Citrix Virtual Apps and Desktops SDK

Get-BrokerGpoPolicySet

Gets GPO policy sets defined in site.

Syntax


Get-BrokerGpoPolicySet -PolicySetGuid <Guid> [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Get-BrokerGpoPolicySet [-ScopeId <Guid>] [-ScopeName <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Retrieve information about all policy sets or a specified policy set.

Brokergpopolicyset Object

A GPO policy set is a container of GPO policies. There is always a site policy set, which contains all the site policies. There is also a policy set that contains all the policy templates. Other policy sets are private policy sets used by individual components for special configurations.

  • Description (System.String) A short description of the policy set.

  • LastError (System.String) If neither nor empty, an error string indicating the reason why the most recent conversion from the policy set to VDA blob failed.

  • Name (System.String) The name of the policy set. This must be unique among all policy sets.

  • PolicyCount (System.Int32) Number of policies in the policy set.

  • PolicySetGuid (System.Guid) The ID of the configuration policy set.

  • PolicySetType (System.String) The policy set type.

  • Scopes (Citrix.Fma.Sdk.DelegatedAdminInterfaces.ScopeReference[]) The list of the delegated admin scopes to which the policy set belongs.

Parameters

Name Description Required? Pipeline Input Default Value
PolicySetGuid Gets specified policy set. If this parameter is not specified, all policy sets are returned. true false  
ScopeId Gets the policy sets that are associated with the given scope identifier. false false  
ScopeName Gets the policy sets that are associated with the given scope name. 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  
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.Gpopolicyset

Get-BrokerGpoPolicySet returns the matching policy set object.

Examples

Example 1


C:\PS> Get-BrokerGpoPolicySet

<!--NeedCopy-->

Description

Lists the policy sets currently defined for the site.

Get-BrokerGpoPolicySet