This API has a deprecated equivalent from v7.0U1.
Test DNS Servers
Test if dns servers are reachable.
Request
URLURL
https://{api_host}/api/appliance/networking/dns/servers?action=test
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
NetworkingDnsServersTestRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"servers": [
"string"
]
}
array of
string
servers
Required
DNS servers.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
NetworkingDnsServersTestStatusInfo
of type application/json
DNS reacable status
{
"messages": [
{
"message": "string",
"result": "failure"
}
],
"status": "orange"
}
status
Required
Servers.TestStatus enumerated type Health indicator
orange : In case data has more than one test, this indicates not all tests were successful
green : All tests were successful for given data
red : All tests failed for given data
Possible values are: orange , green , red
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"servers":["string"]}' https://{api_host}/api/appliance/networking/dns/servers?action=test
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/appliance/networking/dns/servers/test
x-vmw-doc-operation: test
Availability
Added in 7.0U2
