fortinet.fortios.fortios_webfilter_urlfilter – Configure URL filter lists in Fortinet’s FortiOS and FortiGate.
fortinet.fortios.fortios_webfilter_urlfilter – Configure URL filter lists in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
To install it use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_webfilter_urlfilter
.
New in version 2.8: of fortinet.fortios
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.9.0
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string |
Token-based authentication. Generated from GUI of Fortigate. | |||
state string added in 2.9 of fortinet.fortios |
|
Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. | ||
vdom string |
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 dictionary |
Configure URL filter lists. | |||
comment string |
Optional comments. | |||
entries list / elements=string |
URL filter entries. | |||
action string |
|
Action to take for URL filter matches. | ||
dns_address_family string |
|
Resolve IPv4 address, IPv6 address, or both from DNS server. | ||
exempt string |
|
If action is set to exempt, select the security profile operations that exempt URLs skip. Separate multiple options with a space. | ||
id integer / required |
Id. | |||
referrer_host string |
Referrer host name. | |||
status string |
|
Enable/disable this URL filter. | ||
type string |
|
Filter type (simple, regex, or wildcard). | ||
url string |
URL to be filtered. | |||
web_proxy_profile string |
Web proxy profile. Source web-proxy.profile.name. | |||
id integer / required |
ID. | |||
ip_addr_block string |
|
Enable/disable blocking URLs when the hostname appears as an IP address. | ||
name string |
Name of URL filter list. | |||
one_arm_ips_urlfilter string |
|
Enable/disable DNS resolver for one-arm IPS URL filter operation. | ||
state string |
|
Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- 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 URL filter lists.
fortios_webfilter_urlfilter:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
webfilter_urlfilter:
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 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_webfilter_urlfilter_module.html