Rename-NfsClientgroup
Renames a client group on an NFS server.
Syntax
Rename-NfsClientgroup
[-ClientGroupName] <String>
[-NewClientGroupName] <String>
[-AsJob]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-Confirm]
[-WhatIf]
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.
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.
Parameters
-AsJob
ps_cimcommon_asjob
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.
Type: | CimSession[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ClientGroupName
Specifies the name of the client group to rename.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NewClientGroupName
Specifies a new name for the client group.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of 0
is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
Nothing
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for