RouterApi (Apache jclouds 1.7.3 API)

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

Author:

Nick Livens

See Also:
api doc

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(CreateRouterOptions... options)` Create a new router
`boolean`	`delete(String id)` Deletes the specified router
`Router`	`get(String id)` Returns the specific router.
`PagedIterable<? extends ReferenceWithName>`	`list()` Returns the list of all routers currently defined in Neutron for the current tenant.
`PagedIterable<? extends ReferenceWithName>`	`list(PaginationOptions options)`
`PagedIterable<? extends Router>`	`listInDetail()` Returns all routers currently defined in Neutron for the current tenant.
`PagedIterable<? extends Router>`	`listInDetail(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
`boolean`	`update(String id, UpdateRouterOptions... options)` Update a router

- Method Detail
  - list
```
@Named(value="router:list")
PagedIterable<? extends ReferenceWithName> 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")
PagedIterable<? extends ReferenceWithName> list(PaginationOptions options)
```
    See Also:
    api doc
  - listInDetail
```
@Named(value="router:list")
PagedIterable<? extends Router> listInDetail()
```
    Returns all routers currently defined in Neutron for the current tenant.
    
    Returns:
    the list of all routers configured for the tenant
  - listInDetail
```
@Named(value="router:list")
PagedIterable<? extends Router> listInDetail(PaginationOptions options)
```
    See Also:
    api doc
  - get
```
@Named(value="router:get")
@Nullable
Router get(String id)
```
    Returns the specific router.
    
    Parameters:
    id - the id of the router to return
    
    Returns:
    Router or null if not found
  - create
```
@Named(value="router:create")
Router create(CreateRouterOptions... options)
```
    Create a new router
    
    Parameters:
    options - optional arguments
    
    Returns:
    the newly created router
  - update
```
@Named(value="router:update")
boolean update(String id,
                   UpdateRouterOptions... options)
```
    Update a router
    
    Parameters:
    id - the id of the router to update
    options - the attributes to update
    
    Returns:
    true if update successful, false if not
  - 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

listInDetail

listInDetail

get

create

update

delete

addInterfaceForSubnet

addInterfaceForPort

removeInterfaceForSubnet

removeInterfaceForPort