fmgd_dnsfilter_profile – Configure DNS domain filter profile.

Added in version 1.1.0.

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 v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> 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
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • dnsfilter_profile - Configure DNS domain filter profile. 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...
    • dns_translation (Alias name: dns-translation) Dns translation. type: list more...
      • addr_type (Alias name: addr-type) Dns translation type (ipv4 or ipv6). type: str choices: [ipv4, ipv6] more...
      • dst Ipv4 address or subnet on the external network to substitute for the resolved address in dns query replies. type: str more...
      • dst6 Ipv6 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...
      • 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...
      • src Ipv4 address or subnet on the internal network to compare with the resolved address in dns query replies. type: str more...
      • src6 Ipv6 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...
    • domain_filter (Alias name: domain-filter) Domain filter. type: dict more...
      • domain_filter_table (Alias name: domain-filter-table) Dns domain filter table id. type: list more...
    • external_ip_blocklist (Alias name: external-ip-blocklist) One or more external ip block lists. type: list more...
    • ftgd_dns (Alias name: ftgd-dns) Ftgd dns. type: dict more...
      • filters Filters. type: list more...
        • action Action to take for dns requests matching the category. type: str choices: [monitor, block] more...
        • category Category number. type: list more...
        • id Id number. type: int more...
        • log Enable/disable dns filter logging for this dns profile. type: str choices: [disable, enable] more...
      • options Fortiguard dns filter options. type: list choices: [error-allow, ftgd-disable] 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) Ipv4 address of the sdns redirect portal. type: str more...
    • redirect_portal6 (Alias name: redirect-portal6) Ipv6 address of the sdns redirect portal. type: str more...
    • safe_search (Alias name: safe-search) Enable/disable google, bing, youtube, qwant, duckduckgo 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...
    • strip_ech (Alias name: strip-ech) Enable/disable removal of the encrypted client hello service parameter from supporting dns rrs. type: str choices: [disable, enable] more...
    • youtube_restrict (Alias name: youtube-restrict) Set safe search for youtube restriction level. type: str choices: [strict, moderate, none] more...
    • transparent_dns_database (Alias name: transparent-dns-database) Support meta variable 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure DNS domain filter profile.
      fortinet.fmgdevice.fmgd_dnsfilter_profile:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        dnsfilter_profile:
          name: "your value" # Required variable, string
          # block_action: <value in [block, redirect, block-sevrfail]>
          # block_botnet: <value in [disable, enable]>
          # comment: <string>
          # dns_translation:
          #   - addr_type: <value in [ipv4, ipv6]>
          #     dst: <string>
          #     dst6: <string>
          #     id: <integer>
          #     netmask: <string>
          #     prefix: <integer>
          #     src: <string>
          #     src6: <string>
          #     status: <value in [disable, enable]>
          # domain_filter:
          #   domain_filter_table: <list or string>
          # external_ip_blocklist: <list or string>
          # ftgd_dns:
          #   filters:
          #     - action: <value in [monitor, block]>
          #       category: <list or string>
          #       id: <integer>
          #       log: <value in [disable, enable]>
          #   options:
          #     - "error-allow"
          #     - "ftgd-disable"
          # log_all_domain: <value in [disable, enable]>
          # redirect_portal: <string>
          # redirect_portal6: <string>
          # safe_search: <value in [disable, enable]>
          # sdns_domain_log: <value in [disable, enable]>
          # sdns_ftgd_err_log: <value in [disable, enable]>
          # strip_ech: <value in [disable, enable]>
          # youtube_restrict: <value in [strict, moderate, none]>
          # transparent_dns_database: <list or string>

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.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)