OSIRIS JSON Producer for HPE Aruba Networking Central platform | OSIRIS JSON DocsSkip to content
OSIRIS JSON Producer for HPE Aruba Networking Central platform<br>Last updated: Jul 28, 2026Sharelink<br>content_copyCopy MDdownloadDownload MD
The OSIRIS JSON HPE producer connects to HPE infrastructure platforms (in its first 0.1.0 release, Aruba Central is supported and others will come later) and generates OSIRIS JSON snapshots of your network topology, devices, interfaces, and connections.
Prerequisites<br>Section titled “Prerequisites”
Install the OSIRIS Producer - see the How to Install page for more install options.
Supported platforms<br>Section titled “Supported platforms”
Aruba Networking Central<br>available cloud-native, AI-powered network management platform that unifies Wi-Fi, switching, and SD-WAN operations<br>Transport: REST API
Authentication<br>Section titled “Authentication”
The Aruba Central producer supports two credential types:
API Gateway application : Standard client_id and client_secret plus an OAuth2 token pair (access_token and refresh_token), created via the Central UI or OAuth2 flow.
HPE GreenLake Personal API client : A self-service client_id and client_secret pair (generated at common.cloud.hpe.com/manage-account/api). No access/refresh token pair is needed upfront; the producer mints tokens automatically against the GreenLake SSO endpoint.
Caution<br>There are deliberately no CLI flags like --client-id or --client-secret to prevent secrets from leaking into shell history. Always supply credentials via a token file or the interactive prompts.
Getting started with Aruba Networking Central<br>Section titled “Getting started with Aruba Networking Central”
Single mode<br>Section titled “Single mode”
By default, the producer runs interactively. It will auto-detect your cluster and list the sites available in your account, prompting you to select one or more. Each selected site generates its own separate OSIRIS JSON document.
Terminal window# Default mode
osirisjson-producer arubacentral
# Audit mode
osirisjson-producer arubacentral --purpose audit
Run without login interaction<br>Section titled “Run without login interaction”
The producer is designed to run without interactive login if needed.
Terminal window# This writes a `arubacentral-token.json` skeleton. Populate it with your credentials.
osirisjson-producer arubacentral template --Generate
# Default mode
osirisjson-producer arubacentral --token-file ./arubacentral-token.json
# Audit mode
osirisjson-producer arubacentral --purpose audit --token-file ./arubacentral-token.json
CI/CD Automated Mode (Multi-Site Batch)<br>Section titled “CI/CD Automated Mode (Multi-Site Batch)”
This examples works as a perfect use-case for unattended execution (e.g., in a cron job or pipeline), you can specify one or multiple site or use the --all flag, this discovers and exports every accessible site non-interactively. Each site’s resources is written to a dedicated OSIRIS JSON document in the output directory.
Terminal window# You can bypass the site picker by specifying sites explicitly (comma-separated):
osirisjson-producer arubacentral --token-file ./arubacentral-token.json --site "MXP,BRANCH-01"
# Batch mode: export all sites silently in a specific output directory of choice named output
osirisjson-producer arubacentral --all --token-file ./arubacentral-token.json -o ./output
Flags reference<br>Section titled “Flags reference”
General flags<br>Section titled “General flags”
Flag<br>Short<br>Description
--token-file
JSON file with {client_id, client_secret}. Mandatory for non-interactive auth.
--cluster
Cluster short code (e.g. eucentral3). Auto-detects if omitted.
--base-url
Override the API Gateway base URL (takes precedence over --cluster).
--site
Comma-separated site name(s) to collect (bypasses interactive site picker).
--all
Auto-discover and export every accessible site, skipping prompts.
--output<br>-o<br>Output directory for files. Default is osirisjson-hpe-arubacentral in current dir.
--purpose
documentation (default) or audit (adds client fingerprints/health deep-dives).
--include-raw-body
Attaches full API responses to resources. Requires --purpose audit.
--safe-failure-mode
Secret handling: fail-closed (default), log-and-redact, off.
What the producer collects<br>Section titled “What the producer collects”
The OSIRIS JSON producer for Aruba Networking Central extracts the following inventory and topology:
Run in documentation mode (Default)
Resource / Element<br>Description
network.switch<br>Switches (includes stacking logic, hardware sensors, and VSX peerings)
network.gateway<br>Gateways (includes uplinks, ports, and VLANs)
network.interface<br>Interfaces and ports for the devices
network.vlan<br>VLANs spanning devices
APs & Radios<br>osiris.hpe.arubacentral.accesspoint, .radio, .wlan, .bssid and .swarm (mesh swarms)
Clients<br>osiris.hpe.arubacentral.client (unified wired/wireless clients)
Neighbors (Topology)<br>LLDP/CDP adjacencies mapping...