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

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

JSON Example

{
	"enabled": false
}

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
    ipv6ServiceNetworkDefinition:
        x-vcloud-added-in: "37.0"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
            - args:
                - arg: CIDR
              constraint: NetworkAddress
    licenseType:
        x-vcloud-added-in: "35.0"
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
        x-vcloud-deprecated-alternative: Please use supportedFeatureSet.
        x-vcloud-deprecated-in: "37.0"
        x-vcloud-removed-in: "37.0"
    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
    supportedFeatureSet:
        x-vcloud-added-in: "37.0"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
[{"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
Availability
Added in 35.0
Parameter To

Update Load Balancer Config
Returned By

Get Load Balancer Config
What's changed in v37.0?

INTRODUCED (2)

Added Properties
supportedFeatureSet
ipv6ServiceNetworkDefinition
CHANGED (2)
Changed Properties
supportedFeatureSet
ipv6ServiceNetworkDefinition

Feedback

Was this page helpful?