Guide complet pour la surveillance de l'état des clusters Proxmox sur Linux

Le maintien de la stabilité et des performances d’un cluster Proxmox est crucial pour les professionnels de l’informatique et les fournisseurs de services gérés (MSP). Un cluster Proxmox offre de nombreux avantages, notamment une haute disponibilité, une gestion efficace des ressources ainsi qu’une virtualisation optimale. Cependant, il est essentiel de surveiller son état pour garantir un fonctionnement sans problèmes.

Cet article présente un script Bash conçu pour obtenir l’état du cluster Proxmox et l’enregistrer dans un champ personnalisé. Nous explorerons les fonctionnalités du script, les cas d’utilisation potentiels, les comparaisons, une FAQ, les implications et les bonnes pratiques.

Contexte

Proxmox Virtual Environment (VE) est une solution open-source de gestion de la virtualisation des serveurs qui permet aux professionnels de l’informatique de déployer et de gérer des machines virtuelles et des conteneurs. Créer un cluster dans Proxmox est une fonctionnalité fondamentale qui permet à plusieurs nœuds Proxmox VE de travailler ensemble, offrant ainsi une haute disponibilité et un équilibrage de la charge. La surveillance de l’état du cluster est essentielle pour maintenir l’intégrité et les performances de l’environnement virtuel.

Ce script est conçu pour les professionnels de l’informatique qui ont besoin d’un moyen efficace pour surveiller les clusters Proxmox. Il récupère l’état du cluster et enregistre les informations dans un champ personnalisé multiligne ou un champ personnalisé WYSIWYG, ce qui facilite la gestion et l’examen de l’état du cluster.

Le script

#!/usr/bin/env bash

# Description: Get the Proxmox Cluster Status and save it to a multiline and/or WYSIWYG custom field
#
# Release Notes: Fixed 10% width bug.
# 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).

# Command line arguments, swap the numbers if you want the multiline custom field to be the second argument
multiline_custom_field=$1 # First argument is the multiline custom field name
wysiwyg_custom_field=$2   # Second argument is the WYSIWYG custom field name

if [[ -n "${multilineCustomField}" && "${multilineCustomField}" != "null" ]]; then
    multiline_custom_field=$multilineCustomField
fi
if [[ -n "${wysiwygCustomField}" && "${wysiwygCustomField}" != "null" ]]; then
    wysiwyg_custom_field=$wysiwygCustomField
fi

if [[ -n "${multiline_custom_field}" && "${multiline_custom_field}" == "${wysiwyg_custom_field}" ]]; then
    echo "[Error] multilineCustomField and wysiwygCustomField cannot be the same custom field."
    exit 1
fi

if [[ -z "${multiline_custom_field}" ]]; then
    echo "[Info] multilineCustomField is not set."
fi
if [[ -z "${wysiwyg_custom_field}" ]]; then
    echo "[Info] wysiwygCustomField is not set."
fi

# Check that we have the required tools
if ! command -v pvecm &>/dev/null; then
    echo "[Error] The Proxmox VE API tool 'pvecm' is required."
    exit 1
fi

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

# Check if ninjarmm-cli command exists
ninjarmm_cli="/opt/NinjaRMMAgent/programdata/ninjarmm-cli"
if [[ -z $ninjarmm_cli ]]; then
    echo "[Error] The ninjarmm-cli command does not exist in the default path. Please ensure the NinjaRMM agent is installed before running this script."
    exit 1
else
    # ninjarmm-cli command exists in the default path
    echo -n
fi

# Run the pvecm command to get the status information
if ! pvecm_status_output=$(pvecm status); then
    echo "[Error] Failed to get the Proxmox Cluster Status."
    echo "$pvecm_status_output"
    exit 1
fi
# Example Output:
# Cluster information
# -------------------
# Name:             cluster1
# Config Version:   4
# Transport:        knet
# Secure auth:      on
#
# Quorum information
# ------------------
# Date:             Mon Apr  8 10:33:16 2024
# Quorum provider:  corosync_votequorum
# Nodes:            4
# Node ID:          0x00000004
# Ring ID:          1.631
# Quorate:          Yes
#
# Votequorum information
# ----------------------
# Expected votes:   4
# Highest expected: 4
# Total votes:      4
# Quorum:           3
# Flags:            Quorate
#
# Membership information
# ----------------------
#     Nodeid      Votes Name
# 0x00000001          1 10.10.10.17
# 0x00000002          1 10.10.10.18
# 0x00000003          1 10.10.10.19
# 0x00000004          1 10.10.10.20 (local)

