Product Documentation

Remove-AdminPermission

Oct 01, 2013

Remove permissions from the set of permissions of a role.

Syntax

Remove-AdminPermission [-InputObject] <Permission[]> -Role <String> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AdminPermission [-Permission] <String[]> -Role <String> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AdminPermission -All -Role <String> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Remove permissions from the set of permissions that a role maps to.

Any administrator with a right including that role immediately loses the ability to use the operations of the removed permissions.

Duplicate permissions do not produce an error, and permissions that the roles does not already have are skipped (without error).

You cannot modify the permissions of built-in roles.

Parameters

-InputObject<Permission[]>

Specifies the permissions to remove.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-Permission<String[]>

Specifies the list of permissions to remove (by identifier).

Required? true
Default Value  
Accept Pipeline Input? true (ByPropertyName)

-Role<String>

Role name or identifier of the role to update.

Required? true
Default Value  
Accept Pipeline Input? false

-All<SwitchParameter>

Remove all permissions.

Required? true
Default Value  
Accept Pipeline Input? false

-LoggingId<Guid>

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller the PowerShell snap-in connects to. You can provide this as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

Input Type

Citrix.DelegatedAdmin.Sdk.Permission You can pipe a list of permissions to be removed into this command.

Return Values

None

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Remove-AdminPermission -Role MyRole -Permission Global_Read,Logging_Read

Remove a couple of specific permissions from the 'MyRole' role.

-------------------------- EXAMPLE 2 --------------------------

C:\PS> Remove-AdminPermission -Role MyRole -All

Remove all permissions from the 'MyRole' role.