Note
You are viewing documentation for an older version of this integration. We recommend upgrading to the latest version, Citrix Hypervisor for improved features, better support and latest information.Supported Target Versions |
---|
Citrix XenServer: Version 8.2 |
Gateway: Version 11.0.2 |
Introduction
Citrix XenServer is a hypervisor platform that enables the creation and management of virtualized server infrastructure.
Supported metrics
Click here to view the supported metrics
Metric Name | Monitor Name | Units |
---|---|---|
system.uptime The time since the SNMP agent in the system was last re-initialized. | System Uptime | s |
unix.cpu.total It provides the Sum of CPU Time in all modes. | CPU Stats - UCD-SNMP-MIB | s |
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-MIB | KB |
system.unix.memory.used It Monitors the UNIX used memory | Memory Utilization - UCD-SNMP-MIB | KB |
system.unix.memory.swap.used It Monitors the amount of used swap memory. | Memory Utilization - UCD-SNMP-MIB | KB |
system.unix.memory.swap.total It Monitors the total amount of swap space configured for this host. | Memory Utilization - UCD-SNMP-MIB | KB |
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 Performance | GB |
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 Performance | GB |
xenserver.pif.rx It provides the bytes per second received on physical interface (PIF) | XenServer Host Performance | Bps |
xenserver.pif.tx It provides the bytes per second transmitted by physical interface (PIF). | XenServer Host Performance | Bps |
xenserver.pif.aggr.rx It provides the aggregate of physical interface bytes per seconds received. | XenServer Host Performance | Bps |
xenserver.pif.aggr.tx It provides the aggregate of physical interface bytes per seconds transmitted. | XenServer Host Performance | Bps |
xenserver.sr.cache.hits It provides the cache misses per second for the given Storage Repository. | XenServer Host Performance | hps |
xenserver.sr.cache.misses It provides the cache hits per second for that given Storage Repository. | XenServer Host Performance | mps |
xenserver.sr.cache.size It provides the cache size of the IntelliCache Storage Repository. | XenServer Host Performance | Bytes |
xenserver.sr.cache.size It provides the cache size of the IntelliCache Storage Repository. | XenServer Host Performance | Bytes |
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 Performance | s |
xenserver.xapi.live.memory It provides the live memory for the XAPI process in KB. | XenServer Host Performance | KB |
xenserver.xapi.memory.allocation It provides the Memory allocation done by the XAPI daemon. | XenServer Host Performance | KB |
xenserver.xapi.memory.freespace It provides the freespace memory available to the XAPI daemon. | XenServer Host Performance | KB |
xenserver.xapi.memory.usage It provides the total memory used by the XAPI daemon. | XenServer Host Performance | KB |
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 Performance | Days |
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 Performance | Bps |
xenserver.pif.lo.rx.errors It provides the errors per second on physical loopback Interface. | XenServer Host Performance | Errors per Sec |
xenserver.pif.lo.tx It provides the Bytes per second transmitted by physical loopback interface. | XenServer Host Performance | Bps |
xenserver.pif.lo.tx.errors It provides the errors per second by physical loopback Interface. | XenServer Host Performance | Errors per Sec |
xenserver.pif.rx.errors It provides the errors per second on physical Interface. | XenServer Host Performance | Errors per Sec |
xenserver.pif.tx.errors It provides the errors per second by physical Interface. | XenServer Host Performance | Errors per Sec |
xenserver.latency It defines the latency (in ms). | XenServer Host Performance | ms |
xenserver.memory.max.reclaimed The maximum amount of memory that is reclaimed (in bytes). | XenServer Host Performance | Bytes |
xenserver.memory.reclaimed It provides the host memory reclaimed by squeeze. | XenServer Host Performance | Bytes |
xenserver.network.latency It defines network latency (in s). | XenServer Host Performance | s |
xenserver.statefile.latency It defines the statefile latency (in s). | XenServer Host Performance | s |
xenserver.pif.lo.tx It provides the Bytes per second transmitted to physical loopback interface. | XenServer Host Performance - Advanced | Bps |
xenserver.pif.lo.tx.errors It provides the errors per second by physical loopback Interface. | XenServer Host Performance - Advanced | Errors per Sec |
xenserver.pif.lo.rx It provides the Bytes per second received on physical loopback interface. | XenServer Host Performance - Advanced | Bps |
xenserver.pif.lo.rx.errors It provides the errors per second on physical loopback Interface. | XenServer Host Performance - Advanced | Errors per Sec |
xenserver.pif.tx.errors It provides the errors per second by physical Interface. | XenServer Host Performance - Advanced | Errors per Sec |
xenserver.pif.rx.errors It provides the errors per second on physical Interface. | XenServer Host Performance - Advanced | Errors per Sec |
xenserver.latency It defines the latency (in ms). | XenServer Host Performance - Advanced | ms |
xenserver.memory.reclaimed It provides the host memory reclaimed by squeeze. | XenServer Host Performance - Advanced | Bytes |
xenserver.memory.max.reclaimed The maximum amount of memory that is reclaimed (in bytes). | XenServer Host Performance - Advanced | Bytes |
xenserver.network.latency It defines network latency (in s). | XenServer Host Performance - Advanced | s |
xenserver.statefile.latency It defines the statefile latency (in s). | XenServer Host Performance - Advanced | s |
xenserver.memory.allocated Indicates the amount of memory allocated for the VM. | XenServer VirtualMachine Performance | GB |
xenserver.memory.target It defines the XenServer Memory Sizing. | XenServer VirtualMachine Performance | GB |
xenserver.memory.internal.free It provides the internal memory used. | XenServer VirtualMachine Performance | GB |
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 Performance | Bps |
xenserver.vbd.write.latency Provides the time to write to the device in microseconds. | XenServer VirtualMachine Performance | microsec |
xenserver.vbd.read Provides the speed (in bytes per second) to read from the device.. | XenServer VirtualMachine Performance | Bps |
xenserver.vbd.read.latency Provides the time to read from the device in microseconds. | XenServer VirtualMachine Performance | microsec |
xenserver.vbd.iops.read Provides the read requests per second. | XenServer VirtualMachine Performance | Req per Sec |
xenserver.vbd.iops.total Provides the Total (Read/Write) requests per second. | XenServer VirtualMachine Performance | Req per Sec |
xenserver.vbd.iops.write Provides the Write requests per second. | XenServer VirtualMachine Performance | Req 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 Performance | Bps |
xenserver.vif.rx.errors Provides the Receive errors per second on the given virtual interface. | XenServer VirtualMachine Performance | Errors per Sec |
xenserver.vif.tx Provides the Bytes per second transmitted on the given virtual interface. | XenServer VirtualMachine Performance | Bps |
xenserver.vif.tx.errors Provides the Transmit errors per second on the given virtual interface. | XenServer VirtualMachine Performance | Errors per Sec |
xenserver.vbd.io.throughput.total Provides the All Input/Output in KBps. | XenServer VirtualMachine Performance | KBps |
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 Performance | GB |
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 | % |
Configure and Install the integration
From All Clients, select a client.
Navigate to Setup > Account.
Select the Integrations and Apps tab.
The Installed Integrations page, where all the installed applications are displayed. If there are no installed applications, it will navigate to the Available Integrations and Apps page.
Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
Note: Search for the application using the search option available. Alternatively, use the All Categories option to search.Click ADD on the XenServer tile.
Enter the gateway profile name or select a gateway profile on the Installation tab and click NEXT.
Note: The selected gateway should be up and running.
CONFIGURATION
Provide all details related to the device.Name: Configuration name
IP Address: IP Address
CredentialSet: You can select a credential from the list or add a credential.
To add a credential:- Click the +ADD option available in the CredentialSet dropdown. The ADD CREDENTIAL window is displayed. Enter the following information:
- Name: Credential name.
- Description: Brief description of the credential.
- User Name: User name.
- Password: Password
- Confirm Password: Confirm password
- Port: Port number. Set
443
for a secure connection. For unsecured connections, use port80
. - Secure: Select the Secure checkbox for encryption.
- Connection Timeout (ms): Timeout in milliseconds. Default time-out is 1000 milliseconds
- Click ADD to add the credential to the credential list.
- Click the +ADD option available in the CredentialSet dropdown. The ADD CREDENTIAL window is displayed. Enter the following information:
FILTER BY RESOURCE TAG: Click Any or All of the rules below to match any one or all of the conditions you define for filtering.
Enter/select the values in the Key, Operator, and Value fields for filtering the resources.FILTER BY RESOURCE TYPE:
ALL: All the existing and future resources will be discovered.
SELECT: You can select one or multiple resources to be discovered.ACTIONS_LABEL: Select the Manage Device option, if you want the discovered devices to be managed.
DISCOVERY SCHEDULE: Discovery is triggered based on the scheduled time. New resources added to the environment are automatically discovered.
Choose one of the following Recurrence Patterns:- Hourly
- Daily
- Weekly
- Monthly
- None (On-demand discovery)
Click FINISH.
The XenServer integration is installed and displayed on the INSTALLED INTEGRATIONS page.
Supported templates
The gateway is the collector type for the following supported Citrix XenServer metrics:
Name | Description |
---|---|
Citrix XenServer Health Check - G2 | Applicable 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 Performance | Capture the XenServer Host performance present in the XenServer. |
XenServer Host Performance - Advanced | Capture the XenServer Host performance present in the XenServer. |
XenServer VirtualMachine Performance | Capture the XenServer Virtual Machine performance present in the XenServer. |
XenServer Datastore Performance | Capture 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:
- Go to Infrastructure > Resources.
- From the Citrix Xenserver resources page, click the resource name and go to the resource details.
- Go to Monitors > Template.
- From the Templates screen, click +Assign Templates.
- From the Apply Templates screen, go to Select Templates > Available templates and select the templates.
- 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 are plotted for each metric in the template.
- Alerts are generated for metrics in the template by giving thresholds.