Product Documentation


Nov 06, 2015

Add a connection address to a hypervisor connection.


Add-HypHypervisorConnectionAddress [-LiteralPath] <String> [-HypervisorAddress] <String> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

This provides the ability to add addresses by which a hypervisor can be contacted. All the addresses added to a single hypervisor connection are assumed to be equivalent (i.e. they all result in the ability to communicate with the same hypervisors). The hypervisor that the addresses reference is stored at the point of creation of the hypervisor connection. Once this is done all addresses must resolve to this hypervisor to be valid.

The addresses required are; XenServer - The address of the XenServer machines (must all reference the same XenServer pool). VMWare vSphere/ESX - The address of a vCenter server. Microsoft SCVMM/Hyper-V - the address of an SCVMM server.



Specifies the path within a Host Service provider to the hypervisor connection item to which to add the address. 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? false


Specifies the address to be used. The address will be validated and the hypervisor must be contactable at the address supplied.

XenServer (ConnectionType = XenServer) The address being added must reference the same XenServer pool referenced by any existing addresses for the same connection. VMware vSphere\ESX (ConnectionType = vCenter) The address being added must be to the same VMware vCenter as the existing addresses. SCVMM\Hyper-v (ConnectionType = SCVMM) The address being added must be to the same SCVMM server as the existing addresses. Custom Connection Types ?Validation here I assume none need to check? #PUBS NOTE: ASSUME THIS TO BE UPDATED?#

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)


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


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

Return Values


Add-HypHypervisorConnectionAddress returns an object containing the new definition of the hypervisor connection.

HypervisorConnectionUid <Guid>

Specifies the unique identifier for the hypervisor connection.

HypervisorConnectionName <string>

Specifies the name of the hypervisor connection.

ConnectionType <Citrix.XDInterServiceTypes.ConnectionType>

Specifies the connection type of the connection.

XenServer - A Citrix XenServer hypervisor

SCVMM - A Microsoft SCVMM/Hyper-V hypervisor

vCenter - A VMWare vSphere/ESX hypervisor

Custom - A 3rd party hypervisor

HypervisorAddress <string[]>

A list of addresses that can be used to communicate with the hypervisor.

UserName <string>

The user name that is used when connecting to the hypervisor.

Persistent <Boolean>

Indicates whether the connection is stored in the database or is only a temporary connection that has the same lifetime as the current Powershell session.

PlugInId <string>

The Citrix identifier for the Citrix Machine Management plug-in.

Revision <Guid>

Identifier for the current version of the hypervisor connection. This value changes every time a property of the hypervisor connection is updated.

SupportsPvsVMs <Boolean>

Indicates whether the connection can be used as part of a hosting unit and therefore used by the Citrix XenDesktop Machine Creation Services to create virtual machines. Only the built-in supported hypervisor connection types can be used for this (i.e. XenServer, SCVMM and vCenter).

Metadata <Citrix.Host.Sdk.Metadata[]>

A list of key value pairs that can store additional information relating to the hosting unit.


The address format must be valid for the hypervisor connection. The rules that are applied are as below: XenServer (HypervisorConnection Type = XenServer)

http:\\<IP Address>

or http:\\<server Name>

or https:\\<server Name>

Note: To use multiple addresses to the same XenServer pool in order to provide failover functionality, all the XenServers in the pool must have a shared block storage device. If using https connections and failover is required, the certificates on the servers must be trusted by all of the controllers (typically this means having a root certificate installed).

VMWare vSphere/ESX (HypervisorConnection Type = vCenter)

http:\\<IP Address>\<sdk path>

http:\\<server Name>\<sdk path>

or https:\\<Server Name>\<sdk path>


* Http requires manual vCenter configuration; https is the only supported default format.

* Default sdk path is 'sdk'

Microsoft SCVMM/Hyper-v (HypervisorConnection Type = SCVMM)

IP Address

server Name (short or FQDN)

Note: If XenServers are moved to new XenServer pools after being added to a hypervisor connection, unpredictable results will occur. Once a XenServer is assigned to a hypervisor connection it should not be moved to a new XenServer pool.

In the case of failure the following errors can be produced.

Error Codes



The path provided is not to an item in a sub directory of a hosting unit item.


The hypervisor connection to which the address is to be added could not be located.


The address could not be used to contact a hypervisor or the validation rules have not been met.


The address specified is already part of the hypervisor connection.


The hypervisor for the connection is in maintenance mode.


An error occurred in the service whilst attempting a database operation.


The operation could not be completed as the database for the service is not configured.


An error occurred in the service whilst attempting a database operation - communication to database failed for

for various reasons.


An error occurred whilst communicating with the service.


The user does not have administrative rights to perform this operation.


An unexpected error occurred. To locate more details see the Windows event logs on the controller being used, or examine the XenDesktop logs.


-------------------------- EXAMPLE 1 --------------------------

c:\PS>Add-HypHypervisorConnectionAddress -LiteralPath XDHyp:\Connections\MyConnection -HypervisorAddress http:\\ 
PSPath                   : Citrix.HostingUnitService.Admin.V1.0\Citrix.Hypervisor::XDHyp:\Connections\MyConnection  
PSParentPath             : Citrix.HostingUnitService.Admin.V1.0\Citrix.Hypervisor::XDHyp:\Connections 
PSChildName              : MyConnection  
PSDrive                  : XDHyp 
PSProvider               : Citrix.HostingUnitService.Admin.V1.0\Citrix.Hypervisor 
PSIsContainer            : True 
HypervisorConnectionUid  : 85581f42-c5da-4976-970c-ebc3448ea1e3 
HypervisorConnectionName : MyConnection  
ConnectionType           : XenServer 
HypervisorAddress        : {http:\\,http:\\} 
UserName                 : root 
Persistent               : False 
PluginId                 : XenFactory 
SupportsPvsVMs           : True 
Revision                 : 4c95c857-c54d-4f92-abef-0cce32c02502 
Metadata                 :

Add the address 'http:\\' to the hypervisor connection called "MyConnection".