Managed Object - SrmRecoveryPlanFolder

Returned by
GetRecoveryPlanRootFolder, ListChildRecoveryPlanFolders, RecoveryPlanGetParentFolder
Extends
SrmFolder
See also
SrmRecoveryPlan,
Since
SRM API 3.0


Managed Object Description

An SRM folder which holds SrmRecoveryPlans and SrmRecoveryPlanFolders.

Properties

Name Type Description
None
Properties inherited from SrmFolder
None

Methods

Methods defined in this Managed Object
GetRecoveryPlan, ListChildRecoveryPlanFolders, ListChildRecoveryPlans
Methods inherited from SrmFolder
DestroyFolder_Task, GetChildType, GetName, GetParentFolder, MoveFolder_Task, RenameFolder_Task, SrmFolder_CreateFolder_Task

GetRecoveryPlan

Retrieve a specific SrmRecoveryPlan.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SrmRecoveryPlanFolder used to make the method call.
name Pxsd:string

The name of the recovery plan

Since SRM API 3.0
P Required privilege: name

Return Value

Type Description
ManagedObjectReference
to a SrmRecoveryPlan
A specific SrmRecoveryPlan with the given name.

Faults

Type Description
vmodl.RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SrmFaultRecoveryPlanNotFoundThrown if no plan with this name exists

Events

Type
None



ListChildRecoveryPlanFolders

The array of sub-Folders within this folder.

SrmRecoveryPlanFolders for which the current session does not have the {@code System.View} privilege are removed from the result set.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SrmRecoveryPlanFolder used to make the method call.

Return Value

Type Description
ManagedObjectReference[]
to a SrmRecoveryPlanFolder[]
The array of sub-Folders within this folder.

Faults

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

Events

Type
None



ListChildRecoveryPlans

The array of SrmRecoveryPlans within this folder.

{@code RecoveryPlan}s for which the current session does not have the {@code System.View} privilege are removed from the result set.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SrmRecoveryPlanFolder used to make the method call.

Return Value

Type Description
ManagedObjectReference[]
to a SrmRecoveryPlan[]
The array of SrmRecoveryPlans within this folder.

Faults

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

Events

Type
None