cisco.iosxr.iosxr_prefix_lists – Prefix-Lists resource module.

Note

This plugin is part of the cisco.iosxr collection (version 2.6.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 cisco.iosxr.

To use it in a playbook, specify: cisco.iosxr.iosxr_prefix_lists.

New in version 2.3.0: of cisco.iosxr

Synopsis

  • This module manages prefix-lists configuration on devices running Cisco IOSXR.

Note

This module has a corresponding action plugin.

Parameters

Parameter Choices/Defaults Comments
config
list / elements=dictionary
A list of prefix-lists configuration.
afi
string
    Choices:
  • ipv4
  • ipv6
The Address Family Identifier (AFI) for the prefix-lists.
prefix_lists
list / elements=dictionary
List of prefix-list configurations.
entries
list / elements=dictionary
List of configurations for the specified prefix-list
action
string
    Choices:
  • permit
  • deny
  • remark
Prefix-List permit or deny.
description
string
Description of the prefix list. only applicable for action "remark".
prefix
string
IP or IPv6 prefix in A.B.C.D/LEN or A:B::C:D/LEN format. only applicable for action "permit" and "deny"
sequence
integer
Sequence Number.
name
string
Name of the prefix-list.
running_config
string
This option is used only with state parsed.
The value of this option should be the output received from the Iosxr device by executing the command show running-config prefix-list.
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
state
string
    Choices:
  • merged ←
  • replaced
  • overridden
  • deleted
  • parsed
  • gathered
  • rendered
The state the configuration should be left in.
Refer to examples for more details.
With state replaced, for the listed prefix-lists, sequences that are in running-config but not in the task are negated.
With state overridden, all prefix-lists that are in running-config but not in the task are negated.
Please refer to examples for more details.

Notes

Note

  • Tested against IOSXR 7.0.2.

  • This module works with connection network_cli.

Examples

# Using merged
# Before state
#RP/0/0/CPU0:10#show running-config
#Thu Feb  4 09:38:36.245 UTC
#% No such configuration item(s)
#RP/0/0/CPU0:10#
#
- name: Merge the provided configuration with the existing running configuration
  cisco.iosxr.iosxr_prefix_lists:
         state: merged
         config:
           - afi: ipv6
             prefix_lists:
               - name: pl_1
                 entries:
                   - prefix: 2001:db8:1234::/48
                     action: deny
                     sequence: 1
               - name: pl_2
                 entries:
                   - sequence: 2
                     action: remark
                     description: TEST_PL_2_REMARK
           - afi: ipv4
             prefix_lists:
               - name: pl1
                 entries:
                   - sequence: 3
                     action: remark
                     description: TEST_PL1_2_REMARK
                   - sequence: 4
                     action: permit
                     prefix: 10.0.0.0/24
               - name: pl2
                 entries:
                   - sequence: 5
                     action: remark
                     description: TEST_PL2_REMARK
#
# After state:
#
#RP/0/0/CPU0:10#show running-config
# ipv6 prefix-list pl_1
#  1 deny 2001:db8:1234::/48
# !
# ipv6 prefix-list pl_2
#  2 remark TEST_PL_2_REMARK
# !
# ipv4 prefix-list pl1
#  3 remark TEST_PL1_2_REMARK
#  4 permit 10.0.0.0/24
# !
# ipv4 prefix-list pl2
#  5 remark TEST_PL2_REMARK
# !
#Module execution
#
# "after": [
#         {
#             "afi": "ipv6",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "deny",
#                             "prefix": "2001:db8:1234::/48",
#                             "sequence": 1
#                         }
#                     ],
#                     "name": "pl_1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL_2_REMARK",
#                             "sequence": 2
#                         }
#                     ],
#                     "name": "pl_2"
#                 }
#             ]
#         },
#         {
#             "afi": "ipv4",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL1_2_REMARK",
#                             "sequence": 3
#                         },
#                         {
#                             "action": "permit",
#                             "prefix": "10.0.0.0/24",
#                             "sequence": 4
#                         }
#                     ],
#                     "name": "pl1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL2_REMARK",
#                             "sequence": 5
#                         }
#                     ],
#                     "name": "pl2"
#                 }
#             ]
#         }
#     ],
#     "before": [],
#     "changed": true,
#     "commands": [
#         "ipv6 prefix-list pl_1 1 deny 2001:db8:1234::/48",
#         "ipv6 prefix-list pl_2 2 remark TEST_PL_2_REMARK",
#         "ipv4 prefix-list pl1 3 remark TEST_PL1_2_REMARK",
#         "ipv4 prefix-list pl1 4 permit 10.0.0.0/24",
#         "ipv4 prefix-list pl2 5 remark TEST_PL2_REMARK"
#     ]
#-----------------------------------------------------------------------
# Using replaced:
# --------------
# Before state
#RP/0/0/CPU0:10#show running-config
#
# ipv6 prefix-list pl_1
#  1 deny 2001:db8:1234::/48
# !
# ipv6 prefix-list pl_2
#  2 remark TEST_PL_2_REMARK
# !
# ipv4 prefix-list pl1
#  3 remark TEST_PL1_2_REMARK
#  4 permit 10.0.0.0/24
# !
# ipv4 prefix-list pl2
#  5 remark TEST_PL2_REMARK
# !
#
#
- name: Replace device configurations of listed prefix lists with provided configurations
  register: result
  cisco.iosxr.iosxr_prefix_lists: &id001
    config:
           - afi: ipv4
             prefix_lists:
               - name: pl1
                 entries:
                   - sequence: 3
                     action: permit
                     prefix: 10.0.0.0/24
           - afi: ipv6
             prefix_lists:
               - name: pl_1
                 entries:
                   - prefix: 2001:db8:1234::/48
                     action: permit
                     sequence: 1
               - name: pl_2
                 entries:
                   - sequence: 2
                     action: remark
                     description: TEST_PL1_2
    state: replaced
# After state:
#RP/0/0/CPU0:10#show running-config
#
# ipv6 prefix-list pl_1
#  1 deny 2001:db8:1234::/48
# !
# ipv6 prefix-list pl_2
#  2 remark TEST_PL1_2
# !
# ipv4 prefix-list pl1
#  3 permit 10.0.0.0/24
# !
# ipv4 prefix-list pl2
#  5 remark TEST_PL2_REMARK
#
# Module Execution:
#
# "after": [
#         {
#             "afi": "ipv6",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "deny",
#                             "prefix": "2001:db8:1234::/48",
#                             "sequence": 1
#                         }
#                     ],
#                     "name": "pl_1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL1_2",
#                             "sequence": 2
#                         }
#                     ],
#                     "name": "pl_2"
#                 }
#             ]
#         },
#         {
#             "afi": "ipv4",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "permit",
#                             "prefix": "10.0.0.0/24",
#                             "sequence": 3
#                         }
#                     ],
#                     "name": "pl1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL2_REMARK",
#                             "sequence": 5
#                         }
#                     ],
#                     "name": "pl2"
#                 }
#             ]
#         }
#     ],
#     "before": [
#         {
#             "afi": "ipv6",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "deny",
#                             "prefix": "2001:db8:1234::/48",
#                             "sequence": 1
#                         }
#                     ],
#                     "name": "pl_1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL_2_REMARK",
#                             "sequence": 2
#                         }
#                     ],
#                     "name": "pl_2"
#                 }
#             ]
#         },
#         {
#             "afi": "ipv4",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL1_2_REMARK",
#                             "sequence": 3
#                         },
#                         {
#                             "action": "permit",
#                             "prefix": "10.0.0.0/24",
#                             "sequence": 4
#                         }
#                     ],
#                     "name": "pl1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL2_REMARK",
#                             "sequence": 5
#                         }
#                     ],
#                     "name": "pl2"
#                 }
#             ]
#         }
#     ],
#     "changed": true,
#     "commands": [
#         "no ipv4 prefix-list pl1 3 remark TEST_PL1_2_REMARK",
#         "no ipv4 prefix-list pl1 4 permit 10.0.0.0/24",
#         "ipv4 prefix-list pl1 3 permit 10.0.0.0/24",
#         "ipv6 prefix-list pl_2 2 remark TEST_PL1_2"
#     ],
#     "invocation": {
#         "module_args": {
#             "config": [
#                 {
#                     "afi": "ipv4",
#                     "prefix_lists": [
#                         {
#                             "entries": [
#                                 {
#                                     "action": "permit",
#                                     "description": null,
#                                     "prefix": "10.0.0.0/24",
#                                     "sequence": 3
#                                 }
#                             ],
#                             "name": "pl1"
#                         }
#                     ]
#                 },
#                 {
#                     "afi": "ipv6",
#                     "prefix_lists": [
#                         {
#                             "entries": [
#                                 {
#                                     "action": "permit",
#                                     "description": null,
#                                     "prefix": "2001:db8:1234::/48",
#                                     "sequence": 1
#                                 }
#                             ],
#                             "name": "pl_1"
#                         },
#                         {
#                             "entries": [
#                                 {
#                                     "action": "remark",
#                                     "description": "TEST_PL1_2",
#                                     "prefix": null,
#                                     "sequence": 2
#                                 }
#                             ],
#                             "name": "pl_2"
#                         }
#                     ]
#                 }
#             ],
#             "running_config": null,
#             "state": "replaced"
#         }
#     }
# }
#------------------------------------------------------------------
# Using deleted:
# -------------
# Before state:
#RP/0/0/CPU0:10#show running-config
#
# ipv6 prefix-list pl_1
#  1 deny 2001:db8:1234::/48
# !
# ipv6 prefix-list pl_2
#  2 remark TEST_PL_2_REMARK
# !
# ipv4 prefix-list pl1
#  3 remark TEST_PL1_2_REMARK
#  4 permit 10.0.0.0/24
# !
# ipv4 prefix-list pl2
#  5 remark TEST_PL2_REMARK

- name: Delete all prefix-lists from the device
  cisco.iosxr.iosxr_prefix_lists:
    state: deleted

# After state:
#RP/0/0/CPU0:10#show running-config
#
#
# Module Execution:
#
# "after": [],
#     "before": [
#         {
#             "afi": "ipv6",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "deny",
#                             "prefix": "2001:db8:1234::/48",
#                             "sequence": 1
#                         }
#                     ],
#                     "name": "pl_1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL1_2",
#                             "sequence": 2
#                         }
#                     ],
#                     "name": "pl_2"
#                 }
#             ]
#         },
#         {
#             "afi": "ipv4",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "permit",
#                             "prefix": "10.0.0.0/24",
#                             "sequence": 3
#                         }
#                     ],
#                     "name": "pl1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL2_REMARK",
#                             "sequence": 5
#                         }
#                     ],
#                     "name": "pl2"
#                 }
#             ]
#         }
#     ],
#     "changed": true,
#     "commands": [
#         "no ipv6 prefix-list pl_1",
#         "no ipv6 prefix-list pl_2",
#         "no ipv4 prefix-list pl1",
#         "no ipv4 prefix-list pl2"
#     ],
#     "invocation": {
#         "module_args": {
#             "config": null,
#             "running_config": null,
#             "state": "deleted"
#         }
#     }
# }
#---------------------------------------------------------------------------------
#
# using gathered:
# --------------
# Before state:
#RP/0/0/CPU0:10#show running-config
#
# ipv6 prefix-list pl_1
#  1 deny 2001:db8:1234::/48
# !
# ipv6 prefix-list pl_2
#  2 remark TEST_PL_2_REMARK
# !
# ipv4 prefix-list pl1
#  3 remark TEST_PL1_2_REMARK
#  4 permit 10.0.0.0/24
# !
# ipv4 prefix-list pl2
#  5 remark TEST_PL2_REMARK
#
- name: Gather ACL interfaces facts using gathered state
  cisco.iosxr.iosxr_prefix_lists:
     state: gathered
#
# Module Execution:
#
# "gathered": [
#         {
#             "afi": "ipv6",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "deny",
#                             "prefix": "2001:db8:1234::/48",
#                             "sequence": 1
#                         }
#                     ],
#                     "name": "pl_1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL_2_REMARK",
#                             "sequence": 2
#                         }
#                     ],
#                     "name": "pl_2"
#                 }
#             ]
#         },
#         {
#             "afi": "ipv4",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL1_2_REMARK",
#                             "sequence": 3
#                         },
#                         {
#                             "action": "permit",
#                             "prefix": "10.0.0.0/24",
#                             "sequence": 4
#                         }
#                     ],
#                     "name": "pl1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL2_REMARK",
#                             "sequence": 5
#                         }
#                     ],
#                     "name": "pl2"
#                 }
#             ]
#         }
#     ],
#     "changed": false,
#--------------------------------------------------------------------------
# Using parsed:
# --------------
#
# parsed.cfg
#------------------------------
# ipv6 prefix-list pl_1
#  1 deny 2001:db8:1234::/48
# !
# ipv6 prefix-list pl_2
#  2 remark TEST_PL_2_REMARK
# !
# ipv4 prefix-list pl1
#  3 remark TEST_PL1_2_REMARK
#  4 permit 10.0.0.0/24
# !
# ipv4 prefix-list pl2
#  5 remark TEST_PL2_REMARK
#
#
- name: Parse externally provided Prefix_lists config to agnostic model
  cisco.iosxr.iosxr_prefix_lists:
     running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}"
     state: parsed
