Skip to content
Was this article helpful?

Update-AcctADAccount

Updates the state of Active Directory (AD) accounts.

Syntax

Update-AcctADAccount [-IdentityPoolName] <String> [-AllAccounts] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Update-AcctADAccount -IdentityPoolUid <Guid> [-AllAccounts] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Provides the ability to synchronize the state of the Active Directory (AD) accounts stored in the AD Identity Service with the AD accounts themselves. By default, this checks all accounts marked as 'error' to determine if accounts are still in an error state (i.e. disabled or locked). If you specify the 'AllAccounts' option, it checks all accounts regardless of error state and updates their status.

Parameters

Name Description Required? Pipeline Input Default Value
IdentityPoolName The name of the identity pool of the AD accounts that are to be updated. true true (ByPropertyName)
IdentityPoolUid The unique identifier for the identity pool of the AD accounts that are to be updated. true false
AllAccounts Indicates if all accounts should be updated or only the ones marked as in error. false 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
AdminClientIP Specifies the Client IP of 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

Notes

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

  • 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 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>Update-AcctADAccount -IdentityPoolName MyPool

Description

Checks the status of accounts in the identity pool MyPool that are currently in the Error state, marking them as Available, InUse, Tainted or Error as appropriate.

Example 2

c:\PS>Update-AcctADAccount -IdentityPoolName MyPool -AllAccounts

Description

Checks the status of all accounts in the identity pool MyPool marking them as Available, InUse, Tainted or Error as appropriate.

Was this article helpful?