source: | fortios_webfilter_urlfilter.py |
---|---|
orphan: |
.. versionadded:: 2.0.0
- 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
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_webfilter_urlfilter | v6.0.0 -> latest |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- webfilter_urlfilter - Configure URL filter lists. type: dict
more...
Supported Version Ranges webfilter_urlfilter v6.0.0 -> latest
- comment - Optional comments. type: str
more...
Supported Version Ranges comment v6.0.0 -> latest
- entries - URL filter entries. type: list member_path: entries:id
more...
Supported Version Ranges entries v6.0.0 -> latest
- action - Action to take for URL filter matches. type: str choices: exempt, block, allow, monitor
more...
Supported Version Ranges action v6.0.0 -> latest
[exempt] v6.0.0 -> latest
[block] v6.0.0 -> latest
[allow] v6.0.0 -> latest
[monitor] v6.0.0 -> latest
- antiphish_action - Action to take for AntiPhishing matches. type: str choices: block, log
more...
Supported Version Ranges antiphish_action v6.4.0 -> latest
[block] v6.0.0 -> latest
[log] v6.0.0 -> latest
- dns_address_family - Resolve IPv4 address, IPv6 address, or both from DNS server. type: str choices: ipv4, ipv6, both
more...
Supported Version Ranges dns_address_family v6.0.0 -> latest
[ipv4] v6.0.0 -> latest
[ipv6] v6.0.0 -> latest
[both] v6.0.0 -> latest
- exempt - If action is set to exempt, select the security profile operations that exempt URLs skip. Separate multiple options with a space. type: list choices: av, web-content, activex-java-cookie, dlp, fortiguard, range-block, pass, antiphish, all
more...
Supported Version Ranges exempt v6.0.0 -> latest
[av] v6.0.0 -> latest
[web-content] v6.0.0 -> latest
[activex-java-cookie] v6.0.0 -> latest
[dlp] v6.0.0 -> latest
[fortiguard] v6.0.0 -> latest
[range-block] v6.0.0 -> latest
[pass] v6.0.0 -> latest
[antiphish] v6.4.0 -> latest
[all] v6.0.0 -> latest
- id - Id. see Notes. type: int required: true
more...
Supported Version Ranges id v6.0.0 -> latest
- referrer_host - Referrer host name. type: str
more...
Supported Version Ranges referrer_host v6.0.0 -> latest
- status - Enable/disable this URL filter. type: str choices: enable, disable
more...
Supported Version Ranges status v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- type - Filter type (simple, regex, or wildcard). type: str choices: simple, regex, wildcard
more...
Supported Version Ranges type v6.0.0 -> latest
[simple] v6.0.0 -> latest
[regex] v6.0.0 -> latest
[wildcard] v6.0.0 -> latest
- url - URL to be filtered. type: str
more...
Supported Version Ranges url v6.0.0 -> latest
- web_proxy_profile - Web proxy profile. Source web-proxy.profile.name. type: str
more...
Supported Version Ranges web_proxy_profile v6.0.0 -> latest
- id - ID. see Notes. type: int required: true
more...
Supported Version Ranges id v6.0.0 -> latest
- ip_addr_block - Enable/disable blocking URLs when the hostname appears as an IP address. type: str choices: enable, disable
more...
Supported Version Ranges ip_addr_block v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ip4_mapped_ip6 - Enable/disable matching of IPv4 mapped IPv6 URLs. type: str choices: enable, disable
more...
Supported Version Ranges ip4_mapped_ip6 v7.2.4 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- name - Name of URL filter list. type: str
more...
Supported Version Ranges name v6.0.0 -> latest
- one_arm_ips_urlfilter - Enable/disable DNS resolver for one-arm IPS URL filter operation. type: str choices: enable, disable
more...
Supported Version Ranges one_arm_ips_urlfilter v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
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
- 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"
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.