REST API Reference Version 5.2.1.0Search

Update

PUT v1/shelves/id

Query parameters

Parameter Type
force NsBoolean

Description

Activate a shelf. Use 'force=true' with 'activated=true' to force the shelf to activate.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Detail Codes

SM_shelf_connected_only_one_side

SM_shelf_create_rfail

SM_shelf_ctrlr_loop

SM_shelf_disconnected

SM_shelf_disk_sas_link_degraded

SM_shelf_ebusy

SM_shelf_expander_err

SM_shelf_expr_fw_ver_inval

SM_shelf_expr_mfg_ver_inval

SM_shelf_expr_rev_incompatible

SM_shelf_foreign

SM_shelf_foreign_disk

SM_shelf_hdds_in_afs

SM_shelf_invalid_afs

SM_shelf_invalid_afs_count

SM_shelf_invalid_count

SM_shelf_invalid_csz

SM_shelf_invalid_disk_count

SM_shelf_invalid_eeprom

SM_shelf_invalid_loc

SM_shelf_invalid_model

SM_shelf_loc_order

SM_shelf_no_eloc_id

SM_shelf_no_rserial

SM_shelf_not_inuse

SM_shelf_not_ready

SM_shelf_pmd_state

SM_shelf_preactivation_io_err

SM_shelf_preactivation_mfr_err

SM_shelf_raid_degraded

SM_shelf_sas_lanes_degraded

SM_shelf_ses_device_not_ready

SM_shelf_ses_mship_err

SM_shelf_ssd_degraded

SM_shelf_wrong_ctrlr_side

SM_shelf_wrong_sas_port

SM_invalid_arg_value

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_missing_arg

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_unexpected_arg

SM_unexpected_query_param

SM_version_name

Request

Parameter Type JSON Type Description Mandatory Deprecated
id NsObjectID string ID of shelf. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. false  
activated NsBoolean boolean Activated state for shelf or disk set means it is available to store date on. An activated shelf may not be deactivated. Possible values: 'true', 'false'. true  
driveset NsUnsignedInt number Driveset to activate. Unsigned 32-bit integer. Example: 1234. false  
force NsBoolean boolean Forcibly activate shelf. Possible values: 'true', 'false'. false  

JSON Request

            
            
            {
               "data" : {
                  "shelf_op" : "add"
                  "force"    : "true"
               }
            }
            
        
         

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": "090635b3cf4c9f5b73000000000000000000000001",
                    "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_1458238671.218442",
                                    "sw_type": "Head Shelf"
                                }
                            ],
                            "ctrlr_hw_model": "head_x8",
                            "ctrlr_sensor_last_run": 19740758507,
                            "ctrlr_sensors": [
                                {
                                    "cid": "A",
                                    "display_name": "motherboard",
                                    "location": "motherboard",
                                    "name": "motherboard",
                                    "status": "OK",
                                    "type": "temperature",
                                    "value": 22
                                },
                                {
                                    "cid": "A",
                                    "display_name": "bp-temp1",
                                    "location": "left-side backplane",
                                    "name": "bp-temp1",
                                    "status": "OK",
                                    "type": "temperature",
                                    "value": 30
                                },
                                {
                                    "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": 7605
                                },
                                {
                                    "cid": "A",
                                    "display_name": "fan5",
                                    "location": "upper left front of controller A",
                                    "name": "fan5",
                                    "status": "OK",
                                    "type": "fan",
                                    "value": 7515
                                },
                                {
                                    "cid": "A",
                                    "display_name": "fan6",
                                    "location": "upper left rear of controller A",
                                    "name": "fan6",
                                    "status": "OK",
                                    "type": "fan",
                                    "value": 7650
                                }
                            ],
                            "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": -1,
                                    "remote_port_id": -1,
                                    "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_1458238671.121843",
                                    "sw_type": "Head Shelf"
                                }
                            ],
                            "ctrlr_hw_model": "head_x8",
                            "ctrlr_sensor_last_run": 19790879605,
                            "ctrlr_sensors": [
                                {
                                    "cid": "B",
                                    "display_name": "motherboard",
                                    "location": "motherboard",
                                    "name": "motherboard",
                                    "status": "OK",
                                    "type": "temperature",
                                    "value": 21
                                },
                                {
                                    "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": 7545
                                },
                                {
                                    "cid": "B",
                                    "display_name": "fan5",
                                    "location": "upper left front of controller B",
                                    "name": "fan8",
                                    "status": "OK",
                                    "type": "fan",
                                    "value": 7485
                                },
                                {
                                    "cid": "B",
                                    "display_name": "fan6",
                                    "location": "upper left rear of controller B",
                                    "name": "fan9",
                                    "status": "OK",
                                    "type": "fan",
                                    "value": 7035
                                }
                            ],
                            "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": -1,
                                    "remote_port_id": -1,
                                    "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": "2d0635b3cf4c9f5b73000000010000414100018815",
                    "model": "CS210",
                    "model_ext": "CS210-8T-160F",
                    "psu_overall_status": "OK",
                    "serial": "AA-100373",
                    "temp_overall_status": "OK"
                }
            }