Avi HealthMonitor Object API
CLI ``` - configure healthmonitor - show healthmonitor ``` Examples - **healthmonitor_example**: To create a basic HTTP health monitor that uses GET / to determine if the service is alive ```json {'name': 'http-hmon', 'send_interval': 10, 'receive_timeout': 4, 'failed_checks': 3, 'type': 'HEALTH_MONITOR_HTTP', 'http_monitor': {'http_request': 'GET / HTTP/1.0'}} ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /healthmonitorpost /healthmonitordelete /healthmonitor/{uuid}get /healthmonitor/{uuid}/federated_info/get /healthmonitor/{uuid}patch /healthmonitor/{uuid}put /healthmonitor/{uuid}
(healthmonitorGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"tcp_monitor" : {
"tcp_response" : "aeiou",
"tcp_half_open" : true,
"tcp_request" : "aeiou",
"maintenance_response" : "aeiou"
},
"monitor_port" : 123,
"radius_monitor" : {
"password" : "aeiou",
"shared_secret" : "aeiou",
"username" : "aeiou"
},
"description" : "aeiou",
"pop3s_monitor" : "",
"external_monitor" : {
"command_path" : "aeiou",
"command_variables" : "aeiou",
"command_code" : "aeiou",
"command_parameters" : "aeiou"
},
"type" : "aeiou",
"uuid" : "aeiou",
"ldap_monitor" : {
"filter" : "aeiou",
"ssl_attributes" : "",
"base_dn" : "aeiou",
"scope" : "aeiou",
"attributes" : "aeiou"
},
"_last_modified" : "aeiou",
"send_interval" : 123,
"sctp_monitor" : {
"sctp_request" : "aeiou",
"sctp_response" : "aeiou"
},
"allow_duplicate_monitors" : true,
"smtp_monitor" : {
"ssl_attributes" : "",
"recipients_ids" : [ "aeiou" ],
"domainname" : "aeiou",
"mail_data" : "aeiou",
"sender_id" : "aeiou"
},
"successful_checks" : 123,
"receive_timeout" : 123,
"configpb_attributes" : {
"version" : 123
},
"is_federated" : true,
"authentication" : {
"password" : "aeiou",
"username" : "aeiou"
},
"disable_quickstart" : true,
"ftps_monitor" : "",
"dns_monitor" : {
"response_string" : "aeiou",
"qtype" : "aeiou",
"query_name" : "aeiou",
"rcode" : "aeiou",
"record_type" : "aeiou"
},
"failed_checks" : 123,
"http_monitor" : {
"http_response" : "aeiou",
"ssl_attributes" : "",
"auth_type" : "aeiou",
"exact_http_request" : true,
"http_request" : "aeiou",
"http_request_body" : "aeiou",
"response_size" : 123,
"http_response_code" : [ "aeiou" ],
"maintenance_code" : [ "" ],
"maintenance_response" : "aeiou"
},
"ftp_monitor" : {
"mode" : "aeiou",
"ssl_attributes" : {
"server_name" : "aeiou",
"pki_profile_ref" : "aeiou",
"ssl_key_and_certificate_ref" : "aeiou",
"ssl_profile_ref" : "aeiou"
},
"filename" : "aeiou"
},
"url" : "aeiou",
"imap_monitor" : {
"ssl_attributes" : "",
"folder" : "aeiou"
},
"imaps_monitor" : "",
"ldaps_monitor" : "",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"pop3_monitor" : {
"ssl_attributes" : ""
},
"smtps_monitor" : "",
"sip_monitor" : {
"sip_request_code" : "aeiou",
"sip_monitor_transport" : "aeiou",
"sip_response" : "aeiou"
},
"udp_monitor" : {
"udp_request" : "aeiou",
"udp_response" : "aeiou",
"maintenance_response" : "aeiou"
},
"https_monitor" : "",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
HealthMonitorApiResponse
401
log in failed
(healthmonitorPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — HealthMonitor object creation
Return type
Example data
Content-Type: application/json
{
"tcp_monitor" : {
"tcp_response" : "aeiou",
"tcp_half_open" : true,
"tcp_request" : "aeiou",
"maintenance_response" : "aeiou"
},
"monitor_port" : 123,
"radius_monitor" : {
"password" : "aeiou",
"shared_secret" : "aeiou",
"username" : "aeiou"
},
"description" : "aeiou",
"pop3s_monitor" : "",
"external_monitor" : {
"command_path" : "aeiou",
"command_variables" : "aeiou",
"command_code" : "aeiou",
"command_parameters" : "aeiou"
},
"type" : "aeiou",
"uuid" : "aeiou",
"ldap_monitor" : {
"filter" : "aeiou",
"ssl_attributes" : "",
"base_dn" : "aeiou",
"scope" : "aeiou",
"attributes" : "aeiou"
},
"_last_modified" : "aeiou",
"send_interval" : 123,
"sctp_monitor" : {
"sctp_request" : "aeiou",
"sctp_response" : "aeiou"
},
"allow_duplicate_monitors" : true,
"smtp_monitor" : {
"ssl_attributes" : "",
"recipients_ids" : [ "aeiou" ],
"domainname" : "aeiou",
"mail_data" : "aeiou",
"sender_id" : "aeiou"
},
"successful_checks" : 123,
"receive_timeout" : 123,
"configpb_attributes" : {
"version" : 123
},
"is_federated" : true,
"authentication" : {
"password" : "aeiou",
"username" : "aeiou"
},
"disable_quickstart" : true,
"ftps_monitor" : "",
"dns_monitor" : {
"response_string" : "aeiou",
"qtype" : "aeiou",
"query_name" : "aeiou",
"rcode" : "aeiou",
"record_type" : "aeiou"
},
"failed_checks" : 123,
"http_monitor" : {
"http_response" : "aeiou",
"ssl_attributes" : "",
"auth_type" : "aeiou",
"exact_http_request" : true,
"http_request" : "aeiou",
"http_request_body" : "aeiou",
"response_size" : 123,
"http_response_code" : [ "aeiou" ],
"maintenance_code" : [ "" ],
"maintenance_response" : "aeiou"
},
"ftp_monitor" : {
"mode" : "aeiou",
"ssl_attributes" : {
"server_name" : "aeiou",
"pki_profile_ref" : "aeiou",
"ssl_key_and_certificate_ref" : "aeiou",
"ssl_profile_ref" : "aeiou"
},
"filename" : "aeiou"
},
"url" : "aeiou",
"imap_monitor" : {
"ssl_attributes" : "",
"folder" : "aeiou"
},
"imaps_monitor" : "",
"ldaps_monitor" : "",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"pop3_monitor" : {
"ssl_attributes" : ""
},
"smtps_monitor" : "",
"sip_monitor" : {
"sip_request_code" : "aeiou",
"sip_monitor_transport" : "aeiou",
"sip_response" : "aeiou"
},
"udp_monitor" : {
"udp_request" : "aeiou",
"udp_response" : "aeiou",
"maintenance_response" : "aeiou"
},
"https_monitor" : "",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
HealthMonitor
401
log in failed
Up
delete /healthmonitor/{uuid}
(healthmonitorUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /healthmonitor/{uuid}/federated_info/
(healthmonitorUuidFederatedInfoGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /healthmonitor/{uuid}
(healthmonitorUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"tcp_monitor" : {
"tcp_response" : "aeiou",
"tcp_half_open" : true,
"tcp_request" : "aeiou",
"maintenance_response" : "aeiou"
},
"monitor_port" : 123,
"radius_monitor" : {
"password" : "aeiou",
"shared_secret" : "aeiou",
"username" : "aeiou"
},
"description" : "aeiou",
"pop3s_monitor" : "",
"external_monitor" : {
"command_path" : "aeiou",
"command_variables" : "aeiou",
"command_code" : "aeiou",
"command_parameters" : "aeiou"
},
"type" : "aeiou",
"uuid" : "aeiou",
"ldap_monitor" : {
"filter" : "aeiou",
"ssl_attributes" : "",
"base_dn" : "aeiou",
"scope" : "aeiou",
"attributes" : "aeiou"
},
"_last_modified" : "aeiou",
"send_interval" : 123,
"sctp_monitor" : {
"sctp_request" : "aeiou",
"sctp_response" : "aeiou"
},
"allow_duplicate_monitors" : true,
"smtp_monitor" : {
"ssl_attributes" : "",
"recipients_ids" : [ "aeiou" ],
"domainname" : "aeiou",
"mail_data" : "aeiou",
"sender_id" : "aeiou"
},
"successful_checks" : 123,
"receive_timeout" : 123,
"configpb_attributes" : {
"version" : 123
},
"is_federated" : true,
"authentication" : {
"password" : "aeiou",
"username" : "aeiou"
},
"disable_quickstart" : true,
"ftps_monitor" : "",
"dns_monitor" : {
"response_string" : "aeiou",
"qtype" : "aeiou",
"query_name" : "aeiou",
"rcode" : "aeiou",
"record_type" : "aeiou"
},
"failed_checks" : 123,
"http_monitor" : {
"http_response" : "aeiou",
"ssl_attributes" : "",
"auth_type" : "aeiou",
"exact_http_request" : true,
"http_request" : "aeiou",
"http_request_body" : "aeiou",
"response_size" : 123,
"http_response_code" : [ "aeiou" ],
"maintenance_code" : [ "" ],
"maintenance_response" : "aeiou"
},
"ftp_monitor" : {
"mode" : "aeiou",
"ssl_attributes" : {
"server_name" : "aeiou",
"pki_profile_ref" : "aeiou",
"ssl_key_and_certificate_ref" : "aeiou",
"ssl_profile_ref" : "aeiou"
},
"filename" : "aeiou"
},
"url" : "aeiou",
"imap_monitor" : {
"ssl_attributes" : "",
"folder" : "aeiou"
},
"imaps_monitor" : "",
"ldaps_monitor" : "",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"pop3_monitor" : {
"ssl_attributes" : ""
},
"smtps_monitor" : "",
"sip_monitor" : {
"sip_request_code" : "aeiou",
"sip_monitor_transport" : "aeiou",
"sip_response" : "aeiou"
},
"udp_monitor" : {
"udp_request" : "aeiou",
"udp_response" : "aeiou",
"maintenance_response" : "aeiou"
},
"https_monitor" : "",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
HealthMonitor
401
log in failed
Up
patch /healthmonitor/{uuid}
(healthmonitorUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — HealthMonitor object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"tcp_monitor" : {
"tcp_response" : "aeiou",
"tcp_half_open" : true,
"tcp_request" : "aeiou",
"maintenance_response" : "aeiou"
},
"monitor_port" : 123,
"radius_monitor" : {
"password" : "aeiou",
"shared_secret" : "aeiou",
"username" : "aeiou"
},
"description" : "aeiou",
"pop3s_monitor" : "",
"external_monitor" : {
"command_path" : "aeiou",
"command_variables" : "aeiou",
"command_code" : "aeiou",
"command_parameters" : "aeiou"
},
"type" : "aeiou",
"uuid" : "aeiou",
"ldap_monitor" : {
"filter" : "aeiou",
"ssl_attributes" : "",
"base_dn" : "aeiou",
"scope" : "aeiou",
"attributes" : "aeiou"
},
"_last_modified" : "aeiou",
"send_interval" : 123,
"sctp_monitor" : {
"sctp_request" : "aeiou",
"sctp_response" : "aeiou"
},
"allow_duplicate_monitors" : true,
"smtp_monitor" : {
"ssl_attributes" : "",
"recipients_ids" : [ "aeiou" ],
"domainname" : "aeiou",
"mail_data" : "aeiou",
"sender_id" : "aeiou"
},
"successful_checks" : 123,
"receive_timeout" : 123,
"configpb_attributes" : {
"version" : 123
},
"is_federated" : true,
"authentication" : {
"password" : "aeiou",
"username" : "aeiou"
},
"disable_quickstart" : true,
"ftps_monitor" : "",
"dns_monitor" : {
"response_string" : "aeiou",
"qtype" : "aeiou",
"query_name" : "aeiou",
"rcode" : "aeiou",
"record_type" : "aeiou"
},
"failed_checks" : 123,
"http_monitor" : {
"http_response" : "aeiou",
"ssl_attributes" : "",
"auth_type" : "aeiou",
"exact_http_request" : true,
"http_request" : "aeiou",
"http_request_body" : "aeiou",
"response_size" : 123,
"http_response_code" : [ "aeiou" ],
"maintenance_code" : [ "" ],
"maintenance_response" : "aeiou"
},
"ftp_monitor" : {
"mode" : "aeiou",
"ssl_attributes" : {
"server_name" : "aeiou",
"pki_profile_ref" : "aeiou",
"ssl_key_and_certificate_ref" : "aeiou",
"ssl_profile_ref" : "aeiou"
},
"filename" : "aeiou"
},
"url" : "aeiou",
"imap_monitor" : {
"ssl_attributes" : "",
"folder" : "aeiou"
},
"imaps_monitor" : "",
"ldaps_monitor" : "",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"pop3_monitor" : {
"ssl_attributes" : ""
},
"smtps_monitor" : "",
"sip_monitor" : {
"sip_request_code" : "aeiou",
"sip_monitor_transport" : "aeiou",
"sip_response" : "aeiou"
},
"udp_monitor" : {
"udp_request" : "aeiou",
"udp_response" : "aeiou",
"maintenance_response" : "aeiou"
},
"https_monitor" : "",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
HealthMonitor
401
log in failed
Up
put /healthmonitor/{uuid}
(healthmonitorUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — HealthMonitor object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"tcp_monitor" : {
"tcp_response" : "aeiou",
"tcp_half_open" : true,
"tcp_request" : "aeiou",
"maintenance_response" : "aeiou"
},
"monitor_port" : 123,
"radius_monitor" : {
"password" : "aeiou",
"shared_secret" : "aeiou",
"username" : "aeiou"
},
"description" : "aeiou",
"pop3s_monitor" : "",
"external_monitor" : {
"command_path" : "aeiou",
"command_variables" : "aeiou",
"command_code" : "aeiou",
"command_parameters" : "aeiou"
},
"type" : "aeiou",
"uuid" : "aeiou",
"ldap_monitor" : {
"filter" : "aeiou",
"ssl_attributes" : "",
"base_dn" : "aeiou",
"scope" : "aeiou",
"attributes" : "aeiou"
},
"_last_modified" : "aeiou",
"send_interval" : 123,
"sctp_monitor" : {
"sctp_request" : "aeiou",
"sctp_response" : "aeiou"
},
"allow_duplicate_monitors" : true,
"smtp_monitor" : {
"ssl_attributes" : "",
"recipients_ids" : [ "aeiou" ],
"domainname" : "aeiou",
"mail_data" : "aeiou",
"sender_id" : "aeiou"
},
"successful_checks" : 123,
"receive_timeout" : 123,
"configpb_attributes" : {
"version" : 123
},
"is_federated" : true,
"authentication" : {
"password" : "aeiou",
"username" : "aeiou"
},
"disable_quickstart" : true,
"ftps_monitor" : "",
"dns_monitor" : {
"response_string" : "aeiou",
"qtype" : "aeiou",
"query_name" : "aeiou",
"rcode" : "aeiou",
"record_type" : "aeiou"
},
"failed_checks" : 123,
"http_monitor" : {
"http_response" : "aeiou",
"ssl_attributes" : "",
"auth_type" : "aeiou",
"exact_http_request" : true,
"http_request" : "aeiou",
"http_request_body" : "aeiou",
"response_size" : 123,
"http_response_code" : [ "aeiou" ],
"maintenance_code" : [ "" ],
"maintenance_response" : "aeiou"
},
"ftp_monitor" : {
"mode" : "aeiou",
"ssl_attributes" : {
"server_name" : "aeiou",
"pki_profile_ref" : "aeiou",
"ssl_key_and_certificate_ref" : "aeiou",
"ssl_profile_ref" : "aeiou"
},
"filename" : "aeiou"
},
"url" : "aeiou",
"imap_monitor" : {
"ssl_attributes" : "",
"folder" : "aeiou"
},
"imaps_monitor" : "",
"ldaps_monitor" : "",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"pop3_monitor" : {
"ssl_attributes" : ""
},
"smtps_monitor" : "",
"sip_monitor" : {
"sip_request_code" : "aeiou",
"sip_monitor_transport" : "aeiou",
"sip_response" : "aeiou"
},
"udp_monitor" : {
"udp_request" : "aeiou",
"udp_response" : "aeiou",
"maintenance_response" : "aeiou"
},
"https_monitor" : "",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
HealthMonitor
401
log in failed
[ Jump to Methods ]
Table of Contents
ConfigPbAttributesHealthMonitorHealthMonitorApiResponseHealthMonitorAuthInfoHealthMonitorDNSHealthMonitorExternalHealthMonitorFtpHealthMonitorHttpHealthMonitorImapHealthMonitorLdapHealthMonitorPop3HealthMonitorRadiusHealthMonitorSIPHealthMonitorSSLAttributesHealthMonitorSctpHealthMonitorSmtpHealthMonitorTcpHealthMonitorUdpRoleFilterMatchLabel
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
allow_duplicate_monitors (optional)
Boolean By default, multiple instances of the same healthmonitor to the same server are suppressed intelligently. In rare cases, the monitor may have specific constructs that go beyond the server keys (ip, port, etc.) during which such suppression is not desired. Use this knob to allow duplicates. Field introduced in 18.2.8. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.
authentication (optional)
HealthMonitorAuthInfo Authentication information for username/password. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
description (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disable_quickstart (optional)
Boolean During addition of a server or healthmonitors or during bootup, Avi performs sequential health checks rather than waiting for send-interval to kick in, to mark the server up as soon as possible. This knob may be used to turn this feature off. Field introduced in 18.2.7. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
dns_monitor (optional)
HealthMonitorDNS Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
external_monitor (optional)
HealthMonitorExternal Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
failed_checks (optional)
Integer Number of continuous failed health checks before the server is marked down. Allowed values are 1-50. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
ftp_monitor (optional)
HealthMonitorFtp Health monitor for FTP. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ftps_monitor (optional)
HealthMonitorFtp Health monitor for FTPS. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
http_monitor (optional)
HealthMonitorHttp Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.
https_monitor (optional)
HealthMonitorHttp Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.
imap_monitor (optional)
HealthMonitorImap Health monitor for IMAP. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
imaps_monitor (optional)
HealthMonitorImap Health monitor for IMAPS. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
is_federated (optional)
Boolean This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. . Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
ldap_monitor (optional)
HealthMonitorLdap Health monitor for LDAP. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ldaps_monitor (optional)
HealthMonitorLdap Health monitor for LDAPS. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
monitor_port (optional)
Integer Use this port instead of the port defined for the server in the Pool. If the monitor succeeds to this port, the load balanced traffic will still be sent to the port of the server defined within the Pool. Allowed values are 1-65535. Special values are 0 - Use server port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
name
String A user friendly name for this health monitor. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pop3_monitor (optional)
HealthMonitorPop3 Health monitor for POP3. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
pop3s_monitor (optional)
HealthMonitorPop3 Health monitor for POP3S. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
radius_monitor (optional)
HealthMonitorRadius Health monitor for Radius. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
receive_timeout (optional)
Integer A valid response from the server is expected within the receive timeout window. This timeout must be less than the send interval. If server status is regularly flapping up and down, consider increasing this value. Allowed values are 1-2400. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
sctp_monitor (optional)
HealthMonitorSctp Health monitor for SCTP. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
send_interval (optional)
Integer Frequency, in seconds, that monitors are sent to a server. Allowed values are 1-3600. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
sip_monitor (optional)
HealthMonitorSIP Health monitor for SIP. Field introduced in 17.2.8, 18.1.3, 18.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
smtp_monitor (optional)
HealthMonitorSmtp Health monitor for SMTP. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
smtps_monitor (optional)
HealthMonitorSmtp Health monitor for SMTPS. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
successful_checks (optional)
Integer Number of continuous successful health checks before server is marked up. Allowed values are 1-50. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
tcp_monitor (optional)
HealthMonitorTcp Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Type of the health monitor. Enum options - HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP, HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB, HEALTH_MONITOR_SIP, HEALTH_MONITOR_RADIUS, HEALTH_MONITOR_SMTP, HEALTH_MONITOR_SMTPS, HEALTH_MONITOR_POP3, HEALTH_MONITOR_POP3S, HEALTH_MONITOR_IMAP, HEALTH_MONITOR_IMAPS, HEALTH_MONITOR_FTP, HEALTH_MONITOR_FTPS, HEALTH_MONITOR_LDAP, HEALTH_MONITOR_LDAPS, HEALTH_MONITOR_SCTP. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- HEALTH_MONITOR_PING,HEALTH_MONITOR_TCP,HEALTH_MONITOR_UDP), Basic edition(Allowed values- HEALTH_MONITOR_PING,HEALTH_MONITOR_TCP,HEALTH_MONITOR_UDP,HEALTH_MONITOR_HTTP,HEALTH_MONITOR_HTTPS), Enterprise with Cloud Services edition.
udp_monitor (optional)
HealthMonitorUdp Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String UUID of the health monitor. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
password
String Password for server authentication. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
username
String Username for server authentication. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
qtype (optional)
String Query_Type Response has atleast one answer of which the resource record type matches the query type Any_Type Response should contain atleast one answer AnyThing An empty answer is enough. Enum options - DNS_QUERY_TYPE, DNS_ANY_TYPE, DNS_ANY_THING. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
query_name
String The DNS monitor will query the DNS server for the fully qualified name in this field. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
rcode (optional)
String When No Error is selected, a DNS query will be marked failed is any error code is returned by the server. With Any selected, the monitor ignores error code in the responses. Enum options - RCODE_NO_ERROR, RCODE_ANYTHING. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
record_type (optional)
String Resource record type used in the healthmonitor DNS query, only A or AAAA type supported. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
response_string (optional)
String The resource record of the queried DNS server's response for the Request Name must include the IP address defined in this field. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
command_code
String Command script provided inline. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
command_parameters (optional)
String Optional arguments to feed into the script. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
command_path (optional)
String Path of external health monitor script. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
command_variables (optional)
String Environment variables to be fed into the script. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
filename
String Filename to download with full path. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mode
String FTP data transfer process mode. Enum options - FTP_PASSIVE_MODE, FTP_PORT_MODE. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ssl_attributes (optional)
HealthMonitorSSLAttributes SSL attributes for FTPS monitor. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
auth_type (optional)
String Type of the authentication method. Enum options - AUTH_BASIC, AUTH_NTLM. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
exact_http_request (optional)
Boolean Use the exact http_request string as specified by user, without any automatic insert of headers like Host header. Field introduced in 17.1.6,17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http_request (optional)
String Send an HTTP request to the server. The default GET / HTTP/1.0 may be extended with additional headers or information. For instance, GET /index.htm HTTP/1.1 Host www.site.com Connection Close. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http_request_body (optional)
String HTTP request body. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http_response (optional)
String Match for a keyword in the first 2Kb of the server header and body response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http_response_code (optional)
array[String] List of HTTP response codes to match as successful. Default is 2xx. Enum options - HTTP_ANY, HTTP_1XX, HTTP_2XX, HTTP_3XX, HTTP_4XX, HTTP_5XX. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
maintenance_code (optional)
array[Integer] Match or look for this HTTP response code indicating server maintenance. A successful match results in the server being marked down. Allowed values are 101-599. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
maintenance_response (optional)
String Match or look for this keyword in the first 2KB of server header and body response indicating server maintenance. A successful match results in the server being marked down. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
response_size (optional)
Integer Expected http/https response page size. Allowed values are 2048-16384. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
ssl_attributes (optional)
HealthMonitorSSLAttributes SSL attributes for HTTPS health monitor. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
folder (optional)
String Folder to access. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ssl_attributes (optional)
HealthMonitorSSLAttributes SSL attributes for IMAPS monitor. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
attributes (optional)
String Attributes which will be retrieved. commas can be used to delimit more than one attributes (example- cn,address,email). Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
base_dn
String DN(Distinguished Name) of a directory entry. which will be starting point of the search. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
filter (optional)
String Filter to search entries in specified scope. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
scope (optional)
String Search scope which can be base, one, sub. Enum options - LDAP_BASE_MODE, LDAP_ONE_MODE, LDAP_SUB_MODE. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ssl_attributes (optional)
HealthMonitorSSLAttributes SSL attributes for LDAPS monitor. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ssl_attributes (optional)
HealthMonitorSSLAttributes SSL attributes for POP3S monitor. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
password
String Radius monitor will query Radius server with this password. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
shared_secret
String Radius monitor will query Radius server with this shared secret. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
username
String Radius monitor will query Radius server with this username. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sip_monitor_transport (optional)
String Specify the transport protocol TCP or UDP, to be used for SIP health monitor. The default transport is UDP. Enum options - SIP_UDP_PROTO, SIP_TCP_PROTO. Field introduced in 17.2.14, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sip_request_code (optional)
String Specify the SIP request to be sent to the server. By default, SIP OPTIONS request will be sent. Enum options - SIP_OPTIONS. Field introduced in 17.2.8, 18.1.3, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sip_response (optional)
String Match for a keyword in the first 2KB of the server header and body response. By default, it matches for SIP/2.0. Field introduced in 17.2.8, 18.1.3, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pki_profile_ref (optional)
String PKI profile used to validate the SSL certificate presented by a server. It is a reference to an object of type PKIProfile. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_name (optional)
String Fully qualified DNS hostname which will be used in the TLS SNI extension in server connections indicating SNI is enabled. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ssl_key_and_certificate_ref (optional)
String Service engines will present this SSL certificate to the server. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ssl_profile_ref
String SSL profile defines ciphers and SSL versions to be used for healthmonitor traffic to the back-end servers. It is a reference to an object of type SSLProfile. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sctp_request (optional)
String Request data to send after completing the SCTP handshake. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sctp_response (optional)
String Match for the desired keyword in the first 2Kb of the server's SCTP response. If this field is left blank, no server response is required. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
domainname (optional)
String Sender domain name. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mail_data (optional)
String Mail data. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
recipients_ids (optional)
array[String] Mail recipients. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sender_id (optional)
String Mail sender. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ssl_attributes (optional)
HealthMonitorSSLAttributes SSL attributes for SMTPS monitor. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
maintenance_response (optional)
String Match or look for this keyword in the first 2KB of server's response indicating server maintenance. A successful match results in the server being marked down. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tcp_half_open (optional)
Boolean Configure TCP health monitor to use half-open TCP connections to monitor the health of backend servers thereby avoiding consumption of a full fledged server side connection and the overhead and logs associated with it. This method is light-weight as it makes use of listener in server's kernel layer to measure the health and a child socket or user thread is not created on the server side. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.
tcp_request (optional)
String Request data to send after completing the TCP handshake. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tcp_response (optional)
String Match for the desired keyword in the first 2Kb of the server's TCP response. If this field is left blank, no server response is required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
maintenance_response (optional)
String Match or look for this keyword in the first 2KB of server's response indicating server maintenance. A successful match results in the server being marked down. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
udp_request (optional)
String Send UDP request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
udp_response (optional)
String Match for keyword in the UDP response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.