Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Repair-Acctadaccount

August 3, 2023
Contributed by: 
C

Resets the Active Directory machine password for the given accounts.

Syntax

Repair-AcctADAccount -ADAccountName <String[]> [-Password <String>] [-SecurePassword <SecureString>] [-ADUserName <String>] [-ADPassword <SecureString>] [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Repair-AcctADAccount -ADAccountSid <String[]> [-Password <String>] [-SecurePassword <SecureString>] [-ADUserName <String>] [-ADPassword <SecureString>] [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

This provides the ability to synchronize the account password stored in Active Directory with the password stored in the AD Identity Service. If successful, this results in the AD Identity Service account state being reset to ‘available’ so it can be consumed by other Machine Creation Services.

If the current account password is not suplied using the Password or SecurePassword Parameters, this requires the user who initiated the runspace to have the required permissions in Active Directory to reset the Active Directory Account password.

If the current account password is supplied then this command will use the password change operation which does not require any elevated permissions in Active Directory.

Parameters

Name Description Required? Pipeline Input Default Value
ADAccountName The Active Directory account name(s) that are to be repaired. Active Directory 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. true false  
ADAccountSid The Active Directory account SID(s) that are to be repaired. true true (ByPropertyName)  
Password The current password for the computer account. false false  
SecurePassword The current password for the account (provided in a Secure String class). false false  
ADUserName The username for an Active Directoy user account with Write Permissions. This parameter is only used in Cloud deployments. false false  
ADPassword The matching password for an Active Directoy user account with Write Permissions. This parameter is only used in Cloud deployments. false false  
Force Indicates whether accounts that are marked as ‘in-use’ can be repaired or not. false 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. false false  
BearerToken Specifies the bearer token assigned to the calling user 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

Return Values

Citrix.Adidentity.Sdk.Accountoperationsummary
The Repair-Acctadaccout 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
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>Repair-AcctADAccount -ADAccountName "Domain\account","domain\account2"

          SuccessfulAccountsCount       FailedAccountsCount    FailedAccounts

          -----------------------       -------------------    --------------

                                2                         0    {}
<!--NeedCopy-->

Description

Repair-Acctadaccount
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.