New-BrokerAutoscaleGroupPlugin
Introduced in: Citrix Virtual Apps and Desktop 7 2411
Creates an association between a desktop group and an autoscale plugin.
Syntax
New-BrokerAutoscaleGroupPlugin
[-AutoApprove <Boolean>]
[-AutoscalePluginUid] <Int32>
[-Configuration <String>]
[-Description <String>]
[-DesktopGroupUid] <Int32>
[-Enabled <Boolean>]
[-Name] <String>
[-Priority <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Creates 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
Associates autoscale plugin 7 with the desktop group called "Sales". The group plugin is created at priority 3 for that desktop group.
$financeDg = Get-BrokerDesktopGroup "Sales"
New-BrokerAutoscaleGroupPlugin -DesktopGroupUid $financeDg.Uid -AutoscalePluginUid 7 -Name "Holidays" -Priority 3
EXAMPLE 2
Creates a group plugin association called "Christmas Holiday" between desktop group 3 and autoscale plugin 2. The group plugin is created at priority 2 for that desktop group and using the specified JSON configuration string. Configurtion string formats are specific to the autoscale plugin being used, the value shown here is purely an example.
New-BrokerAutoscaleGroupPlugin "Christmas Holiday" 3 2 -Priority 2 -Configuration '{"Holidays":["2024-12-25"]}'
Parameters
-Name
The name of the group plugin. The name must be unique amongst plugins associated with the same desktop group, however the same name may be used multiple times for group plugins associated with different desktop groups.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
| Length range: | 1 to 389 |
| Disallowed characters: | /;:#.*?=<>\|[]()"`' and all ASCII control characters |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-DesktopGroupUid
The UID of the desktop group with which to associate the plugin.
| Type: | Int32 |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-AutoscalePluginUid
The UID of the autoscale plugin that is to be associated with the desktop group.
| Type: | Int32 |
| Position: | 4 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| 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: | Copied from the BrokerAutoscalePlugin object having the specified AutoscalePluginUid. |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-Configuration
An 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: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-Description
An optional description for the group plugin.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
| 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: | True |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-Priority
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, and the new group plugin is added with the specified priority.
If not specified, group plugins are added with a priority of 1, the highest priority.
| Type: | Int32 |
| Position: | Named |
| Default value: | 1 |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| 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
None
You cannot pipe input into this cmdlet.
Outputs
Citrix.Broker.Admin.SDK.AutoscaleGroupPlugin
The newly created autoscale group plugin object.