CreateGroupReplica method of the MSISCSITARGET_ReplicationService class
Creates a new group of storage objects that are replicas of the specified source storage or a group of source storage objects. This method can be used to instantiate the replicas and to create an ongoing association between the source and replica by using the SyncType input parameter.
This method is inherited from the CIM_ReplicationService class.
Syntax
uint32 CreateGroupReplica(
[in, optional] string RelationshipName,
[in] uint16 SyncType,
[in, optional] uint16 Mode,
[in, optional] CIM_ReplicationGroup Ref SourceGroup,
[in, optional] CIM_LogicalElement Ref SourceElement,
[in, optional] CIM_ServiceAccessPoint Ref SourceAccessPoint,
[in, out] CIM_ReplicationGroup Ref TargetGroup,
[in, optional] uint64 TargetElementCount,
[in, optional] CIM_ServiceAccessPoint Ref TargetAccessPoint,
[in, optional] uint16 Consistency,
[in, optional] string ReplicationSettingData,
[out] CIM_ConcreteJob Ref Job,
[out] CIM_Synchronized Ref Synchronization,
[in, optional] CIM_SettingData Ref TargetSettingGoal,
[in, optional] CIM_ResourcePool Ref TargetPool,
[in, optional] uint16 WaitForCopyState
);
Parameters
-
RelationshipName [in, optional]
-
Specifies a user name that is meaningful for the relationship between the source and target groups or between a source element and a target group. If NULL, the implementation assigns a name. If the individual target elements require an ElementName property, the implementation constructs an appropriate ElementName value by using the RelationshipName property. For example, by using the RelationshipName property as a prefix that is followed by the "_n" sequence number, where n is a number that begins with 1.
-
SyncType [in]
-
Specifies the type of copy to make. 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 are updated synchronously or asynchronously. If NULL, implementation decides the mode.
The possible values are.
Synchronous (2)
Asynchronous (3)
DMTF Reserved
Vendor Specific
SourceGroup [in, optional]
Specifies a group of source storage objects that can be a CIM_StorageVolume instance or a storage object. If this parameter is not specified, the SourceElement parameter is required. You cannot specify both the SourceGroup and SourceElement parameters, but you must specify one of them.
SourceElement [in, optional]
Specifies the source storage object that can be a MSISCSITARGET_StorageVolume instance or a storage object. If this parameter is not specified, the SourceGroup parameter is required. You cannot specify both the SourceGroup and SourceElement parameters, but you must specify one of them.
SourceAccessPoint [in, optional]
Specifies the source access point information. Can be NULL, if the service does not require access information to access the source element.
TargetGroup [in, out]
On input, optionally specifies a target group to use. On output, refers to the created target group that is the replica group. If a job is created, the target group might not be available immediately. If you specify the TargetGroup parameter, the TargetElementCount parameter must be NULL.
TargetElementCount [in, optional]
Specifies how many target elements to create. Use this parameter to create multiple copies of a source element. If you specify the TargetElementCount parameter, the TargetGroup parameter must be NULL.
TargetAccessPoint [in, optional]
Specifies the target access point information. Can be NULL, if the service does not require access information to access the target element or target group.
Consistency [in, optional]
Specifies consistency for the replica. Overrides the default group consistency.
The possible values are.
No Consistency (2)
Sequential Consistency (3)
DMTF Reserved
Vendor Specific
ReplicationSettingData [in, optional]
If provided, specifies the replication setting data for the given SyncType input parameter in the form of an embedded CIM_ReplicationSettingData instance. If not provided, the management server uses the default replication setting data.
If provided, it overrides the default replication setting data for the given SyncType input parameter. If NULL, the management server uses the default replication setting data.
Job [out]
On return, contains a reference to the job, which can be NULL if the job is completed.
Synchronization [out]
On return, contains a reference to the created group association between the source and the target elements. If a job is created, this parameter can be NULL until the association is instantiated.
TargetSettingGoal [in, optional]
Specifies configuration-related and operational parameters for the target, replica, and storage objects. If existing target elements are specified, this parameter is NULL.
TargetPool [in, optional]
Specifies the underlying storage for the new target elements. If NULL, the allocation is implementation-specific. If existing target elements are supplied, this parameter is NULL.
WaitForCopyState [in, optional]
Specifies the CopyState value 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 |
|