junos_config – Manage configuration on devices running Juniper JUNOS
junos_config – Manage configuration on devices running Juniper JUNOS
New in version 2.1.
Synopsis
- This module provides an implementation for working with the active configuration running on Juniper JUNOS devices. It provides a set of arguments for loading configuration, performing rollback operations and zeroing the active configuration on the device.
Requirements
The below requirements are needed on the host that executes this module.
- ncclient (>=v0.5.2)
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
backup boolean added in 2.2 |
|
This argument will cause the module to create a full backup of the current | |
backup_options dictionary added in 2.8 |
This is a dict object containing configurable options related to backup file path. The value of this option is read only when | ||
dir_path path |
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of | ||
filename - |
The filename to be used to store the backup configuration. If the the filename is not given it will be generated based on the hostname, current time and date in format defined by _config.@ | ||
check_commit boolean added in 2.8 |
|
This argument will check correctness of syntax; do not apply changes. Note that this argument can be used to confirm verified configuration done via commit confirmed operation | |
comment - |
Default: "configured by junos_config" |
The | |
confirm - |
Default: 0 |
The | |
confirm_commit boolean added in 2.4 |
|
This argument will execute commit operation on remote device. It can be used to confirm a previous commit. | |
lines - |
This argument takes a list of | ||
provider dictionary |
Deprecated Starting with Ansible 2.5 we recommend using 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 | ||
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 | |
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 | ||
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 | ||
replace boolean |
|
The Note this argument should be considered deprecated. To achieve the equivalent, set the update argument to | |
rollback - |
The | ||
src - added in 2.2 |
The src argument provides a path to the configuration file to load into the remote system. The path can either be a full system path to the configuration file if the value starts with / or relative to the root of the implemented role or playbook. This argument is mutually exclusive with the lines argument. | ||
src_format - added in 2.2 |
|
The src_format argument specifies the format of the configuration found int src. If the src_format argument is not provided, the module will attempt to determine the format of the configuration file specified in src. | |
update - added in 2.3 |
|
This argument will decide how to load the configuration data particularly when the candidate configuration and loaded configuration contain conflicting statements. Following are accepted values. | |
zeroize boolean |
|
The |
Notes
Note
- This module requires the netconf system service be enabled on the remote device being managed.
- Abbreviated commands are NOT idempotent, see Network FAQ.
- Loading JSON-formatted configuration json is supported starting in Junos OS Release 16.1 onwards.
- Update
override
not currently compatible withset
notation. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4.
- Recommended connection is
netconf
. See the Junos OS Platform Options. - This module also works with
local
connections for legacy playbooks. - 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
- name: load configure file into device
junos_config:
src: srx.cfg
comment: update config
- name: load configure lines into device
junos_config:
lines:
- set interfaces ge-0/0/1 unit 0 description "Test interface"
- set vlans vlan01 description "Test vlan"
comment: update config
- name: Set routed VLAN interface (RVI) IPv4 address
junos_config:
lines:
- set vlans vlan01 vlan-id 1
- set interfaces irb unit 10 family inet address 10.0.0.1/24
- set vlans vlan01 l3-interface irb.10
- name: Check correctness of commit configuration
junos_config:
check_commit: yes
- name: rollback the configuration to id 10
junos_config:
rollback: 10
- name: zero out the current configuration
junos_config:
zeroize: yes
- name: Set VLAN access and trunking
junos_config:
lines:
- set vlans vlan02 vlan-id 6
- set interfaces ge-0/0/6.0 family ethernet-switching interface-mode access vlan members vlan02
- set interfaces ge-0/0/6.0 family ethernet-switching interface-mode trunk vlan members vlan02
- name: confirm a previous commit
junos_config:
confirm_commit: yes
- name: for idempotency, use full-form commands
junos_config:
lines:
# - set int ge-0/0/1 unit 0 desc "Test interface"
- set interfaces ge-0/0/1 unit 0 description "Test interface"
- name: configurable backup path
junos_config:
src: srx.cfg
backup: yes
backup_options:
filename: backup.cfg
dir_path: /home/user
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
backup_path string |
when backup is yes |
The full path to the backup file
Sample: /playbooks/ansible/backup/config.2016-07-16@22:28:34 |
date string |
when backup is yes |
The date extracted from the backup file name
Sample: 2016-07-16 |
filename string |
when backup is yes and filename is not specified in backup options |
The name of the backup file
Sample: junos01_config.2016-07-16@22:28:34 |
shortname string |
when backup is yes and filename is not specified in backup options |
The full path to the backup file excluding the timestamp
Sample: /playbooks/ansible/backup/junos01_config |
time string |
when backup is yes |
The time extracted from the backup file name
Sample: 22:28:34 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/junos_config_module.html