Grant-NfsSharePermission

  • Reference
Module:
NFS

Grants permission to access shares that an NFS server exports.

Syntax

Grant-NfsSharePermission
     [-ClientName] <String>
     [-ClientType] <String>
     [[-Permission] <String>]
     [[-LanguageEncoding] <String>]
     [[-AllowRootAccess] <Boolean>]
     [-Name] <String>
     [-NetworkName <String>]
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
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.

Type:Boolean
Position:5
Default value:None
Required:False
Accept pipeline input:True
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
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:True
Accept pipeline input:True
Accept wildcard characters: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
Type:String
Aliases:Type
Accepted values:host, netgroup, clientgroup, builtin
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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
Type:String
Aliases:Lang, Encoding
Accepted values:euc-jp, euc-tw, euc-kr, shift-jis, big5, ksc5601, gb2312-80, ansi
Position:4
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 grant for an NFS share. Valid values are:

  • no-access
  • readonly
  • readwrite
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

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Nothing