Get-BrokerGpoPolicy

Last published : Oct 31, 2026
Gets GPO policies configured for this site.
Related information
about_Broker_AccessPolicy

Syntax

Get-BrokerGpoPolicy
   [[-Name] <String>]
   [-Description <String>]
   [-IsEnabled <Boolean>]
   [-PolicySetGuid <Guid>]
   [-Priority <Int32>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-BrokerGpoPolicy
   [-PolicyGuid] <Guid>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Retrieve GPO policies matching the specified criteria. If no parameters are specified this cmdlet enumerates all GPO policies.
A GPO policy contains settings that control VDA behaviors.
-------------------------- BrokerGpoPolicy Object
A GPO policy object is a collection of VDA configurations that control how a VDA should behave. The filters in a policy are used to determine which VDAs are to be enforced with the specified configuration settings. Policy priorities determine how the policies should be applied together.
  • Description (System.String)
    A short description.
  • IsEnabled (System.Boolean)
    Specifies whether the policy is enabled. A disabled policy is not used to enforce its settings by VDAs.
  • Name (System.String)
    The name of the policy object. Names for each policy object must be unique in a policy set.
  • PolicyGuid (System.Guid)
    The GUID of the policy object.
  • PolicySetGuid (System.Guid)
    The GUID of the policy set that contains this policy.
  • Priority (System.Int32)
    Specifies the priority of this policy among all the other policies in the policy set that contains this policy. The value is 1-based and the maximal value is the number of policies in the policy set.

Examples

EXAMPLE 1

Finds the policy named as 'Security settings'.
Get-BrokerGpoPolicy -Name 'Security settings'

EXAMPLE 2

Finds all policies in the default site policy set.
Get-BrokerGpoPolicy

Parameters

-PolicyGuid

Gets only the policy object with the specified GUID.
Type: Guid
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Name

Gets only the policy object with the specified name.
Type: String
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-Description

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

-IsEnabled

Gets policies that are enabled or disabled.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PolicySetGuid

Gets only the policies in the policy set.
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Priority

Gets the policy that has the specified priority.
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.GpoPolicy

Get-BrokerGpoPolicy returns an object for each matching policy.