sophos.sophos_firewall.sfos_time module – Manage Date and Time settings (System > Administration > Time)

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_time.

New in sophos.sophos_firewall 1.0.0

Synopsis

• Manage Date and Time settings (System > Administration > Time) 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 dictionary	Date settings
day integer	Day
month integer	Month
year integer	Year
state string / required	Use query to retrieve or updated to modify Choices: "updated" "query"
time dictionary	Time settings
hour integer	Hour
minute integer	Minute
second integer	Second
timezone string	Timezone setting. WARNING: WILL CAUSE DEVICE REBOOT!

Examples

- name: Update Time Settings
  sophos.sophos_firewall.sfos_time:e
    timezone: Europe/London
    date:
      year: 2024
      month: 9
      day: 26
    time:
      hour: 10
      minute: 28
      second: 59
    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)

Collection links

• Issue Tracker
• Repository (Sources)

Warning

If the firewall is a member of a group in Central, the changes made by Ansible will override the settings of the group. The actual configuration on the firewall may then differ from what is displayed for the same setting in the Central group.