Supported Versions
Citrix XenServer: Version 8.2
Gateway: Version 11.0.2

Citrix XenServer is a hypervisor platform that enables the creation and management of virtualized server infrastructure.

Step 1: Create a credential

  1. Select a client from the All Clients list.
  2. Go to Setup > Accounts > Clients.
  3. On the client Credentials tab, add the credential information.

Step 2: Configure the integration

  1. From All Clients, select a client.
  2. Go to Setup > Integrations > Integrations.
  3. From Available Integrations, select Compute > XenServer and click Install.
  4. Enter:
PropertyDescription
NameName for the integration. (required)
IP addressLocation of the installation. (required)
Credentials

Note: Select an existing credential or create a new credential.
Credential for the integration. (required)
  1. Click Install.

Step 3: Add a discovery profile

  1. From the integration, click Add.
  2. Enter:
PropertyOptionsDescription
Profile details (required)Profile nameName of the profile.

Note: Select the profile name (gateway) which is in connected state). To confirm you can check under Management profile Gateway state (Connected /Disconnected).
Host nameName of host.
Perform actions (optional)Manage DeviceAction used to manage the resource.
Host nameName of host.
Discovery schedule (optional)Recurrence PatternConfigure how frequently the discovery action should trigger. Select Recurrence Pattern to add one of the following patterns:
  • Minutes
  • Hourly
  • Daily
  • Weekly
  • Monthly
  1. Click Save.
  2. (Optional), scan for the resource with the following steps:
    1. Go to the Discovery Profiles section.
    2. Select the profile.
    3. Click Scan Now.

Supported templates

The gateway is the collector type for the following supported Citrix XenServer metrics:

NameDescription
Citrix XenServer Health Check - G2Applicable on all the Xenservers in a given pool. It monitors CPU Utilization, CPU Stats, Storage Utilization, CPU Load, Memory Utilization and Uptime. Required SNMP credentials at device level and also device should support UCD-SNMP-MIB.
XenServer Host PerformanceCapture the XenServer Host performance present in the XenServer.
XenServer Host Performance - AdvancedCapture the XenServer Host performance present in the XenServer.
XenServer VirtualMachine PerformanceCapture the XenServer Virtual Machine performance present in the XenServer.
XenServer Datastore PerformanceCapture the XenServer Datastore performance present in the XenServer.

Next steps

Assign monitoring templates to the resource

After a discovery profile is created, you can do the following:

  1. Go to Infrastructure > Resources.
  2. From the Citrix Xenserver resources page, click the resource name and go to the resource details.
  3. Go to Monitors > Template.
  4. From the Templates screen, click +Assign Templates.
  5. From the Apply Templates screen, go to Select Templates > Available templates and select the templates.
  6. Click Assign.
    Validate that the resource was successfully added to OpsRamp.

Validation the resource is successfully added

The gateway monitors the application using the assigned templates and displays the results in a graphical format.
To confirm that the device is being monitored, review the following:

  • The graph plotted for each metric in the template.
  • Alerts generated for metrics in the template by giving thresholds

Supported metrics

Metric NameMonitor NameUnits
system.uptime

The time since the SNMP agent in the system was last re-initialized.
System Uptimes
unix.cpu.total

It provides the Sum of CPU Time in all modes.
CPU Stats - UCD-SNMP-MIBs
system.unix.cpu.stats.user

It provides the CPU time in User mode.
CPU Stats - UCD-SNMP-MIB%
system.unix.cpu.stats.nice

It provides the CPU Time in Nice mode.
CPU Stats - UCD-SNMP-MIB%
system.unix.cpu.stats.system

It provides the CPU Time in System mode.
CPU Stats - UCD-SNMP-MIB%
system.unix.cpu.stats.idle

It provides the CPU Time in Idle mode.
CPU Stats - UCD-SNMP-MIB%
system.unix.cpu.stats.iowait

It provides the CPU Time in iowait mode. This is primarily a SysV thingie.
CPU Stats - UCD-SNMP-MIB%
system.unix.cpu.stats.kernel

It provides the CPU Time in Kernel mode.
CPU Stats - UCD-SNMP-MIB%
system.unix.cpu.stats.interrupt

It Monitors the 5 minute cpu load average.
CPU Stats - UCD-SNMP-MIB%
system.unix.load.5min

It Monitors the 5 minute cpu load average.
CPU Stats - UCD-SNMP-MIB
system.unix.memory

It Monitors the Unix Real Memory utilization.
Memory Utilization - UCD-SNMP-MIB%
system.unix.memory.swap

It Monitors the Unix Swap Memory Utilization.
Memory Utilization - UCD-SNMP-MIB%
system.unix.memory.free

It Monitors the UNIX free memory.
Memory Utilization - UCD-SNMP-MIBKB
system.unix.memory.used

It Monitors the UNIX used memory
Memory Utilization - UCD-SNMP-MIBKB
system.unix.memory.swap.used

It Monitors the amount of used swap memory.
Memory Utilization - UCD-SNMP-MIBKB
system.unix.memory.swap.total

It Monitors the total amount of swap space configured for this host.
Memory Utilization - UCD-SNMP-MIBKB
system.disk.util.percent

