junos_package – Installs packages on remote devices running Junos

Synopsis

  • This module can install new and updated packages on remote devices running Junos. The module will compare the specified package with the one running on the remote device and install the specified version if there is a mismatch

Requirements

The below requirements are needed on the host that executes this module.

  • junos-eznc

  • ncclient (>=v0.5.2)

Parameters

Parameter Choices/Defaults Comments
force
boolean
    Choices:
  • no ←
  • yes
The force argument instructs the module to bypass the package version check and install the packaged identified in src on the remote device.
force_host
boolean
added in 2.8
    Choices:
  • no ←
  • yes
The force_host argument controls the way software package or bundle is added on remote JUNOS host and is applicable for JUNOS QFX5100 device. If the value is set to True it will ignore any warnings while adding the host software package or bundle.
issu
boolean
added in 2.8
    Choices:
  • no ←
  • yes
The issu argument is a boolean flag when set to True allows unified in-service software upgrade (ISSU) feature which enables you to upgrade between two different Junos OS releases with no disruption on the control plane and with minimal disruption of traffic.
no_copy
boolean
    Choices:
  • no ←
  • yes
The no_copy argument is responsible for instructing the remote device on where to install the package from. When enabled, the package is transferred to the remote device prior to installing.
provider
dictionary
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli or connection: netconf.
For more information please see the Junos OS Platform Options guide.
A dict object containing connection details.
host
string / required
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password
string
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
integer
Default:
22
Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for transport=cli) or port 830 (for transport=netconf) device.
ssh_keyfile
path
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
timeout
integer
Default:
10
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
username
string
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
reboot
boolean
    Choices:
  • no
  • yes ←
In order for a package to take effect, the remote device must be restarted. When enabled, this argument will instruct the module to reboot the device once the updated package has been installed. If disabled or the remote package does not need to be changed, the device will not be started.
src
- / required
The src argument specifies the path to the source package to be installed on the remote device in the advent of a version mismatch. The src argument can be either a localized path or a full path to the package file to install.

aliases: package
validate
boolean
added in 2.5
    Choices:
  • no
  • yes ←
The validate argument is responsible for instructing the remote device to skip checking the current device configuration compatibility with the package being installed. When set to false validation is not performed.
version
-
The version argument can be used to explicitly specify the version of the package that should be installed on the remote device. If the version argument is not specified, then the version is extracts from the src filename.

Notes

Note

  • This module requires the netconf system service be enabled on the remote device being managed.

  • Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4.

  • Works with local connections only.

  • For information on using CLI and netconf see the Junos OS Platform Options guide

  • For more information on using Ansible to manage network devices see the Ansible Network Guide

  • For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper.

Examples

# the required set of connection arguments have been purposely left off
# the examples for brevity

- name: install local package on remote device
  junos_package:
    src: junos-vsrx-12.1X46-D10.2-domestic.tgz

- name: install local package on remote device without rebooting
  junos_package:
    src: junos-vsrx-12.1X46-D10.2-domestic.tgz
    reboot: no

Status

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

  • Peter Sprygada (@privateip)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.