cisco.iosxr.iosxr – Use iosxr cliconf to run command on Cisco IOS XR platform

Note

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

New in version 1.0.0: of cisco.iosxr

Synopsis

  • This iosxr plugin provides low level abstraction apis for sending and receiving CLI commands from Cisco IOS XR network devices.

Parameters

Parameter Choices/Defaults Configuration Comments
config_commands
list / elements=string
added in 2.0.0 of cisco.iosxr
Default:
[]
var: ansible_iosxr_config_commands
Specifies a list of commands that can make configuration changes to the target device.
When `ansible_network_single_user_mode` is enabled, if a command sent to the device is present in this list, the existing cache is invalidated.

Authors

  • Ansible Networking Team

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/iosxr/iosxr_cliconf.html