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

Note

This module is part of the community.network collection (version 5.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_prefix_list.

Synopsis

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

Parameters

Parameter

Comments

pn_cliswitch

string

Target switch to run the CLI on.

pn_name

string / required

Prefix List Name.

pn_scope

string

scope of prefix-list.

Choices:

  • "local"

  • "fabric"

state

string

State the action to perform. Use present to create prefix-list and absent to delete prefix-list.

Choices:

  • "present" ← (default)

  • "absent"

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

Description

changed

boolean

indicates whether the CLI caused changes on the target.

Returned: always

command

string

the CLI command run on the target node.

Returned: always

stderr

list / elements=string

set of error responses from the prefix-list command.

Returned: on error

stdout

list / elements=string

set of responses from the prefix-list command.

Returned: always

Authors

  • Pluribus Networks (@rajaspachipulusu17)