Edit

Share via

Rename-NfsClientgroup

  • Reference
Module:
NFS

Renames a client group on an NFS server.

Syntax

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

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

Indicates that this cmdlet runs the command as a background job on a remote computer. Use this parameter to run commands that take an extensive time to finish.

When you use the AsJob parameter, the command returns an object that represents the job, and then displays the command prompt. You can continue to work in the session while the job finishes. To manage the job, use the Job cmdlets. To get the job results, use the Receive-Job cmdlet.

The AsJob parameter resembles using the Invoke-Command cmdlet to run a Start-Job command remotely. However, with AsJob, the job is created on the local computer, even though the job runs on a remote computer, and the results of the remote job are automatically returned to the local computer.

For more information about Windows PowerShell background jobs, see about_Jobs and about_Remote_Jobs.

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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
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
Aliases:name, cgname
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
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
Aliases:newname, newcgname
Position:1
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
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Nothing