Citrix Virtual Apps and Desktops SDK

Reset-BrokerHypervisorConnection

August 3, 2023

Contributed by:

Reset the hypervisor connection

Syntax

Reset-BrokerHypervisorConnection [[-HypervisorConnectionUid] <Int32>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Reset-BrokerHypervisorConnection [-InputObject] <HypervisorConnection> [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Requests the hypervisor connection to be reset. The connection is dropped, details including credentials refreshed and the connection re-established. The reset request is asynchronous and may take a moment to occur

Parameters

Name	Description	Required?	Pipeline Input	Default Value
InputObject	Specifies the hypervisor connection object to remove.	true	true (ByValue)
HypervisorConnectionUid	Specifies the hypervisor connection Uid	false	false
AdminClientIP	Internal use only.	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
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

Input Type

Citrix.Broker.Admin.Sdk.Hypervisorconnection

You can pipe the hypervisor connection to be reset to Reset-BrokerHypervisorConnection.

Return Values

None

Examples

Example 1

C:\PS> Reset-BrokerHypervisorConnection -HypervisorConnectionUid 2

<!--NeedCopy-->

Description

This command resets the specified Hypervisor connection by internal Uid

Example 2

C:\PS> Get-HypervisorConnection | Reset-BrokerHypervisorConnection

<!--NeedCopy-->

Description

This command resets the piped in 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

Reset-BrokerHypervisorConnection

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Reset-BrokerHypervisorConnection

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Broker.Admin.Sdk.Hypervisorconnection

Return Values

None

Examples

Example 1

Description

Example 2

Description

In this article