fmgr_webfilter_profile – Configure Web filter profiles.¶

New in version 2.10.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status
Authors

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/webfilter/profile
/pm/config/global/obj/webfilter/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 Web filter profiles.

data - No description for the parameter type: array
- comment - Optional comments. type: str
- extended-log - Enable/disable extended logging for web filtering. type: str choices: [disable, enable]
- https-replacemsg - Enable replacement messages for HTTPS. type: str choices: [disable, enable]
- inspection-mode - Web filtering inspection mode. type: str choices: [proxy, flow-based, dns]
- log-all-url - Enable/disable logging all URLs visited. type: str choices: [disable, enable]
- name - Profile name. type: str
- options - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str choices: [block-invalid-url, jscript, js, vbs, unknown, wf-referer, https-scan, intrinsic, wf-cookie, per-user-bwl, activexfilter, cookiefilter, https-url-scan, javafilter, rangeblock, contenttype-check]
- ovrd-perm - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str choices: [bannedword-override, urlfilter-override, fortiguard-wf-override, contenttype-check-override]
- post-action - Action taken for HTTP POST traffic. type: str choices: [normal, comfort, block]
- replacemsg-group - Replacement message group. type: str
- web-content-log - Enable/disable logging logging blocked web content. type: str choices: [disable, enable]
- web-extended-all-action-log - Enable/disable extended any filter action logging for web filtering. type: str choices: [disable, enable]
- web-filter-activex-log - Enable/disable logging ActiveX. type: str choices: [disable, enable]
- web-filter-applet-log - Enable/disable logging Java applets. type: str choices: [disable, enable]
- web-filter-command-block-log - Enable/disable logging blocked commands. type: str choices: [disable, enable]
- web-filter-cookie-log - Enable/disable logging cookie filtering. type: str choices: [disable, enable]
- web-filter-cookie-removal-log - Enable/disable logging blocked cookies. type: str choices: [disable, enable]
- web-filter-js-log - Enable/disable logging Java scripts. type: str choices: [disable, enable]
- web-filter-jscript-log - Enable/disable logging JScripts. type: str choices: [disable, enable]
- web-filter-referer-log - Enable/disable logging referrers. type: str choices: [disable, enable]
- web-filter-unknown-log - Enable/disable logging unknown scripts. type: str choices: [disable, enable]
- web-filter-vbs-log - Enable/disable logging VBS scripts. type: str choices: [disable, enable]
- web-ftgd-err-log - Enable/disable logging rating errors. type: str choices: [disable, enable]
- web-ftgd-quota-usage - Enable/disable logging daily quota usage. type: str choices: [disable, enable]
- web-invalid-domain-log - Enable/disable logging invalid domain names. type: str choices: [disable, enable]
- web-url-log - Enable/disable logging URL filtering. type: str choices: [disable, enable]
- wisp - Enable/disable web proxy WISP. type: str choices: [disable, enable]
- wisp-algorithm - WISP server selection algorithm. type: str choices: [auto-learning, primary-secondary, round-robin]
- wisp-servers - WISP servers. type: str
- youtube-channel-filter - No description for the parameter type: array
  - channel-id - YouTube channel ID to be filtered. type: str
  - comment - Comment. type: str
  - id - ID. type: int
- youtube-channel-status - YouTube channel filter status. type: str choices: [disable, blacklist, whitelist]

