New-Nfs Share

Module:
nfs
Creates an NFS file share.

Syntax 

New-NfsShare
   [-Name] <String>
   [-Path] <String>
   [[-NetworkName] <String>]
   [[-Authentication] <String[]>]
   [[-AnonymousUid] <Int32>]
   [[-AnonymousGid] <Int32>]
   [[-LanguageEncoding] <String>]
   [[-EnableAnonymousAccess] <Boolean>]
   [[-EnableUnmappedAccess] <Boolean>]
   [[-AllowRootAccess] <Boolean>]
   [[-Permission] <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-NfsShare cmdlet creates a Network File System (NFS) file share. To create a share, you must specify a name and a path. If you do not use the optional parameters for this cmdlet, New-NfsShare assigns default values for these share settings.

If you specify a path to a clustered disk for a new NFS share, this cmdlet creates a highly available clustered share. You can use the NetworkName parameter to scope a share to a specified network name. The network name must belong to the same resource group as the clustered disk. If you do not specify the network name, New-NfsShare assigns an arbitrary network name that is available in the same resource group to scope the share.

Examples

Example 1: Create an NFS share for a folder 

PS C:\> New-NfsShare -Name "NFSshare01" -Path "C:\shares\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}

This command creates an NFS share named NFSshare01 for sharing the folder C:\shares\NFSshare01.

Example 2: Create an NFS share that has unmapped access 

PS C:\> New-NfsShare -Name "NFSshare01" -Path "C:\shares\NFSshare01" -EnableUnmappedAccess $True -Authentication krb5,krb5i

This command creates an NFS share named NFSshare01 for sharing the folder C:\shares\ NFSshare01. This command enables unmapped access on the new share and configures Krb5 and Krb5i authentication on the share.

Required Parameters

-Name

Specifies the name of the NFS share to create.

Type: String
Aliases: ShareName
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Path

Specifies the path of a new NFS share.

Type: String
Aliases: SharePath
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional Parameters

-AllowRootAccess

Grants the UNIX root user access to a share.

Type: Boolean
Position: 9
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-AnonymousGid

Specifies the group identifier (GID) that Server for NFS uses for anonymous users who access an NFS share.

Type: Int32
Aliases: AnonGid
Position: 5
Default value: -2
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-AnonymousUid

Specifies the user identifier (UID) that Server for NFS uses for anonymous users who access an NFS share.

Type: Int32
Aliases: AnonUid
Position: 4
Default value: -2
Accept pipeline input: True (ByPropertyName)
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
Accept pipeline input: False
Accept wildcard characters: False
-Authentication

Specifies an array of authentication types that an NFS client can use to access NFS shares. The acceptable values for this parameter are:

-- Sys (AUTH_SYS authentication)

  • Krb5 (Kerberos v5 authentication)
  • Krb5i (Kerberos v5 authentication with integrity checking)
  • Krb5p (Kerberos v5 authentication with privacy)
  • All
  • Default

If you specify All, Server for NFS configures Sys, Krb, Krbi, and Krbp on the share. If you specify Default, Server for NFS configures Sys, Krb, and Krbi on the share.

Type: String[]
Aliases: af, auth
Parameter Sets: sys, krb5, krb5i, krb5p, all, default
Position: 3
Default value: Default
Accept pipeline input: True (ByPropertyName)
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
Accept pipeline input: False
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-EnableAnonymousAccess

Configures an NFS share to allow anonymous users to access it.

Type: Boolean
Aliases: anon, AnonymousAccess
Position: 7
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-EnableUnmappedAccess

Configures an NFS share to allow unmapped UNIX users to access a share by using the UID or GID.

Type: Boolean
Aliases: unmapped, UnmappedAccess
Position: 8
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-LanguageEncoding

Specifies language encoding to configure on an NFS share. You can use only one language on the share.

The acceptable values for this parameter are:

  • 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
Parameter Sets: euc-jp, euc-tw, euc-kr, shift-jis, big5, ksc5601, gb2312-80, ansi
Position: 6
Default value: Ansi
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-NetworkName

Specifies the network name of a share.

For a local 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.

This parameter is not required when you create a local share. In the case of a server cluster, specify the client access point. If you do not specify a network name, New-NfsShare assigns a network name that belongs to the same resource group by default.

Type: String
Aliases: netname
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Permission

Configures the type of global ("All Machines") permissions on the NFS share. The acceptable values for this parameter are:

  • Readwrite
  • Readonly
  • No-access
Type: String
Aliases: access
Parameter Sets: no-access, readonly, readwrite
Position: 10
Default value: No-access
Accept pipeline input: True (ByPropertyName)
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
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
Accept pipeline input: False
Accept wildcard characters: False

Outputs

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/NFS/MSFT_NfsShare