Managed Object - DrConfigServiceManager

Property of: DrConfigServiceInstanceContent
See also: DrConfigServiceStatusInfo
Since: DrConfig API 1.0

Managed Object Description

This managed object provides operations to control appliance services.

Properties

Name	Type	Description
srmServiceRunning P	xsd:boolean	Deprecated. The current SRM service state.

P Required privilege: System.Anonymous

Methods

Methods defined in this Managed Object
DrConfigAllServicesStatus, DrConfigRestartService, DrConfigServiceStatus, DrConfigStartService, DrConfigStopService, IsSrmServerRunning

DrConfigAllServicesStatus

Returns the ServiceStatus objects for all services.

Required Privileges: System.Read
Since: DrConfig API 3.0

Parameters

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

Return Value

Type	Description
DrConfigServiceStatusInfo[]

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
vmodl.fault.SystemError

Events

Type
None

DrConfigRestartService

Stops the service and then starts it again. If service is not running it will be started.

Required Privileges: System.Admin

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

service P

xsd:string

Since DrConfig API 1.0

P Required privilege: service

Return Value

Type	Description
None

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
vmodl.fault.SystemError
vmodl.fault.InvalidArgument

Events

Type
None

DrConfigServiceStatus

Returns the ServiceStatus object which contains the service status info about the service.

Required Privileges: System.Read
Since: DrConfig API 3.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

service P

xsd:string

Since DrConfig API 3.0

P Required privilege: service

Return Value

Type	Description
DrConfigServiceStatusInfo

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
vmodl.fault.SystemError
vmodl.fault.InvalidArgument

Events

Type
None

DrConfigStartService

Starts the service. Does nothing if service is already running.

Required Privileges: System.Admin

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

service P

xsd:string

Since DrConfig API 1.0

P Required privilege: service

Return Value

Type	Description
None

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
vmodl.fault.SystemError
vmodl.fault.InvalidArgument

Events

Type
None

DrConfigStopService

Stops the service. Does nothing if service is not running.

Required Privileges: System.Admin

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

service P

xsd:string

Since DrConfig API 1.0

P Required privilege: service

Return Value

Type	Description
None

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
vmodl.fault.SystemError
vmodl.fault.InvalidArgument

Events

Type
None

IsSrmServerRunning

The current SRM service state.

Required Privileges: System.Anonymous
Since: DrConfig API 3.1

Parameters

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

Return Value

Type	Description
xsd:boolean

Faults

Type	Description
vmodl.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