Citrix Daas SDK

Rename-BrokerAutoscaleGroupPlugin

Renames an autoscale group plugin.

Syntax

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

Description

The Rename-BrokerAutoscaleGroupPlugin cmdlet changes the name of an autoscale group plugin. A group plugin cannot have the same name as another group plugin associated with the same desktop group, however the same name can be reused for group plugins associated with different desktop groups.

Examples

EXAMPLE 1

Renames all autoscale group plugins with the name “Holidays” to “US Holidays”.

Rename-BrokerAutoscaleGroupPlugin -Name "Holidays" -NewName "US Holidays"
<!--NeedCopy-->

EXAMPLE 2

Renames autoscale group plugin with the Uid 1 to “UK Holidays”, showing the result.

Get-BrokerAutoscaleGroupPlugin -Uid 1 | Rename-BrokerAutoscaleGroupPlugin -NewName "UK Holidays" -PassThru
<!--NeedCopy-->

Parameters

-InputObject

Specifies the autoscale group plugin to rename.

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

-Name

Specifies the name of the autoscale group plugin to rename. Because multiple group plugins can have the same name, even a non-wildcarded name may rename multiple group plugins.

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

-NewName

Specifies the new name of the autoscale group plugin.

A group plugin cannot have the same name as another group plugin associated with the same desktop group, however the same name can be reused for group plugins associated with different desktop groups.

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

You can pipe autoscale group plugins to Rename-BrokerAutoscaleGroupPlugin.

Outputs

None or Citrix.Broker.Admin.SDK.AutoscaleGroupPlugin

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

Rename-BrokerAutoscaleGroupPlugin