ModifySettingsDefineState method of the MSISCSITARGET_ReplicationService class

Modifies the CIM_SettingsDefineState association between the storage objects and the synchronization aspect. The modification could range from introducing the target elements, which creates a new CIM_StorageSynchronized association, to dissolving the CIM_SettingsDefineState association.

This method is inherited from the CIM_ReplicationService class.

Syntax

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

Parameters

Operation [in]

Specifies the type of modification to be made to the related associations. Required.

Activate Consistency (2)

Activates consistency if it is not already active.

Deactivate Consistency (3)

Deactivates consistency if it is active.

Delete (4)

Removes the CIM_SettingsDefineState association.

Copy To Target (5)

Introduces the target elements and forms the necessary associations between the source and the target elements.

DMTF Reserved

Reserved.

Vendor Specific

Reserved.

SettingsState [in]

Specifies the association between the source element and a synchronization aspect. Required.

TargetElement [in, out]

On input, specifies a target element to use. Optional. If the TargetElement parameter is specified, the TargetGroup and TargetCount parameters must be NULL.

On output, contains a reference to the created target storage element. If a job is created, the target element might not be available immediately.

TargetGroup [in, out]

On input, specifies a target group to use. Optional. If the TargetGroup parameter is specified, the TargetElement and TargetCount parameters must be NULL.

On output, contains a reference to the created target group. If a job is created, the target group might not be available immediately.

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 TargetElementand TargetGroup parameters 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.

Synchronization [out, optional]

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.

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

Job [out]

On return, contains a reference to the job, which can be NULL, if the job is completed.

TargetSettingGoal [in, optional]

Specifies configuration-related and operational parameters for the target storage objects. If existing target elements are specified, this parameter must be set to NULL.

TargetPool [in, optional]

Specifies the resource pool to use for the underlying storage for the target element. If NULL, the allocation is implementation-specific. If a TargetElement is specified, this parameter must be NULL.

WaitForCopyState [in, optional]

Specifies the CopyState value that must be reached before this method returns. Only a subset of valid values applies.

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)

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 0x7FFF)

Vendor Specific (0x8000 = value )

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

MSISCSITARGET_ReplicationService