lix_fortinet.fortios.fortios_webfilter_fortiguard (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure FortiGuard Web Filter service.
    fortios_webfilter_fortiguard:
      vdom:  "{{ vdom }}"
      webfilter_fortiguard:
        cache_mem_percent: "2"
        cache_mode: "ttl"
        cache_prefix_match: "enable"
        close_ports: "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"

Inputs

    
vdom:
    default: root
    description:
    - 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

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

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

webfilter_fortiguard:
    default: null
    description:
    - Configure FortiGuard Web Filter service.
    suboptions:
      cache_mem_percent:
        description:
        - Maximum percentage of available memory allocated to caching (1 - 15).
        type: int
      cache_mode:
        choices:
        - ttl
        - db-ver
        description:
        - Cache entry expiration mode.
        type: str
      cache_prefix_match:
        choices:
        - enable
        - disable
        description:
        - Enable/disable prefix matching in the cache.
        type: str
      close_ports:
        choices:
        - enable
        - disable
        description:
        - Close ports used for HTTP/HTTPS override authentication and disable user overrides.
        type: str
      ovrd_auth_https:
        choices:
        - enable
        - disable
        description:
        - Enable/disable use of HTTPS for override authentication.
        type: str
      ovrd_auth_port:
        description:
        - Port to use for FortiGuard Web Filter override authentication.
        type: int
      ovrd_auth_port_http:
        description:
        - Port to use for FortiGuard Web Filter HTTP override authentication.
        type: int
      ovrd_auth_port_https:
        description:
        - Port to use for FortiGuard Web Filter HTTPS override authentication in proxy
          mode.
        type: int
      ovrd_auth_port_https_flow:
        description:
        - Port to use for FortiGuard Web Filter HTTPS override authentication in flow
          mode.
        type: int
      ovrd_auth_port_warning:
        description:
        - Port to use for FortiGuard Web Filter Warning override authentication.
        type: int
      request_packet_size_limit:
        description:
        - Limit size of URL request packets sent to FortiGuard server (0 for default).
        type: int
      warn_auth_https:
        choices:
        - enable
        - disable
        description:
        - Enable/disable use of HTTPS for warning and authentication.
        type: str
    type: dict

Outputs

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