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

Note

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

Comments

commit_confirmed

boolean

enable or disable commit confirmed mode

Choices:

  • no ← (default)

  • yes

Configuration:

  • Environment variable: ANSIBLE_IOSXR_COMMIT_CONFIRMED

  • Variable: ansible_iosxr_commit_confirmed

commit_confirmed_timeout

integer

Commits the configuration on a trial basis for the time specified in seconds or minutes.

Configuration:

  • Environment variable: ANSIBLE_IOSXR_COMMIT_CONFIRMED_TIMEOUT

  • Variable: ansible_iosxr_commit_confirmed_timeout

config_commands

list / elements=string

added in 2.0.0 of cisco.iosxr

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.

Default: []

Configuration:

  • Variable: ansible_iosxr_config_commands

Authors

  • Ansible Networking Team (@ansible-network)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.