REST API - config

vcenter namespace management load balancers: config spec

The config_spec encapsulates load balancer configuration on vSphere Namespaces. This structure was added in vSphere API 7.0.1.0.

Representation:

JSON

{
    "ha_proxy_config_create_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",
    "id" : "obj-103"
}

Attributes:

Name	Type	Description
Required
id	string	An identifier that identifies a load balancer and can be used to query or configure load balancer properties via these resources. The identifier has DNS_LABEL restrictions as specified in . This must be an alphanumeric (a-z and 0-9) string, with a maximum length of 63 characters and with the '-' character allowed anywhere except the first or last character. This name is unique across all Namespaces in this vCenter server. This attribute was added in vSphere API 7.0.1.0. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.vcenter.namespace_management.LoadBalancerConfig`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.vcenter.namespace_management.LoadBalancerConfig`.
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. This attribute was added in vSphere API 7.0.1.0.
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. This attribute was added in vSphere API 7.0.1.0. 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_create_spec.servers	server[]	Servers is a list of the addresses for the data plane API servers used to configure Virtual Servers. This attribute was added in vSphere API 7.0.1.0.
ha_proxy_config_create_spec.servers[].host	string	Load balancer hostname or IPv4 address. This attribute was added in vSphere API 7.0.1.0.
ha_proxy_config_create_spec.servers[].port	long	Load balancer port. This attribute was added in vSphere API 7.0.1.0.
ha_proxy_config_create_spec.username	string	An administrator user name for accessing the HAProxy Data Plane API server. This attribute was added in vSphere API 7.0.1.0.
ha_proxy_config_create_spec.password	secret	The password for the administrator user. This attribute was added in vSphere API 7.0.1.0.
ha_proxy_config_create_spec.certificate_authority_chain	string	CertificateAuthorityChain contains PEM-encoded CA chain which is used to verify x509 certificates received from the server. This attribute was added in vSphere API 7.0.1.0.
Optional
ha_proxy_config_create_spec	HA_proxy_config_create_spec	The `HA_proxy_config_create_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. This attribute was added in vSphere API 7.0.1.0. 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.