-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
Get-BrokerHypervisorConnection
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-BrokerHypervisorConnection
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 |
-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 |
-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 |
-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 |
-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 |
| 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 |
-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 |
-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 |
-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 |
-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 |
-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.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.