Get-BrokerRemotePCAccount

Last published : Oct 31, 2026
Get RemotePCAccount entries configured for this site.
Related information
about_Broker_AccessPolicy

Syntax

Get-BrokerRemotePCAccount
   [-AllowSubfolderMatches <Boolean>]
   [-CatalogUid <Int32>]
   [-OU <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-BrokerRemotePCAccount
   -Uid <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Retrieves RemotePCAccounts matching the specified criteria. If no parameters are specified this cmdlet enumerates all RemotePCAccounts. Each RemotePCAccount object defines a set of machines either by machine name patterns or by where the machines are placed in Active Directory, and which RemotePC catalog the machines are to be associated with when they are discovered.
-------------------------- BrokerRemotePCAccount Object
RemotePCAccounts define a set of machines either by machine name patterns or by where the machines are placed in Active Directory, and which RemotePC catalog the machines are to be associated with when they are discovered.
  • AllowSubfolderMatches (System.Boolean)
    Specifies whether machines subfolders of specified AD OUs are to be considered part of the RemotePCAccount.
  • CatalogUid (System.Int32)
    The Uid of the RemotePC catalog to which machines in the RemotePCAccount automatically join during registration.
  • MachinesExcluded (System.String\[\])
    A list of machines which are to be excluded from the RemotePCAccount. Wildcard matching is supported.
  • MachinesIncluded (System.String\[\])
    A list of machines which are to be included in the RemotePCAccount. Wildcard matching is supported.
  • OU (System.String)
    Machines within this specified AD OU are considered part of the RemotePCAccount, unless they are in they match the MachinesExcluded
  • Uid (System.Int32)
    The Uid of the RemotePCAccount object.

Examples

EXAMPLE 1

Find all RemotePCAccounts.
Get-BrokerRemotePCAccount

EXAMPLE 2

Find RemotePCAccounts belonging to Remote PC catalog 42.
Get-BrokerRemotePCAccount -CatalogUid 42

Parameters

-Uid

Gets the RemotePCAccount with the specified unique ID.
Type: Int32
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-AllowSubfolderMatches

Gets RemotePCAccounts with the specified value of AllowSubfolderMatches.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-CatalogUid

Gets RemotePCAccounts belonging to the specified Remote PC catalog.
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-OU

Gets the RemotePCAccount with the specified OU.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-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
Introduced in: Citrix Virtual Apps and Desktop 7 2106

-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.RemotePCAccount

Get-BrokerRemotePCAccount returns an object for each matching RemotePCAccount.