Unlock-AcctIdentityPool
Unlocks identity pools.
Syntax
Unlock-AcctIdentityPool
[-IdentityPoolName] <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Unlock-AcctIdentityPool
-IdentityPoolUid <Guid>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to unlock the specified identity pool. Identity pools are locked automatically when being updated (e.g. when new accounts are being created). The pool must never be left in a locked state; this command allows recovery from an error should one ever occur. Use this command with caution, as unlocking an identity pool which is supposed to be locked may result in unexpected behavior.
Examples
EXAMPLE 1
Unlocks the identity pool called "MyPool", setting the Lock field to false.
Unlock-AcctIdentityPool -IdentityPool MyPool
EXAMPLE 2
Unlocks all the locked identity pools.
Get-AcctIdentityPool -Filter {Lock -eq $true} | Unlock-AcctIdentityPool
Parameters
-IdentityPoolName
The name of the identity pool to be unlocked.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-IdentityPoolUid
The unique identifier for the identity pool to be unlocked.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| 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.IdentityPool
You can pipe an object containing a parameter called 'IdentityPoolName' to unlock-AcctIdentityPool.
Outputs
None
By default, this cmdlet returns no output.
Notes
In the case of failure, the following errors can result.
Error Codes
IdentityPoolObjectNotFound
The specified identity pool could not be located.
IdentityPoolAlreadyUnlocked
The specified identity pool 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.