fortios_system_wccp – Configure WCCP in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_system_wccp – Configure WCCP in Fortinet’s FortiOS and FortiGate

New in version 2.9.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## 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.5

## Requirements

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
password string | Default: "" | FortiOS or FortiGate password.
ssl_verify boolean | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
state string / required | Choices: present absent | Indicates whether to create or remove the object.
system_wccp dictionary | Default: null | Configure WCCP.
| assignment_bucket_format string | Choices: wccp-v2 cisco-implementation | Assignment bucket format for the WCCP cache engine.
| assignment_dstaddr_mask string |  | Assignment destination address mask.
| assignment_method string | Choices: HASH MASK any | Hash key assignment preference.
| assignment_srcaddr_mask string |  | Assignment source address mask.
| assignment_weight integer |  | Assignment of hash weight/ratio for the WCCP cache engine.
| authentication string | Choices: enable disable | Enable/disable MD5 authentication.
| cache_engine_method string | Choices: GRE L2 | Method used to forward traffic to the routers or to return to the cache engine.
| cache_id string |  | IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
| forward_method string | Choices: GRE L2 any | Method used to forward traffic to the cache servers.
| group_address string |  | IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
| password string |  | Password for MD5 authentication.
| ports string |  | Service ports.
| ports_defined string | Choices: source destination | Match method.
| primary_hash string | Choices: src-ip dst-ip src-port dst-port | Hash method.
| priority integer |  | Service priority.
| protocol integer |  | Service protocol.
| return_method string | Choices: GRE L2 any | Method used to decline a redirected packet and return it to the FortiGate.
| router_id string |  | IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
| router_list string |  | IP addresses of one or more WCCP routers.
| server_list string |  | IP addresses and netmasks for up to four cache servers.
| server_type string | Choices: forward proxy | Cache server type.
| service_id string |  | Service ID.
| service_type string | Choices: auto standard dynamic | WCCP service type used by the cache server for logical interception and redirection of traffic.
username string |  | FortiOS or FortiGate username.
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.

## Notes

Note

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
       ssl_verify: "False"
      tasks:
      - name: Configure WCCP.
        fortios_system_wccp:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          system_wccp:
            assignment_bucket_format: "wccp-v2"
            assignment_dstaddr_mask: "<your_own_value>"
            assignment_method: "HASH"
            assignment_srcaddr_mask: "<your_own_value>"
            assignment_weight: "7"
            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: "17"
            protocol: "18"
            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 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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.