W3cubDocs

/Ansible

mellanox.onyx.onyx_l3_interface – Manage L3 interfaces on Mellanox ONYX network devices

Note

This plugin is part of the mellanox.onyx collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install mellanox.onyx.

To use it in a playbook, specify: mellanox.onyx.onyx_l3_interface.

Synopsis

  • This module provides declarative management of L3 interfaces on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
aggregate
string
List of L3 interfaces definitions
ipv4
string
IPv4 of the L3 interface.
ipv6
string
IPv6 of the L3 interface (not supported for now).
name
string
Name of the L3 interface.
purge
boolean
    Choices:
  • no ←
  • yes
Purge L3 interfaces not defined in the aggregate parameter.
state
string
    Choices:
  • present ←
  • absent
State of the L3 interface configuration.

Examples

- name: Set Eth1/1 IPv4 address
  onyx_l3_interface:
    name: Eth1/1
    ipv4: 192.168.0.1/24

- name: Remove Eth1/1 IPv4 address
  onyx_l3_interface:
    name: Eth1/1
    state: absent

- name: Set IP addresses on aggregate
  onyx_l3_interface:
    aggregate:
      - { name: Eth1/1, ipv4: 192.168.2.10/24 }
      - { name: Eth1/2, ipv4: 192.168.3.10/24 }

- name: Remove IP addresses on aggregate
  onyx_l3_interface:
    aggregate:
      - { name: Eth1/1, ipv4: 192.168.2.10/24 }
      - { name: Eth1/2, ipv4: 192.168.3.10/24 }
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
commands
list / elements=string
always.
The list of configuration mode commands to send to the device

Sample:
['interfaces ethernet 1/1 ip address 192.168.0.1 /24']


Authors

  • Samer Deeb (@samerd)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/mellanox/onyx/onyx_l3_interface_module.html