Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NfsClientgroup

Set-NfsClientgroup

msft_nfsservertasks.cmdletdefinition.cdxml

Synopsis

Adds and removes client computers from a client group.

Syntax

Set-NfsClientgroup [-ClientGroupName] [-AddMember] [-RemoveMember] [-AsJob] [-CimSession] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NfsClientGroup cmdlet adds and removes client computers from a client group on a Network File System (NFS) server. Use the ClientGroupName parameter to specify a client group to modify. Then, use the AddMember parameter to specify the client computers to add, and use the RemoveMember parameter to specify the client computers to remove.

Parameters

-AddMember <String[]>

Specifies an array of host names or IP addresses of client computers to add to the specified client group.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ClientGroupName <String>

Specifies the name of a client group.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-RemoveMember <String[]>

Specifies an array of host names or IP addresses of client computers to remove from the specified client group.

Aliases

None

Required?

false

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Nothing

Notes

None

Examples

Example 1: Add a client computer to a client group

This command adds the client computer that has the IP address 10.121.24.132 to the client group named Contoso-Group2.

PS C:\> Set-NfsClientGroup -Name "Contoso-Group2" -AddMember "10.121.24.132"

Example 2: Remove a client computer from a client group

This command removes the client computer named bill-laptop from the client group named Contoso-Group1.

PS C:\> Set-NfsClientGroup -ClientGroupName "Contoso-Group1" -RemoveMember "bill-laptop"

Online Version
Get-NfsClientgroup
New-NfsClientgroup
Remove-NfsClientgroup
Rename-NfsClientgroup