Rename-Brokergpopolicy¶

Rename policies of the same name.

Syntax¶

Rename-BrokerGpoPolicy [-InputObject] <GpoPolicy[]> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]<br><br>Rename-BrokerGpoPolicy [-Name] <String> [-NewName] <String> [-PassThru] [-LoggingId <Guid>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Detailed Description¶

Renames GPO policies with the supplied name. Policy names are unique in a policy set. Policies of the same name can exist in different policy sets. This cmdlet renames all policies in different policy sets.

Parameters¶

Name	Description	Required?	Pipeline Input	Default Value
InputObject	Specifies the GPO policy objects to rename.	true	true (ByValue)
Name	Identifies the policies to be renamed by name.	true	true (ByPropertyName)
NewName	Specifies new name for the policies.	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
AdminClientIP	Internal use only.	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¶

The policy to rename can be piped into this cmdlet.

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.

Notes¶

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

Examples¶

Example 1¶

C:\PS> Rename-BrokerGpoPolicy -Name 'Test' -NewName 'Policy1'

Description¶

Renames all the policies with the name 'Test' to 'Policy1'.