NSX-T Data Center REST API

# *************************************************************************** # Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential. # ***************************************************************************

LBVirtualNetworkApplianceUsage (schema)

The load balancer usage for a virtual network appliance

It contains the load balancer node usage information for the given
virtual network appliance.

Name Description Type Notes
current_large_load_balancer_count The current large load balancer count

The count of large load balancer services configured on the node.
integer Readonly
current_load_balancer_credits Current load balancer credits

The current load balancer credits means the current credits used on the
node. For example, configuring a medium load balancer on a node
consumes 10 credits. If there are 2 medium instances configured on a
node, the current credit number is 2 * 10 = 20.
integer Readonly
current_medium_load_balancer_count The current medium load balancer count

The count of medium load balancer services configured on the node.
integer Readonly
current_pool_count The current pool count.

The count of pools configured on the node.
integer Readonly
current_pool_member_count The current pool member count

The count of pool members configured on the node.
integer Readonly
current_small_load_balancer_count The current small load balancer count

The count of small load balancer services configured on the node.
integer Readonly
current_virtual_server_count The current virtual server count

The count of virtual servers configured on the node.
integer Readonly
current_xlarge_load_balancer_count The current xlarge load balancer count

The count of xlarge load balancer services configured on the node.
integer Readonly
form_factor The form factor of the given edge node or virtual network appliance

The form factor of the given edge node or virtual network appliance.
string Readonly
Enum: SMALL_VIRTUAL_MACHINE, MEDIUM_VIRTUAL_MACHINE, LARGE_VIRTUAL_MACHINE, XLARGE_VIRTUAL_MACHINE, PHYSICAL_MACHINE
load_balancer_credit_capacity Load balancer credit capacity

The load balancer credit capacity means the maximum credits which can
be used for load balancer configuration for the given edge node.
integer Readonly
node_path The node path for load balancer node usage

The property identifies the node path for load balancer node usage.
For example, node_path=/infra/sites/default/enforcement-points/default
/edge-clusters/85175e0b-4d74-461d-83e1-f3b785adef9c/edge-nodes
/86e077c0-449f-11e9-87c8-02004eb37029.
string Required
remaining_large_load_balancer_count The remaining large load balancer count

The remaining count of large load balancer services which can be
configured on the given edge node.
integer Readonly
remaining_medium_load_balancer_count The remaining medium load balancer count

The remaining count of medium load balancer services which can be
configured on the given edge node.
integer Readonly
remaining_small_load_balancer_count The remaining small load balancer count

The remaining count of small load balancer services which can be
configured on the given edge node.
integer Readonly
remaining_xlarge_load_balancer_count The remaining xlarge load balancer count

The remaining count of xlarge load balancer services which can be
configured on the given edge node.
integer Readonly
resource_type Must be set to the value LBVirtualNetworkApplianceUsage string Required
severity LB usage severity

The severity calculation is based on current credit usage percentage
of load balancer for one node.
LBUsageSeverity Readonly
usage_percentage Usage percentage

The usage percentage of the edge node for load balancer.
The value is the load balancer credit usage percentage.
number Readonly
virtual_network_appliance_cluster_path The path of virtual network appliance cluster

The path of virtual network appliance cluster which contains the
virtual network appliance.
string Readonly