PowerShell Logo Small

Rename-NfsClientgroup



This is the built-in help made by Microsoft for the command 'Rename-NfsClientgroup', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Renames a client group on an NFS server.

SYNTAX


Rename-NfsClientgroup [-ClientGroupName] <String> [-NewClientGroupName] <String> [-AsJob] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf]
[<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Rename-NfsClientGroup cmdlet changes the name of a client group on a Network File System (NFS) server. Renaming a client group does not affect the members of the client.





<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?linkid=287501
Get-NfsClientgroup
New-NfsClientgroup
Remove-NfsClientgroup
Set-NfsClientgroup

REMARKS

<

Examples


Example 1: Rename a client group by using a name

PS C:\> Rename-NfsClientGroup -ClientGroupName "Contoso-cg1" -NewClientGroupName "Contoso-NewCg"



This command renames a client group that has the name Contoso-cg1 to Contoso-NewCg.




Example 2: Rename a client group by using an input pipeline

PS C:\> Get-NfsClientGroup -ClientGroupName "Contoso-cg1" | Rename-NfsClientGroup -NewClientGroupName "Contoso-NewCg"



This command gets the client group named Contoso-cg1.

The second command then uses the pipeline operator to pass the result to Rename-NfsClientGroup, which renames the client group Contoso-NewCg.