Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Remove-BrokerAutoscalePlugin

August 9, 2024
Contributed by: 
C

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Removes an autoscale plugin from the site.

Syntax

Remove-BrokerAutoscalePlugin
      [-InputObject] <AutoscalePlugin[]>
      [-Force]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-BrokerAutoscalePlugin
      [-Force]
      [-Name] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Removes an existing autoscale plugin from the site.

Prior to removing a plugin it must be uninstalled from all controllers within the site, failure to do this results in the plugin being added back as soon as any controller is restarted.

If a plugin is currently configured to provide schedule overrides for any desktop group then the -Force switch must be used to remove the plugin.

Examples

EXAMPLE 1

Removes the autoscale plugin with a Uid of 4 from the site.

Remove-BrokerAutoscalePlugin 4
<!--NeedCopy-->

Parameters

-InputObject

The autoscale plugin to be removed from the site.

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 removed from the site.

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

-Force

Used to forcibly remove a plugin from the site even it is currently configured to provide schedule overrides for any desktop group.

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

The autoscale plugin to be removed from the site.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerAutoscalePlugin
August 9, 2024
Contributed by: 
C
August 9, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.