Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Remove-Adminrole

August 3, 2023
Contributed by: 
C

Removes a role from the site.

Syntax

Remove-AdminRole [-InputObject] <Role[]> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AdminRole [-Id] <Guid[]> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AdminRole [-Name] <String[]> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The Remove-AdminRole cmdlet deletes roles from the site.

You cannot remove built-in roles.

An error will be produced if the role being removed is currently assigned to an administrator unless you specify the -Force option. When -Force is specified, any rights that reference the role are also removed.

Parameters

Name Description Required? Pipeline Input Default Value
InputObject Specifies the roles to remove (by role object). true true (ByValue)  
Id Specifies the roles to remove (by role id). true true (ByPropertyName)  
Name Specifies the roles to remove (by role name). true true (ByPropertyName)  
Force Allow removal of roles that are still in use. false 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. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Citrix.Delegatedadmin.Sdk.Role

You can pipe the roles to be deleted into this command.

Return Values

None

Examples

Example 1 

C:\PS> Remove-AdminRole -Name Supervisor
<!--NeedCopy-->

Description

Remove the Supervisor role.

Example 2 

C:\PS> Get-AdminRole -BuiltIn $false | Remove-AdminRole
<!--NeedCopy-->

Description

Attempt to remove all custom roles. This fails if one of the roles is assigned to an administrator.

Remove-Adminrole
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.