15f7be9a52
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
4.1 KiB
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
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