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-BrokerUser
Creates an association between a user and another broker object
Syntax
Add-BrokerUser
[-InputObject] <User[]>
[-ApplicationGroup <ApplicationGroup>]
[-Application <Application>]
[-SessionLinger <SessionLinger>]
[-SessionPreLaunch <SessionPreLaunch>]
[-Machine <Machine>]
[-PrivateDesktop <PrivateDesktop>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Add-BrokerUser
[-Name] <String>
[-ApplicationGroup <ApplicationGroup>]
[-Application <Application>]
[-SessionLinger <SessionLinger>]
[-SessionPreLaunch <SessionPreLaunch>]
[-Machine <Machine>]
[-PrivateDesktop <PrivateDesktop>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
The Add-BrokerUser cmdlet adds broker user objects to another specified object, such as a broker private desktop. This depends on the target object type:
-
Machine - assign the broker machine to the specified user(s); when the
machine is subsequently added to a desktop group, the desktop is also assigned to the same user(s).
- PrivateDesktop - assign the desktop to the specified user(s).
- Application - assign the application to the specified user(s).
- Application group - assign the applications in the application group to the specified user(s).
Examples
EXAMPLE 1
Assign the specified private desktop to the specified user.
Add-BrokerUser "DOMAIN\UserName" -PrivateDesktop "DOMAIN\MachineName"
<!--NeedCopy-->
EXAMPLE 2
Assign the specified application to the specified user.
Add-BrokerUser "DOMAIN\UserName" -Application "ApplicationName"
<!--NeedCopy-->
Parameters
-InputObject
The user objects to add.
| Type: | User[] |
| Position: | 2 |
| Default value: | Null |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
The name of the user or users to be added.
| Type: | String |
| Position: | 2 |
| Default value: | Null |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-ApplicationGroup
The application group to which the user is to be assigned.
| Type: | ApplicationGroup |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Application
The application to which the user is to be assigned.
| Type: | Application |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-SessionLinger
The session linger setting to which the user is to be assigned.
| Type: | SessionLinger |
| Position: | Named |
| Default value: | Null |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-SessionPreLaunch
The session pre-launch setting to which the user is to be assigned.
| Type: | SessionPreLaunch |
| Position: | Named |
| Default value: | Null |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Machine
The machine to which the user is to be assigned
| Type: | Machine |
| Position: | Named |
| Default value: | Null |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-PrivateDesktop
The desktop to which the user is to be assigned
| Type: | PrivateDesktop |
| Position: | Named |
| Default value: | Null |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop 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.Broker.Admin.SDK.USer
You can pipe the users to be added to Add-BrokerUser.
Outputs
None
By default, this cmdlet returns no output.
Notes
Specify one of the -Machine or -PrivateDesktop or -Application parameters only.
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.