REST API - set

vcenter namespace management load balancers: set

Applies the entire load balancer spec to an existing load balancer configuration. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

PUT https://{server}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}

{
    "ha_proxy_config_set_spec" : {
        "password" : "secret string",
        "servers" : [
            {
                "port" : 1,
                "host" : "string"
            },
            {
                "port" : 1,
                "host" : "string"
            }
        ],
        "certificate_authority_chain" : "string",
        "username" : "string"
    },
    "address_ranges" : [
        {
            "address" : "string",
            "count" : 1
        },
        {
            "address" : "string",
            "count" : 1
        }
    ],
    "provider" : "HA_PROXY"
}

Path Parameters

Name	Type	Description
Required
cluster	string	Identifier of the cluster the load balancer is associated with.
id	string	Identifier of the load balancer.

Body Parameters:

Name	Type	Description
bold = required
-	set_spec	Information about the load balancer object to be set.
-.address_ranges	IP_range[]	List of address ranges that will be used to derive frontend IP addresses for L4 virtual servers. 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. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.address_ranges[].address	string	The starting address of the range. This attribute was added in vSphere API 7.0.1.0.
-.address_ranges[].count	long	The number of IP addresses in the range. This attribute was added in vSphere API 7.0.1.0.
-.provider	string	The `provider` selects a provider from the list of available providers to be used with vSphere Namespaces. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. The `provider` enumerates the kinds of load balancers supported by vSphere Namespaces. This enumeration was added in vSphere API 7.0.1.0. Value is one of: HA_PROXY: This constant was added in vSphere API 7.0.1.0.
-.ha_proxy_config_set_spec	HA_proxy_config_set_spec	The `HA_proxy_config_set_spec` 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. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. It is only relevant when provider has value HA_PROXY. This field is optional and it is only relevant when the value of `provider` is HA_PROXY.
-.ha_proxy_config_set_spec.servers	server[]	Servers is a list of the addresses for the data plane API servers used to configure HAProxy. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.ha_proxy_config_set_spec.servers[].host	string	Load balancer hostname or IPv4 address. This attribute was added in vSphere API 7.0.1.0.
-.ha_proxy_config_set_spec.servers[].port	long	Load balancer port. This attribute was added in vSphere API 7.0.1.0.
-.ha_proxy_config_set_spec.username	string	An administrator user name for accessing the HAProxy Data Plane API server. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.ha_proxy_config_set_spec.password	secret	The password for the administrator user. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.ha_proxy_config_set_spec.certificate_authority_chain	string	CertificateAuthorityChain contains PEM-encoded CA chain which is used to verify x509 certificates received from the server. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request.
400	invalid_argument
400	not_allowed_in_current_state	if the associated cluster is being disabled or if the load balancer config is already marked for delete.
404	not_found	if `cluster` or `id` cannot be located.
401	unauthenticated	if the user cannot be authenticated.
403	unauthorized	if the user does not have Namespaces.Manage privilege.
400	unsupported	if the specified cluster does not have vSphere Namespaces enabled.