It Monitors the disk utilization
Storage Utilization - HR-MIB%
system.unix.cpu.util.percent

CPU utilization is a key performance metric. It is the percentage of time the processor spends doing work (as opposed to being idle). It can be used to track CPU performance regressions or improvements.
CPU Utilization - UCD-SNMP-MIB%
xenserver.io.queuesize.average

Defines the average input/output queue size of the XenServer.
XenServer Host Performance
xenserver.cpu.time.cstate

It provides the Time during which the given CPU is spent in the given C-state.
XenServer Host Performance%
xenserver.cpu.usage

It provides the CPU usage in percentage of the XenServer.
XenServer Host Performance%
xenserver.cpu.usage.average

It provides the average CPU usage in percentage of the XenServer.
XenServer Host Performance%
xenserver.loadavg

It provides the load average in percentage of the XenServer.
XenServer Host Performance%
xenserver.memory.freespace

It provides the freespace memory of the XenServer.
XenServer Host PerformanceGB
xenserver.memory.freespace.average

It provides the average freespace memory of XenServer.
XenServer Host Performance%
xenserver.memory.total

It provides the total amount of memory in the host (in GB).
XenServer Host PerformanceGB
xenserver.pif.rx

It provides the bytes per second received on physical interface (PIF)
XenServer Host PerformanceBps
xenserver.pif.tx

It provides the bytes per second transmitted by physical interface (PIF).
XenServer Host PerformanceBps
xenserver.pif.aggr.rx

It provides the aggregate of physical interface bytes per seconds received.
XenServer Host PerformanceBps
xenserver.pif.aggr.tx

It provides the aggregate of physical interface bytes per seconds transmitted.
XenServer Host PerformanceBps
xenserver.sr.cache.hits

It provides the cache misses per second for the given Storage Repository.
XenServer Host Performancehps
xenserver.sr.cache.misses

It provides the cache hits per second for that given Storage Repository.
XenServer Host Performancemps
xenserver.sr.cache.size

It provides the cache size of the IntelliCache Storage Repository.
XenServer Host PerformanceBytes
xenserver.sr.cache.size

It provides the cache size of the IntelliCache Storage Repository.
XenServer Host PerformanceBytes
xenserver.xapi.healthcheck.latencyhealth

It provides the turn-around time in seconds of the latest XAPI status monitoring call on the local host.
XenServer Host Performances
xenserver.xapi.live.memory

It provides the live memory for the XAPI process in KB.
XenServer Host PerformanceKB
xenserver.xapi.memory.allocation

It provides the Memory allocation done by the XAPI daemon.
XenServer Host PerformanceKB
xenserver.xapi.memory.freespace

It provides the freespace memory available to the XAPI daemon.
XenServer Host PerformanceKB
xenserver.xapi.memory.usage

It provides the total memory used by the XAPI daemon.
XenServer Host PerformanceKB
xenserver.xapi.memory.usage.average

It provides the average memory used (%) by XAPI daemon.
XenServer Host Performance%
xenserver.vm.poweroff.count

It provides the counts of powered off VMs present in host.
XenServer Host Performance
xenserver.vm.poweron.count

It provides the counts of powered on VMs present in host.
XenServer Host Performance
xenserver.vm.suspended.count

It provides the number of virtual machines in suspended state in the XenServer host.
XenServer Host Performance
xenserver.host.license.expiry

It provides the number of days remaining until expiration of the license for the host.
XenServer Host PerformanceDays
xenserver.memory.usage.average

It provides the average memory usage (%).
XenServer Host Performance%
xenserver.host.status.availability

Denotes the availability of the host.
XenServer Host Performance
xenserver.pif.lo.rx

It provides the Bytes per second received on physical loopback interface.
XenServer Host PerformanceBps
xenserver.pif.lo.rx.errors

It provides the errors per second on physical loopback Interface.
XenServer Host PerformanceErrors per Sec
xenserver.pif.lo.tx

It provides the Bytes per second transmitted by physical loopback interface.
XenServer Host PerformanceBps
xenserver.pif.lo.tx.errors

It provides the errors per second by physical loopback Interface.
XenServer Host PerformanceErrors per Sec
xenserver.pif.rx.errors

It provides the errors per second on physical Interface.
XenServer Host PerformanceErrors per Sec
xenserver.pif.tx.errors

It provides the errors per second by physical Interface.
XenServer Host PerformanceErrors per Sec
xenserver.latency

It defines the latency (in ms).
XenServer Host Performancems
xenserver.memory.max.reclaimed

The maximum amount of memory that is reclaimed (in bytes).
XenServer Host PerformanceBytes
xenserver.memory.reclaimed

It provides the host memory reclaimed by squeeze.
XenServer Host PerformanceBytes
xenserver.network.latency

It defines network latency (in s).
XenServer Host Performances
xenserver.statefile.latency

It defines the statefile latency (in s).
XenServer Host Performances
xenserver.pif.lo.tx

It provides the Bytes per second transmitted to physical loopback interface.
XenServer Host Performance - AdvancedBps
xenserver.pif.lo.tx.errors

