timeout
|
uint32
|
Time in seconds that the session can be idle before it automatically ends. Valid values are 120–43200 seconds (2–720 minutes).
|
output-format
|
string
|
- console: Supports interactive use of the CLI by displaying command output in easily readable format. This format automatically sizes fields according to content and adjusts content to window resizes.
- 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” objects embedded (indented) under “parent” objects.
-
ipa: Alternate form of XML output which displays like api-embed format with brief mode enabled.
-
ipa: Alternate form of XML output which displays like api-embed format with brief mode enabled.
-
json: Standard JavaScript Object Notation (JSON) output.
-
wbi: A JSON-like format used internally by the
PowerVault Manager.
|
output-format-api
|
string
|
-
console
-
api
-
api-brief
-
api-embed
-
api-embed-brief
-
json
-
json-full
|
output-format-api- numeric
|
uint32
|
Numeric equivalents for
output-format-api values.
-
1: console
-
2: api
-
3: api-brief
-
4: api-embed
-
5: api-embed-brief
-
6: json
-
7: json-full
|
brief-mode
|
string
|
-
Enabled: In XML output, this setting shows a subset of attributes of object properties. The name and type attributes are always shown.
-
Disabled: In XML output, this setting shows all attributes of object properties.
|
brief-mode-numeric
|
uint32
|
Numeric equivalents for
brief-mode values.
|
base
|
uint8
|
Alias for
storage-size-base.
|
pager
|
string
|
-
Enabled: Halts output after each full screen to wait for keyboard input.
-
Disabled: Output is not halted. When displaying output in API format, which is intended for scripting, disable paging.
|
pager-numeric
|
uint32
|
Numeric equivalents for
pager values.
|
locale
|
string
|
The display language.
|
locale-numeric
|
uint32
|
Numeric equivalents for
locale values.
-
0: English
-
3: Spanish
-
4: French
-
5: German
-
7: Japanese
-
8: Korean
-
11: Chinese-simplified
|
storage-size-base
|
uint8
|
Base for entry and display of storage-space sizes.
-
2: Sizes are shown as powers of 2, using 1024 as a divisor for each magnitude.
-
10: Sizes are shown as powers of 10, using 1000 as a divisor for each magnitude.
Operating systems usually show volume size in base 2. Disk drives usually show size in base 10. Memory (RAM and ROM) size is always shown in base 2.
|
storage-size- precision
|
uint8
|
Number of decimal places (1–10) for display of storage-space sizes.
|
storage-size-units
|
string
|
Unit for display of storage-space sizes.
-
Auto: Lets the system determine the proper unit for a size.
-
MB: Sizes are shown in megabytes.
-
GB: Sizes are shown in gigabytes.
- TB: Sizes are shown in terabytes.
Based on the precision setting, if a size is too small to meaningfully display in the selected unit, the system uses a smaller unit for that size. For example, if
storage-size-units is set to TB,
storage-size-precision is set to 1, and
storage-size-base is set to 10, the size 0.11709 TB is instead shown as 117.1 GB.
|
storage-size- units-numeric
|
uint32
|
Numeric equivalents for storage-size-units values.
-
0: Auto
-
1: MB
-
2: GB
-
3: TB
|
temperature-scale
|
string
|
-
Fahrenheit: Temperatures are shown in degrees Fahrenheit.
-
Celsius: Temperatures are shown in degrees Celsius.
|
temperature-scale- numeric
|
uint32
|
Numeric equivalents for
temperature-scale values.
|
user-type
|
string
|
The experience level of the logged-in user.
-
Novice
-
Standard
-
Advanced
-
Diagnostic
|
user-type-numeric
|
uint32
|
Numeric equivalents for
user-type values.
-
1: Novice
-
2: Standard
-
3: Advanced
-
4: Diagnostic
|
username
|
string
|
The logged-in user name.
|
management-mode
|
string
|
The management mode used in the current CLI session.
-
Linear: Uses linear-storage terminology in command output and system messages. For example,
vdisk for disk groups and pools.
-
Virtual: Uses terminology in command output and system messages that is generalized for managing virtual and linear storage. For example,
disk group for disk groups and
pool for pools.
|
management-mode-numeric
|
uint32
|
Numeric equivalents for
management-mode values.
|