Skip to content

Latest commit

 

History

History
391 lines (350 loc) · 17.1 KB

fortios_webfilter_fortiguard.rst

File metadata and controls

391 lines (350 loc) · 17.1 KB
Raw
source:fortios_webfilter_fortiguard.py
orphan:

fortios_webfilter_fortiguard -- Configure FortiGuard Web Filter service in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and fortiguard category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • webfilter_fortiguard - Configure FortiGuard Web Filter service. type: dict more...
    Supported Version Ranges
    webfilter_fortiguard v6.0.0 -> 7.4.3
    • cache_mem_percent - Maximum percentage of available memory allocated to caching (1 - 15). type: int more...
      Supported Version Ranges
      cache_mem_percent v6.0.0 -> v7.2.4
    • cache_mem_permille - Maximum permille of available memory allocated to caching (1 - 150). type: int more...
      Supported Version Ranges
      cache_mem_permille v7.4.0 -> 7.4.3
    • cache_mode - Cache entry expiration mode. type: str choices: ttl, db-ver more...
      Supported Version Ranges
      cache_mode v6.0.0 -> 7.4.3
      [ttl] v6.0.0 -> 7.4.3
      [db-ver] v6.0.0 -> 7.4.3
    • cache_prefix_match - Enable/disable prefix matching in the cache. type: str choices: enable, disable more...
      Supported Version Ranges
      cache_prefix_match v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • close_ports - Close ports used for HTTP/HTTPS override authentication and disable user overrides. type: str choices: enable, disable more...
      Supported Version Ranges
      close_ports v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • embed_image - Enable/disable embedding images into replacement messages . type: str choices: enable, disable more...
      Supported Version Ranges
      embed_image v7.2.4 -> 7.4.3
      [enable] v7.2.4 -> 7.4.3
      [disable] v7.2.4 -> 7.4.3
    • ovrd_auth_https - Enable/disable use of HTTPS for override authentication. type: str choices: enable, disable more...
      Supported Version Ranges
      ovrd_auth_https v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • ovrd_auth_port - Port to use for FortiGuard Web Filter override authentication. type: int more...
      Supported Version Ranges
      ovrd_auth_port v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • ovrd_auth_port_http - Port to use for FortiGuard Web Filter HTTP override authentication. type: int more...
      Supported Version Ranges
      ovrd_auth_port_http v6.0.0 -> 7.4.3
    • ovrd_auth_port_https - Port to use for FortiGuard Web Filter HTTPS override authentication in proxy mode. type: int more...
      Supported Version Ranges
      ovrd_auth_port_https v6.0.0 -> 7.4.3
    • ovrd_auth_port_https_flow - Port to use for FortiGuard Web Filter HTTPS override authentication in flow mode. type: int more...
      Supported Version Ranges
      ovrd_auth_port_https_flow v6.2.0 -> 7.4.3
    • ovrd_auth_port_warning - Port to use for FortiGuard Web Filter Warning override authentication. type: int more...
      Supported Version Ranges
      ovrd_auth_port_warning v6.0.0 -> 7.4.3
    • request_packet_size_limit - Limit size of URL request packets sent to FortiGuard server (0 for default). type: int more...
      Supported Version Ranges
      request_packet_size_limit v6.0.0 -> 7.4.3
    • warn_auth_https - Enable/disable use of HTTPS for warning and authentication. type: str choices: enable, disable more...
      Supported Version Ranges
      warn_auth_https v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure FortiGuard Web Filter service.
  fortinet.fortios.fortios_webfilter_fortiguard:
      vdom: "{{ vdom }}"
      webfilter_fortiguard:
          cache_mem_percent: "2"
          cache_mem_permille: "1"
          cache_mode: "ttl"
          cache_prefix_match: "enable"
          close_ports: "enable"
          embed_image: "enable"
          ovrd_auth_https: "enable"
          ovrd_auth_port: "32767"
          ovrd_auth_port_http: "8008"
          ovrd_auth_port_https: "8010"
          ovrd_auth_port_https_flow: "8015"
          ovrd_auth_port_warning: "8020"
          request_packet_size_limit: "0"
          warn_auth_https: "enable"

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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.