Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
You might already have this collection installed if you are using the ansible
package. 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 fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_emailfilter_bwl
.
New in version 2.10: of fortinet.fortios
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
emailfilter_bwl dictionary | Configure anti-spam black/white list. | |||
comment string | Optional comments. | |||
entries list / elements=string | Anti-spam black/white list entries. | |||
action string |
| Reject, mark as spam or good email. | ||
addr_type string |
| IP address type. | ||
email_pattern string | Email address pattern. | |||
id integer / required | Entry ID. | |||
ip4_subnet string | IPv4 network address/subnet mask bits. | |||
ip6_subnet string | IPv6 network address/subnet mask bits. | |||
pattern_type string |
| Wildcard pattern or regular expression. | ||
status string |
| Enable/disable status. | ||
type string |
| Entry type. | ||
id integer / required | ID. | |||
name string | Name of table. | |||
enable_log boolean |
| Enable/Disable logging for task. | ||
state string / required |
| Indicates whether to create or remove the object. | ||
vdom string | Default: "root" | 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. |
Note
- 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"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_emailfilter_bwl_module.html