Developer Documentation
Citrix Daas SDK

Rename-BrokerGpoPolicy

November 28, 2023
Contributed by: 
C C

Rename policies of the same name.

Syntax

Rename-BrokerGpoPolicy
      [-InputObject] <GpoPolicy[]>
      [-PassThru]
      [-NewName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Rename-BrokerGpoPolicy
      [-Name] <String>
      [-PassThru]
      [-NewName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

Renames all the policies with the name ‘Test’ to ‘Policy1’.

Rename-BrokerGpoPolicy -Name 'Test' -NewName 'Policy1'
<!--NeedCopy-->

Parameters

-InputObject

Specifies the GPO policy objects to rename.

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

-Name

Identifies the policies to be renamed by name.

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

-NewName

Specifies new name for the policies.

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

-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

-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.GpoPolicy

The policy to rename can be piped into this cmdlet.

Outputs

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.

Rename-BrokerGpoPolicy
November 28, 2023
Contributed by: 
C C
November 28, 2023
Contributed by: 
C 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.