fortinet.fortios.fortios_webfilter_urlfilter module – Configure URL filter lists in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.8).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_webfilter_urlfilter.

New in fortinet.fortios 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 urlfilter 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

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"

  • "absent"

vdom

string

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.

Default: "root"

webfilter_urlfilter

dictionary

Configure URL filter lists.

comment

string

Optional comments.

entries

list / elements=dictionary

URL filter entries.

action

string

Action to take for URL filter matches.

Choices:

  • "exempt"

  • "block"

  • "allow"

  • "monitor"

antiphish_action

string

Action to take for AntiPhishing matches.

Choices:

  • "block"

  • "log"

dns_address_family

string

Resolve IPv4 address, IPv6 address, or both from DNS server.

Choices:

  • "ipv4"

  • "ipv6"

  • "both"

exempt

list / elements=string

If action is set to exempt, select the security profile operations that exempt URLs skip. Separate multiple options with a space.

Choices:

  • "av"

  • "web-content"

  • "activex-java-cookie"

  • "dlp"

  • "fortiguard"

  • "range-block"

  • "pass"

  • "antiphish"

  • "all"

id

integer / required

Id. see <a href=’#notes’>Notes</a>.

referrer_host

string

Referrer host name.

status

string

Enable/disable this URL filter.

Choices:

  • "enable"

  • "disable"

type

string

Filter type (simple, regex, or wildcard).

Choices:

  • "simple"

  • "regex"

  • "wildcard"

url

string

URL to be filtered.

web_proxy_profile

string

Web proxy profile. Source web-proxy.profile.name.

id

integer / required

ID. see <a href=’#notes’>Notes</a>.

ip4_mapped_ip6

string

Enable/disable matching of IPv4 mapped IPv6 URLs.

Choices:

  • "enable"

  • "disable"

ip_addr_block

string

Enable/disable blocking URLs when the hostname appears as an IP address.

Choices:

  • "enable"

  • "disable"

name

string

Name of URL filter list.

one_arm_ips_urlfilter

string

Enable/disable DNS resolver for one-arm IPS URL filter operation.

Choices:

  • "enable"

  • "disable"

Notes

Note

  • We highly recommend using your own value as the id instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.

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

  • The module supports check_mode.

Examples

- name: Configure URL filter lists.
  fortinet.fortios.fortios_webfilter_urlfilter:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      webfilter_urlfilter:
          comment: "Optional comments."
          entries:
              -
                  action: "exempt"
                  antiphish_action: "block"
                  dns_address_family: "ipv4"
                  exempt: "av"
                  id: "9"
                  referrer_host: "myhostname"
                  status: "enable"
                  type: "simple"
                  url: "myurl.com"
                  web_proxy_profile: "<your_own_value> (source web-proxy.profile.name)"
          id: "15"
          ip_addr_block: "enable"
          ip4_mapped_ip6: "enable"
          name: "default_name_18"
          one_arm_ips_urlfilter: "enable"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

Sample: "v5.6.3"

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)