PortApi (Apache jclouds 2.1.0 API)

```
@Beta
@Path(value="/ports")
@Consumes(value="application/json")
public interface PortApi
```
Provides access to Port operations for the OpenStack Networking (Neutron) v2 API.
A port represents a virtual switch port on a logical network switch where all the interfaces attached to a given network are connected.
A port has an administrative state which is either 'DOWN' or 'ACTIVE'. Ports which are administratively down will not be able to receive/send traffic.

See Also:
api doc

Method Summary

Methods
Modifier and Type	Method and Description
`Port`	`create(Port.CreatePort port)` Create a new port in the specified network
`com.google.common.collect.FluentIterable<Port>`	`createBulk(List<Port.CreatePort> ports)` Create multiple ports
`boolean`	`delete(String id)` Delete a port
`Port`	`get(String id)` Returns the specific port
`PagedIterable<Port>`	`list()` Returns the list of all ports currently defined in Neutron for the current tenant.
`Ports`	`list(PaginationOptions options)`
`Port`	`update(String id, Port.UpdatePort port)` Update a port

Method Detail

list
```
@Named(value="port:list")
@GET
PagedIterable<Port> list()
```
Returns the list of all ports currently defined in Neutron for the current tenant. The list provides the unique identifier of each network configured for the tenant.

Returns:
the list of all port references configured for the tenant

list

@Named(value="port:list")
@GET
Ports list(PaginationOptions options)

See Also:: api doc

get

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

Returns the specific port

Parameters:: id - the id of the port to return
Returns:: Port or null if not found

create
```
@Named(value="port:create")
@POST
Port create(Port.CreatePort port)
```
Create a new port in the specified network

Parameters:
port - the port details

Returns:
a reference of the newly-created port

createBulk
```
@Named(value="port:createBulk")
@POST
com.google.common.collect.FluentIterable<Port> createBulk(List<Port.CreatePort> ports)
```
Create multiple ports

Parameters:
ports - the bulk of ports to create

Returns:
list of references of the newly-created ports

update

@Named(value="port:update")
@PUT
@Path(value="/{id}")
Port update(@PathParam(value="id")
                         String id,
                         Port.UpdatePort port)

Update a port

Parameters:: id - the id of the port to update; port - CreatePort with just the attributes to update
Returns:: true if update successful, false if not

delete

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

Delete a port

Parameters:: id - the id of the port to delete
Returns:: true if delete successful, false if not

Interface PortApi

Method Summary

Method Detail

list

list

get

create

createBulk

update

delete