Guida agli script Linux: come recuperare lo stato dello storage dei nodi Proxmox

La gestione efficace dello storage è un aspetto cruciale per mantenere un’infrastruttura IT solida ed efficiente. Per i professionisti IT e i provider di servizi gestiti (MSP), disporre di strumenti che forniscono informazioni dettagliate sullo stato dello storage può migliorare notevolmente l’efficienza operativa.

Uno di questi strumenti è lo script bash progettato per recuperare lo stato dello storage dei nodi Proxmox e visualizzarne i dettagli. Questo post del blog esplorerà le funzionalità dello script, la sua importanza e la sua applicazione in scenari reali.

Background

In un ambiente virtualizzato come Proxmox, la comprensione dello stato dello storage dei nodi è fondamentale per l’ottimizzazione delle prestazioni, la risoluzione dei problemi e la pianificazione dell’uso delle capacità. Proxmox VE (Virtual Environment) è una soluzione open-source per la gestione della virtualizzazione dei server che offre una potente piattaforma per la gestione di virtual machine, container, storage e networking.

Lo script fornito sfrutta l’API di Proxmox e lo strumento NinjaRMM CLI per raccogliere e mostrare informazioni dettagliate sullo storage dei nodi Proxmox, che possono essere salvate in campi personalizzati per ulteriori analisi o documentazione. Questo script è particolarmente utile per gli MSP che devono monitorare più ambienti client e garantire prestazioni e disponibilità ottimali.

Lo script per recuperare lo stato dello storage dei nodi Proxmox:

#!/usr/bin/env bash

# Description: Get the details of a Proxmox Node Storage 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/it/condizioni-utilizzo
# 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

# Check if the multilineCustomField and wysiwygCustomField are set
if [[ -n "${multilineCustomField}" && "${multilineCustomField}" != "null" ]]; then
    multiline_custom_field=$multilineCustomField
fi
if [[ -n "${wysiwygCustomField}" && "${wysiwygCustomField}" != "null" ]]; then
    wysiwyg_custom_field=$wysiwygCustomField
fi

# Check if the multiline_custom_field and wysiwyg_custom_field are the same
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

# Check if the multiline_custom_field and wysiwyg_custom_field are set
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 pvesh &>/dev/null; then
    echo "[Error] The Proxmox VE API tool 'pvesh' 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

function GetThisNodeName() {
    # Get the node name
    if ! node_name=$(pvesh get /cluster/status --noborder | awk '$6 == 1 {print $2}'); then
        echo "[Error] Failed to get the node name."
        echo "$node_name"
        exit 1
    fi
    echo "$node_name"
}

# Run the pvesh command to get the status information
if ! storages=$(pvesh get /storage --noborder | tail +2); then
    echo "[Error] Failed to get the list of storages."
    echo "$storages"
    exit 1
fi
# Example Output:
# local
# local-zfs
# storage-nas

function formatStorage() {
    echo ""
    echo "Storage Status:"
    # Loop though the storages and get the status of each
    for storage in $storages; do
        # Get the status of the storage
        if ! storage_status=$(pvesh get /storage/"$storage" --noborder); then
            echo "[Error] Failed to get the Storage Status of $storage."
            echo "$storage_status"
            exit 1
        fi
        storage_node=$(GetThisNodeName)
        # Get the storage name
        storage_name=$(echo "$storage_status" | grep -P 'storage\s+' | awk '{print $2}')
        # Get the free space
        # "$storage_name " is used to avoid matching "local-zfs" when searching for "local"
        storage_free_space=$(pvesh get "/nodes/$storage_node/storage" --noborder | grep -P "$storage_name " | awk '{print $5" "$6}')
        # Get the total space
        storage_total_space=$(pvesh get "/nodes/$storage_node/storage" --noborder | grep -P "$storage_name " | awk '{print $9" "$10}')
        echo -n
        echo ""
        echo "$storage"
        echo "-------------"
        # Take the output of $storage_status, skip the first line, then use a colon as a separator between the key and value
        echo "$storage_status" | tail +2 | awk '{print $1 ": " $2}'
        echo "Free: $storage_free_space"
        echo "Total: $storage_total_space"
    done
}
multiline_output=$(formatStorage)

# Create Storage Status label
storage_table="<h2>Storage Status</h2>"
# Create the Storage Status table
storage_table+="<table style='white-space:nowrap;'><tr><th>Storage Name</th><th>Type</th><th>Path/File System</th><th>Free Space</th><th>Total Space</th><th>Content</th></tr>"

