-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
Add-AcctADAccount
-
-
-
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Add-AcctADAccount
Import existing Active Directory (AD) computer accounts for use in the AD Identity Service.
Syntax
Add-AcctADAccount
[-IdentityPoolName] <String>
-ADAccountName <String[]>
[-Password <String>]
[-SecurePassword <SecureString>]
[-ADUserName <String>]
[-ADPassword <SecureString>]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Add-AcctADAccount
-IdentityPoolUid <Guid>
-ADAccountName <String[]>
[-Password <String>]
[-SecurePassword <SecureString>]
[-ADUserName <String>]
[-ADPassword <SecureString>]
[-UseServiceAccount]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Provides the ability to add existing Active Directory (AD) computer accounts to an already existing identity pool to be used by the Citrix AD Identity Service and other Citrix Machine Creation Services.
The user performing the operation in PowerShell must have sufficient permissions in AD to reset computer account passwords. If the current user does not have permissions, the ADUserName and ADPassword parameters can be used to provide credentials for a user with permissions.
Imported accounts in a disabled or locked state in AD are imported with the account marked in an error state.
If the identity pool into which accounts are being imported does not have a domain set, the domain of the identity pool will be set to the domain of the first account imported.
Examples
EXAMPLE 1
Import the two accounts (account and account2) from AD into the identity Pool called “MyPool”
Add-AcctADAccount -IdentityPoolName MyPool -ADAccountName "Domain\account","Domain\account2" -OutVariable result
SuccessfulAccounts SuccessfulAccountsCount FailedAccountsCount FailedAccounts
------------------ ----------------------- ------------------- --------------
{domain\account, domain\account2} 2 0 {}
$result.SuccessfulAccounts
ADAccountGuid : 473f5534-48ac-4baf-831f-376c5b813b60
ADAccountName : domain\account
ADAccountSid : S-1-5-21-1315084875-1285793635-2418178940-2644
AccountDisabled : False
AccountLocked : False
Domain : Domain.com
DomainControllerHint :
Lock : False
State : Available
TenantId :
DeviceManagementType : None
IdentityType : ActiveDirectory
VdaHostId :
WorkgroupMachine : False
TrustServiceInstanceId :
ADAccountGuid : 7f23cdaa-072f-4eab-bca5-c2b18cd30c06
ADAccountName : domain\account2
ADAccountSid : S-1-5-21-1315084875-1285793635-2418178940-2645
AccountDisabled : False
AccountLocked : False
Domain : Domain.com
DomainControllerHint :
Lock : False
State : Available
TenantId :
DeviceManagementType : None
IdentityType : ActiveDirectory
VdaHostId :
WorkgroupMachine : False
TrustServiceInstanceId :
<!--NeedCopy-->
Parameters
-ADAccountName
The name of the AD account to be imported. AD 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 |
-IdentityPoolUid
The unique identifier for the identity pool in which the accounts are to be imported.
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 in which the accounts are to be imported.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Length range: | 1 to 64 |
-Password
The current password for the computer account. If this parameter is used, AD permissions to reset computer account passwords are not required.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SecurePassword
The current password for the account (provided in a Secure String class). If this parameter is used, AD permissions to reset computer account passwords are not required.
Type: | SecureString |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ADUserName
The username for an AD user account with permissions to reset computer account passwords. This parameter can 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 (in a Secure String class) for an AD user account with permissions to reset computer account passwords. This parameter can 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 |
-UseServiceAccount
Use the IdentityPool’s service account to add AD accounts.
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.AccountOperationDetailedSummary
The Add-AcctADAccount returns an object that contains the following properties:
-
SuccessfulAccountsCount <int>
The number of accounts that were added successfully
-
FailedAccountsCount <int>
The number of accounts that were not added.
-
FailedAccounts <Citrix.XDPowerShell.AccountError[]>
The list of accounts that failed to be added. Each one has the following properties:
- ADAccountName <string>
- ADAccountSid <String>
-
ErrorReason <ADIdentityStatus>
This can be one of the following:
- UnableToConvertDomain
- UnableToAccessAccountProperties
- IdentityNotLocatedInDomain
- UnableToAccessAccountProperties
- IdentityDuplicateObjectExists
- IdentityObjectLocked
- IdentityObjectInUse
- FailedToConnectToDomainController
- FailedToExecuteSearchInAD
- FailedToAccessComputerAccountInAD
- FailedToSetPasswordInAD
- FailedToChangePasswordInAD
- ADServiceDatabaseError
- ADServiceDatabaseNotConfigured
- ADServiceStatusInvalidDb
-
DiagnosticInformtion <Exception>
Any other error information
-
SuccessfulAccounts <Citrix.ADIdentity.Sdk.Identity[]>
The list of accounts that were successfully added. Each one has the following properties:
-
ADAccountGuid <Guid>
The unique identifier for the account.
-
ADAccountName <string>
The name of the account.
-
ADAccountSid <string>
The SID for the account.
-
AccountDisabled <bool>
Whether or not the account is disabled in AD.
-
AccountLocked <bool>
Whether or not the account is locked in AD.
-
Domain <string>
The domain for the account.
- DomainControllerHint <string>
-
Lock <bool>
Whether or not the account is locked (in the database, not AD).
-
State <Citrix.ADIdentity.Sdk.ADIdentityState>
The state for the account. This can be:
-
Available
The account is not used.
-
InUse
The account is in use.
-
Error
The account is in error (i.e. the account is locked or disabled in AD).
-
Tainted
The account is no longer used, but the password is no longer known.
-
-
TenantId <Guid>
The identity of the tenant associated with this account.
-
DeviceManagementType <string>
The device management type.
-
IdentityType <string>
The identity type.
-
VdaHostId <Guid>
The ID of the VDA associated with this account.
-
WorkgroupMachine <bool>
Whether or not the account is a workgroup account (not domain-joined).
-
TrustServiceInstanceId <string>
The trust service ID of the machine.
-
Notes
To maintain maximum security when using the command programmatically, Citrix recommends you use the ‘SecurePassword’ property instead of the ‘Password’ property.
In the case of failure, the following errors can result:
-
IdentityPoolAlreadyLocked
The specified identity pool was locked by another operation.
-
IdentityPoolNotFound
The specified identity pool was not found.
-
IdentityDuplicateObjectExists
The specified AD account already exists for the identity pool.
-
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.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.