fmgr_dnsfilter_profile – Configure DNS domain filter profiles.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| dnsfilter_profile | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- dnsfilter_profile - no description type: dict
- block-action - Action to take for blocked domains. type: str choices: [block, redirect, block-sevrfail] more...
- block-botnet - Enable/disable blocking botnet C&C DNS lookups. type: str choices: [disable, enable] more...
- comment - Comment. type: str more...
- external-ip-blocklist - One or more external IP block lists. type: str more...
- log-all-domain - Enable/disable logging of all domains visited (detailed DNS logging). type: str choices: [disable, enable] more...
- name - Profile name. type: str more...
- redirect-portal - IP address of the SDNS redirect portal. type: str more...
- safe-search - Enable/disable Google, Bing, and YouTube safe search. type: str choices: [disable, enable] more...
- sdns-domain-log - Enable/disable domain filtering and botnet domain logging. type: str choices: [disable, enable] more...
- sdns-ftgd-err-log - Enable/disable FortiGuard SDNS rating error logging. type: str choices: [disable, enable] more...
- youtube-restrict - Set safe search for YouTube restriction level. type: str choices: [strict, moderate] more...
- dns-translation - Dns-Translation. type: array
more...
- dst - IPv4 address or subnet on the external network to substitute for the resolved address in DNS query replies. type: str more...
- id - ID. type: int more...
- netmask - If src and dst are subnets rather than single IP addresses, enter the netmask for both src and dst. type: str more...
- src - IPv4 address or subnet on the internal network to compare with the resolved address in DNS query replies. type: str more...
- status - Enable/disable this DNS translation entry. type: str choices: [disable, enable] more...
- addr-type - DNS translation type (IPv4 or IPv6). type: str choices: [ipv4, ipv6] more...
- dst6 - IPv6 address or subnet on the external network to substitute for the resolved address in DNS query replies. type: str more...
- prefix - If src6 and dst6 are subnets rather than single IP addresses, enter the prefix for both src6 and dst6 (1 - 128, default = 128). type: int more...
- src6 - IPv6 address or subnet on the internal network to compare with the resolved address in DNS query replies. type: str more...
- redirect-portal6 - IPv6 address of the SDNS redirect portal. type: str more...
- domain-filter type: dict
- domain-filter-table - DNS domain filter table ID. type: int more...
- ftgd-dns type: dict
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: 'your_value'
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict