[{"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

EdgeGatewayLoadBalancerConfig

Describes Load Balancer Service configuration on an Edge Gateway.

Properties

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.

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

JSON Example

Show optional properties

{
	"enabled": false
}

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

Vendor Extensions

This class contains the following vendor extensions defined in the spec:

x-vcloud-property-annotations:
    enabled:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    licenseType:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    loadBalancerCloudRef:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
        x-vcloud-restricted: Visible to provider users only
    serviceNetworkDefinition:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
            - args:
                - arg: CIDR
              constraint: NetworkAddress

vmware-cloud-director

Availability

Added in 35.0

Parameter To

Update Load Balancer Config

Returned By

Get Load Balancer Config