fortios_webfilter_urlfilter – Configure URL filter lists in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_webfilter_urlfilter – Configure URL filter lists in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- 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

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

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host - / required |  | FortiOS or FortiGate ip address.
https boolean | Choices: no ← yes | Indicates if the requests towards FortiGate must use HTTPS protocol
password - | Default: "" | FortiOS or FortiGate password.
username - / required |  | FortiOS or FortiGate username.
vdom - | Default: "root" | 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.
webfilter_urlfilter - | Default: null | Configure URL filter lists.
| comment - |  | Optional comments.
| entries - |  | URL filter entries.
|  | action - | Choices: exempt block allow monitor | Action to take for URL filter matches.
|  | dns-address-family - | Choices: ipv4 ipv6 both | Resolve IPv4 address, IPv6 address, or both from DNS server.
|  | exempt - | Choices: av web-content activex-java-cookie dlp fortiguard range-block pass all | If action is set to exempt, select the security profile operations that exempt URLs skip. Separate multiple options with a space.
|  | id - / required |  | Id.
|  | referrer-host - |  | Referrer host name.
|  | status - | Choices: enable disable | Enable/disable this URL filter.
|  | type - | Choices: simple regex wildcard | Filter type (simple, regex, or wildcard).
|  | url - |  | URL to be filtered.
|  | web-proxy-profile - |  | Web proxy profile. Source web-proxy.profile.name.
| id - / required |  | ID.
| ip-addr-block - | Choices: enable disable | Enable/disable blocking URLs when the hostname appears as an IP address.
| name - |  | Name of URL filter list.
| one-arm-ips-urlfilter - | Choices: enable disable | Enable/disable DNS resolver for one-arm IPS URL filter operation.
| state - | Choices: present absent | Indicates whether to create or remove the object

## Notes

Note

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - 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"

## Return Values

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

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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation you can edit this document to improve it.