1. Types
  2. vcenter
  3. namespace management
  4. load balancers

vcenter namespace management load balancers: update spec

The update_spec encapsulates configuration allowed for when updating configuration for load balancers. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Representation:

{
    "ha_proxy_config_update_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"
}

Attributes:

Name Type Description
Required
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.
ha_proxy_config_update_spec.servers[].host string Load balancer hostname or IPv4 address. This attribute was added in vSphere API 7.0.1.0.
ha_proxy_config_update_spec.servers[].port long Load balancer port. This attribute was added in vSphere API 7.0.1.0.
Optional
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. An update 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.

Optional. If unset, the existing list of address ranges will not be modified.
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.

Optional. If set, corresponding load balancer UpdateSpec will be used to update the configuration. Note: This field cannot be updated and can only be used a qualifer for the provider specific update spec.
ha_proxy_config_update_spec HA_proxy_config_update_spec The HA_proxy_config_update_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. If unset, the HAProxy load balancer configuration will not be modified.
ha_proxy_config_update_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.

Optional. If unset, the existing list of server information will not be modified.
ha_proxy_config_update_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.

Optional. If unset, the existing username will not be modified.
ha_proxy_config_update_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.

Optional. If unset, the existing password will not be modified.
ha_proxy_config_update_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.

Optional. If unset, the existing PEM-encoded CA chain will not be modified.