/mgmt/status/default/IPAddressStatus GET

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

Resource URL

https://host:port/mgmt/status/default/IGMPStatus
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 appliance interfaces. Each object contains the following fields:
Name
String.
The name of the interface.
Index
Integer.
The value of the SNMP ifIndex column in the ifTable for the interface.
IPVersion
String.
Indicates the version of IP Address for the interface.
  • 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
PrefixLength
Integer.
Indicates the prefix length for the interface. The prefix length represents the configured netmask for the interface.
IP
String.
The IP address for the interface.

Examples

The following example requests information about the appliance interfaces.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/IPAddressStatus
The following listing shows an example received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/IPAddressStatus"
    },
    "doc": {
      "href": "/mgmt/docs/status/IPAddressStatus"
    }
  },
  "IPAddressStatus": [
    {
      "Name": "lo",
      "Index": 1,
      "IPVersion": "ipv4",
      "PrefixLength": 8,
      "IP": "127.0.0.1"
    },
    {
      "Name": "lo",
      "Index": 1,
      "IPVersion": "ipv6",
      "PrefixLength": 128,
      "IP": "::1"
    },
    {
      "Name": "mgt0",
      "Index": 4,
      "IPVersion": "ipv4",
      "PrefixLength": 24,
      "IP": "192.0.2.136"
    },
    {
      "Name": "eth20",
      "Index": 6,
      "IPVersion": "ipv4",
      "PrefixLength": 16,
      "IP": "172.21.136.0"
    },
    {
      "Name": "eth21",
      "Index": 10,
      "IPVersion": "ipv4",
      "PrefixLength": 24,
      "IP": "192.168.253.136"
    },
    {
      "Name": "eth13",
      "Index": 11,
      "IPVersion": "ipv4",
      "PrefixLength": 24,
      "IP": "192.168.251.136"
    }
  ]
}