Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Unlock-AcctADAccount

March 11, 2024
Contributed by: 
C

Unlocks Active Directory (AD) accounts within the AD Identity Service.

Syntax


Unlock-AcctADAccount -ADAccountName <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Unlock-AcctADAccount -ADAccountSid <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to unlock Active Directory (AD) accounts within the AD Identity Service. An AD account is marked as locked in the AD Identity Service while the Machine Creation Services (MCS) are processing tasks relating to the account. If these tasks are forcibly stopped, an account can remain locked despite no longer being processed. This command resolves this issue, but use it with caution because unlocking an account that MCS expects to be locked can result in an MCS operation being cancelled. Use this command only when MCS has locked an account for use in a provisioning operation and the operation has failed without unlocking the account.

Note: The lock state in Active Directory is unrelated to the lock state in the AD Identity service. This command does NOT make any changes to the account information stored in Active Directory, only the AD Identity Service database.

Parameters

Name Description Required? Pipeline Input Default Value
ADAccountName The name of the AD account to be unlocked. AD account name is 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 of the AD account to be unlocked. true true (ByPropertyName)  
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

Citrix.Adidentity.Sdk.Identityinpool 

You Can Pipe An Object Containing A Parameter Called 'Adaccountsid' To Unlock-Acctadaccount.

Return Values

Notes

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

  • IdentityNotLocatedInDomain: The specified AD account could not be located in Active Directory.

  • IdentityObjectNotFound: The identity could not be found.

  • IdentityAlreadyUnlocked: The identity is not locked.

  • 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>Unlock-AcctADAccount -ADAccountName Domain\account

<!--NeedCopy-->

Description

Unlocks the AD account called “Domain\account”.

Example 2 


c:\PS>Get-AcctADAccount -Filter {Lock -eq $true} | Unlock-AcctADAccount

<!--NeedCopy-->

Description

Unlocks all the locked AD accounts.

Unlock-AcctADAccount
March 11, 2024
Contributed by: 
C
March 11, 2024
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.