/mgmt/status/default/DNSNameServerStatus2 GET

Use the HTTP GET method with the /mgmt/status/default/DNSNameServerStatus2 resource to request a list of configured and acquired name servers.

Resource URL

https://host:port/mgmt/status/default/DNSNameServerStatus2
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 the name server information for the appliance. Each object contains the following fields:
SearchOrderIndex
Integer.
The name servers will be searched for in the specified order.
IPAddress
String.
The numeric IP address for any DNS server that is configured for use on this appliance.
UDPPort
Integer.
The UDP port number of the DNS server. (The default DNS UDP port is 53.) When the load balancing algorithm is first alive, this value is ignored.
TCPPort
Integer.
The TCP port number of the DNS server. (The default DNS TCP port is also 53.) When the load balancing algorithm is first alive, this value is ignored.
MaxRetries
Integer.
The maximum number of lookup requests that are sent to a given DNS name server before a connection failure is reported. However, if the load balancing algorithm is first alive, the individual host uses the top-level retry setting from DNS settings.

Examples

The following example requests the power supply status of the appliance.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/DNSNameServerStatus2
The following listing shows the received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/DNSNameServerStatus2"
    },
    "doc": {
      "href": "/mgmt/docs/status/DNSNameServerStatus2"
    }
  },
  "DNSNameServerStatus2": [
    {
      "SearchOrderIndex": 1,
      "IPAddress": "192.0.2.11",
      "UDPPort": 53,
      "TCPPort": 53,
      "MaxRetries": 3
    },
    {
      "SearchOrderIndex": 2,
      "IPAddress": "192.0.2.25",
      "UDPPort": 53,
      "TCPPort": 53,
      "MaxRetries": 3
    }
  ]
}