Skip to content
LearnNewsroom Created with Sketch.
Download OSIRIS
OSIRIS JSON Producer

The OSIRIS JSON Producer

Get a portable snapshot of your IT and OT Infrastructure normalized in OSIRIS JSON format.

an OSIRIS JSON producer is a super lightweight application written in Go available on Windows, MacOS, Linux that after being installed is able to generate a private portable and normalized snapshot of your IT/OT on-premise, hybrid or cloud infrastructure at a point in time without need of extra dependencies like third-party services or SaaS solutions, AI Platforms and MCP Servers. You execute it on your workstation or a server under your full complete control.

It connects directly from your own environment to infrastructure sources such as hyperscalers, public cloud and hosting providers, on-premise IT systems (like for example hypervisors,bare metal servers,storage,network etc.) and OT systems. It discovers inventory and topology data, normalizes proprietary informations and emits a valid OSIRIS JSON Document like OSIRIS JSON IT infrastructure example and OSIRIS JSON OT infrastructure example.

  • No AI platform, MCP server or AI agent are required
  • No SaaS or intermediary API are required
  • No pay per use, license or expensive consultancy are required
  • No additional software development is required
  • Your infrastructure data stays under your control like your API keys or login credentials to retrieve the informations and generate an OSIRIS JSON document

OSIRIS JSON producer bridge the gap between proprietary infrastructure language/format and the freedom of an open, vendor-neutral JSON format.

The OSIRIS JSON Producer Architecture High-Level Diagram

Section titled “The OSIRIS JSON Producer Architecture High-Level Diagram”
flowchart TD 
    subgraph VP ["Vendor / Platform"]
        A["Hyperscalers, Cloud & Hosting Providers"]
        B["On-Premises<br/>IT and OT"]
    end
    
    subgraph SP ["The OSIRIS JSON Specification"]
        S["The authoritative<br/>source of truth for the<br/>specification and core schema"]
    end
    
    subgraph PR ["The OSIRIS JSON Producers"]
        P["Discover, Normalize, Redact, Emit"]
        J["OSIRIS JSON Document<br/>Portable point-in-time infrastructure snapshot"]
    end
    
    subgraph VA ["The OSIRIS JSON Toolbox"]
        V["Validation toolbox<br/>Three-level validation"]
    end
    
    subgraph OC ["The OSIRIS JSON Consumers"]
        C["Consumers under development<br/>Read OSIRIS JSON documents"]
        AD["Architecture documentation reports"]
        AU["Audit reports"]
        DF["Snapshot diff view"]
        TP["Automatic topology<br/>generation and updates"]
    end
    
    subgraph UC ["Under Your Full Control"]
        U["One OSIRIS JSON file<br/>Multiple use cases"]
        M["CMDB / IPAM / DCIM workflows"]
        AI["AI platforms, agents<br/>and MCP servers"]
        X["Custom analytics<br/>and third-party tools"]
    end
    
    A -->|"Discovered by"| P
    B -->|"Discovered by"| P

    S -. "Defines the format" .-> J
    S -. "Guides implementation" .-> P

    P -->|"Generates"| J

    J -->|"Validated by"| V

    J -->|"Consumed by"| C
    C -->|"Generates"| AD
    C -->|"Generates"| AU
    C -->|"Generates"| DF
    C -->|"Generates"| TP

    J --> U
    U --> M
    U --> AI
    U --> X
    
    style VP fill:transparent,stroke:#555,stroke-width:1px,color:inherit
    style SP fill:transparent,stroke:#555,stroke-width:1px,color:inherit
    style PR fill:transparent,stroke:#4F7FE7,stroke-width:2px,color:inherit
    style VA fill:transparent,stroke:#555,stroke-width:1px,color:inherit
    style OC fill:transparent,stroke:#555,stroke-width:1px,color:inherit
    style UC fill:transparent,stroke:#555,stroke-width:1px,color:inherit

What an OSIRIS JSON producers will do in detail

Section titled “What an OSIRIS JSON producers will do in detail”

After installing it on your workstation or on a server of your choice, when you execute an OSIRIS JSON producer il will performs four steps:

  1. Discovery - The OSIRIS JSON producer connect using credentials (can be your user account or better a dedicated read-only service account or API keys) to the target platform or device of your choice and enumerate all resources within scope allowed by the assigned account/API permission.
  2. Normalization - Map vendor-specific data models into OSIRIS JSON resource types, connections and groups enriching other details if needed with specific flag usage. The data get normalized following the OSIRIS JSON Specification but without altering any original informations which remain intact.
  3. Redaction and safety guardrails - As per OSIRIS JSON Specification any secrets, credentials and other sensitive configuration values will be stripped before emitting the OSIRIS JSON document.
  4. Emission - it save a valid OSIRIS JSON document file. You can use the document as you like. For example with your AI platform or MCP server for enhanced reasoning without any need to connect AI/MCP to your infrastructure, or to create reports, schedule autogeneration for audit or configuration drift identification or you can use to feed CMDB/IPAM/DCIM or generate diagrams in Draw.io/Mermaidjs. OSIRIS JSON Consumer is under development once ready you would use the program to generate report and topology of your infrastructure with zero dependency and in total privacy.

Producers are released incrementally while others are planned and will follow. If you are using a platform or device not currently listed below we encourage you to open a new discussion on GitHub.

Provider Scope Status
Microsoft Azure Virtual Networks, VMs, Load Balancers available
Amazon Web Services VPC, EC2, ELB, Transit Gateway available
Google Cloud Platform VPC, Compute Engine, Cloud Load Balancing under development
Cloudflare To be defined planned
Provider Scope Status
Digital Ocean Virtual Networks, VMs, Load Balancers planned
Leaseweb Virtual Networks, VMs, Load Balancers planned

Vendor Scope Status
Proxmox VE Virtual Machines and Containers under development
VMware Virtual Machines planned
Vendor Scope Status
Cisco APIC, NX-OS, IOS-XE available
Arista EOS planned
HPE Aruba Networking Central EOS under development
UniFi UniFi OS planned

see the How to Install page for install instructions.

For solution architects and auditors, the recommended workflow is:

  1. Run the producer against your target platform with appropriate credentials.
  2. Validate the output using @osirisjson/cli with the strict profile.
  3. Review the snapshot as an architecture artifact store it, compare it over time, attach it to audits.
Terminal window
# Generate snapshot
osirisjson-producer cisco apic -h apic.example.com -u admin > snapshot.json
# Validate
npx @osirisjson/cli validate --profile strict snapshot.json