| _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 |
| active_monitor_paths |
Active monitor path list
In case of active healthchecks, load balancer itself initiates new
connections (or sends ICMP ping) to the servers periodically to check
their health, completely independent of any data traffic. Active
healthchecks are deactivated by default and can be activated for a server
pool by binding a health monitor to the pool. If multiple active
monitors are configured, the pool member status is UP only when the
health check status for all the monitors are UP.
The property is deprecated as NSX-T Load Balancer is deprecated.
|
array of string |
Deprecated |
| algorithm |
Load balancing algorithm
Load Balancing algorithm chooses a server for each new connection by going
through the list of servers in the pool. Currently, following load balancing
algorithms are supported with ROUND_ROBIN as the default.
ROUND_ROBIN means that a server is selected in a round-robin fashion. The
weight would be ignored even if it is configured.
WEIGHTED_ROUND_ROBIN means that a server is selected in a weighted
round-robin fashion. Default weight of 1 is used if weight is not configured.
LEAST_CONNECTION means that a server is selected when it has the least
number of connections. The weight would be ignored even if it is configured.
Slow start would be enabled by default.
WEIGHTED_LEAST_CONNECTION means that a server is selected in a weighted
least connection fashion. Default weight of 1 is used if weight is not
configured. Slow start would be enabled by default.
IP_HASH means that consistent hash is performed on the source IP address of
the incoming connection. This ensures that the same client IP address will
always reach the same server as long as no server goes down or up. It may
be used on the Internet to provide a best-effort stickiness to clients
which refuse session cookies.
|
string |
Enum: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH
Default: "ROUND_ROBIN" |
| children |
Subtree for this type within policy tree
Subtree for this type within policy tree containing nested elements. Note that
this type is applicable to be used in Hierarchical API only.
|
array of ChildPolicyConfigResource
Children are not allowed for this type |
|
| 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 |
| id |
Unique identifier of this resource |
string |
Sortable |
| 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" |
| member_group |
Load balancer member setting with grouping object
Load balancer pool support grouping object as dynamic pool members.
When member group is defined, members setting should not be specified.
|
LBPoolMemberGroup |
|
| members |
Load balancer pool members
Server pool consists of one or more pool members. Each pool member
is identified, typically, by an IP address and a port.
|
array of LBPoolMember |
|
| min_active_members |
Minimum number of active pool members to consider pool as active
A pool is considered active if there are at least certain
minimum number of members.
|
integer |
Minimum: 1
Maximum: 2147483647
Default: "1" |
| origin_site_id |
A unique identifier assigned by the system for knowing which site owns an object
This is a UUID generated by the system for knowing which site owns an object.
This is used in NSX+.
|
string |
Readonly |
| 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" |
| owner_id |
A unique identifier assigned by the system for the ownership of an object
This is a UUID generated by the system for knowing who owns this object.
This is used in NSX+.
|
string |
Readonly |
| parent_path |
Path of its parent
Path of its parent |
string |
Readonly |
| passive_monitor_path |
Passive monitor path
Passive healthchecks are deactivated by default and can be activated by
attaching a passive health monitor to a server pool.
Each time a client connection to a pool member fails, its failed count
is incremented. For pools bound to L7 virtual servers, a connection is
considered to be failed and failed count is incremented if any TCP
connection errors (e.g. TCP RST or failure to send data) or SSL
handshake failures occur. For pools bound to L4 virtual servers, if no
response is received to a TCP SYN sent to the pool member or if a TCP
RST is received in response to a TCP SYN, then the pool member is
considered to have failed and the failed count is incremented.
The property is deprecated as NSX-T Load Balancer is deprecated.
|
string |
Deprecated |
| path |
Absolute path of this object
Absolute path of this object |
string |
Readonly |
| 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 their
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 |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| remote_path |
Path of the object on the remote end.
This is the path of the object on the local managers when queried on the NSX+ service,
and path of the object on NSX+ service when queried from the local managers.
|
string |
Readonly |
| resource_type |
Must be set to the value LBPool |
string |
|
| snat_translation |
Snat translation configuration
Depending on the topology, Source NAT (SNAT) may be required to ensure
traffic from the server destined to the client is received by the load
balancer. SNAT can be enabled per pool. If SNAT is not enabled for a
pool, then load balancer uses the client IP and port (spoofing) while
establishing connections to the servers. This is referred to as no-SNAT
or TRANSPARENT mode. By default Source NAT is enabled as LBSnatAutoMap.
|
LBSnatTranslation
(Abstract type: pass one of the following concrete types)
LBSnatAutoMap
LBSnatDisabled
LBSnatIpPool |
|
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| tcp_multiplexing_enabled |
TCP multiplexing enable flag
TCP multiplexing allows the same TCP connection between load balancer
and the backend server to be used for sending multiple client requests
from different client TCP connections.
The property is deprecated as NSX-T Load Balancer is deprecated.
|
boolean |
Deprecated
Default: "False" |
| tcp_multiplexing_number |
Maximum number of TCP connections for multiplexing
The maximum number of TCP connections per pool that are idly kept alive
for sending future client requests.
The property is deprecated as NSX-T Load Balancer is deprecated.
|
integer |
Deprecated
Minimum: 0
Maximum: 2147483647
Default: "6" |
| unique_id |
A unique identifier assigned by the system
This is a UUID generated by the GM/LM to uniquely identify
entities 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 |