Citrix Virtual Apps and Desktops SDK

Get-BrokerHypervisorConnection

August 9, 2024

Contributed by:

Gets hypervisor connections matching the specified criteria.

Syntax

Get-BrokerHypervisorConnection
   [[-Name] <String>]
   [-ExplicitPreferredController <Boolean>]
   [-ExtraSpinUpTimeSecs <Int32>]
   [-FaultReason <String>]
   [-FaultState <String>]
   [-FaultStateDuration <TimeSpan>]
   [-HypHypervisorConnectionUid <Guid>]
   [-HypHypervisorType <String>]
   [-IsReady <Boolean>]
   [-MachineCount <Int32>]
   [-MaxAbsoluteActiveActions <Int32>]
   [-MaxAbsoluteNewActionsPerMinute <Int32>]
   [-MaxAbsolutePvdPowerActions <Int32>]
   [-MaxPercentageActiveActions <Int32>]
   [-MaxPvdPowerActionsPercentageOfDesktops <Int32>]
   [-Metadata <String>]
   [-PreferredController <String>]
   [-State <HypervisorConnectionState>]
   [-TimeFaultStateEntered <DateTime>]
   [-ZoneExternalUid <Guid>]
   [-ZoneHealthy <Boolean>]
   [-ZoneUid <Guid>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Get-BrokerHypervisorConnection
   [-Uid] <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Get-BrokerHypervisorConnection cmdlet gets hypervisor connections matching the specified criteria. If no parameters are specified this cmdlet enumerates all hypervisor connections.

————————– BrokerHypervisorConnection Object

The BrokerHypervisorConnection represents hypervisor connection object. It contains the following properties:

Capabilities (System.String[])

The set of capabilities as reported by the hypervisor.
ExplicitPreferredController (System.Boolean?)

Whether the PreferredController property was explicity set through the SDK or automatically chosen.
ExtraSpinUpTimeSecs (System.Int32?)

The extra time a VM is allowed to start before it is marked as failed on session launch
FaultReason (System.String)

Detailed fault state description if connection is currently in a fault state.
FaultState (System.String)

Current fault state indicator associsted with hypervisor connection, or ‘None’ if connection is operating normally.
FaultStateDuration (System.TimeSpan?)

Period for which the hypervisor has been in fault state
HypervisorCapabilities (System.String[])

The set of hypervisor capabilities as reported by the hypervisor.
HypHypervisorConnectionUid (System.Guid)

The Guid that identifies the hypervisor connection.
HypHypervisorType (System.String)

The type of hypervisor connected to.
IsReady (System.Boolean)

Indicates that the connection is ready to be used in the configuration of managed machines.
MachineCount (System.Int32)

Count of machines associated with this hypervisor connection.
MaxAbsoluteActiveActions (System.Int32?)

Maximum number of active power actions allowed at any one time (defined in the metadata named ‘Citrix_Broker_MaxAbsoluteActiveActions’ on the hypervisor connection in the Citrix Hosting Service).
MaxAbsoluteNewActionsPerMinute (System.Int32?)

Maximum number of new actions that can be fired off to the hypervisor in any one minute (defined in the metadata named ‘Citrix_Broker_MaxAbsoluteNewActionsPerMinute’ on the hypervisor connection in the Citrix Hosting Service).
MaxAbsolutePvdPowerActions (System.Int32?)

This property is no longer supported.
MaxPercentageActiveActions (System.Int32?)

Maximum percentage of machines on the connection that can have active power actions at any one time (defined in the metadata named ‘Citrix_Broker_MaxPowerActionsPercentageOfDesktops’ on the hypervisor connection in the Citrix Hosting Service).
MaxPvdPowerActionsPercentageOfDesktops (System.Int32?)

This property is no longer supported.
MetadataMap (System.Collections.Generic.Dictionary<string, string>)

Collection of all the metadata associated to the hypervisor connection.
Name (System.String)

The display name of the hypervisor connection.
PreferredController (System.String)

The name of the controller which is preferred to be used, when available, to perform all communication to the hypervisor. The name is in DOMAIN\machine form. A preferred controller may have been automatically chosen when the hypervisor connection was created.
State (Citrix.Broker.Admin.SDK.HypervisorConnectionState)

The state of the hypervisor connection.
TimeFaultStateEntered (System.DateTime?)

Time at which the hypervisor entered fault state
Uid (System.Int32)

Unique internal identifier of hypervisor connection.
ZoneExternalUid (System.Guid?)

The Guid that is the external zone uid of the hypervisor connection.
ZoneHealthy (System.Boolean?)

Health state of the Zone associated with this hypervisor connection.
ZoneUid (System.Guid?)

The Guid that identifies the zone associated with the hypervisor connection.

Examples

EXAMPLE 1

Gets a hypervisor connection by name.

$hvConn = Get-BrokerHypervisorConnection -Name "hvConnectionName"
<!--NeedCopy-->

EXAMPLE 2

Gets hypervisor connections by preferred controller.

$hvConn = Get-BrokerHypervisorConnection -PreferredController "domainName\controllerName"
<!--NeedCopy-->

EXAMPLE 3

Gets hypervisor connection used by a (power managed) machine.

$machine = Get-BrokerMachine -Uid $machineUid
$hvConn = Get-BrokerHypervisorConnection -Uid $machine.HypervisorConnectionUid
<!--NeedCopy-->

Parameters

-Uid

Gets the hypervisor connection with the specified internal id.

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

-Name

Gets hypervisor connections with the specified name.

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

-ExplicitPreferredController

Gets hypervisor connections based on whether their preferred controller was explicitly specified or not

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

-ExtraSpinUpTimeSecs

Gets the extra time a VM is allowed to start before it is marked as failed on session launch

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

-FaultReason

Gets hypervisor connections with fault reasons matching that specified.

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

-FaultState

Gets hypervisor connections with fault states matching that specified.

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

-FaultStateDuration

Period for which the hypervisor has been in fault state

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

-HypHypervisorConnectionUid

Gets hypervisor connections with the specified Guid.

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

-HypHypervisorType

Gets hypervisor connections with the specified value of the hypervisor type.

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

-IsReady

Gets hypervisor connections with the specified value of the IsReady flag.

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

-MachineCount

Gets hypervisor connections with the specified machine count.

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

-MaxAbsoluteActiveActions

Gets hypervisor connections with the specified MaxAbsoluteActiveActions value.

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

-MaxAbsoluteNewActionsPerMinute

Gets hypervisor connections with the specified MaxAbsoluteNewActionsPerMinute value.

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

-MaxAbsolutePvdPowerActions

This property is no longer supported.

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

-MaxPercentageActiveActions

Gets hypervisor connections with the specified MaxPercentageActiveActions value.

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

-MaxPvdPowerActionsPercentageOfDesktops

This property is no longer supported.

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

-Metadata

Gets records with matching metadata entries.

The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.

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

-PreferredController

Gets hypervisor connections with the specified preferred controller. Specify the SAM name of the controller.

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

-State

Gets hypervisor connections with the specified connection state. Values can be can be:

Unavailable - The broker is unable to contact the hypervisor.
InMaintenanceMode - The hosting server is in maintenance mode.
On - The broker is in contact with the hypervisor.

Type:	HypervisorConnectionState
Accepted values:	InMaintenanceMode, On, Unavailable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TimeFaultStateEntered

Time at which the hypervisor entered fault state

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

-ZoneExternalUid

Gets the hypervisor connections with the specified zone external uid.

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 2012

-ZoneHealthy

Health state of the Zone associated with this hypervisor connection.

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

-ZoneUid

Gets the hypervisor connections with the specified zone uid.

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 2012

-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
Introduced in:	Citrix Virtual Apps and Desktop 7 2106

-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

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

Get-BrokerHypervisorConnection returns an object for each matching hypervisor connection.

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

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-BrokerHypervisorConnection

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

Parameters

-Uid

-Name

-ExplicitPreferredController

-ExtraSpinUpTimeSecs

-FaultReason

-FaultState

-FaultStateDuration

-HypHypervisorConnectionUid

-HypHypervisorType

-IsReady

-MachineCount

-MaxAbsoluteActiveActions

-MaxAbsoluteNewActionsPerMinute

-MaxAbsolutePvdPowerActions

-MaxPercentageActiveActions

-MaxPvdPowerActionsPercentageOfDesktops

-Metadata

-PreferredController

-State

-TimeFaultStateEntered

-ZoneExternalUid

-ZoneHealthy

-ZoneUid

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

-Property

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Broker.Admin.SDK.HypervisorConnection

Related Links

In this article