Citrix Virtual Apps and Desktops SDK

Get-BrokerGpoSetting

Introduced in: Citrix Virtual Apps and Desktop 7 2009

Gets GPO settings for a policy.

Syntax

Get-BrokerGpoSetting
   [[-SettingName] <String>]
   [-PolicyGuid <Guid>]
   [-SettingValue <String>]
   [-UseDefault <Boolean>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerGpoSetting
   [-SettingGuid] <Guid>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Retrieve GPO settings that meet certain criteria.

————————– BrokerGpoSetting Object

A GPO setting specifies a configuration setting that controls how a VDA behaves.

  • PolicyGuid (System.Guid)

    The GUID of the policy that owns the setting.

  • SettingGuid (System.Guid)

    The GUID of the setting.

  • SettingName (System.String)

    The name of the setting.

  • SettingValue (System.String)

    The setting value.

  • UseDefault (System.Boolean)

    Indicate if the default value of the setting is used. Ignored if setting is Boolean.

Examples

EXAMPLE 1

Gets the specified setting.

Get-BrokerGpoSetting -SettingGuid ([Guid]"1234abcd-...")
<!--NeedCopy-->

EXAMPLE 2

The value of the setting in the output may be produced if a setting with the value [“a”, “b”] has been created previously.

SettingValue : [“a”, “b”]

Get-BrokerGpoSetting -SettingValue '*"a"*"b"*'
<!--NeedCopy-->

Parameters

-SettingGuid

Gets specified setting. If this parameter is not specified, all settings that belong to the policy are returned.

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

-SettingName

Gets specified setting if this parameter is specified.

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

-PolicyGuid

Specifies the policy for which the settings are retrieved.

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

-SettingValue

Gets the setting with the specified value.

Getting one or more setting objects is a SQL search operation. The parameters are used as the conditions in a SQL WHERE clause. If the value of a setting contains characters that are used as SQL meta characters, for example, if the value of a setting is a JSON string [“a”, “b”], because the [, ], and “ are meta characters, searching using such a string may not yield the expected result. In general, it is not necessary to search by value when the GUID of a setting is known, or when the GUID of a policy and the name of a setting in the policy is known.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True
Introduced in: Citrix Virtual Apps and Desktop 7 2308

-UseDefault

Gets the settings that use the default value.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2308

-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
Introduced in: Citrix Virtual Apps and Desktop 7 2106

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

Get-BrokerGpoSetting returns an object for each matching setting object.

Get-BrokerGpoSetting