W3cubDocs

/Ansible

fortinet.fortios.fortios_system_wccp – Configure WCCP in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.

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

New in version 2.10: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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.9.0

Parameters

Parameter		Choices/Defaults	Comments
access_token string			Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean		Choices: no ← yes	Enable/Disable logging for task.
state string / required		Choices: present absent	Indicates whether to create or remove the object.
system_wccp dictionary			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 list / elements=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.
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

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: Configure WCCP.
    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: "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

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_wccp_module.html