W3cubDocs

/Ansible

community.network.slxos_interface – Manage Interfaces on Extreme SLX-OS network devices

Note

This plugin is part of the community.network collection (version 3.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 community.network.

To use it in a playbook, specify: community.network.slxos_interface.

Synopsis

  • This module provides declarative management of Interfaces on Extreme SLX-OS network devices.

Parameters

Parameter Choices/Defaults Comments
aggregate
string
List of Interfaces definitions.
delay
string
Default:
10
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up/down, tx_rate and rx_rate.
description
string
Description of Interface.
enabled
boolean
    Choices:
  • no
  • yes
Interface link status.
mtu
string
Maximum size of transmit packet.
name
string / required
Name of the Interface.
neighbors
string
Check the operational state of given interface name for LLDP neighbor.
The following suboptions are available.
host
string
LLDP neighbor host for given interface name.
port
string
LLDP neighbor port to which given interface name is connected.
rx_rate
string
Receiver rate in bits per second (bps).
speed
string
Interface link speed.
state
string
    Choices:
  • present
  • absent
  • up
  • down
State of the Interface configuration, up means present and operationally up and down means present and operationally down
tx_rate
string
Transmit rate in bits per second (bps).

Notes

Note

  • Tested against SLX-OS 17s.1.02

Examples

- name: Configure interface
  community.network.slxos_interface:
      name: Ethernet 0/2
      description: test-interface
      speed: 1000
      mtu: 9216

- name: Remove interface
  community.network.slxos_interface:
    name: Loopback 9
    state: absent

- name: Make interface up
  community.network.slxos_interface:
    name: Ethernet 0/2
    enabled: True

- name: Make interface down
  community.network.slxos_interface:
    name: Ethernet 0/2
    enabled: False

- name: Check intent arguments
  community.network.slxos_interface:
    name: Ethernet 0/2
    state: up
    tx_rate: ge(0)
    rx_rate: le(0)

- name: Check neighbors intent arguments
  community.network.slxos_interface:
    name: Ethernet 0/41
    neighbors:
    - port: Ethernet 0/41
      host: SLX

- name: Config + intent
  community.network.slxos_interface:
    name: Ethernet 0/2
    enabled: False
    state: down

- name: Add interface using aggregate
  community.network.slxos_interface:
    aggregate:
    - { name: Ethernet 0/1, mtu: 1548, description: test-interface-1 }
    - { name: Ethernet 0/2, mtu: 1548, description: test-interface-2 }
    speed: 10000
    state: present

- name: Delete interface using aggregate
  community.network.slxos_interface:
    aggregate:
    - name: Loopback 9
    - name: Loopback 10
    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, except for the platforms that use Netconf transport to manage the device.
The list of configuration mode commands to send to the device.

Sample:
['interface Ethernet 0/2', 'description test-interface', 'mtu 1548']


Authors

  • Lindsay Hill (@LindsayHill)

© 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/community/network/slxos_interface_module.html