GetAvailableTargetElements method of the CIM_ReplicationService class

Get (or start a job to get) all of the candidate target elements for the supplied source element. If a job is started, once the job completes, examine the AffectedJobElement associations for candidate targets.

Syntax

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

Parameters

SourceElement [in]

The source storage object which may be a StorageVolume or storage object.

SyncType [in]

SyncType describes the type of copy.

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, the implementation decides.

Synchronous (2)

Asynchronous (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.

TargetAccessPoint [in]

Reference to access point information. If NULL, only local system is examined.

TargetSettingGoal [in]

Desired target SettingData. If NULL, settings of the source element will be used.

TargetPools [in]

The storage pools for the target elements. If NULL, all storage pools (on the given system) will be examined.

Job [out]

Reference to the job (may be NULL if the task completed).

Candidates [out]

The list of the candidate target elements.

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