Vcenter FoundationLoadBalancers get
Retrieves information about the load balancer corresponding to the specified foundationLoadBalancer.
This operation was added in vSphere API 9.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
System.Read.
identifier of the load balancer.
The parameter must be an identifier for the resource type: com.vmware.vcenter.FoundationLoadBalancer.
information about the load balancer.
{
"id": "string",
"name": "string",
"owner": "string",
"owner_id": "string",
"replica": 0,
"size": {
"reserve_cpu": false,
"reserve_mem": false,
"size": "string"
},
"available_versions": [
{
"major": 0,
"minor": 0,
"patch": 0,
"revision": 0
}
],
"version": {
"major": 0,
"minor": 0,
"patch": 0,
"revision": 0
},
"placement_spec": {
"cluster": "string",
"res_pool": "string",
"storage_policy": "string",
"folder": "string"
},
"network_config_spec": {
"ntp_servers": [
"string"
],
"dns": {
"servers": [
"string"
],
"search_domains": [
"string"
]
},
"extra_vip_subnets": [
"string"
]
},
"log_config_spec": {
"log_verbosity": "string",
"syslog_server": "string"
},
"load_balancer_controllers": [
{
"address": "string",
"port": 0
}
],
"node_info_map": {
"node_info_map": {
"id": "string",
"version": {
"major": 0,
"minor": 0,
"patch": 0,
"revision": 0
},
"nics": [
{
"ip_settings": [
{
"type": "string",
"ip_address": "string",
"prefix": 0,
"personas": [
"string"
],
"gateway": "string"
}
],
"network": "string",
"device_id": "string"
}
],
"node_runtime_info": {
"vm": "string",
"maintenance_mode": "string",
"management_ip": "string",
"deployment_status": "string",
"deployment_notifications": [
{
"severity": "string",
"title": "string",
"message": "string",
"time": "string"
}
],
"ha_status": "string",
"health_status": "string",
"health_notifications": [
{
"severity": "string",
"title": "string",
"message": "string",
"time": "string"
}
],
"workload_alarms": [
{
"severity": "string",
"title": "string",
"message": "string",
"time": "string"
}
],
"utilization": {
"cpu": "string",
"memory": "string"
}
}
}
},
"trusted_ca": {
"cert_chain": [
"string"
]
},
"runtime": {
"operation_status": "string",
"operation_notifications": [
{
"severity": "string",
"title": "string",
"message": "string",
"time": "string"
}
],
"deployment_status": "string",
"health_status": "string",
"utilization": {
"cpu": "string",
"memory": "string"
}
},
"system_trusted_cas": [
{
"cert_chain": [
"string"
]
}
]
}The identifier of the load balancer.
This property was added in vSphere API 9.0.0.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.FoundationLoadBalancer. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.FoundationLoadBalancer.
The name of the load balancer.
This property was added in vSphere API 9.0.0.0.
The owner of the load balancer.
This property was added in vSphere API 9.0.0.0.
The owner identifier of the load balancer.
This property was added in vSphere API 9.0.0.0.
If missing or null, it means the owner identifier is not configured when creating the load balancer.
The replica number of the load balancer node(s).
This property was added in vSphere API 9.0.0.0.
The load balancer node(s) capacity.
This property was added in vSphere API 9.0.0.0.
The available versions could be used for upgrading.
This property was added in vSphere API 9.0.0.0.
If missing or null means there are no versions for upgrading.
The version of load balancer image.
This property was added in vSphere API 9.0.0.0.
The placement configuration of load balancer node(s).
This property was added in vSphere API 9.0.0.0.
The network configuration of load balancer node(s).
This property was added in vSphere API 9.0.0.0.
The log configuration of load balancer node(s).
This property was added in vSphere API 9.0.0.0.
If missing or null means doesn't configure log setting when creating load balancer.
The location of load balancer controller.
This property was added in vSphere API 9.0.0.0.
If missing or null means doesn't configure load balancer controller when creating load balancer.
The load balancer node(s) information, the key(ID) was dynamically generated when creating the load balancer node and it will stick with the load balancer node during the whole lifecycle, even if you make changes to the load balancer node, such as reconfiguration and redeployment.
This property was added in vSphere API 9.0.0.0.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.FoundationLoadBalancerNode. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.FoundationLoadBalancerNode.
The TLS certificate chain of the load balancer used by load balancer node(s) to verify the load balancer controller.
This property was added in vSphere API 9.0.0.0.
If missing or null, load balancer node(s) use system-wide certificates finishing the verification process for load balancer controller.
The runtime information associated with load balancer.
This property was added in vSphere API 9.0.0.0.
List of trusted CA certificate chains used by load balancer node(s) for verifying the TLS certificates. These certificate chains are imported into the system-wide database to secure TLS connections of load balancer node(s).
This property was added in vSphere API 9.0.0.0.
If missing or null, the system certificate store of the load balancer node(s) will remain empty.
if the caller is not 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 the "System.Read" privilege.
"Vapi Std Errors Unauthorized Object"if the load balancer is not found.
"Vapi Std Errors NotFound Object"if there is a generic error.
"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 -H 'Authorization: <value>' https://{api_host}/api/vcenter/foundation-load-balancers/{foundationLoadBalancer}