NSX-T Data Center REST API

LBNodeUsageSummary (type)

{
  "additionalProperties": false,
  "description": "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.",
  "extends": {
    "$ref": "PolicyRuntimeInfoPerEP"
  },
  "id": "LBNodeUsageSummary",
  "module_id": "PolicyLBStatistics",
  "properties": {
    "alarm": {
      "$ref": "PolicyRuntimeAlarm",
      "description": "Alarm information details.",
      "readonly": true,
      "title": "Alarm Information Details"
    },
    "current_load_balancer_credits": {
      "description": "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.",
      "readonly": true,
      "title": "Current load balancer credits",
      "type": "integer"
    },
    "current_pool_member_count": {
      "description": "The overall count of pool members configured on all nodes.",
      "readonly": true,
      "title": "The current pool member count",
      "type": "integer"
    },
    "enforcement_point_path": {
      "description": "Policy Path referencing the enforcement point where the info is fetched.",
      "readonly": true,
      "title": "Enforcement point Path",
      "type": "string"
    },
    "load_balancer_credit_capacity": {
      "description": "The load balancer credit capacity means the maximum credits which can be used for load balancer service configuration for all nodes.",
      "readonly": true,
      "title": "Load balancer credit capacity",
      "type": "integer"
    },
    "node_counts": {
      "description": "The property identifies array of node count for each severity.",
      "items": {
        "$ref": "LBNodeCountPerSeverity"
      },
      "readonly": true,
      "title": "Array of node count for each severity",
      "type": "array"
    },
    "node_usages": {
      "description": "The property identifies all LB node usages. By default, it is not included in response. It exists when parameter ?include_usages=true.",
      "items": {
        "$ref": "LBNodeUsage"
      },
      "readonly": true,
      "title": "LB node usages",
      "type": "array"
    },
    "pool_member_capacity": {
      "deprecated": true,
      "deprecation_advice": "The property is deprecated as there is no LB pool member limit per\nedge node anymore. Please don't check this property for the pool member\ncapacity of all edge nodes.\n",
      "description": "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.",
      "readonly": true,
      "title": "The overall pool member capacity",
      "type": "integer"
    },
    "severity": {
      "$ref": "LBUsageSeverity",
      "description": "The severity calculation is based on overall credit usage percentage of load balancer for all nodes.",
      "readonly": true,
      "title": "LB usage severity"
    },
    "usage_percentage": {
      "description": "The overall usage percentage of all nodes for load balancer. The value is the overall load balancer credit usage percentage.",
      "readonly": true,
      "title": "Usage percentage",
      "type": "number"
    }
  },
  "title": "LB node usage summary for all nodes",
  "type": "object"
}