Removes administrators from the site.
Syntax
Remove-AdminAdministrator [-InputObject] <Administrator[]> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]
Remove-AdminAdministrator -Sid <String[]> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]
Remove-AdminAdministrator [-Name] <String[]> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description
The Remove-AdminAdministrator cmdlet deletes administrators from the site.
Parameters
-InputObject<Administrator[]>
Specifies the administrators to delete.
Required? |
true |
Default Value |
|
Accept Pipeline Input? |
true (ByValue) |
-Name<String[]>
Specifies the name of the administrator to delete.
Required? |
true |
Default Value |
|
Accept Pipeline Input? |
true (ByPropertyName) |
-Sid<String[]>
Specifies the SID of the administrator to delete.
Required? |
true |
Default Value |
|
Accept Pipeline Input? |
true (ByPropertyName) |
-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.Administrator
You can pipe the adminstrators to be deleted into this command.
Examples
-------------------------- EXAMPLE 1 --------------------------
C:\PS> Remove-AdminAdministrator DOMAIN\TestUser
Remove the administrator called "DOMAIN\TestUser".
-------------------------- EXAMPLE 2 --------------------------
C:\PS> Get-AdminAdministrator -Enabled $false | Remove-AdminAdministrator
Remove all disabled administrators.