sophos.sophos_firewall.sfos_ip_hostgroup module – Manage IP Hostgroup (System > Hosts & services > IP host group)

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

New in sophos.sophos_firewall 1.0.0

Synopsis

• Creates, updates or removes an IP Host Group (System > Hosts & services > IP host group) 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
action string	Indicates whether to add or remove hosts from the list, or replace the list entirely. Choices: "add" "remove" "replace"
description string	Description to be included on the IP Host Group object.
host_list list / elements=string	List of IP Host objects to be included in the IP Hostgroup
name string / required	Name of the IP Host Group 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 IP Host Group
  sophos.sophos_firewall.sfos_ip_hostgroup:
    name: TESTHOSTGROUP
    state: query

- name: Create IP Host Group
  sophos.sophos_firewall.sfos_ip_hostgroup:
    name: TESTHOSTGROUP
    description: Test Host Group
    host_list:
      - TESTHOST1
      - TESTHOST2
    state: present

- name: Add Hosts to IP Host Group
  sophos.sophos_firewall.sfos_ip_hostgroup:
    name: TESTHOSTGROUP
    description: Test Host Group
    host_list:
      - TESTHOST3
      - TESTHOST4
    action: add
    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.