Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Update-HypHypervisorConnection

March 11, 2024
Contributed by: 
C

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>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <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  
AdminClientIP Specifies the client IP of 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  
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.

  • 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.

Update-HypHypervisorConnection
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.