fortinet.fortimanager.fmgr_webfilter_urlfilter – Configure URL filter lists.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_webfilter_urlfilter.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
webfilter_urlfilter
dictionary
the top level parameters set
comment
string
Optional comments.
entries
list / elements=string
no description
action
string
    Choices:
  • exempt
  • block
  • allow
  • monitor
  • pass
Action to take for URL filter matches.
dns-address-family
string
    Choices:
  • ipv4
  • ipv6
  • both
Resolve IPv4 address, IPv6 address, or both from DNS server.
exempt
list / elements=string
    Choices:
  • av
  • web-content
  • activex-java-cookie
  • dlp
  • fortiguard
  • all
  • filepattern
  • pass
  • range-block
no description
id
integer
Id.
referrer-host
string
Referrer host name.
status
string
    Choices:
  • disable
  • enable
Enable/disable this URL filter.
type
string
    Choices:
  • simple
  • regex
  • wildcard
Filter type (simple, regex, or wildcard).
url
string
URL to be filtered.
web-proxy-profile
string
Web proxy profile.
id
integer
ID.
ip-addr-block
string
    Choices:
  • disable
  • enable
Enable/disable blocking URLs when the hostname appears as an IP address.
name
string
Name of URL filter list.
one-arm-ips-urlfilter
string
    Choices:
  • disable
  • enable
Enable/disable DNS resolver for one-arm IPS URL filter operation.
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state present directive.
  • To delete an object, use state absent directive.
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure URL filter lists.
     fmgr_webfilter_urlfilter:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        webfilter_urlfilter:
           comment: <value of string>
           entries:
             -
                 action: <value in [exempt, block, allow, ...]>
                 dns-address-family: <value in [ipv4, ipv6, both]>
                 exempt:
                   - av
                   - web-content
                   - activex-java-cookie
                   - dlp
                   - fortiguard
                   - all
                   - filepattern
                   - pass
                   - range-block
                 id: <value of integer>
                 referrer-host: <value of string>
                 status: <value in [disable, enable]>
                 type: <value in [simple, regex, wildcard]>
                 url: <value of string>
                 web-proxy-profile: <value of string>
           id: <value of integer>
           ip-addr-block: <value in [disable, enable]>
           name: <value of string>
           one-arm-ips-urlfilter: <value in [disable, enable]>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request
response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_webfilter_urlfilter_module.html