Managed Object - HostDateTimeSystem(vim.host.DateTimeSystem)

Property of
HostConfigManager
See also
HostDateTimeConfig, HostDateTimeInfo, HostDateTimeSystemTimeZone
Since
VI API 2.5


Managed Object Description

This managed object provides for NTP and date/time related configuration on a host. Information regarding the running status of the NTP daemon and functionality to start and stop the daemon is provided by the HostServiceSystem object.

Properties

Name Type Description
dateTimeInfo PHostDateTimeInfo

The DateTime configuration of the host.
P Required privilege: System.Read

Methods

Methods defined in this Managed Object
QueryAvailableTimeZones, QueryDateTime, RefreshDateTimeSystem, UpdateDateTime, UpdateDateTimeConfig

QueryAvailableTimeZones(queryAvailableTimeZones)

Retrieves the list of available timezones on the host. The API works off the public domain 'tz' timezone database.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDateTimeSystem used to make the method call.

Return Value

Type Description
HostDateTimeSystemTimeZone[]List of available timezones on the host.

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryDateTime(queryDateTime)

Get the current DateTime on the host.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDateTimeSystem used to make the method call.

Return Value

Type Description
xsd:dateTimeCurrent DateTime on the host.

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



RefreshDateTimeSystem(refresh)

Refresh the DateTime related settings to pick up any changes that might have occurred.
Required Privileges
Host.Config.DateTime

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDateTimeSystem used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



UpdateDateTime(updateDateTime)

Update the date/time on the host. This method should be used with caution since network delays, execution delays can result in time skews.
Required Privileges
Host.Config.DateTime

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDateTimeSystem used to make the method call.
dateTime Pxsd:dateTime

DateTime to update the host to.

Since VI API 2.5
P Required privilege: dateTime

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown if an error occurs.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



UpdateDateTimeConfig(updateConfig)

Update the DateTime configuration of the host.
Required Privileges
Host.Config.DateTime

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDateTimeSystem used to make the method call.
config PHostDateTimeConfig

The new DateTime configuration information.

Since VI API 2.5
P Required privilege: config

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown if an error occurs.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition