Share via

ModifySettingsDefineState method of the CIM_ReplicationService class

  • Article

Modify (or start a job to modify) the SettingsDefineState association between the storage objects and SynchronizationAspect. The modification could range from introducing the target elements, which creates a new StorageSynchronized association to dissolving the SettingsDefineState association. If 0 is returned, the function completed successfully and no ConcreteJob instance was created. If 4096/0x1000 is returned, a ConcreteJob was started and a reference to this Job is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition.

Syntax

uint32 ModifySettingsDefineState(
  [in]      uint16                      Operation,
  [in]      CIM_SettingsDefineState REF SettingsState,
  [in, out] CIM_LogicalElement      REF TargetElement,
  [in, out] CIM_ReplicationGroup    REF TargetGroup,
  [in]      uint64                      TargetElementCount,
  [in]      CIM_ServiceAccessPoint  REF TargetAccessPoint,
  [out]     CIM_Synchronized        REF Synchronization,
  [in]      string                      ReplicationSettingData,
  [out]     CIM_ConcreteJob         REF Job,
  [in]      CIM_SettingData         REF TargetSettingGoal,
  [in]      CIM_ResourcePool        REF TargetPool,
  [in]      uint16                      WaitForCopyState
);

Parameters

Operation [in]

Operation describes the type of modification to be made to the related associations. Activate Consistency: if consistency was not requested when CreateSynchronizationAspect was called. If Consistency is already active, no modification is made. Deactivate Consistency: Deactivate consistency. If consistency was not enabled, this operation has no effect. Delete: Remove the SettingsDefineState association. Copy To Target: Introduces the target elements and forms the necessary associations between the source and the target elements i.e. StorageSynchronized and GroupSynchronized.

Activate Consistency (2)

Deactivate Consistency (3)

Delete (4)

Copy To Target (5)

DMTF Reserved

6 32767

Vendor Specific

32768 65535

SettingsState [in]

Reference to the association between the source element and an instance of SynchronizationAspect.

TargetElement [in, out]

Optionally, as an input, refers to a target element to use. If TargetElement is supplied, TargetGroup and TargetCount shall be NULL. 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.

TargetGroup [in, out]

Optionally, as an input, refers to a target group to use. If TargetGroup is supplied, TargetElement and TargetCount shall be NULL. As an output, refers to the created target group (i.e., the replica group). If a job is created, the target group may not be available immediately. If TargetGroup is supplied, TargetElementCount shall be NULL.

TargetElementCount [in]

This parameter applies to one-source-to-many-target- elements. It is possible to create multiple copies of a source element. If TargetCount is supplied, TargetElement and TargetGroup shall be NULL.

TargetAccessPoint [in]

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

Synchronization [out]

The reference to the created replication association describing the elements/groups relationship.

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 the task completed).

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. Fractured/Split: Target elements are separated from the source elements. Etc.

Return value

Completed with No Error (0)

Not Supported (1)

Unspecified Error (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