{"id":353643,"date":"2024-08-02T13:34:10","date_gmt":"2024-08-02T13:34:10","guid":{"rendered":"https:\/\/www.ninjaone.com\/script-hub\/surveillance-etat-des-clusters-proxmox-linux\/"},"modified":"2024-10-13T19:06:46","modified_gmt":"2024-10-13T19:06:46","slug":"surveillance-etat-des-clusters-proxmox-linux","status":"publish","type":"script_hub","link":"https:\/\/www.ninjaone.com\/fr\/script-hub\/surveillance-etat-des-clusters-proxmox-linux\/","title":{"rendered":"Guide complet pour la surveillance de l’\u00e9tat des clusters Proxmox sur Linux"},"content":{"rendered":"

Le maintien de la stabilit\u00e9 et des performances d’un cluster Proxmox est crucial pour les professionnels de l’informatique et les fournisseurs de services g\u00e9r\u00e9s (MSP)<\/a>. Un cluster Proxmox offre de nombreux avantages, notamment une haute disponibilit\u00e9, une gestion efficace des ressources ainsi qu’une virtualisation optimale. Cependant, il est essentiel de surveiller son \u00e9tat pour garantir un fonctionnement sans probl\u00e8mes.<\/p>\n

Cet article pr\u00e9sente un script Bash con\u00e7u pour obtenir l’\u00e9tat du cluster Proxmox<\/strong> et l’enregistrer dans un champ personnalis\u00e9. Nous explorerons les fonctionnalit\u00e9s du script, les cas d’utilisation potentiels, les comparaisons, une FAQ, les implications et les bonnes pratiques.<\/p>\n

Contexte<\/h2>\n

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\u00e9ployer et de g\u00e9rer des machines virtuelles et des conteneurs. Cr\u00e9er un cluster dans Proxmox est une fonctionnalit\u00e9 fondamentale qui permet \u00e0 plusieurs n\u0153uds Proxmox VE de travailler ensemble, offrant ainsi une haute disponibilit\u00e9 et un \u00e9quilibrage de la charge. La surveillance de l’\u00e9tat du cluster est essentielle pour maintenir l’int\u00e9grit\u00e9 et les performances de l’environnement virtuel.<\/p>\n

Ce script est con\u00e7u pour les professionnels de l’informatique qui ont besoin d’un moyen efficace pour surveiller les clusters Proxmox. Il r\u00e9cup\u00e8re l’\u00e9tat du cluster et enregistre les informations dans un champ personnalis\u00e9 multiligne ou un champ personnalis\u00e9 WYSIWYG, ce qui facilite la gestion et l’examen de l’\u00e9tat du cluster.<\/p>\n

Le script<\/h2>\n
#!\/usr\/bin\/env bash\r\n\r\n# Description: Get the Proxmox Cluster Status and save it to a multiline and\/or WYSIWYG custom field\r\n#\r\n# Release Notes: Fixed 10% width bug.\r\n# 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.\r\n# 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. \r\n# 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. \r\n# 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. \r\n# Warranty Disclaimer: The script is provided \u201cas is\u201d and \u201cas available\u201d, 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. \r\n# 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. \r\n# 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. \r\n# EULA: If you are a NinjaOne customer, your use of the script is subject to the End User License Agreement applicable to you (EULA).\r\n\r\n# Command line arguments, swap the numbers if you want the multiline custom field to be the second argument\r\nmultiline_custom_field=$1 # First argument is the multiline custom field name\r\nwysiwyg_custom_field=$2   # Second argument is the WYSIWYG custom field name\r\n\r\nif [[ -n \"${multilineCustomField}\" && \"${multilineCustomField}\" != \"null\" ]]; then\r\n    multiline_custom_field=$multilineCustomField\r\nfi\r\nif [[ -n \"${wysiwygCustomField}\" && \"${wysiwygCustomField}\" != \"null\" ]]; then\r\n    wysiwyg_custom_field=$wysiwygCustomField\r\nfi\r\n\r\nif [[ -n \"${multiline_custom_field}\" && \"${multiline_custom_field}\" == \"${wysiwyg_custom_field}\" ]]; then\r\n    echo \"[Error] multilineCustomField and wysiwygCustomField cannot be the same custom field.\"\r\n    exit 1\r\nfi\r\n\r\nif [[ -z \"${multiline_custom_field}\" ]]; then\r\n    echo \"[Info] multilineCustomField is not set.\"\r\nfi\r\nif [[ -z \"${wysiwyg_custom_field}\" ]]; then\r\n    echo \"[Info] wysiwygCustomField is not set.\"\r\nfi\r\n\r\n# Check that we have the required tools\r\nif ! command -v pvecm &>\/dev\/null; then\r\n    echo \"[Error] The Proxmox VE API tool 'pvecm' is required.\"\r\n    exit 1\r\nfi\r\n\r\n# Check that we are running as root\r\nif [[ $EUID -ne 0 ]]; then\r\n    echo \"[Error] This script must be run as root.\"\r\n    exit 1\r\nfi\r\n\r\n# Check if ninjarmm-cli command exists\r\nninjarmm_cli=\"\/opt\/NinjaRMMAgent\/programdata\/ninjarmm-cli\"\r\nif [[ -z $ninjarmm_cli ]]; then\r\n    echo \"[Error] The ninjarmm-cli command does not exist in the default path. Please ensure the NinjaRMM agent is installed before running this script.\"\r\n    exit 1\r\nelse\r\n    # ninjarmm-cli command exists in the default path\r\n    echo -n\r\nfi\r\n\r\n# Run the pvecm command to get the status information\r\nif ! pvecm_status_output=$(pvecm status); then\r\n    echo \"[Error] Failed to get the Proxmox Cluster Status.\"\r\n    echo \"$pvecm_status_output\"\r\n    exit 1\r\nfi\r\n# Example Output:\r\n# Cluster information\r\n# -------------------\r\n# Name:             cluster1\r\n# Config Version:   4\r\n# Transport:        knet\r\n# Secure auth:      on\r\n#\r\n# Quorum information\r\n# ------------------\r\n# Date:             Mon Apr  8 10:33:16 2024\r\n# Quorum provider:  corosync_votequorum\r\n# Nodes:            4\r\n# Node ID:          0x00000004\r\n# Ring ID:          1.631\r\n# Quorate:          Yes\r\n#\r\n# Votequorum information\r\n# ----------------------\r\n# Expected votes:   4\r\n# Highest expected: 4\r\n# Total votes:      4\r\n# Quorum:           3\r\n# Flags:            Quorate\r\n#\r\n# Membership information\r\n# ----------------------\r\n#     Nodeid      Votes Name\r\n# 0x00000001          1 10.10.10.17\r\n# 0x00000002          1 10.10.10.18\r\n# 0x00000003          1 10.10.10.19\r\n# 0x00000004          1 10.10.10.20 (local)\r\n\r\n# Cluster Table\r\n# Get the cluster name\r\ncluster_name=$(echo \"$pvecm_status_output\" | grep -oP 'Name:\\s+\\K\\w+' | head -n 1)\r\n# Get the Config Version\r\nconfig_version=$(echo \"$pvecm_status_output\" | grep -oP 'Config Version:\\s+\\K\\d+' | head -n 1)\r\n# Get the Transport\r\ntransport=$(echo \"$pvecm_status_output\" | grep -oP 'Transport:\\s+\\K\\w+' | head -n 1)\r\n# Get the Secure auth\r\nsecure_auth=$(echo \"$pvecm_status_output\" | grep -oP 'Secure auth:\\s+\\K\\w+' | head -n 1)\r\n\r\n# Create Cluster Status label\r\ncluster_table=\"<h2>Cluster Status<\/h2>\"\r\n# Create the Cluster Status table\r\ncluster_table+=\"<table style='white-space:nowrap;'><tr><th>Cluster Name<\/th><th>Config Version<\/th><th>Transport<\/th><th>Secure Auth<\/th><\/tr>\"\r\ncluster_table+=\"<tr><td>$cluster_name<\/td><td>$config_version<\/td><td>$transport<\/td><td>$secure_auth<\/td><\/tr><\/table>\"\r\n\r\n# Quorum Table\r\n# Get the Quorum Date\r\nquorum_date=$(echo \"$pvecm_status_output\" | grep -oP 'Date:\\s+\\K.*' | head -n 1)\r\n# Get the Quorum provider\r\nquorum_provider=$(echo \"$pvecm_status_output\" | grep -oP 'Quorum provider:\\s+\\K\\w+' | head -n 1)\r\n# Get the Nodes\r\nnodes=$(echo \"$pvecm_status_output\" | grep -oP 'Nodes:\\s+\\K\\d+' | head -n 1)\r\n# Get the Node ID\r\nnode_id=$(echo \"$pvecm_status_output\" | grep -oP 'Node ID:\\s+\\K\\w+' | head -n 1)\r\n# Get the Ring ID\r\nring_id=$(echo \"$pvecm_status_output\" | grep -oP 'Ring ID:\\s+\\K[\\d.]+')\r\n# Get the Quorate\r\nquorate=$(echo \"$pvecm_status_output\" | grep -oP 'Quorate:\\s+\\K\\w+')\r\n\r\n# Create Quorum Status label\r\nquorum_table=\"<h2>Quorum Status<\/h2>\"\r\n# Create the Quorum Status table\r\nquorum_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>\"\r\nquorum_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>\"\r\n\r\n# Votequorum Table\r\n# Get the Expected votes\r\nexpected_votes=$(echo \"$pvecm_status_output\" | grep -oP 'Expected votes:\\s+\\K\\d+')\r\n# Get the Highest expected\r\nhighest_expected=$(echo \"$pvecm_status_output\" | grep -oP 'Highest expected:\\s+\\K\\d+')\r\n# Get the Total votes\r\ntotal_votes=$(echo \"$pvecm_status_output\" | grep -oP 'Total votes:\\s+\\K\\d+')\r\n# Get the Quorum\r\nquorum=$(echo \"$pvecm_status_output\" | grep -oP 'Quorum:\\s+\\K\\d+')\r\n# Get the Flags\r\nflags=$(echo \"$pvecm_status_output\" | grep -oP 'Flags:\\s+\\K\\w+')\r\n\r\n# Create Votequorum Status label\r\nvotequorum_table=\"<h2>Votequorum Status<\/h2>\"\r\n# Create the Votequorum Status table\r\nvotequorum_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>\"\r\nvotequorum_table+=\"<tr><td>$expected_votes<\/td><td>$highest_expected<\/td><td>$total_votes<\/td><td>$quorum<\/td><td>$flags<\/td><\/tr><\/table>\"\r\n\r\n# Get the Membership information table\r\nmemberships=$(echo \"$pvecm_status_output\" | grep -oP '0x000000\\d+\\s+\\d+\\s+\\d+\\.\\d+\\.\\d+\\.\\d+')\r\n# Split memberships into an array\r\nOLDIFS=$IFS\r\nIFS=$'\\n' read -r -d '' -a membership_array <<<\"$memberships\"\r\nIFS=$OLDIFS\r\n\r\n# Membership Table\r\n# Create Membership Status label\r\nmembership_table=\"<h2>Membership Status<\/h2>\"\r\n# Create the Membership Status table\r\nmembership_table+=\"<table style='white-space:nowrap;'><tr><th>Node ID<\/th><th>Votes<\/th><th>Name<\/th><\/tr>\"\r\nfor membership in \"${membership_array[@]}\"; do\r\n    node_id=$(echo \"$membership\" | grep -oP '0x000000\\d+')\r\n    votes=$(echo \"$membership\" | grep -oP '\\d+\\s+(?=\\d+\\.\\d+\\.\\d+\\.\\d+)')\r\n    name=$(echo \"$membership\" | grep -oP '\\d+\\.\\d+\\.\\d+\\.\\d+')\r\n    membership_table+=\"<tr><td>$node_id<\/td><td>$votes<\/td><td>$name<\/td><\/tr>\"\r\ndone\r\nmembership_table+=\"<\/table>\"\r\n\r\n# Combine all tables into one\r\nresult_table=\"$cluster_table<\/br>$quorum_table<\/br>$votequorum_table<\/br>$membership_table\"\r\n\r\n# Save the result to the custom field\r\n_exit_code=0\r\nif [[ -n \"$multiline_custom_field\" ]]; then\r\n    if [[ -x \"$ninjarmm_cli\" ]]; then\r\n        if hideOutput=$(\"$ninjarmm_cli\" set \"$multiline_custom_field\" \"$pvecm_status_output\" 2>&1); then\r\n            echo \"[Info] Successfully set custom field: $multiline_custom_field\"\r\n        else\r\n            echo \"[Error] Failed to set custom field: $multiline_custom_field. Custom Field does not exit or does not have write permissions.\"\r\n            _exit_code=1\r\n        fi\r\n    else\r\n        echo \"[Error] NinjaRMM CLI not found or not executable\"\r\n        _exit_code=1\r\n    fi\r\nfi\r\n\r\nif [[ -n \"$wysiwyg_custom_field\" ]]; then\r\n    if [[ -x \"$ninjarmm_cli\" ]]; then\r\n        if hideOutput=$(\"$ninjarmm_cli\" set \"$wysiwyg_custom_field\" \"$result_table\" 2>&1); then\r\n            echo \"[Info] Successfully set custom field: $wysiwyg_custom_field\"\r\n        else\r\n            echo \"[Error] Failed to set custom field: $wysiwyg_custom_field. Custom Field does not exit or does not have write permissions.\"\r\n            _exit_code=1\r\n        fi\r\n    else\r\n        echo \"[Error] NinjaRMM CLI not found or not executable\"\r\n        _exit_code=1\r\n    fi\r\nfi\r\n\r\n# Error out after checking both custom fields\r\nif [[ $_exit_code -ne 0 ]]; then\r\n    exit 1\r\nfi\r\n\r\n# Output the result if no custom fields are set\r\nif [[ -z \"${wysiwyg_custom_field}\" ]] && [[ -z \"${multiline_custom_field}\" ]]; then\r\n    echo \"${pvecm_status_output}\"\r\nfi<\/pre>\n
 <\/p>\n\n
<\/h2>
<\/p><\/div>
<\/a><\/div><\/div>\n
Description d\u00e9taill\u00e9e<\/h2>\n
D\u00e9cortiquons le script \u00e9tape par \u00e9tape pour comprendre son fonctionnement et sa logique.<\/p>\n
    \n
  1. Initialisation et arguments de ligne de commande : <\/strong>Le script commence par prendre deux arguments de ligne de commande : les noms des champs personnalis\u00e9s multilignes et WYSIWYG.<\/li>\n
  2. Validation et configuration : <\/strong>Il valide et attribue des valeurs aux champs personnalis\u00e9s, en s’assurant qu’ils ne sont pas nuls ou identiques.<\/li>\n
  3. V\u00e9rification de la disponibilit\u00e9 de l’outil et des autorisations : <\/strong>Le script v\u00e9rifie si les outils n\u00e9cessaires, tels que pvecm et ninjarmm-cli, sont disponibles et s’assure que le script s’ex\u00e9cute avec les privil\u00e8ges root.<\/li>\n
  4. Recherche et analyse de l’\u00e9tat du cluster : <\/strong>Il ex\u00e9cute la commande pvecm status pour r\u00e9cup\u00e9rer l’\u00e9tat du cluster et stocke le r\u00e9sultat dans une variable.<\/li>\n
  5. Extraction d’informations pertinentes : <\/strong>Le script utilise grep et des expressions r\u00e9guli\u00e8res pour analyser et extraire les informations pertinentes, telles que le nom du cluster, la version de la configuration, la m\u00e9thode de transport, l’\u00e9tat de l’authentification s\u00e9curis\u00e9e, les informations sur le quorum et les d\u00e9tails sur les membres.<\/li>\n
  6. Cr\u00e9ation de tableaux HTML : <\/strong>Le script formate les donn\u00e9es extraites dans des tableaux HTML pour une meilleure lisibilit\u00e9 et organisation.<\/li>\n
  7. Enregistrement des r\u00e9sultats dans des champs personnalis\u00e9s : <\/strong>En fonction de la disponibilit\u00e9 des champs personnalis\u00e9s, le script enregistre les r\u00e9sultats bruts et format\u00e9s dans les champs personnalis\u00e9s sp\u00e9cifi\u00e9s \u00e0 l’aide de la commande ninjarmm-cli.<\/li>\n<\/ol>\n
    Cas d’utilisation potentiels<\/h2>\n
    Prenons l’exemple d’une entreprise MSP qui g\u00e8re plusieurs clusters Proxmox pour diff\u00e9rents clients. La v\u00e9rification et l’enregistrement r\u00e9guliers de l’\u00e9tat des clusters peuvent prendre beaucoup de temps. Ce script automatise le processus et garantit que des informations actualis\u00e9es sur le statut sont toujours disponibles dans un format structur\u00e9. Par exemple, un professionnel de l’informatique peut utiliser ce script pour :<\/p>\n