Host Date Time System Get Date Time Info

Host Date Time System Get Date Time Info

The DateTime configuration of the host.

Required privileges: System.Read

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/HostDateTimeSystem/{moId}/dateTimeInfo
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property 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

DateTime configuration of the host.

Returns HostDateTimeInfo of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "timeZone": {
        "_typeName": "string",
        "key": "string",
        "name": "string",
        "description": "string",
        "gmtOffset": 0
    },
    "systemClockProtocol": "string",
    "ntpConfig": {
        "_typeName": "string",
        "server": [
            "string"
        ],
        "configFile": [
            "string"
        ]
    },
    "ptpConfig": {
        "_typeName": "string",
        "domain": 0,
        "port": [
            {
                "_typeName": "string",
                "index": 0,
                "deviceType": "string",
                "device": "string",
                "ipConfig": {
                    "_typeName": "string",
                    "dhcp": false,
                    "ipAddress": "string",
                    "subnetMask": "string",
                    "ipV6Config": {
                        "_typeName": "string",
                        "ipV6Address": [
                            {
                                "_typeName": "string",
                                "ipAddress": "string",
                                "prefixLength": 0,
                                "origin": "string",
                                "dadState": "string",
                                "lifetime": "string",
                                "operation": "string"
                            }
                        ],
                        "autoConfigurationEnabled": false,
                        "dhcpV6Enabled": false
                    }
                }
            }
        ]
    },
    "enabled": false,
    "disableEvents": false,
    "disableFallback": false,
    "inFallbackState": false,
    "serviceSync": false,
    "lastSyncTime": "string",
    "remoteNtpServer": "string",
    "ntpRunTime": 0,
    "ptpRunTime": 0,
    "ntpDuration": "string",
    "ptpDuration": "string"
}
HostDateTimeSystemTimeZone
timeZone
Required

The time zone of the host.

string
systemClockProtocol
Optional

The system clock synchronization protocol.

See HostDateTimeInfoProtocolEnum for possible values.

HostNtpConfig
ntpConfig
Optional

Configuration information for the NTP (Network Time Protocol) service.

HostPtpConfig
ptpConfig
Optional

Configuration information for the host PTP (Precision Time Protocol) service.

Since: vSphere API Release 7.0.3.0

boolean
enabled
Optional

Present state of the time services subsystem.

Since: vSphere API Release 7.0.3.0

boolean
disableEvents
Optional

When not disabled Network Time service or Precision Time service will send events to Virtual Center when service fails or recovers.

Since: vSphere API Release 7.0.3.0

boolean
disableFallback
Optional

When not disabled, if PrecisionTimeSync is configured, then the NTP configuration can run as backup.

Since: vSphere API Release 7.0.3.0

boolean
inFallbackState
Optional

Tracks if NTP is providing time to ESXi due to PTP service failure.

This is set only if disableFallback is set to false.

Since: vSphere API Release 7.0.3.0

boolean
serviceSync
Optional

Report true if time is synchronized with remote time source For PrecisionTimeSync this is obtained from PTP Port Status value.

For NetworkTimeProtocol this obtained from Leap Indicator value.

Since: vSphere API Release 7.0.3.0

string As date-time As date-time
lastSyncTime
Optional

Timestamp when time services were last in sync with remote clock.

If not set, time services have never established synchronization.

Since: vSphere API Release 7.0.3.0

string
remoteNtpServer
Optional

Provides the NTP server that the host is synced with from the set of servers configured.

Since: vSphere API Release 7.0.3.0

integer As int64 As int64
ntpRunTime
Optional

Provides the total seconds ntpd process has been running for.

Since: vSphere API Release 7.0.3.0

integer As int64 As int64
ptpRunTime
Optional

Provides the total seconds ptpd process has been running for.

Since: vSphere API Release 7.0.3.0

string
ntpDuration
Optional

Provides a duration in simplified, human-readable form for the lifetime of the ntp service.

Since: vSphere API Release 7.0.3.0

string
ptpDuration
Optional

Provides a duration in simplified, human-readable form for the lifetime of the ptp service.

Since: vSphere API Release 7.0.3.0


On This Page
Host Date Time System Operations
GET
Host Date Time System Get Date Time Info
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
POST
Host Date Time System Update Date Time Config