Grant-NfsSharePermission
Grants permission to access shares that an NFS server exports.
Syntax
ByName (Default)
Grant-NfsSharePermission
[-ClientName] <String>
[-ClientType] <String>
[[-Permission] <String>]
[[-LanguageEncoding] <String>]
[[-AllowRootAccess] <Boolean>]
[-Name] <String>
[-NetworkName <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByPath
Grant-NfsSharePermission
[-Path] <String>
[-ClientName] <String>
[-ClientType] <String>
[[-Permission] <String>]
[[-LanguageEncoding] <String>]
[[-AllowRootAccess] <Boolean>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Grant-NfsSharePermission cmdlet configures access permissions to a Network File System (NFS) share that an NFS server exports. You can use Grant-NfsSharePermission to grant permissions for a share by using a specified name or path.
You can choose the type of permissions to provide to client computers, netgroups, or client groups.
You can choose to fence the language encoding across individual hosts or netgroups. Services for NFS supports fencing of shares by using the following principals:
- Hosts
- Client groups
- Netgroups
Examples
Example 1: Grant NFS share permissions to a specified client computer
PS C:\> Grant-NfsSharePermission -Name "Export" -ClientName "contoso-fs" -ClientType "host" -Permission "readwrite"
This command grants read/write access to a share named Export for a computer named contoso-fs.
Example 2: Grant NFS share permissions to a specified client group
PS C:\> Grant-NfsSharePermission -Name "Export" -ClientName "contoso-clientgroup" -ClientType "clientgroup" -Permission "readonly"
This command grants read-only access to a share named Export for a client group named contoso-clientgroup.
Example 3: Grant NFS share permissions to a specific UNIX computer with root user access
PS C:\> Grant-NfsSharePermission -Name "Export" -ClientName "192.168.1.8" -ClientType "host" -Permission "readonly" -AllowRootAccess:$true
This command grants read access to a share named Export for a computer specifying its IP address, and also grants UNIX root user access.
Parameters
-AllowRootAccess
Specifies whether to grant the UNIX root user access to an NFS share.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 5 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Client |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ClientType
Specifies a client type. Use the builtin client type only when the ClientName parameter value is All Machines.
Valid values are:
- host
- clientgroup
- netgroup
- builtin
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | host, netgroup, clientgroup, builtin |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Type |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LanguageEncoding
Specifies the type of language encoding used for access permissions configured on an NFS share. You can use only one of the following values for a share:
- euc-jp (Japanese)
- euc-tw (Chinese)
- euc-kr (Korean)
- shift-jis (Japanese)
- big5 (Chinese)
- ksc5601 (Korean)
- gb2312-80 (Simplified Chinese)
- ansi
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | euc-jp, euc-tw, euc-kr, shift-jis, big5, ksc5601, gb2312-80, ansi |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Lang, Encoding |
Parameter sets
(All)
| Position: | 4 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
Specifies the name of an NFS share.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ShareName |
Parameter sets
ByName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | netname |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Path
Specifies the path of an NFS share.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SharePath |
Parameter sets
ByPath
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Permission
Specifies the type of access to grant for an NFS share. Valid values are:
- no-access
- readonly
- readwrite
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | no-access, readonly, readwrite |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Access |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.