/mgmt/status/default/NDCacheStatus2 GET

Use the HTTP GET method with the /mgmt/status/default/NDCacheStatus2 resource to request status information about IPv6 Neighbor Discovery (ND) translations on all interfaces. Only complete cache entries are returned.

Resource URL

https://host:port/mgmt/status/default/NDCacheStatus2
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 ND translations. Each object contains the following fields:
IPType
String.
The version of the IP address: 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
IPAddress
String.
The IPv6 address that corresponds to the MAC address.
PrefixLength
Integer.
The prefix length of the IP address that represents the configured netmask.
HardwareAddress
String.
The Host Bus Adapter associated with this path.
Interface
String.
The name of the interface.
InterfaceIndex
Integer.
The index of the interface.
InterfaceType
String.
The interface type:
  • 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.
State
String.
The lifecycle state for the entry:
  • incomplete The cache entry is in the incomplete state. It is inaccessible.
  • reachable The cache entry is in the reachable state. It is accessible.
  • stale The cache entry is in the stale state. It is potentially accessible.
  • delay The cache entry is in the delay state. It is inaccessible.
  • probe The cache entry is in the probe state. It is inaccessible.
  • failed The cache entry is in the failed state. It is inaccessible.
  • noarp The cache entry is in the noarp state. It is inaccessible.
  • permanent The cache entry is in the permanent state. It is always accessible.

Examples

The following example requests information about ND translations.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/NDCacheStatus2
The following listing shows an example received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/NDCacheStatus2"
    },
    "doc": {
      "href": "/mgmt/docs/status/NDCacheStatus2"
    }
  },
  "result": "No status retrieved."
}