CreateRemoteReplicationCollection method of the CIM_ReplicationService class

  • Article

Create (or start a job to create) a new instance of RemoteReplicationCollection, and optionally supply the remote system and the paths (i.e. ProtocolEndpoints) that are used to perform replication operations to/from the remote system. If 0 is returned, the function completed successfully and no ConcreteJob instance created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. Once the job completes, examine the AffectedJobElement associations for the created instance of RemoteReplicationCollection.

Syntax

uint32 CreateRemoteReplicationCollection(
  [in]  string                         ElementName,
  [in]  CIM_ServiceAccessPoint     REF LocalAccessPoints[],
  [in]  CIM_ServiceAccessPoint     REF RemoteAccessPoints[],
  [in]  CIM_ComputerSystem         REF RemoteComputerSystem,
  [in]  boolean                        Active,
  [in]  boolean                        DeleteOnUnassociated,
  [out] CIM_ConcreteJob            REF Job,
  [out] CIM_ConnectivityCollection REF ConnectivityCollection
);

Parameters

ElementName [in]

A end user relevant name for the element being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created element.

LocalAccessPoints [in]

An array of references to local ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.

RemoteAccessPoints [in]

An array of references to remote ServiceAccessPoints (for example, ProtocolEndpoints) that allow communication to the remote system.

RemoteComputerSystem [in]

A reference to the remote system.

Active [in]

If true, the instance of RemoteReplicationCollection will be enabled and allows replication operations to to the remote system. Use the intrinsic method ModifyInstance to change this property after the RemoteReplicationCollection is created.

DeleteOnUnassociated [in]

If true, the instance of RemoteReplicationCollection will be deleted when it is no longer associated to a ServiceAccessPoint. Use the intrinsic method ModifyInstance to change this property after the RemoteReplicationCollection is created.

Job [out]

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

ConnectivityCollection [out]

Reference to the created instance ofRemoteReplicationCollection.

Return value

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