create commands

dsctl create checkpoint

Synopsis

dsctl create checkpoint [-d <device_string>] -i <ID_string> -n <name_string> [-t <timeout_integer>]

Description

The dsctl create checkpoint command is used to create a deployment checkpoint. A checkpoint is a saved version of the running file that you can revert to.

Options

The following are dsctl create checkpoint parameters:


Parameter:	`-d <device_string>`
Used with operation:	`create checkpoint`
Description:	Specifies the device target name. Multiple names are separated by a semi-colon. Default is ‟*” (the asterisk symbol).


Parameter:	`-i <ID_string`>
Used with operation:	`create checkpoint`
Description:	Specifies the deployment ID. Mandatory field.


Parameter:	`-n <name_string`>
Used with operation:	`create checkpoint`
Description:	Specifies the name of the checkpoint being created. Mandatory field.


Parameter:	`-t <timeout_integer`>
Used with operation:	`create checkpoint`
Description:	Specifies the timeout value as an integer. This is the time in minutes to wait for an ACK of the processed message. Default is 1.

Examples

To create a checkpoint with the name ‟testcheckpoint" associated with a deployment named ‟star" with a timeout value of 2 minutes:

dsctl create checkpoint -i star -n testcheckpoint -t 2

dsctl create config

Synopsis

dsctl create config defaults [-e <gluster_endpoint>] [-n <gluster_endpoint_namespace>] [-v <gluster_volumename>] [-s <imagePullSecrets_string>][-k <K8_nodeselector_string>]

dsctl create confg fssconnect -a <auth_URL_string> -d <DNS_name_string> -s <host_string> -i <DNS_IP_resolution_string> -p <password_string> -u <user_ID_string> -z <ZTP_URL_string>

dsctl create config nokia-srlinux-license [-f <filename_string>] [-k <keyname_string>] [-v <version_string>]

Description

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

The defaults operation creates the Digital Sandbox configuration defaults.
The fssconnect operation creates the FSSconnect secret, or sensitive information such as passwords that are required to connect to the fabric manager (Fabric Services System).
The nokia-srlinux-license operation creates a license key for a specified Nokia SR Linux version.

Options

The following are dsctl create config defaults parameters:


Parameter:	`-e <gluster_endpoint_string>`
Used with operation:	`create config defaults`
Description:	Creates the default configuration with the specified gluster service endpoint.


Parameter:	`-n <gluster_endpoint_namespace>`
Used with operation:	`create config defaults`
Description:	Creates the default configuration with the specified namespace of the gluster endpoint.


Parameter:	`-v <gluster_volumename>`
Used with operation:	`create config defaults`
Description:	Creates the default configuration with the specified gluster volume name.


Parameter:	`-s <imagePullSecrets_string>`
Used with operation:	`create config defaults`
Description:	Defines the kubernetes image pull secrets (stored in the digital-sandbox-system namespace) that can be used during Digital Sandbox deployment creation. Default = regcred.


Parameter:	`-k <K8_nodeselector_string>`
Used with operation:	`create config defaults`
Description:	Defines the kubernetes node selector to use to specify which kubernetes nodes can be used by the Digital Sandbox.

The following are dsctl create config fssconnect parameters:


Parameter:	`-a <auth_URL_string>`
Used with operation:	`create config fssconnect`
Description:	Defines the fabric manager authorization URL. Mandatory field.


Parameter:	`-d <DNS_name_string>`
Used with operation:	`create config fssconnect`
Description:	Defines the fabric manager service DNS name. Mandatory field.


Parameter:	`-s <host_string>`
Used with operation:	`create config fssconnect`
Description:	Defines the fabric manager host. Mandatory field.


Parameter:	`-i <DNS_IP_resolution_string>`
Used with operation:	`create config fssconnect`
Description:	Defines the fabric manager service DNS IP resolution. Mandatory field.


Parameter:	`-p <password_string>`
Used with operation:	`create config fssconnect`
Description:	Defines the fabric manager password. Mandatory field.


Parameter:	`-u <user ID_string>`
Used with operation:	`create config fssconnect`
Description:	Defines the fabric manager user ID. Mandatory field.


Parameter:	`-z <ZTP_URL_string>`
Used with operation:	`create config fssconnect`
Description:	Defines the fabric manager ZTP URL. Mandatory field.

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


Parameter:	`-f <filename_string>`
Used with operation:	`create config nokia-srlinux-license`
Description:	Defines the name and path of the SR Linux license file.


Parameter:	`-k <keyname_string>`
Used with operation:	`create config nokia-srlinux-license`
Description:	Defines the license key that corresponds to the Nokia SR Linux version.


