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-AcctADAccount

August 3, 2023
Contributed by: 
C

Removes Active Directory (AD) computer accounts from an identity pool.

Syntax


Remove-AcctADAccount [-IdentityPoolName] <String> -ADAccountName <String[]> [-ADUserName <String>] [-ADPassword <SecureString>] [-RemovalOption <ADIdentityRemoveAccountOption>] [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AcctADAccount [-IdentityPoolName] <String> -ADAccountSid <String[]> [-ADUserName <String>] [-ADPassword <SecureString>] [-RemovalOption <ADIdentityRemoveAccountOption>] [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AcctADAccount -IdentityPoolUid <Guid> -ADAccountName <String[]> [-ADUserName <String>] [-ADPassword <SecureString>] [-RemovalOption <ADIdentityRemoveAccountOption>] [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AcctADAccount -IdentityPoolUid <Guid> -ADAccountSid <String[]> [-ADUserName <String>] [-ADPassword <SecureString>] [-RemovalOption <ADIdentityRemoveAccountOption>] [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to remove Active Directory (AD) accounts from an identity pool. This only removes the AD account from the identity pool within the AD Identity Service. Options for removing (or disabling) the account in AD are available if necessary.

All aspects of this command that need to make modifications to the accounts in AD will use the account that the runspace is using. This means that if an account is to be removed from AD or disabled, the user performing the operation in PowerShell must have sufficient privileges in AD for this operation to complete successfully. If the current user does not have sufficient privileges, the ADUserName and ADPassword parameters may be used instead.

If the option to remove the account from AD or to disable it in AD is specified, the AD operation must succeed for the account to be removed from the Citrix AD Identity Service database. Use caution when using the Force parameter because this allows removal of accounts that are in the ‘inUse’ state, which may result in the machines becoming unusable.

Parameters

Name Description Required? Pipeline Input Default Value
IdentityPoolName The name of the identity pool from which accounts are to be removed. true false  
ADAccountName The name of the AD account to be removed. AD accounts are accepted in the following formats: Fully qualified DN e.g. CN=MyComputer,OU=Computers,DC=MyDomain,DC=Com; UPN format e.g MyComputer@MyDomain.Com; Domain qualified e.g MyDomain\MyComputer. true false  
ADAccountSid The SID for the AD account to be removed. true true (ByPropertyName)  
IdentityPoolUid The unique identifier for the identity pool from which accounts are to be removed. true true (ByPropertyName)  
ADUserName The username for an AD user account with Write Permissions. This parameter must be used if the current user does not have the necessary privileges. false false  
ADPassword The matching password for an AD user account with Write Permissions. This parameter must be used if the current user does not have the necessary privileges. false false  
RemovalOption Defines the behavior relating to the AD account.      
None - Do not attempt to remove the account from AD Delete - Attempt to remove the account from AD Disable - Attempt to disable the account in AD false false None  
Force Indicates if accounts that are marked as ‘in-use’ can be removed. 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  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a Citrix Virtual Apps and Desktops controller that the PowerShell snap-in connects 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

Return Values

Citrix.Adidentity.Sdk.Accountoperationsummary

The remove-AcctADAccout command returns an object with the following parameters;

  • SuccessfulAccountsCount <int> The number of accounts that were removed successfully.

  • FailedAccountsCount <int> The number of accounts that were not removed.

  • FailedAccounts <Citrix.ADIdentity.Sdk.AccountError[]> The list of accounts that failed to be removed. Each one has the following parameters:

  • ADAccountName <string>

  • ADAccountSid <String>

  • ErrorReason <ADIdentityStatus> This can be one of the following UnableToConvertDomain IdentityNotLocatedInDomain IdentityNotInIdentityPool IdentityObjectInUse IdentityObjectLocked ADServiceDatabaseError ADServiceDatabaseNotConfigured ADServiceStatusInvalidDb FailedToConnectToDomainController FailedToDisableAccountInAD FailedToDeleteAccountInAD FailedToExecuteSearchInAD FailedToAccessComputerAccountInAD

  • DiagnosticInformtion <Exception> Any other error information

Notes

In the case of failure, the following errors can result.

  • IdentityPoolNotFound: The specified identity pool was not found.

  • IdentityPoolAlreadyLocked: The specified identity pool was locked by another operation.

  • PermissionDenied: The user does not have administrative rights to perform this operation.

  • ConfigurationLoggingError: The operation could not be performed because of a configuration logging error

  • DatabaseError: An error occurred in the service while attempting a database operation.

  • DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.

  • ServiceStatusInvalidDb: An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.

  • CommunicationError: An error occurred while communicating with the service.

  • ExceptionThrown: An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the Citrix Virtual Apps and Desktops logs.

Examples

Example 1 


C:\PS>Remove-AcctADAccount -IdentityPoolName MyPool -ADAccountName "Domain\account","domain\account2"

    SuccessfulAccountsCount       FailedAccountsCount    FailedAccounts

    -----------------------       -------------------    --------------

                          2                         0    {}

<!--NeedCopy-->

Description

Removes two accounts (account and account2) from the identity pool called “MyPool”, leaving the AD accounts untouched.

Example 2 


C:\PS>Remove-AcctADAccount -IdentityPoolName MyPool -RemovalOption Delete -ADAccountName "Domain\account","domain\account2"

    SuccessfulAccountsCount       FailedAccountsCount    FailedAccounts

    -----------------------       -------------------    --------------

                          2                         0    {}

<!--NeedCopy-->

Description

Removes two accounts (account and account2) from the identity pool called “MyPool” (and from AD).

Example 3 


C:\PS>Remove-AcctADAccount -IdentityPoolName MyPool -ADAccountName "Domain\account","domain\account2" -Force

    SuccessfulAccountsCount       FailedAccountsCount    FailedAccounts

    -----------------------       -------------------    --------------

                          2                         0    {}

<!--NeedCopy-->

Description

Removes two accounts (account and account2) from the identity pool called “MyPool”, leaving the AD accounts untouched. The accounts are removed regardless of whether they are in the ‘inUse’ state or not.

Example 4 


C:\PS>Remove-AcctADAccount -IdentityPoolName MyPool -ADAccountName "Domain\account","domain\account2" -OutVariable result

    SuccessfulAccountsCount       FailedAccountsCount    FailedAccounts

    -----------------------       -------------------    --------------

    1                                               1    {account2}

    C:\PS>$result[0].FailedAccounts

    ADAccountName                 ADAccountSid           ErrorReason

    -------------                 -------------          ------------

    Domain\account2               account2               IdentityObjectLocked

<!--NeedCopy-->

Description

Shows failure of removal of one of two accounts and how to retrieve the failure reason.

Example 5 


C:\PS>Remove-AcctADAccount -IdentityPoolName MyPool -ADAccountSid S-1-5-21-1315084875-1285793635-2418178940-2685

    SuccessfulAccountsCount       FailedAccountsCount    FailedAccounts

    -----------------------       -------------------    --------------

    1                                               0    {}

<!--NeedCopy-->

Description

Removes one account (S-1-5-21-1315084875-1285793635-2418178940-2685) from the identity pool called “MyPool”, leaving the AD accounts untouched.

Remove-AcctADAccount
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.