Revoke-NfsSharePermission
Revoke-NfsSharePermission
Revokes permission to access shares that an NFS server exports.
Syntax
Parameter Set: ByName
Revoke-NfsSharePermission [-Name] <String> [-ClientName] <String> [-ClientType] <String> [-AsJob] [-CimSession <CimSession[]> ] [-NetworkName <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByPath
Revoke-NfsSharePermission [-Path] <String> [-ClientName] <String> [-ClientType] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Revoke-NfsSharePermission cmdlet revokes permissions previously granted by a Network File System (NFS) server that has an NFS share configured. You can use the Get-NfsSharePermission cmdlet to get a list of the permissions configured on an NFS share.
Parameters
-AsJob
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? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ClientType<String>
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
Aliases |
none |
Required? |
true |
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 network name of an NFS share.
For a local share, the network name is the host name. For a cluster, the network name is the network name displayed 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 |
-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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Nothing
Examples
Example 1: Revoke NFS share permissions for a specified host
This command revokes permissions for a host computer named contoso-fs on an NFS share called Export. The command identifies the client as a host client type.
PS C:\> Revoke-NfsSharePermission -Name "Export" -ClientName "contoso-fs" -ClientType "host"
Example 2: Revoke NFS share permissions for a specified group
This command revokes permissions for a netgroup named contoso-netgroup on an NFS share called Export. The command identifies the client as a netgroup type.
PS C:\> Revoke-NfsSharePermission -Name "Export" -ClientName "contoso-netgroup" -ClientType "netgroup"