Package org.jclouds.openstack.neutron.v2.features

Interface FloatingIPApi

@Beta
@Path("/floatingips")
@Consumes("application/json")
public interface FloatingIPApi

Provides access to Floating IP operations for the OpenStack Networking (Neutron) v2 API.

A floating IP is an IP address on an external network, which is associated with a specific port, and optionally a specific IP address, on a private OpenStack Networking network. Therefore a floating IP allows access to an instance on a private network from an external network. Floating IPs can only be defined on networks for which the attribute floatingip:external (by the external network extension) has been set to True.

Method Summary

Modifier and Type	Method	Description
FloatingIP	create(FloatingIP.CreateFloatingIP createFloatingIP)	Creates a floating IP.
boolean	delete(String id)	Deletes the specified floatingIP
FloatingIP	get(String id)	Returns the details for a specific floating IP.
PagedIterable<FloatingIP>	list()	Returns a list of floating IPs to which the tenant has access.
FloatingIPs	list(PaginationOptions options)
FloatingIP	update(String id, FloatingIP.UpdateFloatingIP updateFloatingIP)	Update a Floating IP

Method Detail

list

@Named("floatingip:list")
@GET
PagedIterable<FloatingIP> list()

Returns a list of floating IPs to which the tenant has access. Default policy settings return only those floating IPs that are owned by the tenant who submits the request, unless the request is submitted by an user with administrative rights.

Returns:

the list of all floatingIP references configured for the tenant.

list

@Named("floatingip:list")
@GET
FloatingIPs list(PaginationOptions options)

Returns:

the list of all floatingIP references configured for the tenant.

get

@Named("floatingip:get")
@GET
@Path("/{id}")
@Nullable
FloatingIP get(@PathParam("id")
               String id)

Returns the details for a specific floating IP.

Parameters:

id - the id of the floatingIP to return

Returns:

FloatingIPs collection or empty if not found

create

@Named("floatingip:create")
@POST
FloatingIP create(FloatingIP.CreateFloatingIP createFloatingIP)

Creates a floating IP.

Parameters:

createFloatingIP - Options for creating a Floating IP

Returns:

the newly created Floating IP

update

@Named("floatingip:update")
@PUT
@Path("/{id}")
FloatingIP update(@PathParam("id")
                  String id,
                  FloatingIP.UpdateFloatingIP updateFloatingIP)

Update a Floating IP

Parameters:

id - the id of the Floating IP to update

updateFloatingIP - Contains only the attributes to update

Returns:

The modified Floating IP

delete

@Named("floatingip:delete")
@DELETE
@Path("/{id}")
boolean delete(@PathParam("id")
               String id)

Deletes the specified floatingIP

Parameters:

id - the id of the floatingIP to delete

Returns:

true if delete successful, false if not