```
An example configuration file:
```
[CONF]
xen_server_ip=192.168.80.17
user=root
password=S4ToBh!
temporal=/tmp
[PANDORA]
group=Unknown
logfile=/tmp/pandora_xenserver.log
interval=300
transfer_mode=tentacle
tentacle_ip=172.42.42.101
tentacle_client=tentacle_client
tentacle_port=41121
tentacle_opts=
data_dir=/tmp/data_in
id_as_name = 1
[TUNNING]
time_adjustment=10
scan_vm_ip=1
scan_all_vm=1
scan_all_sr=1
scan_all_host=1
[REJECT]
vm_test_env=1
sr_additional=1
[RENAME]
vm_env_prod_157=Prod157
vm_env_dev_157=Dev157
```
It must be taken into account that the interval that we define in this configuration file, which will be the interval of the agents that are generated when the plugin is executed, has to be equal to the execution interval of the plugin. If this is not the case, the modules of the generated agents will be set to "unknown" in the moments in which the agents try to collect the data but the plugin has not yet been executed.
# Manual execution
The plugin can be run manually by terminal to check its correct configuration before its subsequent installation in PandoraFMS. This has two parameters, -c or --conf (you can use whichever you prefer) to call the configuration conf file.
For a correct configuration of the configuration file, carefully review the previous chapter of this manual called "Parameters". In it, all the possible configuration options are detailed.
**Manual execution**
```
./pandora_xenserver -c
```
An example output would be the following:
```XML
```
**As discovery plugin**
```
./pandora_xenserver -c --as_discovery_plugin 1
```
An example output would be the following:
```JSON
[{"summary":{"Hosts":1,"Storage":7, "VMs":23,"Hosts VMs running":10,"Hosts VMs installed":95}}]
```
# Discovery
This plugin can be integrated with Pandora FMS Discovery.
To do this, you must load the ".disco" package that you can download from the Pandora FMS library:
[https://pandorafms.com/library/](https://pandorafms.com/library/)
[](https://pandorafms.com/guides/public/uploads/images/gallery/2023-06/image-1687944638257.png)
Once loaded, XenServer environments can be monitored by creating Discovery tasks from the Management > Discovery > Applications section.
[](https://pandorafms.com/guides/public/uploads/images/gallery/2023-06/image-1687944787532.png)
For each task, the following minimum data will be requested:
- **XenServer IP:** IP of the XenServer server to monitor.
- **XenServer user:** Connection user to the XenServer.
- **Password:** Password of the connection user.
- **ID as Name:** To enable an SR's id to be its agent name, the alias will remain the name.
- **Tentacle IP:** IP of the Tentacle server to send agent data to. Normally this parameter will not be modified.
- **Tentacle port:** Tentacle server port to send data to. Normally this parameter will not be modified.
- **Tentacle extra options:** Additional options for sending data through the Tentacle client. Normally this parameter will not be modified.
[](https://pandorafms.com/guides/public/uploads/images/gallery/2024-05/dwbimage.png)
Task settings can also be adjusted to customize the desired monitoring:
- Time adjustment: Time adjustment, enter in seconds.
- Scan VM IP: Activate to check the IP of the virtual machines.
- Scan all Hosts: Check to enable scanning of all hosts.
- Scan all VM: Check to enable scanning of all virtual machines.
- Scan all SR: Check to enable scanning of all SR agents.
- Extra settings: Optional additional configuration block. Here you can include all the plugin configuration parameters you want, such as the REJECT or RENAME blocks.
[](https://pandorafms.com/guides/public/uploads/images/gallery/2023-05/image-1683798608834.png)
Tasks that are successfully completed will have an execution summary with the following information:
- Hosts: Number of monitored hosts.
- Storage: Amount of storage monitored.
- VMs: Number of virtual machines that are not templates or control domain. A control domain is a special virtual machine that acts as a management interface to the Xen environment.
- Hosts VMs running: Number of virtual machines running on the monitored hosts.
- Hosts VMs installed: Number of virtual machines of the monitored hosts, including templates and control domains.
[](https://pandorafms.com/guides/public/uploads/images/gallery/2023-05/image-1684313757448.png)
The tasks that are not completed successfully will have an execution summary recording the errors produced.
# Agents generated by the plugin
The plugin generates three types of agents:
● virtual machine (VM)
● storage disk (SR)
● XenServer (Host)
**Storage Repository (SR) type agents**
For each SR an agent will be generated, which will have a name of the type: XenSR\_<name\_of\_SR>
**SR Agent Modules**
For each agent of this type the following modules will be generated:
| Name | Description | Data type | Unity |
| physical\_size | Physical space | generic\_data | GB |
| physical\_utilisation | Physical use | generic\_data | GB |
| free space | Free space | generic\_data | GB |
| used percent | Percentage of SR used | generic\_data | % |
**Virtual Machine (VM) type agents**
Each agent will have the IP of the virtual machine and its system
operating (as long as you have XenServer Tools installed
**VM Agent Modules**
For each agent of this type the following modules will be generated:
| Module name | Description | Data type | Unity |
| Status | Returns whether a VM is
running or not | generic\_proc | - |
| Status description | state name | generic\_data\_string | - |
| Memory used | RAM percentage
used | generic\_data | % |
| cpuX | CPU load percentage | generic\_data | % |
| Xenxerver Tools | Check if the VM has been
installed and update XenServer
tools | generic\_proc | - |
| VDI\_<nombre vdi> | VDI size | generic\_data | GB |
| Vbd\_XX\_write | Write speed in bytes
per second | generic\_data | Bytes/sec |
| Vbd\_XX\_read | Reading speed in bytes
per second | generic\_data | Bytes/sec |
**XenServer-type agents**
An agent will be generated for each host or server, which will have a name of the type:
<XenServer\_name>
Each agent will recognize your IP.
**XenServer Agent Modules**
For each agent of this type the following modules will be generated:
| Module name | description | data type | unity |
| VMs running | Number of VMs running | generic\_data | - |
| VMs installed | Number of VMs installed | generic\_data | - |
| Memory used | RAM percentage
used | generic\_data | % |
| Load CPU avg | Average load percentage
CPU | generic\_data | % |