-
-
-
-
-
Get-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!
Get-BrokerAutoscaleGroupPlugin
Gets associations between desktop groups and autoscale plugins
Syntax
Get-BrokerAutoscaleGroupPlugin
[-AutoscalePluginName <String>]
[-AutoscalePluginUid <Int32>]
[-Configuration <String>]
[-Description <String>]
[-DesktopGroupName <String>]
[-DesktopGroupUid <Int32>]
[-Enabled <Boolean>]
[-Metadata <String>]
[-Priority <Int32>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Get-BrokerAutoscaleGroupPlugin
-Uid <Int32>
[-Property <String[]>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Returns associations between desktop groups and autoscale plugins (autoscale ‘group plugins’) using the specified search criteria. If no search criteria are specified, all autoscale group plugins are obtained.
Autoscale group plugins represent an association between a desktop group and an autoscale plugin. They 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.
————————– BrokerAutoscaleGroupPlugin Object
The BrokerAutoscaleGroupPlugin object represents an association between a desktop group and an autoscale plugin. It contains the following properties:
-
AutoscalePluginName (System.String)
The name of the autoscale plugin associated with this group plugin.
-
AutoscalePluginUid (System.Int32)
The unique ID of the autoscale plugin associated with this group plugin.
-
Configuration (System.String)
Configuration data expressed as a JSON string that is passed to the group plugin when it is queried to provide a schedule override for the associated desktop group.
-
Description (System.String)
Optional description of the group plugin. The description is purely informational and does not alter the behavior of the plugin in any way.
-
DesktopGroupName (System.String)
The name of the desktop group associated with this group plugin.
-
DesktopGroupUid (System.Int32)
The unique ID of the desktop group associated with this group plugin.
-
Enabled (System.Boolean)
Specifies whether the group plugin is enabled. When disabled the plugin is not queried for schedule overrides relating to the group.
-
MetadataMap (System.Collections.Generic.Dictionary<string, string>)
A collection of arbitrary key/value pairs that can be associated with the group plugin. The administrator can use these values for any purpose; they are not used by the site itself in any way.
-
Priority (System.Int32)
The priority of this group plugin with respect to other group plugins associated with the same desktop group. Priority 1 is the highest priority. When obtaining schedule overrides for a given desktop group, each associated group plugin is queried in priority order until one returns a schedule override at which point the process terminates for that group.
-
Uid (System.Int32)
The unique ID of the desktop group associated with this group plugin.
Examples
EXAMPLE 1
Returns all autoscale group plugins associated with the desktop group called “Sales” and lists them in the order in which they will be queried for schedule overrides.
Get-BrokerAutoscaleGroupPlugin -DesktopGroupName Sales -SortBy Priority
<!--NeedCopy-->
EXAMPLE 2
Returns all autoscale group plugins that include the text “Owner:Joe” in their descriptions.
Get-BrokerAutoscaleGroupPlugin -Description "*Owner:Joe*"
<!--NeedCopy-->
Parameters
-Uid
Gets only the group plugin with the specified Uid.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AutoscalePluginName
Gets only group plugins using autoscale plugins with names matching the specified pattern.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-AutoscalePluginUid
Gets only group plugins using the specified autoscale plugin.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Configuration
Gets only group plugins with configuration data matching the specified pattern.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Description
Gets only group plugins with descriptions matching the specified pattern.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-DesktopGroupName
Gets only group plugins associated with desktop groups having names matching the specified pattern.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-DesktopGroupUid
Gets only group plugins associated with the specified desktop group.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Enabled
Gets only group plugins in the specified enabled state.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Metadata
Gets records with matching metadata entries.
The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Priority
Gets only group plugins having the specified priority.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReturnTotalRecordCount
When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxRecordCount
Specifies the maximum number of records to return.
| Type: | Int32 |
| Position: | Named |
| Default value: | 250 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SortBy
Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.
| Type: | String |
| Position: | Named |
| Default value: | The default sort order is by name or unique identifier. |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterScope
Gets only results allowed by the specified scope id.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Property
Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.
| Type: | String[] |
| 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
Get-BrokerAutoscaleGroupPlugin returns all group plugins that match the specified selection criteria.
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.