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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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 - Configure DNS domain filter profiles. type: dict
- block-action - Action to take for blocked domains. type: str choices: [block, redirect]
- block-botnet - Enable/disable blocking botnet C&C DNS lookups. type: str choices: [disable, enable]
- comment - Comment. type: str
- external-ip-blocklist - One or more external IP block lists. type: str
- log-all-domain - Enable/disable logging of all domains visited (detailed DNS logging). type: str choices: [disable, enable]
- name - Profile name. type: str
- redirect-portal - IP address of the SDNS redirect portal. type: str
- safe-search - Enable/disable Google, Bing, and YouTube safe search. type: str choices: [disable, enable]
- sdns-domain-log - Enable/disable domain filtering and botnet domain logging. type: str choices: [disable, enable]
- sdns-ftgd-err-log - Enable/disable FortiGuard SDNS rating error logging. type: str choices: [disable, enable]
- youtube-restrict - Set safe search for YouTube restriction level. type: str choices: [strict, moderate]
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: 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]>
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