sophos.sophos_firewall.sfos_firewall_rule module – Manage Firewall Rules (Protect > Rules & policies)

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

New in sophos.sophos_firewall 1.0.0

Synopsis

  • Creates, updates or removes firewall rules (Protect > Rules & policies) 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 / required

The rule action.

Choices:

  • "accept"

  • "drop"

  • "reject"

after_rulename

string

Name of the rule to insert this rule after.

before_rulename

string

Name of the rule to insert this rule before.

description

string / required

Rule description.

dst_networks

list / elements=string

Destination network(s).

dst_zones

list / elements=string / required

Destination zone(s).

log

string / required

Enable or disable logging.

Choices:

  • "enable"

  • "disable"

name

string / required

Name of the firewall rule to create, update, or delete

position

string

Indicates where the rule should be inserted.

Choices:

  • "top"

  • "bottom" ← (default)

  • "after"

  • "before"

service_list

list / elements=string

Name of service(s).

src_networks

list / elements=string / required

Source network(s).

src_zones

list / elements=string / required

Source zone(s).

state

string / required

Use query to retrieve, present to create, absent to remove, or updated to modify

Choices:

  • "present"

  • "absent"

  • "updated"

  • "query"

status

string

Enabled or Disabled state of the rule

Choices:

  • "enable"

  • "disable"

Examples

- name: Create Firewall Rule
  sophos.sophos_firewall.sfos_firewall_rule:
    name: TEST RULE 100
    after_rulename: TEST RULE 99
    action: accept
    description: Test rule created by Ansible
    log: enable
    status: enable
    position: bottom
    src_zones:
      - LAN
    dst_zones:
      - WAN
    src_networks:
      - SRCNET1
      - SRCNET2
    dst_networks:
      - DSTNET1
      - DSTNET2
    service_list:
      - HTTPS
      - SSH
    state: present

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)