-
-
-
-
-
New-BrokerAutoscaleGroupPlugin
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
New-BrokerAutoscaleGroupPlugin
Creates an association between a desktop group and an autoscale plugin.
Syntax
New-BrokerAutoscaleGroupPlugin
[-AutoscalePluginUid] <Int32>
[-Configuration <String>]
[-Description <String>]
[-DesktopGroupUid] <Int32>
[-Enabled <Boolean>]
[-Priority <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
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 -Priority 3
<!--NeedCopy-->
EXAMPLE 2
Associates autoscale plugin 2 with desktop group 3. 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 3 2 -Priority 2 -Configuration '{"Holidays":["2024-12-25"]}'
<!--NeedCopy-->
Parameters
-DesktopGroupUid
The UID of the desktop group with which to associate the plugin.
| Type: | Int32 |
| Position: | 2 |
| 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: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-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 |
-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.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.