Citrix Virtual Apps and Desktops SDK

Get-BrokerProjectedAutoscaleMachines

Introduced in: Citrix Virtual Apps and Desktop 7 2212

Gets the projected number of machines that Autoscale will keep powered on over the specified period

Syntax

Get-BrokerProjectedAutoscaleMachines
   [-DesktopGroupUid] <Int32>
   [-FromDate <String>]
   [-NumberOfDays <Int32>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Get-BrokerProjectedAutoscaleMachines cmdlet retrieves the projected number of machines that Autoscale will keep powered on for each half hour over a specified period.

————————– BrokerProjectedAutoscaleMachines Object

The projected Autoscale machines object returned represents the detailed projection of the number of machines that Autoscale will keep powered on for each half hour over a specified period.

  • DesktopGroupUid (System.Int32)

    The UID of the desktop group

  • ManagedMachineCount (System.Int32)

    The number of machines in the desktop group that would be managed by Autoscale.

  • ProjectedMachines (System.String)

    The number of machines that Autoscale will keep powered on for each half hour over the specified period.

Examples

Parameters

-DesktopGroupUid

Gets projected Autoscale machines in the specified desktop group.

Type: Int32
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-FromDate

Gets projected Autoscale machines for the period starting at the specified date (YYYY-MM-DD).

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-NumberOfDays

Gets projected Autoscale machines for the period consisting of the specified number of days.

Type: Int32
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.ProjectedAutoscaleMachines

Get-BrokerProjectedAutoscaleMachines returns a ProjectedAutoscaleMachines object.

Get-BrokerProjectedAutoscaleMachines