AttachReplica method of the CIM_StorageConfigurationService class

Create (or start a job to create) a StorageSynchronized relationship between two existing storage objects. Note that using the input parameter, CopyType, this function can be used to to create an ongoing association between the source and replica. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition.

Syntax

uint32 AttachReplica(
  [out] CIM_ConcreteJob    REF Job,
  [in]  CIM_ManagedElement REF SourceElement,
  [in]  CIM_ManagedElement REF TargetElement,
  [in]  uint16                 CopyType
);

Parameters

Job [out]

Reference to the job (may be null if the task completed).

SourceElement [in]

The source storage object which may be a StorageVolume or other storage object.

TargetElement [in]

Reference to the target storage element (i.e., the replica).

CopyType [in]

CopyType describes the type of Synchronized relationship that will be created. Values are:

Async: Create and maintain an asynchronous copy of the source.

Sync: Create and maintain a synchronized copy of the source.

UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source.

UnSyncUnAssoc: Create unassociated copy of the source element.

Async (2)

Sync (3)

UnSyncAssoc (4)

UnSyncUnAssoc (5)

DMTF Reserved

6 32767

Vendor Specific

32768 65535

Return value

Job Completed with No Error (0)

Not Supported (1)

Unspecified Error (2)

Timeout (3)

Failed (4)

Invalid Parameter (5)

In Use (6)

DMTF Reserved (7 4095)

Method Parameters Checked - Job Started (4096)

Method Reserved (4097 32767)

Vendor Specific (32768 65535)

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012 R2
Namespace
Root\CIMv2\Storage\iScsiTarget
MOF
SmIscsiTarget.mof
DLL
SMiSCSITargetProv.dll

See also

CIM_StorageConfigurationService