Read
GET v1/network_interfaces
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| array_name_or_serial | NsObjectName |
| partial_response_ok | NsBoolean |
GET v1/network_interfaces/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| array_name_or_serial | NsObjectName |
| partial_response_ok | NsBoolean |
Description
List a set of network interfaces or a single network interface.
Normal Response Codes
200
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the interface. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| array_name_or_serial | NsObjectName | string | Name or serial of the array where the interface is hosted. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| array_id | NsObjectID | string | Identifier for the array. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| controller_name | NsString | string | Name (A or B) of the controller where the interface is hosted. Plain string. | Yes |
| controller_id | NsObjectID | string | Identifier of the controller where the interface is hosted. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsObjectName | string | Name of the interface. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| mac | NsMac | string | MAC address of the interface. Mac address of an interface. | |
| is_present | NsBoolean | boolean | Whether this interface is present on this controller. Possible values: 'true', 'false'. | |
| link_speed | NsPlatLinkSpeed | string enum | Speed of the link. Possible values: 'link_speed_unknown', 'link_speed_10M', 'link_speed_100M', 'link_speed_1000M', 'link_speed_10000M'. | |
| link_status | NsPlatLinkStatus | string enum | Status of the link. Possible values: 'link_status_unknown', 'link_status_down', 'link_status_up'. | |
| mtu | NsUnsignedLong | number | MTU on the link. Unsigned 64-bit integer. Example: 1234. | |
| port | NsUnsignedLong | number | Port number for this interface. Unsigned 64-bit integer. Example: 1234. | |
| slot | NsUnsignedLong | number | Slot number for this interface. Unsigned 64-bit integer. Example: 1234. | |
| max_link_speed | NsPlatLinkSpeed | string enum | Maximum speed of the link. Possible values: 'link_speed_unknown', 'link_speed_10M', 'link_speed_100M', 'link_speed_1000M', 'link_speed_10000M'. | |
| nic_type | NsPlatNicType | string enum | Interface type. Possible values: 'nic_type_unknown', 'nic_type_tp', 'nic_type_sfp'. |
JSON Response
{
"data": [
{
"array_id": "0900000000000004d3000000000000000000000004",
"controller_id": "c300000000000004d3000000000000000400000000",
"controller_name": "A",
"id": "1c00000000000004d3000000040000000001010000",
"is_present": 1,
"link_speed": "link_speed_1000M",
"link_status": "link_status_up",
"mac": "11:33:55:77:99:BB",
"max_link_speed": "link_speed_1000M",
"mtu": 1500,
"name": "eth1",
"nic_type": "nic_type_tp",
"port": 0,
"slot": 0
},
{
"array_id": "0900000000000004d3000000000000000000000004",
"controller_id": "c300000000000004d3000000000000000400000000",
"controller_name": "A",
"id": "1c00000000000004d3000000040000000001020000",
"is_present": 1,
"link_speed": "link_speed_1000M",
"link_status": "link_status_up",
"mac": "11:33:55:77:99:BB",
"max_link_speed": "link_speed_1000M",
"mtu": 1500,
"name": "eth2",
"nic_type": "nic_type_tp",
"port": 0,
"slot": 0
}
],
"endRow": 2,
"startRow": 0,
"totalRows": 2
}