Rename-BrokerMergeGroup

Last published : Oct 31, 2026
Introduced in: Citrix Virtual Apps and Desktop 7 2407
Renames the Merge Group
Related information
about_Broker_AccessPolicy

Syntax

Rename-BrokerMergeGroup
      [-InputObject] <MergeGroup[]>
      [-PassThru]
      [-NewName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
Rename-BrokerMergeGroup
      [-Name] <String>
      [-PassThru]
      [-NewName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]

Description

Renames the specified Merge Group

Examples

EXAMPLE 1

Renames the Merge Group called ZoneAMergeGroup to ZoneBMergeGroup
Rename-BrokerMergeGroup -Name ZoneAMergeGroup -NewName ZoneBMergeGroup

Parameters

-InputObject

Specifies one or more Merge Group objects.
Type: MergeGroup[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Identifies Merge Group to be renamed by name.
Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-NewName

Renames the Merge Group with the supplied name.
Type: String
Position: 3
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Length range: 1 to 64
Disallowed characters: /;:#.*?=<>\|[]()"'` and all ASCII control characters

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

You can pipe in the Merge Group to be renamed.

Outputs

None or Citrix.Broker.Admin.SDK.MergeGroup

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