/mgmt/status/default/EthernetCountersStatus GET

Use the HTTP GET method with the /mgmt/status/default/EthernetCountersStatus resource to request detailed statistics for each Ethernet device on the appliance.

Resource URL
Request headers
Request body format
Security requirements
Response status codes
Response headers
Response body format
Examples

Resource URL

https://host:port/mgmt/status/default/EthernetCountersStatus

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 from the Ethernet interfaces. Each object contains the following fields:

InterfaceIndex: Integer.; The value of the SNMP ifIndex column in the ifTable for this interface.
Name: String.; The name of the ethernet interface.
InUnicastPackets: Integer.; The number of unicast packets received on this interface.
InMulticastPackets: Integer.; The number of multicast packets received on this interface.
InBroadcastPackets: Integer.; The number of broadcast packets received on this interface.
OutUnicastPackets: String.; The number of unicast packets transmitted on this interface.
OutMulticastPackets: Integer.; The number of multicast packets transmitted on this interface.
OutBroadcastPackets: Integer.; The number of broadcast packets transmitted on this interface.
InOctets: Integer.; The number of bytes received on this interface at the MAC level.
OutOctets: Integer.; The number of bytes transmitted on this interface at the MAC level.
InErrors: Integer.; The total number of receive errors on this interface.
OutErrors: Integer.; The total number of transmit errors on this interface.
OutDiscards: Integer.; The number of packets not transmitted for flow control reasons.
AlignmentErrors: Integer.; The number of packets received on this interface that were not an integral number of bytes in length.
FCSErrors: Integer.; The number of packets received on this interface with an invalid Frame Check Sequence (checksum). This does not include FCS errors on packets that were too long or too short.
SingleCollisionFrames: Integer.; The number of packets successfully transmitted on this interface after a single collision. This can only happen when the interface is running in Half-Duplex mode.
MultipleCollisionFrames: Integer.; The number of packets successfully transmitted on this interface after multiple collisions, but less than 16 collisions. This can only happen when the interface is running in Half-Duplex mode.
SQETestErrors: Integer.; The number of times that an SQE test error was encountered. This only can happen when the link is operating in 10BASE-T Half-Duplex.
DeferredTransmissions: Integer.; The number of frames for which the first transmission attempt was deferred because the medium was busy. This can only happen when the interface is running in Half-Duplex mode.
LateCollisions: Integer.; The number of times that a collision was detected later than one slot time after the transmission of a packet. This can only happen when the interface is running in Half-Duplex mode.
ExcessiveCollisions: Integer.; The number of times that transmission of a packet failed because it encountered sixteen collisions in a row. This can only happen when the interface is running in Half-Duplex mode.
InternalMacTransmitErrors: String.; The number of times that transmission of packets failed due to errors inside the MAC layer of the Ethernet interface. These may be due to temporary resource limitations.
CarrierSenseErrors: Integer.; The number transmitted packets during which there were failures of carrier sense. This can only happen when the interface is running in Half-Duplex mode.
FrameTooShorts: Integer.; The number of received packets that were shorter than 64 bytes. This can be the result of a collision. Such packages are also known as runts.
FrameTooLongs: Integer.; The number of received packets that were longer than the configured MTU. This can be the result of a collision, as well as due to incompatible configuration.
InternalMacReceiveErrors: Integer.; The number of times that reception of packets failed due to errors inside the MAC layer of the Ethernet interface. These may be due to temporary resource limitations.
InPauseFrames: Integer.; The number of pause frames received.
OutPauseFrames: Integer.; The number of pause frames transmitted.

Examples

The following example requests detailed statistics for each Ethernet device.

The following URL is used with the HTTP GET method:

https://localhost:5554/mgmt/status/default/EthernetCountersStatus

The following listing shows sections from the received response:

{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/EthernetCountersStatus"
    },
    "doc": {
      "href": "/mgmt/docs/status/EthernetCountersStatus"
    }
  },
  "EthernetCountersStatus": [
    {
      "InterfaceIndex": 4,
      "Name": "mgt0",
      "InUnicastPackets": "",
      "InMulticastPackets": 25935923,
      "InBroadcastPackets": 1805817,
      "OutUnicastPackets": "",
      "OutMulticastPackets": 6,
      "OutBroadcastPackets": 59,
      "InOctets": 2361799647,
      "OutOctets": 682384283,
      "InErrors": 0,
      "OutErrors": 0,
      "OutDiscards": 0,
      "AlignmentErrors": 0,
      "FCSErrors": 0,
      "SingleCollisionFrames": 0,
      "MultipleCollisionFrames": 0,
      "SQETestErrors": 0,
      "DeferredTransmissions": 0,
      "LateCollisions": 0,
      "ExcessiveCollisions": 0,
      "InternalMacTransmitErrors": "",
      "CarrierSenseErrors": 0,
      "FrameTooShorts": 0,
      "FrameTooLongs": 0,
      "InternalMacReceiveErrors": 0,
      "InPauseFrames": 0,
      "OutPauseFrames": 0
    },
.......
    {
      "InterfaceIndex": 15,
      "Name": "eth17",
      "InUnicastPackets": "",
      "InMulticastPackets": 0,
      "InBroadcastPackets": 0,
      "OutUnicastPackets": "",
      "OutMulticastPackets": 0,
      "OutBroadcastPackets": 0,
      "InOctets": 0,
      "OutOctets": 0,
      "InErrors": 0,
      "OutErrors": 0,
      "OutDiscards": 0,
      "AlignmentErrors": 0,
      "FCSErrors": 0,
      "SingleCollisionFrames": 0,
      "MultipleCollisionFrames": 0,
      "SQETestErrors": 0,
      "DeferredTransmissions": 0,
      "LateCollisions": 0,
      "ExcessiveCollisions": 0,
      "InternalMacTransmitErrors": "",
      "CarrierSenseErrors": 0,
      "FrameTooShorts": 0,
      "FrameTooLongs": 0,
      "InternalMacReceiveErrors": 0,
      "InPauseFrames": 0,
      "OutPauseFrames": 0
    }
  ]
}