org.onosproject.incubator.net.virtual

Interface VirtualNetworkAdminService

All Superinterfaces:

ListenerService<VirtualNetworkEvent,VirtualNetworkListener>, VirtualNetworkService

@Beta
public interface VirtualNetworkAdminService
extends VirtualNetworkService

Service for managing the inventory of virtual networks.

Field Summary

Fields inherited from interface org.onosproject.incubator.net.virtual.VirtualNetworkService

VIRTUAL_NETWORK_TOPIC

Method Summary

Modifier and Type	Method and Description
void	bindVirtualPort(NetworkId networkId, DeviceId deviceId, PortNumber portNumber, ConnectPoint realizedBy) Binds an existing virtual port on the specified device.
VirtualDevice	createVirtualDevice(NetworkId networkId, DeviceId deviceId) Creates a new virtual device within the specified network.
VirtualHost	createVirtualHost(NetworkId networkId, HostId hostId, MacAddress mac, VlanId vlan, HostLocation location, java.util.Set<IpAddress> ips) Creates a new virtual host within the specified network.
VirtualLink	createVirtualLink(NetworkId networkId, ConnectPoint src, ConnectPoint dst) Creates a new virtual link within the specified network.
VirtualNetwork	createVirtualNetwork(TenantId tenantId) Creates a new virtual network for the specified tenant.
VirtualPort	createVirtualPort(NetworkId networkId, DeviceId deviceId, PortNumber portNumber, ConnectPoint realizedBy) Creates a new virtual port on the specified device.
java.util.Set<TenantId>	getTenantIds() Returns the set of tenant identifiers known to the system.
void	registerTenantId(TenantId tenantId) Registers the specified, externally generated tenant identifier.
void	removeVirtualDevice(NetworkId networkId, DeviceId deviceId) Removes the specified virtual device and all its ports and affiliated links.
void	removeVirtualHost(NetworkId networkId, HostId hostId) Removes the specified virtual host.
void	removeVirtualLink(NetworkId networkId, ConnectPoint src, ConnectPoint dst) Removes the specified virtual link.
void	removeVirtualNetwork(NetworkId networkId) Removes the specified virtual network and all its devices and links.
void	removeVirtualPort(NetworkId networkId, DeviceId deviceId, PortNumber portNumber) Removes the specified virtual port.
void	unregisterTenantId(TenantId tenantId) Unregisters the specified, externally generated tenant identifier.
void	updatePortState(NetworkId networkId, DeviceId deviceId, PortNumber portNumber, boolean isEnabled) Updates port state of an existing virtual port on the specified device.

Methods inherited from interface org.onosproject.incubator.net.virtual.VirtualNetworkService

get, getPhysicalDevices, getServiceDirectory, getVirtualDevices, getVirtualHosts, getVirtualLinks, getVirtualNetworkApplicationId, getVirtualNetworks, getVirtualPorts

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

registerTenantId

void registerTenantId(TenantId tenantId)

Registers the specified, externally generated tenant identifier.

Parameters:

tenantId - tenant identifier

unregisterTenantId

void unregisterTenantId(TenantId tenantId)

Unregisters the specified, externally generated tenant identifier.

Parameters:

tenantId - tenant identifier

Throws:

java.lang.IllegalStateException - if there are networks still owned by this tenant

getTenantIds

java.util.Set<TenantId> getTenantIds()

Returns the set of tenant identifiers known to the system.

Returns:

set of known tenant identifiers

createVirtualNetwork

VirtualNetwork createVirtualNetwork(TenantId tenantId)

Creates a new virtual network for the specified tenant.

Parameters:

tenantId - tenant identifier

Returns:

newly created virtual network

removeVirtualNetwork

void removeVirtualNetwork(NetworkId networkId)

Removes the specified virtual network and all its devices and links.

Parameters:

networkId - network identifier

createVirtualDevice

VirtualDevice createVirtualDevice(NetworkId networkId,
                                  DeviceId deviceId)

Creates a new virtual device within the specified network. The device id must be unique within the bounds of the network.

Parameters:

networkId - network identifier

deviceId - device identifier

Returns:

newly created virtual device

Throws:

ItemNotFoundException - if no such network found

removeVirtualDevice

void removeVirtualDevice(NetworkId networkId,
                         DeviceId deviceId)

Removes the specified virtual device and all its ports and affiliated links.

Parameters:

networkId - network identifier

deviceId - device identifier

Throws:

ItemNotFoundException - if no such network or device found

createVirtualHost

VirtualHost createVirtualHost(NetworkId networkId,
                              HostId hostId,
                              MacAddress mac,
                              VlanId vlan,
                              HostLocation location,
                              java.util.Set<IpAddress> ips)

Creates a new virtual host within the specified network. The host id must be unique within the bounds of the network.

Parameters:

networkId - network identifier

hostId - host identifier

mac - mac address

vlan - vlan identifier

location - host location

ips - set of ip addresses

Returns:

newly created virtual host

Throws:

ItemNotFoundException - if no such network found

removeVirtualHost

void removeVirtualHost(NetworkId networkId,
                       HostId hostId)

Removes the specified virtual host.

Parameters:

networkId - network identifier

hostId - host identifier

Throws:

ItemNotFoundException - if no such network or host found

createVirtualLink

VirtualLink createVirtualLink(NetworkId networkId,
                              ConnectPoint src,
                              ConnectPoint dst)

Creates a new virtual link within the specified network.

Parameters:

networkId - network identifier

src - source connection point

dst - destination connection point

Returns:

newly created virtual link

Throws:

ItemNotFoundException - if no such network found

removeVirtualLink

void removeVirtualLink(NetworkId networkId,
                       ConnectPoint src,
                       ConnectPoint dst)

Removes the specified virtual link.

Parameters:

networkId - network identifier

src - source connection point

dst - destination connection point

Throws:

ItemNotFoundException - if no such network or link found

createVirtualPort

VirtualPort createVirtualPort(NetworkId networkId,
                              DeviceId deviceId,
                              PortNumber portNumber,
                              ConnectPoint realizedBy)

Creates a new virtual port on the specified device.

Parameters:

networkId - network identifier

deviceId - virtual device identifier

portNumber - virtual port number

realizedBy - underlying physical port using which this virtual port is realized

Returns:

newly created port

Throws:

ItemNotFoundException - if no such network or device is found

bindVirtualPort

void bindVirtualPort(NetworkId networkId,
                     DeviceId deviceId,
                     PortNumber portNumber,
                     ConnectPoint realizedBy)

Binds an existing virtual port on the specified device.

Parameters:

networkId - network identifier

deviceId - virtual device identifier

portNumber - virtual port number

realizedBy - underlying physical port using which this virtual port is realized

Throws:

ItemNotFoundException - if no such network or device is found

updatePortState

void updatePortState(NetworkId networkId,
                     DeviceId deviceId,
                     PortNumber portNumber,
                     boolean isEnabled)

Updates port state of an existing virtual port on the specified device.

Parameters:

networkId - network identifier

deviceId - virtual device identifier

portNumber - virtual port number

isEnabled - indicator whether the port is up and active

Throws:

ItemNotFoundException - if no such network or device is found

removeVirtualPort

void removeVirtualPort(NetworkId networkId,
                       DeviceId deviceId,
                       PortNumber portNumber)

Removes the specified virtual port.

Parameters:

networkId - network identifier

deviceId - device identifier

portNumber - port number

Throws:

ItemNotFoundException - if no such network or port found