community.network.pn_access_list – CLI command to create/delete access-list

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

Synopsis

  • This module can be used to create and delete an access list.

Parameters

Parameter Choices/Defaults Comments
pn_cliswitch
string
Target switch to run the CLI on.
pn_name
string
Access List Name.
pn_scope
string
    Choices:
  • local
  • fabric
scope. Available valid values - local or fabric.
state
string / required
    Choices:
  • present
  • absent
State the action to perform. Use 'present' to create access-list and 'absent' to delete access-list.

Examples

- name: Access list functionality
  community.network.pn_access_list:
    pn_cliswitch: "sw01"
    pn_name: "foo"
    pn_scope: "local"
    state: "present"

- name: Access list functionality
  community.network.pn_access_list:
    pn_cliswitch: "sw01"
    pn_name: "foo"
    pn_scope: "local"
    state: "absent"

- name: Access list functionality
  community.network.pn_access_list:
    pn_cliswitch: "sw01"
    pn_name: "foo"
    pn_scope: "fabric"
    state: "present"

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 access-list command.

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



Authors

  • Pluribus Networks (@amitsi)