fortinet.fortimanager.fmgr_webfilter_profile_web – Web content filtering settings.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_webfilter_profile_web.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
profile
string / required
the parameter (profile) in requested url
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
webfilter_profile_web
dictionary
the top level parameters set
allowlist
list / elements=string
    Choices:
  • exempt-av
  • exempt-webcontent
  • exempt-activex-java-cookie
  • exempt-dlp
  • exempt-rangeblock
  • extended-log-others
no description
blacklist
string
    Choices:
  • disable
  • enable
Enable/disable automatic addition of URLs detected by FortiSandbox to blacklist.
blocklist
string
    Choices:
  • disable
  • enable
Enable/disable automatic addition of URLs detected by FortiSandbox to blocklist.
bword-table
string
Banned word table ID.
bword-threshold
integer
Banned word score threshold.
content-header-list
string
Content header list.
keyword-match
string
no description
log-search
string
    Choices:
  • disable
  • enable
Enable/disable logging all search phrases.
safe-search
list / elements=string
    Choices:
  • google
  • yahoo
  • bing
  • url
  • header
no description
urlfilter-table
string
URL filter table ID.
whitelist
list / elements=string
    Choices:
  • exempt-av
  • exempt-webcontent
  • exempt-activex-java-cookie
  • exempt-dlp
  • exempt-rangeblock
  • extended-log-others
no description
youtube-restrict
string
    Choices:
  • strict
  • none
  • moderate
YouTube EDU filter level.
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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: Web content filtering settings.
     fmgr_webfilter_profile_web:
        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_web:
           blacklist: <value in [disable, enable]>
           bword-table: <value of string>
           bword-threshold: <value of integer>
           content-header-list: <value of string>
           keyword-match: <value of string>
           log-search: <value in [disable, enable]>
           safe-search:
             - google
             - yahoo
             - bing
             - url
             - header
           urlfilter-table: <value of string>
           whitelist:
             - exempt-av
             - exempt-webcontent
             - exempt-activex-java-cookie
             - exempt-dlp
             - exempt-rangeblock
             - extended-log-others
           youtube-restrict: <value in [strict, none, moderate]>
           allowlist:
             - exempt-av
             - exempt-webcontent
             - exempt-activex-java-cookie
             - exempt-dlp
             - exempt-rangeblock
             - extended-log-others
           blocklist: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)