list commands

List commands are used to list Digital Sandbox resources and configurations.

The following list CLI commands are available:

dsctl

    — list

        — checkpoints

        — config

            — constants

            — defaults

            — fssconnect

            — nokia-srlinux-license

        — deployments

        — image

        — links

        — nodes

        — phyconnector

dsctl list checkpoint

dsctl list config

Synopsis

dsctl list config constants

dsctl list config defaults

dsctl list config fssconnect

dsctl list config nokia-srlinux-license [-o <output_format_string>] [-v <version_string>]

Description

The dsctl list config command is used to list Digital Sandbox configuration details and has the following operations:

  • The constants operation lists the Digital Sandbox constants configurations. This configuration can be set, but not changed. The initial setting occurs at installation.

  • The defaults operation lists the Digital Sandbox default configurations.

  • The fssconnect operation lists the FSSconnect configurations.

  • The nokia-srlinux-license operation lists all Nokia SR Linux licenses (version and key) or a specified version.

Options

The following are dsctl list config nokia-srlinux-license parameters:

Parameter:

-o <output_format_string>

Used with operation:

list config nokia-srlinux-license

Description:

Lists the SR Linux licenses in a specified format. Valid options are:

  • table (default)

  • text

Parameter:

-v <version_string>

Used with operation:

list config nokia-srlinux-license

Description:

Lists the specific license for the version specified.

Examples

To list the Nokia SR Linux licenses in text format (instead of a table) for version ‟srl_rel_0.0.0‟:

dsctl list config nokia-srlinux-license -o text -v srl_rel_0.0.0

To list the Digital Sandbox default configuration:

dsctl list config defaults

Synopsis

dsctl list checkpoint -i <ID_string> [-n <name_string>]

Description

The dsctl list checkpoint command is used to list available checkpoints. A checkpoint is a saved version of the running file that you can revert back to. If you do not provide the name (-n), all the checkpoints available in the deployment are given. If the name is given, the details of a specific checkpoint are returned.

Options

The following are dsctl list checkpoint parameters:

Parameter:

-i <ID_string>

Used with operation:

list checkpoint

Description:

Specifies the deployment ID. Mandatory field.

Parameter:

-n <name_string>

Used with operation:

list checkpoint

Description:

Name of the checkpoint.

Examples

To list all the checkpoints associated with a deployment ID named ‟star”:

dsctl list checkpoint -i star

To list the details of a checkpoint named ‟checkpt1” associated with deployment ID named ‟star”:

dsctl list checkpoint -i star -n checkpt1

dsctl list deployments

Synopsis

dsctl list deployments [-i <ID_string>] [-o <output_format>]

Description

The dsctl list deployments command is used to list Digital Sandbox configuration details for all deployments or for a specific deployment ID.

Options

The following are dsctl list deployments parameters:

Parameter:

-i <ID_string>

Used with operation:

list deployments

Description:

Specifies the deployment ID.

Parameter:

-o <output_format>

Used with operation:

list deployments

Description:

Displays the output in a specified format. Valid options are:

  • json (default)

  • yaml

Examples

To list deployment details for deployment ID ‟star” in yaml format:

dsctl list deployments -i star -o yaml

dsctl list links

Synopsis

dsctl list links -i <ID_string> [-e <endpoint_string>]

Description

The dsctl list links command is used to list all links in a Digital Sandbox deployment.

Options

The following are dsctl list links parameters:

Parameter:

-i <ID_string>

Used with operation:

list links

Description:

Specifies the deployment ID. Mandatory field.

Parameter:

-e <endpoint_string>

Used with operation:

list links

Description:

Specifies a network element name that needs to be a part of the definition.

Examples

To list links associated with deployment ID ‟star” with endpoint ‟endpoint1”:

dsctl list links -i star -e endpoint1

dsctl list nodes

Synopsis

dsctl list links -i <ID_string>

Description

The dsctl list nodes command is used to list nodes or network elements in a Digital Sandbox deployment.

Options

The following are dsctl list nodes parameters:

Parameter:

-i <ID_string>

Used with operation:

list nodes

Description:

Specifies the deployment ID. Mandatory field.

Examples

To list a node or network elements associated with deployment ID ‟star”:

dsctl list nodes -i star

dsctl list phyconnector

Synopsis

dsctl list phyconnector [-n <name_string>]

Description

The dsctl list phyconnector command is used to list all or one specified phyconnectors. A phyconnector is used to connect a physical interface, device, or network to the containerized network.

Options

The following are dsctl list phyconnector parameters:

Parameter:

-n <name_string>

Used with operation:

list phyconnector

Description:

Name of the phyconnector resource.

Examples

To list all phyconnectors:

dsctl list phyconnector

To list a specific phyconnector named ‟phyconnector1”:

dsctl list phyconnector -n phyconnector1