Test DNS Servers
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Test if dns servers are reachable.
Request
URLURL
https://{api_host}/rest/appliance/networking/dns/servers/test
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains NetworkingDnsServersTestRequestBody
of type application/json
(required)
{
"servers": [
"string"
]
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | servers | array of string |
DNS servers. |
Response
Response
Response BodyResponse Body
200 OK returns
NetworkingDnsServersTestResponseBody
of type application/json
DNS reacable status
{
"value": {
"messages": [
{
"message": "string",
"result": "enum"
}
],
"status": "enum"
}
}| Property Name | Type | Description |
|---|---|---|
| value | NetworkingDnsServersTestStatusInfo |
DNS reacable status |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"servers":["string"]}' https://{api_host}/rest/appliance/networking/dns/servers/test
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : Generic error |
| default | ErrorRest | Not available |
