LbHttpsMonitor (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
int
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
certificate_chain_depth the maximum traversal depth of server certificate chain

authentication depth is used to set the verification depth in the server
certificates chain.
integer Minimum: 1
Maximum: 2147483647
Default: "3"
cipher_group_label Label of cipher group

It is a label of cipher group which is mostly consumed by GUI.
SslCipherGroup
ciphers supported SSL cipher list to servers array of SslCipher
client_certificate_id client certificate identifier

client certificate can be specified to support client authentication.
string
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
fall_count num of consecutive checks must fail before marking it down integer Minimum: 1
Maximum: 2147483647
Default: "3"
id Unique identifier of this resource string Sortable
interval the frequency at which the system issues the monitor check (in second) integer Minimum: 1
Maximum: 2147483647
Default: "5"
is_fips FIPS compliance of ciphers and protocols

This flag is set to true when all the ciphers and protocols are FIPS
compliant. It is set to false when one of the ciphers or protocols are
not FIPS compliant..
boolean Readonly
is_secure Secure/Insecure monitor flag

This flag is set to true when all the ciphers and protocols are secure.
It is set to false when one of the ciphers or protocols is insecure.
boolean Readonly
monitor_port port which is used for healthcheck

If the monitor port is specified, it would override pool member port
setting for healthcheck. A port range is not supported.
For ICMP monitor, monitor_port is not required.
PortElement
protocols supported SSL protocol list to servers

SSL versions TLS1.1 and TLS1.2 are supported and enabled by default.
SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
array of SslProtocol
request_body String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST. string
request_headers Array of HTTP request headers array of LbHttpRequestHeader
request_method the health check method for HTTP monitor type HttpRequestMethodType Default: "GET"
request_url URL used for HTTP monitor string
request_version HTTP request version HttpRequestVersionType Default: "HTTP_VERSION_1_1"
resource_type Must be set to the value LbHttpsMonitor MonitorType Required
response_body response body to match

If HTTP response body match string (regular expressions not supported)
is specified (using LbHttpMonitor.response_body) then the
healthcheck HTTP response body is matched against the specified string
and server is considered healthy only if there is a match.
If the response body string is not specified, HTTP healthcheck is
considered successful if the HTTP response status code is 2xx, but it
can be configured to accept other status codes as successful.
string
response_status_codes Array of single HTTP response status codes

The HTTP response status code should be a valid HTTP status code.
array of int Maximum items: 64
rise_count num of consecutive checks must pass before marking it up integer Minimum: 1
Maximum: 2147483647
Default: "3"
server_auth server authentication mode ServerAuthType Default: "IGNORE"
server_auth_ca_ids CA identifier list to verify server certificate

If server auth type is REQUIRED, server certificate must be signed by
one of the trusted Certificate Authorities (CAs), also referred to as
root CAs, whose self signed certificates are specified.
array of string
server_auth_crl_ids CRL identifier list to verify server certificate

A Certificate Revocation List (CRL) can be specified in the server-side
SSL profile binding to disallow compromised server certificates.
array of string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
timeout the number of seconds the target has in which to respond to the monitor request integer Minimum: 1
Maximum: 2147483647
Default: "15"