fmgr_dnsfilter_profile – Configure DNS domain filter profiles.
Added in version 1.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
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.x and v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- dnsfilter_profile - Configure DNS domain filter profiles. type: dict
- block_action (Alias name: block-action) Action to take for blocked domains. type: str choices: [block, redirect, block-sevrfail] more...
- block_botnet (Alias name: block-botnet) Enable/disable blocking botnet c&c dns lookups. type: str choices: [disable, enable] more...
- comment Comment. type: str more...
- external_ip_blocklist (Alias name: external-ip-blocklist) One or more external ip block lists. type: list or str more...
- log_all_domain (Alias name: 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 (Alias name: redirect-portal) Ip address of the sdns redirect portal. type: str more...
- safe_search (Alias name: safe-search) Enable/disable google, bing, and youtube safe search. type: str choices: [disable, enable] more...
- sdns_domain_log (Alias name: sdns-domain-log) Enable/disable domain filtering and botnet domain logging. type: str choices: [disable, enable] more...
- sdns_ftgd_err_log (Alias name: sdns-ftgd-err-log) Enable/disable fortiguard sdns rating error logging. type: str choices: [disable, enable] more...
- youtube_restrict (Alias name: youtube-restrict) Set safe search for youtube restriction level. type: str choices: [strict, moderate] more...
- dns_translation (Alias name: dns-translation) Dns-translation. type: list
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 (Alias name: 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 (Alias name: redirect-portal6) Ipv6 address of the sdns redirect portal. type: str more...
- log_all_url (Alias name: log-all-url) Enable/disable log all urls visited. type: str choices: [disable, enable] more...
- sdns_url_log (Alias name: sdns-url-log) Enable/disable logging of url filtering and botnet domains. type: str choices: [disable, enable] more...
- domain_filter (Alias name: domain-filter) type: dict
- domain_filter_table (Alias name: domain-filter-table) Dns domain filter table id. type: int more...
- ftgd_dns (Alias name: ftgd-dns) type: dict
- urlfilter type: dict
- urlfilter_table (Alias name: urlfilter-table) Dns url filter table id. type: int more...
- transparent_dns_database (Alias name: transparent-dns-database) type: list more...
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
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure DNS domain filter profiles.
fortinet.fortimanager.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: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the profiles
fortinet.fortimanager.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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.