community.network.pn_prefix_list_network – CLI command to add/remove prefix-list-network
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_network.
Synopsis
- This module is used to add network associated with prefix list and remove networks associated with prefix list.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| pn_cliswitch
string
|
Target switch to run the CLI on.
|
|
| pn_name
string
|
Prefix List Name.
|
|
| pn_netmask
string
|
netmask of the network associated the prefix list.
|
|
| pn_network
string
|
network associated with the prefix list.
|
|
| state
string / required
|
|
State the action to perform. Use present to create prefix-list-network and absent to delete prefix-list-network.
|
Examples
- name: Prefix list network add
community.network.pn_prefix_list_network:
pn_cliswitch: "sw01"
pn_name: "foo"
pn_network: "172.16.3.1"
pn_netmask: "24"
state: "present"
- name: Prefix list network remove
community.network.pn_prefix_list_network:
pn_cliswitch: "sw01"
state: "absent"
pn_name: "foo"
pn_network: "172.16.3.1"
pn_netmask: "24"
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-network command.
|
| stdout
list / elements=string
|
always |
set of responses from the prefix-list-network 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_network_module.html