fmgr_webfilter_profile – Configure Web filter profiles.¶
New in version 2.10.
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.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- webfilter_profile - Configure Web filter profiles. type: dict
- 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 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 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]
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: Configure Web filter profiles.
fmgr_webfilter_profile:
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>
state: <value in [present, absent]>
webfilter_profile:
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:
- 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:
- bannedword-override
- urlfilter-override
- fortiguard-wf-override
- contenttype-check-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]>
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict