NSX-T Data Center REST API
# ***************************************************************************
# Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential.
# ***************************************************************************
LBNodeUsageSummary (schema)
LB node usage summary for all nodes
The load balancer node usage summary for all nodes from specific
enforcement point. Only edge node is supported. The summary contains all
edge nodes which are configured in edge clusters.
| Name | Description | Type | Notes |
|---|---|---|---|
| alarm | Alarm Information Details Alarm information details. |
PolicyRuntimeAlarm | Readonly |
| current_load_balancer_credits | Current load balancer credits Current load balancer credits in use for all nodes. For example, configuring a medium load balancer on a node consumes 10 credits. If there are 2 medium instances configured, the current load balancer credit number is 2 * 10 = 20. |
integer | Readonly |
| current_pool_member_count | The current pool member count The overall count of pool members configured on all nodes. |
integer | Readonly |
| enforcement_point_path | Enforcement point Path Policy Path referencing the enforcement point where the info is fetched. |
string | Readonly |
| load_balancer_credit_capacity | Load balancer credit capacity The load balancer credit capacity means the maximum credits which can be used for load balancer service configuration for all nodes. |
integer | Readonly |
| node_counts | Array of node count for each severity The property identifies array of node count for each severity. |
array of LBNodeCountPerSeverity | Readonly |
| node_usages | LB node usages The property identifies all LB node usages. By default, it is not included in response. It exists when parameter ?include_usages=true. |
array of LBNodeUsage (Abstract type: pass one of the following concrete types) LBEdgeNodeUsage LBVirtualNetworkApplianceUsage |
Readonly |
| severity | LB usage severity The severity calculation is based on overall credit usage percentage of load balancer for all nodes. |
LBUsageSeverity | Readonly |
| usage_percentage | Usage percentage The overall usage percentage of all nodes for load balancer. The value is the overall load balancer credit usage percentage. |
number | Readonly |
| pool_member_capacity | The overall pool member capacity This is a deprecated property. There is no LB pool member limit per edge node or per virtual network appliance anymore. For backward compatible consideration, the property value is set as the max configurable pool member number of the largest supported LB size on the node for all edge nodes. It won't calculate virtual network appliances. |
integer | Deprecated Readonly |