Method Detail

• list

  @Named(value="router:list")
  @GET
  PagedIterable<Router> list()

  Returns the list of all routers currently defined in Neutron for the current tenant. The list provides the unique identifier of each router configured for the tenant

  Returns:

  the list of all router references configured for the tenant.

• list

  @Named(value="router:list")
  @GET
  Routers list(PaginationOptions options)

  See Also:

  api doc

• get

  @Named(value="router:get")
  @GET
  @Path(value="/{id}")
  @Nullable
  Router get(@PathParam(value="id")
                                   String id)

  Returns a Routers collection that should contain a single router with the id requested.

  Parameters:

  id - the id of the router to return

  Returns:

  Routers collection or empty if not found

• create

  @Named(value="router:create")
  @POST
  Router create(Router.CreateRouter router)

  Create a new router

  Parameters:

  router - Options for creating a router

  Returns:

  the newly created router

• update

  @Named(value="router:update")
  @PUT
  @Path(value="/{id}")
  Router update(@PathParam(value="id")
                             String id,
                             Router.UpdateRouter router)

  Update a router

  Parameters:

  id - the id of the router to update

  router - Contains only the attributes to update

  Returns:

  The modified router

• delete

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

  Deletes the specified router

  Parameters:

  id - the id of the router to delete

  Returns:

  true if delete successful, false if not

• addInterfaceForSubnet

  @Named(value="router:addInterfaceForSubnet")
  @PUT
  @Path(value="/{id}/add_router_interface")
  RouterInterface addInterfaceForSubnet(@PathParam(value="id")
                                                     String routerId,
                                                     String subnetId)

  Add a interface to a router to connect to the specified subnet

  Parameters:

  routerId - the id of the router to create the interface at

  subnetId - the id of the subnet to connect with the interface

  Returns:

  the newly-created router interface

• addInterfaceForPort

  @Named(value="router:addInterfaceForPort")
  @PUT
  @Path(value="/{id}/add_router_interface")
  RouterInterface addInterfaceForPort(@PathParam(value="id")
                                                   String routerId,
                                                   String portId)

  Add a interface to a router to connect to the specified port

  Parameters:

  routerId - the id of the router to create the interface at

  portId - the id of the port to connect with the interface

  Returns:

  the newly-created router interface

• removeInterfaceForSubnet

  @Named(value="router:removeInterfaceForSubnet")
  @PUT
  @Path(value="/{id}/remove_router_interface")
  boolean removeInterfaceForSubnet(@PathParam(value="id")
                                                String routerId,
                                                String subnetId)

  Remove the interface where the specified subnet is connected to

  Parameters:

  routerId - the id of the router to remove the interface from

  subnetId - the id of the subnet to disconnect from the interface

• removeInterfaceForPort

  @Named(value="router:removeInterfaceForPort")
  @PUT
  @Path(value="/{id}/remove_router_interface")
  boolean removeInterfaceForPort(@PathParam(value="id")
                                              String routerId,
                                              String portId)

  Remove the interface where the specified port is connected to

  Parameters:

  routerId - the id of the router to remove the interface from

  portId - the id of the port to disconnect from the interface