fortinet.fortios.fortios_dnsfilter_profile module – Configure DNS domain filter profile in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_dnsfilter_profile
.
New in fortinet.fortios 2.0.0
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.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Configure DNS domain filter profile. |
|
Action to take for blocked domains. Choices:
|
|
Enable/disable blocking botnet C&C DNS lookups. Choices:
|
|
Comment. |
|
DNS translation settings. |
|
DNS translation type (IPv4 or IPv6). Choices:
|
|
IPv4 address or subnet on the external network to substitute for the resolved address in DNS query replies. Can be single IP address or subnet on the external network, but number of addresses must equal number of mapped IP addresses in src. |
|
IPv6 address or subnet on the external network to substitute for the resolved address in DNS query replies. Can be single IP address or subnet on the external network, but number of addresses must equal number of mapped IP addresses in src6. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
If src and dst are subnets rather than single IP addresses, enter the netmask for both src and dst. |
|
If src6 and dst6 are subnets rather than single IP addresses, enter the prefix for both src6 and dst6 (1 - 128). |
|
IPv4 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resolved address matches, the resolved address is substituted with dst. |
|
IPv6 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resolved address matches, the resolved address is substituted with dst6. |
|
Enable/disable this DNS translation entry. Choices:
|
|
Domain filter settings. |
|
DNS domain filter table ID. Source dnsfilter.domain-filter.id. |
|
One or more external IP block lists. |
|
External domain block list name. Source system.external-resource.name. |
|
FortiGuard DNS Filter settings. |
|
FortiGuard DNS domain filters. |
|
Action to take for DNS requests matching the category. Choices:
|
|
Category number. |
|
ID number. see <a href=’#notes’>Notes</a>. |
|
Enable/disable DNS filter logging for this DNS profile. Choices:
|
|
FortiGuard DNS filter options. Choices:
|
|
Enable/disable logging of all domains visited (detailed DNS logging). Choices:
|
|
Profile name. |
|
IPv4 address of the SDNS redirect portal. |
|
IPv6 address of the SDNS redirect portal. |
|
Enable/disable Google, Bing, YouTube, Qwant, DuckDuckGo safe search. Choices:
|
|
Enable/disable domain filtering and botnet domain logging. Choices:
|
|
Enable/disable FortiGuard SDNS rating error logging. Choices:
|
|
Enable/disable removal of the encrypted client hello service parameter from supporting DNS RRs. Choices:
|
|
Transparent DNS database zones. |
|
DNS database zone name. Source system.dns-database.name. |
|
Set safe search for YouTube restriction level. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure DNS domain filter profile.
fortinet.fortios.fortios_dnsfilter_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dnsfilter_profile:
block_action: "block"
block_botnet: "disable"
comment: "Comment."
dns_translation:
-
addr_type: "ipv4"
dst: "<your_own_value>"
dst6: "<your_own_value>"
id: "10"
netmask: "<your_own_value>"
prefix: "128"
src: "<your_own_value>"
src6: "<your_own_value>"
status: "enable"
domain_filter:
domain_filter_table: "0"
external_ip_blocklist:
-
name: "default_name_19 (source system.external-resource.name)"
ftgd_dns:
filters:
-
action: "block"
category: "0"
id: "24"
log: "enable"
options: "error-allow"
log_all_domain: "enable"
name: "default_name_28"
redirect_portal: "<your_own_value>"
redirect_portal6: "<your_own_value>"
safe_search: "disable"
sdns_domain_log: "enable"
sdns_ftgd_err_log: "enable"
strip_ech: "disable"
transparent_dns_database:
-
name: "default_name_36 (source system.dns-database.name)"
youtube_restrict: "strict"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |