Developer Documentation
Citrix Daas SDK

Rename-BrokerGpoPolicySet

August 18, 2023
Contributed by: 
C

Rename a GPO policy set.

Syntax

Rename-BrokerGpoPolicySet [-InputObject] <GpoPolicySet[]> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]<br /><br />Rename-BrokerGpoPolicySet [-Name] <String> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Renames a GPO policy set to a new name.

Parameters

Name Description Required? Pipeline Input Default Value
InputObject Specifies the GPO policy set object to rename. true true (ByValue)  
Name Identifies the policy set to be renamed by name. true true (ByPropertyName)  
NewName Specifies new name for the policy set. true false  
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
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.SdkGpopolicyset

The policy set to rename can be piped into this cmdlet.

Return Values

None Or Citrix.Broker.Admin.SdkGpopolicyset

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

Notes

Note that when renaming a policy set, its Guid remains the same and any associations are maintained.

Examples

Example 1 

C:\PS> Rename-BrokerGpoPolicySet -Name 'Test' -NewName 'Set1'
<!--NeedCopy-->

Description

Renames the policy set with the name ‘Test’ to ‘Set1’.

Rename-BrokerGpoPolicySet
August 18, 2023
Contributed by: 
C
August 18, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.