lantronix.oob Ansible Collection

Manage Lantronix Out-of-Band infrastructure from Ansible. The lantronix.oob collection provides 20 modules covering SLC9000 device configuration and Percepxion fleet management, the only Ansible collection that automates the full OOB infrastructure stack, not just the appliance.

Installation

ansible-galaxy collection install lantronix.oob

Requires the requests library:

pip install requests

Requirements

• ansible-core >= 2.16
• ansible.netcommon >= 5.0.0
• Python 3.9+
• Python requests library

Supported Platforms

Modules

SLC9000 Device Modules

Percepxion Fleet Modules

Example Roles

Quick Start

SLC9000

# inventory.yml
slc_devices:
  hosts:
    slc9k-datacenter:
      ansible_host: 192.168.1.100
  vars:
    ansible_network_os: lantronix.oob.slc9
    ansible_connection: ansible.netcommon.httpapi
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: true
    ansible_user: sysadmin
    ansible_password: "{{ vault_slc_password }}"

# gather_facts.yml
- hosts: slc_devices
  gather_facts: false
  tasks:
    - name: Gather SLC facts
      lantronix.oob.slc_facts:
      register: result

    - name: Show firmware and model
      ansible.builtin.debug:
        msg: "{{ inventory_hostname }}, {{ result.slc_facts.model }} running {{ result.slc_facts.firmware_version }}"

Percepxion

# inventory.yml
percepxion:
  hosts:
    percepxion_platform:
      ansible_host: api.consoleflow.com
  vars:
    ansible_network_os: lantronix.oob.percepxion
    ansible_connection: ansible.netcommon.httpapi
    ansible_httpapi_use_ssl: true
    ansible_user: "{{ vault_percepxion_user }}"
    ansible_password: "{{ vault_percepxion_password }}"
    percepxion_project_tag: "prod-datacenter-east"   # optional, scopes all ops to project
    percepxion_tenant_id: "34f5c98e-..."             # optional, Project Admin only

# firmware_audit.yml
- hosts: percepxion_platform
  gather_facts: false
  tasks:
    - name: Run firmware compliance report
      lantronix.oob.percepxion_firmware:
        state: report
      register: audit

    - name: Show non-compliant devices
      ansible.builtin.debug:
        msg: "Non-compliant: {{ audit.firmware_report.non_compliant | map(attribute='device_name') | list }}"

Connection Plugins

This collection includes two httpapi connection plugins:

• lantronix.oob.slc9, authenticates to SLC9000 REST API v2 via session token
• lantronix.oob.percepxion, authenticates to Percepxion API with Bearer token and CSRF token handling

Both plugins handle login, token management, and error translation automatically. You do not call them directly; set ansible_network_os in your inventory.

Percepxion Project and Tenant Scoping

The Percepxion API supports multi-project and multi-tenant deployments. Set these as inventory connection variables, all Percepxion modules inherit them automatically:

percepxion_project_tag: "prod-east"       # scope all ops to this project
percepxion_tenant_id: "uuid-here"         # required only for Project Admins

To operate across multiple projects, loop over inventory groups rather than module arguments.

Contributing

Bug reports and pull requests welcome. Please open an issue before submitting a PR for significant changes.

See CONTRIBUTING.md for development setup, coding standards, and commit conventions.

mkdir -p ansible_collections/lantronix
git clone https://github.com/Lantronix/ansible-collection-oob ansible_collections/lantronix/oob
cd ansible_collections/lantronix/oob

# Sanity tests
ansible-test sanity --python 3.12

# Unit tests
ansible-test units --python 3.12

Changelog

See CHANGELOG.rst for release history.

Support

This collection is maintained by the Lantronix OOB product team.

Red Hat Automation Hub users: Open a support request via the collection page on Automation Hub using the "Create issue" link. This ensures your request is routed through the appropriate Red Hat support channels.

Community support: Open an issue on GitHub. Pull requests are welcome, please open an issue before submitting a PR for significant changes.

Product support: Visit https://www.lantronix.com/support/.

License

Apache 2.0. See LICENSE for details.