Set-Nfs Share

Module:
nfs
Changes configuration settings of an NFS share.

Syntax 

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

Description

The Set-NfsShare cmdlet changes configuration settings for an existing share that Server for Network File System (NFS) exports. You can use the NetworkName parameter to select a share in a server cluster. NetworkName is not required when you modify configuration settings of non-clustered (standard) shares.

Examples

Example 1: Enable unmapped user access on an NFS share 

PS C:\> Set-NfsShare -Name "NFSshare01" -EnableUnmappedAccess $True

This command enables unmapped users to access the NFS share NFSshare01.

Example 2: Set the authentication protocol of an NFS share 

PS C:\> Set-NfsShare -Name "NFSshare01" -Authentication "sys,krb5" -AnonymousUid 100 -AnonymousGid 200

This command sets the authentication protocol as AUTH_SYS and Kerberos v5 on the NFS share NFSshare01. The command also sets the anonymous UID to 100 and the anonymous GID to 200.

Required Parameters

-Name

Specifies the name of an NFS share to modify.

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

Specifies the path of an NFS share.

Type: String
Aliases: SharePath
Position: 0
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: 7
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: 4
Default value: None
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: 5
Default value: None
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, Krb5, Krb5i, and Krb5p on the share. If you specify Default, Server for NFS configures Sys, Krb5, and Krb5i on the share.

Type: String[]
Aliases: af, auth
Parameter Sets: sys, krb5, krb5i, krb5p, all, default
Position: 1
Default value: None
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 the NFS share to allow anonymous users to access it.

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

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

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

Specifies the 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: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-NetworkName

Specifies the network name of the share. You cannot change the network name of an existing 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.

Type: String
Aliases: netname
Position: Named
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, no-access, readonly, readwrite
Position: 8
Default value: None
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