Difference between revisions of "Diablo: ULLtraDIMMM - CLI Overview"

From Define Wiki
Jump to navigation Jump to search
(Created page with "== ULLtraDIMM CLI Structure == The structure of the ULLtraDIMM CLI command is: '''<code>td-cli <global_option> <command> <--parameter> <value></code>''' <br> For example,...")
 
m (Jon moved page Diablo: ULLtraDIMMM - CLI Reference to Diablo: ULLtraDIMMM - CLI Overview without leaving a redirect)
 
(5 intermediate revisions by the same user not shown)
Line 16: Line 16:
 
     '''<code>td-cli --verbose | -v enables more output (stackable)</code>'''
 
     '''<code>td-cli --verbose | -v enables more output (stackable)</code>'''
 
     '''<code>td-cli --help | -h displays the help</code>'''
 
     '''<code>td-cli --help | -h displays the help</code>'''
 +
 +
== Overview of Commands ==
 +
 +
{| class="wikitable"
 +
! style="width: 15%;"|Command
 +
! style="width: 25%;"|Description
 +
! style="width: 60%;"|Parameters/Values
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| device
 +
| style="background: white; text-align: left;"| Manages or displays information about the ULLtraDIMM device
 +
| style="background: white; text-align: left;"| list<br><device_id><br>....--attach <group_name><br>....--commit <normal | WriteNow ><br>....--maintenance<br>....--online<br>....--status<br>....--trim <on | off><br>....<yes>
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| device-alias
 +
| style="background: white; text-align: left;"| Manages a device alias
 +
| style="background: white; text-align: left;"| <device_id><br>....--get<br>....--set <alias_name>
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| device-defaults
 +
| style="background: white; text-align: left;"| Resets the device configuration to the default values
 +
| style="background: white; text-align: left;"| <device_id>
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| device-diag
 +
| style="background: white; text-align: left;"| Executes diagnostic tests
 +
| style="background: white; text-align: left;"| <device_id> --alarm state<br><device_id> --list<br><device_id> --run<br>....--all (run all diagnostic tests)<br>....--ecc_count (error correcting code test)<br>....--fw_verify (firmware verification test)<br>....--media_ro (media read only)<br>....--media_wr (media write read compare)<br>....--mem_wep (long WEP with multiple patterns)<br>....--power_cap (power capacitor test) wep (short WEP test)
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| device-erase
 +
| style="background: white; text-align: left;"| Erases the device
 +
| style="background: white; text-align: left;"| <device_id><br>....--crypto<br>....--secure<br>....yes
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| device-firmware
 +
| style="background: white; text-align: left;"| Managed the device firmware
 +
| style="background: white; text-align: left;"| <device_id><br>....--query <name> <details><br>....--upgrade <path_and_image_name> <force> <dry-run> <online> <yes>
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| device-format
 +
| style="background: white; text-align: left;"| Manages the device format
 +
| style="background: white; text-align: left;"| <device_id><br>....--bs <512 (default), 4096><br>....--provision <100 (default), 50-100 in 5% increments><br>....--stride <4 (default), 8, 16, 32, 64>
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| device-group
 +
| style="background: white; text-align: left;"| Manages the driver thread groups
 +
| style="background: white; text-align: left;"| --add <group_name> <cpu><br>--delete<br><group_name><br>....--list<br>....--status<br>....--update name <new_name> <cpu> <cpu>
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| device-reset
 +
| style="background: white; text-align: left;"| Performs a hardware reset of the device
 +
| style="background: white; text-align: left;"| <device_id>
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| device-stats
 +
| style="background: white; text-align: left;"| Displays the block statistics
 +
| style="background: white; text-align: left;"| <device_id><br>....--delay <interval_in_seconds><br>....--repeat <number_of_iterations><br>....--reprint <number_of_entries_between_headers>
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| host-config
 +
| style="background: white; text-align: left;"| Saves the current group and device configuration settings and loads them on startup
 +
| style="background: white; text-align: left;"| --save
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| device-smart
 +
| style="background: white; text-align: left;"| Displays the supported attributes for S.M.A.R.T monitoring of the device
 +
| style="background: white; text-align: left;"| <device_id><br>....--attr
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| version
 +
| style="background: white; text-align: left;"| Reports the version of the CLI and device driver
 +
| style="background: white; text-align: left;"| n/a
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| driver-stop
 +
| style="background: white; text-align: left;"| Prepares the system to unload the driver
 +
| style="background: white; text-align: left;"| n/a
 +
|- style="vertical-align:top;"
 +
| style="background: white; text-align: left;"| support-pkg
 +
| style="background: white; text-align: left;"| Generates a status report to the Support team
 +
| style="background: white; text-align: left;"| n/a
 +
|}

Latest revision as of 12:31, 23 May 2014

ULLtraDIMM CLI Structure

The structure of the ULLtraDIMM CLI command is: 

    td-cli <global_option> <command> <--parameter> <value>


For example, to set the provisioning level for a device to 100 percent, type: 

    td-cli device-format <device_id> --provision 100


  • Command parameters must be preceded by two dashes, as shown in the example above.
  • Options must be lower-case only, and multi-word options must be joined with a dash “–“, not an underscore “_”.
  • Regular output, including help, will be sent to stdout.
  • Errors and warnings will be sent to stderr.
  • Commands will exit with a value of 0 on success, and a non-zero exit code on any failure.

Global Options

The ULLtraDIMM CLI supports two global options: 

    td-cli --verbose | -v enables more output (stackable)
    td-cli --help | -h displays the help

Overview of Commands

Command Description Parameters/Values
device Manages or displays information about the ULLtraDIMM device list
<device_id>
....--attach <group_name>
....--commit <normal | WriteNow >
....--maintenance
....--online
....--status
....--trim <on | off>
....<yes>
device-alias Manages a device alias <device_id>
....--get
....--set <alias_name>
device-defaults Resets the device configuration to the default values <device_id>
device-diag Executes diagnostic tests <device_id> --alarm state
<device_id> --list
<device_id> --run
....--all (run all diagnostic tests)
....--ecc_count (error correcting code test)
....--fw_verify (firmware verification test)
....--media_ro (media read only)
....--media_wr (media write read compare)
....--mem_wep (long WEP with multiple patterns)
....--power_cap (power capacitor test) wep (short WEP test)
device-erase Erases the device <device_id>
....--crypto
....--secure
....yes
device-firmware Managed the device firmware <device_id>
....--query <name> <details>
....--upgrade <path_and_image_name> <force> <dry-run> <online> <yes>
device-format Manages the device format <device_id>
....--bs <512 (default), 4096>
....--provision <100 (default), 50-100 in 5% increments>
....--stride <4 (default), 8, 16, 32, 64>
device-group Manages the driver thread groups --add <group_name> <cpu>
--delete
<group_name>
....--list
....--status
....--update name <new_name> <cpu> <cpu>
device-reset Performs a hardware reset of the device <device_id>
device-stats Displays the block statistics <device_id>
....--delay <interval_in_seconds>
....--repeat <number_of_iterations>
....--reprint <number_of_entries_between_headers>
host-config Saves the current group and device configuration settings and loads them on startup --save
device-smart Displays the supported attributes for S.M.A.R.T monitoring of the device <device_id>
....--attr
version Reports the version of the CLI and device driver n/a
driver-stop Prepares the system to unload the driver n/a
support-pkg Generates a status report to the Support team n/a
Retrieved from "http://wiki.define-technology.com/mediawiki-1.35.0/index.php?title=Diablo:_ULLtraDIMMM_-_CLI_Overview&oldid=4526"