Umfassender Guide für die Proxmox-Cluster-Statusüberwachung unter Linux

Die Aufrechterhaltung der Stabilität und Leistung eines Proxmox-Clusters ist für IT-Experten und Managed Service Provider (MSPs) essenziell. Ein Proxmox-Cluster bietet zahlreiche Vorteile, darunter hohe Verfügbarkeit, effiziente Ressourcenverwaltung und nahtlose Virtualisierung. Die Proxmox-Cluster-Statusüberwachung ist daher für einen reibungslosen Betrieb unerlässlich.

In diesem Blogbeitrag wird ein Bash-Skript vorgestellt, mit dem der Status ermittelt und in einem benutzerdefinierten Feld gespeichert werden kann. Wir werden die Funktionalität und mögliche Anwendungsfälle des Skripts, Vergleiche, häufig gestellte Fragen, Auswirkungen und Best Practices aufgreifen.

Kontext

Proxmox Virtual Environment (VE) ist eine Open-Source-Lösung zur Verwaltung der Servervirtualisierung, mit der IT-Experten virtuelle Maschinen und Container bereitstellen und verwalten können. Clustering in Proxmox ist eine grundlegende Funktion, die es mehreren Proxmox VE-Netzwerk-Knoten ermöglicht, zusammenzuarbeiten und so eine hohe Verfügbarkeit und Lastverteilung zu gewährleisten. Die Proxmox-Cluster-Statusüberwachung ist entscheidend für die Aufrechterhaltung der Integrität und Leistung der virtuellen Umgebung.

Dieses Skript ist für IT-Experten gedacht, die eine effiziente Methode zur Überwachung von Proxmox-Clustern benötigen. Es ruft den Cluster-Status ab und speichert die Informationen entweder in einem mehrzeiligen benutzerdefinierten Feld oder in einem benutzerdefinierten WYSIWYG-Feld, was die Verwaltung und Überprüfung des Status erleichtert.

Das Skript

#!/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

 

Detailansicht

Lassen Sie uns das Skript Schritt für Schritt aufschlüsseln, um seine Funktionsweise und die dahinter stehende Logik zu verstehen.

1. Initialisierung und Befehlszeilenargumente: Das Skript beginnt mit zwei Befehlszeilenargumenten: die Namen der benutzerdefinierten mehrzeiligen und WYSIWYG-Felder.
2. Validierung und Konfiguration: Es validiert und weist den benutzerdefinierten Feldern Werte zu bzw. stellt sicher, dass sie nicht null oder identisch sind.
3. Verfügbarkeits- und Berechtigungsprüfung: Das Skript prüft, ob die erforderlichen Tools wie pvecm und ninjarmm-cli verfügbar sind, und sorgt dafür, dass das Skript mit Root-Rechten ausgeführt wird.
4. Abrufen und Parsen des Cluster-Status: Es führt den Befehl ‚pvecm status‘ aus, um den Cluster-Status abzufragen, und speichert die Ausgabe in einer Variablen.
5. Extrahieren relevanter Informationen: Das Skript verwendet grep und reguläre Ausdrücke, um relevante Informationen zu analysieren und zu extrahieren, z. B. den Clusternamen, die Konfigurationsversion, die Transportmethode, den sicheren Auth-Status, Quorum-Informationen und Mitgliedschaftsdetails.
6. Erstellung von HTML-Tabellen: Das Skript formatiert die extrahierten Daten zur besseren Lesbarkeit und Organisierung in HTML-Tabellen.
7. Speichern von Ergebnissen in benutzerdefinierten Feldern: Je nach Verfügbarkeit der benutzerdefinierten Felder speichert das Skript die rohen und formatierten Ergebnisse mit dem Befehl ’ninjarmm-cli‘ in den angegebenen benutzerdefinierten Feldern.

Potenzielle Anwendungsfälle

