Set-BrokerAutoscaleGroupPlugin
Modifies an association between a desktop group and an autoscale plugin.
Syntax
Set-BrokerAutoscaleGroupPlugin
[-InputObject] <AutoscaleGroupPlugin[]>
[-PassThru]
[-ApprovedUntil <String>]
[-AutoApprove <Boolean>]
[-Configuration <String>]
[-Description <String>]
[-Enabled <Boolean>]
[-Priority <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerAutoscaleGroupPlugin
[-Name] <String>
[-PassThru]
[-ApprovedUntil <String>]
[-AutoApprove <Boolean>]
[-Configuration <String>]
[-Description <String>]
[-Enabled <Boolean>]
[-Priority <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Modifies an association between a desktop group and an autoscale plugin (an autoscale 'group plugin'). Group plugins are used to dynamically override certain aspects of a desktop group's autoscale and power policy settings on a day-by-day basis.
A single desktop group can be associated with multiple autoscale plugins. This is represented by multiple group plugin objects. Each group plugin has a priority that is unique amongst those for the same desktop group, and determines the order in which they are queried for autoscale schedule overrides.
Examples
EXAMPLE 1
Sets the priority of the autoscale group plugin with UID 3 to be 2. If there is already a group plugin with priority 2 for the same desktop group, it, and other lower priority group plugins for that desktop group have their priorities lowered as needed to make way for the group plugin being modified.
Set-BrokerAutoscaleGroupPlugin 3 -Priority 2
EXAMPLE 2
Sets the JSON configuration string for the autoscale group plugin with UID 4. Configurtion string formats are specific to the autoscale plugin being used, the value shown here is purely an example.
Set-BrokerAutoscaleGroupPlugin -Uid 4 -Configuration '{"Holidays":["2024-01-01","2024-12-25"]}'
Parameters
-InputObject
The autoscale group plugin to be modified.
| Type: | AutoscaleGroupPlugin[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
Name of the autoscale group plugins to be modified. Because the same name may be used for plugins associated with different desktop groups, even a non-wildcarded name may match multiple group plugins.
| 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 |
-ApprovedUntil
If AutoApprove is False, specifies the date until which any schedule override produced by the plugin is automatically accepted as the schedule for the target date. See AutoApprove for more information.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AutoApprove
If True, indicates that any schedule override produced by the plugin is automatically accepted as the schedule for the target date. Otherwise the schedule is only accepted if the target date is on or before the date specified in ApprovedUtil. If AutoApprove is False and the ApprovedUtil date is not set, or is in the past, then any schedule override produced is discarded without being used.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Configuration
Sets the optional plugin-specific JSON configuration string to be passed to the autoscale plugin whenever it is queried for a schedule override for the desktop group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Sets the optional description for the group plugin.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Disallowed characters: | All ASCII control characters |
-Enabled
Specifies whether the group plugin is enabled. A disabled group plugin is not queried for schedule overrides.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Priority
Sets the priority of the group plugin with respect to other group plugins associated with the same desktop group. Priority 1 is the highest priority.
If a group plugin for the same desktop group already exists with the same priority, then that one and any lower priority group plugins have their priorities reduced as needed to make way for the group plugin being modified.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| 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
The autoscale group plugin to be modified.
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.