/mgmt/status/default/RoutingStatus3 GET

Use the HTTP GET method with the /mgmt/status/default/RoutingStatus3 resource to retrieve routing table details.

Resource URL

https://host:port/mgmt/status/default/RoutingStatus3
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 the routing table. Each object contains the following fields:
IPType
String.
The version of the IP address: ipv4 or ipv6.
Destination
String.
The IP subnet or aggregate that is the destination of the route.
PrefixLength
Integer.
The prefix length of the IP address that represents the configured netmask.
InterfaceType
String.
The type of device interface used for this route. For example, Ethernet indicates that the interface is on the base Ethernet MAC interface and VLAN indicates that the interface is on an IEEE 802.1Q VLAN on top of the base Ethernet MAC 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.
MacInterface
String.
The configured name of the interface for the route.
GatewayIPType
String.
The IP address version that corresponds to the next hop gateway: ipv4 or ipv6.
Gateway
String.
The next hop gateway for traffic that uses the route. For routes with a local route type, the value is 0.0.0.0 for IPv4 and :: for IPv6.
Metric
Integer.
The metric for the route. When the same destination has multiple routes, the route with the lowest metric is used.

Examples

The following example requests information about the routing table on the appliance.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/RoutingStatus3
The following listing shows an example received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/RoutingStatus3"
    },
    "doc": {
      "href": "/mgmt/docs/status/RoutingStatus3"
    }
  },
  "RoutingStatus3": [
    {
      "IPType": "ipv4",
      "Destination": "0.0.0.0",
      "PrefixLength": 0,
      "InterfaceType": "Ethernet",
      "MacInterface": "mgt0",
      "GatewayIPType": "ipv4",
      "Gateway": "9.20.87.1",
      "Metric": 200
    },
    {
      "IPType": "ipv4",
      "Destination": "9.20.87.0",
      "PrefixLength": 24,
      "InterfaceType": "Ethernet",
      "MacInterface": "mgt0",
      "GatewayIPType": "ipv4",
      "Gateway": "0.0.0.0",
      "Metric": 0
    },
    {
      "IPType": "ipv4",
      "Destination": "172.21.0.0",
      "PrefixLength": 16,
      "InterfaceType": "Ethernet",
      "MacInterface": "eth20",
      "GatewayIPType": "ipv4",
      "Gateway": "0.0.0.0",
      "Metric": 0
    },
    {
      "IPType": "ipv4",
      "Destination": "192.168.251.0",
      "PrefixLength": 24,
      "InterfaceType": "Ethernet",
      "MacInterface": "eth13",
      "GatewayIPType": "ipv4",
      "Gateway": "0.0.0.0",
      "Metric": 0
    },
    {
      "IPType": "ipv4",
      "Destination": "192.168.253.0",
      "PrefixLength": 24,
      "InterfaceType": "Ethernet",
      "MacInterface": "eth21",
      "GatewayIPType": "ipv4",
      "Gateway": "0.0.0.0",
      "Metric": 0
    }
  ]
}