fortinet.fortios.fortios_system_wccp module – Configure WCCP in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.9).
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_system_wccp.
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 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
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure WCCP. |
|
Assignment bucket format for the WCCP cache engine. Choices:
|
|
Assignment destination address mask. |
|
Hash key assignment preference. Choices:
|
|
Assignment source address mask. |
|
Assignment of hash weight/ratio for the WCCP cache engine. |
|
Enable/disable MD5 authentication. Choices:
|
|
Method used to forward traffic to the routers or to return to the cache engine. Choices:
|
|
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0. |
|
Method used to forward traffic to the cache servers. Choices:
|
|
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0. |
|
Password for MD5 authentication. |
|
Service ports. |
|
Match method. Choices:
|
|
Hash method. Choices:
|
|
Service priority. |
|
Service protocol. |
|
Method used to decline a redirected packet and return it to the FortiGate unit. Choices:
|
|
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0. |
|
IP addresses of one or more WCCP routers. |
|
IP addresses and netmasks for up to four cache servers. |
|
Cache server type. Choices:
|
|
Service ID. |
|
WCCP service type used by the cache server for logical interception and redirection of traffic. Choices:
|
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
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 here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |