Export (0) Print
Expand All

Get-NfsSharePermission

Updated: October 15, 2012

Applies To: Windows Server 2012

Get-NfsSharePermission

Gets information about permissions that an NFS server grants to exported NFS shares.

Syntax

Parameter Set: ByName
Get-NfsSharePermission [-Name] <String> [[-ClientName] <String> ] [[-ClientType] <String> ] [[-Permission] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-NetworkName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByPath
Get-NfsSharePermission [-Path] <String> [[-ClientName] <String> ] [[-ClientType] <String> ] [[-Permission] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-NfsSharePermission cmdlet gets information about access permissions granted by a Network File System (NFS) server that has an NFS share configured.

Parameters

-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?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ClientType<String>

Specifies a client type. The acceptable values for this parameter are: 

-- host
-- clientgroup
-- netgroup


Aliases

none

Required?

false

Position?

3

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


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

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

  • Microsoft.Management.Infrastructure.CimInstance#root/microsoft/windows/nfs/MSFT_NfsSharePermission

Examples

Example 1: Get all permissions for a specified NFS share

This command gets the permissions for an NFS share named Export.


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 : ansi

Example 2: Get read/write permissions for a specified NFS share

This command gets the read/write permissions for an NFS share named Export.


PS C:\> Get-NfsSharePermission -Name "Export" -Permission "readwrite"

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft