- about_AdminDelegatedAdminSnapin
- about_Admin_Filtering
- Add-AdminPermission
- Add-AdminRight
- Get-AdminAdministrator
- Get-AdminDBConnection
- Get-AdminDBSchema
- Get-AdminDBVersionChangeScript
- Get-AdminEffectiveAdministrator
- Get-AdminEffectiveRight
- Get-AdminInstalledDBVersion
- Get-AdminPermission
- Get-AdminPermissionGroup
- Get-AdminRevision
- Get-AdminRole
- Get-AdminRoleConfiguration
- Get-AdminScope
- Get-AdminService
- Get-AdminServiceAddedCapability
- Get-AdminServiceInstance
- Get-AdminServiceStatus
- Import-AdminRoleConfiguration
- New-AdminAdministrator
- New-AdminRole
- New-AdminScope
- Remove-AdminAdministrator
- Remove-AdminAdministratorMetadata
- Remove-AdminPermission
- Remove-AdminRight
- Remove-AdminRole
- Remove-AdminRoleMetadata
- Remove-AdminScope
- Remove-AdminScopeMetadata
- Remove-AdminServiceMetadata
- Rename-AdminRole
- Rename-AdminScope
- Reset-AdminServiceGroupMembership
- Set-AdminAdministrator
- Set-AdminAdministratorMetadata
- Set-AdminDBConnection
- Set-AdminRole
- Set-AdminRoleMetadata
- Set-AdminScope
- Set-AdminScopeMetadata
- Set-AdminServiceMetadata
- Test-AdminAccess
- Test-AdminDBConnection
Remove-AdminAdministrator
Nov 06, 2015
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.
Return Values
None
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.