mellanox.onyx.onyx_traffic_class – Configures Traffic Class

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_traffic_class.

Synopsis

  • This module provides declarative management of Traffic Class configuration on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
congestion_control
string
configure congestion control on interface.
control
string / required
    Choices:
  • red
  • ecn
  • both
congestion control type.
max_threshold
string / required
Set maximum-threshold value (in KBs) for marking traffic-class queue.
min_threshold
string / required
Set minimum-threshold value (in KBs) for marking traffic-class queue.
threshold_mode
string / required
    Choices:
  • absolute
  • relative
congestion control threshold mode.
dcb
string
configure dcb control on interface.
mode
string / required
    Choices:
  • strict
  • wrr
dcb control mode.
weight
string
Relevant only for wrr mode.
interfaces
string / required
list of interfaces name.
state
string
    Choices:
  • enabled ←
  • disabled
enable congestion control on interface.
tc
string / required
traffic class, range 0-7.

Examples

- name: Configure traffic class
  onyx_traffic_class:
    interfaces:
      - Eth1/1
      - Eth1/2
    tc: 3
    congestion_control:
      control: ecn
      threshold_mode: absolute
      min_threshold: 500
      max_threshold: 1500
    dcb:
      mode: strict

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:
['interface ethernet 1/15 traffic-class 3 congestion-control ecn minimum-absolute 150 maximum-absolute 1500', 'interface ethernet 1/16 traffic-class 3 congestion-control ecn minimum-absolute 150 maximum-absolute 1500', 'interface mlag-port-channel 7 traffic-class 3 congestion-control ecn minimum-absolute 150 maximum-absolute 1500', 'interface port-channel 1 traffic-class 3 congestion-control ecn minimum-absolute 150 maximum-absolute 1500', 'interface ethernet 1/15 traffic-class 3 dcb ets strict', 'interface ethernet 1/16 traffic-class 3 dcb ets strict', 'interface mlag-port-channel 7 traffic-class 3 dcb ets strict', 'interface port-channel 1 traffic-class 3 dcb ets strict']


Authors

  • Anas Badaha (@anasb)

© 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_traffic_class_module.html