Diablo: ULLtraDIMMM - CLI Overview
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 <early, superearly (default) > <yes> ....maintenance ....online ....status ....trim <on, off> |
| 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> |