Product Documentation

Get-BrokerUser

Nov 18, 2015

Gets broker users configured for this site.

Syntax

Get-BrokerUser -SID <String> [-Property <String[]>] [-AdminAddress <String>] [<CommonParameters>]

Get-BrokerUser [[-Name] <String>] [-FullName <String>] [-UPN <String>] [-ApplicationUid <Int32>] [-MachineUid <Int32>] [-PrivateDesktopUid <Int32>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-Property <String[]>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Retrieve broker users matching the specified criteria. If no parameters are specified this cmdlet enumerates all broker users.

For information about advanced filtering options, see about_Broker_Filtering.

-------------------------- BrokerUser Object

The BrokerUser object represents a single instance of an user. It contains the following properties:

-- FullName (System.String)

The full name of an user

-- Name (System.String)

The name of an user

-- SID (System.String)

The SID of an user

-- UPN (System.String)

The UPN of an user

Parameters

-SID<String>

Gets the broker user with the specified SID property value.

Required? true
Default Value  
Accept Pipeline Input? false

-Name<String>

Gets the broker user with the specified Name property.

Required? false
Default Value  
Accept Pipeline Input? false

-FullName<String>

Gets the broker user with the specified FullName property.

Required? false
Default Value  
Accept Pipeline Input? false

-UPN<String>

Gets the broker user with the specified UPN property value.

Required? false
Default Value  
Accept Pipeline Input? false

-ApplicationUid<Int32>

Gets broker users associated with the application with the specified Uid.

Required? false
Default Value  
Accept Pipeline Input? false

-MachineUid<Int32>

Gets broker users associated with the broker machine with the specified Uid.

Required? false
Default Value  
Accept Pipeline Input? false

-PrivateDesktopUid<Int32>

Gets broker users associated with the private desktop with the specified Uid.

Required? false
Default Value  
Accept Pipeline Input? false

-ReturnTotalRecordCount<SwitchParameter>

When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.

Required? false
Default Value False
Accept Pipeline Input? false

-MaxRecordCount<Int32>

Specifies the maximum number of records to return.

Required? false
Default Value 250
Accept Pipeline Input? false

-Skip<Int32>

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Required? false
Default Value 0
Accept Pipeline Input? false

-SortBy<String>

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Required? false
Default Value The default sort order is by name or unique identifier.
Accept Pipeline Input? false

-Filter<String>

Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-Property<String[]>

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

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

None You cannot pipe input into this cmdlet.

Return Values

Citrix.Broker.Admin.SDK.User

Get-BrokerUser returns an object for each matching broker user.

Examples

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

Get-BrokerUser DOMAIN7\*

Get all broker user objects with names matching the supplied pattern

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

$pdt = Get-BrokerPrivateDesktop DOMAIN\MACHINENAME\n 
              Get-BrokerUser -PrivateDesktopUid $pdt.Uid

Get all broker user objects added to the specified private desktop