parameters for method: [get] - Configure Web 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: [comment, extended-log, https-replacemsg, inspection-mode, log-all-url, name, options, ovrd-perm, post-action, replacemsg-group, web-content-log, web-extended-all-action-log, web-filter-activex-log, web-filter-applet-log, web-filter-command-block-log, web-filter-cookie-log, web-filter-cookie-removal-log, web-filter-js-log, web-filter-jscript-log, web-filter-referer-log, web-filter-unknown-log, web-filter-vbs-log, web-ftgd-err-log, web-ftgd-quota-usage, web-invalid-domain-log, web-url-log, wisp, wisp-algorithm, wisp-servers, youtube-channel-status]
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/WEBFILTER/PROFILE
     fmgr_webfilter_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:
                -
                    comment: <value of string>
                    extended-log: <value in [disable, enable]>
                    https-replacemsg: <value in [disable, enable]>
                    inspection-mode: <value in [proxy, flow-based, dns]>
                    log-all-url: <value in [disable, enable]>
                    name: <value of string>
                    options:
                      - <value in [block-invalid-url, jscript, js, ...]>
                    ovrd-perm:
                      - <value in [bannedword-override, urlfilter-override, fortiguard-wf-override, ...]>
                    post-action: <value in [normal, comfort, block]>
                    replacemsg-group: <value of string>
                    web-content-log: <value in [disable, enable]>
                    web-extended-all-action-log: <value in [disable, enable]>
                    web-filter-activex-log: <value in [disable, enable]>
                    web-filter-applet-log: <value in [disable, enable]>
                    web-filter-command-block-log: <value in [disable, enable]>
                    web-filter-cookie-log: <value in [disable, enable]>
                    web-filter-cookie-removal-log: <value in [disable, enable]>
                    web-filter-js-log: <value in [disable, enable]>
                    web-filter-jscript-log: <value in [disable, enable]>
                    web-filter-referer-log: <value in [disable, enable]>
                    web-filter-unknown-log: <value in [disable, enable]>
                    web-filter-vbs-log: <value in [disable, enable]>
                    web-ftgd-err-log: <value in [disable, enable]>
                    web-ftgd-quota-usage: <value in [disable, enable]>
                    web-invalid-domain-log: <value in [disable, enable]>
                    web-url-log: <value in [disable, enable]>
                    wisp: <value in [disable, enable]>
                    wisp-algorithm: <value in [auto-learning, primary-secondary, round-robin]>
                    wisp-servers: <value of string>
                    youtube-channel-filter:
                      -
                          channel-id: <value of string>
                          comment: <value of string>
                          id: <value of integer>
                    youtube-channel-status: <value in [disable, blacklist, whitelist]>

   - name: REQUESTING /PM/CONFIG/OBJ/WEBFILTER/PROFILE
     fmgr_webfilter_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 [comment, extended-log, https-replacemsg, ...]>
              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/webfilter/profile

return values for method: [get]

data - No description for the parameter type: array
- comment - Optional comments. type: str
- extended-log - Enable/disable extended logging for web filtering. type: str
- https-replacemsg - Enable replacement messages for HTTPS. type: str
- inspection-mode - Web filtering inspection mode. type: str
- log-all-url - Enable/disable logging all URLs visited. type: str
- name - Profile name. type: str
- options - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str
- ovrd-perm - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str
- post-action - Action taken for HTTP POST traffic. type: str
- replacemsg-group - Replacement message group. type: str
- web-content-log - Enable/disable logging logging blocked web content. type: str
- web-extended-all-action-log - Enable/disable extended any filter action logging for web filtering. type: str
- web-filter-activex-log - Enable/disable logging ActiveX. type: str
- web-filter-applet-log - Enable/disable logging Java applets. type: str
- web-filter-command-block-log - Enable/disable logging blocked commands. type: str
- web-filter-cookie-log - Enable/disable logging cookie filtering. type: str
- web-filter-cookie-removal-log - Enable/disable logging blocked cookies. type: str
- web-filter-js-log - Enable/disable logging Java scripts. type: str
- web-filter-jscript-log - Enable/disable logging JScripts. type: str
- web-filter-referer-log - Enable/disable logging referrers. type: str
- web-filter-unknown-log - Enable/disable logging unknown scripts. type: str
- web-filter-vbs-log - Enable/disable logging VBS scripts. type: str
- web-ftgd-err-log - Enable/disable logging rating errors. type: str
- web-ftgd-quota-usage - Enable/disable logging daily quota usage. type: str
- web-invalid-domain-log - Enable/disable logging invalid domain names. type: str
- web-url-log - Enable/disable logging URL filtering. type: str
- wisp - Enable/disable web proxy WISP. type: str
- wisp-algorithm - WISP server selection algorithm. type: str
- wisp-servers - WISP servers. type: str
- youtube-channel-filter - No description for the parameter type: array
  - channel-id - YouTube channel ID to be filtered. type: str
  - comment - Comment. type: str
  - id - ID. type: int
- youtube-channel-status - YouTube channel filter status. 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/webfilter/profile

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Frank Shen (@fshen01)
Link Zheng (@zhengl)

Hint

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