Citrix Virtual Apps and Desktops SDK

Unlock-AcctADAccount

March 11, 2024

Contributed by:

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

Syntax

Unlock-AcctADAccount
      -ADAccountName <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Unlock-AcctADAccount
      -ADAccountSid <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

Unlocks the AD account called “Domain\account”.

Unlock-AcctADAccount -ADAccountName Domain\account
<!--NeedCopy-->

EXAMPLE 2

Unlocks all the locked AD accounts.

Get-AcctADAccount -Filter {Lock -eq $true} | Unlock-AcctADAccount
<!--NeedCopy-->

Parameters

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ADAccountSid

The SID of the AD account to be unlocked.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
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

Citrix.ADIdentity.Sdk.IdentityInPool

You can pipe an object containing a parameter called ‘ADAccountSID’ to unlock-AcctADAccount.

Outputs

None

By default, this cmdlet returns no output.

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

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

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Unlock-AcctADAccount

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-ADAccountName

-ADAccountSid

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.ADIdentity.Sdk.IdentityInPool

Outputs

None

Notes

Related Links

In this article