cm_backup_restore – Backup and restore CM configuration

New in version 1.0.0.

Synopsis

  • Backup and restore CM configuration.

Parameters

Parameter Choices/Defaults Configuration Comments
day_of_the_month_to_run
integer
Specifies From which Day of the month backup should start.
days_of_the_week_to_run
list / elements=integer
Specifies Day of the week when backup has been scheduled. 0-Sunday, 1-Monday and so on.
The accepted value range is between 0 and 6.
encryption_password
string / required
Encryption password for the backup to be created.
Password should be minimum of 8 characters.
frequency
string
    Choices:
  • Monthly
  • Weekly
  • Daily
Ensured that backup is scheduled Monthly, Weekly or Daily.
The accepted value is Monthly, Weekly, Daily.
name
string / required
The name of the backup file to be created while Scheduling a Backup.
Actual File Name is auto-generated in the case of Instant Backup.
schedule
dictionary
Specifies whether backup is to be scheduled or not.
end_at
string
Specifies End time of the backup.
start_at
string
Specifies Start time of the backup.
scheduled
boolean
    Choices:
  • no
  • yes
When True, ensures that that scheduled backup is to be delete.
When False, ensures that that Instant backup is to be delete.
Scheduled Parameter is required when state is absent.
state
string
    Choices:
  • absent
  • backup ←
  • scheduled_backup
  • restore
When backup, ensures the backup is file is created instantly.
When scheduled_backup, ensures the backup is file is scheduled.
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 operations are not idempotent.

Examples

- name: Backup Central Manager instance
  cm_backup_restore:
    encryption_password: "F5site02"
    name: Backup-20240829-101240_L_20.3.0-0.14.14_6.tgz
    schedule:
      start_at: "2019-08-24T14:15:22Z"
    frequency: Weekly
    days_of_the_week_to_run: [0, 1]
    state: scheduled_backup
    timeout: 600

- name: Restore Central Manager instance
  cm_next_backup_restore:
    encryption_password: "F5site02"
    name: Backup-20240829-101240_L_20.3.0-0.14.14_6.tgz
    state: restore
    timeout: 600

- name: Remove a Central Manager backup
  cm_next_backup_restore:
    filename: Backup-20240829-101240_L_20.3.0-0.14.14_6.tgz
    scheduled: true
    state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
day_of_the_month_to_run
integer
changed
Specifies From which Day of the month backup should start.

Sample:
15
days_of_the_week_to_run
list
changed
Specifies Day of the week when backup has been scheduled. 0-Sunday, 1-Monday and so on.

Sample:
[0, 1, 2]
encryption_password
string
changed
Encryption password for the backup to be created.

Sample:
F5site02
frequency
string
changed
Ensured that backup is scheduled Monthly, Weekly or Daily.

Sample:
Weekly
name
string
changed
The name of the backup file to be created.

Sample:
Backup-20240829
state
string
changed
Ensured whether its is a backup, scheduled backup or restore.

Sample:
backup


Status

Authors

  • Prateek Ramani (@ramani)