# Managed Object - DrConfigServiceInstance

See also
  DrConfigServiceInstanceContent
Since
  DrConfig API 1.0

## Managed Object Description

The ServiceInstance managed object is the singleton object which provides access to the functionality of the DrConfig server. Authorization and authentication support are limited to local OS users and method only privileges. Please do not specify parameter privileges as it will not work. The authorization code currently recognizes only the following privileges: System.Anonymous No authorization required. Can be called with an unauthenticated session. System.View or System.Read Authorization is required. Call Login before invoking a method requiring this privilege. VcDr.Internal.com.vmware.vcDr.InternalAccess Administrator access is required to invoke a method annotated with this privilege. If a method requires a privilege not listed here it will be treated as if administrator access privilege is required.

Properties

Name | Type | Description
--- | --- | ---
content P | DrConfigServiceInstanceContent | The properties of service instance. This property is identical to the value returned by retrieveContent. Note: This API doesn't support the property collector.

P Required privilege: System.Anonymous

Methods

Methods defined in this Managed Object
ChangeUserPassword, LoginDrConfig, LogoutDrConfig, RetrieveContent

# ChangeUserPassword

Assigns password to the user, who is running drconfig service.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigServiceInstance used to make the method call.
userName P | xsd:string | The user for which the password will be changed. For now this parameter is not taken into account and the password is changed only for the SRM user. Since DrConfig API 1.0
currentPassword P | xsd:string | The current user password. Since DrConfig API 1.0
newPassword P | xsd:string | The new user password. Since DrConfig API 1.0

P Required privilege - see tooltip for details

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.
DrConfigFaultChangePasswordFault | Thrown if the password can not be changed.

Events

Type
None

# LoginDrConfig

Log on to the server by verifying user and password with the local OS.

Required Privileges
  System.Anonymous

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigServiceInstance used to make the method call.
userName P | xsd:string | The ID of the user who is logging on to the server. Since DrConfig API 1.0
password P | xsd:string | The password of the user logging on to the server. Since DrConfig API 1.0
locale* P | xsd:string | The locale for this session. Since DrConfig API 1.0

*Need not be set P Required privilege - see tooltip for details

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.InvalidArgument | Thrown if no username is provided.
DrConfigFaultInvalidLocale | Thrown if the requested locale is invalid or unavailable.
DrConfigFaultInvalidLogin |
DrConfigFaultNoPermission | Thrown if permission to login is denied.

Events

Type
None

# LogoutDrConfig

Log out and terminate the current session.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigServiceInstance used to make the method call.

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.

Events

Type
None

# RetrieveContent

Retrieves the properties of the service instance.

Required Privileges
  System.Anonymous

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigServiceInstance used to make the method call.

Return Value

Type | Description
--- | ---
DrConfigServiceInstanceContent | The properties belonging to the service instance, including various object managers.

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