Get-BrokerGpoSettingDefinition

Last published : Oct 31, 2026
Introduced in: Citrix Virtual Apps and Desktop 7 2503
Gets the definitions of all settings or the definition of a specific setting.
Related information
about_Broker_AccessPolicy

Syntax

Get-BrokerGpoSettingDefinition
   [-SettingName <String>]
   [-DisplayName <String>]
   [-Category <String>]
   [-VdaVersion <String>]
   [-ComputerOnly]
   [-UserOnly]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Parameters can be specified to return only the definitions of settings that meet the requirements specified by the parameters. When a setting is configured, its name must be specific. To find out the names of available settings, use this command.

Examples

EXAMPLE 1

Get all setting definitions.
Get-BrokerGpoSettingDefinition

EXAMPLE 2

Get all user setting definitions whose names contain the word Virtual.
Get-BrokerGpoSettingDefinition -UserOnly -SettingName ".*Virtual.*"

Parameters

-SettingName

Specifies the GPO setting name, for which the definition is to be retrieved. The setting name can be a regular expression. Settings whose names match the regular expression are returned.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-DisplayName

Retrieve the definition of a setting using its display name. The name can be specified using a regular expression. Definitions of all settings, whose name match the regular expression are returned.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-Category

Retrieve the definitions of settings in a category. The category can be a regular expression. All settings, whose category match the regular expression, are returned.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-VdaVersion

Retrieve the definitions of settings supported by a specific VDA version. The version string can be a regular expression. Settings whose version strings match the given regular expression are returned.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-ComputerOnly

Retrieve only the definitions of computer settings.
Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-UserOnly

Retrieve only the definitions of user settings.
Type: SwitchParameter
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 can't pipe objects to this cmdlet.

Outputs

Citrix.GroupPolicy.Definitions.SettingDefinition

The definition of a setting contains detailed information about a setting, such as the setting name, the display name of a setting, the VDA versions that support this setting, and other information about this setting.
  • AllowedText
    If this setting is a Boolean, this is the string to display in the label of a radio button for Allow.
  • Category
    The category of this setting. A category of a setting is similar to the folder hierarchy of file.
  • DefaultValue
    The suggested value of a setting if the setting is not used.
  • DeniedText
    If this setting is a Boolean, this is the string to display in the label of a radio button for Deny.
  • DisabledValue
    If the IsToggled flag is true, this setting is a toggled setting. A toggled setting defines a special value to indicate that the setting is disabled. This value is that special value.
  • DisplayName
    The display name of the setting.
  • EditorName
    The name of the setting editor. This tells the UI how the setting data should be presented and edited in a user interface.
  • EnumType
    If this setting is an enum, this shows the type name of the enum.
  • Explanation
    A brief description of the function and use of the setting.
  • GpoScope
    An internal flag indicating if this setting is supported only in a domain GPO.
  • HideValueHint
    Indicates to a UI that the hint about the value of the setting should not be displayed.
  • InitialValue
    If the IsToggled flag is true, this value specifies the initial value for such a setting when the setting is enabled.
  • IsEnableDisable
    If the setting data type is bool, this flag indicates if the UI should display the labels of the radio buttons as enable/disable. If this flag is false, the UI usually displays the labels of the radio buttons as allow/prohibit.
  • IsToggled
    A setting may have its value in use only when it is enabled. These settings are so-called toggled settings.
  • IsUserSetting
    Indicates if the setting is a user setting. A user setting is applied when a session is connected. If this is not a user setting, it is always applied.
  • ProductGroup
    An internal flag indicating the product group of this setting when it is used for configuring for use in a configuration slot.
  • RelatedSettings
    Names of other settings related to this setting.
  • SettingName
    The name of the setting.
  • SettingType
    The data type of the setting.
  • ValidatorError
    The error message displayed when the ValueValidator reports an error.
  • ValueMaximum
    If the type of the setting value is integer, this value specifies the maximum value for it to be considered valid. If a value larger than this value is specified, the value is rejected.
  • ValueMinimum
    If the type of the setting value is integer, this value specifies the minimum value for it to be considered valid. If a value smaller than this value is specified, the value is rejected.
  • ValueType
    String representation of the data type of the setting value.
  • ValueUnit
    If the setting data type is integer, this optional string specifies the unit of the data as quantity or measurement.
  • ValueValidator
    The name of an internal method used to validate the setting value.
  • VdaVersions
    Versions of VDAs that support this setting.