CreateSynchronizationAspect method of the CIM_ReplicationService class

  • Article

Create (or start a job to create) a new point-in-time representation of a source element. This representation may be of a form of pointers that keep track of data at the time the point-in-time was created, or a series checkpoints that capture the view of data on the source elements at the time of point-in-time. This method does not include a target element, however, a target element can be added subsequently using the ModifySettingsDefineState method. If the method executes successfully, a SettingsDefineState association is created between the source element and the SynchronizationAspect, which will have the datetime of the point-in-time.

Syntax

uint32 CreateSynchronizationAspect(
  [in]  string                      Name,
  [in]  uint16                      SyncType,
  [in]  uint16                      Mode,
  [in]  CIM_ReplicationGroup    REF SourceGroup,
  [in]  CIM_LogicalElement      REF SourceElement,
  [in]  CIM_ServiceAccessPoint  REF SourceAccessPoint,
  [in]  uint16                      Consistency,
  [in]  string                      ReplicationSettingData,
  [out] CIM_ConcreteJob         REF Job,
  [out] CIM_SettingsDefineState REF SettingsState
);

Parameters

Name [in]

A end user relevant name for the element or relationship being created. If NULL, then a system supplied default name can be used. The value will be stored in the ElementName or relationship name depending on whether an element is created or a group.

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

SourceGroup [in]

A group of source storage objects which may be a StorageVolume or storage object. If this parameter is not supplied, SourceElement is required. Both SourceGroup and SourceElement shall not be supplied.

SourceElement [in]

The source storage object which may be a StorageVolume or storage object. If this parameter is not supplied, SourceGroup is required. Both SourceGroup and SourceElement shall not be supplied.

SourceAccessPoint [in]

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

Consistency [in]

Overrides the default group consistency.

No Consistency (2)

Sequential Consistency (3)

DMTF Reserved

4 32767

Vendor Specific

32768 65535

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

SettingsState [out]

Reference to the created association between the source element or group and an instance of SynchronizationAspect. If a job is created, this parameter may be NULL unless the association is actually formed.

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