Export (0) Print
Expand All

Get-NfsShare

Updated: October 15, 2012

Applies To: Windows Server 2012

Get-NfsShare

Gets NFS shares on an NFS server.

Syntax

Parameter Set: ByName
Get-NfsShare [[-Name] <String[]> ] [[-IsClustered]] [[-NetworkName] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ExcludeName <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByLiteralName
Get-NfsShare -LiteralName <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByLiteralPath
Get-NfsShare -LiteralPath <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByPath
Get-NfsShare [[-Path] <String[]> ] [[-IsClustered]] [[-NetworkName] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ExcludePath <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-NfsShare cmdlet gets Network File System (NFS) shares that are configured on a computer. By default, the cmdlet gets all the nonclustered (standard) shares from the local computer. If the server belongs to a server cluster, the cmdlet enumerates all the local shares in addition to the cluster shares that belong to resource groups that the local node owns.

The local node is the node where you run the cmdlet. Shares that belong to resource groups that other nodes of the cluster own are not enumerated.

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

-ExcludeName<String[]>

Specifies an array of share names to exclude from the list of shares that the cmdlet gets from an NFS server.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-ExcludePath<String[]>

Specifies an array of share paths to exclude from the list of shares that the cmdlet gets from an NFS server.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IsClustered

Enumerates shares that are highly available and are configured in a failover cluster.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-LiteralName<String[]>

Specifies an array of share names to get from an NFS server.

The cmdlet uses the value of LiteralName exactly as typed. The cmdlet does not interpret any characters as wildcards. If the name includes escape characters, enclose it in single quotation marks ('). Single quotation marks instruct Windows PowerShell®not to interpret any characters as escape sequences.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-LiteralPath<String[]>

Specifies an array of share paths to get from an NFS server.

The cmdlet uses the value of LiteralName exactly as typed. The cmdlet does not interpret any characters as wildcards. If the name includes escape characters, enclose it in single quotation marks ('). Single quotation marks instruct Windows PowerShell not to interpret any characters as escape sequences.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of share names to get from a local NFS server.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

-NetworkName<String[]>

Specifies an array of network names. Get-NfsShare gets the NFS shares scoped to specified networks.

For a local NFS share, the network name is the host name. For a server cluster, the network name is the network name in the resource group to which the share is scoped.


Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Path<String[]>

Specifies an array of share paths on a local NFS server.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

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

Examples

Example 1: Get an NFS share

This command gets an NFS share named NFSshare01.


PS C:\> Get-NfsShare -Name "NFSshare01"
Name:                 nfsexport
Path:                 C:\shares\nfsexport
NetworkName:          GAPRASAD-TST22
Availability:         Standard (not clustered)
Online:               True
AnonymousAccess:       Disabled
AnonymousGid: -2
AnonymousUID: -2
UnmappedUserAccess:   Enabled
Authentication:         {sys, Krb5, Krb5i, Krb5p}

Example 2: Get all NFS shares on a local computer

This command gets all the NFS shares on a local computer.


PS C:\> Get-NfsShare
              
Name:              nfsexportA
Path:                  C:\shares\nfsexportA
NetworkName:           contoso-fs
Availability:          Standard (not clustered)
Online:                True
AnonymousAccess:       Disabled
AnonymousGID: -2
AnonymousUID: -2
UnmappedUserAccess:    Enabled
Authentication:        {sys, Krb5, Krb5i, Krb5p}
Name:              nfsexportB
Path:                  C:\shares\nfsexportB
NetworkName:           contoso-fs
Availability:          Standard (not clustered)
Online:                True
AnonymousAccess:       Disabled
AnonymousGID: -2
AnonymousUID: -2
UnmappedUserAccess:    Enabled
Authentication:        {sys, Krb5, Krb5i, Krb5p}

Related topics

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