#
# Module execution:
#"parsed": [
#         {
#             "afi": "ipv6",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "deny",
#                             "prefix": "2001:db8:1234::/48",
#                             "sequence": 1
#                         }
#                     ],
#                     "name": "pl_1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL_2_REMARK",
#                             "sequence": 2
#                         }
#                     ],
#                     "name": "pl_2"
#                 }
#             ]
#         },
#         {
#             "afi": "ipv4",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL1_2_REMARK",
#                             "sequence": 3
#                         },
#                         {
#                             "action": "permit",
#                             "prefix": "10.0.0.0/24",
#                             "sequence": 4
#                         }
#                     ],
#                     "name": "pl1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL2_REMARK",
#                             "sequence": 5
#                         }
#                     ],
#                     "name": "pl2"
#                 }
#             ]
#         }
#     ]
#
#----------------------------------------------------------------------------
# Using rendered:
# --------------
#
- name: Render platform specific commands from task input using rendered state
  register: result
  cisco.iosxr.iosxr_prefix_lists:
     config:
       - afi: ipv6
         prefix_lists:
           - name: pl_1
             entries:
               - prefix: 2001:db8:1234::/48
                 action: deny
                 sequence: 1
           - name: pl_2
             entries:
               - sequence: 2
                 action: remark
                 description: TEST_PL_2_REMARK
       - afi: ipv4
         prefix_lists:
           - name: pl1
             entries:
               - sequence: 3
                 action: remark
                 description: TEST_PL1_2_REMARK
               - sequence: 4
                 action: permit
                 prefix: 10.0.0.0/24
           - name: pl2
             entries:
               - sequence: 5
                 action: remark
                 description: TEST_PL2_REMARK

     state: rendered
