ansible.builtin.fortios_webfilter_fortiguard (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure webfilter feature and fortiguard category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

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

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure FortiGuard Web Filter service.
    fortios_webfilter_fortiguard:
      host:  "{{  host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{  vdom }}"
      webfilter_fortiguard:
        cache-mem-percent: "3"
        cache-mode: "ttl"
        cache-prefix-match: "enable"
        close-ports: "enable"
        ovrd-auth-https: "enable"
        ovrd-auth-port: "8"
        ovrd-auth-port-http: "9"
        ovrd-auth-port-https: "10"
        ovrd-auth-port-warning: "11"
        request-packet-size-limit: "12"
        warn-auth-https: "enable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

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.

https:
    default: false
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

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%).
      cache-mode:
        choices:
        - ttl
        - db-ver
        description:
        - Cache entry expiration mode.
      cache-prefix-match:
        choices:
        - enable
        - disable
        description:
        - Enable/disable prefix matching in the cache.
      close-ports:
        choices:
        - enable
        - disable
        description:
        - Close ports used for HTTP/HTTPS override authentication and disable user overrides.
      ovrd-auth-https:
        choices:
        - enable
        - disable
        description:
        - Enable/disable use of HTTPS for override authentication.
      ovrd-auth-port:
        description:
        - Port to use for FortiGuard Web Filter override authentication.
      ovrd-auth-port-http:
        description:
        - Port to use for FortiGuard Web Filter HTTP override authentication
      ovrd-auth-port-https:
        description:
        - Port to use for FortiGuard Web Filter HTTPS override authentication.
      ovrd-auth-port-warning:
        description:
        - Port to use for FortiGuard Web Filter Warning override authentication.
      request-packet-size-limit:
        description:
        - Limit size of URL request packets sent to FortiGuard server (0 for default).
      warn-auth-https:
        choices:
        - enable
        - disable
        description:
        - Enable/disable use of HTTPS for warning and authentication.

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