LBPool

Defining access of a Group from a LBVirtualServer and binding to LBMonitorProfile.


Properties

integer
_create_time Optional

Timestamp of resource creation


string
_create_user Optional

ID of the user who created this resource


integer
_last_modified_time Optional

Timestamp of last modification


string
_last_modified_user Optional

ID of the user who last modified this resource


array of ResourceLink
_links Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.


string
_protection Optional

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.


integer
_revision Optional

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.


string
_schema Optional

Schema for this resource


_self Optional

Link to this resource


boolean
_system_owned Optional

Indicates system owned resource


array of string
active_monitor_paths Optional

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 disabled by default and can be enabled for a server pool by binding a health monitor to the pool. Currently, only one active health monitor can be configured per server pool.


string
algorithm Optional

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.

Possible values are: ROUND_ROBINWEIGHTED_ROUND_ROBINLEAST_CONNECTIONWEIGHTED_LEAST_CONNECTIONIP_HASH


children Optional

subtree for this type within policy tree containing nested elements.


string
description Optional

Description of this resource


string
display_name Optional

Defaults to ID if not set


string
id Optional

Unique identifier of this resource


boolean
marked_for_delete Optional

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.


member_group Optional

Load balancer pool support grouping object as dynamic pool members. When member group is defined, members setting should not be specified.


array of LBPoolMember
members Optional

Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port.


integer
min_active_members Optional

A pool is considered active if there are at least certain minimum number of members.


string
parent_path Optional

Path of its parent


string
passive_monitor_path Optional

Passive healthchecks are disabled by default and can be enabled 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.


string
path Optional

Absolute path of this object


string
relative_path Optional

Path relative from its parent


string
resource_type Optional

The type of this resource.


snat_translation Optional

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.


array of Tag
tags Optional

Opaque identifiers meaningful to the API user


boolean
tcp_multiplexing_enabled Optional

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.


integer
tcp_multiplexing_number Optional

The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.

Property Of

ChildLBPool
Extends

PolicyConfigResource

JSON Example

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "active_monitor_paths": [
        "string"
    ],
    "algorithm": "string",
    "children": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "marked_for_delete": false,
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "description": "string",
    "display_name": "string",
    "id": "string",
    "marked_for_delete": false,
    "member_group": {
        "customized_members": [
            {
                "admin_state": "string",
                "display_name": "string",
                "ip_address": "string",
                "port": "string",
                "weight": 0
            }
        ],
        "group_path": "string",
        "ip_revision_filter": "string",
        "max_ip_list_size": 0,
        "port": 0
    },
    "members": [
        {
            "admin_state": "string",
            "backup_member": false,
            "display_name": "string",
            "ip_address": "string",
            "max_concurrent_connections": 0,
            "port": "string",
            "weight": 0
        }
    ],
    "min_active_members": 0,
    "parent_path": "string",
    "passive_monitor_path": "string",
    "path": "string",
    "relative_path": "string",
    "resource_type": "string",
    "snat_translation": {
        "type": "string"
    },
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "tcp_multiplexing_enabled": false,
    "tcp_multiplexing_number": 0
}
Feedback

Was this page helpful?