# After state:
# Module Execution:
# "rendered": [
#         "ipv6 prefix-list pl_1 1 deny 2001:db8:1234::/48",
#         "ipv6 prefix-list pl_2 2 remark TEST_PL_2_REMARK",
#         "ipv4 prefix-list pl1 3 remark TEST_PL1_2_REMARK",
#         "ipv4 prefix-list pl1 4 permit 10.0.0.0/24",
#         "ipv4 prefix-list pl2 5 remark TEST_PL2_REMARK"
#     ]
#
#---------------------------------------------------------------------------------
# Using overridden:
# --------------
# Before state:
#RP/0/0/CPU0:10#show running-config
#
# ipv6 prefix-list pl_1
#  1 deny 2001:db8:1234::/48
# !
# ipv6 prefix-list pl_2
#  2 remark TEST_PL_2_REMARK
# !
# ipv4 prefix-list pl1
#  3 remark TEST_PL1_2_REMARK
#  4 permit 10.0.0.0/24
# !
# ipv4 prefix-list pl2
#  5 remark TEST_PL2_REMARK
#
- name: Overridde all Prefix_lists configuration with provided configuration
  cisco.iosxr.iosxr_prefix_lists:
        config:
           - afi: ipv4
             prefix_lists:
               - name: pl3
                 entries:
                   - sequence: 3
                     action: remark
                     description: TEST_PL1_3_REMARK
                   - sequence: 4
                     action: permit
                     prefix: 10.0.0.0/24
        state: overridden

