mellanox.onyx.onyx_wjh – Configure what-just-happend module

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

Synopsis

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

Parameters

Parameter Choices/Defaults Comments
auto_export
boolean
    Choices:
  • no
  • yes
wjh group auto export pcap file status
clear_group
string
    Choices:
  • all
  • user
  • auto-export
clear pcap file by group
enabled
boolean
    Choices:
  • no
  • yes
wjh group status
export_group
string
    Choices:
  • all
  • forwarding
  • acl
wjh group auto export group
group
string
    Choices:
  • all
  • forwarding
  • acl
Name of wjh group.

Examples

- name: Enable wjh
  onyx_wjh:
      group: forwarding
      enabled: True

- name: Disable wjh
  onyx_wjh:
      group: forwarding
      enabled: False

- name: Enable auto-export
  onyx_wjh:
        auto_export: True
        export_group: forwarding
- name: Disable auto-export
  onyx_wjh:
        auto_export: False
        export_group: forwarding
- name: Clear pcap file
  onyx_wjh:
        clear_group: auto-export

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:
['what-just-happend forwarding enable', 'what-just-happend auto-export forwarding enable', 'clear what-just-happend pcap-file user']


Authors

  • Anas Shami (@anass)