Citrix Virtual Apps and Desktops SDK

Set-BrokerGpoPolicy

August 3, 2023

Contributed by:

Changes the properties of a GPO policy.

Syntax

Set-BrokerGpoPolicy [-InputObject] <GpoPolicy[]> [-PassThru] [-Description <String>] [-IsEnabled <Boolean>] [-Name <String>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

The Set-BrokerGpoPolicy cmdlet is used to disable or enable an existing GPO policy or to alter its properties.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
InputObject	Specifies the GPO policy object to set.	true	true (ByValue)
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
Description	Specifies a new description for the policy.	false	false
IsEnabled	Enable or disable the policy.	false	false
Name	Specifies a new name for the policy.	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
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.Gpopolicy

You can pipe GPO policies to be adjusted to Set-BrokerGpoPolicy.

Return Values

None Or Citrix.Broker.Admin.Sdk.Gpopolicy

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.GpoPolicy object.

Examples

Example 1

C:\PS> Get-BrokerGpoPolicy -Name '\*test\*' | Set-BrokerGpoPolicy -IsEnabled $true

<!--NeedCopy-->

Description

Enable all policies with names containing the word ‘test’.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-BrokerGpoPolicy

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Set-BrokerGpoPolicy

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Broker.Admin.Sdk.Gpopolicy

Return Values

None Or Citrix.Broker.Admin.Sdk.Gpopolicy

Examples

Example 1

Description

In this article