Update-HypHypervisorConnection
Requests the host service to update the connection properties that depend on the version
of hypervisor in use.
Syntax
Update-HypHypervisorConnection
[-LoggingId <Guid>]
[-LiteralPath] <String>
[<CitrixCommonParameters>]
[<CommonParameters>]
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.
Examples
EXAMPLE 1
This command requests that the properties of Connection1 be updated to match the current capabilities of the hypervisor.
Update-HypHypervisorConnection -LiteralPath xdhyp:\connections\Connection1
Parameters
-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; \<drive\>:\Connections\\\<HypervisorConnectionName\> or \<drive\>:\Connections\{HypervisorConnection Uid\>}
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-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.
| Type: | Guid |
| Position: | Named |
| 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
None
You can't pipe objects to this cmdlet.
Outputs
None
By default, this cmdlet returns no output.
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.