| _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 |
| allow_duplicate_monitors |
Allow duplicate monitors
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.
Allowed in Basic(Allowed values- true) edition,
Essentials(Allowed values- true) edition, Enterprise
edition.
|
boolean |
|
| authentication |
Authentication
Authentication information for username/password.
Allowed in Basic edition, Essentials edition, Enterprise
edition.
|
ALBHealthMonitorAuthInfo |
|
| 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
Sortable |
| disable_quickstart |
Disable quickstart
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.
Allowed in Basic(Allowed values- false) edition,
Essentials(Allowed values- false) edition, Enterprise
edition.
|
boolean |
|
| display_name |
Identifier to use when displaying entity in logs or GUI
Defaults to ID if not set |
string |
Maximum length: 255
Sortable |
| dns_monitor |
Dns monitor
Placeholder for description of property dns_monitor of obj
type HealthMonitor field type str type ref.
|
ALBHealthMonitorDNS |
|
| external_monitor |
External monitor
Placeholder for description of property external_monitor of
obj type HealthMonitor field type str type ref.
|
ALBHealthMonitorExternal |
|
| failed_checks |
Failed checks
Number of continuous failed health checks before the server
is marked down.
Allowed values are 1-50.
Default value when not specified in API or module is
interpreted by ALB Controller as 2.
|
integer |
Minimum: 1
Maximum: 50
Default: "2" |
| http_monitor |
Http monitor
Placeholder for description of property http_monitor of obj
type HealthMonitor field type str type ref.
|
ALBHealthMonitorHttp |
|
| https_monitor |
Https monitor
Placeholder for description of property https_monitor of
obj type HealthMonitor field type str type ref.
|
ALBHealthMonitorHttp |
|
| id |
Unique identifier of this resource |
string |
Sortable |
| imap_monitor |
Imap monitor
Health monitor for IMAP. |
ALBHealthMonitorImap |
|
| imaps_monitor |
Imaps monitor
Health monitor for IMAPS. |
ALBHealthMonitorImap |
|
| is_federated |
Is federated
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.
Allowed in Basic(Allowed values- false) edition,
Essentials(Allowed values- false) edition, Enterprise
edition.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
|
boolean |
Default: "False" |
| 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" |
| markers |
Markers
List of labels to be used for granular RBAC.
Allowed in Basic edition, Essentials edition, Enterprise
edition.
|
array of ALBRoleFilterMatchLabel |
|
| monitor_port |
Monitor port
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'.
|
integer |
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 |
| pop3_monitor |
Pop3 monitor
Health monitor for POP3. |
ALBHealthMonitorPop3 |
|
| pop3s_monitor |
Pop3s monitor
Health monitor for POP3S. |
ALBHealthMonitorPop3 |
|
| radius_monitor |
Radius monitor
Health monitor for Radius.
Allowed in Basic edition, Essentials edition, Enterprise
edition.
|
ALBHealthMonitorRadius |
|
| realization_id |
A unique identifier assigned by the system for realizing intent
This is a UUID generated by the system for realizing the entity object.
In most cases this should be same as 'unique_id' of the entity. However,
in some cases this can be different because of entities have migrated thier
unique identifier to NSX Policy intent objects later in the timeline and did
not use unique_id for realization. Realization id is helpful for users to
debug data path to correlate the configuration with corresponding intent.
|
string |
Readonly |
| receive_timeout |
Receive timeout
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.
Default value when not specified in API or module is
interpreted by ALB Controller as 4.
|
integer |
Minimum: 1
Maximum: 2400
Default: "4" |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| resource_type |
Must be set to the value ALBHealthMonitor |
string |
|
| send_interval |
Send interval
Frequency, in seconds, that monitors are sent to a server.
Allowed values are 1-3600.
Unit is SEC.
Default value when not specified in API or module is
interpreted by ALB Controller as 10.
|
integer |
Minimum: 1
Maximum: 3600
Default: "10" |
| sip_monitor |
Sip monitor
Health monitor for SIP.
Allowed in Basic edition, Essentials edition, Enterprise
edition.
|
ALBHealthMonitorSIP |
|
| smtp_monitor |
Smtp monitor
Health monitor for SMTP. |
ALBHealthMonitorSmtp |
|
| smtps_monitor |
Smtps monitor
Health monitor for SMTPS. |
ALBHealthMonitorSmtp |
|
| successful_checks |
Successful checks
Number of continuous successful health checks before server
is marked up.
Allowed values are 1-50.
Default value when not specified in API or module is
interpreted by ALB Controller as 2.
|
integer |
Minimum: 1
Maximum: 50
Default: "2" |
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| tcp_monitor |
Tcp monitor
Placeholder for description of property tcp_monitor of obj
type HealthMonitor field type str type ref.
|
ALBHealthMonitorTcp |
|
| type |
Type
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.
Allowed in Basic(Allowed values-
HEALTH_MONITOR_PING,HEALTH_MONITOR_TCP,HEALTH_MONITOR_UDP,HEALTH_MONITOR_HTTP,HEALTH_MONITOR_HTTPS)
edition, Essentials(Allowed values-
HEALTH_MONITOR_PING,HEALTH_MONITOR_TCP,HEALTH_MONITOR_UDP)
edition, Enterprise edition.
|
ALBHealthMonitorType |
Required |
| udp_monitor |
Udp monitor
Placeholder for description of property udp_monitor of obj
type HealthMonitor field type str type ref.
|
ALBHealthMonitorUdp |
|
| 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 |