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

Note

This plugin is part of the cisco.ios 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.ios.

To use it in a playbook, specify: cisco.ios.ios.

New in version 1.0.0: of cisco.ios

Synopsis

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

Parameters

Parameter Choices/Defaults Configuration Comments
config_commands
list / elements=string
added in 2.0.0 of cisco.ios
Default:
[]
var: ansible_ios_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