[{"label":"Latest (v37.0)","version":"latest"},{"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

Get Load Balancer Config

Description

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

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
gatewayId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns EdgeGatewayLoadBalancerConfig of type(s) application/json;version=37.0
{
	"enabled": false,
	"ipv6ServiceNetworkDefinition": "string",
	"licenseType": "string",
	"loadBalancerCloudRef": {
		"id": "string",
		"name": "string"
	},
	"serviceNetworkDefinition": "string",
	"supportedFeatureSet": "string"
}
boolean
enabled Required

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


string
ipv6ServiceNetworkDefinition Introduced Changed 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.


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 Introduced Changed 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.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/loadBalancer
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vcloud-default-sort:
    default-sort-field: name
    sort-ascending: true


[{"label":"Latest (v37.0)","version":"latest"},{"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
Feedback

Was this page helpful?