# Managed Object - DrConfigSshAccess

Property of
  DrConfigServiceInstanceContent
Since
  DrConfig API 6.0

## Managed Object Description

This managed object provides operations to manage a temporary user with ssh remote access and administrator rights.

Properties

Name | Type | Description
--- | --- | ---
None

Methods

Methods defined in this Managed Object
DisableSshRemoteAccess, EnableSshRemoteAccess

# DisableSshRemoteAccess

Disable user for remote access.

Required Privileges
  DrConfig.Admin

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigSshAccess used to make the method call.
username P | xsd:string | Since DrConfig API 6.0

P Required privilege: username

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 | General exception for IO operations.
DrConfigFaultUsernameNotAvailable |

Events

Type
None

# EnableSshRemoteAccess

Create and enable temporary user for SSH remote access.

Required Privileges
  DrConfig.Admin

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigSshAccess used to make the method call.
username P | xsd:string | Since DrConfig API 6.0

P Required privilege: username

Return Value

Type | Description
--- | ---
xsd:string | The needed key for remote login.

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 |
DrConfigFaultUsernameNotAvailable | Thrown if the username is not acceptable. SystemError General exception for IO operations.

Events

Type
None