sophos.sophos_firewall.sfos_backup module – Manage Backup settings (System > Backup & firmware)

Note

This module is part of the sophos.sophos_firewall collection (version 2.0.1).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install sophos.sophos_firewall. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: sophos.sophos_firewall.sfos_backup.

New in sophos.sophos_firewall 1.0.0

Synopsis

  • Manage Backup settings (System > Backup & firmware) on Sophos Firewall

Requirements

The below requirements are needed on the host that executes this module.

  • sophosfirewall-python

  • Beginning in version 2.0.0, this module requires use of an httpapi connection plugin. See the HTTPAPI example for details.

Parameters

Parameter

Comments

date

integer

Day of month to be used when frequency is set to monthly

day

string

Day

Choices:

  • "Monday"

  • "Tuesday"

  • "Wednesday"

  • "Thursday"

  • "Friday"

  • "Saturday"

  • "Sunday"

email_address

string

Email address to be used when using Email mode

encryption_password

string

Encryption password for the backup file. If this argument is specified, module will always return changed.

frequency

string

Backup frequency (Never/Daily/Weekly/Monthly)

Choices:

  • "Never"

  • "Daily"

  • "Email"

ftp_password

string

FTP password. If this argument is specified, module will always return changed.

ftp_path

string

FTP directory path

ftp_server

string

IP address of FTP server (hostname not currently allowed)

ftp_username

string

FTP username

hour

integer

Hour

minute

integer

Minute

mode

string

Backup mode (Local/FTP/Email)

Choices:

  • "Local"

  • "FTP"

  • "Email"

prefix

string

Prefix for the backup file

state

string / required

Use query to retrieve or updated to modify

Choices:

  • "updated"

  • "query"

Examples

- name: Update Backup Settings
  sophos.sophos_firewall.sfos_backup:
    mode: FTP
    prefix: devfirewall
    ftp_server: 10.10.10.1
    ftp_username: ftpuser
    ftp_password: ftppassword
    ftp_path: home/backup
    frequency: Weekly
    day: Sunday
    hour: 10
    minute: 30
    encryption_password: backupencryptionpassword
    state: updated

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

api_response

dictionary

Serialized object containing the API response.

Returned: always

Authors

  • Matt Mullen (@mamullen13316)