server-policy health
Use this command to configure server health checks.
Tests for server responsiveness (called “server health checks” in the web UI) poll web servers that are members of a server pool to determine their availability before forwarding traffic. Server health checks can use TCP, HTTP/HTTPS, ICMP ECHO_REQUEST
(ping
), TCP SSL, or TCP half-open.
The FortiWeb appliance polls the server at the frequency set in the interval <seconds_int> option. If the appliance does not receive a reply within the timeout period, and you have configured the health check to retry, it attempts a health check again; otherwise, the server is deemed unresponsive. The FortiWeb appliance reacts to unresponsive servers by disabling traffic to that server until it becomes responsive.
![]() |
If a back-end server will be unavailable for a long period, such as when a server is undergoing hardware repair, it is experiencing extended downtime, or when you have removed a server from the server pool, you can improve the performance of your FortiWeb appliance by disabling the back-end server, rather than allowing the server health check to continue to check for responsiveness. For details, see server-policy server-pool. |
To apply server health checks, select them in a server pool configuration. For details, see server-policy server-pool.
To use this command, your administrator account’s access control profile requires either w
or rw
permission to the traroutegrp
area. For details, see Permissions.
Syntax
config server-policy health
set trigger-policy "<trigger-policy_name>"
configure health-list
edit <entry_index>
set type {icmp | tcp | http | https | tcp-ssl | tcp-half-open}
set method {get | head | post}
set match-type {response-code | match-content | all}
set response-code {response-code_int}
set match-content "<match-content_str>"
next
end
Variable | Description | Default |
Enter the name of the server health check. The maximum length is 63 characters. To display the list of existing server health checks, enter:
|
No default. | |
Enter the name of the trigger to apply when the health check detects a failed server (see log trigger-policy). The maximum length is 63 characters. To display the list of existing trigger policies, enter:
|
No default. | |
|
and
|
|
Enter the index number of the individual rule in the table. The valid range is 1–16. | No default. | |
Select either:
|
ping
|
|
Enter the number of seconds which must pass after the server health check to indicate a failed health check. The valid range is 1–10 . |
|
|
Enter the number of times, if any, a failed health check will be retried before the server is determined to be unresponsive. The valid range is 1–10. |
|
|
Enter the number of seconds between each server health check. The valid range is from 1–10. |
10
|
|
Enter the URL, such as If the web server successfully returns this URL, and its content matches the expression specified by Available when type {icmp | tcp | http | https | tcp-ssl | tcp-half-open} is |
No default. | |
Specify whether the health check uses the HEAD, GET, or POST method. Available when type {icmp | tcp | http | https | tcp-ssl | tcp-half-open} is |
get
|
|
Optionally, enter the HTTP host header name of a specific host. This is useful if the pool member hosts multiple websites (virtual hosting environment). Available when type {icmp | tcp | http | https | tcp-ssl | tcp-half-open} is http or https . |
No default. | |
Available when type {icmp | tcp | http | https | tcp-ssl | tcp-half-open} is |
|
|
Enter the response code that you require the server to return to confirm that it is available, if Available when type {icmp | tcp | http | https | tcp-ssl | tcp-half-open} is |
200
|
|
Enter a regular expression that matches the content that must be present in the HTTP reply to indicate proper server connectivity, if Available when type {icmp | tcp | http | https | tcp-ssl | tcp-half-open} is |
No default. |
Example
This example configures a server health check that periodically requests the main page of the website, /index
. If a physical server does not successfully return that page (which contains the word “About”) every 10 seconds (the default), and fails the check at least three times in a row, FortiWeb considers it unresponsive and forwards subsequent HTTP requests to other physical servers in the server farm.
config server-policy health
edit "status_check1"
set trigger-policy "notification-servers1"
configure health-list
edit 1
set type http
set retry-times 3
set url-path "/index"
set method get
set match-type match-content
set regular About
next
end