Citrix Virtual Apps and Desktops SDK

Get-BrokerProjectedAutoscaleMachines

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>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed 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.

Parameters

Name Description Required? Pipeline Input Default Value
DesktopGroupUid Gets projected Autoscale machines in the specified desktop group. true false  
FromDate Gets projected Autoscale machines for the period starting at the specified date (YYYY-MM-DD). false false  
NumberOfDays Gets projected Autoscale machines for the period consisting of the specified number of days. false false  
AdminClientIP Internal use only. false false  
AdminAddress Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  

Input Type

None

Return Values

Citrix.Broker.Admin.Sdk.Projectedautoscalemachines

Get-BrokerProjectedAutoscaleMachines returns a ProjectedAutoscaleMachines object.

Get-BrokerProjectedAutoscaleMachines