It provides the errors per second by physical loopback Interface.
XenServer Host Performance - AdvancedErrors per Sec
xenserver.pif.lo.rx

It provides the Bytes per second received on physical loopback interface.
XenServer Host Performance - AdvancedBps
xenserver.pif.lo.rx.errors

It provides the errors per second on physical loopback Interface.
XenServer Host Performance - AdvancedErrors per Sec
xenserver.pif.tx.errors

It provides the errors per second by physical Interface.
XenServer Host Performance - AdvancedErrors per Sec
xenserver.pif.rx.errors

It provides the errors per second on physical Interface.
XenServer Host Performance - AdvancedErrors per Sec
xenserver.latency

It defines the latency (in ms).
XenServer Host Performance - Advancedms
xenserver.memory.reclaimed

It provides the host memory reclaimed by squeeze.
XenServer Host Performance - AdvancedBytes
xenserver.memory.max.reclaimed

The maximum amount of memory that is reclaimed (in bytes).
XenServer Host Performance - AdvancedBytes
xenserver.network.latency

It defines network latency (in s).
XenServer Host Performance - Advanceds
xenserver.statefile.latency

It defines the statefile latency (in s).
XenServer Host Performance - Advanceds
xenserver.memory.allocated

Indicates the amount of memory allocated for the VM.
XenServer VirtualMachine PerformanceGB
xenserver.memory.target

It defines the XenServer Memory Sizing.
XenServer VirtualMachine PerformanceGB
xenserver.memory.internal.free

It provides the internal memory used.
XenServer VirtualMachine PerformanceGB
xenserver.runstate.blocked

Fraction of time the devices are blocked or offline.
XenServer VirtualMachine Performance%
xenserver.runstate.concurrency.hazard

Fraction of time that some devices are running and some are runnable.
XenServer VirtualMachine Performance%
xenserver.runstate.full.contention

Fraction of time that all devices are runnable.
XenServer VirtualMachine Performance%
xenserver.runstate.fullrun

Fraction of time that all devices are running.
XenServer VirtualMachine Performance%
xenserver.runstate.partial.contention

Fraction of time that some devices are runnable and some are blocked.
XenServer VirtualMachine Performance%
xenserver.runstate.partial.run

Fraction of time that some devices are running, and some are blocked.
XenServer VirtualMachine Performance%
xenserver.vbd.write

The speed (bytes per second) at which the data is written to the disk.
XenServer VirtualMachine PerformanceBps
xenserver.vbd.write.latency

Provides the time to write to the device in microseconds.
XenServer VirtualMachine Performancemicrosec
xenserver.vbd.read

Provides the speed (in bytes per second) to read from the device..
XenServer VirtualMachine PerformanceBps
xenserver.vbd.read.latency

Provides the time to read from the device in microseconds.
XenServer VirtualMachine Performancemicrosec
xenserver.vbd.iops.read

Provides the read requests per second.
XenServer VirtualMachine PerformanceReq per Sec
xenserver.vbd.iops.total

Provides the Total (Read/Write) requests per second.
XenServer VirtualMachine PerformanceReq per Sec
xenserver.vbd.iops.write

Provides the Write requests per second.
XenServer VirtualMachine PerformanceReq per Sec
xenserver.vbd.iowait

Provides the Percentage of time waiting for Input/Output.
XenServer VirtualMachine Performance%
xenserver.vbd.inflight

Provides the number of I/O requests currently in flight.
XenServer VirtualMachine Performance
xenserver.vbd.io.queue.size

Provides the Input/Output queue size (requests).
XenServer VirtualMachine Performance
xenserver.vif.rx

Provides the Bytes per second received on the given virtual interface number.
XenServer VirtualMachine PerformanceBps
xenserver.vif.rx.errors

Provides the Receive errors per second on the given virtual interface.
XenServer VirtualMachine PerformanceErrors per Sec
xenserver.vif.tx

Provides the Bytes per second transmitted on the given virtual interface.
XenServer VirtualMachine PerformanceBps
xenserver.vif.tx.errors

Provides the Transmit errors per second on the given virtual interface.
XenServer VirtualMachine PerformanceErrors per Sec
xenserver.vbd.io.throughput.total

Provides the All Input/Output in KBps.
XenServer VirtualMachine PerformanceKBps
xenserver.cpu.usage

Provides the CPU usage (in %).
XenServer VirtualMachine Performance%
xenserver.cpu.usage.average

Provides the average CPU usage (in %).
XenServer VirtualMachine Performance%
xenserver.memory.usage.average

Provides the average memory usage (in %).
XenServer VirtualMachine Performance%
xenserver.memory.freespace.average

Provides the average freespace memory (in %)..
XenServer VirtualMachine Performance%
xenserver.datastore.capacity.freespace

It defines the free space capacity of the XenServer datastore.
XenServer Datastore PerformanceGB
xenserver.datastore.capacity.usage

It defines the capacity usage (in %) of the XenServer datastore.
XenServer Datastore Performance%
xenserver.datastore.freespace.average

It defines the average free space available (in %) of the XenServer datastore.
XenServer Datastore Performance%