AttachOrModifyReplica method of the CIM_StorageConfigurationService class

Create (or start a job to create) a StorageSynchronized mirror relationship between two storage elements. The target element may be a local or a remote storage element. A remote mirror pair may be scoped by a peer-to-peer connection modeled as a NetworkPipe between peers.

If Job Completed with No Error (0) is returned, the function completed successfully and a ConcreteJob instance is not created.

If Method Parameters Checked - Job Started (0x1000) is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter.

A return value of Not Supported (1) indicates the method is not supported.

All other values indicate some type of error condition.

Syntax

uint32 AttachOrModifyReplica(
  [out] CIM_ConcreteJob    REF Job,
  [in]  CIM_ManagedElement REF SourceElement,
  [in]  CIM_ManagedElement REF TargetElement,
  [in]  uint16                 CopyType,
  [in]  string                 Goal,
  [in]  CIM_NetworkPipe    REF ReplicationPipe
);

Parameters

Job [out]

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

SourceElement [in]

The source storage element which may be a StorageVolume, StorageExtent, LogicalFile, FileSystem, CommonDatabase, or any other storage object. For this reason, the type is made very generic.

TargetElement [in]

Reference to the target storage element (i.e., the replica). The target storage element which may be a StorageVolume, StorageExtent, LogicalFile, FileSystem, CommonDatabase, or any other storage object. For this reason, the type is made very generic.

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 element.

UnSyncUnAssoc: Create an unassociated copy of the source element.

UnSyncAssoc and UnSyncUnAssoc are not supported for remote mirror replicas.

Async (2)

Sync (3)

UnSyncAssoc (4)

UnSyncUnAssoc (5)

DMTF Reserved

6 4095

Vendor Specific

4096 65535

Goal [in]

The StorageSetting properties to be created or modified for the target element.

ReplicationPipe [in]

The NetworkPipe element that scopes the remote mirror pair. If the value is null, remote mirrors do not require a pre-established connection.

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