Citrix Virtual Apps and Desktops SDK

Remove-AdminAdministrator

Removes administrators from the site.

Syntax

Remove-AdminAdministrator
      [-InputObject] <Administrator[]>
      [-LoggingId <Guid>]
      [-SkipCertificateValidation]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-AdminAdministrator
      -Sid <String[]>
      [-LoggingId <Guid>]
      [-SkipCertificateValidation]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-AdminAdministrator
      [-Name] <String[]>
      [-LoggingId <Guid>]
      [-SkipCertificateValidation]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

The Remove-AdminAdministrator cmdlet deletes administrators from the site. This cmdlet cannot be used in case of DaaS customers.

Examples

EXAMPLE 1

Remove the administrator called “DOMAIN\TestUser”.

Remove-AdminAdministrator DOMAIN\TestUser
<!--NeedCopy-->

EXAMPLE 2

Remove all disabled administrators.

Get-AdminAdministrator -Enabled $false | Remove-AdminAdministrator
<!--NeedCopy-->

Parameters

-Sid

Specifies the SID of the administrator to delete.

Type: String[]
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-InputObject

Specifies the administrators to delete.

Type: Administrator[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies the name of the administrator to delete.

Type: String[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: 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.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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

Citrix.DelegatedAdmin.Sdk.Administrator

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

Outputs

None

By default, this cmdlet returns no output.

Remove-AdminAdministrator