Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Set-NfsClientgroup

Last Updated: 2/14/2017

SYNOPSIS

Adds and removes client computers from a client group.

SYNTAX

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

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.

EXAMPLES

Example 1: Add a client computer to a client group

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

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

Example 2: Remove a client computer from a client group

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

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

PARAMETERS

-AddMember

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

Type: String[]
Parameter Sets: (All)
Aliases: add

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClientGroupName

Specifies the name of a client group.

Type: String
Parameter Sets: (All)
Aliases: name, cgname

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-RemoveMember

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

Type: String[]
Parameter Sets: (All)
Aliases: remove

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Nothing

NOTES

Get-NfsClientgroup

New-NfsClientgroup

Remove-NfsClientgroup

Rename-NfsClientgroup

© 2017 Microsoft