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

Note

This module 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

Comments

auto_export

boolean

wjh group auto export pcap file status

Choices:

  • no

  • yes

clear_group

string

clear pcap file by group

Choices:

  • all

  • user

  • auto-export

enabled

boolean

wjh group status

Choices:

  • no

  • yes

export_group

string

wjh group auto export group

Choices:

  • all

  • forwarding

  • acl

group

string

Name of wjh group.

Choices:

  • all

  • forwarding

  • acl

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

Description

commands

list / elements=string

The list of configuration mode commands to send to the device.

Returned: always

Sample: [“what-just-happend forwarding enable”, “what-just-happend auto-export forwarding enable”, “clear what-just-happend pcap-file user”]

Authors

  • Anas Shami (@anass)