Managed Object - SrmAutoprotectManager

Property of: SrmServiceInstanceContent
Since: SRM API 9.0

Managed Object Description

Autoprotect Manager external API for automatic protection

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
GetAutoprotectUser, IsActive, SetAutoprotectUser, SetDefaultAutoprotectUser

GetAutoprotectUser

Get the user for the automatic protection.

Required Privileges: System.View

Parameters

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

Return Value

Type	Description
xsd:string	Returns the current account to be used by automatic protection on this site.

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

IsActive

Flag indicating if the automatic protection is globally activated (true) or deactivated (false). Automatic protection is active when both SRM servers in a pair support AutoprotectManager and the connection to the remote site is healthy. Automatic protection is not active when peer SRM server does not support AutoprotectManager or the connection to the remote site is broken.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the SrmAutoprotectManager 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

SetAutoprotectUser

Configure the user to be used by automatic protection on this site. If not called, the default autoprotect user is used.

Required Privileges: VcDr.Autoprotect.com.vmware.vcDr.Edit

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

user P

xsd:string

Name of the user to be used by automatic protection.

Since SRM API 9.0

P Required privilege: user

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

SetDefaultAutoprotectUser

Reverts the current user to the default one.

Required Privileges: VcDr.Autoprotect.com.vmware.vcDr.Edit

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the SrmAutoprotectManager 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