fortinet.fortimanager.fmgr_dnsfilter_profile module – Configure DNS domain filter profiles.
Note
This module is part of the fortinet.fortimanager collection (version 2.1.5).
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.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_dnsfilter_profile
.
New in version 2.10: of fortinet.fortimanager
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
the parameter (adom) in requested url |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices:
|
|
the top level parameters set |
|
Action to take for blocked domains. Choices:
|
|
Enable/disable blocking botnet C&C DNS lookups. Choices:
|
|
Comment. |
|
Dns-Translation. |
|
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 sin… |
|
IPv6 address or subnet on the external network to substitute for the resolved address in DNS query replies. Can be sin… |
|
ID. |
|
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, defaul… |
|
IPv4 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resol… |
|
IPv6 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resol… |
|
Enable/disable this DNS translation entry. Choices:
|
|
no description |
|
DNS domain filter table ID. |
|
One or more external IP block lists. |
|
no description |
|
Filters. |
|
Action to take for DNS requests matching the category. Choices:
|
|
Category number. |
|
ID number. |
|
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. |
|
IP address of the SDNS redirect portal. |
|
IPv6 address of the SDNS redirect portal. |
|
Enable/disable Google, Bing, and YouTube safe search. Choices:
|
|
Enable/disable domain filtering and botnet domain logging. Choices:
|
|
Enable/disable FortiGuard SDNS rating error logging. Choices:
|
|
Set safe search for YouTube restriction level. Choices:
|
|
Enable/Disable logging for task Choices:
|
|
The overridden method for the underlying Json RPC request Choices:
|
|
the rc codes list with which the conditions to fail will be overriden |
|
the rc codes list with which the conditions to succeed will be overriden |
|
the directive to create, update or delete an object Choices:
|
|
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
|
the maximum time in seconds to wait for other user to release the workspace lock Default: 300 |
Notes
Note
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- hosts: fortimanager00
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure DNS domain filter profiles.
fmgr_dnsfilter_profile:
bypass_validation: False
adom: ansible
state: present
dnsfilter_profile:
block-action: redirect
block-botnet: disable
comment: 'ansible-test-comment'
log-all-domain: disable
name: 'ansible-test'
- name: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the profiles
fmgr_fact:
facts:
selector: 'dnsfilter_profile'
params:
adom: 'ansible'
profile: ''
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
The descriptive message of the api response Returned: always Sample: “OK.” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)