# Cluster Table
# Get the cluster name
cluster_name=$(echo "$pvecm_status_output" | grep -oP 'Name:\s+\K\w+' | head -n 1)
# Get the Config Version
config_version=$(echo "$pvecm_status_output" | grep -oP 'Config Version:\s+\K\d+' | head -n 1)
# Get the Transport
transport=$(echo "$pvecm_status_output" | grep -oP 'Transport:\s+\K\w+' | head -n 1)
# Get the Secure auth
secure_auth=$(echo "$pvecm_status_output" | grep -oP 'Secure auth:\s+\K\w+' | head -n 1)

# Create Cluster Status label
cluster_table="<h2>Cluster Status</h2>"
# Create the Cluster Status table
cluster_table+="<table style='white-space:nowrap;'><tr><th>Cluster Name</th><th>Config Version</th><th>Transport</th><th>Secure Auth</th></tr>"
cluster_table+="<tr><td>$cluster_name</td><td>$config_version</td><td>$transport</td><td>$secure_auth</td></tr></table>"

# Quorum Table
# Get the Quorum Date
quorum_date=$(echo "$pvecm_status_output" | grep -oP 'Date:\s+\K.*' | head -n 1)
# Get the Quorum provider
quorum_provider=$(echo "$pvecm_status_output" | grep -oP 'Quorum provider:\s+\K\w+' | head -n 1)
# Get the Nodes
nodes=$(echo "$pvecm_status_output" | grep -oP 'Nodes:\s+\K\d+' | head -n 1)
# Get the Node ID
node_id=$(echo "$pvecm_status_output" | grep -oP 'Node ID:\s+\K\w+' | head -n 1)
# Get the Ring ID
ring_id=$(echo "$pvecm_status_output" | grep -oP 'Ring ID:\s+\K[\d.]+')
# Get the Quorate
quorate=$(echo "$pvecm_status_output" | grep -oP 'Quorate:\s+\K\w+')

# Create Quorum Status label
quorum_table="<h2>Quorum Status</h2>"
# Create the Quorum Status table
quorum_table+="<table style='white-space:nowrap;'><tr><th>Quorum Date</th><th>Quorum Provider</th><th>Nodes</th><th>Node ID</th><th>Ring ID</th><th>Quorate</th></tr>"
quorum_table+="<tr><td>$quorum_date</td><td>$quorum_provider</td><td>$nodes</td><td>$node_id</td><td>$ring_id</td><td>$quorate</td></tr></table>"

# Votequorum Table
# Get the Expected votes
expected_votes=$(echo "$pvecm_status_output" | grep -oP 'Expected votes:\s+\K\d+')
# Get the Highest expected
highest_expected=$(echo "$pvecm_status_output" | grep -oP 'Highest expected:\s+\K\d+')
# Get the Total votes
total_votes=$(echo "$pvecm_status_output" | grep -oP 'Total votes:\s+\K\d+')
# Get the Quorum
quorum=$(echo "$pvecm_status_output" | grep -oP 'Quorum:\s+\K\d+')
# Get the Flags
flags=$(echo "$pvecm_status_output" | grep -oP 'Flags:\s+\K\w+')

# Create Votequorum Status label
votequorum_table="<h2>Votequorum Status</h2>"
# Create the Votequorum Status table
votequorum_table+="<table style='white-space:nowrap;'><tr><th>Expected Votes</th><th>Highest Expected</th><th>Total Votes</th><th>Quorum</th><th>Flags</th></tr>"
votequorum_table+="<tr><td>$expected_votes</td><td>$highest_expected</td><td>$total_votes</td><td>$quorum</td><td>$flags</td></tr></table>"

# Get the Membership information table
memberships=$(echo "$pvecm_status_output" | grep -oP '0x000000\d+\s+\d+\s+\d+\.\d+\.\d+\.\d+')
# Split memberships into an array
OLDIFS=$IFS
IFS=$'\n' read -r -d '' -a membership_array <<<"$memberships"
IFS=$OLDIFS

