Get-BrokerGpoFilter

Last published : Oct 31, 2026
Gets GPO filters for a policy.
Related information
about_Broker_AccessPolicy

Syntax

Get-BrokerGpoFilter
   [-FilterData <String>]
   [-FilterType <String>]
   [-IsAllowed <Boolean>]
   [-IsEnabled <Boolean>]
   [-PolicyGuid <Guid>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-BrokerGpoFilter
   -FilterGuid <Guid>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Retrieve GPO filters that meet certain criteria.
-------------------------- BrokerGpoFilter Object
A GPO filter specifies how the policy should be applied based on the properties of a user session and/or the VDA hosting the session.
  • FilterData (System.String)
    Filter data.
  • FilterGuid (System.Guid)
    The GUID of the filter.
  • FilterType (System.String)
    The type of the filter.
  • IsAllowed (System.Boolean)
    Is filter mode set to allowed.
  • IsEnabled (System.Boolean)
    Is filter enabled.
  • PolicyGuid (System.Guid)
    The GUID of the policy that owns the filter.

Examples

EXAMPLE 1

Gets the filters defined for a policy.
Get-BrokerGpoFilter -PolicyGuid ([Guid]"12345678-...")

EXAMPLE 2

Gets a specific filter.
Get-BrokerGpoFilter -FilterGuid ([Guid]"12345678-...")

Parameters

-FilterGuid

Gets specified filter. If this parameter is not specified, all filters are returned.
Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-FilterData

Gets filter that has the specified data.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-FilterType

Gets filter of the specified type.
Type: String
Accepted values: AccessControl, BranchRepeater, ClientIP, ClientName, DesktopGroup, DesktopKind, DesktopTag, OU, User
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-IsAllowed

Gets allowed filters.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-IsEnabled

Gets enabled filters.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PolicyGuid

Gets filters that are defined for the policy.
Type: Guid
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.GpoFilter

Get-BrokerGpoFilter returns an object for each matching GPO filter object.