Citrix Daas SDK

Set-BrokerGpoSetting

Changes the state and/or value of an existing GPO setting.

Syntax

Set-BrokerGpoSetting
   [-InputObject] <GpoSetting[]>
   [-PassThru]
   [-SettingValue <String>]
   [-UseDefault <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-BrokerGpoSetting
   [-SettingName] <String>
   [-PassThru]
   [-SettingValue <String>]
   [-UseDefault <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Changes the state and/or value of an existing GPO setting.

Examples

EXAMPLE 1

Changes the state of the setting to 2 (disabled).

Set-BrokerGpoSetting ([Guid]"12345678-...") -UseDefault $true
<!--NeedCopy-->

Parameters

-InputObject

Specifies the GPO setting object to set.

Type: GpoSetting[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-SettingName

Specifies the GPO setting object to set.

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

-PassThru

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.

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

-SettingValue

The setting value.

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

-UseDefault

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

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

-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

Citrix.Broker.Admin.SDK.GpoSetting

GPO settings may be specified through pipeline input.

Outputs

None

By default, this cmdlet returns no output.

Set-BrokerGpoSetting