Remove-AcctIdentity
Introduced in: Citrix Virtual Apps and Desktop 7 2411
Removes identity accounts from an identity pool.
Syntax
Remove-AcctIdentity
[-IdentityPoolName] <String>
-IdentityAccountName <String[]>
[-PrivilegedUserName <String>]
[-PrivilegedUserPassword <SecureString>]
[-RemovalOption <ADIdentityRemoveAccountOption>]
[-Force]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-AcctIdentity
[-IdentityPoolName] <String>
-IdentityAccountId <String[]>
[-PrivilegedUserName <String>]
[-PrivilegedUserPassword <SecureString>]
[-RemovalOption <ADIdentityRemoveAccountOption>]
[-Force]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-AcctIdentity
-IdentityPoolUid <Guid>
-IdentityAccountName <String[]>
[-PrivilegedUserName <String>]
[-PrivilegedUserPassword <SecureString>]
[-RemovalOption <ADIdentityRemoveAccountOption>]
[-Force]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-AcctIdentity
-IdentityPoolUid <Guid>
-IdentityAccountId <String[]>
[-PrivilegedUserName <String>]
[-PrivilegedUserPassword <SecureString>]
[-RemovalOption <ADIdentityRemoveAccountOption>]
[-Force]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to remove accounts from an identity pool. This only removes the identity account from the identity pool within the Citrix AD Identity Service. Options for removing (or disabling) the account are available if necessary.
All aspects of this command that need to make modifications to the Active Directory or Hybrid Azure AD based accounts will use the account that the runspace is using. This means that if an account is to be removed or disabled, the user performing the operation in PowerShell must have sufficient privileges for this operation to complete successfully. If the current user does not have sufficient privileges, the PrivilegedUserName and PrivilegedPassword parameters may be used instead.
If the option to remove the account from identity pool or to disable it 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 might result in the machines becoming unusable.
Examples
EXAMPLE 1
Removes two accounts (account and account2) from the identity pool called "MyPool", leaving the AD accounts untouched.
Remove-AcctIdentity -IdentityPoolName MyPool -IdentityAccountName "Domain\account","domain\account2"
SuccessfulAccountsCount FailedAccountsCount FailedAccounts
----------------------- ------------------- --------------
2 0 {}
EXAMPLE 2
Removes two accounts (account and account2) from the identity pool called "MyPool" (and from AD).
Remove-AcctIdentity -IdentityPoolName MyPool -RemovalOption Delete -IdentityAccountName "Domain\account","domain\account2"
SuccessfulAccountsCount FailedAccountsCount FailedAccounts
----------------------- ------------------- --------------
2 0 {}
EXAMPLE 3
Removes two accounts (account and account2) from the identity pool called "MyPool", leaving the identity accounts untouched. The accounts are removed regardless of whether they are in the 'inUse' state or not.
Remove-AcctIdentity -IdentityPoolName MyPool -IdentityAccountName "Domain\account","domain\account2" -Force
SuccessfulAccountsCount FailedAccountsCount FailedAccounts
----------------------- ------------------- --------------
2 0 {}
EXAMPLE 4
Shows failure of removal of one of the two accounts and how to retrieve the failure reason.
Remove-AcctIdentity -IdentityPoolName MyPool -IdentityAccountName "Domain\account","domain\account2" -OutVariable result
SuccessfulAccountsCount FailedAccountsCount FailedAccounts
----------------------- ------------------- --------------
1 1 {account2}
C:\PS>$result[0].FailedAccounts
IdentityAccountName IdentityAccountId ErrorReason
------------- ------------- ------------
Domain\account2 account2 IdentityObjectLocked
EXAMPLE 5
Removes one account (S-1-5-21-1315084875-1285793635-2418178940-2685) from the identity pool called "MyPool", leaving the identity accounts untouched.
Remove-AcctADAccount -IdentityPoolName MyPool -IdentityAccountSid S-1-5-21-1315084875-1285793635-2418178940-2685
SuccessfulAccountsCount FailedAccountsCount FailedAccounts
----------------------- ------------------- --------------
1 0 {}
Parameters
-IdentityAccountName
The name of the identity account to be removed. AD based identity 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.
| Type: | String[] |
| Aliases: | ADAccountName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityAccountId
The ID for the identity account to be removed. For AD, the ID is the SID or the ID is same as SID.
| Type: | String[] |
| Aliases: | ADAccountSid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-IdentityPoolUid
The unique identifier for the identity pool from which accounts are to be removed.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-IdentityPoolName
The name of the identity pool from which accounts are to be removed.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
-PrivilegedUserName
The username for an user account in the identity provider (e.g., AD or Azure AD) with Write Permissions. This parameter must be used if the current user does not have the necessary privileges to create accounts in identity provider.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivilegedUserPassword
The matching password for an user account in the identity provider (e.g., AD or Azure AD) with Write Permissions. This parameter must be used if the current user does not have the necessary privileges to create accounts in identity provider.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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
| Type: | ADIdentityRemoveAccountOption |
| Accepted values: | None, Delete, Disable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Indicates if accounts that are marked as 'in-use' can be removed.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseServiceAccount
Use the IdentityPool's service account to remove AD accounts.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
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
None
You can't pipe objects to this cmdlet.
Outputs
Citrix.ADIdentity.Sdk.AccountOperationSummaryV2
The Remove-AcctIdentity cmdlet 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:
IdentityAccountName \<string\>
IdentityAccountId \<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.
Error Codes
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.