Add-AdminPermission
Add permissions to the set of permissions of a role.
Syntax
Add-AdminPermission
-Role <String>
[-Permission] <String[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Add-AdminPermission
-Role <String>
[-InputObject] <Permission[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
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.
You are not permitted to add permissions that you yourself don't have rights to.
Examples
EXAMPLE 1
Add a couple of specific permissions to the 'MyRole' role.
Add-AdminPermission -Role MyRole -Permission Global_Read,Logging_Read
EXAMPLE 2
Add all of the permissions of the Delivery Administrator role to MyRole.
$list = Get-AdminRole "Delivery Administrator" | Select -Expand Permissions
Add-AdminPermission -Role MyRole -Permission $list
Parameters
-Role
Role name or identifier of the role to update.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the permissions to add.
| Type: | Permission[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Permission
Specifies the list of permissions to add (by identifier).
| Type: | String[] |
| Aliases: | Id |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-LoggingId
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.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
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.
Inputs
Citrix.DelegatedAdmin.Sdk.Permission
You can pipe a list of permissions to be added into this command.
Outputs
None
By default, this cmdlet returns no output.