1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/*
* Copyright 2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.incubator.net.virtual;
import com.google.common.annotations.Beta;
import org.onosproject.incubator.net.tunnel.Tunnel;
import org.onosproject.net.ConnectPoint;
import org.onosproject.net.DeviceId;
import org.onosproject.net.Port;
import org.onosproject.net.PortNumber;
import org.onosproject.net.device.DeviceDescription;
import org.onosproject.net.device.PortDescription;
import org.onosproject.net.link.LinkDescription;
import java.util.Set;
/**
* Service for managing the inventory of virtual networks.
*/
@Beta
public interface VirtualNetworkAdminService extends VirtualNetworkService {
/**
* Registers the specified, externally generated tenant identifier.
*
* @param tenantId tenant identifier
*/
void registerTenantId(TenantId tenantId);
/**
* Unregisters the specified, externally generated tenant identifier.
*
* @param tenantId tenant identifier
* @throws IllegalStateException if there are networks still owned by this tenant
*/
void unregisterTenantId(TenantId tenantId);
/**
* Returns the set of tenant identifiers known to the system.
*
* @return set of known tenant identifiers
*/
Set<TenantId> getTenantIds();
/**
* Creates a new virtual network for the specified tenant.
*
* @param tenantId tenant identifier
* @return newly created virtual network
*/
VirtualNetwork createVirtualNetwork(TenantId tenantId);
/**
* Removes the specified virtual network and all its devices and links.
*
* @param networkId network identifier
*/
void removeVirtualNetwork(NetworkId networkId);
/**
* Creates a new virtual device within the specified network. The device id
* must be unique within the bounds of the network.
*
* @param networkId network identifier
* @param description device description
* @return newly created device
* @throws org.onlab.util.ItemNotFoundException if no such network found
*/
VirtualDevice createVirtualDevice(NetworkId networkId, DeviceDescription description);
/**
* Removes the specified virtual device and all its ports and affiliated links.
*
* @param networkId network identifier
* @param deviceId device identifier
* @throws org.onlab.util.ItemNotFoundException if no such network or device found
*/
void removeVirtualDevice(NetworkId networkId, DeviceId deviceId);
/**
* Creates a new virtual link within the specified network.
*
* @param networkId network identifier
* @param description link description
* @param realizedBy tunnel using which this link is realized
* @return newly created virtual link
* @throws org.onlab.util.ItemNotFoundException if no such network found
*/
VirtualLink createVirtualLink(NetworkId networkId, LinkDescription description,
Tunnel realizedBy);
// TODO: Discuss whether we should provide an alternate createVirtualLink
// which is backed by a Path instead; I'm leaning towards not doing that.
/**
* Removes the specified virtual link.
*
* @param networkId network identifier
* @param src source connection point
* @param dst destination connection point
* @throws org.onlab.util.ItemNotFoundException if no such network or link found
*/
void removeVirtualLink(NetworkId networkId, ConnectPoint src, ConnectPoint dst);
/**
* Creates a new virtual port on the specified device. Note that the port
* description can only request the resources which the underlying port
* port is capable of providing. It is, however, permissible to request
* only portion of those resources.
*
* @param networkId network identifier
* @param deviceId device identifier
* @param description port description
* @param realizedBy underlying port using which this virtual port is realized
* @return newly created port
* @throws org.onlab.util.ItemNotFoundException if no such network or device found
*/
VirtualPort createVirtualPort(NetworkId networkId, DeviceId deviceId,
PortDescription description, Port realizedBy);
/**
* Removes the specified virtual port.
*
* @param networkId network identifier
* @param deviceId device identifier
* @param portNumber port number
* @throws org.onlab.util.ItemNotFoundException if no such network or port found
*/
void removeVirtualPort(NetworkId networkId, DeviceId deviceId, PortNumber portNumber);
}
|
