fmgr_dnsfilter_profile – Configure DNS domain filter profiles.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [add, get, set, update] the following FortiManager json-rpc urls.
- /pm/config/adom/{adom}/obj/dnsfilter/profile
- /pm/config/global/obj/dnsfilter/profile
- 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.10.0
Parameters¶
- loose_validation - Do parameter validation in a loose way 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 dom
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- url_params - parameters in url path type: dict required: true
- adom - the domain prefix type: str choices: none, global, custom dom
- parameters for method: [add, set, update] - Configure DNS domain filter profiles.
- data - No description for the parameter type: array
- 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]
- parameters for method: [get] - Configure DNS domain filter profiles.
- attr - The name of the attribute to retrieve its datasource. type: str
- fields - No description for the parameter type: array
- {no-name} - No description for the parameter type: array
- {no-name} - No description for the parameter type: str choices: [block-action, block-botnet, comment, external-ip-blocklist, log-all-domain, name, redirect-portal, safe-search, sdns-domain-log, sdns-ftgd-err-log, youtube-restrict]
- {no-name} - No description for the parameter type: array
- filter - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- get used - No description for the parameter type: int
- loadsub - Enable or disable the return of any sub-objects. type: int
- option - Set fetch option for the request. type: str choices: [count, object member, datasrc, get reserved, syntax]
- range - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
- sortings - No description for the parameter type: array
- {attr_name} - No description for the parameter type: int choices: [1, -1]
Notes¶
Note
- The module may supports multiple method, every method has different parameters definition
- One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
- The module may include domain dependent urls, the domain can be specified in url_params as adom
- To run in workspace mode, the paremeter workspace_locking_adom must be included in the task
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: REQUESTING /PM/CONFIG/OBJ/DNSFILTER/PROFILE
fmgr_dnsfilter_profile:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [add, set, update]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
data:
-
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]>
- name: REQUESTING /PM/CONFIG/OBJ/DNSFILTER/PROFILE
fmgr_dnsfilter_profile:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
attr: <value of string>
fields:
-
- <value in [block-action, block-botnet, comment, ...]>
filter:
- <value of string>
get used: <value of integer>
loadsub: <value of integer>
option: <value in [count, object member, datasrc, ...]>
range:
- <value of integer>
sortings:
-
varidic.attr_name: <value in [1, -1]>
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:
- return values for method: [add, set, update]
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/obj/dnsfilter/profile
- return values for method: [get]
- data
- No description for the parameter type: array
- block-action - Action to take for blocked domains. type: str
- block-botnet - Enable/disable blocking botnet C&C DNS lookups. type: str
- 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
- 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
- sdns-domain-log - Enable/disable domain filtering and botnet domain logging. type: str
- sdns-ftgd-err-log - Enable/disable FortiGuard SDNS rating error logging. type: str
- youtube-restrict - Set safe search for YouTube restriction level. type: str
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/obj/dnsfilter/profile