Citrix Virtual Apps and Desktops SDK

Reset-BrokerHypervisorConnection

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.

Reset-BrokerHypervisorConnection