Register Load Balancer Controller

Register Load Balancer Controller

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

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/loadBalancer/controllers
COPY
Request Body
LoadBalancerController of type(s) application/json
Optional 
{
    "id": "urn:vcloud:loadBalancerController:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "string",
    "description": "string",
    "url": "https://loadBalancerController.vmware.com",
    "username": "string",
    "password": "string",
    "licenseType": "string",
    "version": "string"
}
string
id
Optional

The id of the Load Balancer Controller in URN format.

string
name
Required

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

string
description
Optional

Description for the registered Load Balancer Controller.

string As uri As uri
url
Required

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

string
username
Required

Username to connect to the Load Balancer Controller.

string
password
Required

Cleartext password to connect to the Load Balancer Controller.

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
version
Optional

The version of the load balancer controller.

Authentication
This operation uses the following authentication methods.
Responses
202

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

Operation doesn't return any data structure

400

Invalid configuration.

Returns Error of type(s) */*;version=36.3 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 35.0
On This Page
Load Balancer Controllers Operations
GET
Get Load Balancer Controllers
POST
Register Load Balancer Controller