f5networks.f5os.f5os_config_backup (1.7.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5os:==1.7.0

Add to requirements.yml

  collections:
    - name: f5networks.f5os
      version: 1.7.0

Description

Create, remove, and import F5OS system backups.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
name:
    description:
    - Name of the config backup file.
    required: true
    type: str

force:
    default: false
    description:
    - If C(true), then the backup file is overridden (if it exists).
    - Use this option to overwrite config backup files that exist on the device.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - If C(present), this option creates a config backup file and uploads it to the specified
      remote host.
    - If C(absent), this option deletes the config backup on the device (if it exists).
    type: str

timeout:
    default: 300
    description:
    - The number of seconds to wait for config backup file import to finish.
    - The accepted value range is between C(150) and C(3600) seconds.
    type: int

protocol:
    choices:
    - https
    - scp
    - sftp
    default: https
    description:
    - 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.
    type: str

remote_host:
    description:
    - The hostname or IP address of the remote server used for storing the config backup
      file.
    - Make the server accessible using the specified C(protocol).
    type: str

remote_path:
    description:
    - The path on the remote server used for uploading the created config backup file.
    type: path

remote_port:
    description:
    - The port on the remote host to which you want to connect.
    - If the port is not provided, a default port for the selected C(protocol) is used.
    type: int

remote_user:
    description:
    - User name for the remote server used for exporting the created config backup file.
    type: str

remote_password:
    description:
    - User password for the remote server used for exporting the created config backup
      file.
    type: str

Outputs

message:
  description: Informative message of the file backup status.
  returned: changed
  sample: Backup success
  type: dict
remote_host:
  description: The hostname or IP address of the remote server.
  example: foo.bar.baz.net
  returned: changed
  type: str
remote_path:
  description: The path on the remote server used for uploading the config backup
    file.
  example: /upload/upload.php
  returned: changed
  type: str
remote_port:
  description: The port on the remote host to which you want to connect.
  example: 443
  returned: changed
  type: int