Get-HypHypervisorPlugin
Gets the available hypervisor types.
Syntax
Get-HypHypervisorPlugin
[-ZoneUid <Guid>]
[-IncludeUnavailable <Boolean>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Use this command to retrieve a list of all the available hypervisor types, and their localized names.
Examples
EXAMPLE 1
Get the available hypervisor management plug-ins.
Get-HypHypervisorPlugin | Format-Table -AutoSize
ConnectionType DisplayName PluginFactoryName UsesCloudInfrastructure CitrixVerified
-------------- ----------- ----------------- ----------------------- --------------
SCVMM Microsoft virtualization MicrosoftPSFactory False True
VCenter VMware virtualization VmwareFactory False True
XenServer XenServer XenFactory False True
EXAMPLE 2
Get the available hypervisor management plug-ins for the zone with the specified ZoneUid.
Get-HypHypervisorPlugin -ZoneUid 2534080e-9226-4af2-a2fc-ec6be14f9552
EXAMPLE 3
Get all Citrix supported hypervisor plug-ins for the specified ZoneUid.
Get-HypHypervisorPlugin -ZoneUid 2534080e-9226-4af2-a2fc-ec6be14f9552 -IncludeUnavailable $true
Parameters
-ZoneUid
ID of the Zone
| 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
Outputs
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.
UsesCloudInfrastructure \<Boolean\>
Specifies whether or not the underlying hypervisor plug-in factory employs cloud-hosted infrastructure.
CitrixVerified \<Boolean\>
Specifies whether or not the underlying hypervisor plug-in is verified by Citrix.
Notes
To use 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 can result in unpredictable behavior, especially during service failover conditions.
In the case of failure the following errors can result.
Error Codes
DatabaseError
An error occurred in the service while attempting a database operation.
CommunicationError
An error occurred while 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.