Guide de script Linux : Comment automatiser la collecte des informations sur les machines virtuelles sur Proxmox ?

Dans le monde informatique actuel, la gestion et la surveillance efficaces des environnements virtuels sont cruciales pour les administrateurs de systèmes et les fournisseurs de services gérés (MSP). Les environnements virtuels, comme ceux gérés par Proxmox, nécessitent une surveillance régulière pour garantir un fonctionnement sans problèmes et des performances optimales.

L’automatisation de la collecte de l’état des machines virtuelles (MV ou VM) et des informations de base permet non seulement de gagner du temps, mais aussi de réduire le risque d’erreur humaine. Cet article présente un script bash conçu pour récupérer et afficher l’état et les détails des invités Proxmox, démontrant ainsi son utilité et la façon dont il peut simplifier les opérations informatiques.

Contexte

Proxmox est une solution de gestion de la virtualisation open-source populaire, qui combine la virtualisation KVM et la virtualisation basée sur les conteneurs en une seule plateforme. Pour les professionnels de l’informatique et les entreprises MSP, la surveillance de l’état des machines virtuelles et des conteneurs est une tâche de routine mais vitale. Ce texte répond à la nécessité de disposer d’une méthode automatisée et cohérente pour recueillir et afficher les informations de la VM, en les présentant dans un format facilement accessible et interprétable.

Le script

#!/usr/bin/env bash

# Description: This script gets the status and basic info of all Proxmox guests on a host and saves it to a WYSIWYG custom field.
#
# Release Notes: Initial Release
# By using this script, you indicate your acceptance of the following legal terms as well as our Terms of Use at https://www.ninjaone.com/terms-of-use.
# Ownership Rights: NinjaOne owns and will continue to own all right, title, and interest in and to the script (including the copyright). NinjaOne is giving you a limited license to use the script in accordance with these legal terms. 
# Use Limitation: You may only use the script for your legitimate personal or internal business purposes, and you may not share the script with another party. 
# Republication Prohibition: Under no circumstances are you permitted to re-publish the script in any script library or website belonging to or under the control of any other software provider. 
# Warranty Disclaimer: The script is provided “as is” and “as available”, without warranty of any kind. NinjaOne makes no promise or guarantee that the script will be free from defects or that it will meet your specific needs or expectations. 
# Assumption of Risk: Your use of the script is at your own risk. You acknowledge that there are certain inherent risks in using the script, and you understand and assume each of those risks. 
# Waiver and Release: You will not hold NinjaOne responsible for any adverse or unintended consequences resulting from your use of the script, and you waive any legal or equitable rights or remedies you may have against NinjaOne relating to your use of the script. 
# EULA: If you are a NinjaOne customer, your use of the script is subject to the End User License Agreement applicable to you (EULA).
#
# Below are all the (case sensitive) valid parameters for this script.
# Only the custom field name is required!
# Preset Parameter: "Custom_Field_Name"
#   Custom_Field_Name: The name of the WYSIWYG custom field to save the VM info to.

Custom_Field_Name=$1

if [[ -n "${customFieldName}" ]]; then
    Custom_Field_Name="${customFieldName}"
fi

if [[ -z "${Custom_Field_Name}" || "${Custom_Field_Name}" == "null" ]]; then
    echo "The custom field name is required."
    echo " Example: guests"
    exit 1
fi

# Check that we have the required tools
if ! command -v pvesh &> /dev/null; then
    echo "The Proxmox VE API tool 'pvesh' is required."
    exit 1
fi
if ! command -v python3 &> /dev/null; then
    echo "The python3 is required. Should already be installed."
    exit 1
fi

# Check that we are running as root
if [[ $EUID -ne 0 ]]; then
    echo "This script must be run as root."
    exit 1
fi

function SetCustomField() {
    /opt/NinjaRMMAgent/programdata/ninjarmm-cli "$@"
}

# Get the status and basic info of all Proxmox VMs on a host
qemu_guests=$(pvesh get /nodes/localhost/qemu --output-format=json)

# Create a table to store the VM info with the headers: Name, Status, Memory, CPUs, Disk Sizes
vm_table="<table><tr><th>Status</th><th>ID</th><th>Name</th><th>Memory</th><th>CPUs</th><th>Disk Sizes Combined</th></tr>"

