Update

PUT v1/arrays/id

Description

Modify the settings for the array.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Detail Codes

SM_array_rename_in_netconfig_failed

SM_config_sync_inprogress

SM_eexist

SM_invalid_arg_value

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_missing_arg

SM_missing_array_netconfig

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 Identifier for array. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. true  
name NsHostName string The user provided name of the array. It is also the array's hostname. String of up to 63 alphanumeric and can include hyphens characters but cannot start with hyphen. false  
force NsBoolean boolean Forcibly delete the specified array. Possible values: 'true', 'false'. false  

JSON Request 


            
            
            {
               "data" : {
                  "name" : "newname"
               }
            }

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string Identifier for array. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
name NsHostName string The user provided name of the array. It is also the array's hostname. String of up to 63 alphanumeric and can include hyphens characters but cannot start with hyphen.  
full_name NsObjectName string The array's fully qualified name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
search_name NsSearchName string The array name used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'.  
pool_name NsObjectName string Name of pool to which this is a member. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
model NsObjectName string Array model. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
serial NsArraySerialNumber string Serial number of the array. Example: 'AC-109084'.  
version NsObjectName string Software version of the array. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
creation_time NsTime number Time when this array object was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
last_modified NsTime number Time when this array object was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
usage_valid NsBoolean boolean Indicates whether the usage of array is valid. Possible values: 'true', 'false'.  
usable_capacity_bytes NsBytes number The usable capacity bytes of array. Unsigned 64-bit integer. Example: '1234'.  
raw_capacity_bytes NsBytes number The raw capacity bytes of array. Unsigned 64-bit integer. Example: '1234'.  
vol_usage_bytes NsBytes number The compressed usage of volumes in array. Unsigned 64-bit integer. Example: '1234'.  
vol_compression NsRatio number The compression rate of volumes in array expressed as ratio. Fraction expressed as floating point number. Example: '9.18'.  
vol_saved_bytes NsBytes number The saved space of volumes in array. Unsigned 64-bit integer. Example: '1234'.  
snap_usage_bytes NsBytes number The compressed usage of snapshots in array. Unsigned 64-bit integer. Example: '1234'.  
snap_compression NsRatio number The compression rate of snapshots in array expressed as ratio. Fraction expressed as floating point number. Example: '9.18'.  
snap_space_reduction NsRatio number The space reduction rate of snapshots in array expressed as ratio. Fraction expressed as floating point number. Example: '9.18'.  
snap_saved_bytes NsBytes number The saved space of snapshots in array. Unsigned 64-bit integer. Example: '1234'.  
pending_delete_bytes NsBytes number The pending delete bytes in array. Unsigned 64-bit integer. Example: '1234'.  
available_bytes NsBytes number The available space of array. Unsigned 64-bit integer. Example: '1234'.  
usage NsBytes number Used space of the array in bytes. Unsigned 64-bit integer. Example: '1234'.  
all_flash NsBoolean boolean Whether it is an all-flash array. Possible values: 'true', 'false'.  
dedupe_capacity_bytes NsBytes number The dedupe capacity of a hybrid array. Does not apply to all-flash arrays. Unsigned 64-bit integer. Example: '1234'.  
dedupe_usage_bytes NsBytes number The dedupe usage of a hybrid array. Does not apply to all-flash arrays. Unsigned 64-bit integer. Example: '1234'.  
extended_model NsObjectName string Extended model of the array. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
is_supported_hw_config NsBoolean boolean Whether it is a supported hardware config. Possible values: 'true', 'false'.  
gig_nic_port_count NsUnsignedLong number Count of 1G NIC Ports installed on the array. Unsigned 64-bit integer. Example: 1234. Yes
ten_gig_sfp_nic_port_count NsUnsignedLong number Count of 10G SFP NIC Ports installed on the array. Unsigned 64-bit integer. Example: 1234. Yes
ten_gig_t_nic_port_count NsUnsignedLong number Count of 10G BaseT NIC Ports installed on the array. Unsigned 64-bit integer. Example: 1234. Yes
fc_port_count NsUnsignedLong number Count of Fibre Channel Ports installed on the array. Unsigned 64-bit integer. Example: 1234. Yes

JSON Response 


            
            
            {
                "data": {
                    "available_bytes": 4338029297664,
                    "creation_time": 1426263446,
                    "description": "",
                    "full_name": "newname",
                    "id": "090211f0840c09761c000000000000000000000001",
                    "last_modified": 1426263446,
                    "member_gid": 1,
                    "model": "CS210",
                    "name": "newname",
                    "pending_delete_bytes": 0,
                    "pool_id": "0a0211f0840c09761c000000000000000000000001",
                    "pool_name": "default",
                    "raw_capacity_bytes": 8001639088128,
                    "reachable": true,
                    "search_name": "newname",
                    "serial": "AF-108017",
                    "snap_compression": 0,
                    "snap_saved_bytes": 0,
                    "snap_space_reduction": 0,
                    "snap_usage_bytes": 0,
                    "usable_capacity_bytes": 4338029297664,
                    "version": "0.0.430.0-rlabiaga-2015.03.12.19.58.00-dbg",
                    "vol_compression": 0,
                    "vol_saved_bytes": 0,
                    "vol_usage_bytes": 0
                }
            }