Citrix Virtual Apps and Desktops SDK

Set-BrokerAutoscalePlugin

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Modifies an existing autoscale plugin

Syntax

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

Set-BrokerAutoscalePlugin
   [-Name] <String>
   [-PassThru]
   [-Description <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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"
<!--NeedCopy-->

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.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-BrokerAutoscalePlugin

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Set-BrokerAutoscalePlugin

Syntax

Description

Examples

EXAMPLE 1

Parameters

-InputObject

-Name

-PassThru

-Description

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.Broker.Admin.SDK.AutoscalePlugin

Outputs

None or Citrix.Broker.Admin.SDK.AutoscalePlugin

Related Links

In this article