[{"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
DescriptionUpdates the Load Balancer service configuration on Edge Gateway.
Request
URLURL
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/loadBalancer
Path Parameters
Path Parameters
string
gatewayId
Required
Request Body
Request Body
EdgeGatewayLoadBalancerConfig
of type(s) application/json
Required
{
"enabled": false
}
boolean
enabled
Required
A flag indicating whether Load Balancer Service is enabled or not.
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.
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 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.
Authentication
This operation uses the following authentication methods.
No error details were provided in the OpenAPI specification.
Code SamplesCode Samples
cURL Command
curl -X PUT -H "Content-Type: application/json" -d '{"enabled":false,"licenseType":"string","loadBalancerCloudRef":{"id":"string","name":"string"},"serviceNetworkDefinition":"string"}' https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/loadBalancer
[{"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
Availability
Added in 35.0
