david_igou.routeros_configuration.reset role – Reset RouterOS configuration (gated, destructive).

Note

This role is part of the david_igou.routeros_configuration collection (version 0.0.8-alpha).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install david_igou.routeros_configuration.

To use it in a playbook, specify: david_igou.routeros_configuration.reset.

Entry point main – Reset RouterOS configuration (gated, destructive).

Synopsis

  • Runs /system reset-configuration only when routeros_reset_confirm is true. Wipes the configuration and reboots.

Parameters

Parameter

Comments

routeros_api_hostname

string

API hostname/IP of the device.

Default: "{{ inventory_hostname }}"

routeros_api_password

string

API password. Secret — supply via vault.

routeros_api_port

any

TCP port; empty lets the module choose from tls.

Default: ""

routeros_api_tls

boolean

Use TLS (api-ssl).

Choices:

  • false

  • true ← (default)

routeros_api_username

string

API username.

Default: "admin"

routeros_api_validate_certs

boolean

Validate the device TLS certificate.

Choices:

  • false

  • true ← (default)

routeros_reset_confirm

boolean

Must be true to actually reset. Safety gate.

Choices:

  • false ← (default)

  • true

routeros_reset_keep_users

boolean

Keep users/passwords across the reset.

Choices:

  • false

  • true ← (default)

routeros_reset_no_defaults

boolean

Skip the default configuration after reset.

Choices:

  • false ← (default)

  • true

routeros_reset_reboot_timeout

integer

Seconds to wait for the API after the reset reboot.

Default: 300

routeros_reset_run_after_reset

string

Script to run after reset (e.g. re-enable the API).

Default: ""

Examples

# Destructive: a confirmed run wipes the configuration and reboots. The
# routeros_reset_confirm gate defaults to false as a safeguard.
#
# Safe by default (gate off) — a no-op you can leave in a playbook.
- hosts: routers
  gather_facts: false
  roles:
    - role: david_igou.routeros_configuration.reset

# Reset but keep users, and re-enable the API afterward so Ansible can
# reconnect.
- hosts: routers
  gather_facts: false
  roles:
    - role: david_igou.routeros_configuration.reset
      vars:
        routeros_reset_confirm: true
        routeros_reset_keep_users: true
        routeros_reset_run_after_reset: "/ip service enable api-ssl"

# Reset to a bare configuration (skip RouterOS' default config).
- hosts: routers
  gather_facts: false
  roles:
    - role: david_igou.routeros_configuration.reset
      vars:
        routeros_reset_confirm: true
        routeros_reset_no_defaults: true