Get-BrokerUser
Gets broker users configured for this site.
Syntax
Get-BrokerUser
[[-Name] <String>]
[-DirectoryContext <String>]
[-FullName <String>]
[-HomeZoneName <String>]
[-HomeZoneUid <Guid>]
[-IdentityClaims <String>]
[-NameLookupFailureCount <Int32>]
[-PrimaryClaim <String>]
[-SAMName <String>]
[-UPN <String>]
[-ApplicationGroupUid <Int32>]
[-ApplicationUid <Int32>]
[-SessionLingerDesktopGroupUid <Int32>]
[-SessionPreLaunchDesktopGroupUid <Int32>]
[-MachineUid <Int32>]
[-PrivateDesktopUid <Int32>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Get-BrokerUser
-SID <String>
[-Property <String[]>]
[<CitrixCommonParameters>]
[<CommonParameters>]
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:
-
DirectoryContext (System.String)The directory context of a user
-
FullName (System.String)The full name of a user
-
HomeZoneName (System.String)Name of home zone associated with user
-
HomeZoneUid (System.Guid?)Home zone associated with this user
-
IdentityClaims (System.String)The identity claims of a user
-
Name (System.String)The name of a user
-
NameLookupFailureCount (System.Int32)Tracks the number of consecutive directory lookup failures for this account
-
PrimaryClaim (System.String)The primary identity claim of a user
-
SAMName (System.String)The SAMName of a user
-
SID (System.String)The SID of a user
-
UPN (System.String)The UPN of a user
Examples
EXAMPLE 1
Get all broker user objects with names matching the supplied pattern
Get-BrokerUser DOMAIN7\*
EXAMPLE 2
Get all broker user objects added to the specified private desktop
$pdt = Get-BrokerPrivateDesktop DOMAIN\MACHINENAME\n
Get-BrokerUser -PrivateDesktopUid $pdt.Uid
Parameters
-SID
Gets the broker user with the specified SID property value.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Name
Gets the broker user with the specified Name property.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-DirectoryContext
Gets the broker user with the specified directory context property value.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-FullName
Gets the broker user with the specified FullName property.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-HomeZoneName
Gets user/group accounts having a home zone preference matching the specified name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-HomeZoneUid
Gets user/group accounts having a home zone preference matching the specified UID.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityClaims
Gets the broker user with the specified identity claims property value.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-NameLookupFailureCount
Tracks the number of consecutive directory lookup failures for this account.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrimaryClaim
Gets the broker user with the specified primary claim property value.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-SAMName
Gets the broker user with the specified SAMName property value.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-UPN
Gets the broker user with the specified UPN property value.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ApplicationGroupUid
Gets broker users associated with the application group with the specified Uid.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ApplicationUid
Gets broker users associated with the application with the specified Uid.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionLingerDesktopGroupUid
Gets broker users associated with the desktop group session linger settings with the specified Uid.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionPreLaunchDesktopGroupUid
Gets broker users associated with the desktop group session pre-launch settings with the specified Uid.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachineUid
Gets broker users associated with the broker machine with the specified Uid.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivateDesktopUid
Gets broker users associated with the private desktop with the specified Uid.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReturnTotalRecordCount
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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxRecordCount
Specifies the maximum number of records to return.
| Type: | Int32 |
| Position: | Named |
| Default value: | 250 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SortBy
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.
| Type: | String |
| Position: | Named |
| Default value: | The default sort order is by name or unique identifier. |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterScope
Gets only results allowed by the specified scope id.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Property
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.
| Type: | String[] |
| 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
None
You cannot pipe input into this cmdlet.
Outputs
Citrix.Broker.Admin.SDK.User
Get-BrokerUser returns an object for each matching broker user.