CreateElementReplica method of the CIM_ReplicationService class

Create (or start a job to create) a new storage object, which is a replica of the specified source storage object (SourceElement). Note that using the input parameter, SyncType, this function can be used to instantiate the replica, and to create an ongoing association between the source and replica. If 0 is returned, the function completed successfully and no ConcreteJob instance created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter.

Syntax

uint32 CreateElementReplica(
  [in]      string                     ElementName,
  [in]      uint16                     SyncType,
  [in]      uint16                     Mode,
  [in]      CIM_LogicalElement     REF SourceElement,
  [in]      CIM_ServiceAccessPoint REF SourceAccessPoint,
  [in, out] CIM_LogicalElement     REF TargetElement,
  [in]      CIM_ServiceAccessPoint REF TargetAccessPoint,
  [in]      string                     ReplicationSettingData,
  [out]     CIM_ConcreteJob        REF Job,
  [out]     CIM_Synchronized       REF Synchronization,
  [in]      CIM_SettingData        REF TargetSettingGoal,
  [in]      CIM_ResourcePool       REF TargetPool,
  [in]      uint16                     WaitForCopyState
);

Parameters

ElementName [in]

A end user relevant name for the element being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created element.

SyncType [in]

SyncType describes the type of copy that will be made.

DMTF Reserved

0 5

Mirror (6)

Snapshot (7)

Clone (8)

DMTF Reserved

9 32767

Vendor Specific

32768 65535

Mode [in]

Mode describes whether the target elements will be updated synchronously or asynchronously. If NULL, implementaton decides the mode.

Synchronous (2)

Asynchronous (3)

DMTF Reserved

4 32767

Vendor Specific

32768 65535

SourceElement [in]

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

SourceAccessPoint [in]

Reference to source access point information. If NULL, service does not need access information to access the source element.

TargetElement [in, out]

Optionally, as an input, refers to a target element to use. As an output, refers to the created target storage element (i.e., the replica). If a job is created, the target element may not be available immediately.

TargetAccessPoint [in]

Reference to target access point information. If NULL, service does not need access information to access the target elements.

ReplicationSettingData [in]

If provided, it overrides the default replication setting data for the given SyncType. If not provided, the management server uses the default replication setting data.

Job [out]

Reference to the job (may be NULL if job is completed).

Synchronization [out]

Reference to the created association between the source and the target element. If a job is created, this parameter may be NULL unless the association is actually formed.

TargetSettingGoal [in]

The definition for the SettingData to be maintained by the target storage object (the replica). If a target element is supplied, this parameter shall be NULL.

TargetPool [in]

The underlying storage for the target element (the replica) will be drawn from TargetPool if specified, otherwise the allocation is implementation specific. If a target element is supplied, this parameter shall be NULL.

WaitForCopyState [in]

Method must wait until this CopyState is reached before returning. Only a subset of valid CopyStates apply. For example, Initialized: Associations have been established, but there is no data flow. Inactive: Initialization is complete, but the data flow remains idle until it is activated. Synchronized: Replicas are an exact copy of the source. UnSynchronized: Copy operation is in progress.

Return value

Completed with No Error (0)

Not Supported (1)

Unknown (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 4294967295)

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_ReplicationService