Mellanox Onyx Collection

The Ansible Mellanox Onyx collection includes a list of Ansible modules for managing and automating Mellanox Onyx network devices.

This collection has been tested against ONYX 3.6.8130 and above.

Supported connections

The Mellanox Onyx collection supports network_cli connections.

Included content

Click the Content button to see the list of content included in this collection.

Installing this collection

You can install the Mellanox Onyx collection with the Ansible Galaxy CLI:

ansible-galaxy collection install mellanox.onyx

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: mellanox.onyx
    version: 1.0.0

Using this collection

Using modules from the Mellanox Onyx collection in your playbooks

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as mellanox.onyx.onyx_interfaces.

The following example task configures a network interface speed and MTU on a Mellanox Onyx network device, using the FQCN:

---
- name: configure interface
  mellanox.onyx.onyx_interface:
      name: Eth1/2
      speed: 100G
      mtu: 512

Another option is to call modules by their short name if you list the mellanox.onyx collection in the playbook's collections, in the follwoing example we are creating a link aggration interface:

---
- hosts: onyx-hosts
  gather_facts: false
  connection: network_cli

  collections:
    - mellanox.onyx

  tasks:
	- name: configure link aggregation group
	  onyx_linkagg:
	    name: Po1
	    members:
	      - Eth1/1
	      - Eth1/2

Changelogs

Roadmap

More information

• Ansible network resources
• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.