Junos OS Platform Options¶
The Juniper Junos OS supports multiple connections. This page offers details on how each connection works in Ansible and how to use it.
Connections available¶
CLI
|
NETCONF all modules except |
|
---|---|---|
Protocol |
SSH |
XML over SSH |
Credentials |
uses SSH keys / SSH-agent if present accepts |
uses SSH keys / SSH-agent if present accepts |
Indirect Access |
via a bastion (jump host) |
via a bastion (jump host) |
Connection Settings |
|
|
Enable Mode |
not supported by Junos OS |
not supported by Junos OS |
Returned Data Format |
|
|
The ansible_connection: local
has been deprecated. Please use ansible_connection: ansible.netcommon.network_cli
or ansible_connection: ansible.netcommon.netconf
instead.
Using CLI in Ansible¶
Example CLI inventory [junos:vars]
¶
[junos:vars]
ansible_connection=ansible.netcommon.network_cli
ansible_network_os=junipernetworks.junos.junos
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 Junos OS version
junipernetworks.junos.junos_command:
commands: show version
when: ansible_network_os == 'junipernetworks.junos.junos'
Using NETCONF in Ansible¶
Enabling NETCONF¶
Before you can use NETCONF to connect to a switch, you must:
install the
ncclient
python package on your control node(s) withpip install ncclient
enable NETCONF on the Junos OS device(s)
To enable NETCONF on a new switch via Ansible, use the junipernetworks.junos.junos_netconf
module through the CLI connection. Set up your platform-level variables just like in the CLI example above, then run a playbook task like this:
- name: Enable NETCONF
connection: ansible.netcommon.network_cli
junipernetworks.junos.junos_netconf:
when: ansible_network_os == 'junipernetworks.junos.junos'
Once NETCONF is enabled, change your variables to use the NETCONF connection.
Example NETCONF inventory [junos:vars]
¶
[junos:vars]
ansible_connection=ansible.netcommon.netconf
ansible_network_os=junipernetworks.junos.junos
ansible_user=myuser
ansible_password=!vault |
ansible_ssh_common_args='-o ProxyCommand="ssh -W %h:%p -q bastion01"'
Example NETCONF task¶
- name: Backup current switch config (junos)
junipernetworks.junos.junos_config:
backup: yes
register: backup_junos_location
when: ansible_network_os == 'junipernetworks.junos.junos'
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