Host Date Time System Test Time Service

Host Date Time System Test Time Service

Run a test to validate current time service configuration is functioning normally.

The report will provide a localized diagnostic of any issues. Only one diagnostic test may be running at a time.

Since: vSphere API Release 7.0.3.0

Required privileges: Host.Config.DateTime

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/HostDateTimeSystem/{moId}/TestTimeService
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostDateTimeSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Authentication
This operation uses the following authentication methods.
Responses
200

The status of the time service on this host based on present time service configuration.

Returns HostDateTimeSystemServiceTestResult of type(s) application/json 
"HostDateTimeSystemServiceTestResult Object"
boolean
workingNormally
Required

Value is true if time services are presently working normally.

array of string
report
Optional

Returns details of the checks done to verify time services are working.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/HostDateTimeSystem/{moId}/TestTimeService
Availability
Added in vSphere API Release 7.0.3.0
On This Page
Host Date Time System Operations
POST
Host Date Time System Query Available Time Zones
POST
Host Date Time System Query Date Time
POST
Host Date Time System Refresh Date Time System
POST
Host Date Time System Test Time Service
POST
Host Date Time System Update Date Time Config
POST
Host Date Time System Update Date Time
GET
Host Date Time System Get Date Time Info