Get Load Balancer Config

Retrieves the current state of Load Balancer service on Edge Gateway.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/loadBalancer

COPY

Path Parameters

string

gatewayId

Required

gatewayId

string

gatewayId

Required

gatewayId

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns EdgeGatewayLoadBalancerConfig of type(s) application/json;version=37.3

{
    "enabled": false,
    "serviceNetworkDefinition": "string",
    "ipv6ServiceNetworkDefinition": "string",
    "loadBalancerCloudRef": {
        "name": "string",
        "id": "string"
    },
    "licenseType": "string",
    "supportedFeatureSet": "string",
    "transparentModeEnabled": false
}

boolean

enabled

Required

A flag indicating whether Load Balancer Service is enabled or not.

string

serviceNetworkDefinition

Optional

The IPv4 network definition in Gateway CIDR format which will be used by Load Balancer service on edge. All the load balancer service engines associated with the Service Engine Group will be attached to this network. The subnet prefix length must be 25. If nothing is set, the default is 192.168.255.1/25. Default cidr can be configured. Once set, this field cannot be updated. The default IPv4 service network will be used if both the serviceNetworkDefinition and ipv6ServiceNetworkDefinition properties are unset. If both are set, it will still be one service network with a dual IPv4 and IPv6 stack.

string

ipv6ServiceNetworkDefinition

Optional

The IPv6 network definition in Gateway CIDR format which will be used by Load Balancer service on edge. All the load balancer service engines associated with the Service Engine Group will be attached to this network. Once set, this field cannot be updated. The default IPv4 service network will be used if both the serviceNetworkDefinition and ipv6ServiceNetworkDefinition properties are unset. If both are set, it will still be one service network with a dual IPv4 and IPv6 stack.

EntityReference

loadBalancerCloudRef

Optional

loadBalancerCloudRef

string

licenseType

Optional

The license type of the backing Load Balancer Cloud.

BASIC - Basic edition of the NSX Advanced Load Balancer.
ENTERPRISE - Full featured edition of the NSX Advanced Load Balancer.

string

supportedFeatureSet

Optional

The Load Balancer Feature set supported by the Edge Gateway. Allowed values are:

STANDARD - Edge Gateway supports STANDARD set of features for Load Balancing.
PREMIUM - Edge Gateway supports both STANDARD and PREMIUM set of features for Load Balancing. All Load Balancer Service Engine Groups assigned to this Edge Gateway must support PREMIUM feature set in order to allow PREMIUM features on this gateway.

A Service Engine Group with STANDARD supported feature set can only be assigned to Edge Gateway with STANDARD supported feature set. A Service Engine Group with PREMIUM supported feature set can be assigned to Edge Gateway with both STANDARD and PREMIUM supported feature sets.

boolean

transparentModeEnabled

Optional

A flag indicating whether or not this Edge Gateway has been configured to support transparent load balancing.

Availability

Added in 35.0

On This Page

Description

Request

Path Parameters

Authentication

Response