Citrix Virtual Apps and Desktops SDK

New-BrokerGpoSetting

Introduced in: Citrix Virtual Apps and Desktop 7 2009

Creates a new GPO setting.

Syntax

New-BrokerGpoSetting
   -PolicyGuid <Guid>
   [-SettingName] <String>
   [-SettingValue <String>]
   [-UseDefault <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Creates a GPO setting for a policy.

Examples

EXAMPLE 1

Creates a new ‘Audio quality’ setting.

New-BrokerGpoSetting -PolicyGuid ([Guid]"12345678-...") -SettingName AudioQuality -UseDefault $true
<!--NeedCopy-->

Parameters

-SettingName

The setting name.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-PolicyGuid

The GUID of the policy for which the filter is created.

Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SettingValue

The setting value.

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

-UseDefault

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

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2209

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
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

Input cannot be piped to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.GpoSetting

Outputs the GPO setting object.

New-BrokerGpoSetting