VyOS Platform Options¶
The VyOS collection supports the ansible.netcommon.network_cli
connection type. This page offers details on connection options to manage VyOS using Ansible.
Connections available¶
CLI |
|
---|---|
Protocol |
SSH |
Credentials |
uses SSH keys / SSH-agent if present accepts |
Indirect Access |
via a bastion (jump host) |
Connection Settings |
|
Enable Mode |
not supported |
Returned Data Format |
Refer to individual module documentation |
The ansible_connection: local
has been deprecated. Please use ansible_connection: ansible.netcommon.network_cli
instead.
Using CLI in Ansible¶
Example CLI group_vars/vyos.yml
¶
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: vyos.vyos.vyos
ansible_user: myuser
ansible_password: !vault...
ansible_ssh_common_args: '-o ProxyCommand="ssh -W %h:%p -q bastion01"'
If you are using SSH keys (including an ssh-agent) you can remove the
ansible_password
configuration.If you are accessing your host directly (not through a bastion/jump host) you can remove the
ansible_ssh_common_args
configuration.If you are accessing your host through a bastion/jump host, you cannot include your SSH password in the
ProxyCommand
directive. To prevent secrets from leaking out (for example inps
output), SSH does not support providing passwords via environment variables.
Example CLI task¶
- name: Retrieve VyOS version info
vyos.vyos.vyos_command:
commands: show version
when: ansible_network_os == 'vyos.vyos.vyos'
Warning
Never store passwords in plain text. We recommend using SSH keys to authenticate SSH connections. Ansible supports ssh-agent to manage your SSH keys. If you must use passwords to authenticate SSH connections, we recommend encrypting them with Ansible Vault.
See also