Citrix Virtual Apps and Desktops SDK

New-AdminRole

Adds a new custom role to the site.

Syntax

New-AdminRole
   [-CanLaunchManage <Boolean>]
   [-CanLaunchMonitor <Boolean>]
   [-Description <String>]
   [-Name] <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

New-AdminRole adds a new custom role object to the site. Once a new role has been created, you can add permissions to the role which define what operations the role conveys.

Roles represent a job function, such as ‘help desk administrator’, and contain a list of permissions that are required to perform that job function.

To assign a role to an administrator, you combine it with a scope which indicates what objects the role can operate on. This pair (also known as a ‘right’) can then be assigned to an administrator. See Add-AdminRight for further details.

The identifier of the new role is chosen automatically, and custom roles created with this cmdlet always have their BuiltIn flag set to false.

You cannot modify built-in roles.

The following license editions are supported for custom roles:

  • Citrix DaaS supports custom roles in all editions.
  • Citrix Virtual Apps and Desktops supports custom roles in Premium and Advanced editions.
  • Citrix Virtual Apps supports custom roles in Premium and Advanced editions.

Examples

EXAMPLE 1

Creates a new role called ‘Supervisor’, and then copies the permissions from the help desk role and adds some extras. Then gives this role (with the all scope) to user ‘TestUser’.

New-AdminRole -Name Supervisor -Description "My custom supervisor role"
$list = Get-AdminRole 'Help Desk Administrator' | Select -Expand Permissions
Add-AdminPermission -Role Supervisor -Permission $list
Add-AdminPermission -Role Supervisor -Permission $extras
Add-AdminRight -Administrator DOMAIN\TestUser -Role Supervisor -All
<!--NeedCopy-->

Parameters

-Name

Specifies the name of the role. Each role in a site must have a unique name.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 1 to 64
Disallowed characters: \/;:#.*?=<>\|[]()"'

-CanLaunchManage

Optionally Specifies whether the role has access to the Manage tab in Citrix Cloud.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2109

-CanLaunchMonitor

Optionally Specifies whether the role has access to the Monitor tab in Citrix Cloud.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2109

-Description

Specifies the description of the role.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 0 to 256

-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

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

None

You cannot pipe input into this cmdlet.

Outputs

Citrix.DelegatedAdmin.Sdk.Role

The newly created role.

Notes

Roles are created without any permissions. Use the Add-AdminPermission to add permissions.

New-AdminRole