Share via


CreateOrModifyReplicationPipe method of the CIM_StorageConfigurationService class

This method establishes a peer-to-peer connection identified by a NetworkPipe element and two ProtocolEndpoint elements created by the method provider. The NetworkPipe is associated to a special peer-to-peer Network element. The provider will verify that two systems are capable of a peer relationship. If endpoints are assigned to the pipe, the same number of source and target endpoints must be supplied by the client to form a set of endpoint pairs. If ReplicationPipe is not supplied as an input parameter, a new pipe is created. If a pipe is supplied, a new set of endpoints is assigned to the existing pipe.

If Success (0) is returned, the function completed successfully.

A return value of Not Supported (1) indicates the method is not supported.

A return value of Busy (0x1000) indicates the method is not supported.

All other values indicate some type of error condition.

Syntax

uint32 CreateOrModifyReplicationPipe(
  [in]      string                   PipeElementName,
  [in]      CIM_ComputerSystem   REF SourceSystem,
  [in]      CIM_ComputerSystem   REF TargetSystem,
  [in]      CIM_ProtocolEndpoint REF SourceEndpoint[],
  [in]      CIM_ProtocolEndpoint REF TargetEndpoint[],
  [in]      string                   Goal,
  [in, out] CIM_NetworkPipe      REF ReplicationPipe
);

Parameters

PipeElementName [in]

A user-friendly name for the element created.

SourceSystem [in]

One of the two peer systems participating in the established peer-to-peer connection. If the provider supports uni-directional connections, this must identify the system hosting replica source elements.

TargetSystem [in]

One of the two peer systems participating in the established peer-to-peer connection. If the provider supports uni-directional connections, this must identify the system hosting replica target elements.

SourceEndpoint [in]

References to source system endpoints/ports assigned to the pipe. If a new pipe is created, this is the initial set of endpoints assigned. If an existing pipe is modified, this set replaces the previous set. The list must be null if a provider does not allow the client to manage port assignment.

TargetEndpoint [in]

References to target system endpoints/ports assigned to the pipe. If a new pipe is created, this is the initial set of endpoints assigned. If an existing pipe is modified, this set replaces the previous set. The list must be null if a provider does not allow the client to manage port assignment.

Goal [in]

The setting properties to be maintained for the peer-to-peer connection.

ReplicationPipe [in, out]

Reference to the created or modified NetworkPipe.

Return value

Success (0)

Not Supported (1)

Unspecified Error (2)

Timeout (3)

Failed (4)

Invalid Parameter (5)

DMTF Reserved (6 4095)

Busy (4096)

Method Reserved (4097 32767)

Vendor Specific (32768 65535)

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_StorageConfigurationService