Update Load Balancer Controller

Update Load Balancer Controller

Update an Load Balancer Controller.

Request

URI

PUT

https://{api_host}/cloudapi/1.0.0/loadBalancer/controllers/{loadBalancerControllerId}

COPY

Path Parameters

string

loadBalancerControllerId

Required

loadBalancerControllerId

string

loadBalancerControllerId

Required

loadBalancerControllerId

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",
    "maxCloudCount": 0,
    "maxGatewayCount": 0,
    "maxVirtualServiceCount": 0,
    "usedCloudCount": 0,
    "usedGatewayCount": 0,
    "usedVirtualServiceCount": 0
}

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.

integer

maxCloudCount

Optional

The maximum number of supported clouds for the Load Balancer Controller.

integer

maxGatewayCount

Optional

The maximum number of supported edge gateways for the Load Balancer Controller.

integer

maxVirtualServiceCount

Optional

The maximum number of supported virtual services for the Load Balancer Controller.

integer

usedCloudCount

Optional

The number of used clouds for the Load Balancer Controller.

integer

usedGatewayCount

Optional

The number of used edge gateways for the Load Balancer Controller.

integer

usedVirtualServiceCount

Optional

The number of used virtual services for the Load Balancer Controller.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

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

Availability

Added in 35.0

On This Page

Request

Path Parameters

202 Response Body

Load Balancer Controller Operations

Get Load Balancer Controller

Unregister Load Balancer Controller

Update Load Balancer Controller