REST API Reference Version 5.2.1.0Search

Update

PUT v1/disks/id

Query parameters

Parameter Type
force NsBoolean

Description

Add or remove a disk.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Request

Parameter Type JSON Type Description Mandatory Deprecated
id NsObjectID string ID of disk. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. false  
disk_op NsDiskOp string enum The intended operation to be performed on the specified disk. Disk operation. Possible values: 'add', 'remove'. true  
force NsBoolean boolean Forcibly add a disk. Possible values: 'true', 'false'. false  

JSON Request

            
            
            {
                "data" : {
                    "disk_op" : "remove",
                    "force"   : "true"
                }
            }
            
        
         

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string ID of disk. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
is_dfc NsBoolean boolean Is disk part of dual flash carrier. Possible values: 'true', 'false'.  
serial NsString string Disk serial number(N/A if empty). Plain string.  
path NsString string Disk SCSI device path. Plain string.  
shelf_serial NsString string Serial number of the shelf the disk is attached to. Plain string.  
shelf_location NsString string Identifies the controller, port, and chain position of the shelf the disk belongs to. Plain string.  
shelf_id NsObjectID string Identifies the physical shelf the disk belongs to. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
shelf_location_id NsUnsignedLong number Identifies the position shelf the disk belongs to, as coded integer. Unsigned 64-bit integer. Example: 1234.  
vshelf_id NsUnsignedLong number Identifies the local shelf id the disk belongs to. Unsigned 64-bit integer. Example: 1234.  
slot NsUnsignedLong number Disk slot number. Unsigned 64-bit integer. Example: 1234.  
bank NsUnsignedLong number Disk bank number. Unsigned 64-bit integer. Example: 1234.  
model NsString string Disk model name. Plain string.  
vendor NsString string Vendor name of the disk manufacturer. Plain string.  
firmware_version NsString string Firmware version on the disk. Plain string.  
hba NsUnsignedLong number HBA ID the disk is connected to. Unsigned 64-bit integer. Example: 1234.  
port NsUnsignedLong number HBA port number the disk is connected to. Unsigned 64-bit integer. Example: 1234.  
size NsUnsignedLong number Disk size in bytes. Unsigned 64-bit integer. Example: 1234.  
state NsDiskState string enum Disk hardware state. Disk state. Possible values: 'valid', 'in use', 'failed', absent', 'removed', 'void', 't_fail', 'foreign'.  
type NsDiskType string enum Type of disk (HDD, SSD, N/A). Disk type. Possible values: 'hdd', 'ssd'.  
raid_id NsUnsignedLong number Raid ID. Unsigned 64-bit integer. Example: 1234.  
raid_resync_percent NsUnsignedLong number Percentage RAID rebuild completed on this disk. Unsigned 64-bit integer. Example: 1234.  
raid_resync_current_speed NsUnsignedLong number Current RAID rebuild speed (bytes/sec). Unsigned 64-bit integer. Example: 1234.  
raid_resync_average_speed NsUnsignedLong number Average RAID rebuild speed (bytes/sec). Unsigned 64-bit integer. Example: 1234.  
raid_state NsDiskRaidState string enum RAID status for the disk (N/A, okay, resynchronizing, spare, faulty). Disk RAID state. Possible values: 'N/A', 'okay', 'resynchronizing', 'spare', 'faulty'.  
smart_attribute_list NsDiskSmartAttributeList Array of NsDiskSmartAttribute S.M.A.R.T. attributes for the disk. List of Smart attributes.  
array_name NsObjectName string Name of array the disk 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 disk belongs to. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  

JSON Response

            
            
                {
                    "data": {
                        "array_id": "09736f213cf827e177000000000000000000000001",
                        "array_name": "c12-array5",
                        "bank": 0,
                        "disk_internal_stat_1": "00cf9d220c",
                        "firmware_version": "01.01V01",
                        "hba": 0,
                        "id": "2c736f213cf827e1770001000000000a0000000100",
                        "is_dfc": false,
                        "model": "WDC WD1003FBYX-01Y7B0",
                        "path": "/dev/sdj",
                        "port": 15,
                        "raid_id": 10,
                        "raid_resync_average_speed": 0,
                        "raid_resync_current_speed": 0,
                        "raid_resync_percent": 100,
                        "raid_state": "N/A",
                        "serial": "WD-WCAW31074925",
                        "shelf_id": "2d736f213cf827e177000000010000414100018815",
                        "shelf_location": "A.0",
                        "shelf_location_id": 0,
                        "shelf_serial": "AA-100373",
                        "size": 1000204886016,
                        "slot": 1,
                        "smart_attribute_list": [
                            {
                                "cur_value": 200,
                                "flags": 47,
                                "last_updated_epoch_secs": 1463324503,
                                "name": "Raw read error rate",
                                "raw_value": 2,
                                "smart_id": 1,
                                "threshold": 51,
                                "worst_value": 200
                            },
                        ],
                        "state": "removed",
                        "type": "hdd",
                        "vendor": "OEM",
                        "vshelf_id": 0
                    }
                }