Citrix XenServer

XenServer Management

HQ can monitor the XenServer 4.x family of virtualization hosts.

Plugin Requirements

This plugin requires the use of a 1.5 (or higher) JRE with version 3.2.4 (or higher) of the HQ Agent to function properly.

The requirement for a 1.5 or later JRE is only for the HQ agent being used to proxy the Xen API connection. You need to set HQ_JAVA_HOME on the host running the agent. Assuming that the agent is running on a separate host from your HQ Server, only the agent host is subject to the requirement for a 1.5 or later JRE. If the agent and server are on the same host, you must have a 1.5 or later JRE there, and use HQ_JAVA_HOME to point to it.

On non-Windows systems, set HQ_JAVA_HOME like this:

export HQ_JAVA_HOME= <path to JRE>

Install the Plugin

  1. Download the plugin jar file from: xen-plugin.jar
  2. Follow the plugin deployment instructions in the HQ Documentation

Configure a Single XenServer in HQ

Follow these instructions to monitor a single XenServer.  To monitor a pool of XenServers, see Configure a Pool of XenServers in HQ

  1. In the HQ Portal, click [*New Platform*] (link on Browse Resources or Dashboard)
    1. Enter a name for your Xen server.
    2. Select Xen Host Platform Type.
    3. Enter the FQDN of the Xen server.
    4. Select the HQ Agent connection (this is the agent that will connect to the Xen API, and collect metrics - so there must be connectivity between this agent and the Xen host).
    5. Enter the IP address of the Xen server.
    6. Click OK to create the Xen Host in your HQ inventory.
  2. You will be on the Inventory tab of your new resource. Scroll to the bottom and click the Edit button in the Configuration Properties section.
  3. Enter the configuration settings (URL to Xen API - which is http://xenserverhostname:80 by default, username and password for API connecton - same as what is used to connect to Xen Center, and the server name or UUID for your Xen host), then click OK.

What is the "server name or UUID" for my Xen host?

The "server name or UUID" for your Xen host is not simply the host name of the host system. The proper value for ths field can be obtained through the use of Xen Center.

If the configuration is accepted, you should begin to see metrics being collected for your Xen host in the next 1-2 minutes.

If the configuration is not accepted, something is wrong. Verify the URL to the Xen API, Username, Password, and Server Name or UUID. Also make sure the HQ Agent has network connectivity and can reach the API port on the Xen host (check firewalls).

Configure a Pool of XenServers in HQ

Follow the basic procedure described in Configure a Single XenServer in HQ, with these modifications:

Note:  For each Xen host, including the master and all members of the pool, configure the associated platform in HQ with the host-specific Server Name or UUID.

Resource hierarchy


Browse Space

- Pages
- News
- Labels
- Attachments
- Bookmarks
- Mail
- Advanced
- Activity

Explore Confluence

- Popular Labels
- Notation Guide

Your Account

Log In

or Sign Up  

Other Features

Add Content


System Monitoring Software
SourceForge.net Logo