fortinet.fortios.fortios_wanopt_cache_service module – Designate cache-service for wan-optimization and webcache in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.0).

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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_wanopt_cache_service.

New in fortinet.fortios 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and cache_service 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

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

vdom

string

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"

wanopt_cache_service

dictionary

Designate cache-service for wan-optimization and webcache.

acceptable_connections

string

Set strategy when accepting cache collaboration connection.

Choices:

  • "any"

  • "peers"

collaboration

string

Enable/disable cache-collaboration between cache-service clusters.

Choices:

  • "enable"

  • "disable"

device_id

string

Set identifier for this cache device.

dst_peer

list / elements=dictionary

Modify cache-service destination peer list.

auth_type

integer

Set authentication type for this peer.

device_id

string / required

Device ID of this peer.

encode_type

integer

Set encode type for this peer.

ip

string

Set cluster IP address of this peer.

priority

integer

Set priority for this peer.

prefer_scenario

string

Set the preferred cache behavior towards the balance between latency and hit-ratio.

Choices:

  • "balance"

  • "prefer-speed"

  • "prefer-cache"

src_peer

list / elements=dictionary

Modify cache-service source peer list.

auth_type

integer

Set authentication type for this peer.

device_id

string / required

Device ID of this peer.

encode_type

integer

Set encode type for this peer.

ip

string

Set cluster IP address of this peer.

priority

integer

Set priority for this peer.

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: Designate cache-service for wan-optimization and webcache.
    fortios_wanopt_cache_service:
      vdom:  "{{ vdom }}"
      wanopt_cache_service:
        acceptable_connections: "any"
        collaboration: "enable"
        device_id: "<your_own_value>"
        dst_peer:
         -
            auth_type: "0"
            device_id: "<your_own_value>"
            encode_type: "0"
            ip: "<your_own_value>"
            priority: "1"
        prefer_scenario: "balance"
        src_peer:
         -
            auth_type: "0"
            device_id: "<your_own_value>"
            encode_type: "0"
            ip: "<your_own_value>"
            priority: "1"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

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)