CLI Guide

Table Of Contents
The DTK command line switches, configuration file formatting, and error reporting follow similar style and behavior. However,
individual DTK utilities can sometimes differ from one another in significant ways. You must familiarize yourself with the
command line syntax and utility-specific options and arguments for each utility before using DTK.
NOTE: Some of the command line options in DTK are followed by an asterisk. Such options are used for reporting purposes
only.
Command Line Syntax
The following table lists the generic command line characters and arguments present in the command line options with a short
description of these characters.
Table 3. Command Line Options
Element Description
-
Prefix single character options.
NOTE: This delimiter is not applicable to Baseboard Management Controller
(BMC) sub-options.
--
Prefix multi-character options.
utilname
Indicates the generic designation for a DTK utility name.
o
Indicates the generic single-character designation for an option.
optionX
Indicates the generic multi-character designation for a utility name, where you
can use X to distinguish multiple options used in the same command line instance.
argX
Indicates the generic designation for an argument, where you can use X to
distinguish multiple arguments used in the same command line instance.
[mandatory option]
Indicates the generic designation for a mandatory argument.
<optional argument>
Indicates the generic designation for an optional argument.
<string>
Indicates the generic designation for a string.
<filename>
Indicates the generic designation for a filename.
[ ]
Indicates a component of the command line. Enter only the information within the
brackets and exclude the brackets.
...
Indicates that the previous argument can be repeated several times in a
command. Enter only the information within the ellipses and exclude the ellipses.
|
Separates two mutually exclusive choices in a syntax line. For example:
usb: Turns the usb controller on or off
Argument: enable | disable | legacy
Enter only one choice: --usb=enable, --usb= disable, or
--usb=legacy.
18 Command Syntax Overview