Try SpotterManage Cisco IOS XR configuration sections
| "added in version" 2.1 of ansible.builtin"
Authors: Ricardo Carrillo Cruz (@rcarrillocruz)
preview | supported by network
pipInstall with pip install ansible==2.7.16
Cisco IOS XR configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with IOS XR configuration sections in a deterministic way.
- name: configure top level configuration
iosxr_config:
lines: hostname {{ inventory_hostname }}
- name: configure interface settings
iosxr_config:
lines:
- description test interface
- ip address 172.31.1.1 255.255.255.0
parents: interface GigabitEthernet0/0/0/0
- name: load a config from disk and replace the current config
iosxr_config:
src: config.cfg
replace: config
backup: yes
- name: for idempotency, use full-form commands
iosxr_config:
lines:
# - shut
- shutdown
# parents: int g0/0/0/1
parents: interface GigabitEthernet0/0/0/1
src:
description:
- Specifies the source path to the file that contains the configuration or configuration
template to load. The path to the source file can either be the full path on the
Ansible control host or a relative path from the playbook or role root directory. This
argument is mutually exclusive with I(lines), I(parents).
version_added: '2.2'
version_added_collection: ansible.builtin
admin:
default: 'no'
description:
- Enters into administration configuration mode for making config changes to the device.
type: bool
version_added: '2.4'
version_added_collection: ansible.builtin
after:
description:
- The ordered set of commands to append to the end of the command stack if a change
needs to be made. Just like with I(before) this allows the playbook designer to
append a set of commands to be executed after the command set.
force:
default: 'no'
description:
- The force argument instructs the module to not consider the current devices running-config. When
set to true, this will cause the module to push the contents of I(src) into the
device without first checking if already configured.
- Note this argument should be considered deprecated. To achieve the equivalent,
set the C(match=none) which is idempotent. This argument will be removed in a future
release.
type: bool
version_added: '2.2'
version_added_collection: ansible.builtin
label:
description:
- Allows a commit label to be specified to be included when the configuration is committed.
A valid label must begin with an alphabet and not exceed 30 characters, only alphabets,
digits, hyphens and underscores are allowed. If the configuration is not changed
or committed, this argument is ignored.
version_added: '2.7'
version_added_collection: ansible.builtin
lines:
aliases:
- commands
description:
- The ordered set of commands that should be configured in the section. The commands
must be the exact same commands as found in the device running-config. Be sure
to note the configuration command syntax as some commands are automatically modified
by the device config parser.
match:
choices:
- line
- strict
- exact
- none
default: line
description:
- Instructs the module on the way to perform the matching of the set of commands against
the current device config. If match is set to I(line), commands are matched line
by line. If match is set to I(strict), command lines are matched with respect to
position. If match is set to I(exact), command lines must be an equal match. Finally,
if match is set to I(none), the module will not attempt to compare the source configuration
with the running configuration on the remote device.
backup:
default: 'no'
description:
- This argument will cause the module to create a full backup of the current C(running-config)
from the remote device before any changes are made. The backup file is written
to the C(backup) folder in the playbook root directory or role root directory, if
playbook is part of an ansible role. If the directory does not exist, it is created.
type: bool
version_added: '2.2'
version_added_collection: ansible.builtin
before:
description:
- The ordered set of commands to push on to the command stack if a change needs to
be made. This allows the playbook designer the opportunity to perform configuration
commands prior to pushing any changes without affecting how the set of commands
are matched against the system.
config:
description:
- The module, by default, will connect to the remote device and retrieve the current
running-config to use as a base for comparing against the contents of source. There
are times when it is not desirable to have the task get the current running-config
for every task in a playbook. The I(config) argument allows the implementer to
pass in the configuration to use as the base config for comparison.
comment:
default: configured by iosxr_config
description:
- Allows a commit description to be specified to be included when the configuration
is committed. If the configuration is not changed or committed, this argument is
ignored.
version_added: '2.2'
version_added_collection: ansible.builtin
parents:
description:
- The ordered set of parents that uniquely identify the section or hierarchy the commands
should be checked against. If the parents argument is omitted, the commands are
checked against the set of top level or global commands.
replace:
choices:
- line
- block
- config
default: line
description:
- Instructs the module on the way to perform the configuration on the device. If
the replace argument is set to I(line) then the modified lines are pushed to the
device in configuration mode. If the replace argument is set to I(block) then the
entire command block is pushed to the device in configuration mode if any line is
not correct.
backup_path: description: The full path to the backup file returned: when backup is yes sample: /playbooks/ansible/backup/iosxr01.2016-07-16@22:28:34 type: string commands: description: The set of commands that will be pushed to the remote device returned: If there are commands to run against the host sample: - hostname foo - router ospf 1 - router-id 1.1.1.1 type: list