fortinet.fortimanager.fmgr_webfilter_profile – Configure Web filter profiles.
fortinet.fortimanager.fmgr_webfilter_profile – Configure Web filter profiles.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
To install it use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_webfilter_profile.
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 |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | ||
|
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 |
|
the directive to create, update or delete an object | ||
|
webfilter_profile dictionary |
the top level parameters set | |||
|
comment string |
Optional comments. | |||
|
extended-log string |
|
Enable/disable extended logging for web filtering. | ||
|
https-replacemsg string |
|
Enable replacement messages for HTTPS. | ||
|
inspection-mode string |
|
Web filtering inspection mode. | ||
|
log-all-url string |
|
Enable/disable logging all URLs visited. | ||
|
name string |
Profile name. | |||
|
options list / elements=string |
|
no description | ||
|
ovrd-perm list / elements=string |
|
no description | ||
|
post-action string |
|
Action taken for HTTP POST traffic. | ||
|
replacemsg-group string |
Replacement message group. | |||
|
web-content-log string |
|
Enable/disable logging logging blocked web content. | ||
|
web-extended-all-action-log string |
|
Enable/disable extended any filter action logging for web filtering. | ||
|
web-filter-activex-log string |
|
Enable/disable logging ActiveX. | ||
|
web-filter-applet-log string |
|
Enable/disable logging Java applets. | ||
|
web-filter-command-block-log string |
|
Enable/disable logging blocked commands. | ||
|
web-filter-cookie-log string |
|
Enable/disable logging cookie filtering. | ||
|
web-filter-cookie-removal-log string |
|
Enable/disable logging blocked cookies. | ||
|
web-filter-js-log string |
|
Enable/disable logging Java scripts. | ||
|
web-filter-jscript-log string |
|
Enable/disable logging JScripts. | ||
|
web-filter-referer-log string |
|
Enable/disable logging referrers. | ||
|
web-filter-unknown-log string |
|
Enable/disable logging unknown scripts. | ||
|
web-filter-vbs-log string |
|
Enable/disable logging VBS scripts. | ||
|
web-ftgd-err-log string |
|
Enable/disable logging rating errors. | ||
|
web-ftgd-quota-usage string |
|
Enable/disable logging daily quota usage. | ||
|
web-invalid-domain-log string |
|
Enable/disable logging invalid domain names. | ||
|
web-url-log string |
|
Enable/disable logging URL filtering. | ||
|
wisp string |
|
Enable/disable web proxy WISP. | ||
|
wisp-algorithm string |
|
WISP server selection algorithm. | ||
|
wisp-servers string |
WISP servers. | |||
|
youtube-channel-filter list / elements=string |
no description | |||
|
channel-id string |
YouTube channel ID to be filtered. | |||
|
comment string |
Comment. | |||
|
id integer |
ID. | |||
|
youtube-channel-status string |
|
YouTube channel filter status. | ||
|
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: 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 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)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_webfilter_profile_module.html
