Citrix Virtual Apps and Desktops SDK

Get-BrokerHypervisorConnectionStatus

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2106

Gets connection status and power management stats for the hypervisor.

Syntax

Get-BrokerHypervisorConnectionStatus
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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
ZoneHealthy (System.Boolean?)

Indicates whether hypervisor connection zone is healthy or not

Examples

Parameters

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2109

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2109

-MaxRecordCount

Specifies the maximum number of records to return.

Type:	Int32
Position:	Named
Default value:	250
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2109

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2109

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

Type:	String
Position:	Named
Default value:	The default sort order is by name or unique identifier.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2109

-Filter

Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2109

-FilterScope

Gets only results allowed by the specified scope id.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2109

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

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-BrokerHypervisorConnectionStatus

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-BrokerHypervisorConnectionStatus

Syntax

Description

Examples

Parameters

-Property

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Broker.Admin.SDK.GetBrokerHypervisorConnectionStatus

Related Links

In this article