SetFriendlyName method of the MSFT_SMReplicationGroup class

Updates the user friendly name of a replication group.

Syntax

UInt32 SetFriendlyName(
  [in]            String                FriendlyName,
  [in, optional]  String                username,
  [in, optional]  String                password,
  [out]           MSFT_SMJob        REF Job,
  [out, optional] MSFT_SMExtendedStatus ExtendedStatus
);

Parameters

FriendlyName [in]

The new name of the replication group.

username [in, optional]

The username used to authenticate the SMI-S provider.

password [in, optional]

The password used to authenticate the SMI-S provider.

Job [out]

If this operation is asynchronous, when this method returns, this parameter contains a reference to the object that represents the job; otherwise this parameter is set to NULL.

ExtendedStatus [out, optional]

When this method returns, this parameter contains a MSFT_SMExtendedStatus object that contains detailed status information about the results of this operation.

Return value

The possible return values are:

Success (0)

Not Supported (1)

Unspecified Error (2)

Timeout (3)

Failed (4)

Invalid Parameter (5)

Access denied (40001)

There are not enough resources to complete the operation. (40002)

Cannot connect to the storage provider. (46000)

The storage provider cannot connect to the storage subsystem. (46001)

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Namespace	Root\Microsoft\Windows\Storage\SM
MOF	MsftStrgMan.mof
DLL	StorageService.dll

See also

MSFT_SMReplicationGroup