fmgr_webfilter_profile_ftgdwf – FortiGuard Web Filter settings.

New in version 2.0.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 v6.x and v7.x.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0
True
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10
True True True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11
True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7
True True True True True True True True
7.2.0 7.2.1 7.2.2
True True True
7.4.0
True

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
  • 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
  • profile - The parameter in requested url type: str required: true
  • webfilter_profile_ftgdwf - FortiGuard Web Filter settings. type: dict
    • exempt-quota - Do not stop quota for these categories. type: str more...
    • filters - No description for the parameter type: array more...
      • action - Action to take for matches. type: str choices: [block, monitor, warning, authenticate] more...
      • auth-usr-grp - Groups with permission to authenticate. type: str more...
      • category - Categories and groups the filter examines. type: str more...
      • id - ID number. type: int more...
      • log - Enable/disable logging. type: str choices: [disable, enable] more...
      • override-replacemsg - Override replacement message. type: str more...
      • warn-duration - Duration of warnings. type: str more...
      • warning-duration-type - Re-display warning after closing browser or after a timeout. type: str choices: [session, timeout] more...
      • warning-prompt - Warning prompts in each category or each domain. type: str choices: [per-domain, per-category] more...
    • max-quota-timeout - Maximum FortiGuard quota used by single page view in seconds (excludes streams). type: int more...
    • options - No description for the parameter type: array choices: [error-allow, http-err-detail, rate-image-urls, strict-blocking, rate-server-ip, redir-block, connect-request-bypass, log-all-url, ftgd-disable] more...
    • ovrd - Allow web filter profile overrides. type: str more...
    • quota - No description for the parameter type: array more...
      • category - FortiGuard categories to apply quota to (category action must be set to monitor). type: str more...
      • duration - Duration of quota. type: str more...
      • id - ID number. type: int more...
      • override-replacemsg - Override replacement message. type: str more...
      • type - Quota type. type: str choices: [time, traffic] more...
      • unit - Traffic quota unit of measurement. type: str choices: [B, KB, MB, GB] more...
      • value - Traffic quota value. type: int more...
    • rate-crl-urls - Enable/disable rating CRL by URL. type: str choices: [disable, enable] more...
    • rate-css-urls - Enable/disable rating CSS by URL. type: str choices: [disable, enable] more...
    • rate-image-urls - Enable/disable rating images by URL. type: str choices: [disable, enable] more...
    • rate-javascript-urls - Enable/disable rating JavaScript by URL. type: str choices: [disable, enable] more...
    • category-override - Local categories take precedence over FortiGuard categories. type: str 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

- 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: FortiGuard Web Filter settings.
     fmgr_webfilter_profile_ftgdwf:
        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>
        profile: <your own value>
        webfilter_profile_ftgdwf:
           exempt-quota: <value of string>
           filters:
             -
                 action: <value in [block, monitor, warning, ...]>
                 auth-usr-grp: <value of string>
                 category: <value of string>
                 id: <value of integer>
                 log: <value in [disable, enable]>
                 override-replacemsg: <value of string>
                 warn-duration: <value of string>
                 warning-duration-type: <value in [session, timeout]>
                 warning-prompt: <value in [per-domain, per-category]>
           max-quota-timeout: <value of integer>
           options:
             - error-allow
             - http-err-detail
             - rate-image-urls
             - strict-blocking
             - rate-server-ip
             - redir-block
             - connect-request-bypass
             - log-all-url
             - ftgd-disable
           ovrd: <value of string>
           quota:
             -
                 category: <value of string>
                 duration: <value of string>
                 id: <value of integer>
                 override-replacemsg: <value of string>
                 type: <value in [time, traffic]>
                 unit: <value in [B, KB, MB, ...]>
                 value: <value of integer>
           rate-crl-urls: <value in [disable, enable]>
           rate-css-urls: <value in [disable, enable]>
           rate-image-urls: <value in [disable, enable]>
           rate-javascript-urls: <value in [disable, enable]>
           category-override: <value of 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 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

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)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.