Edit

Share via

Get-NfsClientgroup

  • Reference
Module:
NFS

Gets client groups configured on an NFS server.

Syntax

Get-NfsClientgroup
   [[-ClientGroupName] <String[]>]
   [-ExcludeName <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-NfsClientgroup
   -LiteralName <String[]>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-NfsClientGroup cmdlet gets a list of client groups configured on a Network File System (NFS) server and the list of members of the client groups. By default, the cmdlet enumerates all the client groups configured on a server. You can use the optional ClientGroupName parameter to get a specific client group.

Examples

Example 1: Get client groups by using a name

PS C:\> Get-NfsClientgroup -ClientGroupName "ClientGroup*"

ClientGroupMembers : {contoso-fs2}
ClientGroupName    : clientgroupA

ClientGroupMembers : {contoso-fs1}
ClientGroupName    : clientgroupB

This command gets the client groups on local computer that start with the name ClientGroup.

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 an array of client group names.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ExcludeName

Specifies an array of client group names to exclude from the client groups that the cmdlet gets from the NFS server.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LiteralName

Specifies an array of client groups to get from the NFS server.

The cmdlet uses the value of LiteralName exactly as typed. The cmdlet does not interpret any characters as wildcards. If the name includes escape characters, enclose it in single quotation marks ('). Single quotation marks instruct Windows PowerShell not to interpret any characters as escape sequences.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
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

Outputs

CimInstance