Last updated on: 2024-01-16 03:25:50.

f5os_config_backup – Manage F5OS config backups.

New in version 1.2.0.

Synopsis

  • Create, remove, and import F5OS system backups.

Parameters

Parameter Choices/Defaults Configuration Comments
force
boolean
    Choices:
  • no ←
  • yes
If true, then the backup file is overridden (if it exists).
Use this option to overwrite config backup files that exist on the device.
name
string / required
Name of the config backup file.
protocol
string
    Choices:
  • https ←
  • scp
  • sftp
Protocol for config backup file transfer.
Configuring SFTP or SCP might require adding the target device to known hosts on the F5OS device, otherwise there is a chance transfer will fail due to connection error.
remote_host
string
The hostname or IP address of the remote server used for storing the config backup file.
Make the server accessible using the specified protocol.
remote_password
string
User password for the remote server used for exporting the created config backup file.
remote_path
path
The path on the remote server used for uploading the created config backup file.
remote_port
integer
The port on the remote host to which you want to connect.
If the port is not provided, a default port for the selected protocol is used.
remote_user
string
User name for the remote server used for exporting the created config backup file.
state
string
    Choices:
  • present ←
  • absent
If present, this option creates a config backup file and uploads it to the specified remote host.
If absent, this option deletes the config backup on the device (if it exists).
timeout
integer
Default:
300
The number of seconds to wait for config backup file import to finish.
The accepted value range is between 150 and 3600 seconds.

Examples

- name: Create backup config and import it to remote server
  f5os_config_backup:
    name: foo
    remote_host: builds.mydomain.com
    remote_path: /uploads/upload.php
    timeout: 300
    state: present

- name: Recreate existing backup file and upload it to remote server
  f5os_config_backup:
    name: foo
    remote_host: builds.mydomain.com
    remote_path: /uploads/upload.php
    timeout: 300
    force: true
    state: present

- name: Remove backup file
  f5os_config_backup:
    name: foo
    state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
message
dictionary
changed
Informative message of the file backup status.

Sample:
Backup success
remote_host
string
changed
The hostname or IP address of the remote server.

remote_path
string
changed
The path on the remote server used for uploading the config backup file.

remote_port
integer
changed
The port on the remote host to which you want to connect.



Status

Authors

  • Wojciech Wypior (@wojtek0806)