CreateGroup method of the MSISCSITARGET_ReplicationService class

Creates a new replication group.

This method is inherited from the CIM_ReplicationService class.

Syntax

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

Parameters

GroupName [in, optional]

Specifies an end user name that is meaningful for the group that is to be created. If NULL, or the group is not nameable, then the system assigns a name.

Members [in, optional]

Specifies a list of elements to add to the group. The order of the specified elements is maintained. If NULL, the group is empty.

Note

Empty groups might not be allowed, in which case this parameter is required.

Persistent [in, optional]

Specifies whether the group persists after a copy operation. If false, the group, but not the elements that are associated with the group, can be deleted at the completion of a copy operation. Otherwise, the group persists.

DeleteOnEmptyElement [in, optional]

Specifies whether to delete the group when the last element is removed. If True, the group is deleted after the last element is removed from the group. Otherwise, the empty group is retained.

Note

If empty groups are not allowed, the group is deleted automatically after the group becomes empty even if this parameter is false.

If this parameter is not NULL, its value is used to set the DeleteOnEmptyElement property of the group.

DeleteOnUnassociated [in, optional]

Specifies whether to delete the group when the group is no longer associated with another group. If True, the group is deleted after the last association is dissolved.

This can happen if all synchronization associations to the individual elements of the group are dissolved.

If this parameter is not NULL, its value is used to set the DeleteOnUnassociated property of the group.

ServiceAccessPoint [in, optional]

Specifies a reference to access point information to enable the service to create a group on a remote system. If NULL, the group is created on the local system.

ReplicationGroup [out]

On return, contains a reference to the created group.

ReplicationSettingData [in, optional]

If provided, specifies the replication setting data in the form of an embedded CIM_ReplicationSettingData instance. If not provided, the management server uses the default replication setting data.

Return value

This method returns one of the following values:

Success (0)

Not Supported (1)

Unknown (2)

Timeout (3)

Failed (4)

Invalid Parameter (5)

In Use (6)

Groups are not nameable (7)

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

CIM_ServiceAccessPoint