abort commands

Abort commands are used to abort an ongoing update of a Digital Sandbox deployment.

The following CLI abort commands are available:

dsctl

    — abort

dsctl abort

Synopsis

dsctl abort -i <ID_string>

Description

The dsctl abort command is used to abort an ongoing update of a deployment. When used, the deployment will be labeled as Failed because there will be differences between what the user specified and what is available in the sandbox.A new update trigger must be used to remove the Failed label. The API is intended to be used in cases where a user knows they forgot to specify something before the update was triggered.

Options

The following are dsctl abort parameters:

Parameter:

-i <ID_string>

Used with operation:

abort

Description:

Specifies the Digital Sandbox deployment ID. Mandatory field.

Examples

To abort a Digital Sandbox deployment with an ID of ‟star”:

dsctl abort -i star