HealthCheckConfiguration

HealthCheckConfiguration
HealthCheckConfiguration

Load balancer health check configuration.

JSON Example
{
    "protocol": "HTTP, HTTPS",
    "port": "80",
    "urlPath": "/index.html",
    "intervalSeconds": 60,
    "timeoutSeconds": 5,
    "unhealthyThreshold": 5,
    "healthyThreshold": 2,
    "httpMethod": "GET, OPTIONS, POST, HEAD, PUT",
    "requestBody": "http_request.body",
    "responseBody": "http_response.body",
    "passiveMonitor": false
}
string
protocol
Optional

The protocol used for the health check.

string
port
Optional

Port on the back-end instance machine to use for the health check.

string
urlPath
Optional

URL path on the back-end instance against which a request will be performed for the health check. Useful when the health check protocol is HTTP/HTTPS.

integer As int32 As int32
intervalSeconds
Optional

Interval (in seconds) at which the health checks will be performed.

integer As int32 As int32
timeoutSeconds
Optional

Timeout (in seconds) to wait for a response from the back-end instance.

integer As int32 As int32
unhealthyThreshold
Optional

Number of consecutive check failures before considering a particular back-end instance as unhealthy.

integer As int32 As int32
healthyThreshold
Optional

Number of consecutive successful checks before considering a particular back-end instance as healthy.

string
httpMethod
Optional

HTTP or HTTPS method to use when sending a health check request.

string
requestBody
Optional

Request body. Used by HTTP, HTTPS, TCP, UDP.

string
responseBody
Optional

Expected response body. Used by HTTP, HTTPS, TCP, UDP.

boolean
passiveMonitor
Optional

Enable passive monitor mode. This setting only applies to NSX Manager.

Property Of