Parameter:	`-v <version_string>`
Used with operation:	`create config nokia-srlinux-license`
Description:	Defines the version of the Nokia SR Linux key.

Examples

To create a default configuration with the gluster endpoint ‟digital-sandbox-gluster-endpoints", a gluster endpoint namespace of ‟default", and a gluster volume name of ‟digitalsandbox":

dsctl create config defaults -e digital-sandbox-gluster-endpoints -n default -v digitalsandbox

dsctl create deployment

Synopsis

dsctl create deployment -f <filename_string> -i <ID_string> [-t <tar_filename_string>]

Description

The dsctl create deployment command is used to create a Digital Sandbox simulation platform or deployment.

Options

The following are dsctl create deployment parameters:


Parameter:	`-f <filename_string>`
Used with operation:	`create deployment`
Description:	Specifies the name of the file containing the deployment path and filename. Default is "/tmp/devices.yaml". Mandatory field.


Parameter:	`-i <ID_string`>
Used with operation:	`create deployment`
Description:	Specifies the deployment ID. Mandatory field.


Parameter:	`-t <tar_filename_string`>
Used with operation:	`create deployment`
Description:	Specifies the name of the path and tar file that contains the configuration and state details required to build a topology.

Examples

To create a deployment with a deployment ID named "star", with the filename of "/tmp2/7live.yaml", and with a configuration tar file named "/tmp2/7live.tar":

dsctl create deployment -i star -f /tmp2/7live.yaml -t /tmp2/7live.tar

dsctl create image

Synopsis

dsctl create image {-p <RPM_path_string> | -r <SRL_release_string>}

Description

The dsctl create image command is used to create a custom SR Linux image with the designated RPMs.

Options

The following are dsctl create image parameters:


Parameter:	`-p <RPM_path_string>`
Used with operation:	`create image`
Description:	Specifies the filename and path that contains the list of RPMs to install. Either this parameter (-p) must be provided or the -r parameter.


Parameter:	`-r <SRL_release_string`>
Used with operation:	`create image`
Description:	Specifies the SR Linux release. When used, all the RPMs associated with this release are included and it will ignore any other RPMs. Either this parameter (-r) must be provided or the -p parameter.

Examples

To create an image using the RPMs associated with the SR Linux release ‟srl_rel_21_06_”:

dsctl create image -r srl_rel_21_06_

dsctl create phyconnector

Synopsis

dsctl create phyconnector -s <interface_list_string> -k <k8node_string> -n <resource_name_string>

Description

The dsctl create phyconnector command is used to create a phyconnector in the kubernetes cluster. A phyconnector is used to connect a physical interface, device, or network to the containerized network.

Options

The following are dsctl create phyconnector parameters:


Parameter:	`-s <interface_list_string>`
Used with operation:	`create phyconnector`
Description:	Specifies a list of interfaces, using a semi-colon ( ; ) to separate each, available on the node. Mandatory field.


Parameter:	`-k <k8node_string`>
Used with operation:	`create phyconnector`
Description:	Specifies the name of the k83 node containing the interfaces. Mandatory field.


Parameter:	`-n <resource_name_string`>
Used with operation:	`create phyconnector`
Description:	Specifies the name of the resource. Names must be DNS compatible. Mandatory field.

Examples

To create a physical connection in the kubernetest cluster for interfaces eth3, eth4, and eth5 in the kubernetes node named ‟k8sworker1” for resource named ‟phyconnectOnNode1”:

dsctl create phyconnector -s eth3;eth4;eth5 -n phyconnectOnNode1 -k k8sworker1

dsctl create snapshot

Synopsis

dsctl create snapshot -i <ID_string> [-l <location_string>] [-t <timeout_integer>]

Description

The dsctl create snapshot command is used to create a snapshot of the deployment. A snapshot is a copy of the deployment with all the intents and configurations at the snapshot creation time. This snapshot can be used to create a duplicate of the deployment using the "dsctl load snapshot" command.

Options

The following are dsctl create snapshot parameters:


Parameter:	`-i <ID_string>`
Used with operation:	`create snapshot`
Description:	Specifies the deployment ID. Mandatory field.


Parameter:	`-l <location_string`>
Used with operation:	`create snapshot`
Description:	Specifies filename and path of destination tar-file. Default is “/tmp/snapshot.tar”.


Parameter:	`-t <timeout_integer`>
Used with operation:	`create snapshot`
Description:	Specifies the timeout value as an integer. This is the time in minutes to wait for an ACK of the processed message. Default is 1.