org.jclouds.openstack.neutron.v2.extensions.lbaas.v1

Interface LBaaSApi

@Beta
 @Path(value="/lb")
 @Consumes(value="application/json")
public interface LBaaSApi

Provides access to load-balancing operations for the OpenStack Networking (Neutron) v2 API.

LBaaS v1 is an extension to load-balance the traffic between instances and external networks.

Method Summary

Modifier and Type	Method and Description
HealthMonitor	associateHealthMonitor(String poolId, String healthMonitorId) Associate a HealthMonitor to a Pool.
HealthMonitor	createHealthMonitor(HealthMonitor.CreateHealthMonitor healthMonitor) Creates a new HealthMonitor.
Member	createMember(Member.CreateMember member) Creates a new Member.
Pool	createPool(Pool.CreatePool pool) Creates a new Pool.
VIP	createVIP(VIP.CreateVIP vip) Creates a new VIP.
boolean	deleteHealthMonitor(String id) Deletes the specified Health Monitor.
boolean	deleteMember(String id) Deletes the specified Member.
boolean	deletePool(String id) Deletes the specified Pool.
boolean	deleteVIP(String id) Deletes the specified VIP.
boolean	disassociateHealthMonitor(String poolId, String healthMonitorId) Disassociate a HealthMonitor from a Pool.
HealthMonitor	getHealthMonitor(String id) Returns the details for a specific HealthMonitor.
Member	getMember(String id) Returns the details for a specific Member.
Pool	getPool(String id) Returns the details for a specific Pool.
VIP	getVIP(String id) Returns the details for a specific VIP.
PagedIterable<HealthMonitor>	listHealthMonitors() Returns a list of HealthMonitors to which the tenant has access.
HealthMonitors	listHealthMonitors(PaginationOptions options)
PagedIterable<Member>	listMembers() Returns a list of Members to which the tenant has access.
Members	listMembers(PaginationOptions options)
PagedIterable<Pool>	listPools() Returns a list of Pools to which the tenant has access.
Pools	listPools(PaginationOptions options)
PagedIterable<VIP>	listVIPs() Returns a list of VIPs to which the tenant has access.
VIPs	listVIPs(PaginationOptions options)
HealthMonitor	updateHealthMonitor(String id, HealthMonitor.UpdateHealthMonitor healthMonitor) Update a HealthMonitor.
Member	updateMember(String id, Member.UpdateMember member) Update a Member.
Pool	updatePool(String id, Pool.UpdatePool pool) Update a Pool.
VIP	updateVIP(String id, VIP.UpdateVIP vip) Update a VIP.

Method Detail

listVIPs

@Named(value="vip:list")
 @GET
 @Path(value="/vips")
PagedIterable<VIP> listVIPs()

Returns a list of VIPs to which the tenant has access. Default policy settings return only those VIPs 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 VIP references configured for the tenant.

listVIPs

@Named(value="vip:list")
 @GET
 @Path(value="/vips")
VIPs listVIPs(PaginationOptions options)

Returns:

the list of all VIP references configured for the tenant.

getVIP

@Named(value="vip:get")
 @GET
 @Path(value="/vips/{id}")
 @Nullable
VIP getVIP(@PathParam(value="id")
                                                                               String id)

Returns the details for a specific VIP.

Parameters:

id - the id of the VIP to return.

Returns:

VIP or null if not found.

createVIP

@Named(value="vip:create")
 @POST
 @Path(value="/vips")
VIP createVIP(VIP.CreateVIP vip)

Creates a new VIP.

Parameters:

vip - describes the VIP to be created.

Returns:

a reference of the newly-created VIP.

updateVIP

@Named(value="vip:update")
 @PUT
 @Path(value="/vips/{id}")
VIP updateVIP(@PathParam(value="id")
                                                                          String id,
                                                                          VIP.UpdateVIP vip)

Update a VIP.

Parameters:

id - the id of the VIP to update.

vip - the VIP's attributes to update.

Returns:

a reference of the updated VIP.

deleteVIP

@Named(value="vip:delete")
 @DELETE
 @Path(value="/vips/{id}")
boolean deleteVIP(@PathParam(value="id")
                                                                                 String id)

Deletes the specified VIP.

Parameters:

id - the id of the VIP to delete.

Returns:

true if delete successful, false if not.

listPools

@Named(value="pool:list")
 @GET
 @Path(value="/pools")
PagedIterable<Pool> listPools()

Returns a list of Pools to which the tenant has access. Default policy settings return only those Pools 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 Pool references configured for the tenant.

listPools

@Named(value="pool:list")
 @GET
 @Path(value="/pools")
Pools listPools(PaginationOptions options)

Returns:

the list of all Pool references configured for the tenant.

getPool

@Named(value="pool:get")
 @GET
 @Path(value="/pools/{id}")
 @Nullable
Pool getPool(@PathParam(value="id")
                                                                                   String id)

Returns the details for a specific Pool.

Parameters:

id - the id of the Pool to return.

Returns:

Pool or null if not found.

createPool

@Named(value="pool:create")
 @POST
 @Path(value="/pools")
Pool createPool(Pool.CreatePool pool)

Creates a new Pool.

Parameters:

pool - describes the Pool to be created.

Returns:

a reference of the newly-created Pool.

updatePool

@Named(value="pool:update")
 @PUT
 @Path(value="/pools/{id}")
Pool updatePool(@PathParam(value="id")
                                                                              String id,
                                                                              Pool.UpdatePool pool)

