Product Documentation

Add-BrokerUser

Sep 29, 2015

Creates an association between a user and another broker object

Syntax

Add-BrokerUser [-InputObject] <User[]> [-Application <Application>] [-Machine <Machine>] [-PrivateDesktop <PrivateDesktop>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Add-BrokerUser [-Name] <String> [-Application <Application>] [-Machine <Machine>] [-PrivateDesktop <PrivateDesktop>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed 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:

o 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).

o PrivateDesktop - assign the desktop to the specified user(s).

o Application - assign the application to the specified user(s).

Parameters

-InputObject<User[]>

The user objects to add.

Required? true
Default Value null
Accept Pipeline Input? true (ByValue)

-Name<String>

The name of the user or users to be added.

Required? true
Default Value null
Accept Pipeline Input? true (ByPropertyName)

-Application<Application>

The application to which the user is to be associated.

Required? false
Default Value  
Accept Pipeline Input? true (ByValue)

-Machine<Machine>

The machine to which the user is to be assigned

Required? false
Default Value null
Accept Pipeline Input? true (ByValue)

-PrivateDesktop<PrivateDesktop>

The desktop to which the user is to be assigned

Required? false
Default Value null
Accept Pipeline Input? true (ByValue)

-LoggingId<Guid>

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.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

Citrix.Broker.Admin.SDK.USer You can pipe the users to be added to Add-BrokerUser.

Return Values

None

Notes

Specify one of the -Machine or -PrivateDesktop or -Application parameters only.

Examples

-------------------------- EXAMPLE 1 --------------------------

Add-BrokerUser "DOMAIN\UserName" -PrivateDesktop "DOMAIN\MachineName"

Assign the specified private desktop to the specified user.

-------------------------- EXAMPLE 2 --------------------------

Add-BrokerUser "DOMAIN\UserName" -Application "ApplicationName"

Assign the specified application to the specified user.