Get-BrokerAutoscaleSchedule

Last published : Oct 31, 2026
Introduced in: Citrix Virtual Apps and Desktop 7 2603
Gets the Autoscale schedule for a specified desktop group or group plugin.
Related information
about_Broker_AccessPolicy

Syntax

Get-BrokerAutoscaleSchedule
   [-DesktopGroupUid] <Int32>
   [-ForDate <String>]
   [-Day <String>]
   [-Today]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-BrokerAutoscaleSchedule
   [-GroupPluginUid] <Int32>
   -ForDate <String>
   [<CitrixCommonParameters>]
   [<CommonParameters>]

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

EXAMPLE 2

Returns the autoscale schedule for the specified desktop group and today's date.
Get-BrokerAutoscaleSchedule -DesktopGroupUid $dgId -Today

EXAMPLE 3

Returns the autoscale schedule for the specified desktop group and date.
Get-BrokerAutoscaleSchedule -DesktopGroupUid $dgId -ForDate $date

EXAMPLE 4

Returns the autoscale schedule for the specified desktop group and day of the week.
Get-BrokerAutoscaleSchedule -DesktopGroupUid $dgId -Day $dayOfWeek

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.