This section discusses operations for managing load balancer VIPs through the LBaaS extension.
| Attribute | Type | Required | CRUD [a] | Default value | Validation constraints | Notes | |||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | uuid-str | N/A | R | generated | N/A | Unique identifier for the VIP. | |||||||||||||||||||||||||||||||||||||||||||
| tenant_id | uuid-str | Yes | CR | Derived from authentication token. | N/A | Owner of the VIP. Only an admin user can specify a tenant identifier other than its own. | |||||||||||||||||||||||||||||||||||||||||||
| name | String | No | CRU | None | N/A | Human readable name for the VIP. Does not have to be unique. | |||||||||||||||||||||||||||||||||||||||||||
| description | String | No | CRU | None | N/A | Human readable description for the VIP. | |||||||||||||||||||||||||||||||||||||||||||
| subnet_id | uuid-str | No | CR | None | UUID pattern. | The subnet on which to allocate the VIP address. | |||||||||||||||||||||||||||||||||||||||||||
| address | IP | No | CR | None | IP address or null | The IP address of the VIP. | |||||||||||||||||||||||||||||||||||||||||||
| protocol | String | Yes | CR | None | { "TCP" | "HTTP" | "HTTPS" } | The protocol of the VIP address. | |||||||||||||||||||||||||||||||||||||||||||
| protocol_port | Integer | Yes | CR | None | [0..65535] | The port on which to listen to client traffic that is associated with the VIP address. | |||||||||||||||||||||||||||||||||||||||||||
| pool_id | uuid-str | No | CRU | None | UUID pattern. | The pool that the VIP
associated with. |
|||||||||||||||||||||||||||||||||||||||||||
| session_persistence | dict | No | CRU | None | composite [b] | Session persistence parameters of the VIP. Absence of
When no session persistence is used, the
You can clear session persistence for
the VIP by sending |
|||||||||||||||||||||||||||||||||||||||||||
| connection_limit | Integer | No | CRU | -1 | None | The maximum number of connections allowed for
the VIP or -1 if the limit is not
set. |
|||||||||||||||||||||||||||||||||||||||||||
| admin_state_up | Bool | No | CRU | true | {true | false } | Administrative state of the VIP | |||||||||||||||||||||||||||||||||||||||||||
| status | String | N/A | R | N/A | N/A | Indicates whether a VIP is currently operational. | |||||||||||||||||||||||||||||||||||||||||||
[b] Session persistence is a dictionary with the following attributes:
| |||||||||||||||||||||||||||||||||||||||||||||||||
