cli-parameters
Properties
Table 15
cli-parameters properties
Name
timeout
output-format
output-format-
api
output-format-
api-numeric
brief-mode
brief-mode-
numeric
base
pager
pager-numeric
300 XML API basetype properties
Type
Description
Time in seconds that the session can be idle before it automatically ends. Valid
uint32
values are 120–43200 seconds (2–720 minutes). The default is 1800 seconds
(30 minutes).
•
console: Supports interactive use of the CLI by displaying command output
string
in easily readable format. This format automatically sizes fields according to
content, adjusts content to window resizes, and displays some information in
localized form. This is the default.
•
api: Supports scripting by displaying command output in XML. All objects
are displayed at the same level, related by COMP elements.
•
api-embed: Alternate form of XML output which displays "child"
embedded (indented) under "parent" objects.
•
ipa: Alternate form of XML output for internal use only.
•
json: Alternate data-interchange format for internal use only.
•
string
console
•
api
•
api-brief
•
api-embed
•
api-embed-brief
•
json
•
json-full
Numeric equivalents for output-format-api values.
string
•
1: console
•
2: api
•
3: api-brief
•
4: api-embed
•
5: api-embed-brief
•
6: json
•
7: json-full
•
Enabled: In XML output, only the name and type properties of objects are
string
shown.
•
Disabled: In XML output, all properties of objects are shown. This is the
default.
Numeric equivalents for brief-mode values.
string
•
0: Disabled
•
1: Enabled
Alias for storage-size-base.
uint8
•
Enabled: Output is halted after each full screen to wait for keyboard input.
string
This is the default.
•
Disabled: Output is not halted.
Numeric equivalents for pager values.
string
•
0: Disabled
•
1: Enabled