Gitiles
Code Review Sign In
gerrit.onosproject.org / onos / e46f09365b9d2c627031049da1595711e5b5df22 / . / web / api / src / main / resources / definitions / FlowEntries.json
blob: edc407020209117efb0984ecb2a3ea8df6d9b964 [file] [log] [blame]
Jian Li2907ad22016-05-12 23:08:54 -0700[diff] [blame]1{
2 "type": "object",
3 "title": "flows",
4 "required": [
5 "flows"
6 ],
7 "properties": {
8 "flows": {
9 "type": "array",
10 "xml": {
11 "name": "flows",
12 "wrapped": true
13 },
14 "items": {
15 "type": "object",
16 "title": "flow",
17 "required": [
18 "id",
19 "tableId",
20 "appId",
21 "groupId",
22 "priority",
23 "timeout",
24 "isPermanent",
25 "deviceId",
26 "state",
27 "life",
28 "packets",
29 "bytes",
kalagesa42019542017-03-14 18:00:47 +0530[diff] [blame]30 "liveType",
Jian Li2907ad22016-05-12 23:08:54 -0700[diff] [blame]31 "lastSeen"
32 ],
33 "properties": {
34 "id": {
35 "type": "string",
36 "example": "12103425214920339"
37 },
38 "tableId": {
39 "type": "integer",
40 "format": "int32",
41 "example": 3
42 },
43 "appId": {
44 "type": "string",
45 "example": "org.onosproject.core"
46 },
47 "groupId": {
48 "type": "integer",
49 "format": "int64",
50 "example": 0
51 },
52 "priority": {
53 "type": "integer",
54 "format": "int32",
55 "example": 40000
56 },
57 "timeout": {
58 "type": "integer",
59 "format": "int32",
60 "example": 0
61 },
62 "isPermanent": {
63 "type": "boolean",
64 "example": true
65 },
66 "deviceId": {
67 "type": "string",
68 "example": "of:0000000000000003"
69 },
70 "state": {
71 "type": "string",
72 "example": "ADDED"
73 },
74 "life": {
75 "type": "integer",
76 "format": "int64",
77 "example": 69889
78 },
79 "packets": {
80 "type": "integer",
81 "format": "int64",
82 "example": 22546
83 },
84 "bytes": {
85 "type": "integer",
86 "format": "int64",
87 "example": 1826226
88 },
kalagesa42019542017-03-14 18:00:47 +0530[diff] [blame]89 "liveType": {
90 "type": "string",
91 "example": "UNKNOWN"
92 },
Jian Li2907ad22016-05-12 23:08:54 -0700[diff] [blame]93 "lastSeen": {
94 "type": "integer",
95 "format": "int64",
96 "example": 1447892365670
97 },
98 "treatment": {
99 "type": "object",
100 "title": "treatment",
101 "required": [
102 "instructions",
103 "deferred"
104 ],
105 "properties": {
106 "instructions": {
107 "type": "array",
108 "title": "treatment",
109 "required": [
110 "properties",
111 "port"
112 ],
113 "items": {
114 "type": "object",
115 "title": "instruction",
116 "required": [
117 "type",
118 "port"
119 ],
120 "properties": {
121 "type": {
122 "type": "string",
123 "example": "OUTPUT"
124 },
125 "port": {
126 "type": "string",
127 "example": "CONTROLLER"
128 }
129 }
130 }
131 },
132 "deferred": {
133 "type": "array",
134 "xml": {
135 "name": "deferred",
136 "wrapped": true
137 },
138 "items": {
139 "type": "string"
140 }
141 }
142 }
143 },
144 "selector": {
145 "type": "object",
146 "title": "selector",
147 "required": [
148 "criteria"
149 ],
150 "properties": {
151 "criteria": {
152 "type": "array",
153 "xml": {
154 "name": "criteria",
155 "wrapped": true
156 },
157 "items": {
158 "type": "object",
159 "title": "criteria",
160 "properties": {
161 "type": {
162 "type": "string",
163 "description": "Ethernet field name",
164 "example": "ETH_TYPE"
165 },
166 "ethType": {
167 "type": "int64",
168 "format": "int64",
169 "example": "0x88cc",
170 "description": "Ethernet frame type"
171 },
172 "mac": {
173 "type": "string",
174 "example": "00:00:11:00:00:01"
175 },
176 "port": {
177 "type": "int64",
178 "format": "int64",
179 "example": 1,
180 "description": "Match port"
181 },
182 "metadata": {
183 "type": "Hex16",
184 "format": "Hex16",
185 "example": "0xabcdL",
186 "description": "Metadata passed between tables"
187 },
188 "vlanId": {
189 "type": "uint16",
190 "format": "uint16",
191 "example": "0x1000"
192 },
193 "priority": {
194 "type": "int64",
195 "format": "int64",
196 "example": 1,
197 "description": "VLAN priority."
198 },
199 "ipDscp": {
200 "type": "byte",
201 "format": "byte",
202 "description": "IP DSCP (6 bits in ToS field)"
203 },
204 "ipEcn": {
205 "type": "byte",
206 "format": "byte",
207 "description": "IP ECN (2 bits in ToS field)."
208 },
209 "protocol": {
210 "type": "uint16",
211 "format": "uint16",
212 "example": 1,
213 "description": "IP protocol"
214 },
215 "ip": {
216 "type": "string",
217 "example": "10.1.1.0/24",
218 "description": "IP source address"
219 },
220 "tcpPort": {
221 "type": "integer",
222 "format": "uint16",
223 "example": 1,
224 "description": "TCP source address"
225 },
226 "udpPort": {
227 "type": "uint16",
228 "format": "uint16",
229 "example": 1,
230 "description": "UDP source address"
231 },
232 "sctpPort": {
233 "type": "uint16",
234 "format": "uint16",
235 "example": 1,
236 "description": "SCTP source address"
237 },
238 "icmpType": {
239 "type": "uint16",
240 "format": "uint16",
241 "example": 1,
242 "description": "Internet Control Message Protocol for IPV4 code (RFC0792)"
243 },
244 "icmpCode": {
245 "type": "uint16",
246 "format": "uint16",
247 "example": 1,
248 "description": "Internet Control Message Protocol for IPV4 code (RFC0792)"
249 },
250 "flowLabel": {
251 "type": "Hex16",
252 "format": "Hex16",
253 "example": "0xffffe",
254 "description": "IPv6 Flow Label (RFC 6437)"
255 },
256 "icmpv6Type": {
257 "type": "uint16",
258 "format": "uint16",
259 "example": 1,
260 "description": "Internet Control Message Protocol for IPV6 type (RFC2463)"
261 },
262 "icmpv6Code": {
263 "type": "uint16",
264 "format": "uint16",
265 "example": 1,
266 "description": "Internet Control Message Protocol for IPV6 code (RFC2463)"
267 },
268 "targetAddress": {
269 "type": "String",
270 "example": "10.1.1.0/24",
271 "description": "IPv6 Neighbor discovery target address"
272 },
273 "label": {
274 "type": "int32",
275 "format": "int32",
276 "example": 1,
277 "description": "MPLS label"
278 },
279 "exthdrFlags": {
280 "type": "int64",
281 "format": "int64",
282 "example": 1,
283 "description": "IPv6 extension header pseudo-field"
284 },
285 "lambda": {
286 "type": "int64",
287 "format": "int64",
288 "example": 1,
289 "description": "wavelength abstraction"
290 },
291 "gridType": {
292 "type": "String",
293 "example": "DWDM",
294 "description": "Type of wavelength grid"
295 },
296 "channelSpacing": {
297 "type": "int64",
298 "format": "int64",
299 "example": 100,
300 "description": "Optical channel spacing"
301 },
302 "spacingMultiplier": {
303 "type": "integer",
304 "format": "int64",
305 "example": 4,
306 "description": "Optical channel spacing multiplier"
307 },
308 "slotGranularity": {
309 "type": "int64",
310 "format": "int64",
311 "example": 8
312 },
313 "ochSignalId": {
314 "type": "integer",
315 "format": "int64",
316 "example": 1,
317 "description": "Optical channel signal ID"
318 },
319 "tunnelId": {
320 "type": "int64",
321 "format": "int64",
322 "example": 5,
323 "description": "Tunnel ID"
324 },
325 "ochSignalType": {
326 "type": "int64",
327 "format": "int64",
328 "example": 1,
329 "description": "Optical channel signal type"
330 },
331 "oduSignalId": {
332 "type": "int64",
333 "format": "int64",
334 "example": 1,
335 "description": "ODU (Optical channel Data Unit) signal ID."
336 },
337 "tributaryPortNumber": {
338 "type": "int64",
339 "format": "int64",
340 "example": 11,
341 "description": "OPU (Optical channel Payload Unit) port number."
342 },
343 "tributarySlotLen": {
344 "type": "int64",
345 "format": "int64",
346 "example": 80,
347 "description": "OPU (Optical channel Payload Unit) slot length."
348 },
349 "tributarySlotBitmap": {
350 "type": "array",
351 "title": "tributarySlotBitmap",
352 "description": "OPU (Optical channel Payload Unit) slot bitmap.",
353 "required": [
354 "byte",
355 "port"
356 ],
357 "items": {
358 "type": "byte",
359 "title": "byte",
360 "example": 1
361 }
362 },
363 "oduSignalType": {
364 "type": "int64",
365 "format": "int64",
366 "example": 4,
367 "description": "ODU (Optical channel Data Unit) signal type."
368 }
369 }
370 }
371 }
372 }
373 }
374 }
375 }
376 }
377 }
378}