Product Documentation

Get-HypHypervisorPlugin

Nov 17, 2015

Gets the available hypervisor types.

Syntax

Get-HypHypervisorPlugin [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The provides the ability to retrieve a list of all the available hypervisor types, and their localized names.

Related topics

New-Item

Parameters

-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

Return Values

Citrix.Host.Sdk.HypervisorPlugin

Get-HypHypervisorPlugin returns a list of objects containing the definition of the hypervisor plug-ins.

ConnectionType <Citrix.XDInterServiceTypes.ConnectionType>

The hypervisor connection type. This can be one of the following:

XenServer - Xenserver hypervisor

SCVMM - Microsoft SCVMM/Hyper-v

vCenter - VMWare vSphere/ESX

Custom - a third party hypervisor

DisplayName <string>

The localized display name (localized using the locale of the Powershell snap-in session)

PluginFactoryName <string>

The name of the hypervisor plug-in factory used to manage the hypervisor connections.

Notes

To utilize third party plug-ins, the plug-in assemblies must be installed into the appropriate location on each controller machine that forms part of the Citrix controller site. Failure to do this will result in unpredictable behavior, especially during service failover conditions.

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

Error Codes

-----------

DatabaseError

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

CommunicationError

An error occurred whilst communicating with the service.

InvalidFilter

A filtering expression was supplied that could not be interpreted for this cmdlet.

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> Get-HypHypervisorPlugin | Format-Table -AutoSize 
 
          ConnectionType DisplayName              PluginFactoryName 
          -------------- -----------              ----------------- 
                   SCVMM Microsoft virtualization MicrosoftPSFactory 
                 VCenter VMware virtualization    VmwareFactory 
               XenServer Citrix XenServer         XenFactory

Get the available hypervisor management plug-ins.