fortios_dnsfilter_profile – Configure DNS domain filter profiles in Fortinet’s FortiOS and FortiGate
New in version 2.8.
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dnsfilter feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
Parameter | Choices/Defaults | Comments | |||
---|---|---|---|---|---|
dnsfilter_profile dictionary | Default: null | Configure DNS domain filter profiles. | |||
block_action string |
| Action to take for blocked domains. | |||
block_botnet string |
| Enable/disable blocking botnet C&C DNS lookups. | |||
comment string | Comment. | ||||
domain_filter dictionary | Domain filter settings. | ||||
domain_filter_table integer | DNS domain filter table ID. Source dnsfilter.domain-filter.id. | ||||
external_ip_blocklist list | One or more external IP block lists. | ||||
name string / required | External domain block list name. Source system.external-resource.name. | ||||
ftgd_dns dictionary | FortiGuard DNS Filter settings. | ||||
filters list | FortiGuard DNS domain filters. | ||||
action string |
| Action to take for DNS requests matching the category. | |||
category integer | Category number. | ||||
id integer / required | ID number. | ||||
log string |
| Enable/disable DNS filter logging for this DNS profile. | |||
options string |
| FortiGuard DNS filter options. | |||
log_all_domain string |
| Enable/disable logging of all domains visited (detailed DNS logging). | |||
name string / required | Profile name. | ||||
redirect_portal string | IP address of the SDNS redirect portal. | ||||
safe_search string |
| Enable/disable Google, Bing, and YouTube safe search. | |||
sdns_domain_log string |
| Enable/disable domain filtering and botnet domain logging. | |||
sdns_ftgd_err_log string |
| Enable/disable FortiGuard SDNS rating error logging. | |||
state string |
| Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object. | |||
youtube_restrict string |
| Set safe search for YouTube restriction level. | |||
host string | FortiOS or FortiGate IP address. | ||||
https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | |||
password string | Default: "" | FortiOS or FortiGate password. | |||
ssl_verify boolean added in 2.9 |
| Ensures FortiGate certificate must be verified by a proper CA. | |||
state string added in 2.9 |
| Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. | |||
username string | FortiOS or FortiGate username. | ||||
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. |
Notes
Note
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Configure DNS domain filter profiles. fortios_dnsfilter_profile: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" dnsfilter_profile: block_action: "block" block_botnet: "disable" comment: "Comment." domain_filter: domain_filter_table: "7 (source dnsfilter.domain-filter.id)" external_ip_blocklist: - name: "default_name_9 (source system.external-resource.name)" ftgd_dns: filters: - action: "block" category: "13" id: "14" log: "enable" options: "error-allow" log_all_domain: "enable" name: "default_name_18" redirect_portal: "<your_own_value>" safe_search: "disable" sdns_domain_log: "enable" sdns_ftgd_err_log: "enable" youtube_restrict: "strict"
Return Values
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 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_dnsfilter_profile_module.html