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

Name Type Description
serviceInfoHostServiceInfo

Service configuration.
Properties inherited from ExtensibleManagedObject
availableField, value

Methods

Methods defined in this Managed Object
RefreshServices, RestartService, StartService, StopService, UninstallService, UpdateServicePolicy
Methods inherited from ExtensibleManagedObject
setCustomValue

RefreshServices(refresh)

Refresh the service information and settings to pick up any changes made directly on the host.
Required Privileges
Host.Config.NetService

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostServiceSystem used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown 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



RestartService(restart)

Restarts the service.
Required Privileges
Host.Config.NetService

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostServiceSystem used to make the method call.
id Pxsd:string

Service identifier (ServiceInfo.service.key).

Since 2.0
P Required privilege: id

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other failures.
InvalidStateThrown 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.
NotFoundThrown if the service ID is unknown.
RuntimeFaultThrown 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



StartService(start)

Starts the service.
Required Privileges
Host.Config.NetService

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostServiceSystem used to make the method call.
id Pxsd:string

Service identifier (ServiceInfo.service.key).

Since 2.0
P Required privilege: id

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other failures.
InvalidStateThrown 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.
NotFoundThrown if the service ID is unknown.
RuntimeFaultThrown 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



StopService(stop)

Stops the service.
Required Privileges
Host.Config.NetService

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostServiceSystem used to make the method call.
id Pxsd:string

Service identifier (ServiceInfo.service.key).

Since 2.0
P Required privilege: id

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other failures.
InvalidStateThrown 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.
NotFoundThrown if the service ID is unknown.
RuntimeFaultThrown 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



UninstallService(uninstall)

Uninstalls the service. If the service is running, it is stopped before being uninstalled.
Required Privileges
Host.Config.NetService

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostServiceSystem used to make the method call.
id Pxsd:string

Service identifier (ServiceInfo.service.key).

Since 2.0
P Required privilege: id

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other failures.
NotFoundThrown if the service ID is unknown.
RuntimeFaultThrown 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



UpdateServicePolicy(updatePolicy)

Updates the activation policy of the service.
Required Privileges
Host.Config.NetService

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostServiceSystem used to make the method call.
id Pxsd:string

Service identifier (ServiceInfo.service.key).

Since 2.0
policy Pxsd:string

Specifies the condition for service activation. Use one of the HostServicePolicy values.

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other failures.
NotFoundThrown if the service ID is unknown.
RuntimeFaultThrown 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