Removes a role from the site.
Remove-AdminRole [-InputObject] <Role> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>] Remove-AdminRole [-Id] <Guid> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>] Remove-AdminRole [-Name] <String> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
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.
|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|
|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.|
You can pipe the roles to be deleted into this command.
C:\PS> Remove-AdminRole -Name Supervisor
Remove the Supervisor role.
C:\PS> Get-AdminRole -BuiltIn $false | Remove-AdminRole
Attempt to remove all custom roles. This fails if one of the roles is assigned to an administrator.