| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
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 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostServiceSystem used to make the method call. |
id | xsd:string |
Service identifier
(serviceInfo.service.key).
|
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostServiceSystem used to make the method call. |
id | xsd:string |
Service identifier
(serviceInfo.service.key).
|
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostServiceSystem used to make the method call. |
id | xsd:string |
Service identifier
(serviceInfo.service.key).
|
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostServiceSystem used to make the method call. |
id | xsd:string |
Service identifier
(serviceInfo.service.key).
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
HostConfigFault | Thrown for all other failures. |
InvalidArgument | Thrown if the service is a required service. |
NotFound | Thrown if the service ID is unknown. |
NotSupported | Thrown if the service doesn't support uninstallation. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostServiceSystem used to make the method call. |
id | xsd:string |
Service identifier
(serviceInfo.service.key).
|
policy | xsd:string |
Specifies the condition for service activation.
Use one of the HostServicePolicy values.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
HostConfigFault | Thrown for all other failures. |
InvalidArgument | Thrown if the service ID represents a required service, or if the specified policy is undefined. |
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 |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |