fortios_webfilter_override – Configure FortiGuard Web Filter administrative overrides in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and override 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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- state - 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. type: str required: False choices: present, absent
- webfilter_override - Configure FortiGuard Web Filter administrative overrides. type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- expires - Override expiration date and time, from 5 minutes to 365 from now (format: yyyy/mm/dd hh:mm:ss). type: str
- id - Override rule ID. type: int required: True
- initiator - Initiating user of override (read-only setting). type: str
- ip - IPv4 address which the override applies. type: str
- ip6 - IPv6 address which the override applies. type: str
- new_profile - Name of the new web filter profile used by the override. Source webfilter.profile.name. type: str
- old_profile - Name of the web filter profile which the override applies. Source webfilter.profile.name. type: str
- scope - Override either the specific user, user group, IPv4 address, or IPv6 address. type: str choices: user, user-group, ip, ip6
- status - Enable/disable override rule. type: str choices: enable, disable
- user - Name of the user which the override applies. type: str
- user_group - Specify the user group for which the override applies. Source user.group.name. type: str
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 FortiGuard Web Filter administrative overrides.
fortios_webfilter_override:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
webfilter_override:
expires: "<your_own_value>"
id: "4"
initiator: "<your_own_value>"
ip: "<your_own_value>"
ip6: "<your_own_value>"
new_profile: "<your_own_value> (source webfilter.profile.name)"
old_profile: "<your_own_value> (source webfilter.profile.name)"
scope: "user"
status: "enable"
user: "<your_own_value>"
user_group: "<your_own_value> (source user.group.name)"
Return Values¶
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