NSX-T Data Center REST API

LBEdgeNodeUsage (type)

{
  "additionalProperties": false,
  "description": "It contains the load balancer node usage information for the given edge node.",
  "extends": {
    "$ref": "LBNodeUsage"
  },
  "id": "LBEdgeNodeUsage",
  "module_id": "PolicyLBStatistics",
  "polymorphic-type-descriptor": {
    "type-identifier": "LBEdgeNodeUsage"
  },
  "properties": {
    "current_large_load_balancer_count": {
      "description": "The count of large load balancer services configured on the node.",
      "readonly": true,
      "title": "The current large load balancer count",
      "type": "integer"
    },
    "current_load_balancer_credits": {
      "description": "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.",
      "readonly": true,
      "title": "Current load balancer credits",
      "type": "integer"
    },
    "current_medium_load_balancer_count": {
      "description": "The count of medium load balancer services configured on the node.",
      "readonly": true,
      "title": "The current medium load balancer count",
      "type": "integer"
    },
    "current_pool_count": {
      "description": "The count of pools configured on the node.",
      "readonly": true,
      "title": "The current pool count.",
      "type": "integer"
    },
    "current_pool_member_count": {
      "description": "The count of pool members configured on the node.",
      "readonly": true,
      "title": "The current pool member count",
      "type": "integer"
    },
    "current_small_load_balancer_count": {
      "description": "The count of small load balancer services configured on the node.",
      "readonly": true,
      "title": "The current small load balancer count",
      "type": "integer"
    },
    "current_virtual_server_count": {
      "description": "The count of virtual servers configured on the node.",
      "readonly": true,
      "title": "The current virtual server count",
      "type": "integer"
    },
    "current_xlarge_load_balancer_count": {
      "description": "The count of xlarge load balancer services configured on the node.",
      "readonly": true,
      "title": "The current xlarge load balancer count",
      "type": "integer"
    },
    "edge_cluster_path": {
      "description": "The path of edge cluster which contains the edge node.",
      "readonly": true,
      "title": "The path of edge cluster",
      "type": "string"
    },
    "form_factor": {
      "description": "The form factor of the given edge node or virtual network appliance.",
      "enum": [
        "SMALL_VIRTUAL_MACHINE",
        "MEDIUM_VIRTUAL_MACHINE",
        "LARGE_VIRTUAL_MACHINE",
        "XLARGE_VIRTUAL_MACHINE",
        "PHYSICAL_MACHINE"
      ],
      "readonly": true,
      "title": "The form factor of the given edge node or virtual network appliance\n",
      "type": "string"
    },
    "load_balancer_credit_capacity": {
      "description": "The load balancer credit capacity means the maximum credits which can be used for load balancer configuration for the given edge node.",
      "readonly": true,
      "title": "Load balancer credit capacity",
      "type": "integer"
    },
    "node_path": {
      "description": "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.",
      "required": true,
      "title": "The node path for load balancer node usage",
      "type": "string"
    },
    "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 per edge node.\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, for edge node, the property value is set as the max configurable pool member number of the largest supported LB size on the edge node. For example, for XLARGE edge, the property value is 36000. For virtual network appliance, the property value is not used anymore.",
      "readonly": true,
      "title": "The pool member capacity",
      "type": "integer"
    },
    "remaining_large_load_balancer_count": {
      "description": "The remaining count of large load balancer services which can be configured on the given edge node.",
      "readonly": true,
      "title": "The remaining large load balancer count",
      "type": "integer"
    },
    "remaining_medium_load_balancer_count": {
      "description": "The remaining count of medium load balancer services which can be configured on the given edge node.",
      "readonly": true,
      "title": "The remaining medium load balancer count",
      "type": "integer"
    },
    "remaining_small_load_balancer_count": {
      "description": "The remaining count of small load balancer services which can be configured on the given edge node.",
      "readonly": true,
      "title": "The remaining small load balancer count",
      "type": "integer"
    },
    "remaining_xlarge_load_balancer_count": {
      "description": "The remaining count of xlarge load balancer services which can be configured on the given edge node.",
      "readonly": true,
      "title": "The remaining xlarge load balancer count",
      "type": "integer"
    },
    "resource_type": {
      "description": "The property identifies the load balancer node usage type.",
      "required": true,
      "title": "Type of load balancer node usage",
      "type": "string"
    },
    "severity": {
      "$ref": "LBUsageSeverity",
      "description": "The severity calculation is based on current credit usage percentage of load balancer for one node.",
      "readonly": true,
      "title": "LB usage severity"
    },
    "usage_percentage": {
      "description": "The usage percentage of the edge node for load balancer. The value is the load balancer credit usage percentage.",
      "readonly": true,
      "title": "Usage percentage",
      "type": "number"
    }
  },
  "title": "The load balancer usage for an edge node",
  "type": "object"
}