f5devcentral / ansible-role-backup_config

Ansible role for backup of running configurations from F5 devices

Ansible Role: Backup Config

Role to collect the current device configurations and store it on the Ansible controller with a user specific backup filename and path.

Requirements

None.

Role Variables

Available variables are listed below. For their default values, see defaults/main.yml:

provider_server: localhost
provider_server_port: 443
provider_user: admin
provider_password: secret
provider_validate_certs: no
provider_transport: rest
provider_timeout: 120

Establishes initial connection to your BIG-IQ. These values are substituted into your provider module parameter.

filename

Specifies the filename to store configurations. Since this role backs up multiple files, the multiple files created will be named the value specified here, however the extensions will differ for the backed up files. For example, if filename is "backup", this role will create backup.qkview and backup.ucs.

path

Absolute or relative path of folder where config will be stored.

backup

Boolean flag to indicate if we need to backup configurations before overwriting it with new configurations.

Dependencies

None.

Example Playbook

- name: Backup config
  hosts: bigip
  vars:
    backup_config:
      filename: "config_{{ ansible_host }}"
      path: "~/network_configs_1/"
      backup: yes
  roles:
    - { role: f5devcentral.backup_config }

License

Apache

Author Information

This role was created in 2018 by Tim Rupp, with the help of Forrest Crenshaw.

ansible-role-backup_config's Issues

Getting this to work

I tried to get this to work with my playbook below

---
- name: Fetch a backup from the remote device
  hosts: F5
  roles:
   - { role: f5devcentral.backup_config }
  tasks:
  - name: Backup
    backup_config:
      backup: yes
      path: "~/F5/"
      filename: "config_{{ inventory_hostname }}"
      provider:
        server: "{{ inventory_hostname }}"
        server_port: 443
        user: ansible
        password: ansible
        validate_certs: no
    delegate_to: localhost

But it fails with:
ERROR! couldn't resolve module/action 'backup_config'. This often indicates a misspelling, missing collection, or incorrect module path.

I installed the module with:
ansible-galaxy install f5devcentral.backup_config

So I must be missing out on how to refer to the installed code. And it may be bause I am relative new to ansible and am still trying to get my head around the whole concept. So things I understand but other just don't connect in my head regardless of how many times I read the ansible documentation.