ansible / ansible.builtin / v2.9.3 / module / iosxr_config Manage Cisco IOS XR configuration sections | "added in version" 2.1 of ansible.builtin" Authors: Ricardo Carrillo Cruz (@rcarrillocruz) preview | supported by networkansible.builtin.iosxr_config (v2.9.3) — module
pip
Install with pip install ansible==2.9.3
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
- name: configurable backup path iosxr_config: src: config.cfg backup: yes backup_options: filename: backup.cfg dir_path: /home/user
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. If the C(backup_options) value is not given, 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. exclusive: default: false description: - Enters into exclusive configuration mode that locks out all users from committing configuration changes until the exclusive session ends. type: bool version_added: '2.9' version_added_collection: ansible.builtin backup_options: description: - This is a dict object containing configurable options related to backup file path. The value of this option is read only when C(backup) is set to I(yes), if C(backup) is set to I(no) this option will be silently ignored. suboptions: dir_path: description: - This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of C(filename) or default filename as described in C(filename) options description. If the path value is not given in that case a I(backup) directory will be created in the current working directory and backup configuration will be copied in C(filename) within I(backup) directory. type: path filename: description: - The filename to be used to store the backup configuration. If the the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time> type: dict version_added: '2.8' version_added_collection: ansible.builtin
backup_path: description: The full path to the backup file returned: when backup is yes sample: /playbooks/ansible/backup/iosxr01_config.2016-07-16@22:28:34 type: str 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 date: description: The date extracted from the backup file name returned: when backup is yes sample: '2016-07-16' type: str filename: description: The name of the backup file returned: when backup is yes and filename is not specified in backup options sample: iosxr01_config.2016-07-16@22:28:34 type: str shortname: description: The full path to the backup file excluding the timestamp returned: when backup is yes and filename is not specified in backup options sample: /playbooks/ansible/backup/iosxr01_config type: str time: description: The time extracted from the backup file name returned: when backup is yes sample: '22:28:34' type: str