intent commands

dsctl intent create underlay [-f <filename_string>] {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>}

dsctl intent create workload [-f <filename_string>] {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>}

dsctl intent create fully-qualified-workload [-f <filename_string>] {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>}

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

• The underlay operation specifies the creation of an underlay (or fabric) intent.

• The workload operation specifies the creation of a workload intent.

• The fully-qualified-workload operation specifies the creation of a fully qualified workload intent. A fully qualified workload is a workload that includes Customer Equipment (CE) endpoints and server configuration information.

The following are dsctl intent create {fully-qualified-workload | workload | underlay} parameters:

To create a workload intent using the file/definition located at ‟/tmp/workload_help.yaml”, ‛associated with the deployment ID ‟star”, and name the workload ‟w_help”:

dsctl intent create workload -i star -n w_help -f /tmp/workload_help.yaml

dsctl intent delete underlay {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>}

dsctl intent delete workload {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>}

dsctl intent delete fully-qualified-workload {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>}

The dsctl intent delete command is used to delete a Digital Sandbox intent resource and has the following operations:

• The underlay operation specifies the deletion of a underlay (fabric) intent.

• The workload operation specifies the deletion of a workload intent.

• The fully-qualified-workload operation specifies the deletion of a fully qualified workload intent. A fully qualified workload is a workload that includes Customer Equipment (CE) endpoints and server configuration information.

The following are dsctl intent delete {fully-qualified-workload | workload | underlay} parameters:

To delete a workload intent named ‟workload-alpha” associated with ID ‟intentexample”:

dsctl intent delete workload -i intentexample -n workload-alpha

dsctl intent list

dsctl intent list active-workloads {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>} [-o <output_format>]

dsctl intent list underlay [-s <datastore_string>] {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>} [-o <output_format>]

dsctl intent list workload [-s <datastore_string>>] {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>} [-o <output_format>]

dsctl intent list fully-qualified-workload [-s <datastore_string>] {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>} [-o <output_format>]

The dsctl intent list command is used to retrieve a list of intent resources and has the following operations:

• The active workload operation retrieves a list of all currently active workload intents.

• The underlay operation retrieves a list of underlay (fabric) intents.

• The workload operation retrieves a list of workload intents.

• The fully-qualified-workload operation retrieves a list of fully qualified workload intents. A fully qualified workload is a workload that includes Customer Equipment (CE) endpoints and server configuration information.

The following are dsctl intent list {active-workload | fully-qualified-workload | workload | underlay} parameters:

To retrieve a list of all intent deployments and their corresponding defined workloads/underlays:

dsctl intent list

To retrieve a list of all workload types and underlays associated with the deployment named ‟star”:

dsctl intent list -i star

To retrieve a list of all underlays associated with the deployment named ‟star”:

dsctl intent list underlay -i star

To show the details of the underlay named ‟underlay1” associated with the deployment named ‟star”:

dsctl intent list underlay -i star -n underlay1

To show all the workloads associated with the deployment named ‟star” that are in the running datastore:

dsctl intent list workload -i star -s running

dsctl intent status {-i <DNS_ID_string> | -d <ID_name_string>}

The dsctl intent status command is used to obtain the status for intents.

The following are dsctl intent status parameters:

To show the status of all intent deployments and their corresponding defined workloads/underlays:

dsctl intent status

To show the status of all intent deployments and their corresponding defined workloads/underlays associated with the deployment named ‟star”:

dsctl intent status -i star

dsctl intent update underlay [-f <filename_string>] {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>}

dsctl intent update workload [-f <filename_string>] {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>}

dsctl intent update fully-qualified-workload [-f <filename_string>] {-i <DNS_ID_string> | -d <ID_name_string>} {-n <name_string> | -x <DNS_name_string>}

The dsctl intent update command is used to update an existing Digital Sandbox intent context. During the update, the candidate versions are promoted to running, and links or nodes are added, removed, and updated as needed. This command has the following operations:

• The underlay operation specifies the update of a underlay (fabric) intent.

• The workload operation specifies the update of a workload intent.

• The fully-qualified-workload operation specifies the update of a fully qualified workload intent. A fully qualified workload is a workload that includes Customer Equipment (CE) endpoints and server configuration information.

The following are dsctl intent update {fully-qualified-workload | workload | underlay} parameters:

To update a workload intent named ‟w_help” using the file/definition located at ‟/tmp/workload_help.yaml”, and that is associated with the deployment ID ‟star”:

dsctl intent update workload -i star -n w_help -f /tmp/workload_help.yaml