| source: | fortios_emailfilter_block_allow_list.py |
|---|---|
| orphan: |
fortios_emailfilter_block_allow_list -- Configure anti-spam block/allow list in Fortinet's FortiOS and FortiGate.
.. versionadded:: 2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify emailfilter feature and block_allow_list category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
| Supported Version Ranges | |
| fortios_emailfilter_block_allow_list | v7.0.0 -> latest |
- 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_block_allow_list - Configure anti-spam block/allow list. type: dict
more...
Supported Version Ranges emailfilter_block_allow_list v7.0.0 -> latest - comment - Optional comments. type: str
more...
Supported Version Ranges comment v7.0.0 -> latest - entries - Anti-spam block/allow entries. type: list member_path: entries:id
more...
Supported Version Ranges entries v7.0.0 -> latest - action - Reject, mark as spam or good email. type: str choices: reject, spam, clear
more...
Supported Version Ranges action v7.0.0 -> latest[reject] v6.0.0 -> latest[spam] v6.0.0 -> latest[clear] v6.0.0 -> latest - addr_type - IP address type. type: str choices: ipv4, ipv6
more...
Supported Version Ranges addr_type v7.0.0 -> latest[ipv4] v6.0.0 -> latest[ipv6] v6.0.0 -> latest - email_pattern - Email address pattern. type: str
more...
Supported Version Ranges email_pattern v7.0.0 -> v7.0.12 - id - Entry ID. see Notes. type: int required: true
more...
Supported Version Ranges id v7.0.0 -> latest - ip4_subnet - IPv4 network address/subnet mask bits. type: str
more...
Supported Version Ranges ip4_subnet v7.0.0 -> latest - ip6_subnet - IPv6 network address/subnet mask bits. type: str
more...
Supported Version Ranges ip6_subnet v7.0.0 -> latest - pattern - Pattern to match. type: str
more...
Supported Version Ranges pattern v7.2.0 -> latest - pattern_type - Wildcard pattern or regular expression. type: str choices: wildcard, regexp
more...
Supported Version Ranges pattern_type v7.0.0 -> latest[wildcard] v6.0.0 -> latest[regexp] v6.0.0 -> latest - status - Enable/disable status. type: str choices: enable, disable
more...
Supported Version Ranges status v7.0.0 -> latest[enable] v6.0.0 -> latest[disable] v6.0.0 -> latest - type - Entry type. type: str choices: ip, email-to, email-from, subject, email
more...
Supported Version Ranges type v7.0.0 -> latest[ip] v6.0.0 -> latest[email-to] v7.2.0 -> latest[email-from] v7.2.0 -> latest[subject] v7.2.0 -> latest[email] v7.0.0 -> v7.0.12 - id - ID. see Notes. type: int required: true
more...
Supported Version Ranges id v7.0.0 -> latest - name - Name of table. type: str
more...
Supported Version Ranges name v7.0.0 -> latest
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
- name: Configure anti-spam block/allow list.
fortinet.fortios.fortios_emailfilter_block_allow_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
emailfilter_block_allow_list:
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: "<your_own_value>"
pattern_type: "wildcard"
status: "enable"
type: "ip"
id: "15"
name: "default_name_16"
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
- This module is not guaranteed to have a backwards compatible interface.
- 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.