Load Balancer Plan¶

This page describes operations you can perform on load_balancer_plan. List, and get details for.

List Load Balancer Plan¶

List all visible load_balancer_plans.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/load_balancer_plans

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
description	query	string	-	-	Description of the Load Balancer Plan	no
enabled	query	boolean	-	-	Is user allowed to create new load balancers with this plan.	no
id	query	string	hyph-uuid	-	Unique ID of the Load Balancer Plan	no
maximum_syslog_servers	query	integer	-	-	maximum number of syslog servers	no
name	query	string	-	-	Name of the Load Balancer Plan	no
update_enabled	query	boolean	-	-	Is user allowed to update load balancers with this plan.	no
vendor	query	string	-	['citrix']	Load Balancer Type	no
version	query	string	-	-	Version name	no

Response¶

HTTP Response Code List¶

Response Code	Description
200	OK
400	Bad Request
401	UnAuthorized
404	Not Found
500	Internal Server Error

HTTP Response Parameters¶

Parameter	Type	Format	Description
load_balancer_plans	array<object>	datatype_load_balancer_plan	-
description	string	-	Description of the Load Balancer Plan
enabled	boolean	-	Is user allowed to create new load balancers with this plan.
update_enabled	boolean	-	Is user allowed to update load balancers with this plan.
id	string	hyph-uuid	Unique ID of the Load Balancer Plan
maximum_syslog_servers	integer	-	maximum number of syslog servers
model	object	-	Model of load balancer
edition	string	-	-
size	string	-	-
name	string	-	Name of the Load Balancer Plan
vendor	string	-	Load Balancer Type
version	string	-	Version name

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "load_balancer_plans": [
    {
      "description": "",
      "enabled": true,
      "id": "120c8eb8-0762-4855-9130-634b2ab8a201",
      "maximum_syslog_servers": 10,
      "model": {
        "edition": "Standard",
        "size": "50"
      },
      "name": "LB_Plan1",
      "update_enabled": true,
      "vendor": "citrix",
      "version": "10.5-57.7"
    },
    {
      "description": "",
      "enabled": false,
      "id": "1a7fdd7c-a333-42e1-b15b-e77a91c91701",
      "maximum_syslog_servers": 10,
      "model": {
        "edition": "Standard",
        "size": "1000"
      },
      "name": "LB_Plan2",
      "update_enabled": false,
      "vendor": "citrix",
      "version": "10.5-57.7"
    }
  ]
}

Show Load Balancer Plan¶

Show details for load_balancer_plan.