Citrix Virtual Apps and Desktops SDK

Reset-BrokerHypervisorConnection

August 9, 2024

Contributed by:

Reset the hypervisor connection

Syntax

Reset-BrokerHypervisorConnection
     [[-HypervisorConnectionUid] <Int32>]
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Reset-BrokerHypervisorConnection
     [-InputObject] <HypervisorConnection>
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

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

Examples

EXAMPLE 1

This command resets the specified Hypervisor connection by internal Uid

Reset-BrokerHypervisorConnection -HypervisorConnectionUid 2
<!--NeedCopy-->

EXAMPLE 2

This command resets the piped in hypervisor connection

Get-HypervisorConnection | Reset-BrokerHypervisorConnection
<!--NeedCopy-->

Parameters

-InputObject

Specifies the hypervisor connection object to remove.

Type:	HypervisorConnection
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-HypervisorConnectionUid

Specifies the hypervisor connection Uid

Type:	Int32
Position:	2
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

Citrix.Broker.Admin.SDK.HypervisorConnection

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

Outputs

None

By default, this cmdlet returns no output.

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 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Reset-BrokerHypervisorConnection

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-InputObject

-HypervisorConnectionUid

CitrixCommonParameters

CommonParameters

Inputs

Citrix.Broker.Admin.SDK.HypervisorConnection

Outputs

None

Related Links

In this article