Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-BrokerHypervisorConnectionStatus

March 11, 2024
Contributed by: 
C

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

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

-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

-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

-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

-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

-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

-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

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.

Get-BrokerHypervisorConnectionStatus
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.