Repair-AcctIdentity
Introduced in: Citrix Virtual Apps and Desktop 7 2311
Repair the given identity accounts in identity pool.
Syntax
Repair-AcctIdentity
-Target <String>
[-PrivilegedUserName <String>]
[-PrivilegedUserPassword <SecureString>]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Repair-AcctIdentity
-IdentityAccountId <String[]>
-Target <String>
[-PrivilegedUserName <String>]
[-PrivilegedUserPassword <SecureString>]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Repair-AcctIdentity
-IdentityAccountName <String[]>
-Target <String>
[-PrivilegedUserName <String>]
[-PrivilegedUserPassword <SecureString>]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This provides the ability to repair accounts in the identity pool that behave abnormal without changing the current states of the accounts. Unlike "Repair-AcctADAccount", this command will not reset 'Tainted' accounts and make them to be 'Available' in the identity pool.
Examples
EXAMPLE 1
Repairs userCertificate attributes for the Hybrid Azure AD joined identity accounts in the identity pool "MyIdentityPool".
Get-AcctADAccount -IdentityPoolName "MyIdentityPool" | Repair-AcctIdentity -Target UserCertificate
SuccessfulAccountsCount FailedAccountsCount FailedAccounts
----------------------- ------------------- --------------
2 0 {}
Parameters
-IdentityAccountName
The names of the identity accounts that are to be repaired. 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 repaired. 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, ByValue) |
| Accept wildcard characters: | False |
-Target
The target to be repaired. It can be either 'IdentityInfo' or 'UserCertificate'. Specifies 'IdentityInfo 'to repair account password and trust key pair. Specifies 'UserCertificate' to repair userCertificate for Hybrid Azure AD joined identities.
| Type: | String |
| Accepted values: | UserCertificate, IdentityInfo |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivilegedUserName
The username for an user account in the identity provider (e.g., AD or Azure AD) with Write Permissions. This parameter must be used if the current user does not have the necessary privileges to modify accounts in identity provider.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivilegedUserPassword
The matching password for an user account in the identity provider (e.g., AD or Azure AD) with Write Permissions. This parameter must be used if the current user does not have the necessary privileges to modify accounts in identity provider.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseServiceAccount
Use the service account of IdentityPool which the identity belongs to to repair AD identity account.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2407 |
-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
None
You can't pipe objects to this cmdlet.
Outputs
Citrix.ADIdentity.Sdk.AccountOperationSummary
The Repair-AcctIdentity command returns an object with the following parameters: SuccessfulAccountsCount \<int\>
The number of accounts that were repaired successfully.
FailedAccountsCount \<int\>
The number of accounts that were not repaired.
FailedAccounts \<Citrix.ADIdentity.Sdk.AccountError\[\]\>
The list of accounts that failed to be repaired. Each one has the following parameters:
ADAccountName \<string\>
ADAccountSid \<String\>
ErrorReason \<ADIdentityStatus\>
This can be one of the following
UnableToConvertDomain
IdentityNotLocatedInDomain
IdentityNotFound
IdentityObjectInUse
IdentityObjectLocked
ADServiceDatabaseError
ADServiceDatabaseNotConfigured
ADServiceStatusInvalidDb
FailedToConnectToDomainController
FailedToExecuteSearchInAD
FailedToAccessComputerAccountInAD
FailedToSetPasswordInAD
FailedToChangePasswordInAD
DiagnosticInformtion \<Exception\>
Any other error information
Notes
In the case of failure, the following errors can result.
Error Codes
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 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.