GetAvailableTargetElements method of the MSISCSITARGET_ReplicationService class

Gets all of the available target elements for the supplied source element.

This method is inherited from the CIM_ReplicationService class.

Syntax

uint32 GetAvailableTargetElements(
  [in]           CIM_LogicalElement Ref     SourceElement,
  [in]           uint16                     SyncType,
  [in, optional] uint16                     Mode,
  [in, optional] string                     ReplicationSettingData,
  [in, optional] CIM_ServiceAccessPoint Ref TargetAccessPoint,
  [in, optional] CIM_SettingData Ref        TargetSettingGoal,
  [in, optional] CIM_ResourcePool Ref       TargetPools[],
  [out]          CIM_ConcreteJob Ref        Job,
  [out]          CIM_LogicalElement Ref     Candidates[]
);

Parameters

SourceElement [in]

Specifies the source storage object that can be a CIM_StorageVolume class or a storage object. Required.

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

4 0x7FFF

Vendor Specific

0x8000 = *value*

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.

TargetAccessPoint [in, optional]

Specifies the target access point information. If NULL, only the local system is examined.

TargetSettingGoal [in, optional]

Specifies configuration-related and operational parameters for the target element. If NULL, the settings of the source element are used.

TargetPools [in, optional]

Specifies the storage pools for the target elements to examine. If NULL, all storage pools on the given system are examined.

Job [out]

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

If a job is started and after the job is completed, you can examine the CIM_AffectedJobElement associations for candidate targets.

Candidates [out]

On return, contains the list of the candidate target elements.

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

MSISCSITARGET_AffectedJobElement