Citrix Virtual Apps and Desktops SDK

Unlock-AcctADAccount

August 3, 2023

Contributed by:

Unlocks AD accounts within the AD Identity Service.

Syntax

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

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

Detailed Description

Provides the ability to unlock the AD Identity Service identity item that references a specified AD account. 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 where this operation has failed without unlocking the account.

Note: This command does NOT make any changes to the account information stored in Active Directory.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ADAccountName	The AD account name 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 AD account SID that represents the 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
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 XenDesktop 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. Error Codes

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 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 XenDesktop 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.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Unlock-AcctADAccount

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Unlock-AcctADAccount

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Adidentity.Sdk.Identityinpool

Return Values

Notes

Examples

Example 1

Description

Example 2

Description

In this article