ansible.builtin.fortios_system_wccp (v2.9.27) — module

Configure WCCP in Fortinet's FortiOS and FortiGate.

| "added in version" 2.9 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

vdom:
    default: root
    description:
    - 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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

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

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str