fmgr_webfilter_profile – Configure Web filter profiles.
Added in version 1.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
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.x and v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- adom - The parameter in requested url type: str required: true
- webfilter_profile - Configure Web filter profiles. type: dict
- comment Optional comments. type: str more...
- extended_log (Alias name: extended-log) Enable/disable extended logging for web filtering. type: str choices: [disable, enable] more...
- https_replacemsg (Alias name: https-replacemsg) Enable replacement messages for https. type: str choices: [disable, enable] more...
- inspection_mode (Alias name: inspection-mode) Web filtering inspection mode. type: str choices: [proxy, flow-based, dns] more...
- log_all_url (Alias name: log-all-url) Enable/disable logging all urls visited. type: str choices: [disable, enable] more...
- name Profile name. type: str more...
- options Options. type: list 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, per-user-bal] more...
- ovrd_perm (Alias name: ovrd-perm) Permitted override types. type: list choices: [bannedword-override, urlfilter-override, fortiguard-wf-override, contenttype-check-override] more...
- post_action (Alias name: post-action) Action taken for http post traffic. type: str choices: [normal, comfort, block] more...
- replacemsg_group (Alias name: replacemsg-group) Replacement message group. type: str more...
- web_content_log (Alias name: web-content-log) Enable/disable logging logging blocked web content. type: str choices: [disable, enable] more...
- web_extended_all_action_log (Alias name: web-extended-all-action-log) Enable/disable extended any filter action logging for web filtering. type: str choices: [disable, enable] more...
- web_filter_activex_log (Alias name: web-filter-activex-log) Enable/disable logging activex. type: str choices: [disable, enable] more...
- web_filter_applet_log (Alias name: web-filter-applet-log) Enable/disable logging java applets. type: str choices: [disable, enable] more...
- web_filter_command_block_log (Alias name: web-filter-command-block-log) Enable/disable logging blocked commands. type: str choices: [disable, enable] more...
- web_filter_cookie_log (Alias name: web-filter-cookie-log) Enable/disable logging cookie filtering. type: str choices: [disable, enable] more...
- web_filter_cookie_removal_log (Alias name: web-filter-cookie-removal-log) Enable/disable logging blocked cookies. type: str choices: [disable, enable] more...
- web_filter_js_log (Alias name: web-filter-js-log) Enable/disable logging java scripts. type: str choices: [disable, enable] more...
- web_filter_jscript_log (Alias name: web-filter-jscript-log) Enable/disable logging jscripts. type: str choices: [disable, enable] more...
- web_filter_referer_log (Alias name: web-filter-referer-log) Enable/disable logging referrers. type: str choices: [disable, enable] more...
- web_filter_unknown_log (Alias name: web-filter-unknown-log) Enable/disable logging unknown scripts. type: str choices: [disable, enable] more...
- web_filter_vbs_log (Alias name: web-filter-vbs-log) Enable/disable logging vbs scripts. type: str choices: [disable, enable] more...
- web_ftgd_err_log (Alias name: web-ftgd-err-log) Enable/disable logging rating errors. type: str choices: [disable, enable] more...
- web_ftgd_quota_usage (Alias name: web-ftgd-quota-usage) Enable/disable logging daily quota usage. type: str choices: [disable, enable] more...
- web_invalid_domain_log (Alias name: web-invalid-domain-log) Enable/disable logging invalid domain names. type: str choices: [disable, enable] more...
- web_url_log (Alias name: web-url-log) Enable/disable logging url filtering. type: str choices: [disable, enable] more...
- wisp Enable/disable web proxy wisp. type: str choices: [disable, enable] more...
- wisp_algorithm (Alias name: wisp-algorithm) Wisp server selection algorithm. type: str choices: [auto-learning, primary-secondary, round-robin] more...
- wisp_servers (Alias name: wisp-servers) Wisp servers. type: list or str more...
- youtube_channel_filter (Alias name: youtube-channel-filter) Youtube-channel-filter. type: list more...
- youtube_channel_status (Alias name: youtube-channel-status) Youtube channel filter status. type: str choices: [disable, blacklist, whitelist] more...
- feature_set (Alias name: feature-set) Flow/proxy feature set. type: str choices: [proxy, flow] more...
- web_antiphishing_log (Alias name: web-antiphishing-log) Enable/disable logging of antiphishing checks. type: str choices: [disable, enable] more...
- antiphish type: dict
- check_basic_auth (Alias name: check-basic-auth) Enable/disable checking of http basic auth field for known credentials. type: str choices: [disable, enable] more...
- check_uri (Alias name: check-uri) Enable/disable checking of get uri parameters for known credentials. type: str choices: [disable, enable] more...
- check_username_only (Alias name: check-username-only) Enable/disable acting only on valid username credentials. type: str choices: [disable, enable] more...
- custom_patterns (Alias name: custom-patterns) Custom-patterns. type: list more...
- default_action (Alias name: default-action) Action to be taken when there is no matching rule. type: str choices: [log, block, exempt] more...
- domain_controller (Alias name: domain-controller) Domain for which to verify received credentials against. type: str more...
- inspection_entries (Alias name: inspection-entries) Inspection-entries. type: list more...
- max_body_len (Alias name: max-body-len) Maximum size of a post body to check for credentials. type: int more...
- status Toggle antiphishing functionality. type: str choices: [disable, enable] more...
- authentication Authentication methods. type: str choices: [domain-controller, ldap] more...
- ldap Ldap server for which to verify received credentials against. type: str more...
- ftgd_wf (Alias name: ftgd-wf) type: dict
- exempt_quota (Alias name: exempt-quota) Do not stop quota for these categories. type: list or str more...
- filters Filters. type: list
more...
- action Action to take for matches. type: str choices: [block, monitor, warning, authenticate] more...
- auth_usr_grp (Alias name: auth-usr-grp) Groups with permission to authenticate. type: list or str more...
- category Categories and groups the filter examines. type: str more...
- id Id number. type: int more...
- log Enable/disable logging. type: str choices: [disable, enable] more...
- override_replacemsg (Alias name: override-replacemsg) Override replacement message. type: str more...
- warn_duration (Alias name: warn-duration) Duration of warnings. type: str more...
- warning_duration_type (Alias name: warning-duration-type) Re-display warning after closing browser or after a timeout. type: str choices: [session, timeout] more...
- warning_prompt (Alias name: warning-prompt) Warning prompts in each category or each domain. type: str choices: [per-domain, per-category] more...
- max_quota_timeout (Alias name: max-quota-timeout) Maximum fortiguard quota used by single page view in seconds (excludes streams). type: int more...
- options Options for fortiguard web filter. type: list choices: [error-allow, http-err-detail, rate-image-urls, strict-blocking, rate-server-ip, redir-block, connect-request-bypass, log-all-url, ftgd-disable] more...
- ovrd Allow web filter profile overrides. type: list or str more...
- quota Quota. type: list
more...
- category Fortiguard categories to apply quota to (category action must be set to monitor). type: list or str more...
- duration Duration of quota. type: str more...
- id Id number. type: int more...
- override_replacemsg (Alias name: override-replacemsg) Override replacement message. type: str more...
- type Quota type. type: str choices: [time, traffic] more...
- unit Traffic quota unit of measurement. type: str choices: [B, KB, MB, GB] more...
- value Traffic quota value. type: int more...
- rate_crl_urls (Alias name: rate-crl-urls) Enable/disable rating crl by url. type: str choices: [disable, enable] more...
- rate_css_urls (Alias name: rate-css-urls) Enable/disable rating css by url. type: str choices: [disable, enable] more...
- rate_image_urls (Alias name: rate-image-urls) Enable/disable rating images by url. type: str choices: [disable, enable] more...
- rate_javascript_urls (Alias name: rate-javascript-urls) Enable/disable rating javascript by url. type: str choices: [disable, enable] more...
- category_override (Alias name: category-override) Local categories take precedence over fortiguard categories. type: str more...
- override type: dict
- ovrd_cookie (Alias name: ovrd-cookie) Allow/deny browser-based (cookie) overrides. type: str choices: [deny, allow] more...
- ovrd_dur (Alias name: ovrd-dur) Override duration. type: str more...
- ovrd_dur_mode (Alias name: ovrd-dur-mode) Override duration mode. type: str choices: [constant, ask] more...
- ovrd_scope (Alias name: ovrd-scope) Override scope. type: str choices: [user, user-group, ip, ask, browser] more...
- ovrd_user_group (Alias name: ovrd-user-group) User groups with permission to use the override. type: list or str more...
- profile Web filter profile with permission to create overrides. type: list or str more...
- profile_attribute (Alias name: profile-attribute) Profile attribute to retrieve from the radius server. type: str choices: [User-Name, User-Password, CHAP-Password, NAS-IP-Address, NAS-Port, Service-Type, Framed-Protocol, Framed-IP-Address, Framed-IP-Netmask, Framed-Routing, Filter-Id, Framed-MTU, Framed-Compression, Login-IP-Host, Login-Service, Login-TCP-Port, Reply-Message, Callback-Number, Callback-Id, Framed-Route, Framed-IPX-Network, State, Class, Vendor-Specific, Session-Timeout, Idle-Timeout, Termination-Action, Called-Station-Id, Calling-Station-Id, NAS-Identifier, Proxy-State, Login-LAT-Service, Login-LAT-Node, Login-LAT-Group, Framed-AppleTalk-Link, Framed-AppleTalk-Network, Framed-AppleTalk-Zone, Acct-Status-Type, Acct-Delay-Time, Acct-Input-Octets, Acct-Output-Octets, Acct-Session-Id, Acct-Authentic, Acct-Session-Time, Acct-Input-Packets, Acct-Output-Packets, Acct-Terminate-Cause, Acct-Multi-Session-Id, Acct-Link-Count, CHAP-Challenge, NAS-Port-Type, Port-Limit, Login-LAT-Port] more...
- profile_type (Alias name: profile-type) Override profile type. type: str choices: [list, radius] more...
- url_extraction (Alias name: url-extraction) type: dict
- redirect_header (Alias name: redirect-header) Http header name to use for client redirect on blocked requests type: str more...
- redirect_no_content (Alias name: redirect-no-content) Enable / disable empty message-body entity in http response type: str choices: [disable, enable] more...
- redirect_url (Alias name: redirect-url) Http header value to use for client redirect on blocked requests type: str more...
- server_fqdn (Alias name: server-fqdn) Url extraction server fqdn (fully qualified domain name) type: str more...
- status Enable url extraction type: str choices: [disable, enable] more...
- web type: dict
- blacklist Enable/disable automatic addition of urls detected by fortisandbox to blacklist. type: str choices: [disable, enable] more...
- bword_table (Alias name: bword-table) Banned word table id. type: str more...
- bword_threshold (Alias name: bword-threshold) Banned word score threshold. type: int more...
- content_header_list (Alias name: content-header-list) Content header list. type: str more...
- keyword_match (Alias name: keyword-match) Search keywords to log when match is found. type: list more...
- log_search (Alias name: log-search) Enable/disable logging all search phrases. type: str choices: [disable, enable] more...
- safe_search (Alias name: safe-search) Safe search type. type: list choices: [google, yahoo, bing, url, header] more...
- urlfilter_table (Alias name: urlfilter-table) Url filter table id. type: str more...
- whitelist Fortiguard whitelist settings. type: list choices: [exempt-av, exempt-webcontent, exempt-activex-java-cookie, exempt-dlp, exempt-rangeblock, extended-log-others] more...
- youtube_restrict (Alias name: youtube-restrict) Youtube edu filter level. type: str choices: [strict, none, moderate] more...
- allowlist Fortiguard allowlist settings. type: list choices: [exempt-av, exempt-webcontent, exempt-activex-java-cookie, exempt-dlp, exempt-rangeblock, extended-log-others] more...
- blocklist Enable/disable automatic addition of urls detected by fortisandbox to blocklist. type: str choices: [disable, enable] more...
- vimeo_restrict (Alias name: vimeo-restrict) Set vimeo-restrict (7 = dont show mature content, 134 = dont show unrated and mature content). type: str more...
- file_filter (Alias name: file-filter) type: dict
- entries type: list
more...
- action Action taken for matched file. type: str choices: [log, block] more...
- comment Comment. type: str more...
- direction Match files transmitted in the sessions originating or reply direction. type: str choices: [any, incoming, outgoing] more...
- encryption type: str choices: [any, yes] more...
- file_type (Alias name: file-type) type: list more...
- filter Add a file filter. type: str more...
- password_protected (Alias name: password-protected) Match password-protected files. type: str choices: [any, yes] more...
- protocol type: list choices: [http, ftp] more...
- log Enable/disable file filter logging. type: str choices: [disable, enable] more...
- scan_archive_contents (Alias name: scan-archive-contents) Enable/disable file filter archive contents scan. type: str choices: [disable, enable] more...
- status Enable/disable file filter. type: str choices: [disable, enable] more...
- entries type: list
more...
- web_flow_log_encoding (Alias name: web-flow-log-encoding) Log encoding in flow mode. type: str choices: [utf-8, punycode] more...
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure Web filter profiles.
fortinet.fortimanager.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: present # <value in [present, absent]>
webfilter_profile:
comment: <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: <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
- per-user-bal
ovrd_perm:
- bannedword-override
- urlfilter-override
- fortiguard-wf-override
- contenttype-check-override
post_action: <value in [normal, comfort, block]>
replacemsg_group: <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: <list or string>
youtube_channel_filter:
-
channel_id: <string>
comment: <string>
id: <integer>
youtube_channel_status: <value in [disable, blacklist, whitelist]>
feature_set: <value in [proxy, flow]>
web_antiphishing_log: <value in [disable, enable]>
antiphish:
check_basic_auth: <value in [disable, enable]>
check_uri: <value in [disable, enable]>
check_username_only: <value in [disable, enable]>
custom_patterns:
-
category: <value in [username, password]>
pattern: <string>
type: <value in [regex, literal]>
default_action: <value in [log, block, exempt]>
domain_controller: <string>
inspection_entries:
-
action: <value in [log, block, exempt]>
fortiguard_category: <list or string>
name: <string>
max_body_len: <integer>
status: <value in [disable, enable]>
authentication: <value in [domain-controller, ldap]>
ldap: <string>
ftgd_wf:
exempt_quota: <list or string>
filters:
-
action: <value in [block, monitor, warning, ...]>
auth_usr_grp: <list or string>
category: <string>
id: <integer>
log: <value in [disable, enable]>
override_replacemsg: <string>
warn_duration: <string>
warning_duration_type: <value in [session, timeout]>
warning_prompt: <value in [per-domain, per-category]>
max_quota_timeout: <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: <list or string>
quota:
-
category: <list or string>
duration: <string>
id: <integer>
override_replacemsg: <string>
type: <value in [time, traffic]>
unit: <value in [B, KB, MB, ...]>
value: <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]>
category_override: <string>
override:
ovrd_cookie: <value in [deny, allow]>
ovrd_dur: <string>
ovrd_dur_mode: <value in [constant, ask]>
ovrd_scope: <value in [user, user-group, ip, ...]>
ovrd_user_group: <list or string>
profile: <list or string>
profile_attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
profile_type: <value in [list, radius]>
url_extraction:
redirect_header: <string>
redirect_no_content: <value in [disable, enable]>
redirect_url: <string>
server_fqdn: <string>
status: <value in [disable, enable]>
web:
blacklist: <value in [disable, enable]>
bword_table: <string>
bword_threshold: <integer>
content_header_list: <string>
keyword_match: <list or string>
log_search: <value in [disable, enable]>
safe_search:
- google
- yahoo
- bing
- url
- header
urlfilter_table: <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]>
vimeo_restrict: <string>
file_filter:
entries:
-
action: <value in [log, block]>
comment: <string>
direction: <value in [any, incoming, outgoing]>
encryption: <value in [any, yes]>
file_type: <list or string>
filter: <string>
password_protected: <value in [any, yes]>
protocol:
- http
- ftp
log: <value in [disable, enable]>
scan_archive_contents: <value in [disable, enable]>
status: <value in [disable, enable]>
web_flow_log_encoding: <value in [utf-8, punycode]>
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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.