# Membership Table
# Create Membership Status label
membership_table="<h2>Membership Status</h2>"
# Create the Membership Status table
membership_table+="<table style='white-space:nowrap;'><tr><th>Node ID</th><th>Votes</th><th>Name</th></tr>"
for membership in "${membership_array[@]}"; do
    node_id=$(echo "$membership" | grep -oP '0x000000\d+')
    votes=$(echo "$membership" | grep -oP '\d+\s+(?=\d+\.\d+\.\d+\.\d+)')
    name=$(echo "$membership" | grep -oP '\d+\.\d+\.\d+\.\d+')
    membership_table+="<tr><td>$node_id</td><td>$votes</td><td>$name</td></tr>"
done
membership_table+="</table>"

# Combine all tables into one
result_table="$cluster_table</br>$quorum_table</br>$votequorum_table</br>$membership_table"

# Save the result to the custom field
_exit_code=0
if [[ -n "$multiline_custom_field" ]]; then
    if [[ -x "$ninjarmm_cli" ]]; then
        if hideOutput=$("$ninjarmm_cli" set "$multiline_custom_field" "$pvecm_status_output" 2>&1); then
            echo "[Info] Successfully set custom field: $multiline_custom_field"
        else
            echo "[Error] Failed to set custom field: $multiline_custom_field. Custom Field does not exit or does not have write permissions."
            _exit_code=1
        fi
    else
        echo "[Error] NinjaRMM CLI not found or not executable"
        _exit_code=1
    fi
fi

if [[ -n "$wysiwyg_custom_field" ]]; then
    if [[ -x "$ninjarmm_cli" ]]; then
        if hideOutput=$("$ninjarmm_cli" set "$wysiwyg_custom_field" "$result_table" 2>&1); then
            echo "[Info] Successfully set custom field: $wysiwyg_custom_field"
        else
            echo "[Error] Failed to set custom field: $wysiwyg_custom_field. Custom Field does not exit or does not have write permissions."
            _exit_code=1
        fi
    else
        echo "[Error] NinjaRMM CLI not found or not executable"
        _exit_code=1
    fi
fi

# Error out after checking both custom fields
if [[ $_exit_code -ne 0 ]]; then
    exit 1
fi

# Output the result if no custom fields are set
if [[ -z "${wysiwyg_custom_field}" ]] && [[ -z "${multiline_custom_field}" ]]; then
    echo "${pvecm_status_output}"
fi

Description détaillée

Décortiquons le script étape par étape pour comprendre son fonctionnement et sa logique.

Initialisation et arguments de ligne de commande : Le script commence par prendre deux arguments de ligne de commande : les noms des champs personnalisés multilignes et WYSIWYG.
Validation et configuration : Il valide et attribue des valeurs aux champs personnalisés, en s’assurant qu’ils ne sont pas nuls ou identiques.
Vérification de la disponibilité de l’outil et des autorisations : Le script vérifie si les outils nécessaires, tels que pvecm et ninjarmm-cli, sont disponibles et s’assure que le script s’exécute avec les privilèges root.
Recherche et analyse de l’état du cluster : Il exécute la commande pvecm status pour récupérer l’état du cluster et stocke le résultat dans une variable.
Extraction d’informations pertinentes : Le script utilise grep et des expressions régulières pour analyser et extraire les informations pertinentes, telles que le nom du cluster, la version de la configuration, la méthode de transport, l’état de l’authentification sécurisée, les informations sur le quorum et les détails sur les membres.
Création de tableaux HTML : Le script formate les données extraites dans des tableaux HTML pour une meilleure lisibilité et organisation.
Enregistrement des résultats dans des champs personnalisés : En fonction de la disponibilité des champs personnalisés, le script enregistre les résultats bruts et formatés dans les champs personnalisés spécifiés à l’aide de la commande ninjarmm-cli.

Cas d’utilisation potentiels

