VOSS Platform Options

Extreme VOSS is part of the community.network collection and only supports CLI connections today. This page offers details on how to use ansible.netcommon.network_cli on VOSS in Ansible.

Connections available

CLI

Protocol

SSH

Credentials

uses SSH keys / SSH-agent if present

accepts -u myuser -k if using password

Indirect Access

by a bastion (jump host)

Connection Settings

ansible_connection: ansible.netcommon.network_cli

Enable Mode
(Privilege Escalation)

supported: use ansible_become: true with ansible_become_method: enable

Returned Data Format

stdout[0].

VOSS does not support ansible_connection: local. You must use ansible_connection: ansible.netcommon.network_cli.

Using CLI in Ansible

Example CLI group_vars/voss.yml

ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.voss
ansible_user: myuser
ansible_become: true
ansible_become_method: enable
ansible_password: !vault...
ansible_paramiko_proxy_command: '-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_paramiko_proxy_command 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 in ps output), SSH does not support providing passwords through environment variables.

Example CLI task

- name: Retrieve VOSS info
  community.network.voss_command:
    commands: show sys-info
  when: ansible_network_os == 'community.network.voss'

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

Setting timeout options