Proxmox VE Rest API
Contenu du Pack​
Modèles​
Le Pack Centreon Proxmox VE apporte un modèle d'hôte :
- Virt-Proxmox-Ve-Restapi-custom
Il apporte les modèles de service suivants :
| Alias | Modèle de services | Défaut | Découverte |
|---|---|---|---|
| Node-Usage | Virt-Proxmox-Ve-Node-Usage-Restapi | X | X |
| Storage-Usage | Virt-Proxmox-Ve-Storage-Usage-Restapi | X | X |
| Vm-Usage | Virt-Proxmox-Ve-Vm-Usage-Restapi | X | X |
Règles de découverte​
- Host
- Service
| Nom de la règle | Description |
|---|---|
| Proxmox VM | Découverte des machines virtuelles Proxmox VE |
Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique d'hôtes.
| Nom de la règle | Description |
|---|---|
| Virt-Proxmox-Ve-Restapi-Node-Name | Découvre les noeuds et supervise l'utilisation |
| Virt-Proxmox-Ve-Restapi-Storage-Name | Découvre les stockages et supervise l'utilisation |
| Virt-Proxmox-Ve-Restapi-Vm-Name | Découvre les machines virtuelles et supervise l'utilisation |
Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.
Métriques & statuts collectés​
- Node-Usage
- Storage-Usage
- Vm-Usage
| Metric name | Description | Unit |
|---|---|---|
| node status | Current overall node status | |
| node_id#node.cpu.utilization.percentage | CPU utilization | % |
| node_id#node.memory.usage.bytes | Memory used | B |
| node_id#node.filesystem.usage.bytes | Space used for root filesystem | B |
| node_id#node.swap.usage.bytes | Swap used | B |
| Metric name | Description | Unit |
|---|---|---|
| storage status | Current overall storage status | |
| storage_id#storage.space.usage.bytes | Space used | B |
| Metric name | Description | Unit |
|---|---|---|
| node status | Current overall node status | |
| vm_name#vm.cpu.utilization.percentage | CPU utilization | % |
| vm_name#vm.memory.usage.bytes | Memory used | B |
| vm_name#vm.swap.usage.bytes | Swap used | B |
| vm_name#vm.read.usage.iops | Number of read operations | |
| vm_name#vm.write.usage.iops | Number of write operations | |
| vm_name#vm.traffic.in.bitspersecond | Incoming traffic going | b/s |
| vm_name#vm.traffic.out.bitspersecond | Outgoing traffic going | b/s |
Prérequis​
Pour la supervision, un utilisateur avec les droits en lecture est nécessaire : VM.Monitor, VM.Audit, Datastore.Audit, Sys.Audit, Sys.Syslog.
Référez vous à la documentation officielle : https://pve.proxmox.com/wiki/Proxmox_VE_API
Installation​
- Online License
- Offline License
- Installer le plugin Centreon sur tous les collecteurs Centreon devant superviser des ressources Proxmox VE :
yum install centreon-plugin-Virtualization-Proxmox-Ve-Restapi
- Sur l'interface web de Centreon, installer le Pack Proxmox VE depuis la page Configuration > Packs de plugins.
- Installer le plugin Centreon sur tous les collecteurs Centreon devant superviser des ressources Proxmox VE :
yum install centreon-plugin-Virtualization-Proxmox-Ve-Restapi
- Sur le serveur central Centreon, installer le RPM du Pack Proxmox VE :
yum install centreon-pack-virtualization-proxmox-ve-restapi
- Sur l'interface web de Centreon, installer le Pack Proxmox VE depuis la page Configuration > Packs de plugins.
Configuration​
Hôte​
- Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes
- Complétez les champs Nom, Alias & IP Address / DNS correspondant à votre serveur Proxmox VE.
- Appliquez le modèle d'hôte Virt-Proxmox-Ve-Restapi-custom.
- Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.
| Obligatoire | Nom | Description |
|---|---|---|
| X | PROXMOXAPIPORT | Port used (Default: 443) |
| X | PROXMOXAPIPROTO | Specify http if needed (default: 'https') |
| X | PROXMOXAPIUSERNAME | Api username |
| X | PROXMOXAPIPASSWORD | Api password |
| X | PROXMOXAPIREALM | Api username realm |
| PROXMOXAPIEXTRAOPTIONS | Any extra option you may want to add to the command (eg. a --verbose flag) |
Comment puis-je tester le Plugin et que signifient les options des commandes ?​
Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne
de commande depuis votre collecteur Centreon en vous connectant avec
l'utilisateur centreon-engine (su - centreon-engine) :
/usr/lib/centreon/plugins/centreon_proxmox_ve_restapi.pl \
--plugin=apps::proxmox::ve::restapi::plugin \
--mode=storage \
--hostname='10.0.0.1' \
--port='443' \
--proto='https' \
--api-username='my-username' \
--api-password='my-password' \
--realm='my-realm' \
--verbose
La commande devrait retourner un message de sortie similaire à :
OK: Storage 'storage/nuc/local' state: available, space total: 217.61 GB used: 145.86 GB (67.03%) free: 71.76 GB (32.97%) | 'storage/nuc/local#storage.space.usage.bytes'=156610641920B;;;0;233658822656
La liste de toutes les options complémentaires et leur signification peut être
affichée en ajoutant le paramètre --help à la commande:
/usr/lib/centreon/plugins/centreon_proxmox_ve_restapi.pl \
--plugin=apps::proxmox::ve::restapi::plugin \
--mode=storage \
--help
Tous les modes disponibles peuvent être affichés en ajoutant le paramètre
--list-mode à la commande:
/usr/lib/centreon/plugins/centreon_proxmox_ve_restapi.pl \
--plugin=apps::proxmox::ve::restapi::plugin \
--list-mode
Diagnostic des erreurs communes​
Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.