# opengear/ansible-ng architecture

> Architecture diagram of the GitHub repository opengear/ansible-ng, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/opengear/ansible-ng
- Repository: https://github.com/opengear/ansible-ng

## Overview

This is an Ansible collection for automating Opengear network appliances. The principal workflow is a playbook task invoking a resource module to manage device configuration through the collection’s HTTP API connection; separate fact modules gather device state. Configuration covers identity, networking, serial ports, power, system operations and services, alongside import/export/restore and live status/control capabilities. The sampled code confirms argument-spec-to-module and configuration-engine delegation for static routes and SNMP alert managers. Other resource internals are represented at their enclosing directories because their implementation was not sampled.

Main entry points: [`plugins/modules/facts.py`](https://github.com/opengear/ansible-ng/blob/main/plugins/modules/facts.py) (Facts module), [`plugins/modules`](https://github.com/opengear/ansible-ng/tree/main/plugins/modules) (Resource modules), [`plugins/modules/services_snmp_alert_managers.py`](https://github.com/opengear/ansible-ng/blob/main/plugins/modules/services_snmp_alert_managers.py) (SNMP alert targets), [`plugins/modules/static_routes.py`](https://github.com/opengear/ansible-ng/blob/main/plugins/modules/static_routes.py) (Static routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Ansible entry points"]
  node_resource_modules["Resource modules"]
  node_facts_module["Facts module<br/>[facts.py]"]
  node_config_files["Config file tasks"]
end

subgraph group_configuration["Configuration resources"]
  node_identity["Identity and access"]
  node_network["Network resources"]
  node_serial["Serial ports"]
  node_services["Service configuration<br/>[services_config.py]"]
  node_snmp_alerts["SNMP alert targets"]
  node_syslog["Remote syslog<br/>[services_syslog.py]"]
  node_static_routes["Static routes<br/>[static_routes.py]"]
end

subgraph group_operations["Device operations"]
  node_pdu["PDU resources"]
  node_system["System operations"]
  node_port_actions["Port actions and status"]
  node_config_transfer["Config transfer"]
end

subgraph group_runtime["Shared runtime"]
  node_argspec["Argument specifications"]
  node_config_engine["Configuration engines"]
  node_facts_engine["Facts engines"]
  node_httpapi["HTTP API connection<br/>[http_api.py]"]
end

node_playbook(("Playbook task"))
node_device(("Opengear appliance"))
node_ssh_connection(("SSH connection"))

node_playbook -->|"invokes task"| node_resource_modules
node_playbook -->|"requests facts"| node_facts_module
node_playbook -->|"runs transfer"| node_config_files
node_resource_modules -->|"uses by default"| node_httpapi
node_facts_module -->|"uses by default"| node_httpapi
node_resource_modules -->|"manages resources"| node_device
node_facts_module -->|"gathers state"| node_device
node_config_files -->|"transfers configuration"| node_device
node_config_files -->|"requires SSH"| node_ssh_connection
node_static_routes -->|"uses arguments"| node_argspec
node_static_routes -->|"delegates execution"| node_config_engine
node_snmp_alerts -->|"uses arguments"| node_argspec
node_snmp_alerts -->|"delegates execution"| node_config_engine
node_services -->|"configures services"| node_device
node_identity -->|"manages access"| node_device
node_network -->|"manages networking"| node_device
node_serial -->|"manages serial ports"| node_device
node_pdu -->|"manages power"| node_device
node_system -->|"operates appliance"| node_device
node_port_actions -->|"controls ports"| node_device
node_facts_module -->|"gathers resources"| node_facts_engine

click node_resource_modules "https://github.com/opengear/ansible-ng/tree/main/plugins/modules"
click node_facts_module "https://github.com/opengear/ansible-ng/blob/main/plugins/modules/facts.py"
click node_config_files "https://github.com/opengear/ansible-ng/tree/main/plugins/modules"
click node_identity "https://github.com/opengear/ansible-ng/tree/main/plugins/modules"
click node_network "https://github.com/opengear/ansible-ng/tree/main/plugins/modules"
click node_serial "https://github.com/opengear/ansible-ng/tree/main/plugins/modules"
click node_services "https://github.com/opengear/ansible-ng/blob/main/plugins/modules/services_config.py"
click node_snmp_alerts "https://github.com/opengear/ansible-ng/blob/main/plugins/modules/services_snmp_alert_managers.py"
click node_syslog "https://github.com/opengear/ansible-ng/blob/main/plugins/modules/services_syslog.py"
click node_static_routes "https://github.com/opengear/ansible-ng/blob/main/plugins/modules/static_routes.py"
click node_pdu "https://github.com/opengear/ansible-ng/tree/main/plugins/modules"
click node_system "https://github.com/opengear/ansible-ng/tree/main/plugins/modules"
click node_port_actions "https://github.com/opengear/ansible-ng/tree/main/plugins/modules"
click node_config_transfer "https://github.com/opengear/ansible-ng/tree/main/plugins/modules"
click node_argspec "https://github.com/opengear/ansible-ng/tree/main/plugins/module_utils/argspec"
click node_config_engine "https://github.com/opengear/ansible-ng/tree/main/plugins/module_utils/config"
click node_facts_engine "https://github.com/opengear/ansible-ng/tree/main/plugins/module_utils/facts"
click node_httpapi "https://github.com/opengear/ansible-ng/blob/main/plugins/httpapi/http_api.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_resource_modules,node_facts_module,node_config_files toneBlue
class node_identity,node_network,node_serial,node_services,node_snmp_alerts,node_syslog,node_static_routes toneAmber
class node_pdu,node_system,node_port_actions,node_config_transfer toneMint
class node_argspec,node_config_engine,node_facts_engine,node_httpapi,node_playbook toneRose
class node_device,node_ssh_connection toneIndigo
```

## Components

### Ansible entry points

- [Resource modules](https://github.com/opengear/ansible-ng/tree/main/plugins/modules): `plugins/modules`
- [Facts module](https://github.com/opengear/ansible-ng/blob/main/plugins/modules/facts.py): `plugins/modules/facts.py`
- [Config file tasks](https://github.com/opengear/ansible-ng/tree/main/plugins/modules): `plugins/modules`

### Configuration resources

- [Identity and access](https://github.com/opengear/ansible-ng/tree/main/plugins/modules): `plugins/modules`
- [Network resources](https://github.com/opengear/ansible-ng/tree/main/plugins/modules): `plugins/modules`
- [Serial ports](https://github.com/opengear/ansible-ng/tree/main/plugins/modules): `plugins/modules`
- [Service configuration](https://github.com/opengear/ansible-ng/blob/main/plugins/modules/services_config.py): `plugins/modules/services_config.py`
- [SNMP alert targets](https://github.com/opengear/ansible-ng/blob/main/plugins/modules/services_snmp_alert_managers.py): `plugins/modules/services_snmp_alert_managers.py`
- [Remote syslog](https://github.com/opengear/ansible-ng/blob/main/plugins/modules/services_syslog.py): `plugins/modules/services_syslog.py`
- [Static routes](https://github.com/opengear/ansible-ng/blob/main/plugins/modules/static_routes.py): `plugins/modules/static_routes.py`

### Device operations

- [PDU resources](https://github.com/opengear/ansible-ng/tree/main/plugins/modules): `plugins/modules`
- [System operations](https://github.com/opengear/ansible-ng/tree/main/plugins/modules): `plugins/modules`
- [Port actions and status](https://github.com/opengear/ansible-ng/tree/main/plugins/modules): `plugins/modules`
- [Config transfer](https://github.com/opengear/ansible-ng/tree/main/plugins/modules): `plugins/modules`

### Shared runtime

- [Argument specifications](https://github.com/opengear/ansible-ng/tree/main/plugins/module_utils/argspec): `plugins/module_utils/argspec`
- [Configuration engines](https://github.com/opengear/ansible-ng/tree/main/plugins/module_utils/config): `plugins/module_utils/config`
- [Facts engines](https://github.com/opengear/ansible-ng/tree/main/plugins/module_utils/facts): `plugins/module_utils/facts`
- [HTTP API connection](https://github.com/opengear/ansible-ng/blob/main/plugins/httpapi/http_api.py): `plugins/httpapi/http_api.py`

### Other components

- **Playbook task**
- **Opengear appliance**
- **SSH connection**

## Connections

- Playbook task → Resource modules: invokes task (evidence: `README.md`)
- Playbook task → Facts module: requests facts (evidence: `README.md`)
- Playbook task → Config file tasks: runs transfer (evidence: `README.md`)
- Resource modules → HTTP API connection: uses by default (evidence: `README.md`)
- Facts module → HTTP API connection: uses by default (evidence: `README.md`)
- Resource modules → Opengear appliance: manages resources (evidence: `README.md`)
- Facts module → Opengear appliance: gathers state (evidence: `README.md`)
- Config file tasks → Opengear appliance: transfers configuration (evidence: `README.md`)
- Config file tasks → SSH connection: requires SSH (evidence: `README.md`)
- Static routes → Argument specifications: uses arguments (evidence: `plugins/modules/static_routes.py`)
- Static routes → Configuration engines: delegates execution (evidence: `plugins/modules/static_routes.py`)
- SNMP alert targets → Argument specifications: uses arguments (evidence: `plugins/modules/services_snmp_alert_managers.py`)
- SNMP alert targets → Configuration engines: delegates execution (evidence: `plugins/modules/services_snmp_alert_managers.py`)
- Service configuration → Opengear appliance: configures services (evidence: `README.md`)
- Identity and access → Opengear appliance: manages access (evidence: `README.md`)
- Network resources → Opengear appliance: manages networking (evidence: `README.md`)
- Serial ports → Opengear appliance: manages serial ports (evidence: `README.md`)
- PDU resources → Opengear appliance: manages power (evidence: `README.md`)
- System operations → Opengear appliance: operates appliance (evidence: `README.md`)
- Port actions and status → Opengear appliance: controls ports (evidence: `README.md`)
- Facts module → Facts engines: gathers resources (evidence: `README.md`)
