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
|
/*
* 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.vtnrsc;
import org.onlab.packet.IpAddress;
import org.onlab.packet.IpAddress.Version;
import org.onlab.packet.IpPrefix;
/**
* Representation of a subnet.
*/
public interface Subnet {
/**
* Coarse classification of the type of the ipV6Mode.
*/
enum Mode {
DHCPV6_STATEFUL, DHCPV6_STATELESS, SLAAC
}
/**
* Returns the subnet identifier.
*
* @return identifier
*/
SubnetId id();
/**
* Returns the name of the subnet.
*
* @return subnetName
*/
String subnetName();
/**
* Returns the network identifier.
*
* @return the network identifier
*/
TenantNetworkId networkId();
/**
* Returns tenant identifier.
*
* @return the tenant identifier
*/
TenantId tenantId();
/**
* Returns the IP version, which is 4 or 6.
*
* @return ipVersion
*/
Version ipVersion();
/**
* Returns the cidr.
*
* @return cidr
*/
IpPrefix cidr();
/**
* Returns the gateway IP address.
*
* @return gatewayIp
*/
IpAddress gatewayIp();
/**
* Returns true if DHCP is enabled and return false if DHCP is disabled.
*
* @return true or false
*/
boolean dhcpEnabled();
/**
* Indicates whether this tenantNetwork is shared across all tenants. By
* default, only administrative user can change this value.
*
* @return true or false
*/
boolean shared();
/**
* Returns a collection of hostRoutes.
*
* @return a collection of hostRoutes
*/
Iterable<HostRoute> hostRoutes();
/**
* Returns the ipV6AddressMode. A valid value is dhcpv6-stateful,
* dhcpv6-stateless, or slaac.
*
* @return ipV6AddressMode whose value is dhcpv6-stateful, dhcpv6-stateless
* or slaac
*/
Mode ipV6AddressMode();
/**
* Returns the ipV6RaMode.A valid value is dhcpv6-stateful,
* dhcpv6-stateless, or slaac.
*
* @return ipV6RaMode whose value is dhcpv6-stateful, dhcpv6-stateless or
* slaac
*/
Mode ipV6RaMode();
/**
* Returns a collection of allocation_pools.
*
* @return a collection of allocationPools
*/
Iterable<AllocationPool> allocationPools();
}
|
