-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
Get-BrokerAutoscaleSchedule
-
-
-
-
-
-
-
-
-
-
-
-
-
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-BrokerAutoscaleSchedule
Introduced in: Citrix Virtual Apps and Desktop 7 2603
Gets the Autoscale schedule for a specified desktop group or group plugin.
Syntax
Get-BrokerAutoscaleSchedule
[-DesktopGroupUid] <Int32>
[-ForDate <String>]
[-Day <String>]
[-Today]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Get-BrokerAutoscaleSchedule
[-GroupPluginUid] <Int32>
-ForDate <String>
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
The Get-BrokerAutoscaleSchedule cmdlet retrieves the schedule that an Autoscale Plugin would generate for a future date.
————————– BrokerAutoscaleSchedule Object
The Autoscale schedule object returned represents the schedule that an Autoscale Plugin would generate for a future date.
-
Approved (System.Boolean?)
The approval status of the schedule. Indicates whether the schedule has been approved.
-
AutomaticPowerOnForAssigned (System.Boolean)
Specifies whether assigned desktops in the desktop group that are either off or suspended at the start of a peak time period are automatically restarted. Only relevant for groups whose DesktopKind is Private.
-
AutomaticPowerOnForAssignedDuringPeak (System.Boolean)
Specifies whether assigned desktops in the desktop group that are found to be off at any point during a peak time are automatically restarted. Only relevant for groups whose DesktopKind is Private and which have AutomaticPowerOnForAssigned set to true. This setting applies only to machines that are off, not suspended.
-
AutoscaleGroupPluginUid (System.Int32?)
The UID of the group plugin associated with the desktop group.
-
AutoscalePluginUid (System.Int32?)
The UID of the Autoscale Plugin that generated the schedule.
-
BufferSizeHalfHours (System.Int32[])
The percentage of single-session machines that are kept available in an idle state, or for multi-session machines, the percentage of the total load capacity to be kept available in an idle state, for each half hour period.
-
Date (System.String)
The date for which the schedule is generated.
-
DayOfWeek (System.String)
The day of the week for which the schedule is generated, such as “Monday”, “Tuesday”, etc.
-
DeliveryType (System.String)
The type of resources being published. Possible values are: DesktopsOnly, AppsOnly, DesktopsAndApps.
-
DesktopGroupUid (System.Int32)
The UID of the desktop group
-
ModifiedByPlugin (System.Boolean)
Indicates if the schedule was modified by a plugin.
-
PeakHalfHours (System.Boolean[])
The number of peak half-hour periods.
-
PoolSizeHalfHours (System.Int32[])
The pool size for each half hour period.
-
PoolSizeValuesArePercentages (System.Boolean?)
Indicates if pool size values are percentages.
-
RestrictToTagUid (System.Int32?)
If set to a Tag UID, only machines that have this tag will be auto scaled.
-
SessionSupport (System.String)
Specifies the session support (single/multi) of the machines in the desktop group. Machines with the incorrect session support for the desktop group will be unable to register with the Citrix Broker Service.
Examples
EXAMPLE 1
Returns the autoscale schedule for the specified group plugin and date.
Get-BrokerAutoscaleSchedule -GroupPluginUid $gpId -ForDate $date
<!--NeedCopy-->
EXAMPLE 2
Returns the autoscale schedule for the specified desktop group and today’s date.
Get-BrokerAutoscaleSchedule -DesktopGroupUid $dgId -Today
<!--NeedCopy-->
EXAMPLE 3
Returns the autoscale schedule for the specified desktop group and date.
Get-BrokerAutoscaleSchedule -DesktopGroupUid $dgId -ForDate $date
<!--NeedCopy-->
EXAMPLE 4
Returns the autoscale schedule for the specified desktop group and day of the week.
Get-BrokerAutoscaleSchedule -DesktopGroupUid $dgId -Day $dayOfWeek
<!--NeedCopy-->
Parameters
-DesktopGroupUid
Gets Autoscale schedule for the specified desktop group.
| Type: | Int32 |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GroupPluginUid
Gets Autoscale schedule for the specified group plugin.
| Type: | Int32 |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForDate
Specifies the date (YYYY-MM-DD) for which to retrieve the Autoscale schedule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Day
Specifies the day of the week (e.g., “Monday”) for which to retrieve the Autoscale schedule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Today
Specifies whether to retrieve the Autoscale schedule for today.
| Type: | SwitchParameter |
| 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 can’t pipe objects to this cmdlet.
Outputs
Citrix.Broker.Admin.SDK.AutoscaleSchedule
Get-BrokerAutoscaleSchedule returns a AutoscaleSchedule 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.