CreateListReplica method of the MSISCSITARGET_ReplicationService class
Creates, or starts a job to create new storage objects, which are replicas of the specified source storage objects. This method can be used to instantiate the replicas, and to create an ongoing association between the source and replicas by using the SyncType input parameter.
This method is inherited from the CIM_ReplicationService class.
Syntax
uint32 CreateListReplica(
[in, optional] string ElementNames[],
[in] uint16 SyncType,
[in, optional] uint16 Mode,
[in] CIM_LogicalElement Ref SourceElements[],
[in] CIM_ServiceAccessPoint Ref SourceAccessPoint,
[in, out] CIM_LogicalElement Ref TargetElements[],
[in, optional] CIM_ServiceAccessPoint REF TargetAccessPoint,
[in, optional] string ReplicationSettingData,
[out] CIM_ConcreteJob Ref Job,
[out] CIM_Synchronized Ref Synchronizations[],
[in] CIM_SettingData Ref TargetSettingGoal,
[in] CIM_ResourcePool Ref TargetPool,
[in, optional] uint16 WaitForCopyState
);
Parameters
-
ElementNames [in, optional]
-
Specifies end user relevant names for the elements being created. Specified names are applied to replicas in order. If there are more entries in the SourceElements parameter than in the ElementNames parameter the system supplied name is used for the unspecified items.
If NULL, then a system supplied default name is used. The value will be stored in the ElementName property of the created element.
-
SyncType [in]
-
Specifies the type of copy that will be made. Required.
The possible values are.
-
DMTF Reserved
- *value* = 5
-
Mirror (6)
-
Snapshot (7)
-
Clone (8)
-
DMTF Reserved
- 9 0x7FFF
-
Vendor Specific
- 0x8000 = *value*
Mode [in, optional]
Specifies whether the target elements will be updated synchronously or asynchronously. If NULL, the implementation decides the mode.
The possible values are.
Synchronous (2)
Asynchronous (3)
DMTF Reserved
Vendor Specific
SourceElements [in]
Specifies a list of source storage objects, which may be MSISCSITARGET_StorageVolume instances or other storage objects. All of the source elements must be of the same type.
SourceAccessPoint [in]
Specifies source access point information. May be NULL, if the service does not need access information to access the source element.
This parameter applies to all elements in the SourceElements parameter.
TargetElements [in, out]
On input, optionally specifies a list of target elements to use. On return contains references to the created target storage elements, the replicas. If a job is created, the target elements may not be available immediately.
TargetAccessPoint [in, optional]
Specifies target access point information. May be NULL, if the service does not need access information to access the target elements.
ReplicationSettingData [in, optional]
If provided, specifies the replication setting data for the given SyncType in the form of an embedded CIM_ReplicationSettingData instance. If not provided, the management server uses the default replication setting data. Optional.
Job [out]
On return contains a reference to the job, which may be NULL if the job is completed.
Synchronizations [out]
On return contains references to the created associations between the source and the target elements. If a job is created, this parameter may be NULL unless the associations are actually formed.
TargetSettingGoal [in]
Specifies configuration-related and operational parameters for the target storage objects, the replicas. If a TargetElement parameter is supplied, this parameter shall be NULL.
TargetPool [in]
Specifies the underlying storage for the target elements if specified, otherwise the allocation is implementation specific. If a TargetElement parameter is supplied, this parameter shall be NULL.
This parameter applies to all elements in the target list.
WaitForCopyState [in, optional]
Specifies the CopyState that must be reached before this method returns. Only a subset of valid values 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
This method returns one of the following values.
-
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 (0x8000 = value )
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\CIMv2\Storage\iScsiTarget |
| MOF |
|
| DLL |
|