Product Documentation

New-BrokerUser

Apr 15, 2014

Creates a new broker user object

Syntax

New-BrokerUser [-SID] <SecurityIdentifier> [-AdminAddress <String>] [<CommonParameters>]

New-BrokerUser [-Name] <String> [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The New-BrokerUser cmdlet creates a new broker object to represent a user identity (or the identity of a group of users). The object is created local to the PowerShell environment in which the cmdlet is run; no new user object is created in the broker configuration, unless the object is added to another broker object, such as a machine or a desktop. For details, see Add-BrokerUser.

The identity of the user or group must be specified using either the Name or SID parameter

Parameters

-SID<SecurityIdentifier>

The SID of the user or group

Required? true
Default Value null
Accept Pipeline Input? false

-Name<String>

The name of the user or group

Required? true
Default Value null
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

None You cannot pipe input into this cmdlet.

Return Values

Citrix.Broker.Admin.SDK.User

The broker user object

Notes

Typically, broker user objects are created implicitly using the Add-BrokerUser cmdlet with a user name or SID.

Examples

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

$user = New-BrokerUser DOMAIN\UserName

Create a broker user object for the specified user.

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

$user = New-BrokerUser -SID S-1-5-23-1763203430-193137401-908696819-3450

Create a broker user object for the specified user.