Get-BrokerGpoFilter¶
Gets GPO filters for a policy.
Syntax¶
Get-BrokerGpoFilter -FilterGuid <Guid> [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>] Get-BrokerGpoFilter [-FilterType <String>] [-IsAllowed <Boolean>] [-IsEnabled <Boolean>] [-PolicyGuid <Guid>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
Detailed 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.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| FilterGuid | Gets specified filter. If this parameter is not specified, all filters are returned. | true | false | |
| FilterType | Gets filter of the specified type. | false | false | |
| IsAllowed | Gets allowed filters. | false | false | |
| IsEnabled | Gets enabled filters. | false | false | |
| PolicyGuid | Gets filters that are defined for the policy. | false | 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. | false | false | False |
| MaxRecordCount | Specifies the maximum number of records to return. | false | false | 250 |
| Skip | Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. | false | false | 0 |
| 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. | false | false | The default sort order is by name or unique identifier. |
| Filter | Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details. | false | false | |
| FilterScope | Gets only results allowed by the specified scope id. | false | 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. | false | false | |
| AdminAddress | 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. | false | false | Localhost. Once a value is provided by any cmdlet, this value will become the default. |
| BearerToken | Specifies the bearer token assigned to the calling user | false | false | |
| AdminClientIP | Internal use only. | false | false | |
| TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | |
| TraceState | Specifies the trace state assigned for internal diagnostic tracing use | false | false | |
| VirtualSiteId | Specifies the virtual site the PowerShell snap-in will connect to. | false | false |
Input Type¶
None¶
You cannot pipe input into this cmdlet.
Return Values¶
Citrix.Broker.Admin.Sdk.Gpofilter¶
Get-BrokerGpoFilter returns an object for each matching GPO filter object.
Examples¶
Example 1¶
C:\PS> Get-BrokerGpoFilter -PolicyGuid ([Guid]"12345678-...")
Description¶
Gets the filters defined for a policy.
Example 2¶
C:\PS> Get-BrokerGpoFilter -FilterGuid ([Guid]"12345678-...")
Description¶
Gets a specific filter.