SLX-OS Platform Options — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# SLX-OS Platform Options

Extreme SLX-OS Ansible modules only support CLI connections today. `httpapi` modules may be added in future. This page offers details on how to use `network_cli` on SLX-OS in Ansible 2.6.

Topics

- SLX-OS Platform Options
  - Connections Available
  - Using CLI in Ansible 2.6
    - Example CLI `group_vars/slxos.yml`
    - Example CLI Task

## Connections Available

| CLI
--- | ---
Protocol | SSH
Credentials | uses SSH keys / SSH-agent if present accepts `-u myuser -k` if using password
Indirect Access | via a bastion (jump host)
Connection Settings | `ansible_connection: network_cli`
Enable Mode (Privilege Escalation) | not supported by SLX-OS
Returned Data Format | `stdout[0].`

SLX-OS does not support `ansible_connection: local`. You must use `ansible_connection: network_cli`.

## Using CLI in Ansible 2.6

### Example CLI `group_vars/slxos.yml`

    ansible_connection: network_cli
    ansible_network_os: slxos
    ansible_user: myuser
    ansible_ssh_pass: !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_ssh_pass` 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 in `ps` output), SSH does not support providing passwords via environment variables.

### Example CLI Task

    - name: Backup current switch config (slxos)
      slxos_config:
        backup: yes
      register: backup_slxos_location
      when: ansible_network_os == 'slxos'

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.