This API has a deprecated equivalent from v7.0U1.
Test NTP
Test the connection to a list of ntp servers.
Request
URLURL
https://{api_host}/api/appliance/ntp?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
NtpTestRequestBody 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
List of host names or IP addresses of NTP servers.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
NtpTestRunStatus
of type application/json
List of test run statuses.
[
{
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string"
},
"server": "string",
"status": "SERVER_REACHABLE"
}
]
string
server
Required
Server name associated with the test run.
status
Required
Ntp.ServerStatus enumerated type Status of server during test
SERVER_REACHABLE : Server is reachable.
SERVER_UNREACHABLE : Server is unreachable.
Possible values are: SERVER_REACHABLE , SERVER_UNREACHABLE
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$NtpTestRequestBody = Initialize-NtpTestRequestBody -Servers "MyServers"
Invoke-TestNtp -NtpTestRequestBody $NtpTestRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"servers":["string"]}' https://{api_host}/api/appliance/ntp?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/ntp/test
x-vmw-doc-operation: test
Availability
Added in 7.0U2
