Managed Object - SrmArrayManager

Property of: SrmFaultArrayManagerInUse, SrmFaultDuplicateArray
Parameter to: RemoveArrayManager_Task
Returned by: CreateArrayManager_Task, GetOwner, QueryArrayManagers
See also: SrmAdapterConnectionSpec, SrmArrayInfo, SrmArrayManagerArrayDiscoveryStatus, SrmArrayManagerArrayManagerInfo, SrmReplicatedArrayPair, SrmStorageAdapter
Since: SRM API 8.0

Managed Object Description

External Interface to ArrayManager.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
AddArrayPair_Task, ArrayManagerReconfigure_Task, DiscoverArrays_Task, GetAdapter, GetArrayDiscoveryStatus, GetArrayInfo, QueryReplicatedArrayPairs, ReadInfo, RemoveArrayPair_Task

AddArrayPair_Task

Creates ReplicatedArrayPair object for a given pair of storage arrays.

Required Privileges: VcDr.Storage.com.vmware.vcDr.Configure
Since: SRM API 11.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

arrayId P

xsd:string

Identifier of the local storage array

Since SRM API 11.0

peerArrayId P

xsd:string

Identifier of the storage array at the remote site

Since SRM API 11.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a SrmExtApiTask

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.
vim.fault.TaskInProgress
SrmFaultRemoteSiteNotEnabled

Events

Type
None

ArrayManagerReconfigure_Task

Updates array manager name and connection parameters for the SRA. Performs array discovery as part of reconfigure operation. Ensures that all existing configured array pairs are not affected by the connection specs changes and are still discovered. Array discovery is not performed if only name change is requested and connection specs are unchanged.

Required Privileges: VcDr.Storage.com.vmware.vcDr.Configure
Since: SRM API 11.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

name P

xsd:string

New name.

Since SRM API 11.0

connectionSpec* P

SrmAdapterConnectionSpec[]

New connection parameters.

Since SRM API 11.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a SrmExtApiTask

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.
vim.fault.TaskInProgress

Events

Type
None

DiscoverArrays_Task

Discovers storage arrays configured for replication by executing SRA command discoverArrays. Ids of discovered array must be unique across all array managers that use the same SRA.

Required Privileges: System.View
Since: SRM API 11.0

Parameters

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

Return Value

Type	Description
ManagedObjectReference to a SrmExtApiTask

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.
vim.fault.TaskInProgress

Events

Type
None

GetAdapter

Required Privileges: System.View
Since: SRM API 11.0

Parameters

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

Return Value

Type	Description
ManagedObjectReference to a SrmStorageAdapter	The corresponding storage adapter to the ArrayManager. The ArrayManager may not have storage adapter. In this case unset value is returned.

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

GetArrayDiscoveryStatus

Required Privileges: None
Since: SRM API 11.0

Parameters

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

Return Value

Type	Description
SrmArrayManagerArrayDiscoveryStatus	Status and timestamp information of latest array discovery. Can be unset value if no array discovery is still executed.

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

GetArrayInfo

List of discovered storage arrays.

This list is populated by DiscoverArrays_Task API.

Required Privileges: System.View
Since: SRM API 11.0

Parameters

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

Return Value

Type	Description
SrmArrayInfo[]

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

QueryReplicatedArrayPairs

Returns all Replicated array pairs in the ArrayManager.

Required Privileges: System.View

Parameters

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

Return Value

Type	Description
ManagedObjectReference[] to a SrmReplicatedArrayPair[]

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

ReadInfo

Returns information, specific to the ArrayManager instance.

Required Privileges: System.View

Parameters

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

Return Value

Type	Description
SrmArrayManagerArrayManagerInfo

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

RemoveArrayPair_Task

Deletes specified ReplicatedArrayPair object.

Required Privileges: VcDr.Storage.com.vmware.vcDr.Configure
Since: SRM API 11.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

arrayPair P

ManagedObjectReference
to a SrmReplicatedArrayPair

ReplicatedArraypair to be removed

Since SRM API 11.0

P Required privilege: arrayPair

Return Value

Type	Description
ManagedObjectReference to a SrmExtApiTask

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.
vim.fault.TaskInProgress

Events

Type
None