# After state:
#RP/0/0/CPU0:10#show running-config
#
#ipv4 prefix-list pl3
# 3 remark TEST_PL1_3_REMARK
# 4 permit 10.0.0.0/24
#!
# # Module Execution:
# "after": [
#         {
#             "afi": "ipv4",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL1_3_REMARK",
#                             "sequence": 3
#                         },
#                         {
#                             "action": "permit",
#                             "prefix": "10.0.0.0/24",
#                             "sequence": 4
#                         }
#                     ],
#                     "name": "pl3"
#                 }
#             ]
#         }
#     ],
#     "before": [
#         {
#             "afi": "ipv6",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "deny",
#                             "prefix": "2001:db8:1234::/48",
#                             "sequence": 1
#                         }
#                     ],
#                     "name": "pl_1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL_2_REMARK",
#                             "sequence": 2
#                         }
#                     ],
#                     "name": "pl_2"
#                 }
#             ]
#         },
#         {
#             "afi": "ipv4",
#             "prefix_lists": [
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL1_2_REMARK",
#                             "sequence": 3
#                         },
#                         {
#                             "action": "permit",
#                             "prefix": "10.0.0.0/24",
#                             "sequence": 4
#                         }
#                     ],
#                     "name": "pl1"
#                 },
#                 {
#                     "entries": [
#                         {
#                             "action": "remark",
#                             "description": "TEST_PL2_REMARK",
#                             "sequence": 5
#                         }
#                     ],
#                     "name": "pl2"
#                 }
#             ]
#         }
#     ],
#     "changed": true,
#     "commands": [
#         "no ipv6 prefix-list pl_1",
#         "no ipv6 prefix-list pl_2",
#         "no ipv4 prefix-list pl1",
#         "no ipv4 prefix-list pl2",
#         "ipv4 prefix-list pl3 3 remark TEST_PL1_3_REMARK",
#         "ipv4 prefix-list pl3 4 permit 10.0.0.0/24"
#     ],
#     "invocation": {
#         "module_args": {
#             "config": [
#                 {
#                     "afi": "ipv4",
#                     "prefix_lists": [
#                         {
#                             "entries": [
#                                 {
#                                     "action": "remark",
#                                     "description": "TEST_PL1_3_REMARK",
#                                     "prefix": null,
#                                     "sequence": 3
#                                 },
#                                 {
#                                     "action": "permit",
#                                     "description": null,
#                                     "prefix": "10.0.0.0/24",
#                                     "sequence": 4
#                                 }
#                             ],
#                             "name": "pl3"
#                         }
#                     ]
#                 }
#             ],
#             "running_config": null,
#             "state": "overridden"
#         }
#     }
# }
#

Authors

  • Ashwini Mhatre (@amhatre)