Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
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
Parameter | Choices/Defaults | Comments | |||
---|---|---|---|---|---|
adom string / required | the parameter (adom) in requested url | ||||
bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |||
dnsfilter_profile dictionary | the top level parameters set | ||||
block-action string |
| Action to take for blocked domains. | |||
block-botnet string |
| Enable/disable blocking botnet C&C DNS lookups. | |||
comment string | Comment. | ||||
dns-translation list / elements=string | no description | ||||
addr-type string |
| DNS translation type (IPv4 or IPv6). | |||
dst string | IPv4 address or subnet on the external network to substitute for the resolved address in DNS query replies. Can be sin... | ||||
dst6 string | IPv6 address or subnet on the external network to substitute for the resolved address in DNS query replies. Can be sin... | ||||
id integer | ID. | ||||
netmask string | If src and dst are subnets rather than single IP addresses, enter the netmask for both src and dst. | ||||
prefix integer | If src6 and dst6 are subnets rather than single IP addresses, enter the prefix for both src6 and dst6 (1 - 128, defaul... | ||||
src string | IPv4 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resol... | ||||
src6 string | IPv6 address or subnet on the internal network to compare with the resolved address in DNS query replies. If the resol... | ||||
status string |
| Enable/disable this DNS translation entry. | |||
domain-filter dictionary | no description | ||||
domain-filter-table integer | DNS domain filter table ID. | ||||
external-ip-blocklist string | One or more external IP block lists. | ||||
ftgd-dns dictionary | no description | ||||
filters list / elements=string | no description | ||||
action string |
| Action to take for DNS requests matching the category. | |||
category string | Category number. | ||||
id integer | ID number. | ||||
log string |
| Enable/disable DNS filter logging for this DNS profile. | |||
options list / elements=string |
| no description | |||
log-all-domain string |
| Enable/disable logging of all domains visited (detailed DNS logging). | |||
name string | Profile name. | ||||
redirect-portal string | IP address of the SDNS redirect portal. | ||||
redirect-portal6 string | IPv6 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. | |||
youtube-restrict string |
| Set safe search for YouTube restriction level. | |||
enable_log boolean |
| Enable/Disable logging for task | |||
proposed_method string |
| The overridden method for the underlying Json RPC request | |||
rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | ||||
rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | ||||
state string / required |
| the directive to create, update or delete an object | |||
workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | ||||
workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock |
Note
- hosts: fortimanager-inventory 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 workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> state: <value in [present, absent]> dnsfilter_profile: block-action: <value in [block, redirect]> block-botnet: <value in [disable, enable]> comment: <value of string> external-ip-blocklist: <value of string> log-all-domain: <value in [disable, enable]> name: <value of string> redirect-portal: <value of string> safe-search: <value in [disable, enable]> sdns-domain-log: <value in [disable, enable]> sdns-ftgd-err-log: <value in [disable, enable]> youtube-restrict: <value in [strict, moderate]> dns-translation: - dst: <value of string> id: <value of integer> netmask: <value of string> src: <value of string> status: <value in [disable, enable]> addr-type: <value in [ipv4, ipv6]> dst6: <value of string> prefix: <value of integer> src6: <value of string> redirect-portal6: <value of string> domain-filter: domain-filter-table: <value of integer> ftgd-dns: filters: - action: <value in [monitor, block]> category: <value of string> id: <value of integer> log: <value in [disable, enable]> options: - error-allow - ftgd-disable
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
request_url string | always | The full url requested Sample: /sys/login/user |
response_code integer | always | The status of api request |
response_message string | always | The descriptive message of the api response Sample: OK. |
© 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/fortimanager/fmgr_dnsfilter_profile_module.html