Remove-BrokerAutoscaleGroupPlugin
Introduced in: Citrix Virtual Apps and Desktop 7 2411
Removes an association between a desktop group and an autoscale plugin
Syntax
Remove-BrokerAutoscaleGroupPlugin
[-InputObject] <AutoscaleGroupPlugin[]>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-BrokerAutoscaleGroupPlugin
[-Name] <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Removes an association between a desktop group and an autoscale plugin (an autoscale 'group plugin').
Multiple associations can exist between the same desktop group and a single autoscale plugin each using different priorities. This cmdlet only removes the specified association, any other associations between the group and the same plugin, or between the group and other plugins remain.
If the group plugin provided the currently active schedule override, or a pending schedule override for the next day, those overrides are not removed and still take effect.
Examples
EXAMPLE 1
Removes all autoscale plugin associations with the desktop group named "Finance".
Get-BrokerAutoscaleGroupPlugin -DesktopGroupName "Finance" | Remove-BrokerAutoscaleGroupPlugin
Parameters
-InputObject
The autoscale group plugin to be removed.
| Type: | AutoscaleGroupPlugin[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
Name of the autoscale group plugin to be removed.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-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
The autoscale group plugin to be removed.
Outputs
None
By default, this cmdlet returns no output.