W3cubDocs

/Ansible

community.network.pn_log_audit_exception – CLI command to create/delete an audit exception

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

Synopsis

  • This module can be used to create an audit exception and delete an audit exception.

Parameters

Parameter Choices/Defaults Comments
pn_access
string / required
    Choices:
  • any
  • read-only
  • read-write
Specify the access type to match exceptions.
pn_audit_type
string
    Choices:
  • cli
  • shell
  • vtysh
Specify the type of audit exception.
pn_cliswitch
string
Target switch to run the CLI on.
pn_pattern
string
Specify a regular expression to match exceptions.
pn_scope
string
    Choices:
  • local
  • fabric
scope - local or fabric.
state
string
    Choices:
  • present
  • absent
State the action to perform. Use 'present' to create audit-exception and 'absent' to delete audit-exception.

Examples

- name: Create a log-audit-exception
  community.network.pn_log_audit_exception:
    pn_audit_type: "cli"
    pn_pattern: "test"
    state: "present"
    pn_access: "any"
    pn_scope: "local"

- name: Delete a log-audit-exception
  community.network.pn_log_audit_exception:
    pn_audit_type: "shell"
    pn_pattern: "test"
    state: "absent"
    pn_access: "any"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
changed
boolean
always
indicates whether the CLI caused changes on the target.

command
string
always
the CLI command run on the target node.

stderr
list / elements=string
on error
set of error responses from the log_audit_exceptions command.

stdout
list / elements=string
always
set of responses from the pn_log_audit_exceptions command.



Authors

  • Pluribus Networks (@rajaspachipulusu17)

© 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/pn_log_audit_exception_module.html