Get-NfsSharePermission
Gets information about permissions that an NFS server grants to exported NFS shares.
Syntax
Get-NfsSharePermission
[[-ClientName] <String>]
[[-ClientType] <String>]
[[-Permission] <String>]
[-Name] <String>
[-NetworkName <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-NfsSharePermission
[-Path] <String>
[[-ClientName] <String>]
[[-ClientType] <String>]
[[-Permission] <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Description
The Get-NfsSharePermission cmdlet gets information about access permissions granted by a Network File System (NFS) server that has an NFS share configured.
Examples
Example 1: Get all permissions for a specified NFS share
PS C:\> Get-NfsSharePermission -Name "Export"
ClientName : All Machines
ClientType : Built-in Group
Name : Export
Path : C:\shares\Export
Permission : READ, WRITE
AllowRootAccess : ALLOW ACCESS
LanguageEncoding : ansiThis command gets the permissions for an NFS share named Export.
Example 2: Get read/write permissions for a specified NFS share
PS C:\> Get-NfsSharePermission -Name "Export" -Permission "readwrite"This command gets the read/write permissions for an NFS share named Export.
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 |
-ClientName
Specifies a client name. The client name can be a host name or IP address, netgroup name, or client group name. To specify the type of client, use the ClientType parameter.
| Type: | String |
| Aliases: | Client |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ClientType
Specifies a client type. The acceptable values for this parameter are:
- host
- clientgroup
- netgroup
| Type: | String |
| Aliases: | Type |
| Accepted values: | host, netgroup, clientgroup, builtin |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of an NFS share.
| Type: | String |
| Aliases: | ShareName |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NetworkName
Specifies the scoped network name of an NFS share.
On a local share, NetworkName is the host name. On a cluster, it is the network name in the resource group to which the share is scoped.
| Type: | String |
| Aliases: | netname |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Path
Specifies the path of an NFS share.
| Type: | String |
| Aliases: | SharePath |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Permission
Specifies the type of access to get for an NFS share. The acceptable values for this parameter are:
- no-access
- readonly
- readwrite
A client can have either read-only or read/write access. Only the All Machines group can have all three types of access.
| Type: | String |
| Aliases: | Access |
| Accepted values: | no-access, readonly, readwrite |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| 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 |