fortios_wanopt_webcache – Configure global Web cache settings in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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¶
- 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
- wanopt_webcache - Configure global Web cache settings. type: dict
- always_revalidate - Enable/disable revalidation of requested cached objects, which have content on the server, before serving it to the client. type: str choices: enable, disable
- cache_by_default - Enable/disable caching content that lacks explicit caching policies from the server. type: str choices: enable, disable
- cache_cookie - Enable/disable caching cookies. Since cookies contain information for or about individual users, they not usually cached. type: str choices: enable, disable
- cache_expired - Enable/disable caching type-1 objects that are already expired on arrival. type: str choices: enable, disable
- default_ttl - Default object expiry time . This only applies to those objects that do not have an expiry time set by the web server. type: int
- external - Enable/disable external Web caching. type: str choices: enable, disable
- fresh_factor - 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. type: int
- host_validate - Enable/disable validating "Host:" with original server IP. type: str choices: enable, disable
- ignore_conditional - Enable/disable controlling the behavior of cache-control HTTP 1.1 header values. type: str choices: enable, disable
- ignore_ie_reload - Enable/disable ignoring the PNC-interpretation of Internet Explorer"s Accept: / header. type: str choices: enable, disable
- ignore_ims - Enable/disable ignoring the if-modified-since (IMS) header. type: str choices: enable, disable
- ignore_pnc - Enable/disable ignoring the pragma no-cache (PNC) header. type: str choices: enable, disable
- max_object_size - 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. type: int
- max_ttl - Maximum time an object can stay in the web cache without checking to see if it has expired on the server . type: int
- min_ttl - Minimum time an object can stay in the web cache without checking to see if it has expired on the server . type: int
- neg_resp_time - Time in minutes to cache negative responses or errors (0 - 4294967295). type: int
- reval_pnc - Enable/disable revalidation of pragma-no-cache (PNC) to address bandwidth concerns. type: str choices: enable, disable
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: 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