traffic commands

Traffic commands are used to analyze and compare traffic, and obtain status.

The following traffic CLI commands are available:

dsctl

    — traffic

        — analyze

            — traffic-run

        — compare

            — traffic-runs

        — create

            — tcap-profile

            — tgen-profile

        — list

            — stream

            — traffic-profiles

            — traffic-runs

        — message

            — tcap

            — tgen

dsctl traffic analyze

Synopsis

dsctl traffic analyze traffic-run -i <ID_string> -p <profile_string> -r <run_string> [-s <stream_ID_string>

Description

The dsctl traffic analyze command is used to analyze a traffic run. It takes the raw capture data and performs an analysis on this data, and has the following operation:

  • The traffic-run operation is used to analyze the traffic capture results from different traffic capturers.

Options

The following are dsctl traffic analyze traffic-run parameters:

Parameter:

-i <ID_string>

Used with operation:

traffic analyze traffic-run

Description:

Defines the deployment ID. Mandatory field.

Parameter:

-p <profile_string>

Used with operation:

traffic analyze traffic-run

Description:

Defines the traffic profile name. Mandatory field.

Parameter:

-r <run_string>

Used with operation:

traffic analyze traffic-run

Description:

Defines the name of the capture to use as the baseline run or the target. Mandatory field.

Parameter:

-s <stream_ID_string>

Used with operation:

traffic analyze traffic-run

Description:

Defines the ID of the stream to analyze. Default is ‟-1”.

Examples

To analyze a traffic run associated with deployment ID ‟star” with a traffic profile named ‟profile1”, and a capture named ‟baseline1” to use as the baseline run:

dsctl traffic analyze traffic-run -i star -p profile1 -r baseline1

dsctl traffic compare

Synopsis

dsctl traffic compare traffic-runs -b <baseline_string> -i <ID_string> -p <profile_string> -t <target_string>

Description

The dsctl traffic compare command is used to compare two traffic runs within the same profile (but with different run names), and has the following operation:

  • The traffic-runs operation is used to generate a report that highlights differences between two traffic runs for a specified traffic profile.

Options

The following are dsctl traffic compare traffic-runs parameters:

Parameter:

-b <baseline_string>

Used with operation:

traffic compare traffic-runs

Description:

Defines the baseline run of the traffic capture. Mandatory field.

Parameter:

-i <ID_string>

Used with operation:

traffic compare traffic-runs

Description:

Defines the deployment ID. Mandatory field.

Parameter:

-p <profile_string>

Used with operation:

traffic compare traffic-runs

Description:

Defines the traffic profile of the run to compare. Mandatory field.

Parameter:

-t <target_string>

Used with operation:

traffic compare traffic-runs

Description:

Defines the target run name of the traffic run. Mandatory field.

Examples

For a traffic profile named ‟profile1” associated with deployment ID ‟star”, compare the baseline traffic run named ‟baselinerun” with the target run named ‟targetrun”:

dsctl traffic compare traffic-runs -i star -p profile1-b baselinerun -t targetrun

dsctl traffic create

Synopsis

dsctl traffic create tcap-profile -i <ID_string> [-j] [-e] [-p <profile_string>] [-s] [-t <timeout_integer>] [-m <capture_type_string>]

dsctl traffic create tgen-profile -i <ID_string> [-d <streampacket_interval_integer>]

Description

The dsctl traffic create command is used to create Digital Sandbox traffic resources and has the following operations:

  • The tcap-profile operation creates a capture profile based on the current profile where the capture occurs on all interfaces or only the eternal gatenet interfaces (to and from the simulators at the edges of the Digital Sandbox).

  • The tgen-profile operation creates a traffic profile that can be sent to the traffic generators based on the available routes in the topology. Output is directed to ‟stoudt”.

Options

The following are dsctl traffic create tcap-profile parameters:

Parameter:

-i <ID_string>

Used with operation:

traffic create tcap-profile

Description:

Defines the deployment ID. Mandatory fields.

Parameter:

-j

Used with operation:

traffic create tcap-profile

Description:

If used, the capturer should use delay and jitter statistics gathering.

Parameter:

-e

Used with operation:

traffic create tcap-profile

Description:

If used, creates a profile using only external interfaces.

Parameter:

-p <profile_string>

Used with operation:

traffic create tcap-profile

Description:

Defines the profile name of the capture. Default is ‟default”. Mandatory field.

Parameter:

-s

Used with operation:

traffic create tcap-profile

Description:

If specified, traffic capturing should perform sequence number checks.

Parameter:

-t <timeout_integer>

Used with operation:

traffic create tcap-profile

Description:

Defines the capture timeout value. Default is ‟30”.

Parameter:

-m <capture_type_string>

Used with operation:

traffic create tcap-profile

Description:

Defines the type of capture structure to generate. Options:

  • init

  • auto-timeout (default)

The following are dsctl traffic create tgen-profile parameters:

Parameter:

-i <ID_string>

Used with operation:

traffic create tgen-profile

Description:

Defines the deployment ID. Mandatory field.

Parameter:

-d <streampacket_interval_integer>

Used with operation:

traffic create tgen-profile

Description:

Defines the default time in milliseconds (ms) between two packets on the same simulator. Default is ‟10”.

Examples

To create a capture profile based on the current profile with a deployment ID of ‟star”, a profile name of ‟profile2”, using delay/jitter checks, and with a capturing timeout of ‟25”:

dsctl traffic create tcap-profile -i star -p profile2 -j -t 25

To create a traffic profile that can be sent to the traffic generators based on the available routes that are associated with deployment ID ‟star” with a time of 11ms between packets:

dsctl traffic create tgen-profile -i star -d 11

dsctl traffic list

Synopsis

dsctl traffic list stream [-s <stream_ID_string>] [-f <tgenfile_string>]

dsctl traffic list traffic-profiles -i <ID_string>

dsctl traffic list traffic-runs -i <ID_string> [-p <profile_string>]

Description

The dsctl traffic list command is used to list Digital Sandbox resources and has the following operations:

  • The stream operation lists the stream parameters for a specific tgen profile.

  • The traffic-profiles operation lists the available traffic profiles.

  • The traffic-run operation lists the available traffic runs.

Options

The following are dsctl traffic list stream parameters:

Parameter:

-s <stream_ID_string>

Used with operation:

traffic list stream

Description:

Defines the stream ID of the stream to list. Default is ‟-1”.

Parameter:

-f <tgenfile_string>

Used with operation:

traffic list stream

Description:

Defines the name of the traffic generator init file.

The following are dsctl traffic list traffic-profiles parameters:

Parameter:

-i <ID_string>

Used with operation:

traffic list traffic-profiles

Description:

Defines the deployment ID. Mandatory field.

The following are dsctl traffic list traffic-runs parameters:

Parameter:

-i <ID_string>

Used with operation:

traffic list traffic-runs

Description:

Defines the deployment ID. Mandatory field.

Parameter:

-p <profile_string>

Used with operation:

traffic list traffic-runs

Description:

Defines the name of the traffic profile. Default is ‟*”.

Examples

To list the stream parameters associated with all streams:

dsctl traffic list stream -s -1

To list available traffic profiles associated with deployment ID ‟star”:

dsctl traffic list traffic-profiles -i star

To list the available traffic runs associated with deployment ID ‟star” with a profile name of ‟profile1”:

dsctl traffic list traffic-runs -i star -p profile1

dsctl traffic message

Synopsis

dsctl traffic message tcap -i <ID_string> -f <tcaprun_string> [-p <profile_string>] [-r <profilerun_string>]

dsctl traffic message tgen -i <ID_string> -f <tgenrun_string>

Description

Traffic capturing and sending is controlled by sending the corresponding traffic message. The dsctl traffic message command is used to message Digital Sandbox components and has the following operations:

  • The tcap operation sends a message to the traffic capturers running in the deployment.

  • The tgen operation sends a message to the traffic generators running in the deployment.

Options

The following are dsctl traffic message tcap parameters:

Parameter:

-i <ID_string>

Used with operation:

traffic message tcap

Description:

Defines the deployment ID. Mandatory field.

Parameter:

-f <tcaprun_string>

Used with operation:

traffic message tcap

Description:

Defines the capture init file. Mandatory field.

Parameter:

-p <profile_string>

Used with operation:

traffic message tcap

Description:

Specifies the profile name of the traffic run. When specified, overwrites the testname/profile of the associated capture.

Parameter:

-r <profilerun_string>

Used with operation:

traffic message tcap

Description:

Specifies the profile run name of the traffic run. When specified, overwrites the CaptureName/Run of the capture control data.

The following are dsctl traffic message tgen parameters:

Parameter:

-i <ID_string>

Used with operation:

traffic message tgen

Description:

Defines the deployment ID. Mandatory field.

Parameter:

-f <tgenrun_string>

Used with operation:

traffic message tgen

Description:

Defines the traffic generator init file. Mandatory field.

Examples

To send a message to the traffic capturer associated with deployment ID ‟star” and with a path/filename to the capture profile of ‟tmp/tcapprofile”. Overwrite the profile of the associated capture:

dsctl traffic message tcap -i star -f tmp/tcapprofile -p

To send a message to the traffic generators running in deployment ID ‟star” and with a path/filename to the capture generator of ‟tmp/tgenprofile”:

dsctl traffic message tgen -i star -f tmp/tgenprofile