cisco.nxos.nxos cliconf – Use NX-OS cliconf to run commands on Cisco NX-OS platform

Note

This cliconf plugin is part of the cisco.nxos collection (version 3.1.1).

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.nxos.

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

New in version 1.0.0: of cisco.nxos

Synopsis

  • This nxos plugin provides low level abstraction apis for sending and receiving CLI commands from Cisco NX-OS network devices.

Parameters

Parameter

Comments

config_commands

list / elements=string

added in 2.0.0 of cisco.nxos

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_nxos_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.