File: DateTimeSystem.rst

package info (click to toggle)
python-pyvmomi 6.7.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 14,980 kB
  • sloc: python: 9,206; xml: 77; makefile: 9
file content (137 lines) | stat: -rw-r--r-- 2,357 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
.. _vim.Task: ../../vim/Task.rst

.. _datetime: https://docs.python.org/2/library/stdtypes.html

.. _VI API 2.5: ../../vim/version.rst#vimversionversion2

.. _vim.host.DateTimeInfo: ../../vim/host/DateTimeInfo.rst

.. _vim.host.DateTimeConfig: ../../vim/host/DateTimeConfig.rst

.. _vim.fault.HostConfigFault: ../../vim/fault/HostConfigFault.rst

.. _vim.host.DateTimeSystem.TimeZone: ../../vim/host/DateTimeSystem/TimeZone.rst


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