Ce document décrit comment récupérer les données du CMDB par la Public API.
L’authentification se fait par un en-tête apiKey.

La marche à suivre compte trois étapes :

1. Obtenir les types du CMDB
2. Obtenir les tables d’un type choisi
3. Exporter une table choisie au format CSV

URL de base : https://<xormon host>:8443 (ou le port 443, c’est-à-dire le même que celui de l’interface)
Authentification : toutes les requêtes demandent l’en-tête HTTP suivant : --header 'apiKey: <api-key>'
apiKey: <yourKey>

Étape 1 – Obtenir la liste des types du CMDB

Ce point d’API retourne tous les types de CMDB disponibles.
L’un de ces types est nécessaire pour obtenir la liste des tables du CMDB à l’étape suivante.

Requête : GET /api/public/v1/cmdb/types

exemple curl :

curl --location 'https://<xormon host>:8443/api/public/v1/cmdb/types' \
  --header 'apiKey: yourKey'

Example response:
{
    "statusCode": 200,
    "data": [
        "storage",
        "san",
        "lan",
        "tape",
        "virtualization_proxmox",
        "virtualization_nutanix",
        "virtualization_linux",
        "virtualization_power",
        "virtualization_vmware",
        "virtualization_ovirt",
        "virtualization_xenserver",
        "virtualization_windows",
        "virtualization_solaris",
        "virtualization_oraclevm",
        "virtualization_cloudstack",
        "virtualization_mainframe",
        "virtualization_fusioncompute",
        "virtualization_as400",
        "cloud_azure",
        "cloud_aws",
        "cloud_gcloud",
        "cloud_ibmcloud",
        "cloud_skytap",
        "database_postgres",
        "database_db2",
        "database_oracledb",
        "database_sqlserver",
        "database_timescaledb",
        "database_mongodb",
        "container_docker",
        "container_kubernetes",
        "container_openshift",
        "container_tanzu",
        "backup_ibmtsm",
        "backup_netbackup",
        "backup_veeam",
        "backup_commvault",
        "serversp_didrac",
        "serversp_hpeilo",
        "serversp_lxclarity"
    ]
}

Type de CMDB retenu pour l’étape suivante : storage

Étape 2 – Obtenir les tables du CMDB pour un type donné

Ce point d’API retourne toutes les tables CMDB disponibles sous le type de CMDB choisi.
L’une de ces tables est nécessaire pour exporter les données du CMDB.

Requête : GET /api/public/v1/cmdb/tables/{cmdb_type}

exemple curl (avec « storage ») :

curl --location 'https://<xormon host>:8443/api/public/v1/cmdb/tables/storage' \
  --header 'apiKey: yourKey'

Example response:
{
    "statusCode": 200,
    "data": [
        "HW",
        "Volume",
        "Snapshot"
    ]
}

Table du CMDB retenue pour l’export : HW

Étape 3 – Exporter la table du CMDB au format CSV

Ce point d’API exporte au format CSV la table du CMDB choisie.
L’export contient les valeurs brutes, sans les transformations de l’interface : les valeurs sont par exemple en octets et non en GB.

Requête : GET /api/public/v1/cmdb/table/{cmdb_type}/{cmdb_table}

exemple curl (storage + HW) :

curl --location 'https://<xormon host>:8443/api/public/v1/cmdb/table/storage/HW' \
  --header 'apiKey: yourKey'

Optional: Save CSV directly to a file
curl --location 'https://<xormon host>:8443/api/public/v1/cmdb/table/storage/HW' \
  --header 'apiKey: yourKey' \
  --output storage_HW.csv

Récapitulatif

1. Récupérer les types du CMDB : GET /api/public/v1/cmdb/types
2. Récupérer les tables CMDB d’un type : GET /api/public/v1/cmdb/tables/storage
3. Exporter une table du CMDB en CSV : GET /api/public/v1/cmdb/table/storage/HW

Liste de toutes les tables

Pour lister vos combinaisons réelles de type, table et chemin, lancez ce script
Pour qu’il fonctionne, adaptez les variables du script à votre URL et à une clé d’API valide :
BASE_URL="https://<xormon host>:8443/api/public/v1/cmdb"
API_KEY="e69403787286d3a78002eeef995bf38f"

#!/bin/bash

BASE_URL="https://<xormon host>:8443/api/public/v1/cmdb"
API_KEY="e69403787286d3a78002eeef995bf38f"

OUTPUT_FILE="cmdb_tables.csv"

# Truncate output file
> "$OUTPUT_FILE"

# Get CMDB types
types=$(curl -k \
  --header "apiKey: $API_KEY" \
  "$BASE_URL/types" \
  | jq -r '.data[]')

for type in $types; do
  tables=$(curl -k \
    --header "apiKey: $API_KEY" \
    "$BASE_URL/tables/$type" \
    | jq -r '.data[]')

  for table in $tables; do
    echo "$type;$table;/api/public/v1/cmdb/table/$type/$table" >> "$OUTPUT_FILE"
  done
done