GET /healthmonitor/{uuid}
/healthmonitor/{uuid}
UUID of the object to fetch
object name
List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
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.
Default values are not set.
It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Avi Tenant Header
Avi Tenant Header UUID
The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
OK
{
"_last_modified": "string",
"allow_duplicate_monitors": false,
"authentication": {
"password": "string",
"username": "string"
},
"configpb_attributes": {
"version": 0
},
"description": "string",
"disable_quickstart": false,
"dns_monitor": {
"qtype": "string",
"query_name": "string",
"rcode": "string",
"record_type": "string",
"response_string": "string"
},
"external_monitor": {
"command_code": "string",
"command_parameters": "string",
"command_path": "string",
"command_variables": "string"
},
"failed_checks": 0,
"ftp_monitor": {
"filename": "string",
"mode": "string",
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"ftps_monitor": {
"filename": "string",
"mode": "string",
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"http_monitor": {
"auth_type": "string",
"exact_http_request": false,
"http_request": "string",
"http_request_body": "string",
"http_response": "string",
"http_response_code": [
"string"
],
"maintenance_code": [
0
],
"maintenance_response": "string",
"response_size": 0,
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"https_monitor": {
"auth_type": "string",
"exact_http_request": false,
"http_request": "string",
"http_request_body": "string",
"http_response": "string",
"http_response_code": [
"string"
],
"maintenance_code": [
0
],
"maintenance_response": "string",
"response_size": 0,
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"imap_monitor": {
"folder": "string",
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"imaps_monitor": {
"folder": "string",
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"is_federated": false,
"ldap_monitor": {
"attributes": "string",
"base_dn": "string",
"filter": "string",
"scope": "string",
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"ldaps_monitor": {
"attributes": "string",
"base_dn": "string",
"filter": "string",
"scope": "string",
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"markers": [
{
"key": "string",
"values": [
"string"
]
}
],
"monitor_port": 0,
"name": "string",
"pop3_monitor": {
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"pop3s_monitor": {
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"radius_monitor": {
"password": "string",
"shared_secret": "string",
"username": "string"
},
"receive_timeout": 0,
"sctp_monitor": {
"sctp_request": "string",
"sctp_response": "string"
},
"send_interval": 0,
"sip_monitor": {
"sip_monitor_transport": "string",
"sip_request_code": "string",
"sip_response": "string"
},
"smtp_monitor": {
"domainname": "string",
"mail_data": "string",
"recipients_ids": [
"string"
],
"sender_id": "string",
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"smtps_monitor": {
"domainname": "string",
"mail_data": "string",
"recipients_ids": [
"string"
],
"sender_id": "string",
"ssl_attributes": {
"pki_profile_ref": "string",
"server_name": "string",
"ssl_key_and_certificate_ref": "string",
"ssl_profile_ref": "string"
}
},
"successful_checks": 0,
"tcp_monitor": {
"maintenance_response": "string",
"tcp_half_open": false,
"tcp_request": "string",
"tcp_response": "string"
},
"tenant_ref": "string",
"type": "string",
"udp_monitor": {
"maintenance_response": "string",
"udp_request": "string",
"udp_response": "string"
},
"url": "string",
"uuid": "string"
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
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
configpb_attributes
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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
external_monitor
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.
ftp_monitor
ftps_monitor
http_monitor
https_monitor
imap_monitor
imaps_monitor
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
ldaps_monitor
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.
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.
A user friendly name for this health monitor. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pop3_monitor
pop3s_monitor
radius_monitor
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.
sctp_monitor
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.
sip_monitor
smtp_monitor
smtps_monitor
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.
tcp_monitor
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 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
url
UUID of the health monitor. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
log in failed
curl -H 'Authorization: <value>' https://{api_host}/api/healthmonitor/{uuid}