fortinet.fortios.fortios_wanopt_webcache – Configure global Web cache settings in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.10: 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 | Choices/Defaults | Comments | |
|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
|
| 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.
|
|
| wanopt_webcache
dictionary
|
Configure global Web cache settings.
|
||
| always_revalidate
string
|
|
Enable/disable revalidation of requested cached objects, which have content on the server, before serving it to the client.
|
|
| cache_by_default
string
|
|
Enable/disable caching content that lacks explicit caching policies from the server.
|
|
| cache_cookie
string
|
|
Enable/disable caching cookies. Since cookies contain information for or about individual users, they not usually cached.
|
|
| cache_expired
string
|
|
Enable/disable caching type-1 objects that are already expired on arrival.
|
|
| default_ttl
integer
|
Default object expiry time . This only applies to those objects that do not have an expiry time set by the web server.
|
||
| external
string
|
|
Enable/disable external Web caching.
|
|
| fresh_factor
integer
|
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.
|
||
| host_validate
string
|
|
Enable/disable validating "Host:" with original server IP.
|
|
| ignore_conditional
string
|
|
Enable/disable controlling the behavior of cache-control HTTP 1.1 header values.
|
|
| ignore_ie_reload
string
|
|
Enable/disable ignoring the PNC-interpretation of Internet Explorer"s Accept: / header.
|
|
| ignore_ims
string
|
|
Enable/disable ignoring the if-modified-since (IMS) header.
|
|
| ignore_pnc
string
|
|
Enable/disable ignoring the pragma no-cache (PNC) header.
|
|
| max_object_size
integer
|
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.
|
||
| max_ttl
integer
|
Maximum time an object can stay in the web cache without checking to see if it has expired on the server .
|
||
| min_ttl
integer
|
Minimum time an object can stay in the web cache without checking to see if it has expired on the server .
|
||
| neg_resp_time
integer
|
Time in minutes to cache negative responses or errors (0 - 4294967295).
|
||
| reval_pnc
string
|
|
Enable/disable revalidation of pragma-no-cache (PNC) to address bandwidth concerns.
|
|
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 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 | 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_wanopt_webcache_module.html