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

New in version 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.15

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: 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
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • wanopt_cache_service - Designate cache-service for wan-optimization and webcache. type: dict more...
    • acceptable_connections - Set strategy when accepting cache collaboration connection. type: str choices: any, peers more...
    • collaboration - Enable/disable cache-collaboration between cache-service clusters. type: str choices: enable, disable more...
    • device_id - Set identifier for this cache device. type: str more...
    • dst_peer - Modify cache-service destination peer list. type: list member_path: dst_peer:device_id more...
      • auth_type - Set authentication type for this peer. type: int more...
      • device_id - Device ID of this peer. type: str required: true more...
      • encode_type - Set encode type for this peer. type: int more...
      • ip - Set cluster IP address of this peer. type: str more...
      • priority - Set priority for this peer. type: int more...
    • prefer_scenario - Set the preferred cache behavior towards the balance between latency and hit-ratio. type: str choices: balance, prefer-speed, prefer-cache more...
    • src_peer - Modify cache-service source peer list. type: list member_path: src_peer:device_id more...
      • auth_type - Set authentication type for this peer. type: int more...
      • device_id - Device ID of this peer. type: str required: true more...
      • encode_type - Set encode type for this peer. type: int more...
      • ip - Set cluster IP address of this peer. type: str more...
      • priority - Set priority for this peer. type: int more...

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Designate cache-service for wan-optimization and webcache.
  fortinet.fortios.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: 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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.