/mgmt/status/default/NetworkInterfaceStatus GET

Use the HTTP GET method with the /mgmt/status/default/NetworkInterfaceStatus resource to request information about the network interfaces on the appliance.

Resource URL

https://host:port/mgmt/status/default/NetworkInterfaceStatus
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
Status information retrieved successfully.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. The response includes information about available network interfaces. Each object contains the following fields:
InterfaceIndex
Index.
The value of the SNMP ifIndex column in the ifTable for the interface.
InterfaceType
String.
  • Ethernet Indicates that it is on the base Ethernet MAC interface.
  • Tunnel Indicates that it is on a encapsulation interface.
  • VLAN Indicates that it is on an IEEE 802.1Q VLAN on top of the base Ethernet MAC interface.
  • Aggregate Indicates that it is on an IEEE 802.3ad Link Aggregation composed of one of the base Ethernet MAC interface.
  • Other Refers to network interfaces that you cannot configure.
Name
String.
The configuration name of the interface.
AdminStatus
String.
The configured administrative state of the interface.
  • Enabled The administrative state of the interface is enabled.
  • Disabled The administrative state of the interface is disabled.
OperStatus
The current operational state of the interface.
  • up The interface is operationally up.
  • down The interface is operationally down.
  • testing Some testing mode. After the test completes, the status changes as appropriate.
  • unknown Cannot determine the operational state of the interface.
  • dormant The interface is waiting for a connection.
  • notPresent The interface is not present.
  • LowerLayerDown The required lower layer is down.
IPType
String.
The IP address version: ipv4 or ipv6.
  • unknown An unknown address type.
  • ipv4 An IPv4 address.
  • ipv6 An IPv6 address.
  • ipv4z A nonglobal IPv4 address with a zone index.
  • ipv6z A nonglobal IPv6 address with a zone index.
  • dns A DNS domain name
IP
String.
The primary IP address for the interface.
PrefixLength
String.
The prefix length of the IP address that represents the configured netmask.
MACAddress
String.
The current MAC address of the interface. The address can be the pre-programmed one, overridden by your configuration, or overridden by standby control if the interface is the active member of the standby group.
MTU
Integer.
Maximum transmission unit for the interface.
RxHCBytes
Integer.
The amount of data successfully received on the interface, which includes MAC framing overhead.
RxHCPackets
Integer.
The number of packets successfully received on the interface that were passed up to the network layer for processing.
RxErrors2
Integer.
The number of packets that could not be received due to errors in the packet or in the hardware.
RxDrops2
Integer.
The number of received packets that were not in error, but were not passed up to the network layer due to resource constraints.
TxHCBytes
Integer.
The amount of data successfully transmitted on the interface, which includes MAC framing overhead.
TxHCPackets
Integer.
The number of packets successfully transmitted on the interface.
TxErrors2
Integer.
The number of packets that were not successfully transmitted due to errors on the network or in the hardware.
TxDrops2
Integer.
The number of packets that were not transmitted because the network layer was generating packets faster than the physical network could accept them.

Examples

The following example requests information about network interfaces.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/NetworkInterfaceStatus
The following listing shows sections from an example received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/NetworkInterfaceStatus"
    },
    "doc": {
      "href": "/mgmt/docs/status/NetworkInterfaceStatus"
    }
  },
  "NetworkInterfaceStatus": [
    {
      "InterfaceIndex": 1,
      "InterfaceType": "Other",
      "Name": "lo",
      "AdminStatus": "up",
      "OperStatus": "up",
      "IPType": "ipv4",
      "IP": "127.0.0.1",
      "PrefixLength": 8,
      "MACAddress": "00:00:00:00:00:00",
      "MTU": 65536,
      "RxHCBytes": 1869015199,
      "RxHCPackets": 14005952,
      "RxErrors2": 0,
      "RxDrops2": 0,
      "TxHCBytes": 1869015199,
      "TxHCPackets": 14005952,
      "TxErrors2": 0,
      "TxDrops2": 0
    },
    {
      "InterfaceIndex": 2,
      "InterfaceType": "Other",
      "Name": "sit0",
      "AdminStatus": "down",
      "OperStatus": "lowerLayerDown",
      "IPType": "ipv4",
      "IP": "",
      "PrefixLength": 0,
      "MACAddress": "00:00:00:00:00:00",
      "MTU": 1480,
      "RxHCBytes": 0,
      "RxHCPackets": 0,
      "RxErrors2": 0,
      "RxDrops2": 0,
      "TxHCBytes": 0,
      "TxHCPackets": 0,
      "TxErrors2": 0,
      "TxDrops2": 0
    },
...
{
      "InterfaceIndex": 15,
      "InterfaceType": "Ethernet",
      "Name": "eth17",
      "AdminStatus": "down",
      "OperStatus": "lowerLayerDown",
      "IPType": "ipv4",
      "IP": "",
      "PrefixLength": 0,
      "MACAddress": "00:0b:ab:83:ec:ce",
      "MTU": 1500,
      "RxHCBytes": 0,
      "RxHCPackets": 0,
      "RxErrors2": 0,
      "RxDrops2": 0,
      "TxHCBytes": 0,
      "TxHCPackets": 0,
      "TxErrors2": 0,
      "TxDrops2": 0
    }
  ]
}