# Loop through each VM and add the info to the table
qemu_table=$(echo "$qemu_guests" | python3 -c '
import sys, json

# Function to convert bytes to human readable format
def human_readable_size(size):
    for unit in ["B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB"]:
        if size < 1024:
            return f"{size:.2f} {unit}"
        size /= 1024

qemu_guests = json.load(sys.stdin)
vm_table = ""

for qemu in qemu_guests:
    qemu_id = qemu["vmid"]
    qemu_name = qemu["name"]
    qemu_status = qemu["status"]
    # Convert the memory from bytes to GB
    qemu_mem = human_readable_size(qemu["maxmem"])
    qemu_cpus = qemu["cpus"]
    # Convert the disk size from bytes to GB
    qemu_disk = human_readable_size(qemu["maxdisk"])

    # Add HTML blank space if values are empty
    qemu_id = qemu_id if qemu_id else "&nbsp;"
    qemu_name = qemu_name if qemu_name else "&nbsp;"
    qemu_mem = qemu_mem if qemu_mem else "&nbsp;"
    qemu_cpus = qemu_cpus if qemu_cpus else "&nbsp;"
    qemu_disk = qemu_disk if qemu_disk else "&nbsp;"

    if "running" in qemu_status:
        status_text = "<tr class='"'success'"'><td>Running</td>"
    elif "stopped" in qemu_status:
        status_text = "<tr class='"'danger'"'><td>Stopped</td>"
    else:
        status_text = "<tr class='"'other'"'><td>{}</td>".format(qemu_status)

    vm_table += "{}<td>{}</td><td>{}</td><td>{}</td><td>{}</td><td>{}</td></tr>".format(
        status_text, qemu_id, qemu_name, qemu_mem, qemu_cpus, qemu_disk
    )

print(vm_table)
')
vm_table="$vm_table$qemu_table"

# Loop through each lxc and add the info to the table
lxc_guests=$(pvesh get /nodes/localhost/lxc --output-format=json)
# Loop through each lxc and add the info to the table
lxc_table=$(echo "$lxc_guests" | python3 -c '
import sys, json

# Function to convert bytes to human readable format
def human_readable_size(size):
    for unit in ["B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB"]:
        if size < 1024:
            return f"{size:.2f} {unit}"
        size /= 1024

lxc_guests = json.load(sys.stdin)
vm_table = ""

for lxc in lxc_guests:
    lxc_id = lxc["vmid"]
    lxc_name = lxc["name"]
    lxc_status = lxc["status"]
    # Convert the memory from bytes to GB
    lxc_mem = human_readable_size(lxc["maxmem"])
    lxc_cpus = lxc["cpus"]
    # Convert the disk size from bytes to GB
    lxc_disk = human_readable_size(lxc["maxdisk"])

    # Add HTML blank space if values are empty
    lxc_id = lxc_id if lxc_id else "&nbsp;"
    lxc_name = lxc_name if lxc_name else "&nbsp;"
    lxc_mem = lxc_mem if lxc_mem else "&nbsp;"
    lxc_cpus = lxc_cpus if lxc_cpus else "&nbsp;"
    lxc_disk = lxc_disk if lxc_disk else "&nbsp;"

    if "running" in lxc_status:
        status_text = "<tr class='"'success'"'><td>Running</td>"
    elif "stopped" in lxc_status:
        status_text = "<tr class='"'danger'"'><td>Stopped</td>"
    else:
        status_text = "<tr class='"'other'"'><td>{}</td>".format(lxc_status)

    vm_table += "{}<td>{}</td><td>{}</td><td>{}</td><td>{}</td><td>{}</td></tr>".format(
        status_text, lxc_id, lxc_name, lxc_mem, lxc_cpus, lxc_disk
    )

print(vm_table)
')
vm_table="$vm_table$lxc_table"

# Close the table
vm_table="$vm_table</table>"

# Highlight the running and stopped VMs
vm_table=$(echo "$vm_table" | sed 's/<tr><td>running<\/td>/<tr class="success"><td>Running<\/td>/')
vm_table=$(echo "$vm_table" | sed 's/<tr><td>stopped<\/td>/<tr class="danger"><td>Stopped<\/td>/')

# Save the table to the custom field
if ! SetCustomField set "$Custom_Field_Name" "$vm_table"; then
    echo "Failed to save the Proxmox VM info to the custom field: $Custom_Field_Name"
    exit 1
fi
echo "The Proxmox VM info has been saved to the custom field: $Custom_Field_Name"

 

Description détaillée

Le script bash fourni récupère l’état et les informations essentielles de tous les invités Proxmox sur un hôte et enregistre ces données dans un champ personnalisé. Cette fonction est particulièrement utile dans les environnements comportant de nombreuses machines virtuelles, où les vérifications manuelles peuvent prendre du temps et être source d’erreurs.

Explication étape par étape

1. Initialisation du script et gestion des paramètres :

• Le script commence par définir le nom du champ personnalisé, qui est un paramètre obligatoire. Ce nom de champ stocke les informations des machines virtuelles.

• Si le nom du champ personnalisé n’est pas fourni ou n’est pas valide, le script se termine par un message d’erreur.

2. Contrôle de la disponibilité des outils :

• Le script vérifie la disponibilité des outils requis : pvesh (outil Proxmox VE API) et python3. Si ces outils ne sont pas trouvés, le script se termine par un message d’erreur.

3. Vérification de l’accès root :

• Le script vérifie s’il est exécuté avec des droits d’administrateur. Si ce n’est pas le cas, il se termine par un message d’erreur.

4. Récupération des informations sur les machines virtuelles :

• À l’aide de pvesh, le script récupère des informations sur les MV QEMU et les conteneurs LXC de l’hôte Proxmox.

• Ces informations sont traitées à l’aide de Python pour générer un tableau HTML contenant des détails tels que l’état, l’ID, le nom, la mémoire, les unités centrales et les tailles combinées des disques.

5. Génération d’un tableau HTML :

• Le script Python intégré au script bash formate les données JSON récupérées dans un tableau HTML. Ce tableau est conçu pour mettre en évidence de manière différente les machines virtuelles en cours d’exécution et les machines virtuelles arrêtées.

6. Enregistrement du tableau dans un champ personnalisé :

• Le tableau HTML généré est enregistré dans le champ personnalisé spécifié à l’aide de l’outil CLI de NinjaOne.

Cas d’utilisation potentiels

Imaginez une entreprise MSP qui gère plusieurs environnements Proxmox pour différents clients. La vérification manuelle de l’état et de l’allocation des ressources de chaque machine virtuelle sur différents hôtes peut s’avérer fastidieuse. En déployant ce script, l’entreprise MSP peut automatiser la collecte de ces données et les rendre facilement disponibles dans un champ personnalisé, accessible via son interface de gestion. Cela permet non seulement d’améliorer l’efficacité, mais aussi de garantir une réponse rapide aux problèmes qui se posent.

Comparaisons

D’autres méthodes de collecte d’informations sur les VM peuvent impliquer l’exécution manuelle de commandes et la compilation des résultats, ce qui prend du temps et est sujet à des erreurs. Des outils tels que l’interface web de Proxmox fournissent les informations nécessaires, mais nécessitent une navigation et une vérification manuelles. En revanche, ce script automatise l’ensemble du processus, ce qui garantit la cohérence et permet de gagner un temps précieux.

FAQ

Q : Que se passe-t-il si le script ne trouve pas pvesh ou python3 ?
R : Le script vérifie la présence de ces dépendances au démarrage et se termine par un message d’erreur clair si elles ne sont pas trouvées, guidant l’utilisateur pour qu’il installe les outils manquants.

Q : Le script peut-il être exécuté sans les privilèges de super-utilisateur (root) ?
R : Non, le script doit être exécuté en tant que root pour accéder aux informations système nécessaires.

Q : Que se passe-t-il si le nom du champ personnalisé n’est pas fourni ?
R : Le script requiert le nom du champ personnalisé comme paramètre. S’il n’est pas fourni, le script se termine par un message d’erreur.

Implications

L’automatisation de la collecte des informations des machines virtuelles permet non seulement d’améliorer l’efficacité opérationnelle, mais aussi de renforcer la sécurité informatique. Des contrôles réguliers et automatisés permettent de s’assurer que toutes les machines virtuelles sont prises en compte et fonctionnent comme prévu, ce qui réduit le risque de temps d’arrêt inaperçus ou d’erreurs d’allocation des ressources.

Recommandations

Lorsque vous utilisez ce script, assurez-vous que :

• Le script est exécuté à intervalles réguliers afin de maintenir à jour les informations à propos des machines virtuelles.

• Les autorisations appropriées sont définies pour que le script s’exécute en tant que root.

• Les dépendances (pvesh, python3, NinjaOne CLI) sont installées et correctement configurées.

Conclusion

Ce script est un outil précieux pour les professionnels de l’informatique qui gèrent des environnements Proxmox, car il simplifie le processus de collecte et d’affichage des informations sur les machines virtuelles. Pour ceux qui utilisent NinjaOne, ce script s’intègre davantage dans leur flux de travail, facilitant le maintien d’une vue claire et actualisée de leur infrastructure virtuelle. En automatisant les tâches de routine, les professionnels de l’informatique peuvent se concentrer sur des activités plus stratégiques, ce qui améliore la productivité globale et la fiabilité du système.