"""Exec module for managing Profiles Health Monitors. """
from collections import OrderedDict
from dataclasses import field
from dataclasses import make_dataclass
from typing import Any
from typing import Dict
from typing import List
__contracts__ = ["soft_fail"]
__func_alias__ = {"list_": "list"}
[docs]async def get(
hub, ctx, resource_id: str = None, name: str = None, tenant_ref: str = None
) -> Dict[str, Any]:
"""
None
None
Args:
resource_id(str):
profiles.health_monitor unique ID.
name(str, Optional):
Idem name of the resource. Defaults to None.
tenant_ref(str, Optional):
Avi Tenant Header. Defaults to None.
Returns:
Dict[str, Any]
Examples:
Resource State:
.. code-block:: sls
unmanaged_resource:
exec.run:
- path: avilb.profiles.health_monitor.get
- kwargs:
resource_id: value
Exec call from the CLI:
.. code-block:: bash
idem exec avilb.profiles.health_monitor.get resource_id=value
"""
result = dict(comment=[], ret=None, result=True)
get = await hub.tool.avilb.session.request(
ctx,
method="get",
path="/healthmonitor/{uuid}?include_name".format(**{"uuid": resource_id})
if resource_id
else "/healthmonitor",
query_params={"name": name},
data={},
headers={"X-Avi-Tenant": tenant_ref} if tenant_ref else {"X-Avi-Tenant": "*"},
)
if not get["result"]:
# Send empty result for not found
if get["status"] == 404:
result["comment"].append(f"Get '{name}' result is empty")
return result
result["comment"].append(get["comment"])
result["result"] = False
return result
# Case: Empty results
if not get["ret"]:
result["comment"].append(f"Get '{name}' result is empty")
return result
if "results" in get["ret"].keys():
if get["ret"]["count"] != 0:
# Convert raw response into present format
raw_resource = get["ret"]["results"][0]
resource_id = get["ret"]["results"][0]["uuid"]
else:
return result
else:
# Convert raw response into present format
raw_resource = get["ret"]
resource_in_present_format = {"name": name, "resource_id": resource_id}
resource_parameters = OrderedDict(
{
"allow_duplicate_monitors": "allow_duplicate_monitors",
"authentication": "authentication",
"configpb_attributes": "configpb_attributes",
"description": "description",
"disable_quickstart": "disable_quickstart",
"dns_monitor": "dns_monitor",
"external_monitor": "external_monitor",
"failed_checks": "failed_checks",
"ftp_monitor": "ftp_monitor",
"ftps_monitor": "ftps_monitor",
"http_monitor": "http_monitor",
"https_monitor": "https_monitor",
"imap_monitor": "imap_monitor",
"imaps_monitor": "imaps_monitor",
"is_federated": "is_federated",
"ldap_monitor": "ldap_monitor",
"ldaps_monitor": "ldaps_monitor",
"markers": "markers",
"monitor_port": "monitor_port",
"name": "name",
"pop3_monitor": "pop3_monitor",
"pop3s_monitor": "pop3s_monitor",
"radius_monitor": "radius_monitor",
"receive_timeout": "receive_timeout",
"sctp_monitor": "sctp_monitor",
"send_interval": "send_interval",
"sip_monitor": "sip_monitor",
"smtp_monitor": "smtp_monitor",
"smtps_monitor": "smtps_monitor",
"successful_checks": "successful_checks",
"tcp_monitor": "tcp_monitor",
"tenant_ref": "tenant_ref",
"type": "type",
"udp_monitor": "udp_monitor",
}
)
for parameter_raw, parameter_present in resource_parameters.items():
if parameter_raw in raw_resource and raw_resource.get(parameter_raw):
resource_in_present_format[parameter_present] = raw_resource.get(
parameter_raw
)
result["ret"] = resource_in_present_format
return result
[docs]async def list_(hub, ctx) -> Dict[str, Any]:
"""
None
None
Args:
name(str, Optional):
Idem name of the resource. Defaults to None.
Returns:
Dict[str, Any]
Examples:
Resource State:
.. code-block:: sls
unmanaged_resources:
exec.run:
- path: avilb.profiles.health_monitor.list
- kwargs:
Exec call from the CLI:
.. code-block:: bash
idem exec avilb.profiles.health_monitor.list
Describe call from the CLI:
.. code-block:: bash
$ idem describe avilb.profiles.health_monitor
"""
result = dict(comment=[], ret=[], result=True)
list = await hub.tool.avilb.session.request(
ctx,
method="get",
path="/healthmonitor",
query_params={},
data={},
headers={"X-Avi-Tenant": "*"},
)
if not list["result"]:
result["comment"].append(list["comment"])
result["result"] = False
return result
for resource in list["ret"]["results"]:
# TODO Handle pagination if required
resource["resource_id"] = resource.get("uuid")
result["ret"].append(resource)
return result
[docs]async def create(
hub,
ctx,
type: str,
resource_id: str = None,
name: str = None,
allow_duplicate_monitors: bool = None,
authentication: make_dataclass(
"authentication", [("password", str), ("username", str)]
) = None,
configpb_attributes: make_dataclass(
"configpb_attributes", [("version", int, field(default=None))]
) = None,
description: str = None,
disable_quickstart: bool = None,
dns_monitor: make_dataclass(
"dns_monitor",
[
("query_name", str),
("qtype", str, field(default=None)),
("rcode", str, field(default=None)),
("record_type", str, field(default=None)),
("response_string", str, field(default=None)),
],
) = None,
external_monitor: make_dataclass(
"external_monitor",
[
("command_code", str),
("command_parameters", str, field(default=None)),
("command_path", str, field(default=None)),
("command_variables", str, field(default=None)),
],
) = None,
failed_checks: int = None,
ftp_monitor: make_dataclass(
"ftp_monitor",
[
("filename", str),
("mode", str),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
ftps_monitor: make_dataclass(
"ftps_monitor",
[
("filename", str),
("mode", str),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
http_monitor: make_dataclass(
"http_monitor",
[
("auth_type", str, field(default=None)),
("exact_http_request", bool, field(default=None)),
("http_request", str, field(default=None)),
("http_request_body", str, field(default=None)),
("http_response", str, field(default=None)),
("http_response_code", List[str], field(default=None)),
("maintenance_code", List[int], field(default=None)),
("maintenance_response", str, field(default=None)),
("response_size", int, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
https_monitor: make_dataclass(
"https_monitor",
[
("auth_type", str, field(default=None)),
("exact_http_request", bool, field(default=None)),
("http_request", str, field(default=None)),
("http_request_body", str, field(default=None)),
("http_response", str, field(default=None)),
("http_response_code", List[str], field(default=None)),
("maintenance_code", List[int], field(default=None)),
("maintenance_response", str, field(default=None)),
("response_size", int, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
imap_monitor: make_dataclass(
"imap_monitor",
[
("folder", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
imaps_monitor: make_dataclass(
"imaps_monitor",
[
("folder", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
is_federated: bool = None,
ldap_monitor: make_dataclass(
"ldap_monitor",
[
("base_dn", str),
("attributes", str, field(default=None)),
("filter", str, field(default=None)),
("scope", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
ldaps_monitor: make_dataclass(
"ldaps_monitor",
[
("base_dn", str),
("attributes", str, field(default=None)),
("filter", str, field(default=None)),
("scope", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
markers: List[
make_dataclass(
"markers", [("key", str), ("values", List[str], field(default=None))]
)
] = None,
monitor_port: int = None,
pop3_monitor: make_dataclass(
"pop3_monitor",
[
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
)
],
) = None,
pop3s_monitor: make_dataclass(
"pop3s_monitor",
[
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
)
],
) = None,
radius_monitor: make_dataclass(
"radius_monitor", [("password", str), ("shared_secret", str), ("username", str)]
) = None,
receive_timeout: int = None,
sctp_monitor: make_dataclass(
"sctp_monitor",
[
("sctp_request", str, field(default=None)),
("sctp_response", str, field(default=None)),
],
) = None,
send_interval: int = None,
sip_monitor: make_dataclass(
"sip_monitor",
[
("sip_monitor_transport", str, field(default=None)),
("sip_request_code", str, field(default=None)),
("sip_response", str, field(default=None)),
],
) = None,
smtp_monitor: make_dataclass(
"smtp_monitor",
[
("domainname", str, field(default=None)),
("mail_data", str, field(default=None)),
("recipients_ids", List[str], field(default=None)),
("sender_id", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
smtps_monitor: make_dataclass(
"smtps_monitor",
[
("domainname", str, field(default=None)),
("mail_data", str, field(default=None)),
("recipients_ids", List[str], field(default=None)),
("sender_id", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
successful_checks: int = None,
tcp_monitor: make_dataclass(
"tcp_monitor",
[
("maintenance_response", str, field(default=None)),
("tcp_half_open", bool, field(default=None)),
("tcp_request", str, field(default=None)),
("tcp_response", str, field(default=None)),
],
) = None,
tenant_ref: str = None,
udp_monitor: make_dataclass(
"udp_monitor",
[
("maintenance_response", str, field(default=None)),
("udp_request", str, field(default=None)),
("udp_response", str, field(default=None)),
],
) = None,
) -> Dict[str, Any]:
"""
None
None
Args:
type(str):
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.
resource_id(str, Optional):
profiles.health_monitor unique ID. Defaults to None.
name(str, Optional):
Idem name of the resource. Defaults to None.
allow_duplicate_monitors(bool, Optional):
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. Defaults to None.
authentication(dict[str, Any], Optional):
authentication. Defaults to None.
* password (str):
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 (str):
Username for server authentication. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
configpb_attributes(dict[str, Any], Optional):
configpb_attributes. Defaults to None.
* version (int, Optional):
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. Defaults to None.
description(str, Optional):
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
disable_quickstart(bool, Optional):
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. Defaults to None.
dns_monitor(dict[str, Any], Optional):
dns_monitor. Defaults to None.
* qtype (str, Optional):
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. Defaults to None.
* query_name (str):
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 (str, Optional):
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. Defaults to None.
* record_type (str, Optional):
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. Defaults to None.
* response_string (str, Optional):
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. Defaults to None.
external_monitor(dict[str, Any], Optional):
external_monitor. Defaults to None.
* command_code (str):
Command script provided inline. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
* command_parameters (str, Optional):
Optional arguments to feed into the script. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* command_path (str, Optional):
Path of external health monitor script. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* command_variables (str, Optional):
Environment variables to be fed into the script. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
failed_checks(int, Optional):
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. Defaults to None.
ftp_monitor(dict[str, Any], Optional):
ftp_monitor. Defaults to None.
* filename (str):
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 (str):
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 (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
ftps_monitor(dict[str, Any], Optional):
ftps_monitor. Defaults to None.
* filename (str):
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 (str):
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 (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
http_monitor(dict[str, Any], Optional):
http_monitor. Defaults to None.
* auth_type (str, Optional):
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. Defaults to None.
* exact_http_request (bool, Optional):
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. Defaults to None.
* http_request (str, Optional):
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. Defaults to None.
* http_request_body (str, Optional):
HTTP request body. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* http_response (str, Optional):
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. Defaults to None.
* http_response_code (List[str], Optional):
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. Defaults to None.
* maintenance_code (List[int], Optional):
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. Defaults to None.
* maintenance_response (str, Optional):
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. Defaults to None.
* response_size (int, Optional):
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. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
https_monitor(dict[str, Any], Optional):
https_monitor. Defaults to None.
* auth_type (str, Optional):
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. Defaults to None.
* exact_http_request (bool, Optional):
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. Defaults to None.
* http_request (str, Optional):
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. Defaults to None.
* http_request_body (str, Optional):
HTTP request body. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* http_response (str, Optional):
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. Defaults to None.
* http_response_code (List[str], Optional):
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. Defaults to None.
* maintenance_code (List[int], Optional):
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. Defaults to None.
* maintenance_response (str, Optional):
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. Defaults to None.
* response_size (int, Optional):
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. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
imap_monitor(dict[str, Any], Optional):
imap_monitor. Defaults to None.
* folder (str, Optional):
Folder to access. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
imaps_monitor(dict[str, Any], Optional):
imaps_monitor. Defaults to None.
* folder (str, Optional):
Folder to access. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
is_federated(bool, Optional):
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. Defaults to None.
ldap_monitor(dict[str, Any], Optional):
ldap_monitor. Defaults to None.
* attributes (str, Optional):
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. Defaults to None.
* base_dn (str):
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 (str, Optional):
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. Defaults to None.
* scope (str, Optional):
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. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
ldaps_monitor(dict[str, Any], Optional):
ldaps_monitor. Defaults to None.
* attributes (str, Optional):
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. Defaults to None.
* base_dn (str):
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 (str, Optional):
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. Defaults to None.
* scope (str, Optional):
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. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
markers(List[dict[str, Any]], Optional):
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. Defaults to None.
* key (str):
Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
* values (List[str], Optional):
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. Defaults to None.
monitor_port(int, Optional):
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. Defaults to None.
pop3_monitor(dict[str, Any], Optional):
pop3_monitor. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
pop3s_monitor(dict[str, Any], Optional):
pop3s_monitor. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
radius_monitor(dict[str, Any], Optional):
radius_monitor. Defaults to None.
* password (str):
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 (str):
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 (str):
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.
receive_timeout(int, Optional):
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. Defaults to None.
sctp_monitor(dict[str, Any], Optional):
sctp_monitor. Defaults to None.
* sctp_request (str, Optional):
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. Defaults to None.
* sctp_response (str, Optional):
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. Defaults to None.
send_interval(int, Optional):
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. Defaults to None.
sip_monitor(dict[str, Any], Optional):
sip_monitor. Defaults to None.
* sip_monitor_transport (str, Optional):
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. Defaults to None.
* sip_request_code (str, Optional):
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. Defaults to None.
* sip_response (str, Optional):
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. Defaults to None.
smtp_monitor(dict[str, Any], Optional):
smtp_monitor. Defaults to None.
* domainname (str, Optional):
Sender domain name. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* mail_data (str, Optional):
Mail data. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* recipients_ids (List[str], Optional):
Mail recipients. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* sender_id (str, Optional):
Mail sender. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
smtps_monitor(dict[str, Any], Optional):
smtps_monitor. Defaults to None.
* domainname (str, Optional):
Sender domain name. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* mail_data (str, Optional):
Mail data. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* recipients_ids (List[str], Optional):
Mail recipients. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* sender_id (str, Optional):
Mail sender. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
successful_checks(int, Optional):
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. Defaults to None.
tcp_monitor(dict[str, Any], Optional):
tcp_monitor. Defaults to None.
* maintenance_response (str, Optional):
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. Defaults to None.
* tcp_half_open (bool, Optional):
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. Defaults to None.
* tcp_request (str, Optional):
Request data to send after completing the TCP handshake. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* tcp_response (str, Optional):
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. Defaults to None.
tenant_ref(str, Optional):
It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
udp_monitor(dict[str, Any], Optional):
udp_monitor. Defaults to None.
* maintenance_response (str, Optional):
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. Defaults to None.
* udp_request (str, Optional):
Send UDP request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* udp_response (str, Optional):
Match for keyword in the UDP response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
Returns:
Dict[str, Any]
Examples:
Using in a state:
.. code-block:: sls
resource_is_present:
avilb.profiles.health_monitor.present:
- type: value
Exec call from the CLI:
.. code-block:: bash
idem exec avilb.profiles.health_monitor.create type=value
"""
result = dict(comment=[], ret=[], result=True)
desired_state = {
k: v
for k, v in locals().items()
if k not in ("hub", "ctx", "result") and v is not None
}
resource_to_raw_input_mapping = {
"allow_duplicate_monitors": "allow_duplicate_monitors",
"authentication": "authentication",
"configpb_attributes": "configpb_attributes",
"description": "description",
"disable_quickstart": "disable_quickstart",
"dns_monitor": "dns_monitor",
"external_monitor": "external_monitor",
"failed_checks": "failed_checks",
"ftp_monitor": "ftp_monitor",
"ftps_monitor": "ftps_monitor",
"http_monitor": "http_monitor",
"https_monitor": "https_monitor",
"imap_monitor": "imap_monitor",
"imaps_monitor": "imaps_monitor",
"is_federated": "is_federated",
"ldap_monitor": "ldap_monitor",
"ldaps_monitor": "ldaps_monitor",
"markers": "markers",
"monitor_port": "monitor_port",
"name": "name",
"pop3_monitor": "pop3_monitor",
"pop3s_monitor": "pop3s_monitor",
"radius_monitor": "radius_monitor",
"receive_timeout": "receive_timeout",
"sctp_monitor": "sctp_monitor",
"send_interval": "send_interval",
"sip_monitor": "sip_monitor",
"smtp_monitor": "smtp_monitor",
"smtps_monitor": "smtps_monitor",
"successful_checks": "successful_checks",
"tcp_monitor": "tcp_monitor",
"tenant_ref": "tenant_ref",
"type": "type",
"udp_monitor": "udp_monitor",
}
payload = {}
for key, value in desired_state.items():
if key in resource_to_raw_input_mapping.keys() and value is not None:
payload[resource_to_raw_input_mapping[key]] = value
create = await hub.tool.avilb.session.request(
ctx,
method="post",
path="/healthmonitor",
query_params={},
data=payload,
)
if not create["result"]:
result["comment"].append(create["comment"])
result["result"] = False
return result
result["comment"].append(
f"Created avilb.profiles.health_monitor '{name}'",
)
result["ret"] = create["ret"]
result["ret"]["resource_id"] = create["ret"]["uuid"]
return result
[docs]async def update(
hub,
ctx,
resource_id: str,
type: str,
name: str = None,
allow_duplicate_monitors: bool = None,
authentication: make_dataclass(
"authentication", [("password", str), ("username", str)]
) = None,
configpb_attributes: make_dataclass(
"configpb_attributes", [("version", int, field(default=None))]
) = None,
description: str = None,
disable_quickstart: bool = None,
dns_monitor: make_dataclass(
"dns_monitor",
[
("query_name", str),
("qtype", str, field(default=None)),
("rcode", str, field(default=None)),
("record_type", str, field(default=None)),
("response_string", str, field(default=None)),
],
) = None,
external_monitor: make_dataclass(
"external_monitor",
[
("command_code", str),
("command_parameters", str, field(default=None)),
("command_path", str, field(default=None)),
("command_variables", str, field(default=None)),
],
) = None,
failed_checks: int = None,
ftp_monitor: make_dataclass(
"ftp_monitor",
[
("filename", str),
("mode", str),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
ftps_monitor: make_dataclass(
"ftps_monitor",
[
("filename", str),
("mode", str),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
http_monitor: make_dataclass(
"http_monitor",
[
("auth_type", str, field(default=None)),
("exact_http_request", bool, field(default=None)),
("http_request", str, field(default=None)),
("http_request_body", str, field(default=None)),
("http_response", str, field(default=None)),
("http_response_code", List[str], field(default=None)),
("maintenance_code", List[int], field(default=None)),
("maintenance_response", str, field(default=None)),
("response_size", int, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
https_monitor: make_dataclass(
"https_monitor",
[
("auth_type", str, field(default=None)),
("exact_http_request", bool, field(default=None)),
("http_request", str, field(default=None)),
("http_request_body", str, field(default=None)),
("http_response", str, field(default=None)),
("http_response_code", List[str], field(default=None)),
("maintenance_code", List[int], field(default=None)),
("maintenance_response", str, field(default=None)),
("response_size", int, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
imap_monitor: make_dataclass(
"imap_monitor",
[
("folder", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
imaps_monitor: make_dataclass(
"imaps_monitor",
[
("folder", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
is_federated: bool = None,
ldap_monitor: make_dataclass(
"ldap_monitor",
[
("base_dn", str),
("attributes", str, field(default=None)),
("filter", str, field(default=None)),
("scope", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
ldaps_monitor: make_dataclass(
"ldaps_monitor",
[
("base_dn", str),
("attributes", str, field(default=None)),
("filter", str, field(default=None)),
("scope", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
markers: List[
make_dataclass(
"markers", [("key", str), ("values", List[str], field(default=None))]
)
] = None,
monitor_port: int = None,
pop3_monitor: make_dataclass(
"pop3_monitor",
[
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
)
],
) = None,
pop3s_monitor: make_dataclass(
"pop3s_monitor",
[
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
)
],
) = None,
radius_monitor: make_dataclass(
"radius_monitor", [("password", str), ("shared_secret", str), ("username", str)]
) = None,
receive_timeout: int = None,
sctp_monitor: make_dataclass(
"sctp_monitor",
[
("sctp_request", str, field(default=None)),
("sctp_response", str, field(default=None)),
],
) = None,
send_interval: int = None,
sip_monitor: make_dataclass(
"sip_monitor",
[
("sip_monitor_transport", str, field(default=None)),
("sip_request_code", str, field(default=None)),
("sip_response", str, field(default=None)),
],
) = None,
smtp_monitor: make_dataclass(
"smtp_monitor",
[
("domainname", str, field(default=None)),
("mail_data", str, field(default=None)),
("recipients_ids", List[str], field(default=None)),
("sender_id", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
smtps_monitor: make_dataclass(
"smtps_monitor",
[
("domainname", str, field(default=None)),
("mail_data", str, field(default=None)),
("recipients_ids", List[str], field(default=None)),
("sender_id", str, field(default=None)),
(
"ssl_attributes",
make_dataclass(
"ssl_attributes",
[
("ssl_profile_ref", str),
("pki_profile_ref", str, field(default=None)),
("server_name", str, field(default=None)),
("ssl_key_and_certificate_ref", str, field(default=None)),
],
),
field(default=None),
),
],
) = None,
successful_checks: int = None,
tcp_monitor: make_dataclass(
"tcp_monitor",
[
("maintenance_response", str, field(default=None)),
("tcp_half_open", bool, field(default=None)),
("tcp_request", str, field(default=None)),
("tcp_response", str, field(default=None)),
],
) = None,
tenant_ref: str = None,
udp_monitor: make_dataclass(
"udp_monitor",
[
("maintenance_response", str, field(default=None)),
("udp_request", str, field(default=None)),
("udp_response", str, field(default=None)),
],
) = None,
) -> Dict[str, Any]:
"""
None
None
Args:
resource_id(str):
profiles.health_monitor unique ID.
type(str):
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.
name(str, Optional):
Idem name of the resource. Defaults to None.
allow_duplicate_monitors(bool, Optional):
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. Defaults to None.
authentication(dict[str, Any], Optional):
authentication. Defaults to None.
* password (str):
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 (str):
Username for server authentication. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
configpb_attributes(dict[str, Any], Optional):
configpb_attributes. Defaults to None.
* version (int, Optional):
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. Defaults to None.
description(str, Optional):
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
disable_quickstart(bool, Optional):
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. Defaults to None.
dns_monitor(dict[str, Any], Optional):
dns_monitor. Defaults to None.
* qtype (str, Optional):
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. Defaults to None.
* query_name (str):
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 (str, Optional):
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. Defaults to None.
* record_type (str, Optional):
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. Defaults to None.
* response_string (str, Optional):
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. Defaults to None.
external_monitor(dict[str, Any], Optional):
external_monitor. Defaults to None.
* command_code (str):
Command script provided inline. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
* command_parameters (str, Optional):
Optional arguments to feed into the script. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* command_path (str, Optional):
Path of external health monitor script. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* command_variables (str, Optional):
Environment variables to be fed into the script. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
failed_checks(int, Optional):
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. Defaults to None.
ftp_monitor(dict[str, Any], Optional):
ftp_monitor. Defaults to None.
* filename (str):
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 (str):
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 (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
ftps_monitor(dict[str, Any], Optional):
ftps_monitor. Defaults to None.
* filename (str):
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 (str):
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 (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
http_monitor(dict[str, Any], Optional):
http_monitor. Defaults to None.
* auth_type (str, Optional):
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. Defaults to None.
* exact_http_request (bool, Optional):
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. Defaults to None.
* http_request (str, Optional):
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. Defaults to None.
* http_request_body (str, Optional):
HTTP request body. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* http_response (str, Optional):
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. Defaults to None.
* http_response_code (List[str], Optional):
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. Defaults to None.
* maintenance_code (List[int], Optional):
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. Defaults to None.
* maintenance_response (str, Optional):
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. Defaults to None.
* response_size (int, Optional):
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. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
https_monitor(dict[str, Any], Optional):
https_monitor. Defaults to None.
* auth_type (str, Optional):
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. Defaults to None.
* exact_http_request (bool, Optional):
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. Defaults to None.
* http_request (str, Optional):
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. Defaults to None.
* http_request_body (str, Optional):
HTTP request body. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* http_response (str, Optional):
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. Defaults to None.
* http_response_code (List[str], Optional):
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. Defaults to None.
* maintenance_code (List[int], Optional):
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. Defaults to None.
* maintenance_response (str, Optional):
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. Defaults to None.
* response_size (int, Optional):
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. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
imap_monitor(dict[str, Any], Optional):
imap_monitor. Defaults to None.
* folder (str, Optional):
Folder to access. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
imaps_monitor(dict[str, Any], Optional):
imaps_monitor. Defaults to None.
* folder (str, Optional):
Folder to access. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
is_federated(bool, Optional):
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. Defaults to None.
ldap_monitor(dict[str, Any], Optional):
ldap_monitor. Defaults to None.
* attributes (str, Optional):
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. Defaults to None.
* base_dn (str):
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 (str, Optional):
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. Defaults to None.
* scope (str, Optional):
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. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
ldaps_monitor(dict[str, Any], Optional):
ldaps_monitor. Defaults to None.
* attributes (str, Optional):
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. Defaults to None.
* base_dn (str):
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 (str, Optional):
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. Defaults to None.
* scope (str, Optional):
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. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
markers(List[dict[str, Any]], Optional):
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. Defaults to None.
* key (str):
Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
* values (List[str], Optional):
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. Defaults to None.
monitor_port(int, Optional):
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. Defaults to None.
pop3_monitor(dict[str, Any], Optional):
pop3_monitor. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
pop3s_monitor(dict[str, Any], Optional):
pop3s_monitor. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
radius_monitor(dict[str, Any], Optional):
radius_monitor. Defaults to None.
* password (str):
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 (str):
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 (str):
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.
receive_timeout(int, Optional):
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. Defaults to None.
sctp_monitor(dict[str, Any], Optional):
sctp_monitor. Defaults to None.
* sctp_request (str, Optional):
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. Defaults to None.
* sctp_response (str, Optional):
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. Defaults to None.
send_interval(int, Optional):
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. Defaults to None.
sip_monitor(dict[str, Any], Optional):
sip_monitor. Defaults to None.
* sip_monitor_transport (str, Optional):
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. Defaults to None.
* sip_request_code (str, Optional):
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. Defaults to None.
* sip_response (str, Optional):
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. Defaults to None.
smtp_monitor(dict[str, Any], Optional):
smtp_monitor. Defaults to None.
* domainname (str, Optional):
Sender domain name. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* mail_data (str, Optional):
Mail data. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* recipients_ids (List[str], Optional):
Mail recipients. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* sender_id (str, Optional):
Mail sender. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
smtps_monitor(dict[str, Any], Optional):
smtps_monitor. Defaults to None.
* domainname (str, Optional):
Sender domain name. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* mail_data (str, Optional):
Mail data. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* recipients_ids (List[str], Optional):
Mail recipients. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* sender_id (str, Optional):
Mail sender. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
* ssl_attributes (dict[str, Any], Optional):
ssl_attributes. Defaults to None.
* pki_profile_ref (str, Optional):
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. Defaults to None.
* server_name (str, Optional):
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. Defaults to None.
* ssl_key_and_certificate_ref (str, Optional):
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. Defaults to None.
* ssl_profile_ref (str):
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.
successful_checks(int, Optional):
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. Defaults to None.
tcp_monitor(dict[str, Any], Optional):
tcp_monitor. Defaults to None.
* maintenance_response (str, Optional):
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. Defaults to None.
* tcp_half_open (bool, Optional):
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. Defaults to None.
* tcp_request (str, Optional):
Request data to send after completing the TCP handshake. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* tcp_response (str, Optional):
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. Defaults to None.
tenant_ref(str, Optional):
It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
udp_monitor(dict[str, Any], Optional):
udp_monitor. Defaults to None.
* maintenance_response (str, Optional):
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. Defaults to None.
* udp_request (str, Optional):
Send UDP request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
* udp_response (str, Optional):
Match for keyword in the UDP response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
Returns:
Dict[str, Any]
Examples:
Using in a state:
.. code-block:: sls
resource_is_present:
avilb.profiles.health_monitor.present:
- resource_id: value
- type: value
Exec call from the CLI:
.. code-block:: bash
idem exec avilb.profiles.health_monitor.update resource_id=value, type=value
"""
result = dict(comment=[], ret=[], result=True)
desired_state = {
k: v
for k, v in locals().items()
if k not in ("hub", "ctx", "result") and v is not None
}
resource_to_raw_input_mapping = {
"allow_duplicate_monitors": "allow_duplicate_monitors",
"authentication": "authentication",
"configpb_attributes": "configpb_attributes",
"description": "description",
"disable_quickstart": "disable_quickstart",
"dns_monitor": "dns_monitor",
"external_monitor": "external_monitor",
"failed_checks": "failed_checks",
"ftp_monitor": "ftp_monitor",
"ftps_monitor": "ftps_monitor",
"http_monitor": "http_monitor",
"https_monitor": "https_monitor",
"imap_monitor": "imap_monitor",
"imaps_monitor": "imaps_monitor",
"is_federated": "is_federated",
"ldap_monitor": "ldap_monitor",
"ldaps_monitor": "ldaps_monitor",
"markers": "markers",
"monitor_port": "monitor_port",
"name": "name",
"pop3_monitor": "pop3_monitor",
"pop3s_monitor": "pop3s_monitor",
"radius_monitor": "radius_monitor",
"receive_timeout": "receive_timeout",
"sctp_monitor": "sctp_monitor",
"send_interval": "send_interval",
"sip_monitor": "sip_monitor",
"smtp_monitor": "smtp_monitor",
"smtps_monitor": "smtps_monitor",
"successful_checks": "successful_checks",
"tcp_monitor": "tcp_monitor",
"tenant_ref": "tenant_ref",
"type": "type",
"udp_monitor": "udp_monitor",
}
payload = {}
for key, value in desired_state.items():
if (
key in resource_to_raw_input_mapping.keys()
and value is not None
and key != "_last_modified"
):
payload[resource_to_raw_input_mapping[key]] = value
if payload:
update = await hub.tool.avilb.session.request(
ctx,
method="put",
path="/healthmonitor/{uuid}".format(**{"uuid": resource_id}),
query_params={},
data=payload,
)
if not update["result"]:
result["comment"].append(update["comment"])
result["result"] = False
return result
result["ret"] = update["ret"]
result["resource_id"] = update["ret"]["uuid"]
result["comment"].append(
f"Updated avilb.profiles.health_monitor '{name}'",
)
return result
[docs]async def delete(hub, ctx, resource_id: str, name: str = None) -> Dict[str, Any]:
"""
None
None
Args:
resource_id(str):
profiles.health_monitor unique ID.
name(str, Optional):
Idem name of the resource. Defaults to None.
Returns:
Dict[str, Any]
Examples:
Resource State:
.. code-block:: sls
resource_is_absent:
avilb.profiles.health_monitor.absent:
- resource_id: value
Exec call from the CLI:
.. code-block:: bash
idem exec avilb.profiles.health_monitor.delete resource_id=value
"""
result = dict(comment=[], ret=[], result=True)
before = await hub.exec.avilb.profiles.health_monitor.get(
ctx,
name=name,
resource_id=resource_id,
)
if before["ret"]:
tenant_name = before["ret"]["tenant_ref"].split("#")[-1]
delete = await hub.tool.avilb.session.request(
ctx,
method="delete",
path="/healthmonitor/{uuid}".format(**{"uuid": resource_id}),
query_params={},
data={},
headers={"X-Avi-Tenant": tenant_name},
)
if not delete["result"]:
result["comment"].append(delete["comment"])
result["result"] = False
return result
result["comment"].append(f"Deleted '{name}'")
return result