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

Revision as of 12:08, 23 May 2014

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.

The ULLtraDIMM CLI supports two global options:

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

Command	Description	Parameters/Values
device	Manages or displays information about the ULLtraDIMM device	list <device_id> . attach <group_name> . commit <early, superearly (default) > <yes> . maintenance . online . status . trim <on, off>
device-alias	Manages a device alias	<device_id> . get . set <alias_name>

@@ Line 16: / Line 16: @@
       '''<code>td-cli --verbose | -v enables more output (stackable)</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 <early, superearly (default) > <yes><br>.    maintenance<br>.    online<br>.    status<br>.    trim <on, off>
+|- 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>
+|}