- about_HypHostSnapin
- about_Hyp_Filtering
- Add-HypHostingUnitMetadata
- Add-HypHostingUnitNetwork
- Add-HypHostingUnitStorage
- Add-HypHypervisorConnectionAddress
- Add-HypHypervisorConnectionMetadata
- Add-HypHypervisorConnectionScope
- Add-HypMetadata
- Get-HypConfigurationDataForItem
- Get-HypConfigurationObjectForItem
- Get-HypDBConnection
- Get-HypDBSchema
- Get-HypDBVersionChangeScript
- Get-HypHypervisorPlugin
- Get-HypInstalledDBVersion
- Get-HypScopedObject
- Get-HypService
- Get-HypServiceAddedCapability
- Get-HypServiceInstance
- Get-HypServiceStatus
- Get-HypVMMacAddress
- Get-HypXenServerAddress
- New-HypVMSnapshot
- Remove-HypHostingUnitMetadata
- Remove-HypHostingUnitNetwork
- Remove-HypHostingUnitStorage
- Remove-HypHypervisorConnectionAddress
- Remove-HypHypervisorConnectionMetadata
- Remove-HypHypervisorConnectionScope
- Remove-HypMetadata
- Remove-HypServiceMetadata
- Reset-HypServiceGroupMembership
- Set-HypAdminConnection
- Set-HypDBConnection
- Set-HypHostingUnitMetadata
- Set-HypHostingUnitStorage
- Set-HypHypervisorConnectionMetadata
- Set-HypServiceMetadata
- Start-HypVM
- Stop-HypVM
- Test-HypDBConnection
- Test-HypHostingUnitNameAvailable
- Test-HypHypervisorConnectionNameAvailable
- Update-HypHypervisorConnection
Update-HypHypervisorConnection
Nov 17, 2015
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>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description
Allows the version specific properties of a hypervisor conenction to be updated after an upgrade to the hypervisor system which may provide new capabilities.
Related topics
Parameters
-LiteralPath<String>
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>}
| Required? | true |
| Default Value | |
| Accept Pipeline Input? | true (ByValue) |
-LoggingId<Guid>
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.
| Required? | false |
| Default Value | |
| Accept Pipeline Input? | false |
-AdminAddress<String>
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.
| Required? | false |
| Default Value | LocalHost. Once a value is provided by any cmdlet, this value will become the default. |
| Accept Pipeline Input? | false |
Notes
In the case of failure the following errors can be produced.
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 whilst attempting a database operation.
DatabaseNotConfigured
The operation could not be completed as the database for the service is not configured.
DataStoreException
An error occurred in the service whilst attempting a database operation - communication to database failed for
for various reasons.
CommunicationError
An error occurred whilst 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
This command requests that the properties of Connection1 be updated to match the current capabilities of the hypervisor.