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>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>] Set-BrokerGpoSetting [-SettingName] <String> [-PassThru] [-SettingValue <String>] [-UseDefault <Boolean>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
Detailed Description¶
Changes the state and/or value of an existing GPO setting.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| InputObject | Specifies the GPO setting object to set. | true | true (ByValue) | |
| SettingName | Specifies the GPO setting object to set. | true | true (ByPropertyName) | |
| PassThru | This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record. | false | false | False |
| SettingValue | The setting value. | false | false | |
| UseDefault | Indicate if default value of setting is used. Ignored if setting is Boolean. | false | 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. | false | false | |
| AdminAddress | Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value will become the default. |
| BearerToken | Specifies the bearer token assigned to the calling user | false | false | |
| AdminClientIP | Internal use only. | false | false | |
| TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | |
| TraceState | Specifies the trace state assigned for internal diagnostic tracing use | false | false | |
| VirtualSiteId | Specifies the virtual site the PowerShell snap-in will connect to. | false | false |
Input Type¶
Citrix.Broker.Admin.Sdk.Gposetting¶
GPO settings may be specified through pipeline input.
Return Values¶
None¶
Examples¶
Example 1¶
C:\PS> Set-BrokerGpoSetting ([Guid]"12345678-...") -UseDefault $true
Description¶
Changes the state of the setting to 2 (disabled).