ModifyListSettingsDefineState method of the MSISCSITARGET_ReplicationService class

Modifies or starts a job to modify a list of CIM_SettingsDefineState associations.

This method is inherited from the CIM_ReplicationService class.

Syntax

uint32 ModifyListSettingsDefineState(
  [in]                uint16                      Operation,
  [in]                CIM_SettingsDefineState Ref SettingsStates[],
  [in, out, optional] CIM_LogicalElement Ref      TargetElements[],
  [in, out, optional] CIM_ReplicationGroup Ref    TargetGroups[],
  [in]                uint64                      TargetElementCount,
  [in, optional]      CIM_ServiceAccessPoint Ref  TargetAccessPoint,
  [out]               CIM_Synchronized Ref        Synchronizations[],
  [in, optional]      string                      ReplicationSettingData,
  [out]               CIM_ConcreteJob Ref         Job,
  [in]                CIM_SettingData Ref         TargetSettingGoal,
  [in]                CIM_ResourcePool Ref        TargetPool,
  [in]                uint16                      WaitForCopyState
);

Parameters

Operation [in]

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

The possible values are.

Activate Consistency (2)

Activate consistency if not already active.

Deactivate Consistency (3)

Deactivate consistency if it is active.

Delete (4)

Remove the CIM_SettingsDefineState association.

Copy To Target (5)

Introduce the target elements and form the necessary associations between the source and the target elements.

DMTF Reserved

Reserved.

Vendor Specific

Reserved.

SettingsStates [in]

Specifies an array of references to the associations between the source elements and instances of the synchronization aspect.

TargetElements [in, out, optional]

On input, optionally specifies a list of target elements to use. On return, contains references to the created target storage elements. If a job is created, the target elements might not be available immediately.

If you specify the TargetElements parameter, the TargetGroups and TargetElementCount parameters must be NULL.

TargetGroups [in, out, optional]

On input, optionally specifies a list of target groups to use. On return, contains references to the created target groups. If a job is created, the target groups might not be available immediately.

If you specify the TargetGroups parameter, the TargetElements and TargetElementCount parameters must be NULL.

TargetElementCount [in]

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 TargetGroups and TargetElements 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 group.

Synchronizations [out]

On return, contains an array of references to the created replication associations.

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]

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

TargetPool [in]

Specifies the underlying storage for the new target elements. If NULL, the allocation is implementation-specific. If existing target elements are supplied, this parameter must be NULL.

WaitForCopyState [in]

Specifies the CopyState values 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)

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	SmIscsiTarget.mof
DLL	SmIScsiTargetProv.dll

See also

MSISCSITARGET_ReplicationService