Docs4dev
Docs
ansible / 2.10 / collections / community / network / pn_prefix_list_module.html

community.network.pn_prefix_list – CLI command to create/delete prefix-list

Note

This plugin is part of the community.network collection (version 1.3.0).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.pn_prefix_list.

Synopsis

  • This module can be used to create or delete prefix list.

Parameters

Parameter Choices/Defaults Comments
pn_cliswitch
string
Target switch to run the CLI on.
pn_name
string / required
Prefix List Name.
pn_scope
string
    Choices:
  • local
  • fabric
scope of prefix-list.
state
string
    Choices:
  • present ←
  • absent
State the action to perform. Use present to create prefix-list and absent to delete prefix-list.

Examples

- name: Create prefix list
  community.network.pn_prefix_list:
    pn_cliswitch: "sw01"
    pn_name: "foo"
    pn_scope: "local"
    state: "present"

- name: Delete prefix list
  community.network.pn_prefix_list:
    pn_cliswitch: "sw01"
    pn_name: "foo"
    state: "absent"

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

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



Authors

  • Pluribus Networks (@rajaspachipulusu17)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/pn_prefix_list_module.html