Vcenter NamespaceManagement LoadBalancers update
Updates the load balancer configuration. The specified configuration is applied partially and missing or null fields in spec will leave those parts of configuration as-is.
This operation was added in vSphere API 7.0.3.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
ClusterComputeResourcereferenced by the parameter cluster requiresNamespaces.Manage.
Identifier of the cluster the load balancer is associated with.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Identifier of the load balancer.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig.
Information about the load balancer object to be updated.
{
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"provider": "string",
"ha_proxy_config_update_spec": {
"username": "string",
"password": "string",
"certificate_authority_chain": "string"
},
"avi_config_update_spec": {
"username": "string",
"password": "string",
"certificate_authority_chain": "string"
}
}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. An update operation only allows for addition of new IP ranges to the existing list of IP ranges.
This property was added in vSphere API 7.0.3.0.
If missing or null, the existing list of address ranges will not be modified.
The Vcenter NamespaceManagement LoadBalancers UpdateSpec.provider selects a provider from the list of available providers to be used with vSphere Namespaces.
For more information see: Vcenter NamespaceManagement LoadBalancers Provider.
This property was added in vSphere API 7.0.3.0.
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.
This property is deprecated as of vSphere API 9.0.0.0. Instead, use Vcenter NamespaceManagement Supervisors Networks Edges FoundationLoadBalancerUpdateSpec with provider Vcenter NamespaceManagement Networks Edges EdgeProvider.VSPHERE_FOUNDATION.
The Vcenter NamespaceManagement LoadBalancers HAProxyConfigUpdateSpec 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 property was added in vSphere API 7.0.3.0.
If missing or null, the HAProxy load balancer configuration will not be modified.
The Vcenter NamespaceManagement LoadBalancers AviConfigUpdateSpec 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 property was added in vSphere API 7.0.3.0.
If missing or null, the Avi load balancer configuration will not be modified.
Success!
Vapi Std Errors InvalidArgument:
- if spec contains any errors.
- if if spec contain any errors.
Vapi Std Errors NotAllowedInCurrentState if the associated cluster is being disabled or if the load balancer config is already marked for delete.
Vapi Std Errors Unsupported if the specified cluster does not have vSphere Namespaces enabled.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the user cannot be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user does not have Namespaces.Manage privilege.
"Vapi Std Errors Unauthorized Object"if cluster or id cannot be located.
"Vapi Std Errors NotFound Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'