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 {u'receive_timeout': 4, u'name': u'http-hmon', u'failed_checks': 3, u'send_interval': 10, u'http_monitor': {u'http_request': u'GET / HTTP/1.0'}, u'type': u'HEALTH_MONITOR_HTTP'} ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /healthmonitor
  2. post /healthmonitor
  3. delete /healthmonitor/{uuid}
  4. get /healthmonitor/{uuid}/federated_info/
  5. get /healthmonitor/{uuid}
  6. patch /healthmonitor/{uuid}
  7. put /healthmonitor/{uuid}
Up
get /healthmonitor
(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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

HealthMonitorApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "tcp_monitor" : {
      "tcp_response" : "aeiou",
      "tcp_half_open" : true,
      "tcp_request" : "aeiou",
      "maintenance_response" : "aeiou"
    },
    "dns_monitor" : {
      "response_string" : "aeiou",
      "qtype" : "aeiou",
      "query_name" : "aeiou",
      "rcode" : "aeiou"
    },
    "failed_checks" : 123,
    "monitor_port" : 123,
    "http_monitor" : {
      "http_response" : "aeiou",
      "ssl_attributes" : {
        "pki_profile_ref" : "aeiou",
        "ssl_key_and_certificate_ref" : "aeiou",
        "ssl_profile_ref" : "aeiou"
      },
      "exact_http_request" : true,
      "http_request" : "aeiou",
      "http_response_code" : [ "aeiou" ],
      "maintenance_code" : [ "" ],
      "maintenance_response" : "aeiou"
    },
    "description" : "aeiou",
    "external_monitor" : {
      "command_path" : "aeiou",
      "command_variables" : "aeiou",
      "command_code" : "aeiou",
      "command_parameters" : "aeiou"
    },
    "type" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "send_interval" : 123,
    "successful_checks" : 123,
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "receive_timeout" : 123,
    "udp_monitor" : {
      "udp_request" : "aeiou",
      "udp_response" : "aeiou",
      "maintenance_response" : "aeiou"
    },
    "https_monitor" : "",
    "is_federated" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HealthMonitorApiResponse

401

log in failed

Up
post /healthmonitor
(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

HealthMonitor

Example data

Content-Type: application/json
{
  "tcp_monitor" : {
    "tcp_response" : "aeiou",
    "tcp_half_open" : true,
    "tcp_request" : "aeiou",
    "maintenance_response" : "aeiou"
  },
  "dns_monitor" : {
    "response_string" : "aeiou",
    "qtype" : "aeiou",
    "query_name" : "aeiou",
    "rcode" : "aeiou"
  },
  "failed_checks" : 123,
  "monitor_port" : 123,
  "http_monitor" : {
    "http_response" : "aeiou",
    "ssl_attributes" : {
      "pki_profile_ref" : "aeiou",
      "ssl_key_and_certificate_ref" : "aeiou",
      "ssl_profile_ref" : "aeiou"
    },
    "exact_http_request" : true,
    "http_request" : "aeiou",
    "http_response_code" : [ "aeiou" ],
    "maintenance_code" : [ "" ],
    "maintenance_response" : "aeiou"
  },
  "description" : "aeiou",
  "external_monitor" : {
    "command_path" : "aeiou",
    "command_variables" : "aeiou",
    "command_code" : "aeiou",
    "command_parameters" : "aeiou"
  },
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "send_interval" : 123,
  "successful_checks" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "receive_timeout" : 123,
  "udp_monitor" : {
    "udp_request" : "aeiou",
    "udp_response" : "aeiou",
    "maintenance_response" : "aeiou"
  },
  "https_monitor" : "",
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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 Accept 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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

HealthMonitor

Example data

Content-Type: application/json
{
  "tcp_monitor" : {
    "tcp_response" : "aeiou",
    "tcp_half_open" : true,
    "tcp_request" : "aeiou",
    "maintenance_response" : "aeiou"
  },
  "dns_monitor" : {
    "response_string" : "aeiou",
    "qtype" : "aeiou",
    "query_name" : "aeiou",
    "rcode" : "aeiou"
  },
  "failed_checks" : 123,
  "monitor_port" : 123,
  "http_monitor" : {
    "http_response" : "aeiou",
    "ssl_attributes" : {
      "pki_profile_ref" : "aeiou",
      "ssl_key_and_certificate_ref" : "aeiou",
      "ssl_profile_ref" : "aeiou"
    },
    "exact_http_request" : true,
    "http_request" : "aeiou",
    "http_response_code" : [ "aeiou" ],
    "maintenance_code" : [ "" ],
    "maintenance_response" : "aeiou"
  },
  "description" : "aeiou",
  "external_monitor" : {
    "command_path" : "aeiou",
    "command_variables" : "aeiou",
    "command_code" : "aeiou",
    "command_parameters" : "aeiou"
  },
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "send_interval" : 123,
  "successful_checks" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "receive_timeout" : 123,
  "udp_monitor" : {
    "udp_request" : "aeiou",
    "udp_response" : "aeiou",
    "maintenance_response" : "aeiou"
  },
  "https_monitor" : "",
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept 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

HealthMonitor

Example data

Content-Type: application/json
{
  "tcp_monitor" : {
    "tcp_response" : "aeiou",
    "tcp_half_open" : true,
    "tcp_request" : "aeiou",
    "maintenance_response" : "aeiou"
  },
  "dns_monitor" : {
    "response_string" : "aeiou",
    "qtype" : "aeiou",
    "query_name" : "aeiou",
    "rcode" : "aeiou"
  },
  "failed_checks" : 123,
  "monitor_port" : 123,
  "http_monitor" : {
    "http_response" : "aeiou",
    "ssl_attributes" : {
      "pki_profile_ref" : "aeiou",
      "ssl_key_and_certificate_ref" : "aeiou",
      "ssl_profile_ref" : "aeiou"
    },
    "exact_http_request" : true,
    "http_request" : "aeiou",
    "http_response_code" : [ "aeiou" ],
    "maintenance_code" : [ "" ],
    "maintenance_response" : "aeiou"
  },
  "description" : "aeiou",
  "external_monitor" : {
    "command_path" : "aeiou",
    "command_variables" : "aeiou",
    "command_code" : "aeiou",
    "command_parameters" : "aeiou"
  },
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "send_interval" : 123,
  "successful_checks" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "receive_timeout" : 123,
  "udp_monitor" : {
    "udp_request" : "aeiou",
    "udp_response" : "aeiou",
    "maintenance_response" : "aeiou"
  },
  "https_monitor" : "",
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept 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

HealthMonitor

Example data

Content-Type: application/json
{
  "tcp_monitor" : {
    "tcp_response" : "aeiou",
    "tcp_half_open" : true,
    "tcp_request" : "aeiou",
    "maintenance_response" : "aeiou"
  },
  "dns_monitor" : {
    "response_string" : "aeiou",
    "qtype" : "aeiou",
    "query_name" : "aeiou",
    "rcode" : "aeiou"
  },
  "failed_checks" : 123,
  "monitor_port" : 123,
  "http_monitor" : {
    "http_response" : "aeiou",
    "ssl_attributes" : {
      "pki_profile_ref" : "aeiou",
      "ssl_key_and_certificate_ref" : "aeiou",
      "ssl_profile_ref" : "aeiou"
    },
    "exact_http_request" : true,
    "http_request" : "aeiou",
    "http_response_code" : [ "aeiou" ],
    "maintenance_code" : [ "" ],
    "maintenance_response" : "aeiou"
  },
  "description" : "aeiou",
  "external_monitor" : {
    "command_path" : "aeiou",
    "command_variables" : "aeiou",
    "command_code" : "aeiou",
    "command_parameters" : "aeiou"
  },
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "send_interval" : 123,
  "successful_checks" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "receive_timeout" : 123,
  "udp_monitor" : {
    "udp_request" : "aeiou",
    "udp_response" : "aeiou",
    "maintenance_response" : "aeiou"
  },
  "https_monitor" : "",
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HealthMonitor

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. HealthMonitor
  2. HealthMonitorApiResponse
  3. HealthMonitorDNS
  4. HealthMonitorExternal
  5. HealthMonitorHttp
  6. HealthMonitorSSLAttributes
  7. HealthMonitorTcp
  8. HealthMonitorUdp

HealthMonitor Up

description (optional)
String User defined description for the object.
dns_monitor (optional)
HealthMonitorDNS Placeholder for description of property dns_monitor of obj type HealthMonitor field type str type object
external_monitor (optional)
HealthMonitorExternal Placeholder for description of property external_monitor of obj type HealthMonitor field type str type object
failed_checks (optional)
Integer Number of continuous failed health checks before the server is marked down. Allowed values are 1-50. format: int32
http_monitor (optional)
HealthMonitorHttp Placeholder for description of property http_monitor of obj type HealthMonitor field type str type object
https_monitor (optional)
HealthMonitorHttp Placeholder for description of property https_monitor of obj type HealthMonitor field type str type object
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.
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'. format: int32
name
String A user friendly name for this health monitor.
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. format: int32
send_interval (optional)
Integer Frequency, in seconds, that monitors are sent to a server. Allowed values are 1-3600. format: int32
successful_checks (optional)
Integer Number of continuous successful health checks before server is marked up. Allowed values are 1-50. format: int32
tcp_monitor (optional)
HealthMonitorTcp Placeholder for description of property tcp_monitor of obj type HealthMonitor field type str type object
tenant_ref (optional)
String It is a reference to an object of type Tenant.
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.
udp_monitor (optional)
HealthMonitorUdp Placeholder for description of property udp_monitor of obj type HealthMonitor field type str type object
url (optional)
String url
uuid (optional)
String UUID of the health monitor.

HealthMonitorApiResponse Up

count
Integer format: int32
results

HealthMonitorDNS Up

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.
query_name
String The DNS monitor will query the DNS server for the fully qualified name in this field.
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.
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. .

HealthMonitorExternal Up

command_code
String Command script provided inline.
command_parameters (optional)
String Optional arguments to feed into the script.
command_path (optional)
String Path of external health monitor script.
command_variables (optional)
String Environment variables to be fed into the script.

HealthMonitorHttp Up

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.
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.
http_response (optional)
String Match for a keyword in the first 2Kb of the server header and body response.
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.
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.
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.
ssl_attributes (optional)
HealthMonitorSSLAttributes SSL attributes for HTTPS health monitor. Field introduced in 17.1.1.

HealthMonitorSSLAttributes Up

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.
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.
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.

HealthMonitorTcp Up

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.
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.
tcp_request (optional)
String Request data to send after completing the TCP handshake.
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.

HealthMonitorUdp Up

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.
udp_request (optional)
String Send UDP request.
udp_response (optional)
String Match for keyword in the UDP response.