log commands

Log commands are used to retrieve Digital Sandbox related logs.

The following log CLI commands are available:

dsctl

    — logs

        — all

        — deployment

dsctl logs all

Synopsis

dsctl logs all [-t <tar_string>]

Description

The dsctl logs all command is used to retrieve all the Digital Sandbox logs. If a specific tar string is not specified (using the -t flag), the logs are sent to /tmp/logs.tar.

Options

The following are dsctl logs all parameters:

Parameter:

-t <tar_string>

Used with operation:

logs all

Description:

Optionally define the name of the local tar file that will contain the logs. The default is: ‟/tmp/logs.tar”.

Examples

To retrieve all the Digital Sandbox logs and send them to ‟/tmp/logs.tar”:

dsctl logs all

To retrieve all the Digital Sandbox logs and send them to a tar file that you have named ‟newlogs”:

dsctl logs all -t /tmp/newlogs.tar

dsctl logs deployment

Synopsis

dsctl logs deployment -i <ID_string> [-t <tar_string>]

Description

The dsctl logs deployment command is used to retrieve all the Digital Sandbox logs associated with a specific deployment ID.

Options

The following are dsctl logs deployment parameters:

Parameter:

-i <ID_string>

Used with operation:

logs deployment

Description:

Defines the deployment ID. Mandatory field.

Parameter:

-t <tar_string>

Used with operation:

logs deployment

Description:

Optionally define the name of the local tar file that will contain the logs. The default is: ‟/tmp/logs.tar”.

Examples

To retrieve all the Digital Sandbox logs associated with a deployment ID called ‟star” and send them to ‟/tmp/logs.tar‟:

dsctl logs deployment -i star

To retrieve all the Digital Sandbox logs associated with a deployment ID called ‟star” and send them to a tar file that you have named ‟newlogs”:

dsctl logs deployment -i star -t /tmp/newlogs.tar