Neutron VIP

Media Type
[application/vnd.org.midonet.neutron.lb.Vip-v1+json]
Collection Media Type
[application/vnd.org.midonet.neutron.lb.Vips-v1+json]
GET     /neutron/lb/vips
GET     /neutron/lb/vips/:vipId
POST    /neutron/lb/vips
DELETE  /neutron/lb/vips/:vipId
Field NameTypePOST/PUTRequiredDescription

id

UUID

POST

No

A unique identifier of the resource. If this field is omitted in the POST request, a random UUID is generated.

tenant_id

String

POST

Yes

The identifier of the tenant that owns the VIP.

address

String

POST/PUT

No

The IPv4 destination address of the traffic to be load balanced.

admin_state_up

Boolean

POST/PUT

No

The administrative state of the resource. Default is true (up).

connection_limit

Integer

POST/PUT

No

The maximum amount of open connections using this VIP at any given time.

description

String

POST/PUT

No

The VIP description.

name

String

POST/PUT

No

The VIP name.

pool_id

UUID

POST/PUT

No

The identifier of the pool resource associated with this VIP.

port_id

UUID

POST/PUT

No

The identifier of the port resource associated with this VIP.

protocol

String

POST/PUT

No

The protocol used for load balancing at this VIP. The possible values are HTTP, HTTPS, and TCP. Currently only TCP is supported.

protocol_port

Integer

POST/PUT

No

The TCP port of the traffic to be load balanced. The value must belong to the interval [0, 65535].

session_persistence

(String, String)

POST/PUT

No

The session persistence settings. It is a JSON object with two fields: type with possible values APP_COOKIE, HTTP_COOKIE, SOURCE_IP, and cookie_name indicating the cookie name.

status

String

POST/PUT

No

The VIP status. Values are ACTIVE or INACTIVE. It is currently unused.

status_description

String

POST/PUT

No

The status description.

subnet_id

UUID

POST/PUT

No

The identifier of the subnet associated with this pool.

Questions? Discuss on Mailing Lists or Chat.
Found an error? Report a bug.