Update Load Balancer Config

Updates the Load Balancer service configuration on Edge Gateway.

Request

URI

PUT

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

COPY

Path Parameters

string

gatewayId

Required

gatewayId

string

gatewayId

Required

gatewayId

Request Body

EdgeGatewayLoadBalancerConfig of type(s) application/json

Required

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

boolean

enabled

Required

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

string

serviceNetworkDefinition

Optional

The 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. This field cannot be updated.

EntityReference

loadBalancerCloudRef

Optional

loadBalancerCloudRef

string

licenseType

Optional

The license type of the backing Load Balancer Cloud.