Update a Pool.

Parameters:

id - the id of the Pool to update.

pool - the Pool's attributes to update.

Returns:

a reference of the updated Pool.

deletePool

@Named(value="pool:delete")
 @DELETE
 @Path(value="/pools/{id}")
boolean deletePool(@PathParam(value="id")
                                                                                    String id)

Deletes the specified Pool.

Parameters:

id - the id of the Pool to delete.

Returns:

true if delete successful, false if not.

listMembers

@Named(value="member:list")
 @GET
 @Path(value="/members")
PagedIterable<Member> listMembers()

Returns a list of Members to which the tenant has access. Default policy settings return only those Members 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 Member references configured for the tenant.

listMembers

@Named(value="member:list")
 @GET
 @Path(value="/members")
Members listMembers(PaginationOptions options)

Returns:

the list of all Member references configured for the tenant.

getMember

@Named(value="member:get")
 @GET
 @Path(value="/members/{id}")
 @Nullable
Member getMember(@PathParam(value="id")
                                                                                           String id)

Returns the details for a specific Member.

Parameters:

id - the id of the Member to return.

Returns:

Member or null if not found.

createMember

@Named(value="member:create")
 @POST
 @Path(value="/members")
Member createMember(Member.CreateMember member)

Creates a new Member.

Parameters:

member - describes the Member to be created.

Returns:

a reference of the newly-created Member.

updateMember

@Named(value="member:update")
 @PUT
 @Path(value="/members/{id}")
Member updateMember(@PathParam(value="id")
                                                                                      String id,
                                                                                      Member.UpdateMember member)

Update a Member.

Parameters:

id - the id of the Member to update.

member - the Member's attributes to update.

Returns:

a reference of the updated Member.

deleteMember

@Named(value="member:delete")
 @DELETE
 @Path(value="/members/{id}")
boolean deleteMember(@PathParam(value="id")
                                                                                          String id)

Deletes the specified Member.

Parameters:

id - the id of the Member to delete.

Returns:

true if delete successful, false if not.

listHealthMonitors

@Named(value="health_monitor:list")
 @GET
 @Path(value="/health_monitors")
PagedIterable<HealthMonitor> listHealthMonitors()

Returns a list of HealthMonitors to which the tenant has access. Default policy settings return only those HealthMonitors 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 HealthMonitor references configured for the tenant.

listHealthMonitors

@Named(value="health_monitor:list")
 @GET
 @Path(value="/health_monitors")
HealthMonitors listHealthMonitors(PaginationOptions options)

Returns:

the list of all HealthMonitor references configured for the tenant.

getHealthMonitor

@Named(value="health_monitor:get")
 @GET
 @Path(value="/health_monitors/{id}")
 @Nullable
HealthMonitor getHealthMonitor(@PathParam(value="id")
                                                                                                                         String id)

Returns the details for a specific HealthMonitor.

Parameters:

id - the id of the HealthMonitor to return.

Returns:

Health Monitor or null if not found.

createHealthMonitor

@Named(value="health_monitor:create")
 @POST
 @Path(value="/health_monitors")
HealthMonitor createHealthMonitor(HealthMonitor.CreateHealthMonitor healthMonitor)

Creates a new HealthMonitor.

Parameters:

healthMonitor - describes the HealthMonitor to be created.

Returns:

a reference of the newly-created HealthMonitor.

updateHealthMonitor

@Named(value="health_monitor:update")
 @PUT
 @Path(value="/health_monitors/{id}")
HealthMonitor updateHealthMonitor(@PathParam(value="id")
                                                                                                                    String id,
                                                                                                                    HealthMonitor.UpdateHealthMonitor healthMonitor)

Update a HealthMonitor.

Parameters:

id - the id of the HealthMonitor to update.

healthMonitor - the HealthMonitor's attributes to update.

Returns:

a reference of the updated HealthMonitor.

deleteHealthMonitor

@Named(value="health_monitor:delete")
 @DELETE
 @Path(value="/health_monitors/{id}")
boolean deleteHealthMonitor(@PathParam(value="id")
                                                                                                                 String id)

Deletes the specified Health Monitor.

Parameters:

id - the id of the Health Monitor to delete.

Returns:

true if delete successful, false if not.

associateHealthMonitor

@Named(value="pool:associate_health_monitor")
 @POST
 @Path(value="/pools/{pool-id}/health_monitors")
 @Produces(value="application/json")
HealthMonitor associateHealthMonitor(@PathParam(value="pool-id")
                                                                                                                                                                                String poolId,
                                                                                                                                                                                String healthMonitorId)

Associate a HealthMonitor to a Pool.

Parameters:

poolId - the id of the Pool to associate.

healthMonitorId - the id of the HealthMonitor to associate.

Returns:

the newly associated HealthMonitor.

disassociateHealthMonitor

@Named(value="pool:disassociate_health_monitor")
 @DELETE
 @Path(value="/pools/{pool-id}/health_monitors/{health-monitor-id}")
boolean disassociateHealthMonitor(@PathParam(value="pool-id")
                                                                                                                                                                 String poolId,
                                                                                                                                                                 @PathParam(value="health-monitor-id")
                                                                                                                                                                 String healthMonitorId)

Disassociate a HealthMonitor from a Pool.

Parameters:

poolId - the id of the Pool to disassociate.

healthMonitorId - the id of the HealthMonitor to disassociate.

Returns:

true if disassociate successful, false if not.