The NSX Edge load balancer distributes incoming service requests evenly among multiple servers in such a way that the load distribution is transparent to users. Load balancing thus helps in achieving optimal resource utilization, maximizing throughput, minimizing response time, and avoiding overload. NSX Edge provides load balancing up to Layer 7.

■

API-URL is a URL of the form https://vcloud.example.com/network.

■

id is a vCloud Director unique identifier in the form of a UUID, as defined by RFC 4122.

■

# is a small integer used in an NSX object identifier.

Summary of NSX Edge Load Balancer Requests

Operation

Request

Request Body

Response

Retrieve the load balancer configuration for the edge with identifier id.

GET API-URL/edges/id/loadbalancer/config

None

loadBalancer

Update the load balancer configuration for the edge with identifier id.

PUT API-URL/edges/id/loadbalancer/config

loadBalancer

204 No Content

Delete the load balancer configuration for the edge with identifier id.

DELETE API-URL/edges/id/loadbalancer/config

None

204 No Content

Retrieve the load balancer virtual server configuration for the edge with identifier id.

GET API-URL/edges/id/loadbalancer/config/virtualservers

None

loadBalancer

Update the load balancer virtual server configuration for the edge with identifier id. by appending the virtual server defined in the request body.

POST API-URL/edges/id/loadbalancer/config/virtualservers

virtualServer

201 Created

Delete the load balancer virtual server configuration for the edge with identifier id.

DELETE API-URL/edges/id/loadbalancer/config/virtualservers

None

204 No Content

Retrieve the configuration of the load balancer virtual server with identifier virtualServer-# for the edge with identifier id.

GET API-URL/edges/id/loadbalancer/config/virtualservers/virtualServer-#

None

virtualServer

Update the configuration of the load balancer virtual server with identifier virtualServer-# for the edge with identifier id.

PUT API-URL/edges/id/loadbalancer/config/virtualservers/virtualServer-#

virtualServer

204 No Content

Delete the configuration of the load balancer virtual server with identifier virtualServer-# for the edge with identifier id.

DELETE API-URL/edges/id/loadbalancer/config/virtualservers /virtualServer-#

None

204 No Content

Retrieve the load balancer pool configuration for the edge with identifier id

GET API-URL/edges/id/loadbalancer/config/pools

None

loadBalancer

Update the load balancer pool configuration for the edge with identifier id by appending the pool defined in the request body.

POST API-URL/edges/id/loadbalancer/config/pools

pool

201 Created

Delete the load balancer pool configuration for the edge with identifier id

DELETE API-URL/edges/id/loadbalancer/config/pools

None

204 No Content

Retrieve the load balancer pool with id pool-# for the edge with identifier id

GET API-URL/edges/id/loadbalancer/config/pools/pool-#

None

pool

Update the load balancer pool with id pool-# for the edge with identifier id

PUT API-URL/edges/id/loadbalancer/config/pools/pool-#

pool

204 No Content

Delete the load balancer pool with id pool-# for the edge with identifier id

DELETE API-URL/edges/id/loadbalancer/config/pools/pool-#

None

204 No Content

Retrieve the load balancer application profile configuration for the edge with identifier id

GET API-URL/edges/id/loadbalancer/config/applicationprofiles

None

loadBalancer

Update the load balancer application profile configuration for the edge with identifier id to append the application profile defined in the request body.

POST API-URL/edges/id/loadbalancer/config/applicationprofiles

applicationProfile

201 Created

Delete the load balancer application profile configuration for the edge with identifier id

DELETE API-URL/edges/id/loadbalancer/config/applicationprofiles

None

204 No Content

Retrieve the load balancer application profile with id applicationProfile-# for the edge with identifier id

GET API-URL/edges/id/loadbalancer/config/applicationprofiles/applicationProfile-#

None

applicationProfile

Update the load balancer application profile with id for the edge with identifier applicationProfile-# id

PUT API-URL/edges/id/loadbalancer/config/applicationprofiles/applicationProfile-#

applicationProfile

204 No Content

Delete the load balancer application profile with id applicationProfile-# for the edge with identifier id

DELETE API-URL/edges/id/loadbalancer/config/applicationprofiles/applicationProfile-#

None

204 No Content

Retrieve the load balancer application rule configuration for the edge with identifier id

GET API-URL/edges/id/loadbalancer/config/applicationrules

None

loadBalancer

Update the load balancer application rule configuration for the edge with identifier id to append the application rule defined in the request body.

POST API-URL/edges/id/loadbalancer/config/applicationrules

applicationRule

201 Created

Delete the load balancer application rule configuration for the edge with identifier id

DELETE API-URL/edges/id/loadbalancer/config/applicationrules

None

204 No Content

Retrieve the load balancer application rule with id applicationRule-# for the edge with identifier id

GET API-URL/edges/id/loadbalancer/config/application rules/applicationRule-#

None

applicationRule

Update the load balancer application rule with id applicationRule-# for the edge with identifier id

PUT API-URL/edges/id/loadbalancer/config/applicationrules/applicationRule-#

applicationRule

204 No Content

Delete the load balancer application rule with id applicationRule-# for the edge with identifier id.

DELETE API-URL/edges/id/loadbalancer/config/applicationrules/applicationRule-#

None

204 No Content

Retrieve the load balancer monitor configuration for the edge with identifier id.

GET API-URL/edges/id/loadbalancer/config/monitors

None

loadBalancer

Update the load balancer monitor configuration for the edge with identifier id to append the monitor defined in the request body.

POST API-URL/edges/id/loadbalancer/config/monitors

monitor

201 Created

Delete the load balancer monitor configuration for the edge with identifier id.

DELETE API-URL/edges/id/loadbalancer/config/monitors

None

204 No Content

Retrieve the load balancer monitor with id monitor-# for the edge with identifier id.

GET API-URL/edges/id/loadbalancer/config/monitors/monitor-#

None

monitor

Update the load balancer monitor with id monitor-# for the edge with identifier id.

PUT API-URL/edges/id/loadbalancer/config/monitors/monitor-#

monitor

204 No Content

Delete the load balancer monitor with id monitor-# for the edge with identifier id.

DELETE API-URL/edges/id/loadbalancer/config/monitors/monitor-#

None

204 No Content

Retrieve load balancer status and statistics for the edge with identifier id.

GET API-URL/edges/id/loadbalancer/statistics

None

loadBalancerStatusAndStats

Enable load balancer pool member identified by member- # on the edge with identifier id.

POST API-URL/edges/id/loadbalancer/config/members/member-#?enable=true

None

204 No Content