Skip to main content

Release commands

This section covers commands that you use in SMCTL to manage releases. These commands are: create, approve, reject, close, compare, describe, list and set release as baseline. Use flags to specify command parameters.

Commands

To view release commands, run:

smctl release --help

or

smctl rel -h

Subcommand

Release commands commands begin with:

smctl release <subcommand>

The release commands support these subcommands:

tabla 1. Subcommands for managing releases

Subcommand

Description

approve

Approve a release.

reject

Reject a release.

baseline

Set a release as the baseline.

close

Close a release in advance.

compare

Compare multiple releases.

create, new or add

Create a release of specific type.

describe

Describe a release.

list

List releases.


Create release

Create release commands begin with:

smctl release create

or

smctl rel add

or

smctl rel new

Subcommands

Create release commands support these subcommands:

tabla 2. Subcommands for creating a release

Subcommands

Description

offline

Create an offline keypair release with specified options.

online

Create an approved online keypair release with specified options.

test

Create an approved test keypair release with specified options.


Flags

Create release commands support these flags:

tabla 3. Flags for creating a release

Shortcut

Flags

Description

-g

--group string

Groups for this release window. 

Format:

--group="<value>"

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-h

--help

Help for creating a release.


Example

Description: Create an offline release with the specified keypair IDs from and to the start and end time and date.

Command:

smctl release create offline <release-name> <local-start-time> <local-end-time> <offline-keypair-ids-separated-by-commas>

Command sample:

smctl release create offline offline-release 05-February-2021T10:30 10-February-2021T15:00 d013f485-2851-43c5-b734-5f597d9abe62,aae21e7d-31e9-4cc0-89fa-63b323a64a56

Approve release

Approve release commands begin with:

smctl release approve

Flags

Approve release commands support these flags:

tabla 4. Flags for approving a release

Shortcut

Flag

Description

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-h

--help

Help for approve.


Example

Description: Approve the release referred to by the release ID.

Command:

smctl release approve <release id>

Command sample:

smctl release approve e3830f73-fb35-4ad0-88e6-e95bf9d24c0c

Reject release

Reject release commands begin with:

smctl release reject

or

smctl rel reject

Flags

The reject release command supports these flags:

tabla 5. Flags for rejecting a release

Shortcut

Flag

Description

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-h

--help

Help for reject.


Example

Description: Reject a release for specified release ID.

Command:

smctl release reject <release id>

Command sample:

smctl release reject e3830f73-fb35-4ad0-88e6-e95bf9d24c0ca

Set release as baseline

The release to be set as a baseline should be a matched release in a comparison and the comparison threshold should be met.

Set release as baseline commands begin with:

smctl release baseline

or

smctl rel baseline

Flags

The set release as baseline command supports these flags:

tabla 6. Flags for setting a release as the baseline

Shortcut

Flag

Description

-c

--comparison-id string

Use the comparison ID of the comparison for creating the baseline. 

Format:

--comparison-id="<value>"

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-h

--help

Help for approve.


Example

Description: Set the release referred to with the release ID as baseline.

Command:

smctl release baseline <release id>

Command sample:

smctl release baseline e3830f73-fb35-4ad0-88e6-e95bf9d24c0c

Close release

Close release commands begin with:

smctl release close

Flags

Close release commands support these flags:

tabla 7. Flags for closing a release

Shortcut

Flag

Description

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-h

--help

Help for approve.


Example

Description: Close the release referred to by the release ID.

Command:

smctl release close <release id>

Command sample:

smctl release close e3830f73-fb35-4ad0-88e6-e95bf9d24c0c

Compare releases

You can compare a minimum of two and a maximum of six releases.

Compare release commands begin with:

smctl release compare

Subcommands

Compare release commands support these subcommands:

tabla 8. Subcommands for comparing releases

Shortcut

Subcommand

Description

desc

describe

Describe the details of a release comparison.

ls

list

List release comparisons.


Example

Describe: Compare the releases referred to by their release IDs, separated by commas.

Command:

smctl release compare <comparison name> <release-ids separated-by-comma>

Command sample:

smctl release compare my-comparison 50f05b96-5b57-4fb0-b425-774895c7484c,bbdd8dc2-9c23-4542-8c75-013380165ce0

Describe release comparison

Describe release comparison commands begin with:

smctl release compare describe

or

smctl rel compare desc

Flags

Describe release comparison commands support these flags:

tabla 9. Flags for describing a release comparison

Shortcut

Flag

Description

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-h

--help

Help for describing a release comparison.


Examples

Description: Describe the comparison for the specified release comparison ID.

Command:

smctl release compare describe <release comparison id>

Command sample:

smctl release compare describe 133d1d4f-f82d-4906-b3ac-760bea8466f4

List release comparisons

List release comparisons commands begin with:

smctl release compare list

or

smctl rel compare ls

Flags

List release comparison commands support these flags:

tabla 10. Flags for listing release comparisons

Shortcut

Flag

Description

-f

--filter stringToString

Filter(s) based on field=value. The default is []. 

Format:

--filter="<value>"

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-p

--page int

Page number. Default is –1, which displays all pages.

-s

--size int

Page size. Default is 10.

-h

--help

Help for list release comparisons.


Example

Description: List all the release comparisons with the specified comparison name.

Command:

smctl release compare list --filter <comparison name>

Command sample:

smctl release compare list --filter name=comp-21323

Describe release

Describe release comparison commands begin with:

smctl release describe

or

smctl rel desc

Flags

Describe release comparison commands support these flags:

tabla 11. Flags for describing a release

Shortcut

Flag

Description

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-h

--help

Help for describe release.


Example

Description: Describe the release for specified release ID.

Command:

smctl release describe <release id>

Command sample:

smctl release describe 06324b6e-81a0-4e12-a856-378bef246fd2

List releases

List releases command begins with:

smctl release list

or

smctl rel ls

Flags

List releases command supports these flags:

tabla 12. Flags for listing releases

Shortcut

Flag

Description

-f

--filter stringToString

Supported fields: name, status, type, and requestor. Default is []. 

Format:

--filter="<value>"

-p

--page int

Page number. Default is –1, which displays all pages.

-s

--size int

Page size. Default is 100.

--account-id string

Account ID for the user. 

Format:

--account-id="<value>"

-h

--help

Help for list releases.


Example

Description: List all releases for the specified release name.

Command:

smctl release list --filter name=<release name>

Command sample:

smctl release list --filter name=new-rel-without-baseline