Files
deb-python-pyvmomi/docs/vim/host/DateTimeSystem.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

2.3 KiB

vim.host.DateTimeSystem

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.

since

VI API 2.5

Attributes

dateTimeInfo (vim.host.DateTimeInfo):
privilege: System.Read

The DateTime configuration of the host.

Methods

UpdateDateTimeConfig(config):

Update the DateTime configuration of the host.

Privilege:

Host.Config.DateTime

Args:
config (vim.host.DateTimeConfig):

The new DateTime configuration information.

Returns:

None

Raises:

vim.fault.HostConfigFault:

if an error occurs.

QueryAvailableTimeZones():

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

Privilege:

System.Read

Args:

Returns:
vim.host.DateTimeSystem.TimeZone:

List of available timezones on the host.

QueryDateTime():

Get the current DateTime on the host.

Privilege:

System.Read

Args:

Returns:
datetime:

Current DateTime on the host.

UpdateDateTime(dateTime):

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

Privilege:

Host.Config.DateTime

Args:
dateTime (datetime):

DateTime to update the host to.

Returns:

None

Raises:

vim.fault.HostConfigFault:

if an error occurs.

RefreshDateTimeSystem():

Refresh the DateTime related settings to pick up any changes that might have occurred.

Privilege:

Host.Config.DateTime

Args:

Returns:

None