Diablo: ULLtraDIMMM - CLI Overview - Revision history

Jon: Jon moved page Diablo: ULLtraDIMMM - CLI Reference to Diablo: ULLtraDIMMM - CLI Overview without leaving a redirect

2014-05-23T12:31:55Z

Jon moved page Diablo: ULLtraDIMMM - CLI Reference to Diablo: ULLtraDIMMM - CLI Overview without leaving a redirect

Jon: /* Overview of Commands */

2014-05-23T12:29:46Z

Overview of Commands

Jon: /* Overview of Commands */

2014-05-23T12:22:11Z

Overview of Commands

Jon: /* Overview of Commands */

2014-05-23T12:19:19Z

Overview of Commands

Jon: /* Overview of Commands */

2014-05-23T12:14:19Z

Overview of Commands

Jon at 12:08, 23 May 2014

2014-05-23T12:08:35Z

Jon: Created page with "== ULLtraDIMM CLI Structure == The structure of the ULLtraDIMM CLI command is: '''`td-cli <--parameter>` '''
For example,..."

2014-05-23T11:50:59Z

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,..."

New page

== ULLtraDIMM CLI Structure ==
The structure of the ULLtraDIMM CLI command is:
'''<code>td-cli <global_option> <command> <--parameter> <value></code>'''
<br>
For example, to set the provisioning level for a device to 100 percent, type:
'''<code>td-cli device-format <device_id> --provision 100</code>'''
<br>
* 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:
'''<code>td-cli --verbose | -v enables more output (stackable)</code>'''
'''<code>td-cli --help | -h displays the help</code>'''

@@ Line 26: / Line 26: @@
 | 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="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="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
@@ Line 38: / Line 38: @@
 | 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="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="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="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="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="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
@@ Line 62: / Line 62: @@
 | 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="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="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="background: white; text-align: left;"| <device_id><br>....--attr
 |- style="vertical-align:top;"
 | style="background: white; text-align: left;"| version

@@ Line 60: / Line 60: @@
 | style="background: white; text-align: left;"| <device_id>
 |- style="vertical-align:top;"
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| device-stats
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| Displays the block statistics
-| style="background: white; text-align: left;"|
+| 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;"|
+| style="background: white; text-align: left;"| host-config
-| style="background: white; text-align: left;"|
+| 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;"|
+| style="background: white; text-align: left;"| save
 |- style="vertical-align:top;"
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| device-smart
-| style="background: white; text-align: left;"|
+| 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;"|
+| style="background: white; text-align: left;"| <device_id><br>....attr
 |- style="vertical-align:top;"
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| version
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| Reports the version of the CLI and device driver
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| n/a
 |- style="vertical-align:top;"
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| driver-stop
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| Prepares the system to unload the driver
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| n/a
 |- style="vertical-align:top;"
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| support-pkg
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| Generates a status report to the Support team
-| style="background: white; text-align: left;"|
+| style="background: white; text-align: left;"| n/a
 |}

@@ Line 39: / Line 39: @@
 | 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;"|

@@ Line 26: / Line 26: @@
 | 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="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>
+| style="background: white; text-align: left;"| <device_id><br>....get<br>....set <alias_name>
+|- style="vertical-align:top;"
 |}

← Older revision		Revision as of 12:08, 23 May 2014
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 <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>
		+
		+	\|}

← Older revision	Revision as of 12:31, 23 May 2014
(No difference)

Diablo: ULLtraDIMMM - CLI Overview - Revision history

Jon: Jon moved page Diablo: ULLtraDIMMM - CLI Reference to Diablo: ULLtraDIMMM - CLI Overview without leaving a redirect

Jon: /* Overview of Commands */

Jon: /* Overview of Commands */

Jon: /* Overview of Commands */

Jon: /* Overview of Commands */

Jon at 12:08, 23 May 2014

Jon: Created page with "== ULLtraDIMM CLI Structure == The structure of the ULLtraDIMM CLI command is: '''td-cli <--parameter> ''' For example,..."

Jon: Created page with "== ULLtraDIMM CLI Structure == The structure of the ULLtraDIMM CLI command is: '''`td-cli <--parameter>` '''
For example,..."