Skip to content

Latest commit

 

History

History
309 lines (241 loc) · 7.43 KB

Grant-NfsSharePermission.md

File metadata and controls

309 lines (241 loc) · 7.43 KB
Raw
external help file Module Name ms.date online version schema title
MSFT_NfsServerTasks.cmdletDefinition.cdxml-help.xml
NFS
10/29/2017
2.0.0
Grant-NfsSharePermission

Grant-NfsSharePermission

SYNOPSIS

Grants permission to access shares that an NFS server exports.

SYNTAX

ByName (Default)

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

ByPath

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

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

EXAMPLES

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

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

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

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

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

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

PARAMETERS

-AllowRootAccess

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

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AsJob

ps_cimcommon_asjob

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClientName

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.

Type: String
Parameter Sets: (All)
Aliases: Client

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ClientType

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
Type: String
Parameter Sets: (All)
Aliases: Type
Accepted values: host, netgroup, clientgroup, builtin

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-LanguageEncoding

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
Type: String
Parameter Sets: (All)
Aliases: Lang, Encoding
Accepted values: euc-jp, euc-tw, euc-kr, shift-jis, big5, ksc5601, gb2312-80, ansi

Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

Specifies the name of an NFS share.

Type: String
Parameter Sets: ByName
Aliases: ShareName

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NetworkName

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.

Type: String
Parameter Sets: ByName
Aliases: netname

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Path

Specifies the path of an NFS share.

Type: String
Parameter Sets: ByPath
Aliases: SharePath

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Permission

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

  • no-access
  • readonly
  • readwrite
Type: String
Parameter Sets: (All)
Aliases: Access
Accepted values: no-access, readonly, readwrite

Required: False
Position: 3
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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

Nothing

NOTES

RELATED LINKS

Get-NfsSharePermission

Revoke-NfsSharePermission