The commands for the Storage Enclosure CLI have a number of input parameters. Those parameters, in turn, can also have more than one valid attribute. However, each parameter can accept only one valid value for each run. This section defines the symbols used in the syntax of each command in this document and the syntax layout in the SHM CLI help.
Input Parameter | Description |
---|---|
a|b | Pipe symbol indicating alternative (“a” or “b”) |
italicized-words | Input value |
[…] | Optional input |
<> | Enclosed input value is required for parameter |
Parameter Name | Description | Valid Values |
---|---|---|
-a |
Indicates target adapter |
SAS WWID or Adapter Index |
-d |
Indicates target drive |
WWN ( World Wide Name), Enclosure Slot Index, Drawer Slot Index, Serial Number, or Drive OS Path |
-w |
Indicates target enclosure drawer |
Drawer Index (0, 1, 2, 3, or 4) |
-s |
Indicates target enclosure slot |
Enclosure Slot Index |
-startDate |
Target start date |
StartDate in the format of MM/DD/YY |
-endDate |
Target end date |
EndDate in the format of MM/DD/YY |
-event | Type of event to view from the event log |
EventType (INFO, CRITICAL, ERROR, or WARN) |
-count |
Number of events to view |
LatestEventCount numeric value (1-1000) |
-outputformat |
Format of output data from shmcli command |
SupportedOutputFormats (XML, JSON) |
-enc |
Indicates target physical enclosure |
Enclosure Index or WWN |
-emm |
Indicates target EMM |
WWN or EMM Index |
-file |
Indicates target firmware file for updating a drive or EMM |
Firmware update file location and name |
-outputdir |
Output directory to place the archived output file |
Absolute path to the directory of output archive file |
Parameter | Description | Valid for Parameter |
---|---|---|
Absolute Path to Firmware File |
Indicates the absolute filepath to a valid drive or EMM firmware file | Valid value for the –file parameter |
Adapter Index |
Indicates the enumerated index value for installed supported HBAs | Valid value for the -a parameter |
SAS WWID |
Indicates the device specific SAS WWID of the installed supported HBAs | Valid value for the -a parameter |
Device ID |
Enumerated reference value that Indicates a target drive or EMM | Valid value for the -d and -emm parameters |
Drawer Index |
Indicates reference value for logical grouping of drives into drawers | Valid value for the -w parameter |
Encl Index (Enclosure Index) |
Indicates reference value for enclosures attached to a specified adapter | Valid value for the -enc parameter |
WWN (Worldwide Name) |
Indicates unique value that identifies a unique drive, EMM, or enclosure | Valid value for the -d, -emm, and -enc parameters |
Enclosure Slot Index |
Reference value that Indicates a target drive | Valid value for the -d and-s parameter |
Drawer Slot Index |
Indicates reference value for a drive slot in a specified drawer | Valid value for the -d parameter |
EMM Index (Enclosure Management Module Index) |
Indicates the reference value for EMMs in an specific enclosure | Valid value for the -emm parameter |
StartDate |
Starting date to view logs in the format: MM/DD/YY | Valid value for the -startDate parameter |
EndDate |
End date to view logs in the format: MM/DD/YY | Valid value for the -endDate parameter |
EventType |
Type of event to view (INFO, CRITICAL, ERROR, or WARN) | Valid value for the -event parameter |
LatestEventCount |
Numeric value between 1–1000 | Valid value for the -count parameter |
SupportedOutputFormats |
Supported out file formats: XML, JSON | Valid value for the -outputformat parameter |
Serial Number |
Unique identifier for the physical disk drive | Valid value for the -d parameter |
Drive OS Path |
Unique path to drive provided by the OS. | Valid value for the -d parameter |