Skip to content
Was this article helpful?

Get-BrokerHypervisorConnectionStatus

Gets connection status and power management stats for the hypervisor.

Syntax

Get-BrokerHypervisorConnectionStatus [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-Property <String[]>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Detailed Description

The GetBrokerHypervisorConnectionStatus cmdlet retrieves the power management statistics and connection status for all hypervisors on the DDC

Brokerhypervisorconnectionstatus Object

Retrieves power management statistics and connection status for all hypervisors on the DDC

  • CredentialsValid (System.Boolean?) Indicates whether the credentials are valid or not

  • HclCurrentlyConnected (System.Boolean?) Indicates whether HCL is currently connected

  • HypervisorConnectionGuid (System.Guid?) Gives the hypervisor connection GUID

  • HypervisorConnectionUid (System.Int32) Gives the hypervisor connection UID

  • HypervisorType (System.String) Type of hypervisor connection

  • HypervisorZone (System.Guid?) Zone of the hypervisor connection

  • InMaintenanceMode (System.Boolean?) Indicates whether the hypervisor is in maintenance mode or not

  • InProgressActions (System.Int32?) Number of power actions in progress

  • LastActionCompletedTime (System.DateTime?) Time when the last power action completed

  • LastActionFailedTime (System.DateTime?) Time when the last power action failed

  • LastActionStartTime (System.DateTime?) Time when the last power action started

  • LastMachineManagerCreationTime (System.DateTime?) Time when the last machine manager was created

  • LastPowerStateUpdateEventTime (System.DateTime?) Time when the last power state update event was created

  • LastPowerStateUpdateTime (System.DateTime?) Time when the power state was last updated

  • LastSiteServiceStartTime (System.DateTime?) Time when site services last started

  • LastToolStateUpdateEventTime (System.DateTime?) Time when the last tool state update event was created

  • LastToolStateUpdateTime (System.DateTime?) Time when the last tool state was updated

  • NextPendingAction (System.Int64?) The next pending power action

  • PendingActions (System.Int32?) Number of pending power actions

  • TotalMachineManagersCreated (System.Int32?) Number of machine managers created

  • TotalMachineManagersFailed (System.Int32?) Number of machine managers which failed

  • TotalMachines (System.Int32?) Total number of machines present in the connection

Parameters

Name Description Required? Pipeline Input Default Value
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. 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
AdminClientIP Internal use only. 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
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. false false False
MaxRecordCount Specifies the maximum number of records to return. false false 250
Skip Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. false false 0
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. false false The default sort order is by name or unique identifier.
Filter Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details. false false
FilterScope Gets only results allowed by the specified scope id. false false

Input Type

None

Return Values

Citrix.Broker.Admin.Sdk.Getbrokerhypervisorconnectionstatus

Get-BrokerHypervisorConnectionStatus returns an object for each hypervisor connection present in the DDC.

Was this article helpful?