fortinet.fortios.fortios_firewall_ldb_monitor (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ldb_monitor category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure server load balancing health monitors.
  fortinet.fortios.fortios_firewall_ldb_monitor:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_ldb_monitor:
          dns_match_ip: "<your_own_value>"
          dns_protocol: "udp"
          dns_request_domain: "<your_own_value>"
          http_get: "<your_own_value>"
          http_match: "<your_own_value>"
          http_max_redirects: "0"
          interval: "10"
          name: "default_name_10"
          port: "0"
          retry: "3"
          src_ip: "<your_own_value>"
          timeout: "2"
          type: "ping"

Inputs

    
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

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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

firewall_ldb_monitor:
    default: null
    description:
    - Configure server load balancing health monitors.
    suboptions:
      dns_match_ip:
        description:
        - Response IP expected from DNS server.
        type: str
      dns_protocol:
        choices:
        - udp
        - tcp
        description:
        - Select the protocol used by the DNS health check monitor to check the health
          of the server (UDP | TCP).
        type: str
      dns_request_domain:
        description:
        - Fully qualified domain name to resolve for the DNS probe.
        type: str
      http_get:
        description:
        - URL used to send a GET request to check the health of an HTTP server.
        type: str
      http_match:
        description:
        - String to match the value expected in response to an HTTP-GET request.
        type: str
      http_max_redirects:
        description:
        - The maximum number of HTTP redirects to be allowed (0 - 5).
        type: int
      interval:
        description:
        - Time between health checks (5 - 65535 sec).
        type: int
      name:
        description:
        - Monitor name.
        required: true
        type: str
      port:
        description:
        - Service port used to perform the health check. If 0, health check monitor inherits
          port configured for the server (0 - 65535).
        type: int
      retry:
        description:
        - Number health check attempts before the server is considered down (1 - 255).
        type: int
      src_ip:
        description:
        - Source IP for ldb-monitor.
        type: str
      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).
        type: int
      type:
        choices:
        - ping
        - tcp
        - http
        - https
        - dns
        - passive-sip
        description:
        - Select the Monitor type used by the health check monitor to check the health
          of the server (PING | TCP | HTTP | HTTPS | DNS).
        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