arista.eos.eos – Use eos cliconf to run command on Arista EOS platform

Note

This plugin is part of the arista.eos collection (version 3.1.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 arista.eos.

To use it in a playbook, specify: arista.eos.eos.

New in version 1.0.0: of arista.eos

Synopsis

  • This eos plugin provides low level abstraction apis for sending and receiving CLI commands from Arista EOS network devices.

Parameters

Parameter Choices/Defaults Configuration Comments
config_commands
list / elements=string
added in 2.0.0 of arista.eos
Default:
[]
var: ansible_eos_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.
eos_use_sessions
boolean
    Choices:
  • no
  • yes ←
env:ANSIBLE_EOS_USE_SESSIONS
var: ansible_eos_use_sessions
Specifies if sessions should be used on remote host or not

Authors

  • Ansible Networking Team