: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 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)