Synnefo

Floating IPs

============

Floating IPs are addresses on external networks (and so can be defined only

on networks on which the attribute `router:external` has been set to True). In

the Neutron API, floating IPs are associated with specific ports and IP

addresses on private networks and are used to allow an instance from a private

network to access the external network. Cyclades are able to associate a

floating IP with an instance without the restriction that the instance must

already have a port and a private IP from a private network. In order to avoid

this limitation of Neutron API, Cyclades are using a slightly modified and

extended API.

The attributes of floating IP objects are the following:

* id: A string representing the UUID for the floating IP.

* floating_network_id: The UUID of the external network with which the floating

  IP is associated.

* floating_ip_address: The IPv4 address of the floating IP.

* device_id: The UUID of the device that is associated with the floating IP.

* router_id: The UUID of the router that is associated with this floating IP.

* user_id/tenant_id: The UUID of the owner of the floating IP.

Note: The `device_id` is not part of Neutron API. Instead the Neutron API uses

the `port_id` and `fixed_ip_address` to associate the floating IP with a

specific port and private address.

Floating IPs are associated/de-associated with instances, using the

'addfloatingip', and 'removefloatingip' server actions that are defined in the

extensions of the OpenStack Compute API. When a floating IP is associated with

a server the corresponding Port is automatically created, with device owner the

floating IP. However these ports, exactly as with Router Ports, can not be

managed with the Ports API.

Create(reserve) a floating IP

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

METHOD: POST

URI: /floatingips

The body of the request contains the id of the external network

(`floating_network_id`). If no address is specified (`floating_ip_address`),

an address will automatically be allocated from the pool addresses of the

external network.

List floating IPs

^^^^^^^^^^^^^^^^^

METHOD: GET

URI: /floatingips

Show a floating IP

^^^^^^^^^^^^^^^^^^

METHOD: GET

URI: /floatingips/$(floatingip_id)

Example response:

.. code-block:: console

 {

   "floatingip": {

     "id": "5923c02a-a162-4044-a432-9e52d6d819ce",

     "floating_ip_address": 192.168.1.227,

     "floating_network_id": 00983314-2f3c-43e9-acb0-9fd7cdb32231,

     "router_id": null,

     "device_id": 42,

     "tenant_id: "1012fd8c72284c00b133832cd179f896",

     "user_id": "1012fd8c72284c00b133832cd179f896"

   }

 }

Delete a Floating IP

^^^^^^^^^^^^^^^^^^^^

METHOD: DELETE

URI: /floatingips/$(floatingip_id)

This operation removes(releases) the floating IP. If it associated with a

device(port), the port is automatically removed.

Add Floating IP to server

^^^^^^^^^^^^^^^^^^^^^^^^^

METHOD: POST

URI: server/$(server_id)/action

Request:

.. code-block:: console

 {

   "addFloatingIp": {

     "address": "192.168.1.277"

   }

 }

Remove Floating IP from server

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

METHOD: POST

URI: servers/$(server_id)/action

.. code-block:: console

 {

   "removeFloatingIp": {

     "address": "192.168.1.277"

   }

 }