Read
GET v1/subnets
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsObjectName |
| network | NsIPAddress |
| netmask | NsIPNetmask |
| type | NsSubnetType |
| allow_iscsi | NsBoolean |
| allow_group | NsBoolean |
| discovery_ip | NsIPAddress |
| mtu | NsMTU |
| netzone_type | NsNetZoneType |
| vlan_id | NsVlanId |
| creation_time | NsTime |
| last_modified | NsTime |
GET v1/subnets/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsObjectName |
| network | NsIPAddress |
| netmask | NsIPNetmask |
| type | NsSubnetType |
| allow_iscsi | NsBoolean |
| allow_group | NsBoolean |
| discovery_ip | NsIPAddress |
| mtu | NsMTU |
| netzone_type | NsNetZoneType |
| vlan_id | NsVlanId |
| creation_time | NsTime |
| last_modified | NsTime |
Description
Lists subnets.
Normal Response Codes
200 206
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the initiator group. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsObjectName | string | Name of subnet configuration. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| network | NsIPAddress | string | Subnet network address. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'. | |
| netmask | NsIPNetmask | string | Subnet netmask address. A netmask expressed as a 32 bit binary value must have the highest bit set (2^31) and the lowest bit clear (2^0) with the first zero followed by only zeros. Example: '255.255.255.0'. | |
| type | NsSubnetType | string enum | Subnet type. Options include 'mgmt', 'data', and 'mgmt,data'. Possible values: 'invalid', 'unconfigured', 'mgmt', 'data', 'mgmt_data'. | |
| allow_iscsi | NsBoolean | boolean | Subnet type. Possible values: 'true', 'false'. | |
| allow_group | NsBoolean | boolean | Subnet type. Possible values: 'true', 'false'. | |
| discovery_ip | NsIPAddress | string | Subnet network address. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'. | |
| mtu | NsMTU | number | MTU for specified subnet. Valid MTU's are in the 512-16000 range. Positive integer in range [576,16000]. | |
| netzone_type | NsNetZoneType | string enum | Specify Network Affinity Zone type for iSCSI enabled subnets. Valid types are Single, Bisect, and EvenOdd for iSCSI subnets. Possible values: 'none', 'evenodd', 'bisect', 'single'. | |
| vlan_id | NsVlanId | number | VLAN ID for specified subnet. Valid ID's are in the 1-4094 range. Positive integer in range [0,4096]. | |
| creation_time | NsTime | number | Time when this subnet configuration was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this subnet configuration was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. |
JSON Response
{
{"response":
{"totalRows":"1","data":[
{
"allow_group":true,
"allow_iscsi":true,
"discovery_ip":"127.0.0.102",
"id":"0c00000000000004d30000000000000001",
"mtu":1500,
"name":"subnet1",
"netmask":"255.0.0.0",
"network":"127.0.0.0",
"netzone_type":"single",
"type":"mgmt,data",
"vlan_id":0
}
]}
}
}