Share via

CreateGroup method of the CIM_ReplicationService class

  • Article

Create a new replication group.

Syntax

uint32 CreateGroup(
  [in]  string                     GroupName,
  [in]  CIM_LogicalElement     REF Members[],
  [in]  boolean                    Persistent,
  [in]  boolean                    DeleteOnEmptyElement,
  [in]  boolean                    DeleteOnUnassociated,
  [in]  CIM_ServiceAccessPoint REF ServiceAccessPoint,
  [out] CIM_ReplicationGroup   REF ReplicationGroup,
  [in]  string                     ReplicationSettingData
);

Parameters

GroupName [in]

If nameable, an end user relevant name for the group being created. If NULL or not nameable, then system assigns a name.

Members [in]

List of elements to add to the group -- order is maintained. If NULL, the group will be empty -- if empty groups are supported.

Persistent [in]

If false, the group, not the elements associated with the group, may be deleted at the completion of a copy operation. Use the intrinsic method ModifyInstance to change Persistencyof a group.

DeleteOnEmptyElement [in]

If true and empty groups are allowed, the group will be deleted when the last element is removed from the group. If empty groups are not allowed, the group will be deleted automatically when the group becomes empty. If this parameter is not NULL, its value will be used to set the group's DeleteOnEmptyElement property. Use the intrinsic method ModifyInstance to change this property after the group is created.

DeleteOnUnassociated [in]

If true, the group will be deleted when the group is no longer associated with another group. This can happen if all synchronization associations to the individual elements of the group are dissolved. If this parameter is not NULL, its value will be used to set the group's DeleteOnUnassociated property. Use the intrinsic method ModifyInstance to change this property after the group is created.

ServiceAccessPoint [in]

Reference to access point information to allow the service to create a group on a remote system. If NULL, the group is created on the local system.

ReplicationGroup [out]

Reference to the created group.

ReplicationSettingData [in]

If supplied, it provides additional replication settings for the method. For example, to supply the "Description" for the created group.

Return value

Success (0)

Not Supported (1)

Unknown (2)

Timeout (3)

Failed (4)

Invalid Parameter (5)

In Use (6)

Groups are not nameable (7)

DMTF Reserved (8 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