Citrix Virtual Apps and Desktops 2402 SDK


Add a connection address to a hypervisor connection.


   [-LiteralPath] <String>
   [-HypervisorAddress] <String>
   [-LoggingId <Guid>]


Use this command to add addresses by which a hypervisor can be contacted. All 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, to be valid, all addresses must resolve to this hypervisor.

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.



Add the address ‘http:\\’ to the hypervisor connection called “MyConnection”.

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                 :



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;


or <drive>:\Connections{HypervisorConnection Uid>}

Type: String
Position: 1
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: 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.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False


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


This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.


This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.



You can’t pipe objects to this cmdlet.



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 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 a temporary connection only with 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 or not the connection can be used as part of a hosting unit and therefore used by the Citrix XenDesktop Machine Creation Service 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 to provide failover functionality, all XenServers in the pool must have a shared block storage device. If the use of 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).

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

In the case of failure the following errors can result.

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 while attempting a database operation.


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


An error occurred in the service while attempting a database operation - communication with the database failed for

various reasons.


An error occurred while 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.