# Loop though the storages and get the status of each
for storage in $storages; do
    if ! storage_status=$(pvesh get /storage/"$storage" --noborder); then
        echo "[Error] Failed to get the Storage Status of $storage."
        echo "$storage_status"
        exit 1
    fi
    # Example Output:
    # key     value
    # content images,rootdir
    # digest  c14cb4c9bbcf9a062fa8a82b10afe01cb1ed5b8d
    # pool    rpool/data
    # sparse  1
    # storage local-zfs
    # type    zfspool
    storage_node=$(GetThisNodeName)
    # Get the storage name
    storage_name=$(echo "$storage_status" | grep -P 'storage\s+' | awk '{print $2}')
    # Get the storage type
    storage_type=$(echo "$storage_status" | grep -P 'type\s+' | awk '{print $2}')
    # Get the storage pool/path
    storage_pool=$(echo "$storage_status" | grep -P 'pool\s+' | awk '{print $2}')
    if [[ -z "${storage_pool}" ]]; then
        storage_pool=$(echo "$storage_status" | grep -P 'path\s+' | awk '{print $2}')
    fi
    # Get the storage content
    storage_content=$(echo "$storage_status" | grep -P 'content\s+' | awk '{print $2}')
    # Get the free space
    # "$storage_name " is used to avoid matching "local-zfs" when searching for "local"
    storage_free_space=$(pvesh get "/nodes/$storage_node/storage" --noborder | grep -P "$storage_name " | awk '{print $5" "$6}')
    # Get the total space
    storage_total_space=$(pvesh get "/nodes/$storage_node/storage" --noborder | grep -P "$storage_name " | awk '{print $9" "$10}')

    # Add to the Storage Status table
    storage_table+="<tr><td>$storage_name</td><td>$storage_type</td><td>$storage_pool</td><td>$storage_free_space</td><td>$storage_total_space</td><td>$storage_content</td></tr>"
done

# Close the Storage Status table
storage_table+="</table>"

# Save the results
result_table="$storage_table"

