Opengear OM Collection

The Ansible Opengear OM collection includes a variety of Ansible content to help automate the management of Opengear OM network appliances.

Supported connections

The Ansible OM collection supports httpapi connections.

Included content

HTTPAPI plugins

Name	Description
opengear.om.om	Use Opengear REST API to run request on Opengear OM device

Modules

Name	Description
opengear.om.om_auth	Configure remote authentication, authorization, accounting (AAA) servers.
opengear.om.om_conns	Read and manipulate the network connections on the Operations Manager appliance.
opengear.om.om_facts	Collect facts from OM devices
opengear.om.om_failover	Failover endpoint is to check failover status and retrieve / change failover settings.
opengear.om.om_groups	Retrieve or update group information.
opengear.om.om_pdu	Configure, monitor and control PDUs connected to the device.
opengear.om.om_physifs	Read and manipulate the network physical interfaces on the Operations Manager appliance.
opengear.om.om_ports	Configuring and viewing ports information
opengear.om.om_services	Used for working with the properties of the various services running on the system.
opengear.om.om_static_routes	Configuring and viewing static routes
opengear.om.om_system	Used for configuring and accessing information about the Operations Manager appliance itself.
opengear.om.om_users	Retrieve and update user information.

Installing this collection

You can install the Opengear OM collection with the Ansible Galaxy CLI:

ansible-galaxy collection install opengear.om

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: opengear.om

Alternatively you can install the Opengear OM collection directly from Github:

ansible-galaxy collection install git+https://github.com/opengear/opengear.om.git

Using this collection

This collection includes network resource modules.

Using modules from the Opengear OM collection in your playbooks

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as opengear.om.om_users. The following example task replaces configuration changes in the existing configuration on a Opengear OM network device, using the FQCN:

---
  - name: Replace device configuration of users.
    openear.om.om_users:
      config:
        - name: user1
          enabled: true
          no_password: true
          groups:
          - group2
      state: replaced

See Also:

• Ansible Using collections for more details.

Contributing to this collection

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the Opengear OM collection repository.

See the Ansible Community Guide for details on contributing to Ansible.

Code of Conduct

This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.

More information

• Ansible network resources
• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct
• Opengear OM REST API

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.