Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Grant-NfsSharePermission

Updated: October 15, 2012

Applies To: Windows Server 2012

Grant-NfsSharePermission

Grants permission to access shares that an NFS server exports.

Syntax

Parameter Set: ByName
Grant-NfsSharePermission [-Name] <String> [-ClientName] <String> [-ClientType] <String> [[-Permission] <String> ] [[-LanguageEncoding] <String> ] [[-AllowRootAccess] <Boolean> ] [-AsJob] [-CimSession <CimSession[]> ] [-NetworkName <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByPath
Grant-NfsSharePermission [-Path] <String> [-ClientName] <String> [-ClientType] <String> [[-Permission] <String> ] [[-LanguageEncoding] <String> ] [[-AllowRootAccess] <Boolean> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed 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

Parameters

-AllowRootAccess<Boolean>

Specifies whether to grant the UNIX root user access to an NFS share.


Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ClientName<String>

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.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ClientType<String>

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


Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-LanguageEncoding<String>

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


Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of an NFS share.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NetworkName<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Path<String>

Specifies the path of an NFS share.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Permission<String>

Specifies the type of access to grant for an NFS share. Valid values are:

-- no-access
-- readonly
-- readwrite


Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Nothing

Examples

Example 1: Grant NFS share permissions to a specified client computer

This command grants read/write access to a share named Export for a computer named contoso-fs.


PS C:\> Grant-NfsSharePermission -Name "Export" -ClientName "contoso-fs" -ClientType "host" -Permission "readwrite"

Example 2: Grant NFS share permissions to a specified client group

This command grants read-only access to a share named Export for a client group named contoso-clientgroup.


PS C:\> Grant-NfsSharePermission -Name "Export" -ClientName "contoso-clientgroup" -ClientType "clientgroup" -Permission "readonly"

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.