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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
|
.. -*- rst -*-
================
Tap As A Service
================
TaaS plugin provides a mechanism to mirror certain traffic
(for example tagged with specific VLANs) from a source VM to any traffic analyzer VM.
When packet will be forwarded, the original value of source and target ip/ports
information will not be altered and the system administrator will be able to run,
for ex. ``tcpdump``, on the target VM to trace these packets.
TaaS plugin mainly consists of ``tap service`` and ``tap flow``.
VLAN filter
===========
The ``VLAN filtering`` for Neutron Tap as a Service allows to filter
traffic comming from ``tap-flows`` by VLAN id in case of mirroring SRIOV
ports.
Tap Service
===========
TapService represents the port to which the mirrored traffic is delivered.
List Tap Services
=================
.. rest_method:: GET /v2.0/taas/tap_services
List tap services that belong to a given project.
The list might be empty.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- project: project_id-query
- project-domain: project-domain_taas
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: tas_id
- tenant_id: project_id
- port: mirror_port_tas
- status: status_tas
Response Example
----------------
.. literalinclude:: samples/taas/tas-list-response.json
:language: javascript
Create Tap Service
==================
.. rest_method:: POST /v2.0/taas/tap_services
Create a Tap Service by passing the following JSON-encoded data.
``name``, ``monitoring port`` as mandatory parameters and
``description`` as optional parameter.
Normal response codes: 201
Error response codes: 401, 403, 404, 409
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- project: project_id-query
- project-domain: project-domain_taas
- tenant_id: project_id-query
- name: tas_name-query
- port: mirror_port_tas-query
- description: description_tas-query
Request Example
---------------
.. literalinclude:: samples/taas/tas-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: tas_id
- tenant_id: project_id
- name: tas_name
- port: mirror_port_tas
- status: status_tas
- description: description_tas
- project_id: project_id
Response Example
----------------
.. literalinclude:: samples/taas/tas-create-response.json
:language: javascript
Update Tap Service
==================
.. rest_method:: PUT /v2.0/taas/tap_services/{tap_service_id/name}
Update Tap Service by passing tap service ``name`` or ``id`` as JSON-encoded data.
Name or description or both can only be updated.
Normal response codes: 200
Error response codes: 400, 401, 404, 412
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- name: tas_name-query
- description: description_tas-query
Request Example
---------------
.. literalinclude:: samples/taas/tas-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: tas_id
- name: tas_name
- port: mirror_port_tas
- status: status_tas
- description: description_tas
- project_id: project_id
Response Example
----------------
.. literalinclude:: samples/taas/tas-update-response.json
:language: javascript
Delete Tap Service
==================
.. rest_method:: DELETE /v2.0/taas/tap_services/{tap_service_id/name}
Delete Tap Service by passing tap service ``name`` or ``id`` as JSON-encoded data.
Normal response codes: 204
Error response codes: 400, 401, 404, 412
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- name: tas_name-query
- id: tas_id-query
Response Parameters
-------------------
There is no body content for the response of a successful DELETE request.
Show Tap Service
================
.. rest_method:: GET /v2.0/taas/tap_services/{tap_service_id/name}
Show details for a tap service by passing tap service ``name`` or ``id`` as JSON-encoded data.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- project: project_id-query
- project-domain: project-domain_taas
- name: tas_name-query
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: tas_id
- name: tas_name
- port: mirror_port_tas
- status: status_tas
- description: description_tas
- project_id: project_id
- tenant_id: project_id
Response Example
----------------
.. literalinclude:: samples/taas/tas-show-response.json
:language: javascript
Tap Flow
========
TapFlow represents the port from which the traffic needs to be mirrored.
It can be a port associated with VM on another cloud network.
List Tap Flow
=============
.. rest_method:: GET /v2.0/taas/tap_flows
List tap flow that belong to a given tenant.
The list might be empty.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- project: project_id-query
- project-domain: project-domain_taas
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: taf_id
- port: source_port_taf
- status: status_tas
Response Example
----------------
.. literalinclude:: samples/taas/taf-list-response.json
:language: javascript
Create Tap Flow
===============
.. rest_method:: POST /v2.0/taas/tap_flows
Create a Tap Flow by passing the following JSON-encoded data.
``name``, ``source port``, ``direction`` as ``IN/OUT/BOTH``
``tap_service`` as mandatory parameters and
``description`` as optional parameter.
Normal response codes: 201
Error response codes: 401, 403, 404, 409
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- project: project_id-query
- project-domain: project-domain_taas
- tenant_id: project_id-query
- name: taf_name-query
- port: source_port_taf-query
- tap_service: tap_service_id-query
- vlan_filter: vlan-filter_taf-query
- direction: direction_taf-query
- description: description_taf-query
Request Example
---------------
.. literalinclude:: samples/taas/taf-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: taf_id
- name: taf_name
- port: source_port_taf
- status: status_taf
- tap_service: tap_service_id
- direction: description_taf
- project_id: project_id
- tenant_id: project_id
Response Example
----------------
.. literalinclude:: samples/taas/taf-create-response.json
:language: javascript
Update Tap Flow
===============
.. rest_method:: PUT /v2.0/taas/tap_flows/{taf_service_id/name}
Update Tap Flow by passing tap flow ``name`` or ``id`` as JSON-encoded data.
Name or description or both can only be updated.
Normal response codes: 200
Error response codes: 400, 401, 404, 412
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- name: taf_name-query
- description: description_taf-query
Request Example
---------------
.. literalinclude:: samples/taas/taf-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: taf_id
- name: taf_name
- port: source_port_taf
- status: status_tas
- tap_service: tap_service_id
- direction: description_taf
- project_id: project_id
- tenant_id: project_id
Response Example
----------------
.. literalinclude:: samples/taas/taf-update-response.json
:language: javascript
Delete Tap Flow
===============
.. rest_method:: DELETE /v2.0/taas/tap_flows/{tap_service_id/name}
Delete Tap Flow by passing tap flow ``name`` or ``id`` as JSON-encoded data.
Normal response codes: 204
Error response codes: 400, 401, 404, 412
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- id: taf_id-query
- name: taf_name-query
Response Parameters
-------------------
On successful ``DELETE`` request ``Tap flow {tap_flow_id} deleted.``
message will be displayed.
Show Tap Flow
=============
.. rest_method:: GET /v2.0/taas/tap_flows/{tap_flows_id/name}
Show details for a tap flow by passing tap flow ``name`` or ``id`` as JSON-encoded data.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- project: project_id-query
- project-domain: project-domain_taas
- tenant_id: project_id-query
- id: taf_id-query
- name: taf_name-query
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: taf_id
- name: taf_name
- port: source_port_taf
- status: status_taf
- tap_service: tap_service_id
- direction: description_taf
- project_id: project_id
- tenant_id: project_id
Response Example
----------------
.. literalinclude:: samples/taas/taf-show-response.json
:language: javascript
|
