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

Register Load Balancer Controller

Description

Register a new Load Balancer Controller to be used with vCloud Director.

Request

Request

URL

URL


post
https://{api_host}/cloudapi/1.0.0/loadBalancer/controllers
Copy

Request Body

Request Body

LoadBalancerController of type(s) application/json Required
{
	"name": "string",
	"password": "string",
	"url": "https://loadBalancerController.vmware.com",
	"username": "string"
}
string
username Required

Username to connect to the Load Balancer Controller.


string
name Required

The name of the Load Balancer Controller. Names for Load Balancer Controllers must be unique across the system.


string
password Required

Cleartext password to connect to the Load Balancer Controller.


string as uri
url Required

The URL of the Load Balancer Controller. URLs for Load Balancer Controllers must be unique across the system.


string
id Optional

The id of the Load Balancer Controller in URN format.


string
licenseType Optional

The license type of the Load Balancer Controller.

  • BASIC - Basic edition of the NSX Advanced Load Balancer.
  • ENTERPRISE - Full featured edition of the NSX Advanced Load Balancer.


string
description Optional

Description for the registered Load Balancer Controller.


string
version Optional

The version of the load balancer controller.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted

The request have been accepted and the task to monitor the request is in the Location header.

Errors

Errors

400

Invalid configuration.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"description":"string","id":"urn:vcloud:loadBalancerController:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","licenseType":"string","name":"string","password":"string","url":"https://loadBalancerController.vmware.com","username":"string","version":"string"}' https://{api_host}/cloudapi/1.0.0/loadBalancer/controllers
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?