vSphere API/SDK Documentation > vSphere Management SDK > vSphere Web Services SDK Documentation > VMware vSphere API Reference > Managed Object Types > H

1 2 3 4 5
0 Ratings

Local Properties

Local Methods

Managed Object Types

Data Object Types

All Properties

All Methods

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 P	HostDateTimeInfo	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

Name	Type	Description
_this	ManagedObjectReference	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
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryAvailableTimeZones" type="vim25:QueryAvailableTimeZonesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryAvailableTimeZonesResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:HostDateTimeSystemTimeZone" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

QueryDateTime(queryDateTime)

Get the current DateTime on the host.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostDateTimeSystem used to make the method call.

Return Value

Type	Description
xsd:dateTime	Current DateTime on the host.

Faults

Type	Description
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryDateTime" type="vim25:QueryDateTimeRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryDateTimeResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:dateTime"/>
               </sequence>
            </complexType>
         </element>

RefreshDateTimeSystem(refresh)

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

Required Privileges: Host.Config.DateTime

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostDateTimeSystem used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RefreshDateTimeSystem" type="vim25:RefreshDateTimeSystemRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RefreshDateTimeSystemResponse">
            <complexType/>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostDateTimeSystem used to make the method call.
dateTime	xsd:dateTime	DateTime to update the host to.

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	Thrown if an error occurs.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateDateTime" type="vim25:UpdateDateTimeRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateDateTimeResponse">
            <complexType/>
         </element>

UpdateDateTimeConfig(updateConfig)

Update the DateTime configuration of the host.

Required Privileges: Host.Config.DateTime

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostDateTimeSystem used to make the method call.
config	HostDateTimeConfig	The new DateTime configuration information.

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	Thrown if an error occurs.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateDateTimeConfig" type="vim25:UpdateDateTimeConfigRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateDateTimeConfigResponse">
            <complexType/>
         </element>

Feedback

1 2 3 4 5
0 Ratings