Capacité de stockage : exemple

Exemple d’export de la capacité de stockage par l’API, et son fonctionnement
Ce script Node.js, storage_capacity_api.zip, montre comment employer notre Public API pour exporter les données de capacité de stockage au format CSV.

Prérequis et installation

  • Node.js (v20 ou plus récent recommandé)
  • Accès réseau à votre instance XORMON
  • Des identifiants valides pour la Public API
Utilisation en ligne de commande :
node storage_capacity_api.js <username> <password> <filename.csv>
Configuration SSL : le script gère les certificats auto-signés (paramétrable)
Configuration du serveur : mettez la variable server à l’adresse de votre instance XORMON
Choix du subsystem : choisissez le type d’éléments de stockage à interroger (device, pool, volume, etc.) //les changements se font dans le fichier, variable subsystem

Vue d’ensemble du déroulé :

  1. Authentification
    • Envoie une requête POST au point d’API /api/public/v1/auth
    • Échange les nom d’utilisateur et mot de passe contre une clé d’API
    • La clé d’API sert à toutes les requêtes suivantes
  2. Découverte des éléments, avec pagination
    • Interroge le point d’API /api/public/v1/architecture/search
    • Récupère tous les éléments de stockage correspondant au subsystem et à la classe indiqués
    • Gère la pagination automatiquement (50 éléments par page)
    • Continue jusqu’à ce que tous les éléments soient récupérés
  3. Export des données de capacité
    • Appelle le point d’API /api/public/v1/exporter/capacity
    • Envoie tous les identifiants d’éléments découverts en une seule requête
    • Demande les données au format CSV, pour un traitement simple
    • Retourne les métriques de capacité complètes pour tous les éléments
  4. Écriture du fichier
    • Écrit les données CSV directement dans le fichier indiqué
    • Produit une feuille de calcul prête à l’emploi, avec les informations de capacité

Points notables

  • Pagination automatique : gère les grands volumes en récupérant les données par tranches
  • Gestion des erreurs : messages d’erreur complets, pour le dépannage
  • Configuration souple : facile à adapter à d’autres subsystems ou à d’autres serveurs
  • Sortie CSV : format standard, compatible avec Excel, les bases de données et les outils d’analyse
  • Authentification sûre : par clé d’API, après la connexion initiale

Cas d’usage

  • Planification de capacité : exports réguliers pour l’analyse de tendance
  • Rapports : collecte automatisée de données pour les tableaux de bord de direction
  • Intégration : alimenter des systèmes de supervision externes en données de capacité
  • Documentation des sauvegardes : snapshots périodiques de l’utilisation du stockage
Cet exemple montre ce que permet notre Public API pour l’extraction automatisée de données et l’intégration à vos chaînes existantes.