Product Documentation

Add-AdminPermission

Apr 15, 2014

Add permissions to the set of permissions of a role.

Syntax

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

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

Detailed Description

Add extra permissions to the set of permissions that a role maps to.

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

Duplicate permissions do not produce an error, and permissions are skipped if the role already contains the permission (without error).

You cannot modify the permissions of built-in roles.

Parameters

-InputObject<Permission[]>

Specifies the permissions to add.

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

-Permission<String[]>

Specifies the list of permissions to add (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

-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 added into this command.

Return Values

None

Examples

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

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

Add a couple of specific permissions to the 'MyRole' role.

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

C:\PS> $list = Get-AdminRole "Delivery Administrator" | Select -Expand Permissions 
C:\PS> Add-AdminPermission -Role MyRole -Permission $list

Add all of the permissions of the Delivery Administrator role to MyRole.