fortinet.fortios.fortios_wanopt_webcache module – Configure global Web cache settings in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.1.6).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_wanopt_webcache.
New in version 2.0.0: of fortinet.fortios
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and webcache 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 |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
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. Default: “root” |
|
Configure global Web cache settings. |
|
Enable/disable revalidation of requested cached objects, which have content on the server, before serving it to the client. Choices:
|
|
Enable/disable caching content that lacks explicit caching policies from the server. Choices:
|
|
Enable/disable caching cookies. Since cookies contain information for or about individual users, they not usually cached. Choices:
|
|
Enable/disable caching type-1 objects that are already expired on arrival. Choices:
|
|
Default object expiry time . This only applies to those objects that do not have an expiry time set by the web server. |
|
Enable/disable external Web caching. Choices:
|
|
Frequency that the server is checked to see if any objects have expired (1 - 100). The higher the fresh factor, the less often the checks occur. |
|
Enable/disable validating “Host:” with original server IP. Choices:
|
|
Enable/disable controlling the behavior of cache-control HTTP 1.1 header values. Choices:
|
|
Enable/disable ignoring the PNC-interpretation of Internet Explorer”s Accept: / header. Choices:
|
|
Enable/disable ignoring the if-modified-since (IMS) header. Choices:
|
|
Enable/disable ignoring the pragma no-cache (PNC) header. Choices:
|
|
Maximum cacheable object size in kB (1 - 2147483 kb (2GB). All objects that exceed this are delivered to the client but not stored in the web cache. |
|
Maximum time an object can stay in the web cache without checking to see if it has expired on the server . |
|
Minimum time an object can stay in the web cache without checking to see if it has expired on the server . |
|
Time in minutes to cache negative responses or errors (0 - 4294967295). |
|
Enable/disable revalidation of pragma-no-cache (PNC) to address bandwidth concerns. Choices:
|
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 global Web cache settings.
fortios_wanopt_webcache:
vdom: "{{ vdom }}"
wanopt_webcache:
always_revalidate: "enable"
cache_by_default: "enable"
cache_cookie: "enable"
cache_expired: "enable"
default_ttl: "7"
external: "enable"
fresh_factor: "9"
host_validate: "enable"
ignore_conditional: "enable"
ignore_ie_reload: "enable"
ignore_ims: "enable"
ignore_pnc: "enable"
max_object_size: "15"
max_ttl: "16"
min_ttl: "17"
neg_resp_time: "18"
reval_pnc: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: “1547” |
|
Last method used to provision the content into FortiGate Returned: always Sample: “PUT” |
|
Last result given by FortiGate on last operation applied Returned: always Sample: “200” |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: “id” |
|
Name of the table used to fulfill the request Returned: always Sample: “urlfilter” |
|
Path of the table used to fulfill the request Returned: always Sample: “webfilter” |
|
Internal revision number Returned: always Sample: “17.0.2.10658” |
|
Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352” |
|
Indication of the operation’s result Returned: always Sample: “success” |
|
Virtual domain used Returned: always Sample: “root” |
|
Version of the FortiGate Returned: always 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)