ansible.builtin.fortios_firewall_ldb_monitor (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure firewall feature and ldb_monitor category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

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"
  tasks:
  - name: Configure server load balancing health monitors.
    fortios_firewall_ldb_monitor:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      firewall_ldb_monitor:
        state: "present"
        http-get: "<your_own_value>"
        http-match: "<your_own_value>"
        http-max-redirects: "5"
        interval: "6"
        name: "default_name_7"
        port: "8"
        retry: "9"
        timeout: "10"
        type: "ping"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

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.

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

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

username:
    description:
    - FortiOS or FortiGate username.
    required: true

firewall_ldb_monitor:
    default: null
    description:
    - Configure server load balancing health monitors.
    suboptions:
      http-get:
        description:
        - URL used to send a GET request to check the health of an HTTP server.
      http-match:
        description:
        - String to match the value expected in response to an HTTP-GET request.
      http-max-redirects:
        description:
        - The maximum number of HTTP redirects to be allowed (0 - 5, default = 0).
      interval:
        description:
        - Time between health checks (5 - 65635 sec, default = 10).
      name:
        description:
        - Monitor name.
        required: true
      port:
        description:
        - Service port used to perform the health check. If 0, health check monitor inherits
          port configured for the server (0 - 65635, default = 0).
      retry:
        description:
        - Number health check attempts before the server is considered down (1 - 255,
          default = 3).
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      timeout:
        description:
        - Time to wait to receive response to a health check from a server. Reaching the
          timeout means the health check failed (1 - 255 sec, default = 2).
      type:
        choices:
        - ping
        - tcp
        - http
        - passive-sip
        description:
        - Select the Monitor type used by the health check monitor to check the health
          of the server (PING | TCP | HTTP).

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