org.jclouds.openstack.quantum.v1_0.features

Interface PortApi

public interface PortApi

Provides synchronous access to Port operations on the openstack quantum 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.

Author:

Adam Lowe

See Also:

PortAsyncApi, api doc

Method Summary

Methods

Modifier and Type	Method and Description
Reference	create() Create a new port on the specified network
Reference	create(Port.State state) Create a new port on the specified network, with the requested state
boolean	delete(String id) Deletes a port from a network
Port	get(String id) Returns a specific port.
PortDetails	getDetails(String id) Returns a specific port in detail.
Set<? extends Port>	list() Returns the set of ports currently defined in Quantum for the requested network.
Set<? extends Reference>	listReferences() Returns the list of all ports currently defined in Quantum for the requested network
boolean	plugAttachment(String portId, String attachmentId) Plugs an attachment into the specified port
Attachment	showAttachment(String portId) Returns the attachment for the specified port.
boolean	unplugAttachment(String portId) Unplugs the attachment currently plugged into the specified port
boolean	updateState(String id, Port.State state) Updates the state of a port

Method Detail

listReferences

Set<? extends Reference> listReferences()

Returns the list of all ports currently defined in Quantum for the requested network

list

Set<? extends Port> list()

Returns the set of ports currently defined in Quantum for the requested network.

get

Port get(String id)

Returns a specific port.

getDetails

PortDetails getDetails(String id)

Returns a specific port in detail.

create

Reference create()

Create a new port on the specified network

create

Reference create(Port.State state)

Create a new port on the specified network, with the requested state

updateState

boolean updateState(String id,
                  Port.State state)

Updates the state of a port

delete

boolean delete(String id)

Deletes a port from a network

showAttachment

Attachment showAttachment(String portId)

Returns the attachment for the specified port.

plugAttachment

boolean plugAttachment(String portId,
                     String attachmentId)

Plugs an attachment into the specified port

unplugAttachment

boolean unplugAttachment(String portId)

Unplugs the attachment currently plugged into the specified port