RouterApi (Apache jclouds 2.0.0 API)

```
@Beta
public interface RouterApi
```
Provides access to Router operations for the OpenStack Networking (Neutron) v2 API.
A logical entity for forwarding packets across internal subnets and NATting them on external networks through an appropriate external gateway.

See Also:
api doc, neutron extensions

Method Summary

Methods
Modifier and Type	Method and Description
`RouterInterface`	`addInterfaceForPort(String routerId, String portId)` Add a interface to a router to connect to the specified port
`RouterInterface`	`addInterfaceForSubnet(String routerId, String subnetId)` Add a interface to a router to connect to the specified subnet
`Router`	`create(Router.CreateRouter router)` Create a new router
`boolean`	`delete(String id)` Deletes the specified router
`Router`	`get(String id)` Returns a Routers collection that should contain a single router with the id requested.
`PagedIterable<Router>`	`list()` Returns the list of all routers currently defined in Neutron for the current tenant.
`Routers`	`list(PaginationOptions options)`
`boolean`	`removeInterfaceForPort(String routerId, String portId)` Remove the interface where the specified port is connected to
`boolean`	`removeInterfaceForSubnet(String routerId, String subnetId)` Remove the interface where the specified subnet is connected to
`Router`	`update(String id, Router.UpdateRouter router)` Update a router

- Method Detail
  - list
```
@Named(value="router:list")
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")
Routers list(PaginationOptions options)
```
    See Also:
    api doc
  - get
```
@Named(value="router:get")
@Nullable
Router get(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")
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")
Router update(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")
boolean delete(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")
RouterInterface addInterfaceForSubnet(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")
RouterInterface addInterfaceForPort(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")
boolean removeInterfaceForSubnet(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")
boolean removeInterfaceForPort(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

Interface RouterApi

Method Summary

Method Detail

list

list

get

create

update

delete

addInterfaceForSubnet

addInterfaceForPort

removeInterfaceForSubnet

removeInterfaceForPort