Set-AcctADAccountUserCert
Set userCertificate for the given Active Directory (AD) accounts.
Syntax
Set-AcctADAccountUserCert
[-IdentityPoolName] <String>
-ADAccountName <String[]>
[-ADUserName <String>]
[-ADPassword <SecureString>]
[-Force]
[-BatchSize <Int32>]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-AcctADAccountUserCert
[-IdentityPoolName] <String>
-ADAccountSid <String[]>
[-ADUserName <String>]
[-ADPassword <SecureString>]
[-Force]
[-BatchSize <Int32>]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-AcctADAccountUserCert
[-IdentityPoolName] <String>
[-ADUserName <String>]
[-ADPassword <SecureString>]
[-AllAccounts]
[-Force]
[-BatchSize <Int32>]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-AcctADAccountUserCert
-IdentityPoolUid <Guid>
-ADAccountName <String[]>
[-ADUserName <String>]
[-ADPassword <SecureString>]
[-Force]
[-BatchSize <Int32>]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-AcctADAccountUserCert
-IdentityPoolUid <Guid>
-ADAccountSid <String[]>
[-ADUserName <String>]
[-ADPassword <SecureString>]
[-Force]
[-BatchSize <Int32>]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-AcctADAccountUserCert
-IdentityPoolUid <Guid>
[-ADUserName <String>]
[-ADPassword <SecureString>]
[-AllAccounts]
[-Force]
[-BatchSize <Int32>]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to set the userCertificate attribute for given accounts in Active Directory (AD).
The user performing the operation in PowerShell must have sufficient privileges in AD to set the userCertificate attribute. If the current user does not have sufficient privileges, the ADUserName and ADPassword parameters may be used instead.
Examples
EXAMPLE 1
Set userCertificate for two accounts (account and account2) in the identity pool called "MyPool".
Set-AcctADAccountUserCert -IdentityPoolName MyPool -ADAccountName "Domain\account","Domain\account2"
SuccessfulAccountsCount FailedAccountsCount FailedAccounts
----------------------- ------------------- --------------
2 0 {}
EXAMPLE 2
Set userCertificate for two accounts (account and account2) in the identity pool called "MyPool". The accounts are set regardless of whether they are in the 'inUse' state or not.
Set-AcctADAccountUserCert -IdentityPoolName MyPool -ADAccountName "Domain\account","Domain\account2" -Force
SuccessfulAccountsCount FailedAccountsCount FailedAccounts
----------------------- ------------------- --------------
2 0 {}
EXAMPLE 3
Shows failure of setting of one of two accounts and how to retrieve the failure reason.
Set-AcctADAccountUserCert -IdentityPoolName MyPool -ADAccountName "Domain\account","Domain\account2" -OutVariable result
SuccessfulAccountsCount FailedAccountsCount FailedAccounts
----------------------- ------------------- --------------
1 1 {account2}
C:\PS>$result[0].FailedAccounts
ADAccountName ADAccountSid ErrorReason
------------- ------------- ------------
Domain\account2 account2 IdentityObjectLocked
EXAMPLE 4
Set userCertificate for one account (S-1-5-21-1315084875-1285793635-2418178940-2685) in the identity pool called "MyPool".
Set-AcctADAccountUserCert -IdentityPoolName MyPool -ADAccountSid S-1-5-21-1315084875-1285793635-2418178940-2685
SuccessfulAccountsCount FailedAccountsCount FailedAccounts
----------------------- ------------------- --------------
1 0 {}
Parameters
-ADAccountName
The AD account name to be set with userCertificate.
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.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ADAccountSid
The SID for the AD account to be set with userCertificate.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-AllAccounts
Indicates if all accounts should be set with userCertificate.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityPoolUid
The unique identifier of the identity pool containing the accounts to have userCertificate set.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-IdentityPoolName
The name of the identity pool containing the accounts to have userCertificate set.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
-ADUserName
The username for an AD user account with Write Permissions. This parameter must be used if the current user does not have the necessary privileges.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ADPassword
The matching password for an AD user account with Write Permissions. This parameter must be used if the current user does not have the necessary privileges.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Indicates if accounts that are marked as 'in-use' can be set with userCertificate.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BatchSize
Specifies the number of accounts to set user certificate in one batch to AD Identity Service.
| Type: | Int32 |
| Position: | Named |
| Default value: | 50 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseServiceAccount
Use the IdentityPool's service account to set userCertificate of AD accounts.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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
None
You can't pipe objects to this cmdlet.
Outputs
Citrix.ADIdentity.Sdk.AccountOperationSummary
The Set-AcctADAccountUserCert command returns an object with the following parameters: SuccessfulAccountsCount \<int\>
The number of accounts that were successfully set with userCertificate.
FailedAccountsCount \<int\>
The number of accounts that were failed to set with userCertificate.
FailedAccounts \<Citrix.ADIdentity.Sdk.AccountError\[\]\>
The list of accounts that failed to be set with userCertificate. Each one has the following parameters:
ADAccountName \<string\>
ADAccountSid \<String\>
ErrorReason \<ADIdentityStatus\>
This can be one of the following:
IdentityObjectNotFound
IdentityObjectLocked
IdentityObjectInUse
IdentityPoolObjectNotFound
ADServiceDatabaseError
ADServiceDatabaseNotConfigured
ADServiceStatusInvalidDb
FailedToConnectToDomainController
FailedToGenerateDeviceKeyPair
FailedToAccessComputerAccountInAD
UnauthorizedToWriteUserCertificateInAD
DiagnosticInformation \<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.