Managed Object - HostServiceSystem

Property of
HostConfigManager
Extends
ExtensibleManagedObject
See also
HostServiceInfo


Managed Object Description

The ServiceSystem 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 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.

Show WSDL type definition



RestartService

Restarts the service.
Required Privileges
Host.Config.NetService

Parameters

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



Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other failures.
InvalidStateThrown if the service is not running.
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.

Show WSDL type definition



StartService

Starts the service.
Required Privileges
Host.Config.NetService

Parameters

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



Return Value

Type Description
None

Faults

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

Show WSDL type definition



StopService

Stops the service.
Required Privileges
Host.Config.NetService

Parameters

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



Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other failures.
InvalidStateThrown if the service is not running.
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.

Show WSDL type definition



UninstallService

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.
idxsd:string



Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other failures.
InvalidArgumentThrown if the service is a required service.
NotFoundThrown if the service ID is unknown.
NotSupportedThrown if the service doesn't support uninstallation.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateServicePolicy

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

Parameters

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


policyxsd:string



Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other failures.
InvalidArgumentThrown if the service ID represents a required service, or if the specified policy is undefined.
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.

Show WSDL type definition