Set Load Balancers
Applies the entire load balancer spec to an existing load balancer configuration.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster the load balancer is associated with. The parameter must be an identifier for the resource type: ClusterComputeResource.
string
id
Required
Identifier of the load balancer. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
NamespaceManagementLoadBalancersSetSpec of mimetype application/json
Required
Information about the load balancer object to be set.
{
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"provider": "HA_PROXY"
}
array of
NamespaceManagementIPRange
address_ranges
Required
List of address ranges that will be used to derive frontend IP addresses for L4 virtual servers. This field is ignored in case of AVI load balancer provider. In case of HA_PROXY load balancer provider, at least one range must be provided. A set operation only allows for addition of new IP ranges to the existing list of IP ranges.
provider
Required
The LoadBalancers.Provider enumerates the kinds of load balancers supported by vSphere Namespaces.
HA_PROXY : HAProxy load balancer
AVI : NSX Advanced Load Balancer
Possible values are: HA_PROXY , AVI
avi_config_set_spec
Optional
The LoadBalancers.AviConfigSetSpec is a conditional configuration made available upon selecting the AVI load balancer provider. It is used to configure the load balancer at run time. This field is optional and it is only relevant when the value of LoadBalancers.SetSpec.provider is AVI.
ha_proxy_config_set_spec
Optional
The LoadBalancers.HAProxyConfigSetSpec is a conditional configuration made available upon selecting the HA_PROXY load balancer provider. It is used to configure the load balancer at run time. This field is optional and it is only relevant when the value of LoadBalancers.SetSpec.provider is HA_PROXY.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if if spec contain any errors. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the associated cluster is being disabled or if the load balancer config is already marked for delete. | com.vmware.vapi.std.errors.unsupported : if the specified cluster does not have vSphere Namespaces enabled.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Manage privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$NamespaceManagementIPRange = Initialize-NamespaceManagementIPRange -Address "MyAddress" -Count 0
$NamespaceManagementLoadBalancersSetSpec = Initialize-NamespaceManagementLoadBalancersSetSpec -AddressRanges $NamespaceManagementIPRange -Provider "HA_PROXY"
Invoke-SetClusterIdNamespaceManagementLoadBalancers -Cluster "MyCluster" -Id "MyId" -NamespaceManagementLoadBalancersSetSpec $NamespaceManagementLoadBalancersSetSpec
PowerCLI Client SDK All Parameters Example
$NamespaceManagementIPRange = Initialize-NamespaceManagementIPRange -Address "MyAddress" -Count 0
$NamespaceManagementLoadBalancersServer = Initialize-NamespaceManagementLoadBalancersServer -VarHost "MyVarHost" -Port 0
$NamespaceManagementLoadBalancersHAProxyConfigSetSpec = Initialize-NamespaceManagementLoadBalancersHAProxyConfigSetSpec -Servers $NamespaceManagementLoadBalancersServer -Username "MyUsername" -Password "MyPassword" -CertificateAuthorityChain "MyCertificateAuthorityChain"
$NamespaceManagementLoadBalancersAviConfigSetSpec = Initialize-NamespaceManagementLoadBalancersAviConfigSetSpec -Server $NamespaceManagementLoadBalancersServer -Username "MyUsername" -Password "MyPassword" -CertificateAuthorityChain "MyCertificateAuthorityChain"
$NamespaceManagementLoadBalancersSetSpec = Initialize-NamespaceManagementLoadBalancersSetSpec -AddressRanges $NamespaceManagementIPRange -Provider "HA_PROXY" -HaProxyConfigSetSpec $NamespaceManagementLoadBalancersHAProxyConfigSetSpec -AviConfigSetSpec $NamespaceManagementLoadBalancersAviConfigSetSpec
Invoke-SetClusterIdNamespaceManagementLoadBalancers -Cluster "MyCluster" -Id "MyId" -NamespaceManagementLoadBalancersSetSpec $NamespaceManagementLoadBalancersSetSpec
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"address_ranges":[{"address":"string","count":0}],"avi_config_set_spec":{"certificate_authority_chain":"string","password":"string","server":{"host":"string","port":0},"username":"string"},"ha_proxy_config_set_spec":{"certificate_authority_chain":"string","password":"string","servers":[{"host":"string","port":0}],"username":"string"},"provider":"HA_PROXY"}' https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: set
Availability
Added in 7.0.3.0
