Citrix Virtual Apps and Desktops SDK

Update-Hyphypervisorconnection

July 4, 2023

Contributed by:

Requests the host service to update the connection properties that depend on the version of hypervisor in use.

Syntax

Update-HypHypervisorConnection [-LiteralPath] <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Use this command to update the version-specific properties of a hypervisor connection, after an upgrade to the hypervisor system which may provide new capabilities.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
LiteralPath	Specifies the path within a Host Service provider to the hypervisor connection item to be updated. The path specified must be in one of the following formats; :\Connections\ or :\Connections{HypervisorConnection Uid>}	true	true (ByValue)
LoggingId	Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminAddress	Specifies the address of a XenDesktop controller that the PowerShell snap-in 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.

Input Type

Return Values

Notes

In the case of failure, the following errors can result.
Error Codes
———–
InvalidPath
The path provided is not in the required format.
HypervisorInMaintenanceMode
The hypervisor is in maintenance mode and cannot be updated.
DatabaseError
An error occurred in the service while attempting a database operation.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
DataStoreException
An error occurred in the service while attempting a database operation - communication with the database failed for
various reasons.
CommunicationError
An error occurred while communicating with the service.
PermissionDenied
The user does not have administrative rights to perform this operation.
ExceptionThrown
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.

Examples

Example 1

c:\PS>Update-HypHypervisorConnection -LiteralPath xdhyp:\connections\Connection1
<!--NeedCopy-->

Description

This command requests that the properties of Connection1 be updated to match the current capabilities of the hypervisor.

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

Update-Hyphypervisorconnection

July 4, 2023

Contributed by:

July 4, 2023

Contributed by:

Update-Hyphypervisorconnection

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Notes

Examples

Example 1

Description

In this article