Managed Object - SrmFolder

Property of
SrmFaultIllegalMove, SrmFaultInvalidFolder
Parameter to
CreateAbrProtectionGroup, CreateHbrProtectionGroup, CreateHbrProtectionGroup2, CreateRecoveryPlan, CreateVvolProtectionGroup, MoveFolder_Task, MovePlan_Task, MoveProtectionGroup_Task
Returned by
GetParentFolder, SrmFolder_CreateFolder_Task
Extended by
SrmProtectionGroupFolder, SrmRecoveryPlanFolder
See also
Since
SRM API 3.0


Managed Object Description

An SRM folder which holds SrmProtectionGroups, SrmRecoveryPlans, and SrmFolders.

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
DestroyFolder_Task, GetChildType, GetName, GetParentFolder, MoveFolder_Task, RenameFolder_Task, SrmFolder_CreateFolder_Task

DestroyFolder_Task

Destroys this Folder. This method requires VcDr.ProtectionProfile.com.vmware.vcDr.Delete privilege for protection group folders and VcDr.RecoveryProfile.com.vmware.vcDr.Delete for recovery plan folders.
Required Privileges
None
Since
SRM API 11.0

Parameters

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

Return Value

Type Description
ManagedObjectReference
to a SrmExtApiTask

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



GetChildType

Specifies the object types a folder may contain. When you create a folder, it inherits its childType from the parent folder in which it is created. childType is an array of strings.
Required Privileges
System.View
Since
SRM API 11.0

Parameters

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

Return Value

Type Description
xsd:string[]

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



GetName

The name of this folder object.
Required Privileges
System.View

Parameters

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

Return Value

Type Description
xsd:string

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



GetParentFolder

Parent folder.

This value is null for the root object.

Required Privileges
System.View

Parameters

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

Return Value

Type Description
ManagedObjectReference
to a SrmFolder

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



MoveFolder_Task

Moves this folder into another folder. The objects that can be moved into a folder depends on the parent folder's type (as defined by the parent folder's childType() property). For a folder constructed for recovery plans, only recovery plans & recovery folders can be moved into the folder. For a folder constructed to hold ProtectionGroups, only ProtectionGroups and protection folders can be moved into the folder. For protection group folders this method requires VcDr.ProtectionProfile.com.vmware.vcDr.Edit on the moved folder, on the current parent folder, and on the destination folder. For recovery plan folders this method requires VcDr.RecoveryProfile.com.vmware.vcDr.Edit on the moved folder, on the current parent folder, and on the destination folder.
Required Privileges
None
Since
SRM API 11.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SrmFolder used to make the method call.
destination PManagedObjectReference
to a SrmFolder

The folder that should become the new parent of this folder.

Since SRM API 11.0
P Required privilege: destination

Return Value

Type Description
ManagedObjectReference
to a SrmExtApiTask

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



RenameFolder_Task

Renames this Folder. This method requires VcDr.ProtectionProfile.com.vmware.vcDr.Edit privilege for protection group folders and VcDr.RecoveryProfile.com.vmware.vcDr.Edit for recovery plan folders.
Required Privileges
None
Since
SRM API 11.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SrmFolder used to make the method call.
newName Pxsd:string

The new folder name.

Since SRM API 11.0
P Required privilege: newName

Return Value

Type Description
ManagedObjectReference
to a SrmExtApiTask

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.
SrmFaultStringArgumentTooLongThrown if the folder name is too long.

Events

Type
None



SrmFolder_CreateFolder_Task

Creates a new sub-folder with the specified name. Because of the dual-server nature of SRM, the sites must be connected when creating folders. Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter. This method requires VcDr.ProtectionProfile.com.vmware.vcDr.Create privilege on the containing folder to create a protection group folder and VcDr.RecoveryProfile.com.vmware.vcDr.Create to create a recovery plan folder.
Required Privileges
None
Since
SRM API 11.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SrmFolder used to make the method call.
folderName Pxsd:string

Since SRM API 11.0
P Required privilege: folderName

Return Value

Type Description
ManagedObjectReference
to a SrmExtApiTask

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.
SrmFaultStringArgumentTooLongThrown if the folder name is too long.

Events

Type
None