LBActiveMonitor (schema)

Base class for each type of active LBMonitorProfile

All the active types of LBMonitorProfile extend from this abstract class.
This is present for extensibility.
Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
_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
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.
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
children subtree for this type within policy tree

subtree for this type within policy tree containing nested elements.
array of ChildPolicyConfigResource
Children are not allowed for this type
description Description of this resource string Maximum length: 1024
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
fall_count Monitor fall count for active healthchecks

Only if a healthcheck fails consecutively for a specified number of
times, given with fall_count, to a member will the member status be
marked DOWN.
integer Minimum: 1
Maximum: 2147483647
Default: "3"
id Unique identifier of this resource string Sortable
interval Monitor interval in seconds for active healthchecks

Active healthchecks are initiated periodically, at a configurable
interval (in seconds), to each member of the Group.
integer Minimum: 1
Maximum: 2147483647
Default: "5"
marked_for_delete Indicates whether the intent object is marked for deletion

Intent objects are not directly deleted from the system when a delete
is invoked on them. They are marked for deletion and only when all the
realized entities for that intent object gets deleted, the intent object
is deleted. Objects that are marked for deletion are not returned in
GET call. One can use the search API to get these objects.
boolean Readonly
Default: "False"
monitor_port Monitor port for active healthchecks

Typically, monitors perform healthchecks to Group members using the
member IP address and pool_port.
However, in some cases, customers prefer to run healthchecks against a
different port than the pool member port which handles actual
application traffic. In such cases, the port to run healthchecks
against can be specified in the monitor_port value.
For ICMP monitor, monitor_port is not required.
int Minimum: 0
Maximum: 65535
overridden Indicates whether this object is the overridden intent object

Global intent objects cannot be modified by the user.
However, certain global intent objects can be overridden locally by use
of this property. In such cases, the overridden local values take
precedence over the globally defined values for the properties.
boolean Readonly
Default: "False"
parent_path Path of its parent

Path of its parent
string Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value LBActiveMonitor LBMonitorProfileType Required
rise_count Monitor rise count for active healthchecks

Once a member is DOWN, a specified number of consecutive successful
healthchecks specified by rise_count will bring the member back to UP
integer Minimum: 1
Maximum: 2147483647
Default: "3"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
timeout Monitor timeout in seconds for active healthchecks

Timeout specified in seconds. After a healthcheck is initiated, if it
does not complete within a certain period, then also the healthcheck
is considered to be unsuccessful. Completing a healthcheck within
timeout means establishing a connection (TCP or SSL), if applicable,
sending the request and receiving the response, all within the
configured timeout.
integer Minimum: 1
Maximum: 2147483647
Default: "5"
unique_id A unique identifier assigned by the system

This is a UUID generated by the GM/LM to uniquely identify
entites in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
string Readonly