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

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 wanopt feature and cache_service category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• 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: Designate cache-service for wan-optimization and webcache.
    fortios_wanopt_cache_service:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      wanopt_cache_service:
        acceptable_connections: "any"
        collaboration: "enable"
        device_id: "<your_own_value>"
        dst_peer:
         -
            auth_type: "7"
            device_id: "<your_own_value>"
            encode_type: "9"
            ip: "<your_own_value>"
            priority: "11"
        prefer_scenario: "balance"
        src_peer:
         -
            auth_type: "14"
            device_id: "<your_own_value>"
            encode_type: "16"
            ip: "<your_own_value>"
            priority: "18"

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

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

wanopt_cache_service:
    default: null
    description:
    - Designate cache-service for wan-optimization and webcache.
    suboptions:
      acceptable_connections:
        choices:
        - any
        - peers
        description:
        - Set strategy when accepting cache collaboration connection.
        type: str
      collaboration:
        choices:
        - enable
        - disable
        description:
        - Enable/disable cache-collaboration between cache-service clusters.
        type: str
      device_id:
        description:
        - Set identifier for this cache device.
        type: str
      dst_peer:
        description:
        - Modify cache-service destination peer list.
        suboptions:
          auth_type:
            description:
            - Set authentication type for this peer.
            type: int
          device_id:
            description:
            - Device ID of this peer.
            type: str
          encode_type:
            description:
            - Set encode type for this peer.
            type: int
          ip:
            description:
            - Set cluster IP address of this peer.
            type: str
          priority:
            description:
            - Set priority for this peer.
            type: int
        type: list
      prefer_scenario:
        choices:
        - balance
        - prefer-speed
        - prefer-cache
        description:
        - Set the preferred cache behavior towards the balance between latency and hit-ratio.
        type: str
      src_peer:
        description:
        - Modify cache-service source peer list.
        suboptions:
          auth_type:
            description:
            - Set authentication type for this peer.
            type: int
          device_id:
            description:
            - Device ID of this peer.
            type: str
          encode_type:
            description:
            - Set encode type for this peer.
            type: int
          ip:
            description:
            - Set cluster IP address of this peer.
            type: str
          priority:
            description:
            - Set priority for this peer.
            type: int
        type: list
    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