Set-BrokerAutoscalePlugin

Last published : Oct 31, 2026
Modifies an existing autoscale plugin
Related information
about_Broker_AccessPolicy

Syntax

Set-BrokerAutoscalePlugin
   [-InputObject] <AutoscalePlugin[]>
   [-PassThru]
   [-Description <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-BrokerAutoscalePlugin
   [-Name] <String>
   [-PassThru]
   [-Description <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

The Set-BrokerAutoscalePlugin cmdlet is used to modify properties of an existing autoscale plugin.
Autoscale plugins are used to dynamically override certain aspects of a desktop group's autoscale and power policy settings on a day-by-day basis.

Examples

EXAMPLE 1

Changes the description associated with the autoscale plugin with Uid 2.
Set-BrokerAutoscalePlugin -InputObject 2 -Description "Turns off VDAs during company holidays"

Parameters

-InputObject

The autoscale plugin to be modified.
Type: AutoscalePlugin[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The name of the autoscale plugin to be modified.
Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-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

-Description

Specifies the new description to use for the autoscale plugin.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Disallowed characters: All ASCII control characters

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

The autoscale plugin to be to be modified.

Outputs

None or Citrix.Broker.Admin.SDK.AutoscalePlugin

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