vyos.vyos.vyos – Use vyos cliconf to run command on VyOS platform

Note

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

To use it in a playbook, specify: vyos.vyos.vyos.

New in version 1.0.0: of vyos.vyos

Synopsis

  • This vyos plugin provides low level abstraction apis for sending and receiving CLI commands from VyOS network devices.

Parameters

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