:source: fmgr_webfilter_profile.py
:orphan:
.. _fmgr_webfilter_profile:
fmgr_webfilter_profile -- Configure Web filter profiles.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 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.name``
- New 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.
.. contents::
:local:
:depth: 1
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 v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v6.0.0 -> latest
Parameters
----------
.. raw:: html
- 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
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- webfilter_profile - Configure Web filter profiles. type: dict
- comment Optional comments. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- extended_log (Alias name: extended-log) Enable/disable extended logging for web filtering. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- https_replacemsg (Alias name: https-replacemsg) Enable replacement messages for https. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- inspection_mode (Alias name: inspection-mode) Web filtering inspection mode. type: str choices: [proxy, flow-based, dns]
more...
Supported Version Ranges: v6.0.0 -> v7.2.1
- log_all_url (Alias name: log-all-url) Enable/disable logging all urls visited. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- name Profile name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- 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...
Supported Version Ranges: v6.0.0 -> latest
- ovrd_perm (Alias name: ovrd-perm) Permitted override types. type: list choices: [bannedword-override, urlfilter-override, fortiguard-wf-override, contenttype-check-override]
more...
Supported Version Ranges: v6.0.0 -> latest
- post_action (Alias name: post-action) Action taken for http post traffic. type: str choices: [normal, comfort, block]
more...
Supported Version Ranges: v6.0.0 -> latest
- replacemsg_group (Alias name: replacemsg-group) Replacement message group. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- web_content_log (Alias name: web-content-log) Enable/disable logging logging blocked web content. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- 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...
Supported Version Ranges: v6.0.0 -> latest
- web_filter_activex_log (Alias name: web-filter-activex-log) Enable/disable logging activex. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_filter_applet_log (Alias name: web-filter-applet-log) Enable/disable logging java applets. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_filter_command_block_log (Alias name: web-filter-command-block-log) Enable/disable logging blocked commands. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_filter_cookie_log (Alias name: web-filter-cookie-log) Enable/disable logging cookie filtering. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_filter_cookie_removal_log (Alias name: web-filter-cookie-removal-log) Enable/disable logging blocked cookies. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_filter_js_log (Alias name: web-filter-js-log) Enable/disable logging java scripts. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_filter_jscript_log (Alias name: web-filter-jscript-log) Enable/disable logging jscripts. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_filter_referer_log (Alias name: web-filter-referer-log) Enable/disable logging referrers. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_filter_unknown_log (Alias name: web-filter-unknown-log) Enable/disable logging unknown scripts. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_filter_vbs_log (Alias name: web-filter-vbs-log) Enable/disable logging vbs scripts. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_ftgd_err_log (Alias name: web-ftgd-err-log) Enable/disable logging rating errors. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_ftgd_quota_usage (Alias name: web-ftgd-quota-usage) Enable/disable logging daily quota usage. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_invalid_domain_log (Alias name: web-invalid-domain-log) Enable/disable logging invalid domain names. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- web_url_log (Alias name: web-url-log) Enable/disable logging url filtering. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- wisp Enable/disable web proxy wisp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- wisp_algorithm (Alias name: wisp-algorithm) Wisp server selection algorithm. type: str choices: [auto-learning, primary-secondary, round-robin]
more...
Supported Version Ranges: v6.0.0 -> latest
- wisp_servers (Alias name: wisp-servers) Wisp servers. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- youtube_channel_filter (Alias name: youtube-channel-filter) Youtube channel filter. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- channel_id (Alias name: channel-id) Youtube channel id to be filtered. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- comment Comment. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- id Id. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- youtube_channel_status (Alias name: youtube-channel-status) Youtube channel filter status. type: str choices: [disable, blacklist, whitelist]
more...
Supported Version Ranges: v6.0.0 -> latest
- feature_set (Alias name: feature-set) Flow/proxy feature set. type: str choices: [proxy, flow]
more...
Supported Version Ranges: v6.4.0 -> latest
- web_antiphishing_log (Alias name: web-antiphishing-log) Enable/disable logging of antiphishing checks. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.0 -> latest
- antiphish Antiphish. type: dict
more...
Supported Version Ranges: v6.4.5 -> latest
- 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...
Supported Version Ranges: v6.4.5 -> latest
- check_uri (Alias name: check-uri) Enable/disable checking of get uri parameters for known credentials. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.5 -> latest
- check_username_only (Alias name: check-username-only) Enable/disable acting only on valid username credentials. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.5 -> latest
- custom_patterns (Alias name: custom-patterns) Custom patterns. type: list
more...
Supported Version Ranges: v6.4.5 -> latest
- category Category that the pattern matches. type: str choices: [username, password]
more...
Supported Version Ranges: v6.4.5 -> latest
- pattern Target pattern. type: str
more...
Supported Version Ranges: v6.4.5 -> latest
- type Pattern will be treated either as a regex pattern or literal string. type: str choices: [regex, literal]
more...
Supported Version Ranges: v7.0.0 -> latest
- default_action (Alias name: default-action) Action to be taken when there is no matching rule. type: str choices: [log, block, exempt]
more...
Supported Version Ranges: v6.4.5 -> latest
- domain_controller (Alias name: domain-controller) Domain for which to verify received credentials against. type: str
more...
Supported Version Ranges: v6.4.5 -> latest
- inspection_entries (Alias name: inspection-entries) Inspection entries. type: list
more...
Supported Version Ranges: v6.4.5 -> latest
- action Action to be taken upon an antiphishing match. type: str choices: [log, block, exempt]
more...
Supported Version Ranges: v6.4.5 -> latest
- fortiguard_category (Alias name: fortiguard-category) Fortiguard category to match. type: list
more...
Supported Version Ranges: v6.4.5 -> latest
- name Inspection target name. type: str
more...
Supported Version Ranges: v6.4.5 -> latest
- max_body_len (Alias name: max-body-len) Maximum size of a post body to check for credentials. type: int
more...
Supported Version Ranges: v6.4.5 -> latest
- status Toggle antiphishing functionality. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.5 -> latest
- authentication Authentication methods. type: str choices: [domain-controller, ldap]
more...
Supported Version Ranges: v7.0.0 -> latest
- ldap Ldap server for which to verify received credentials against. type: str
more...
Supported Version Ranges: v7.0.0 -> latest
- ftgd_wf (Alias name: ftgd-wf) Ftgd wf. type: dict
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- exempt_quota (Alias name: exempt-quota) Do not stop quota for these categories. type: list or str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- filters Filters. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- action Action to take for matches. type: str choices: [block, monitor, warning, authenticate]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- auth_usr_grp (Alias name: auth-usr-grp) Groups with permission to authenticate. type: list or str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- category Categories and groups the filter examines. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- id Id number. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- log Enable/disable logging. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- override_replacemsg (Alias name: override-replacemsg) Override replacement message. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- warn_duration (Alias name: warn-duration) Duration of warnings. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- warning_duration_type (Alias name: warning-duration-type) Re-display warning after closing browser or after a timeout. type: str choices: [session, timeout]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- warning_prompt (Alias name: warning-prompt) Warning prompts in each category or each domain. type: str choices: [per-domain, per-category]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- max_quota_timeout (Alias name: max-quota-timeout) Maximum fortiguard quota used by single page view in seconds (excludes streams). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- 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...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ovrd Allow web filter profile overrides. type: list or str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- quota Quota. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- category Fortiguard categories to apply quota to (category action must be set to monitor). type: list or str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- duration Duration of quota. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- id Id number. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- override_replacemsg (Alias name: override-replacemsg) Override replacement message. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- type Quota type. type: str choices: [time, traffic]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- unit Traffic quota unit of measurement. type: str choices: [B, KB, MB, GB]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- value Traffic quota value. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- reset_frequency (Alias name: reset-frequency) Quota reset frequency (default = dayly). type: str choices: [daily, weekly, monthly]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10
- rate_crl_urls (Alias name: rate-crl-urls) Enable/disable rating crl by url. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- rate_css_urls (Alias name: rate-css-urls) Enable/disable rating css by url. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- rate_image_urls (Alias name: rate-image-urls) Enable/disable rating images by url. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- rate_javascript_urls (Alias name: rate-javascript-urls) Enable/disable rating javascript by url. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- category_override (Alias name: category-override) Local categories take precedence over fortiguard categories. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v6.4.15
- risk Risk. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.2 -> latest
- action Action to take for matches. type: str choices: [block, monitor]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.2 -> latest
- id Id number. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.2 -> latest
- log Enable/disable logging. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.2 -> latest
- risk_level (Alias name: risk-level) Risk level to be examined. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.2 -> latest
- override Override. type: dict
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ovrd_cookie (Alias name: ovrd-cookie) Allow/deny browser-based (cookie) overrides. type: str choices: [deny, allow]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ovrd_dur (Alias name: ovrd-dur) Override duration. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ovrd_dur_mode (Alias name: ovrd-dur-mode) Override duration mode. type: str choices: [constant, ask]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ovrd_scope (Alias name: ovrd-scope) Override scope. type: str choices: [user, user-group, ip, ask, browser]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ovrd_user_group (Alias name: ovrd-user-group) User groups with permission to use the override. type: list or str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- profile Web filter profile with permission to create overrides. type: list or str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- 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...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- profile_type (Alias name: profile-type) Override profile type. type: str choices: [list, radius]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- url_extraction (Alias name: url-extraction) Url extraction. type: dict
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- redirect_header (Alias name: redirect-header) Http header name to use for client redirect on blocked requests type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- redirect_no_content (Alias name: redirect-no-content) Enable / disable empty message-body entity in http response type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- redirect_url (Alias name: redirect-url) Http header value to use for client redirect on blocked requests type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- server_fqdn (Alias name: server-fqdn) Url extraction server fqdn (fully qualified domain name) type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- status Enable url extraction type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- web Web. type: dict
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- blacklist Enable/disable automatic addition of urls detected by fortisandbox to blacklist. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- bword_table (Alias name: bword-table) Banned word table id. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- bword_threshold (Alias name: bword-threshold) Banned word score threshold. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- content_header_list (Alias name: content-header-list) Content header list. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- keyword_match (Alias name: keyword-match) Search keywords to log when match is found. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- log_search (Alias name: log-search) Enable/disable logging all search phrases. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- safe_search (Alias name: safe-search) Safe search type. type: list choices: [google, yahoo, bing, url, header]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- urlfilter_table (Alias name: urlfilter-table) Url filter table id. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- whitelist Fortiguard whitelist settings. type: list choices: [exempt-av, exempt-webcontent, exempt-activex-java-cookie, exempt-dlp, exempt-rangeblock, extended-log-others]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- youtube_restrict (Alias name: youtube-restrict) Youtube edu filter level. type: str choices: [strict, none, moderate]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- allowlist Fortiguard allowlist settings. type: list choices: [exempt-av, exempt-webcontent, exempt-activex-java-cookie, exempt-dlp, exempt-rangeblock, extended-log-others]
more...
Supported Version Ranges: v7.0.0 -> latest
- blocklist Enable/disable automatic addition of urls detected by fortisandbox to blocklist. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.0 -> latest
- vimeo_restrict (Alias name: vimeo-restrict) Set vimeo-restrict (7 = dont show mature content, 134 = dont show unrated and mature content). type: str
more...
Supported Version Ranges: v7.0.1 -> latest
- qwant_restrict (Alias name: qwant-restrict) Qwant restrict. type: str choices: [strict, none, moderate]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- file_filter (Alias name: file-filter) File filter. type: dict
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- entries Entries. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- action Action taken for matched file. type: str choices: [log, block]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- comment Comment. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- direction Match files transmitted in the sessions originating or reply direction. type: str choices: [any, incoming, outgoing]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- encryption Encryption. type: str choices: [any, yes]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.2.0
- file_type (Alias name: file-type) Select file type. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- filter Add a file filter. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- password_protected (Alias name: password-protected) Match password-protected files. type: str choices: [any, yes]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- protocol Protocols to apply with. type: list choices: [http, ftp]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- log Enable/disable file filter logging. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- scan_archive_contents (Alias name: scan-archive-contents) Enable/disable file filter archive contents scan. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- status Enable/disable file filter. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.6.2
- web_flow_log_encoding (Alias name: web-flow-log-encoding) Log encoding in flow mode. type: str choices: [utf-8, punycode]
more...
Supported Version Ranges: v7.4.2 -> latest
- ia_categorization (Alias name: ia-categorization) Ia categorization. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure Web filter profiles.
fortinet.fortimanager.fmgr_webfilter_profile:
# workspace_locking_adom:
adom:
state: present #
webfilter_profile:
name: "your value" # Required variable, string
# comment:
# extended_log:
# https_replacemsg:
# inspection_mode:
# log_all_url:
# 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:
# 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_filter:
# - channel_id:
# comment:
# id:
# youtube_channel_status:
# feature_set:
# web_antiphishing_log:
# antiphish:
# check_basic_auth:
# check_uri:
# check_username_only:
# custom_patterns:
# - category:
# pattern:
# type:
# default_action:
# domain_controller:
# inspection_entries:
# - action:
# fortiguard_category:
# name:
# max_body_len:
# status:
# authentication:
# ldap:
# ftgd_wf:
# exempt_quota:
# filters:
# - action:
# auth_usr_grp:
# category:
# id:
# log:
# override_replacemsg:
# warn_duration:
# warning_duration_type:
# warning_prompt:
# max_quota_timeout:
# 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:
# quota:
# - category:
# duration:
# id:
# override_replacemsg:
# type:
# unit:
# value:
# reset_frequency:
# rate_crl_urls:
# rate_css_urls:
# rate_image_urls:
# rate_javascript_urls:
# category_override:
# risk:
# - action:
# id:
# log:
# risk_level:
# override:
# ovrd_cookie:
# ovrd_dur:
# ovrd_dur_mode:
# ovrd_scope:
# ovrd_user_group:
# profile:
# profile_attribute:
# profile_type:
# url_extraction:
# redirect_header:
# redirect_no_content:
# redirect_url:
# server_fqdn:
# status:
# web:
# blacklist:
# bword_table:
# bword_threshold:
# content_header_list:
# keyword_match:
# log_search:
# safe_search: ["google", "yahoo", "bing", "url", "header"]
# urlfilter_table:
# whitelist: ["exempt-av", "exempt-webcontent", "exempt-activex-java-cookie",
# "exempt-dlp", "exempt-rangeblock", "extended-log-others"]
# youtube_restrict:
# allowlist: ["exempt-av", "exempt-webcontent", "exempt-activex-java-cookie",
# "exempt-dlp", "exempt-rangeblock", "extended-log-others"]
# blocklist:
# vimeo_restrict:
# qwant_restrict:
# file_filter:
# entries:
# - action:
# comment:
# direction:
# encryption:
# file_type:
# filter:
# password_protected:
# protocol: ["http", "ftp"]
# log:
# scan_archive_contents:
# status:
# web_flow_log_encoding:
# ia_categorization:
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:
.. raw:: html
- 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.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)