Managed Object -
HostServiceSystem(vim.host.ServiceSystem)
- Property of
-
HostConfigManager
- Extends
-
ExtensibleManagedObject
- See also
-
HostServiceInfo
- Since
- 2.0
Managed Object Description
The HostServiceSystem managed object describes the configuration
of host services. This managed object operates in conjunction
with the HostFirewallSystem
managed object.
Properties
Methods
RefreshServices(refresh)
Refresh the service information and settings to pick up any changes
made directly on the host.
- Required Privileges
- Host.Config.NetService
Parameters
Return Value
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
Show WSDL type definition
RestartService(restart)
Restarts the service.
- Required Privileges
- Host.Config.NetService
Parameters
P
Return Value
Faults
Type
|
Description
|
HostConfigFault | Thrown for all other failures. |
InvalidState | Thrown 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. |
NotFound | Thrown if the service ID is unknown. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Show WSDL type definition
StartService(start)
Starts the service.
- Required Privileges
- Host.Config.NetService
Parameters
P
Return Value
Faults
Type
|
Description
|
HostConfigFault | Thrown for all other failures. |
InvalidState | Thrown 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. |
NotFound | Thrown if the service ID is unknown. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Show WSDL type definition
StopService(stop)
Stops the service.
- Required Privileges
- Host.Config.NetService
Parameters
P
Return Value
Faults
Type
|
Description
|
HostConfigFault | Thrown for all other failures. |
InvalidState | Thrown 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. |
NotFound | Thrown if the service ID is unknown. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Show WSDL type definition
UninstallService(uninstall)
Uninstalls the service. If the service is running, it is
stopped before being uninstalled.
- Required Privileges
- Host.Config.NetService
Parameters
P
Return Value
Faults
Type
|
Description
|
HostConfigFault | Thrown for all other failures. |
NotFound | Thrown if the service ID is unknown. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Show WSDL type definition
UpdateServicePolicy(updatePolicy)
Updates the activation policy of the service.
- Required Privileges
- Host.Config.NetService
Parameters
P
Return Value
Faults
Type
|
Description
|
HostConfigFault | Thrown for all other failures. |
NotFound | Thrown if the service ID is unknown. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Show WSDL type definition
© 2006-2020 VMware, Inc. All rights reserved.
Revision 10 MAR 2020 | Version 7.0