Citrix Virtual Apps and Desktops SDK

Get-BrokerGpoPolicySet

Gets GPO policy sets defined in site.

Syntax

Get-BrokerGpoPolicySet
   [[-Name] <String>]
   [-Description <String>]
   [-IsAssigned <Boolean>]
   [-PolicyCount <Int32>]
   [-PolicySetType <String>]
   [-ScopeId <Guid>]
   [-ScopeName <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerGpoPolicySet
   [-PolicySetGuid] <Guid>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

  • IsAssigned (System.Boolean)

    True if the policy set is assigned to a delivery group.

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

Examples

EXAMPLE 1

Lists the policy sets currently defined for the site.

Get-BrokerGpoPolicySet
<!--NeedCopy-->

Parameters

-PolicySetGuid

Gets specified policy set. If this parameter is not specified, all policy sets are returned.

Type: Guid
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Name

Gets specified policy set. If this parameter is not specified, all policy sets are returned.

Type: String
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-Description

Gets the policy set that has the specified description.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-IsAssigned

Gets policy sets that are currently assigned to at least one delivery group or not assigned to any delivery group.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PolicyCount

Gets the policy set that has the specified number of policies.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PolicySetType

Gets the policy sets of the specified type.

Type: String
Accepted values: CustomTemplates, DeliveryGroupPolicies, SitePolicies, SiteTemplates
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ScopeId

Gets the policy sets that are associated with the given scope identifier.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ScopeName

Gets the policy sets that are associated with the given scope name.

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

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

Get-BrokerGpoPolicySet returns the matching policy set object.

Get-BrokerGpoPolicySet