Read
GET v1/network_configs
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsNetConfigName |
| mgmt_ip | NsIPAddress |
| role | NsNetConfigRole |
| iscsi_automatic_connection_method | NsBoolean |
| iscsi_connection_rebalancing | NsBoolean |
| group_leader_array | NsObjectName |
| creation_time | NsTime |
| last_modified | NsTime |
| active_since | NsTime |
| last_active | NsTime |
GET v1/network_configs/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsNetConfigName |
| mgmt_ip | NsIPAddress |
| role | NsNetConfigRole |
| iscsi_automatic_connection_method | NsBoolean |
| iscsi_connection_rebalancing | NsBoolean |
| group_leader_array | NsObjectName |
| creation_time | NsTime |
| last_modified | NsTime |
| active_since | NsTime |
| last_active | NsTime |
Description
List a set of network configurations or a single network configuration.
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 network configuration. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsNetConfigName | string enum | Name of the network configuration. Use the name 'draft' when creating a draft configuration. Possible values: 'active', 'backup', 'draft'. | |
| mgmt_ip | NsIPAddress | string | Management IP for the Group. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'. | |
| role | NsNetConfigRole | string enum | Role of network configuration. Possible values: 'active', 'backup', 'draft'. | |
| iscsi_automatic_connection_method | NsBoolean | boolean | Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP to the best data IP based on connection counts. Possible values: 'true', 'false'. | |
| iscsi_connection_rebalancing | NsBoolean | boolean | Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP. Possible values: 'true', 'false'. | |
| route_list | NsRouteConfigs | Array of NsRoute | List of static routes. List of route configs. | |
| subnet_list | NsSubnetConfigs | Array of NsSubnet | List of subnet configs. List of subnet configs. | |
| array_list | NsArrayNetConfigs | Array of NsArrayNet | List of array network configs. List of array network configs. | |
| group_leader_array | NsObjectName | string | Name of the group leader 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 net configuration was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this network configuration was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| active_since | NsTime | number | Start time of activity. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_active | NsTime | number | Time of last activity. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. |
JSON Response
{
{
"response": {
"totalRows": "1",
"data": [
{
"array_list": [
{
"name": "g1a1",
"member_gid": 1,
"ctrlr_a_support_ip": "127.0.0.11",
"ctrlr_b_support_ip": "127.0.0.21",
"nic_list": [
{
"name": "eth1",
"subnet_label": "subnet1",
"data_ip": "127.0.0.91",
"tagged": false
}
]
},
{
"name": "g1a2",
"member_gid": 2,
"ctrlr_a_support_ip": "127.0.0.12",
"ctrlr_b_support_ip": "127.0.0.22",
"nic_list": [
{
"name": "eth1",
"subnet_label": "subnet1",
"data_ip": "127.0.0.92",
"tagged": false
}
]
},
{
"name": "g1a3",
"member_gid": 3,
"ctrlr_a_support_ip": "127.0.0.13",
"ctrlr_b_support_ip": "127.0.0.23",
"nic_list": [
{
"name": "eth1",
"subnet_label": "subnet1",
"data_ip": "127.0.0.93",
"tagged": false
}
]
},
{
"name": "g1a4",
"member_gid": 4,
"ctrlr_a_support_ip": "127.0.0.14",
"ctrlr_b_support_ip": "127.0.0.24",
"nic_list": [
{
"name": "eth1",
"subnet_label": "subnet1",
"data_ip": "127.0.0.94",
"tagged": false
}
]
}
],
"config_active_since": 1337403904,
"config_last_active": 1337403827,
"config_last_modified": 1337403450,
"id": "1300000000000004d30000000000000001",
"iscsi_automatic_connection_method": true,
"iscsi_connection_rebalancing": true,
"mgmt_ip": "127.0.0.101",
"name": "active",
"role": "active",
"route_list": [
{
"gateway": "127.0.0.1",
"tgt_network": "0.0.0.0",
"tgt_netmask": "0.0.0.0"
},
{
"gateway": "127.0.0.2",
"tgt_network": "127.0.2.0",
"tgt_netmask": "255.255.255.0"
},
{
"gateway": "127.0.0.3",
"tgt_network": "127.0.3.0",
"tgt_netmask": "255.255.255.0"
},
{
"gateway": "127.0.0.4",
"tgt_network": "127.0.4.0",
"tgt_netmask": "255.255.255.0"
}
],
"subnet_list": [
{
"label": "subnet1",
"network": "127.0.0.0",
"netmask": "255.0.0.0",
"type": "mgmt,data",
"allow_iscsi": true,
"allow_group": true,
"netzone_type": "single",
"discovery_ip": "127.0.0.102",
"mtu": 1500,
"vlan_id": 0
}
]
}
]
}
}
}