New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
firewall_ldb_monitor
-
|
Default: null
|
Configure server load balancing health monitors.
|
|
http-get
-
|
URL used to send a GET request to check the health of an HTTP server.
|
||
http-match
-
|
String to match the value expected in response to an HTTP-GET request.
|
||
http-max-redirects
-
|
The maximum number of HTTP redirects to be allowed (0 - 5, default = 0).
|
||
interval
-
|
Time between health checks (5 - 65635 sec, default = 10).
|
||
name
-
/ required
|
Monitor name.
|
||
port
-
|
Service port used to perform the health check. If 0, health check monitor inherits port configured for the server (0 - 65635, default = 0).
|
||
retry
-
|
Number health check attempts before the server is considered down (1 - 255, default = 3).
|
||
state
-
|
|
Indicates whether to create or remove the object
|
|
timeout
-
|
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
-
|
|
Select the Monitor type used by the health check monitor to check the health of the server (PING | TCP | HTTP).
|
|
host
-
/ required
|
FortiOS or FortiGate ip address.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
|
username
-
/ required
|
FortiOS or FortiGate username.
|
||
vdom
-
|
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.
|
Note
- 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"
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.