1. Operations
  2. appliance
  3. ntp

appliance ntp: test

Test the connection to a list of ntp servers. This operation was added in vSphere API 6.7

Request:

HTTP request

POST https://{server}/rest/appliance/ntp/test

Request Body Structure:

{
    "servers": [
        "string",
        "string"
    ]
}

Request Body Parameters:

Name Type Description
bold = required
servers string[] List of host names or IP addresses of NTP servers.

Response:

HTTP Status Code: 200

Representation:

{
    "value": [
        {
            "message": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "server": "string",
            "status": "SERVER_REACHABLE"
        },
        {
            "message": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "server": "string",
            "status": "SERVER_REACHABLE"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value test_run_status[] List of test run statuses.
value[].server string Server name associated with the test run. This attribute was added in vSphere API 6.7
value[].status string Server status. This attribute was added in vSphere API 6.7

Status of server during test. This enumeration was added in vSphere API 6.7 Value is one of:
SERVER_REACHABLE: Server is reachable. This constant was added in vSphere API 6.7
SERVER_UNREACHABLE: Server is unreachable. This constant was added in vSphere API 6.7
value[].message localizable_message Message associated with status. This attribute was added in vSphere API 6.7
value[].message.id string id in message bundle. This attribute was added in vSphere API 6.7
value[].message.default_message string text in english. This attribute was added in vSphere API 6.7
value[].message.args string[] nested data. This attribute was added in vSphere API 6.7

Errors:

HTTP Status Code Type Description
500 error Generic error