Skip to content

Latest commit

 

History

History
663 lines (617 loc) · 23.5 KB

fortios_emailfilter_bwl.rst

File metadata and controls

663 lines (617 loc) · 23.5 KB
Raw
source:fortios_emailfilter_bwl.py
orphan:

fortios_emailfilter_bwl -- Configure anti-spam black/white list in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify emailfilter feature and bwl category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.9

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
fortios_emailfilter_bwl yes yes yes yes yes yes yes

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • emailfilter_bwl - Configure anti-spam black/white list. type: dict more...
    v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
    emailfilter_bwl yes yes yes yes yes yes yes
    • comment - Optional comments. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
      comment yes yes yes yes yes yes yes
    • entries - Anti-spam black/white list entries. type: list member_path: entries:id more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
      entries yes yes yes yes yes yes yes
      • action - Reject, mark as spam or good email. type: str choices: reject, spam, clear more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
        action yes yes yes yes yes yes yes
        [reject] yes yes yes yes yes yes yes
        [spam] yes yes yes yes yes yes yes
        [clear] yes yes yes yes yes yes yes
      • addr_type - IP address type. type: str choices: ipv4, ipv6 more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
        addr_type yes yes yes yes yes yes yes
        [ipv4] yes yes yes yes yes yes yes
        [ipv6] yes yes yes yes yes yes yes
      • email_pattern - Email address pattern. type: str more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
        email_pattern yes yes yes yes yes yes yes
      • id - Entry ID. see Notes. type: int required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
        id yes yes yes yes yes yes yes
      • ip4_subnet - IPv4 network address/subnet mask bits. type: str more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
        ip4_subnet yes yes yes yes yes yes yes
      • ip6_subnet - IPv6 network address/subnet mask bits. type: str more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
        ip6_subnet yes yes yes yes yes yes yes
      • pattern_type - Wildcard pattern or regular expression. type: str choices: wildcard, regexp more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
        pattern_type yes yes yes yes yes yes yes
        [wildcard] yes yes yes yes yes yes yes
        [regexp] yes yes yes yes yes yes yes
      • status - Enable/disable status. type: str choices: enable, disable more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
        status yes yes yes yes yes yes yes
        [enable] yes yes yes yes yes yes yes
        [disable] yes yes yes yes yes yes yes
      • type - Entry type. type: str choices: ip, email more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
        type yes yes yes yes yes yes yes
        [ip] yes yes yes yes yes yes yes
        [email] yes yes yes yes yes yes yes
    • id - ID. see Notes. type: int required: true more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
      id yes yes yes yes yes yes yes
    • name - Name of table. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4
      name yes yes yes yes yes yes yes

Notes

Note

  • We highly recommend using your own value as the id instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure anti-spam black/white list.
    fortios_emailfilter_bwl:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      emailfilter_bwl:
        comment: "Optional comments."
        entries:
         -
            action: "reject"
            addr_type: "ipv4"
            email_pattern: "<your_own_value>"
            id:  "8"
            ip4_subnet: "<your_own_value>"
            ip6_subnet: "<your_own_value>"
            pattern_type: "wildcard"
            status: "enable"
            type: "ip"
        id:  "14"
        name: "default_name_15"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.