Nehmen wir an, ein MSP verwaltet mehrere Proxmox-Cluster für verschiedene Kunden. Die regelmäßige Überprüfung und Erfassung des Cluster-Status kann zeitaufwändig sein. Dieses Skript automatisiert den Prozess und sorgt dafür, dass stets aktuelle Statusinformationen in einem strukturierten Format verfügbar sind. Ein IT-Experte kann dieses Skript zum Beispiel verwenden, um:

• den Status des Proxmox-Clusters jeden Morgen automatisch zu sammeln und speichern.

• Statusberichten für Kunden zu erstellen, die den Cluster-Status und mögliche Probleme aufzeigen.

• Überwachungs-Tools zu integrieren, sodass Warnmeldungen ausgelöst werden, wenn bestimmte Cluster-Metriken auf Probleme hinweisen.

Vergleiche

Es gibt zwar auch andere Methoden zur Proxmox-Cluster-Statusüberwachung, z. B. manuelle Überprüfungen oder die Verwendung von Überwachungsprogrammen von Drittanbietern, aber dieses Skript bietet mehrere Vorteile:

• Automatisierung: Im Gegensatz zu manuellen Kontrollen automatisiert dieses Skript den Prozess, wodurch die Gefahr menschlichen Versagens verringert und Zeit gespart wird.

• Anpassungen: Die Möglichkeit, Statusinformationen in benutzerdefinierten Feldern zu speichern, gewährt eine einfache Integration in bestehende Überwachungs- und Berichterstellungs-Systeme.

• Kostengünstig: Diese Lösung nutzt integrierte Tools und Skripte, sodass keine teuren Lösungen von Drittanbietern erforderlich sind.

FAQs

Q1: Muss ich ein Experte in der Bash-Skripterstellung sein, um dieses Skript zu verwenden?

Nein, Sie brauchen nur Grundkenntnisse darüber, wie man ein Skript ausführt, und müssen seine Parameter verstehen.

Q2: Kann ich das Skript für andere Arten von benutzerdefinierten Feldern einstellen?

Ja, Sie können das Skript ändern, um zusätzliche benutzerdefinierte Felder zu bearbeiten, indem Sie die entsprechenden Abschnitte anpassen.

Q3: Was passiert, wenn das Skript auf einen Fehler stößt?

Das Skript enthält eine Fehlerbehandlungs-Lösung, die Sie über fehlende Tools, Berechtigungsprobleme oder fehlerhafte Befehle informiert.

Folgen

Die regelmäßige Proxmox-Cluster-Statusüberwachung trägt zur Aufbewahrung der Zuverlässigkeit und Leistung des Systems bei. Mithilfe dieses Skripts können IT-Experten den Zustand von Clustern proaktiv verwalten, Ausfallzeiten verhindern und eine optimale Ressourcennutzung sicherstellen. Dies trägt zur allgemeinen IT-Sicherheit und betrieblichen Effizienz bei.

Empfehlungen

• Lassen Sie es regelmäßig laufen: Planen Sie die Ausführung des Skripts in regelmäßigen Abständen mit Cron-Jobs, um eine kontinuierliche Überwachung zu gewährleisten.

• Überprüfen Sie die Ergebnisse: Überprüfen Sie regelmäßig die gespeicherten Ergebnisse, um Anomalien oder Probleme frühzeitig zu entdecken.

• Bewahren Sie Backups auf: Erstellen Sie Backups Ihrer Cluster-Konfigurationen und aktualisieren Sie Ihre Skripte regelmäßig, sodass sie neue Proxmox-Versionen verarbeiten können.

Abschließende Überlegungen

Eine effiziente Überwachung ist für die Verwaltung von Proxmox-Clustern ausschlaggebend, und dieses Bash-Skript bietet IT-Experten und MSPs eine optimierte Lösung dafür. Durch die Automatisierung der Statuserfassung und die Formatierung der Ergebnisse in benutzerdefinierten Feldern verbessert sich die Fähigkeit, den Zustand und die Leistung des Clusters zu erhalten. Tools wie NinjaOne ergänzen dieses Skript, indem sie eine umfassende Plattform für die IT-Verwaltung bieten und sorgen dafür, dass alle Ihre Überwachungsanforderungen effizient erfüllt werden.