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
serviceInfo	HostServiceInfo	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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostServiceSystem used to make the method call.

Return Value

Type	Description
None

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

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RefreshServices" type="vim25:RefreshServicesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RefreshServicesResponse">
                  <complexType/>
               </element>

RestartService(restart)

Restarts the service.

Required Privileges: Host.Config.NetService

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

xsd:string

Service identifier (ServiceInfo.service.key).

Since 2.0

P Required privilege: id

Return Value

Type	Description
None

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

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RestartService" type="vim25:RestartServiceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RestartServiceResponse">
                  <complexType/>
               </element>

StartService(start)

Starts the service.

Required Privileges: Host.Config.NetService

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

xsd:string

Service identifier (ServiceInfo.service.key).

Since 2.0

P Required privilege: id

Return Value

Type	Description
None

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

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="StartService" type="vim25:StartServiceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="StartServiceResponse">
                  <complexType/>
               </element>

StopService(stop)

Stops the service.

Required Privileges: Host.Config.NetService

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

xsd:string

Service identifier (ServiceInfo.service.key).

Since 2.0

P Required privilege: id

Return Value

Type	Description
None

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

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="StopService" type="vim25:StopServiceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="StopServiceResponse">
                  <complexType/>
               </element>

UninstallService(uninstall)

Uninstalls the service. If the service is running, it is stopped before being uninstalled.

Required Privileges: Host.Config.NetService

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

xsd:string

Service identifier (ServiceInfo.service.key).

Since 2.0

P Required privilege: id

Return Value

Type	Description
None

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

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UninstallService" type="vim25:UninstallServiceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UninstallServiceResponse">
                  <complexType/>
               </element>

UpdateServicePolicy(updatePolicy)

Updates the activation policy of the service.

Required Privileges: Host.Config.NetService

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

xsd:string

Service identifier (ServiceInfo.service.key).

Since 2.0

policy P

xsd: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
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

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateServicePolicy" type="vim25:UpdateServicePolicyRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateServicePolicyResponse">
                  <complexType/>
               </element>