Unlock-AcctIdentity
Introduced in: Citrix Virtual Apps and Desktop 7 2411
Unlocks the given identity accounts.
Syntax
Unlock-AcctIdentity
-IdentityAccountId <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Unlock-AcctIdentity
-IdentityAccountName <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to unlock given identity accounts. An identity account is marked as locked 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 identity service. This command does NOT make any changes to the account information stored in Active Directory or Azure AD, only modifies the account state stored in the Citrix AD Identity Service database.
Examples
EXAMPLE 1
Unlocks the identity account called "Domain\account".
Unlock-AcctIdentity -IdentityAccountName Domain\account
EXAMPLE 2
Unlocks all the locked identity accounts.
Get-AcctIdentity -Filter {Lock -eq $true} | Unlock-AcctIdentity
Parameters
-IdentityAccountName
The names of the identity accounts that are to be unlocked. 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(s) of the identity accounts that are to be unlocked. For AD based identity account, it should be SID
| Type: | String |
| Aliases: | ADAccountSid |
| 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.