fortinet.fortimanager.fmgr_webfilter_profile_ftgdwf – FortiGuard Web Filter settings.
fortinet.fortimanager.fmgr_webfilter_profile_ftgdwf – FortiGuard Web Filter settings.
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_ftgdwf.
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 | ||
|
profile string / required |
the parameter (profile) in requested url | |||
|
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_ftgdwf dictionary |
the top level parameters set | |||
|
exempt-quota string |
Do not stop quota for these categories. | |||
|
filters list / elements=string |
no description | |||
|
action string |
|
Action to take for matches. | ||
|
auth-usr-grp string |
Groups with permission to authenticate. | |||
|
category string |
Categories and groups the filter examines. | |||
|
id integer |
ID number. | |||
|
log string |
|
Enable/disable logging. | ||
|
override-replacemsg string |
Override replacement message. | |||
|
warn-duration string |
Duration of warnings. | |||
|
warning-duration-type string |
|
Re-display warning after closing browser or after a timeout. | ||
|
warning-prompt string |
|
Warning prompts in each category or each domain. | ||
|
max-quota-timeout integer |
Maximum FortiGuard quota used by single page view in seconds (excludes streams). | |||
|
options list / elements=string |
|
no description | ||
|
ovrd string |
Allow web filter profile overrides. | |||
|
quota list / elements=string |
no description | |||
|
category string |
FortiGuard categories to apply quota to (category action must be set to monitor). | |||
|
duration string |
Duration of quota. | |||
|
id integer |
ID number. | |||
|
override-replacemsg string |
Override replacement message. | |||
|
type string |
|
Quota type. | ||
|
unit string |
|
Traffic quota unit of measurement. | ||
|
value integer |
Traffic quota value. | |||
|
rate-crl-urls string |
|
Enable/disable rating CRL by URL. | ||
|
rate-css-urls string |
|
Enable/disable rating CSS by URL. | ||
|
rate-image-urls string |
|
Enable/disable rating images by URL. | ||
|
rate-javascript-urls string |
|
Enable/disable rating JavaScript by URL. | ||
|
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: 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]>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_ftgdwf_module.html
