Read
GET v1/shelves/detail
Query parameters
| Parameter | Type |
|---|---|
| array_id | NsObjectID |
| partial_response_ok | NsBoolean |
GET v1/shelves/id
Description
Retrieve information about a shelf or a list of shelves.
Normal Response Codes
200
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | ID of shelf. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| array_name | NsObjectName | string | Name of array the shelf belongs to. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| array_id | NsObjectID | string | ID of array the shelf belongs to. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| chassis_type | NsChassisType | string enum | Chassis type. Type of chassis. Possible values: 'chassis_unknown', 'chassis_3u16', 'chassis_4u24'. | |
| ctrlrs | NsShelfCtrlrList | Array of NsShelfCtrlr | List of ctrlr info. List of controller hardware and software info. | |
| serial | NsString | string | The serial number of the chassis. Plain string. | |
| model | NsString | string | Model of the shelf or head unit. Plain string. | |
| model_ext | NsString | string | Extended model of the shelf or head unit. Plain string. | |
| chassis_sensors | NsShelfSensorList | Array of NsShelfSensor | List of chassis sensor readings. List of sensor readings. | |
| psu_overall_status | NsShelfSensorState | string enum | The overall status for the PSUs. Shelf sensor state. Possible values: 'OK', 'Alerted', 'Failed', 'Missing'. | |
| fan_overall_status | NsShelfSensorState | string enum | The overall status for the fans on both controllers. Shelf sensor state. Possible values: 'OK', 'Alerted', 'Failed', 'Missing'. | |
| temp_overall_status | NsShelfSensorState | string enum | The overall status for the temperature on both controllers. Shelf sensor state. Possible values: 'OK', 'Alerted', 'Failed', 'Missing'. | |
| disk_sets | NsDiskSetAttrList | Array of NsDiskSetAttr | Attributes for the disk sets in this shelf. List of logical shelf attribute. |
JSON Response
{
"data": [
{
"array_id": "091bfe9adff9616812000000000000000000000001",
"array_name": "c12-array5",
"chassis_sensors": [
{
"cid": "A",
"display_name": "power-supply1",
"location": "left rear",
"name": "power-supply1",
"status": "OK",
"type": "power supply",
"value": 0
},
{
"cid": "A",
"display_name": "power-supply2",
"location": "right rear",
"name": "power-supply2",
"status": "OK",
"type": "power supply",
"value": 0
}
],
"chassis_type": "chassis_3u16",
"ctrlrs": [
{
"cached_serial": "AA-100373",
"ctrlr_attrset_list": [
{
"cached_serial": "AA-100373",
"disk_serials": "WD-WCAW31074925,WD-WCAW31562278,WD-WCAW31543481,WD-WCAW31546957,,,,CVPO105101AQ080JGN,CVPO1051023B080JGN,,,,WD-WCAW31507140,WD-WCAW31545053,WD-WCAW31549016,WD-WCAW31544371",
"disk_types": "H,H,H,H,,,,S,S,,,,H,H,H,H",
"hw_state": "ready",
"session_serial": "shelf_0_0x5003048000b0567f_1456884624.213307",
"sw_type": "Head Shelf"
}
],
"ctrlr_hw_model": "head_x8",
"ctrlr_sensor_last_run": 2880758523,
"ctrlr_sensors": [
{
"cid": "A",
"display_name": "motherboard",
"location": "motherboard",
"name": "motherboard",
"status": "OK",
"type": "temperature",
"value": 23
},
{
"cid": "A",
"display_name": "bp-temp1",
"location": "left-side backplane",
"name": "bp-temp1",
"status": "OK",
"type": "temperature",
"value": 29
},
{
"cid": "A",
"display_name": "fan1",
"location": "lower front of controller A",
"name": "fan1",
"status": "OK",
"type": "fan",
"value": 10608
},
{
"cid": "A",
"display_name": "fan2",
"location": "lower left rear of controller A",
"name": "fan2",
"status": "OK",
"type": "fan",
"value": 10608
},
{
"cid": "A",
"display_name": "fan3",
"location": "lower right rear of controller A",
"name": "fan3",
"status": "OK",
"type": "fan",
"value": 10608
},
{
"cid": "A",
"display_name": "fan4",
"location": "upper right front of controller A",
"name": "fan4",
"status": "OK",
"type": "fan",
"value": 7840
},
{
"cid": "A",
"display_name": "fan5",
"location": "upper left front of controller A",
"name": "fan5",
"status": "OK",
"type": "fan",
"value": 7880
},
{
"cid": "A",
"display_name": "fan6",
"location": "upper left rear of controller A",
"name": "fan6",
"status": "OK",
"type": "fan",
"value": 8000
}
],
"ctrlr_side": "A",
"enc_loc_id": 0,
"exp_sas_addr": "0x5003048000b0567f",
"fan_overall_status": "OK",
"hw_master_state": "unknown",
"hw_mship_failure": false,
"port_info": [
{
"port_errors": "",
"port_idx": 0,
"port_name": "SAS PORT1",
"port_status": "disconnected",
"port_type": "downstream",
"remote_loc_id": 4294967295,
"remote_port_id": 4294967295,
"remote_sas_addr": "",
"remote_sas_domain": "unknown",
"remote_sas_phy_id": ""
}
],
"sw_master_state": "not master",
"temp_overall_status": "OK"
},
{
"cached_serial": "AA-100373",
"ctrlr_attrset_list": [
{
"cached_serial": "AA-100373",
"disk_serials": "WD-WCAW31074925,WD-WCAW31562278,WD WCAW31543481,WD-WCAW31546957,,,,CVPO105101AQ080JGN,CVPO1051023B080JGN,,,,WD-WCAW31507140,WD-WCAW31545053,WD-WCAW31549016,WD-WCAW31544371",
"disk_types": "H,H,H,H,,,,S,S,,,,H,H,H,H",
"hw_state": "ready",
"session_serial": "shelf_0_0x5003048000b058ff_1456884624.299637",
"sw_type": "Head Shelf"
}
],
"ctrlr_hw_model": "head_x8",
"ctrlr_sensor_last_run": 2917237000,
"ctrlr_sensors": [
{
"cid": "B",
"display_name": "motherboard",
"location": "motherboard",
"name": "motherboard",
"status": "OK",
"type": "temperature",
"value": 22
},
{
"cid": "B",
"display_name": "fan1",
"location": "lower front of controller B",
"name": "fan1",
"status": "OK",
"type": "fan",
"value": 10608
},
{
"cid": "B",
"display_name": "fan2",
"location": "lower left rear of controller B",
"name": "fan2",
"status": "OK",
"type": "fan",
"value": 10608
},
{
"cid": "B",
"display_name": "fan3",
"location": "lower right rear of controller B",
"name": "fan3",
"status": "OK",
"type": "fan",
"value": 10608
},
{
"cid": "B",
"display_name": "bp-temp2",
"location": "right-side backplane",
"name": "bp-temp2",
"status": "OK",
"type": "temperature",
"value": 30
},
{
"cid": "B",
"display_name": "fan4",
"location": "upper right front of controller B",
"name": "fan7",
"status": "OK",
"type": "fan",
"value": 8040
},
{
"cid": "B",
"display_name": "fan5",
"location": "upper left front of controller B",
"name": "fan8",
"status": "OK",
"type": "fan",
"value": 7920
},
{
"cid": "B",
"display_name": "fan6",
"location": "upper left rear of controller B",
"name": "fan9",
"status": "OK",
"type": "fan",
"value": 7480
}
],
"ctrlr_side": "B",
"enc_loc_id": 0,
"exp_sas_addr": "0x5003048000b058ff",
"fan_overall_status": "OK",
"hw_master_state": "unknown",
"hw_mship_failure": false,
"port_info": [
{
"port_errors": "",
"port_idx": 0,
"port_name": "SAS PORT1",
"port_status": "disconnected",
"port_type": "downstream",
"remote_loc_id": 4294967295,
"remote_port_id": 4294967295,
"remote_sas_addr": "",
"remote_sas_domain": "unknown",
"remote_sas_phy_id": ""
}
],
"sw_master_state": "master",
"temp_overall_status": "OK"
}
],
"disk_sets": [
{
"is_capacity_valid": true,
"is_flash_shelf": false,
"raw_cache_capacity": true,
"raw_capacity": true,
"sw_state": "online",
"usable_cache_capacity": true,
"usable_capacity": true
}
],
"fan_overall_status": "OK",
"id": "2d1bfe9adff9616812000000010000414100018815",
"model": "CS210",
"model_ext": "CS210-8T-160F",
"psu_overall_status": "OK",
"serial": "AA-100373",
"temp_overall_status": "OK"
}
],
"endRow": 1,
"startRow": 0,
"totalRows": 1
}
