ansible.builtin.fortios_webfilter_urlfilter (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 urlfilter 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 URL filter lists.
    fortios_webfilter_urlfilter:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      webfilter_urlfilter:
        state: "present"
        comment: "Optional comments."
        entries:
         -
            action: "exempt"
            dns-address-family: "ipv4"
            exempt: "av"
            id:  "8"
            referrer-host: "myhostname"
            status: "enable"
            type: "simple"
            url: "myurl.com"
            web-proxy-profile: "<your_own_value> (source web-proxy.profile.name)"
        id:  "14"
        ip-addr-block: "enable"
        name: "default_name_16"
        one-arm-ips-urlfilter: "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_urlfilter:
    default: null
    description:
    - Configure URL filter lists.
    suboptions:
      comment:
        description:
        - Optional comments.
      entries:
        description:
        - URL filter entries.
        suboptions:
          action:
            choices:
            - exempt
            - block
            - allow
            - monitor
            description:
            - Action to take for URL filter matches.
          dns-address-family:
            choices:
            - ipv4
            - ipv6
            - both
            description:
            - Resolve IPv4 address, IPv6 address, or both from DNS server.
          exempt:
            choices:
            - av
            - web-content
            - activex-java-cookie
            - dlp
            - fortiguard
            - range-block
            - pass
            - all
            description:
            - If action is set to exempt, select the security profile operations that
              exempt URLs skip. Separate multiple options with a space.
          id:
            description:
            - Id.
            required: true
          referrer-host:
            description:
            - Referrer host name.
          status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable this URL filter.
          type:
            choices:
            - simple
            - regex
            - wildcard
            description:
            - Filter type (simple, regex, or wildcard).
          url:
            description:
            - URL to be filtered.
          web-proxy-profile:
            description:
            - Web proxy profile. Source web-proxy.profile.name.
      id:
        description:
        - ID.
        required: true
      ip-addr-block:
        choices:
        - enable
        - disable
        description:
        - Enable/disable blocking URLs when the hostname appears as an IP address.
      name:
        description:
        - Name of URL filter list.
      one-arm-ips-urlfilter:
        choices:
        - enable
        - disable
        description:
        - Enable/disable DNS resolver for one-arm IPS URL filter operation.
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object

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