fortinet.fortimanager.fmgr_webfilter_profile_web (2.4.0) — module

Web content filtering settings.

| "added in version" 2.0.0 of fortinet.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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: Web content filtering settings.
      fortinet.fortimanager.fmgr_webfilter_profile_web:
        # 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_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>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

profile:
    description: The parameter (profile) in requested url.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

webfilter_profile_web:
    description: The top level parameters set.
    required: false
    suboptions:
      allowlist:
        choices:
        - exempt-av
        - exempt-webcontent
        - exempt-activex-java-cookie
        - exempt-dlp
        - exempt-rangeblock
        - extended-log-others
        description: No description.
        elements: str
        type: list
      blacklist:
        choices:
        - disable
        - enable
        description: Enable/disable automatic addition of URLs detected by FortiSandbox
          to blacklist.
        type: str
      blocklist:
        choices:
        - disable
        - enable
        description: Enable/disable automatic addition of URLs detected by FortiSandbox
          to blocklist.
        type: str
      bword-table:
        description: Deprecated, please rename it to bword_table. Banned word table ID.
        type: str
      bword-threshold:
        description: Deprecated, please rename it to bword_threshold. Banned word score
          threshold.
        type: int
      content-header-list:
        description: Deprecated, please rename it to content_header_list. Content header
          list.
        type: str
      keyword-match:
        description: (list) Deprecated, please rename it to keyword_match.
        type: raw
      log-search:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to log_search. Enable/disable logging
          all search phrases.
        type: str
      safe-search:
        choices:
        - google
        - yahoo
        - bing
        - url
        - header
        description: Deprecated, please rename it to safe_search.
        elements: str
        type: list
      urlfilter-table:
        description: Deprecated, please rename it to urlfilter_table. URL filter table
          ID.
        type: str
      vimeo-restrict:
        description: Deprecated, please rename it to vimeo_restrict. Set Vimeo-restrict
        type: str
      whitelist:
        choices:
        - exempt-av
        - exempt-webcontent
        - exempt-activex-java-cookie
        - exempt-dlp
        - exempt-rangeblock
        - extended-log-others
        description: No description.
        elements: str
        type: list
      youtube-restrict:
        choices:
        - strict
        - none
        - moderate
        description: Deprecated, please rename it to youtube_restrict. YouTube EDU filter
          level.
        type: str
    type: dict

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list