CreateSynchronizationAspect method of the MSISCSITARGET_ReplicationService class
Creates a new representation of a source element as it currently exists.
This method does not include a target element; however, a target element can be added by using the ModifySettingsDefineState method. If the method succeeds, a CIM_SettingsDefineState association is created between the source element and the synchronization aspect instance.
This method is inherited from the CIM_ReplicationService class.
Syntax
uint32 CreateSynchronizationAspect(
[in, optional] string Name,
[in] uint16 SyncType,
[in, optional] uint16 Mode,
[in] CIM_ReplicationGroup Ref SourceGroup,
[in] CIM_LogicalElement Ref SourceElement,
[in, optional] CIM_ServiceAccessPoint Ref SourceAccessPoint,
[in, optional] uint16 Consistency,
[in, optional] string ReplicationSettingData,
[out] CIM_ConcreteJob Ref Job,
[out] CIM_SettingsDefineState Ref SettingsState
);
Parameters
-
Name [in, optional]
-
Specifies a name that is meaningful to the user for the element or relationship to be created. If NULL, a system-supplied default name is used. The value is stored in the ElementName property or the relationship name, depending on whether an element or a group is created.
-
SyncType [in]
-
Specifies the type of copy to 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 is updated synchronously or asynchronously. If NULL, the implementation decides the mode.
The possible values are.
Synchronous (2)
Asynchronous (3)
DMTF Reserved
Vendor Specific
SourceGroup [in]
Specifies a group of source storage objects, which can be MSISCSITARGET_StorageVolume objects or other storage objects. Required.
If this parameter is NULL, the SourceElement parameter is required. You cannot specify both the SourceGroup and the SourceElement parameters.
SourceElement [in]
Specifies the source storage object, which can be a MSISCSITARGET_StorageVolume object or a storage object.
If this parameter is NULL, the SourceGroup parameter is required. You cannot specify both the SourceGroup and the SourceElement parameters.
SourceAccessPoint [in, optional]
Specifies source access point information. Can be NULL, if the service does not require access information to access the source element.
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.
Job [out]
On return, contains a reference to the job, which can be NULL, if the job is completed.
SettingsState [out]
On return, contains a reference to the created association between the source element or group and an instance of synchronization aspect. If a job is created, this parameter can be NULL, if the association is not actually formed.
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 0x7FFF)
-
Vendor Specific (0x8000 = value )
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\CIMv2\Storage\iScsiTarget |
| MOF |
|
| DLL |
|