juniper_junos_config¶

Synopsis¶

• Manipulate the configuration of a Junos device. This module allows a combination of loading or rolling back, checking, diffing, retrieving, and committing the configuration of a Junos device. It performs the following steps in order:

1. Open a candidate configuration database.
   • If the config_mode option has a value of exclusive, the default, take a lock on the candidate configuration database. If the lock fails the module fails and reports an error.
   • If the config_mode option has a value of private, open a private candidate configuration database. If opening the private configuration database fails the module fails and reports an error.
2. Load configuration data into the candidate configuration database.
   • Configuration data may be loaded using the load or rollback options. If either of these options are specified, new configuration data is loaded. If neither option is specified, this step is skipped.
   • If the rollback option is specified, replace the candidate configuration with the previous configuration specified by the value of the rollback option.
   • If the load option is specified, load new configuration data.
   • The value of the load option defines the type of load which is performed.
   • The source of the new configuration data is one of the following:
     • src - A file path on the local Ansible control machine.
     • lines - A list of strings containing the configuration data.
     • template - A file path to a Jinja2 template on the local Ansible control machine. This template is rendered with the variables specified by the vars option. If the template option is specified, the vars option must also be specified.
     • url - A URL reachable from the target Junos device.
   • If the format option is specified, the configuration file being loaded is in the specified format, rather than the format determined from the file name.
3. Check the validity of the candidate configuration database.
   • If the check option is true, the default, check the validity of the configuration by performing a “commit check” operation.
   • This option may be specified with diff false and commit false to confirm a previous “commit confirmed <min>” operation without actually performing an additional commit.
   • If the configuration check fails, further processing stops, the module fails, and an error is reported.
4. Determine differences between the candidate and committed configuration databases.
   • If step 2 was not skipped, and the diff option is true, the default, perform a diff between the candidate and committed configuration databases.
   • If the diffs_file or dest_dir option is specified, save the generated configuration differences.
   • If the return_output option is true, the default, include the generated configuration difference in the diff and diff_lines keys of the module’s response.
5. Retrieve the configuration database from the Junos device.
   • If the retrieve option is specified, retrieve the configuration database specified by the retrieve value from the target Junos device to the local Ansible control machine.
   • The format in which the configuration is retrieved is specified by the value of the format option.
   • The optional filter controls which portions of the configuration are retrieved.
   • If options are specified, they control the content of the configuration retrieved.
   • If the dest or dest_dir option is specified, save the retrieved configuration to a file on the local Ansible control machine.
   • If the return_output option is true, the default, include the retrieved configuration in the config, config_lines, and config_parsed keys of the module’s response.
6. Commit the configuration changes.
   • If the commit option is true, the default, commit the configuration changes.
   • This option may be specified with diff false and check false to confirm a previous “commit confirmed <min>” operation.
   • If the comment option is specified, add the comment to the commit.
   • If the confirmed option is specified, perform a commit confirmed min operation where min is the value of the confirmed option.
   • If the check option is true and the check_commit_wait option is specified, wait check_commit_wait seconds before performing the commit.
7. Close the candidate configuration database.
   • Close and discard the candidate configuration database.
   • If the config_mode option has a value of exclusive, the default, unlock the candidate configuration database.

Requirements¶

The following software packages must be installed on hosts that execute this module:

• junos-eznc >= 2.1.7
• Python >= 2.7

Module-specific Options¶

The following options may be specified for this module:

Common Connection-related Options¶

In addition to the Module-specific Options, the following connection-related options are also supported by this module:

Common Logging-related Options¶

In addition to the Module-specific Options, the following logging-related options are also supported by this module:

Examples¶

---
- name: Manipulate the configuration of Junos devices
  hosts: junos-all
  connection: local
  gather_facts: no
  roles:
    - Juniper.junos
  tasks:
    - name: Retrieve the committed configuration
      juniper_junos_config:
        retrieve: 'committed'
        diff: false
        check: false
        commit: false
      register: response
    - name: Print the lines in the config.
      debug:
        var: response.config_lines

    - name: Append .foo to the hostname using private config mode.
      juniper_junos_config:
        config_mode: 'private'
        load: 'merge'
        lines:
          - "set system host-name {{ inventory_hostname }}.foo"
      register: response
    - name: Print the config changes.
      debug:
        var: response.diff_lines

    - name: Rollback to the previous config.
      juniper_junos_config:
        config_mode: 'private'
        rollback: 1
      register: response
    - name: Print the config changes.
      debug:
        var: response.diff_lines

    - name: Rollback to the rescue config.
      juniper_junos_config:
        rollback: 'rescue'
      register: response
    - name: Print the complete response.
      debug:
        var: response

    - name: Load override from a file.
      juniper_junos_config:
        load: 'override'
        src: "{{ inventory_hostname }}.conf"
      register: response
    - name: Print the complete response.
      debug:
        var: response

    - name: Load from a Jinja2 template.
      juniper_junos_config:
        load: 'merge'
        format: 'xml'
        template: "{{ inventory_hostname }}.j2"
        vars:
          host: "{{ inventory_hostname }}"
      register: response
    - name: Print the complete response.
      debug:
        var: response

    - name: Load from a file on the Junos device.
      juniper_junos_config:
        load: 'merge'
        url: "{{ inventory_hostname }}.conf"
      register: response
    - name: Print the complete response.
      debug:
        var: response

    - name: Load from a file on the Junos device, skip the commit check
      juniper_junos_config:
        load: 'merge'
        url: "{{ inventory_hostname }}.conf"
        check: false
      register: response
    - name: Print the msg.
      debug:
        var: response.msg

    - name: Print diff between current and rollback 10. No check. No commit.
      juniper_junos_config:
        rollback: 11
        diff: true
        check: false
        commit: false
      register: response
    - name: Print the msg.
      debug:
        var: response

    - name: Retrieve [edit system services] of current committed config.
      juniper_junos_config:
        retrieve: 'committed'
        filter: 'system/services'
        diff: true
        check: false
        commit: false
      register: response
    - name: Print the resulting config lines.
      debug:
        var: response.config_lines

    - name: Enable NETCONF SSH and traceoptions, save config, and diffs.
      juniper_junos_config:
        load: 'merge'
        lines:
          - 'set system services netconf ssh'
          - 'set system services netconf traceoptions flag all'
          - 'set system services netconf traceoptions file netconf.log'
        format: 'set'
        retrieve: 'candidate'
        filter: 'system/services'
        comment: 'Enable NETCONF with traceoptions'
        dest_dir: './output'
      register: response
    - name: Print the complete response
      debug:
        var: response

    - name: Load conf. Confirm within 5 min. Wait 3 secs between chk and commit
      juniper_junos_config:
        load: 'merge'
        url: "{{ inventory_hostname }}.conf"
        confirm: 5
        check_commit_wait: 3
      register: response
    - name: Print the complete response
      debug:
        var: response
    - name: Confirm the previous commit with a commit check (but no commit)
      juniper_junos_config:
        check: true
        diff: false
        commit: false
      register: response
    - name: Print the complete response
      debug:
        var: response

Return Values¶

Notes¶