Prenons l’exemple d’une entreprise MSP qui gère plusieurs clusters Proxmox pour différents clients. La vérification et l’enregistrement réguliers de l’état des clusters peuvent prendre beaucoup de temps. Ce script automatise le processus et garantit que des informations actualisées sur le statut sont toujours disponibles dans un format structuré. Par exemple, un professionnel de l’informatique peut utiliser ce script pour :

Collecter et sauvegarder automatiquement l’état des clusters Proxmox tous les matins.

Produire des rapports d’état pour les clients, en soulignant l’intégrité des clusters et tout problème potentiel.

Intégrer des outils de surveillance pour déclencher des alertes si des mesures particulières des clusters indiquent des problèmes.

Comparaisons

Bien qu’il existe d’autres méthodes pour surveiller les clusters Proxmox, comme les vérifications manuelles ou l’utilisation d’outils de surveillance tiers, ce script offre plusieurs avantages :

Automatisation: Contrairement aux vérifications manuelles, ce script automatise le processus, ce qui réduit les risques d’erreur humaine et permet de gagner du temps.

Personnalisation: La possibilité d’enregistrer des informations sur l’état dans des champs personnalisés facilite l’intégration dans les systèmes de surveillance et de création de rapports existants.

Rentable: Cette solution s’appuie sur des outils et des scripts intégrés, ce qui évite d’avoir recours à des solutions tierces coûteuses.

FAQ

Q1 : Dois-je être un expert en script Bash pour utiliser ce script ?

Non, il suffit de savoir exécuter un script et d’en comprendre les paramètres.

Q2 : Puis-je adapter le script à d’autres types de champs personnalisés ?

Oui, vous pouvez modifier le script pour traiter des champs personnalisés supplémentaires en adaptant les sections correspondantes.

Q3 : Que se passe-t-il si le script rencontre une erreur ?

Le script comprend une gestion des erreurs qui vous informe des outils manquants, des problèmes de permissions ou des échecs de commande.

Implications

La surveillance régulière de l’état du cluster Proxmox permet de maintenir la fiabilité et les performances du système. En utilisant ce script, les professionnels de l’informatique peuvent gérer de manière proactive l’état des clusters, prévenir les temps d’arrêt et garantir une utilisation optimale des ressources. Cela contribue à la sécurité informatique globale et à l’efficacité opérationnelle.

Recommandations

Exécuter régulièrement: Planifiez l’exécution du script à intervalles réguliers à l’aide de tâches cron afin d’assurer une surveillance continue.

Vérifier les résultats: Examiner régulièrement les résultats enregistrés afin d’identifier rapidement toute anomalie ou tout problème.

Maintenir les sauvegardes: Conservez des sauvegardes de vos configurations de cluster et mettez régulièrement à jour vos scripts pour gérer les nouvelles versions de Proxmox.

Conclusion

Une surveillance efficace est cruciale pour la gestion des clusters Proxmox, et ce script Bash fournit une solution optimale pour les professionnels de l’informatique et les entreprises MSP. En automatisant la collecte des états et en formatant les résultats dans des champs personnalisés, il améliore la capacité à maintenir l’état et les performances des clusters. Des outils comme NinjaOne complètent ce script en fournissant une plateforme complète pour la gestion informatique, garantissant que tous vos besoins en matière de surveillance sont satisfaits de manière efficace.

Guide complet pour la surveillance de l’état des clusters Proxmox sur Linux

Contexte

Le script

Description détaillée

Cas d’utilisation potentiels

Comparaisons

FAQ

Q1 : Dois-je être un expert en script Bash pour utiliser ce script ?

Q2 : Puis-je adapter le script à d’autres types de champs personnalisés ?

Q3 : Que se passe-t-il si le script rencontre une erreur ?

Implications

Recommandations

Conclusion

Pour aller plus loin

Utiliser ce script

Connectez-vous avec d'autres Ninjas de l'informatique sur Discord

Ressources

Société

Contact

Contexte

Le script

Description détaillée

Cas d’utilisation potentiels

Comparaisons

FAQ

Q1 : Dois-je être un expert en script Bash pour utiliser ce script ?

Q2 : Puis-je adapter le script à d’autres types de champs personnalisés ?

Q3 : Que se passe-t-il si le script rencontre une erreur ?

Implications

Recommandations

Conclusion

Pour aller plus loin

Download the script

Termes et conditions NinjaOne