[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]

vmware-cloud-director

Update Load Balancer Config

Description

Updates the Load Balancer service configuration on Edge Gateway.

Request

URL

put

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

Copy

Path Parameters

string

gatewayId Required

Request Body

EdgeGatewayLoadBalancerConfig of type(s) application/json Required

Show optional properties

{
	"enabled": false
}

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

boolean

enabled Required

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

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.

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.

EntityReference

loadBalancerCloudRef Optional

Reference to the Load Balancer Cloud. This cloud is used by Edge Gateway’s Load Balancer Virtual Services and Pools.

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

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.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

202 Accepted

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure.

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"enabled":false,"ipv6ServiceNetworkDefinition":"string","licenseType":"string","loadBalancerCloudRef":{"id":"string","name":"string"},"serviceNetworkDefinition":"string","supportedFeatureSet":"string","transparentModeEnabled":false}' https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/loadBalancer

vmware-cloud-director

Availability

Added in 35.0

Edge Gateway Load Balancer Operations

get

Get Load Balancer Config

put

Update Load Balancer Config

Update Load Balancer Config

Request

URL

Path Parameters

Request Body

Authentication

ApiKeyAuth

Response

202 Accepted

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

Availability

On This Page

Edge Gateway Load Balancer Operations

Was this page helpful?