VIP

Media Type
[application/vnd.org.midonet.VIP-v1+json]
Collection Media Type
[application/vnd.org.midonet.collection.VIP-v1+json]
GET     /vips
GET     /vips/:vipId
GET     /pools/:poolId/vips
GET     /load_balancers/:loadBalancerId/vips
POST    /vips
POST    /pools/:poolId/vips
PUT     /vips/:vipId
DELETE  /vips/:vipId

A VIP is an entity that represents a virtual IP address device for use with load balancers in MidoNet. It contains the following fields:

Field NameTypePOST/PUTRequiredDescription

uri

URI

  

A GET against this URI refreshes the representation of this resource.

loadBalancer

URI

  

A GET against this URI returns the load balancer.

pool

URI

  

A GET against this URI returns the pool.

id

UUID

POST

No

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

address

String

POST/PUT

Yes

The IP address of the VIP.

poolId

UUID

POST/PUT

Yes

The identifier of the pool. When using the /vips API end-point to create a pool, this field is used to determine the pool to which the VIP belongs. When using the /pools/:poolId/vips API end-point, this field is mandatory but its value will be ignored.

protocolPort

Integer

POST/PUT

Yes

The transport protocol port of the VIP. The value must belong to the interval [0, 65535].

adminStateUp

Boolean

POST/PUT

No

The administrative state of the VIP. The default it true (up).

sessionPersistence

String

POST/PUT

No

Indicates the session persistence of the VIP. The allowed values are SOURCE_IP or null.

loadBalancerId

UUID

  

The identifier of the load balancer object to which the VIP is associated with.

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