W3cubDocs

/Ansible

mellanox.onyx.onyx_pfc_interface – Manage priority flow control on 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_pfc_interface.

Synopsis

  • This module provides declarative management of priority flow control (PFC) on interfaces of Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
aggregate
string
List of interfaces PFC should be configured on.
name
string
Name of the interface PFC should be configured on.
purge
boolean
    Choices:
  • no ←
  • yes
Purge interfaces not defined in the aggregate parameter.
state
string
    Choices:
  • enabled ←
  • disabled
State of the PFC configuration.

Notes

Note

  • Tested on ONYX 3.6.4000

Examples

- name: Configure PFC
  onyx_pfc_interface:
    name: Eth1/1
    state: enabled

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/17 dcb priority-flow-control mode on']


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_pfc_interface_module.html