Rename-BrokerMergeGroupSet
Introduced in: Citrix Virtual Apps and Desktop 7 2511
Renames the Merge Group Set
Syntax
Rename-BrokerMergeGroupSet
[-InputObject] <MergeGroupSet[]>
[-PassThru]
[-NewName] <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Rename-BrokerMergeGroupSet
[-Name] <String>
[-PassThru]
[-NewName] <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Renames the specified Merge Group Set
Examples
EXAMPLE 1
Renames the Merge Group Set called ZoneAMergeGroupSet to ZoneBMergeGroupSet
Rename-BrokerMergeGroupSet -Name ZoneAMergeGroupSet -NewName ZoneBMergeGroupSet
Parameters
-InputObject
Specifies one or more Merge Group Set objects.
| Type: | MergeGroupSet[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
Identifies Merge Group Set 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 Set 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.MergeGroupSet
You can pipe in the Merge Group Set to be renamed.
Outputs
None or Citrix.Broker.Admin.SDK.MergeGroupSet
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.MergeGroupSet object.