InlineEdgeLoadBalancerPool1

JSON Example

{
    "name": "string",
    "defaultPort": 0,
    "portTranslationEnabled": false,
    "gracefulTimeoutPeriod": 0,
    "algorithm": "string",
    "healthMonitors": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "systemDefined": false,
            "successfulChecksCount": 0,
            "failedChecksCount": 0,
            "sendInterval": 0,
            "receiveTimeout": 0,
            "httpSettings": {
                "port": 0,
                "requestHeader": "string",
                "requestBody": "string",
                "useExactRequest": false,
                "expectedResponseData": "string",
                "expectedResponseCodes": [
                    "string"
                ],
                "authSettings": {
                    "type": "string",
                    "username": "string",
                    "password": "string"
                }
            },
            "httpsSettings": {
                "port": 0,
                "requestHeader": "string",
                "requestBody": "string",
                "useExactRequest": false,
                "expectedResponseData": "string",
                "expectedResponseCodes": [
                    "string"
                ],
                "authSettings": {
                    "type": "string",
                    "username": "string",
                    "password": "string"
                }
            },
            "tcpSettings": {
                "port": 0,
                "requestData": "string",
                "expectedResponseData": "string"
            },
            "udpSettings": {
                "port": 0,
                "requestData": "string",
                "expectedResponseData": "string"
            },
            "gatewayRef": {
                "name": "string",
                "id": "string"
            }
        }
    ],
    "persistenceProfile": {
        "name": "string",
        "type": "string",
        "value": "string"
    },
    "members": [
        {
            "ipAddress": "string",
            "port": 0,
            "ratio": 0,
            "enabled": false,
            "healthStatus": "string",
            "markedDownBy": [
                "string"
            ],
            "detailedHealthMessage": "string"
        }
    ],
    "memberGroupRef": {
        "name": "string",
        "id": "string"
    },
    "virtualServiceRefs": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "gatewayRef": {
        "name": "string",
        "id": "string"
    },
    "caCertificateRefs": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "commonNameCheckEnabled": false,
    "domainNames": [
        "*.example.com",
        "www.vmware.com"
    ],
    "sslEnabled": false
}

string

name

Required

Name for the Load Balancer Pool. Name is unique across all pools for an Edge Gateway.

integer As int32 As int32

defaultPort

Optional

The destination server port used by the traffic sent to the member.

boolean

portTranslationEnabled

Optional

Whether to enable port translation or not. By default, requests are forwarded to servers on the default port of virtual service. When set to false, requests are forwarded to servers on the same port as the receiving port of the virtual service.

integer As int32 As int32

gracefulTimeoutPeriod

Optional

Maximum time (in minutes) to gracefully disable a member. Virtual service waits for the specified time before terminating the existing connections to the members that are disabled. Special values: 0 represents 'Immediate', -1 represents 'Infinite'.

string

algorithm

Optional

The algorithm for choosing a member within the pool's list of available members for each new connection. Default value is "LEAST_CONNECTIONS". Supported algorithms are:

LEAST_CONNECTIONS
ROUND_ROBIN
CONSISTENT_HASH
FASTEST_RESPONSE
LEAST_LOAD
FEWEST_SERVERS
RANDOM
FEWEST_TASKS
CORE_AFFINITY

CONSISTENT_HASH uses Source IP Address hash. Using FASTEST_RESPONSE, LEAST_LOAD, FEWEST_SERVERS, RANDOM, FEWEST_TASKS, CORE_AFFINITY algorithms requires an Edge Gateway Load Balancer with PREMIUM feature set.

array of EdgeLoadBalancerHealthMonitor

healthMonitors

Optional

Member server's health can be monitored by using one or more health monitors. Active monitors generate synthetic traffic and mark a server up or down based on the response. This is deprecated in favor of the top-level health monitor API. Setting this property will throw an error.

EdgeLoadBalancerPersistenceProfile

persistenceProfile

Optional

Specifies the Persistence profile for a Load Balancer Pool. Persistence profile will ensure that the same user sticks to the same server for a desired duration of time. If the persistence profile is unmanaged by Cloud Director, updates that leave the values unchanged will continue to use the same unmanaged profile. Any changes made to the persistence profile will cause Cloud Director to switch the pool to a profile managed by Cloud Director.

array of EdgeLoadBalancerPoolMember

members

Optional

The list of destination servers which are used by the Load Balancer Pool to direct load balanced traffic. Only one of members or memberGroupRef can be specified.

EntityReference

memberGroupRef

Optional

Entity reference used to describe VCD entities

array of EntityReference

virtualServiceRefs

Optional

The list of Load Balancer Virtual Services associated with this Load balancer Pool.

EntityReference

gatewayRef

Required

Entity reference used to describe VCD entities

array of EntityReference

caCertificateRefs

Optional

The root certificates to use when validating certificates presented by the pool members.

boolean

commonNameCheckEnabled

Optional

Whether to check the common name of the certificate presented by the pool member. This cannot be enabled if no caCertificateRefs are specified.

array of string

domainNames

Optional

A list of domain names which will be used to verify the common names or subject alternative names presented by the pool member certificates. It is performed only when common name check (commonNameCheckEnabled) is enabled. If common name check is enabled, but domain names are not specified then the incoming host header will be used to check the certificate.

boolean

sslEnabled

Optional

Whether SSL is enabled for this Pool.

Used By

EdgeLoadBalancerPool