Revoke-NfsSharePermission

Module:

NFS Module

Revokes permission to access shares that an NFS server exports.

Syntax

ByName (Default)

Syntax

Revoke-NfsSharePermission
    [-ClientName] <String>
    [-ClientType] <String>
    [-Name] <String>
    [-NetworkName <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByPath

Syntax

Revoke-NfsSharePermission
    [-Path] <String>
    [-ClientName] <String>
    [-ClientType] <String>
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

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.

Examples

Example 1: Revoke NFS share permissions for a specified host

PS C:\> Revoke-NfsSharePermission -Name "Export" -ClientName "contoso-fs" -ClientType "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.

Example 2: Revoke NFS share permissions for a specified group

PS C:\> Revoke-NfsSharePermission -Name "Export" -ClientName "contoso-netgroup" -ClientType "netgroup"

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.

Parameters

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	CimSession[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Session

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Client

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ClientType

Specifies a client type. Use the builtin client type only when the ClientName parameter value is All Machines. The acceptable values for this parameter are:

• host
• clientgroup
• netgroup
• builtin

Parameter properties

Type:	String
Default value:	None
Accepted values:	host, netgroup, clientgroup, builtin
Supports wildcards:	False
DontShow:	False
Aliases:	Type

Parameter sets

(All)

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Specifies the name of an NFS share.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ShareName

Parameter sets

ByName

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-NetworkName

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.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	netname

Parameter sets

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Path

Specifies the path of an NFS share.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	SharePath

Parameter sets

ByPath

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	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.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Nothing

Related Links

• Get-NfsSharePermission
• Grant-NfsSharePermission