sophos.sophos_firewall.sfos_fqdn_host module – Manage FQDN hosts (System > Hosts & services > FQDN host)

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

New in sophos.sophos_firewall 1.0.0

Synopsis

• Creates, updates or removes a FQDN host (System > Hosts & services > FQDN host) 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
description string	Description for the FQDN.
fqdn string	The FQDN string.
fqdn_group_list list / elements=string	A list of FQDN groups this FQDN host should be placed into when created. The sfos_fqdn_hostgroup module can be used to manage this post-creation.
name string / required	Name of the FQDN object to create, update, or delete
state string / required	Use query to retrieve, present to create, absent to remove, or updated to modify Choices: "present" "absent" "updated" "query"

Examples

- name: Retrieve FQDN Host
  sophos.sophos_firewall.sfos_fqdn_host:
    name: TESTFQDN
    state: query

- name: Create FQDN Host
  sophos.sophos_firewall.sfos_fqdn_host:
    name: TESTFQDN
    description: Testing FQDN creation
    fqdn: sophos.com
    state: present

- name: Add FQDN to FQDN Group
  sophos.sophos_firewall.sfos_fqdn_host:
    name: TESTFQDN
    fqdn_group_list:
      - TESTFQDNGROUP
    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.