Method Detail

• create

  @Named(value="virtualip:create")
  @POST
  @Consumes(value="application/json")
  @Path(value="/virtualips")
  VirtualIPWithId create(VirtualIP virtualIP)

  Create a new virtual IP.

• list

  @Named(value="virtualip:list")
  @GET
  @Consumes(value="application/json")
  @Path(value="/virtualips")
  Iterable<VirtualIPWithId> list()

  List the virtual IPs.

• delete

  @Named(value="virtualip:delete")
  @DELETE
  @Path(value="/virtualips/{id}")
  @Consumes(value="*/*")
  boolean delete(@PathParam(value="id")
                                          int id)

  Delete a virtual IP.

  Returns:

  true on a successful delete, false if the virtual IP was not found

  See Also:

  delete(Iterable)

• delete

  @Named(value="virtualip:delete")
  @DELETE
  @Path(value="/virtualips")
  @Consumes(value="*/*")
  boolean delete(@QueryParam(value="id")
                                          Iterable<Integer> ids)

  Batch delete virtual IPs given the specified ids. All load balancers must have at least one virtual IP associated with them at all times. Attempting to delete the last virtual IP will result in an exception. The current default limit is ten ids per request. Any and all configuration data is immediately purged and is not recoverable. If one or more of the items in the list cannot be removed due to its current status, an exception is thrown along with the ids of the ones the system identified as potential failures for this request.

  Returns:

  true on a successful delete, false if the virtual IP was not found