/mgmt/status/default/LinkStatus GET

Use the HTTP GET method with the /mgmt/status/default/LinkStatus resource to request status for the interfaces on the appliance.

Resource URL

https://host:port/mgmt/status/default/LinkStatus
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 interfaces on the appliance. Each object contains the following fields:
Name
String.
The name of the interface in the configuration.
Index
Integer.
The if index for the interface.
Status
String.
the current link state for the interface.
  • ok The interface is responding to the network.
  • noLink The interface is not responding to the network.
Mode
String.
Identifies the actual fixed, configured, or negotiated Ethernet PHY mode, including speed and duplex.
  • 10BASE-T-HD PHY is running 10BASE-T (10 mbps) in half-duplex mode.
  • 10BASE-T-FD PHY is running 10BASE-T (10 mbps) in full-duplex mode.
  • 100BASE-TX-HD PHY is running 100BASE-TX (100 mbps) in half-duplex mode.
  • 100BASE-TX-FD PHY is running 100BASE-TX (100 mbps) in full-duplex mode.
  • 1000BASE-T-FD PHY is running 1000BASE-T (1000 mbps) in full-duplex mode.
  • 1000BASE-KX PHY is 1000BASE-KX (1000 mbps) in full-duplex mode over backplane.
  • 10GBASE-KX4 PHY is 10GBASE-KX4 (10 gbps) in full-duplex mode over backplane.
  • 10GBASE-CR PHY is 10GBASE-CR (10 gbps) in full-duplex mode.
  • 10GBASE-SR PHY is 10GBASE-SR (10 gbps) in full-duplex mode.
  • 40GBASE-CR4 PHY is 40GBASE-CR4 (40 gbps) in full-duplex mode.
  • 40GBASE-SR4 PHY is 40GBASE-SR4 (40 gbps) in full-duplex mode.
  • none No PHY has been negotiated, no link.
Type
String.
The type of interface:
  • 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.
MTU
Integer.
Identifies the maximum transmission unit (MTU) for the interface.
Aggregate
String.
Indicates the associated aggregate interface, if any.
LinkAddress
String.
Identifies the physical IP address for the interface. The default value for Ethernet interfaces is programmed in the Ethernet hardware.

Examples

The following example requests information about interfaces on the appliance.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/LinkStatus
The following listing shows an example received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/LinkStatus"
    },
    "doc": {
      "href": "/mgmt/docs/status/LinkStatus"
    }
  },
  "LinkStatus": [
    {
      "Name": "lo",
      "Index": 1,
      "Status": "ok",
      "Mode": "none",
      "Type": "Other",
      "MTU": 65536,
      "Aggregate": "",
      "LinkAddress": "00:00:00:00:00:00"
    },
    {
      "Name": "mgt0",
      "Index": 4,
      "Status": "ok",
      "Mode": "1000BASE-T-FD",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:8a:56:ee"
    },
    {
      "Name": "mgt1",
      "Index": 7,
      "Status": "no-link",
      "Mode": "none",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:8a:56:ef"
    },
    {
      "Name": "sit0",
      "Index": 2,
      "Status": "no-link",
      "Mode": "none",
      "Type": "Other",
      "MTU": 1480,
      "Aggregate": "",
      "LinkAddress": "00:00:00:00:00:00"
    },
    {
      "Name": "eth10",
      "Index": 5,
      "Status": "no-link",
      "Mode": "none",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:84:23:59"
    },
    {
      "Name": "eth11",
      "Index": 8,
      "Status": "no-link",
      "Mode": "none",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:84:23:5a"
    },
    {
      "Name": "eth12",
      "Index": 9,
      "Status": "no-link",
      "Mode": "none",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:84:23:5b"
    },
    {
      "Name": "eth13",
      "Index": 11,
      "Status": "ok",
      "Mode": "1000BASE-T-FD",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:84:23:5c"
    },
    {
      "Name": "eth14",
      "Index": 12,
      "Status": "no-link",
      "Mode": "none",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:83:ec:cb"
    },
    {
      "Name": "eth15",
      "Index": 13,
      "Status": "no-link",
      "Mode": "none",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:83:ec:cc"
    },
    {
      "Name": "eth16",
      "Index": 14,
      "Status": "no-link",
      "Mode": "none",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:83:ec:cd"
    },
    {
      "Name": "eth17",
      "Index": 15,
      "Status": "no-link",
      "Mode": "none",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:83:ec:ce"
    },
    {
      "Name": "eth20",
      "Index": 6,
      "Status": "ok",
      "Mode": "10GBASE-CR",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:f0:7c:ba"
    },
    {
      "Name": "eth21",
      "Index": 10,
      "Status": "ok",
      "Mode": "10GBASE-SR",
      "Type": "Ethernet",
      "MTU": 1500,
      "Aggregate": "",
      "LinkAddress": "00:0b:ab:f0:7c:bb"
    },
    {
      "Name": "ip6tnl0",
      "Index": 3,
      "Status": "no-link",
      "Mode": "none",
      "Type": "Other",
      "MTU": 1452,
      "Aggregate": "",
      "LinkAddress": "00:00:00:00:00:00"
    }
  ]
}