Use Ansible to Restore a Junos Device to the Factory-Default Configuration Settings

This example uses the following hardware and software components:

• Configuration management server running Ansible 2.18 or later with the juniper.device collection installed

• Junos device that has access to the console port through a console server and has a user account configured with appropriate permissions

• Existing Ansible inventory file with required hosts defined

This example creates an Ansible playbook that uses the juniper.device.system module to reset each host in the inventory group to its factory-default configuration settings. The value of the module’s action argument defines the operation to execute on the host. Setting action to "zeroize" executes the request system zeroize command on each host. This command removes all configuration information on the Routing Engines, resets all key values on the device, and then reboots the device and resets it to the factory-default configuration settings.

When calling the module from a playbook, we recommend that you use an interactive prompt to confirm that the user does intend to reset the devices. If a user unintentionally runs the playbook and there is no check, it could inadvertently revert devices back to factory-default configurations and disrupt any networks that require those devices. As a precaution, this playbook uses an interactive prompt to verify that the user intends to reset the devices and requires that the user manually type 'yes' on the command line in order to execute the module. If the Confirmation check task fails, the Ansible control node skips the other tasks in the play for that device.

The playbook executes the juniper.device.system module provided that the confirmation check was successful. The mode: "telnet" and port: 23 arguments instruct the module to telnet to port 23 of the console server. The  password parameter is set to the value of the password variable, which the playbook prompts for during execution. After the reboot, you must log in through the console as root in order to access the device.

• Create and Execute the Ansible Playbook
• Results

---
- name: Restore Junos devices to factory-default configuration settings
  hosts: dc1_console
  connection: local
  gather_facts: no
    
  vars_prompt:
    - name: reset_confirmation
      prompt: >
        This playbook resets hosts to factory-default configurations! 
        Enter 'yes' to continue.
      default: "no"
      private: no

    - name: "device_password"
      prompt: "Device password"
      private: yes   

  vars: 
    password: "{{ device_password }}"
    mode: "telnet"
    port: 23  

  tasks:
    - name: Confirmation check
      fail: msg="Playbook run confirmation failed"
      when: reset_confirmation != "yes"

    - name: Restore all Routing Engines to factory-default configuration
      juniper.device.system: 
        action: "zeroize"
        timeout: 120
      register: result

    - name: Print response
      ansible.builtin.debug:
        var: result

To execute the playbook:

• Issue the ansible-playbook command on the control node, and provide the playbook path and any desired options.

  content_copy zoom_out_map

  root@ansible-cn:~/ansible# ansible-playbook ansible-pb-junos-zeroize.yaml
  This playbook resets hosts to factory-default configurations!  Enter 'yes' to continue.
   [no]: yes
  Device password: 
  
  PLAY [Restore Junos devices to factory-default configuration settings] 
  
  TASK [Confirmation check] **********************************************
  skipping: [dc1a-console.example.net]
  
  TASK [Restore all Routing Engines to factory-default configuration] ****
  changed: [dc1a-console.example.net]
  
  TASK [Print response] **************************************************
  ok: [dc1a-console.example.net] => {
      "result": {
          "action": "zeroize", 
          "all_re": true, 
          "changed": true, 
          "failed": false, 
          "media": false, 
          "msg": "zeroize successfully initiated.", 
          "other_re": false, 
          "reboot": false
          "vmhost": false
      }
  }
  
  PLAY RECAP ************************************************************
  dc1a-console.example.net : ok=2    changed=1    unreachable=0    failed=0    skipped=1    rescued=0    ignored=0