Citrix Daas SDK

New-BrokerUser

Creates a new broker user object

Syntax

New-BrokerUser
   [-SID] <SecurityIdentifier>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
New-BrokerUser
   [-Name] <String>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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

Examples

EXAMPLE 1

Create a broker user object for the specified user.

$user = New-BrokerUser DOMAIN\UserName
<!--NeedCopy-->

EXAMPLE 2

Create a broker user object for the specified user.

$user = New-BrokerUser -SID S-1-5-23-1763203430-193137401-908696819-3450
<!--NeedCopy-->

Parameters

-SID

The SID of the user or group

Type: SecurityIdentifier
Position: 2
Default value: Null
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Name

The name of the user or group

Type: String
Position: 2
Default value: Null
Required: True
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 cannot pipe input into this cmdlet.

Outputs

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.

New-BrokerUser