cm_next_backup_restore – Backup and restore BIG-IP Next instance configration through CM

New in version 1.0.0.

Synopsis

  • Backup and restore BIG-IP Next instance configration through CM, manage backup files on CM.

Parameters

Parameter Choices/Defaults Configuration Comments
device_hostname
string
The hostname of the BIG-IP Next instance to back up config on.
Parameter mutually exclusive with device_ip.
The parameter is required when state is backup or restore.
device_ip
string
The ip address of the BIG-IP Next instance to back up config on.
Parameter mutually exclusive with device_hostname.
The parameter is required when state is backup or restore.
file_password
string
The encryption password for the given backup file as defined in filename.
The parameter is required when state is backup or restore.
filename
string
The name of the file to save the BIG-IP Next instance backup.
System automatically appends .tar.gz extension to filenames provided without it.
force
boolean
    Choices:
  • no ←
  • yes
When true, removes the existing backup file and creates new one on the CM.
When false, no backup is created if a file with given name exists.
state
string
    Choices:
  • absent
  • backup ←
  • restore
When backup, ensures the backup is file is created.
When restore, ensures the target BIG-IP Next instance is restored from the given backup filename.
When absent, ensures the backup file is removed.
timeout
integer
Default:
300
The amount of time in seconds to wait for the backup or restore operation to complete.
The accepted value range is between 150 and 3600 seconds.

Notes

Note

  • This module’s restore operation is not idempotent.

Examples

- name: Backup BIG-IP Next instance
  cm_next_backup_restore:
    device_ip: "127.1.1.1"
    filename: "ansible_test.tar.gz"
    file_password: "pass123!"
    state: backup
    timeout: 600

- name: Backup a file - force on
  cm_next_backup_restore:
    device_ip: "127.1.1.1"
    filename: "ansible_test.tar.gz"
    file_password: "pass123!"
    state: backup
    force: "yes"
    timeout: 600

- name: Restore BIG-IP Next instance
  cm_next_backup_restore:
    device_ip: "127.1.1.1"
    filename: "ansible_test.tar.gz"
    file_password: "pass123!"
    state: restore
    timeout: 600

- name: Remove a file
  cm_next_backup_restore:
    filename: "/path/to/file/file.json"
    state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
device_hostname
string
changed
The hostname of the BIG-IP Next instance to manage files on.

Sample:
foo.bar.net
device_ip
string
changed
The ip address of the BIG-IP Next instance to manage files on.

Sample:
192.168.1.1
filename
string
changed
The name of the file to save the BIG-IP Next instance backup.

Sample:
file.tar.gz


Status

Authors

  • Ravinder Reddy (@RavinderReddyF5)
  • Wojciech Wypior (@wojtek0806)