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 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
|
.. _str: https://docs.python.org/2/library/stdtypes.html
.. _vim.Task: ../../vim/Task.rst
.. _vim.fault.NotFound: ../../vim/fault/NotFound.rst
.. _vim.host.ServiceInfo: ../../vim/host/ServiceInfo.rst
.. _vim.fault.InvalidState: ../../vim/fault/InvalidState.rst
.. _vmodl.fault.NotSupported: ../../vmodl/fault/NotSupported.rst
.. _vim.fault.HostConfigFault: ../../vim/fault/HostConfigFault.rst
.. _vmodl.fault.InvalidArgument: ../../vmodl/fault/InvalidArgument.rst
.. _vim.ExtensibleManagedObject: ../../vim/ExtensibleManagedObject.rst
vim.host.ServiceSystem
======================
The `HostServiceSystem`_ managed object describes the configuration of host services. This managed object operates in conjunction with the `HostFirewallSystem`_ managed object.
:extends: vim.ExtensibleManagedObject_
Attributes
----------
serviceInfo (`vim.host.ServiceInfo`_):
Service configuration.
Methods
-------
UpdateServicePolicy(id, policy):
Updates the activation policy of the service.
Privilege:
Host.Config.NetService
Args:
id (`str`_):
Service identifier ( `serviceInfo`_ . `service`_ . `key`_ ).
policy (`str`_):
Specifies the condition for service activation. Use one of the `HostServicePolicy`_ values.
Returns:
None
Raises:
`vim.fault.NotFound`_:
if the service ID is unknown.
`vim.fault.HostConfigFault`_:
for all other failures.
`vmodl.fault.InvalidArgument`_:
if the service ID represents a required service, or if the specified policy is undefined.
StartService(id):
Starts the service.
Privilege:
Host.Config.NetService
Args:
id (`str`_):
Service identifier ( `serviceInfo`_ . `service`_ . `key`_ ).
Returns:
None
Raises:
`vim.fault.InvalidState`_:
if the service is already running. Only hosts with ESX/ESXi 4.1 or earlier software use this fault. Hosts running later versions of ESXi do not throw a fault in this case.
`vim.fault.NotFound`_:
if the service ID is unknown.
`vim.fault.HostConfigFault`_:
for all other failures.
StopService(id):
Stops the service.
Privilege:
Host.Config.NetService
Args:
id (`str`_):
Service identifier ( `serviceInfo`_ . `service`_ . `key`_ ).
Returns:
None
Raises:
`vim.fault.InvalidState`_:
if the service is not running. Only hosts with ESX/ESXi 4.1 or earlier software use this fault. Hosts running later versions of ESXi do not throw a fault in this case.
`vim.fault.NotFound`_:
if the service ID is unknown.
`vim.fault.HostConfigFault`_:
for all other failures.
RestartService(id):
Restarts the service.
Privilege:
Host.Config.NetService
Args:
id (`str`_):
Service identifier ( `serviceInfo`_ . `service`_ . `key`_ ).
Returns:
None
Raises:
`vim.fault.InvalidState`_:
if the service is not running. Only hosts with ESX/ESXi 4.1 or earlier software use this fault. Hosts running later versions of ESXi do not throw a fault in this case.
`vim.fault.NotFound`_:
if the service ID is unknown.
`vim.fault.HostConfigFault`_:
for all other failures.
UninstallService(id):
Uninstalls the service. If the service is running, it is stopped before being uninstalled.
Privilege:
Host.Config.NetService
Args:
id (`str`_):
Service identifier ( `serviceInfo`_ . `service`_ . `key`_ ).
Returns:
None
Raises:
`vim.fault.NotFound`_:
if the service ID is unknown.
`vim.fault.HostConfigFault`_:
for all other failures.
`vmodl.fault.InvalidArgument`_:
if the service is a required service.
`vmodl.fault.NotSupported`_:
if the service doesn't support uninstallation.
RefreshServices():
Refresh the service information and settings to pick up any changes made directly on the host.
Privilege:
Host.Config.NetService
Args:
Returns:
None
|