Cloud.NSX.LoadBalancer

Cloud.NSX.LoadBalancer
Cloud.NSX.LoadBalancer

Request schema for provisioning Compute Load Balancer

JSON Example
{
    "address": "string",
    "constraints": [
        {
            "tag": "string"
        }
    ],
    "count": 0,
    "gateway": "string",
    "instances": [
        "string"
    ],
    "loggingLevel": "string",
    "name": "string",
    "network": "string",
    "providerId": "string",
    "resourceName": "string",
    "routes": [
        {
            "algorithm": "string",
            "algorithmParameters": "string",
            "healthCheckConfiguration": {
                "healthyThreshold": 0,
                "httpMethod": "string",
                "intervalSeconds": 0,
                "passiveMonitor": false,
                "port": "string",
                "protocol": "string",
                "requestBody": "string",
                "responseBody": "string",
                "timeoutSeconds": 0,
                "unhealthyThreshold": 0,
                "urlPath": "string"
            },
            "instancePort": "string",
            "instanceProtocol": "string",
            "port": "string",
            "protocol": "string"
        }
    ],
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "type": "string"
}
string
address
Optional

The DNS address of the load balancer.

array of object
constraints
Optional

Load balancer constraints

integer
count
Optional

The number of resource instances to be created.

string
gateway
Optional

Gateway to use for creating Load Balancer service.

array of string
instances
Required

A list of machines, by ID, to add to the load balancer pool.

string
loggingLevel
Optional

The load balancer logging level. The logging levels that you define for any load balancer component on the blueprint apply to all load balancers in the blueprint.The available logging level options are NONE, EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, INFO, DEBUG or NOTICE.

NONE logging level in YAML maps to:

-NSX-V: "Logging Disabled": true and "Log Level": info

-NSXT-T: "Error Log Level": INFO

Possible values are : NONE, EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTICE,
string
name
Optional

Load balancer machine name.

string
network
Required

The network to attach to the load balancer.

string
providerId
Optional

A unique identifier of the resource in the context of the provider.

string
resourceName
Optional

The actual name of the load balancer machine determined after the allocation.

array of object
routes
Required

Settings for incoming requests to reach the load balancer, for requests to be routed to machines in the pool, and for checking the health of machines in the pool.

array of object
tags
Optional

Resource categorization, in case-sensitive key names, or in key-value pairs.

string
type
Optional

Load balancers are available in small, medium, and large sizes. Based on the load balancer size, the load balancer can host different virtual servers and pool members.

Translation from YAML to NSX-V endpoint:

-SMALL: compact

-MEDIUM: large

-LARGE: quad-large

-XLARGE: xlarge

Possible values are : SMALL, MEDIUM, LARGE, EXTRA_LARGE,