Create
POST v1/arrays
Description
Creates an array with given attributes.
Normal Response Codes
201
HTTP Error Codes
400 401 403 404 409 500 503
Detail Codes
Request
| Parameter | Type | JSON Type | Description | Default | Mandatory | Deprecated |
|---|---|---|---|---|---|---|
| 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. | true | ||
| 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'. | true | ||
| serial | NsArraySerialNumber | string | Serial number of the array. Example: 'AC-109084'. | true | ||
| create_pool | NsBoolean | boolean | Whether to create associated pool during array create. Possible values: 'true', 'false'. | 'false' | false | |
| pool_description | NsDescription | string | Text description of the pool to be created during array creation. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | '' | false | |
| ctrlr_a_support_ip | NsIPAddress | string | Controller A Support IP Address. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'. | true | ||
| ctrlr_b_support_ip | NsIPAddress | string | Controller B Support IP Address. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'. | true | ||
| nic_list | NsNICList | Array of NsNIC | List NICs information. Used when creating an array. List of NICs. | true |
JSON Request
{
"data" : {
"nic_list" : [
{
"subnet_label" : "Management",
"data_ip" : "127.0.0.23",
"name" : "eth1"
},
{
"subnet_label" : "Management",
"data_ip" : "127.0.0.24",
"name" : "eth2"
},
{
"subnet_label" : "Management",
"data_ip" : "127.0.0.25",
"name" : "eth3"
},
{
"subnet_label" : "Management",
"data_ip" : "127.0.0.26",
"name" : "eth4"
}
],
"serial" : "g1a2",
"name" : "g1a2",
"ctrlr_b_support_ip" : "127.0.0.22",
"ctrlr_a_support_ip" : "127.0.0.21",
"pool_name" : "default"
}
}
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for array. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| 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'. | |
| 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" : {
"all_flash" : false,
"available_bytes" : 3983343616,
"creation_time" : 1461960572,
"description" : "",
"full_name" : "g1a2",
"id" : "0900000000000004d3000000000000000000000002",
"last_modified" : 1461960573,
"model" : "desktop",
"name" : "g1a2",
"pending_delete_bytes" : 0,
"pool_id" : "0a00000000000004d3000000000000000000000001",
"pool_name" : "default",
"raw_capacity_bytes" : 0,
"role" : "member",
"search_name" : "g1a2",
"serial" : "g1a2",
"snap_compression" : 1,
"snap_saved_bytes" : 0,
"snap_space_reduction" : 1,
"snap_usage_bytes" : 0,
"usable_capacity_bytes" : 3983343616,
"usage" : 0,
"usage_valid" : true,
"version" : "1.0.0.2",
"vol_compression" : 1,
"vol_saved_bytes" : 0,
"vol_usage_bytes" : 0,
"status" : "reachable"}
}