fortios_system_wccp – Configure WCCP 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 system feature and wccp 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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • system_wccp - Configure WCCP. type: dict more...
    • assignment_bucket_format - Assignment bucket format for the WCCP cache engine. type: str choices: wccp-v2, cisco-implementation more...
    • assignment_dstaddr_mask - Assignment destination address mask. type: str more...
    • assignment_method - Hash key assignment preference. type: str choices: HASH, MASK, any more...
    • assignment_srcaddr_mask - Assignment source address mask. type: str more...
    • assignment_weight - Assignment of hash weight/ratio for the WCCP cache engine. type: int more...
    • authentication - Enable/disable MD5 authentication. type: str choices: enable, disable more...
    • cache_engine_method - Method used to forward traffic to the routers or to return to the cache engine. type: str choices: GRE, L2 more...
    • cache_id - IP address known to all routers. If the addresses are the same, use the default 0.0.0.0. type: str more...
    • forward_method - Method used to forward traffic to the cache servers. type: str choices: GRE, L2, any more...
    • group_address - IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0. type: str more...
    • password - Password for MD5 authentication. type: str more...
    • ports - Service ports. type: list
    • ports_defined - Match method. type: str choices: source, destination more...
    • primary_hash - Hash method. type: list choices: src-ip, dst-ip, src-port, dst-port more...
    • priority - Service priority. type: int more...
    • protocol - Service protocol. type: int more...
    • return_method - Method used to decline a redirected packet and return it to the FortiGate unit. type: str choices: GRE, L2, any more...
    • router_id - IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0. type: str more...
    • router_list - IP addresses of one or more WCCP routers. type: list
    • server_list - IP addresses and netmasks for up to four cache servers. type: list
    • server_type - Cache server type. type: str choices: forward, proxy more...
    • service_id - Service ID. type: str required: true more...
    • service_type - WCCP service type used by the cache server for logical interception and redirection of traffic. type: str choices: auto, standard, dynamic more...

Notes

Note

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

Examples

- name: Configure WCCP.
  fortinet.fortios.fortios_system_wccp:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_wccp:
          assignment_bucket_format: "wccp-v2"
          assignment_dstaddr_mask: "<your_own_value>"
          assignment_method: "HASH"
          assignment_srcaddr_mask: "<your_own_value>"
          assignment_weight: "0"
          authentication: "enable"
          cache_engine_method: "GRE"
          cache_id: "<your_own_value>"
          forward_method: "GRE"
          group_address: "<your_own_value>"
          password: "<your_own_value>"
          ports: "<your_own_value>"
          ports_defined: "source"
          primary_hash: "src-ip"
          priority: "0"
          protocol: "0"
          return_method: "GRE"
          router_id: "<your_own_value>"
          router_list: "<your_own_value>"
          server_list: "<your_own_value>"
          server_type: "forward"
          service_id: "<your_own_value>"
          service_type: "auto"

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.