_exit_code=0
# Save the result to the custom field
if [[ -n "$wysiwyg_custom_field" ]]; then
    if [[ -x "$ninjarmm_cli" ]]; then
        if hideOutput=$(echo "$result_table" | "$ninjarmm_cli" set --stdin "$wysiwyg_custom_field" 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

if [[ -n "$multiline_custom_field" ]]; then
    if [[ -x "$ninjarmm_cli" ]]; then
        if hideOutput=$(echo "$multiline_output" | "$ninjarmm_cli" set --stdin "$multiline_custom_field" 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

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

if [[ $_exit_code -eq 1 ]]; then
    exit 1
fi

 

Analisi dettagliata

Approfondiamo lo script per recuperare lo stato dello storage dei nodi Proxmox per comprenderne il funzionamento passo dopo passo.

1. Inizializzazione e parsing degli argomenti: Lo script per recuperare lo stato dello storage dei nodi Proxmox inizia con il parsing degli argomenti della riga di comando per determinare i nomi dei campi personalizzati in cui saranno memorizzati i dettagli sullo spazio di archiviazione. Accetta due argomenti: uno per un campo personalizzato multilinea e un altro per un campo personalizzato WYSIWYG. Questi campi sono utilizzati per memorizzare le informazioni di memorizzazione formattate per facilitare la lettura e l’analisi.
2. Convalida dei campi personalizzati: Lo script per recuperare lo stato dello storage dei nodi Proxmox controlla se i campi personalizzati sono impostati tramite variabili d’ambiente o argomenti della riga di comando. Assicura che i due campi non siano uguali per evitare conflitti.
3. Verifica della disponibilità dello strumento e delle autorizzazioni: Lo script per recuperare lo stato dello storage dei nodi Proxmox verifica la disponibilità del comando pvesh, utilizzato per interagire con l’API di Proxmox, e si assicura che sia eseguito con i privilegi di root.
4. Convalida NinjaOne CLI: Lo script per recuperare lo stato dello storage dei nodi Proxmox verifica l’esistenza dello strumento NinjaRMM CLI, necessario per l’aggiornamento dei campi personalizzati.
5. Recupero del nome del nodo: Lo script per recuperare lo stato dello storage dei nodi Proxmox definisce una funzione per recuperare il nome del nodo Proxmox, necessario per individuare i dettagli specifici dello storage.
6. Recupero e formattazione delle informazioni sullo storage: Lo script recupera l’elenco degli spazi di archiviazione e itera su ogni elemento di storage per raccogliere informazioni dettagliate sullo stato dello storage dei nodi Proxmox, compreso lo spazio libero e totale. Queste informazioni sono formattate sia per i campi personalizzati multilinea che per quelli WYSIWYG.
7. Creazione della tabella HTML: Lo script per recuperare lo stato dello storage dei nodi Proxmox costruisce una tabella HTML per il campo personalizzato WYSIWYG, inserendo i dati sullo stato dello storage in un formato tabellare.
8. Salvataggio dei risultati: Infine, lo script salva le informazioni sugli spazi di archiviazione formattate nei campi personalizzati specificati utilizzando lo strumento NinjaRMM CLI.

Casi d’uso potenziali

Immagina un MSP che gestisce più ambienti di clienti con Proxmox. Deve controllare regolarmente lo stato dello storage dei nodi Proxmox per assicurarsi che ci sia abbastanza spazio libero per i backup e le operazioni delle virtual machine. Utilizzando questo script, l’MSP può automatizzare il recupero delle informazioni sullo spazio di archiviazione e salvarle in campi personalizzati per ogni cliente, consentendo un rapido accesso ai dati critici senza interventi manuali. L’automazione riduce il rischio di errori umani e garantisce aggiornamenti tempestivi sullo stato dello storage.

Confronti

Sebbene questo script offra una soluzione su misura per gli ambienti Proxmox integrati con NinjaOne, altri metodi per recuperare le informazioni sugli storage includono l’uso di strumenti nativi di Proxmox come l’interfaccia web o script personalizzati senza l’integrazione con NinjaOne.

Tuttavia, questi metodi possono mancare dell’automazione e delle funzionalità di gestione centralizzata fornite dalla combinazione di questo script e di NinjaOne, e questo li rende meno efficienti per gli MSP che gestiscono più ambienti.

Domande frequenti

Che cos’è Proxmox VE?

Proxmox VE è una piattaforma open-source per la gestione della virtualizzazione dei server che consente di gestire virtual machine, container, storage e reti.

Che cos’è NinjaOne?

NinjaOne è uno strumento di monitoraggio e gestione remota (RMM) che aiuta gli MSP e i professionisti IT a gestire gli ambienti dei clienti da una piattaforma centralizzata.

Ho bisogno dell’accesso root per eseguire questo script per recuperare lo stato dello storage dei nodi Proxmox?

Sì, per recuperare le informazioni sullo storage dai nodi Proxmox è necessario l’accesso root.

Questo script può essere utilizzato senza NinjaOne?

Lo script per recuperare lo stato dello storage dei nodi Proxmox è progettato per integrarsi con NinjaOne per la memorizzazione dei dati dei campi personalizzati. Senza NinjaOne, può comunque recuperare e visualizzare le informazioni sugli spazi di archiviazione, ma non le salverà nei campi personalizzati.

Implicazioni

L’automazione per individuare le informazioni sullo storage e documentarle migliora l’efficienza operativa e riduce il rischio che i problemi legati allo spazio di archiviazione passino inosservati. Questo approccio proattivo alla gestione dello storage può prevenire i tempi di inattività e garantire che l’infrastruttura IT rimanga integra e performante.

Raccomandazioni

• Assicurati che lo strumento Proxmox API (pvesh) e lo strumento NinjaOne CLI siano correttamente installati e configurati prima di eseguire lo script.
• Controlla e aggiorna regolarmente i campi personalizzati per mantenere le informazioni sugli storage aggiornate e precise.
• Testa lo script per recuperare lo stato dello storage dei nodi Proxmox in un ambiente non di produzione per assicurarti che soddisfi le tue esigenze e si integri perfettamente con i processi esistenti.

Considerazioni finali

L’utilizzo di script di automazione come questo per recuperare lo stato dello storage dei nodi Proxmox può migliorare in modo significativo l’efficienza delle operazioni IT, in particolare per gli MSP che gestiscono più ambienti di clienti. NinjaOne, con le sue potenti funzionalità RMM, fornisce una piattaforma eccellente per l’integrazione di tali script, offrendo un approccio centralizzato e semplificato alla gestione IT. Utilizzando questi strumenti, i professionisti IT possono assicurarsi che la loro infrastruttura funzioni sempre in modo ottimale ed essere meglio preparati a gestire qualsiasi problema legato allo storage.