forked from kytos-ng/sdntrace_cp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yml
170 lines (170 loc) · 6.26 KB
/
openapi.yml
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
openapi: 3.0.0
info:
title: amlight/sdntrace_cp
version: '0.1'
description: An OpenFlow Path Tracing on Control Plane
paths:
/api/amlight/sdntrace_cp/trace:
put:
summary: Trace a path
description: Trace a path starting with the switch given with the parameters given. The trace is done entirely in control plane.
requestBody:
content:
application/json:
schema:
type: object
properties:
trace:
type: object
properties:
switch:
type: object
properties:
dpid:
type: string
description: Initial switch datapath ID
example: 00:00:00:00:00:00:00:01
in_port:
type: integer
description: Starting incoming port
example: 1
eth:
type: object
properties:
dl_vlan:
type: integer
description: VLAN ID
example: 100
dl_type:
type: string
description: Ethernet type
example: '0x8100'
dl_src:
type: string
description: Source MAC address
example: '01:23:45:67:89:ab'
dl_dst:
type: string
description: Destination MAC address
example: '23:45:67:89:ab:cd'
ip:
type: object
properties:
nw_src:
type: string
description: Source IP
example: 192.168.20.21
nw_dst:
type: string
description: Destination IP
example: 192.168.25.123
nw_proto:
type: integer
description: IP protocol
example: 6
nw_tos:
type: integer
description: IP TOS
example: 0
tp:
type: object
properties:
tp_src:
type: integer
description: Source transport port
example: 8761
tp_dst:
type: integer
description: Destination transport port
example: 80
responses:
200:
description: Ok.
content:
application/json:
schema:
type: object
properties:
result:
type: array
items:
type: object
required:
- dpid
- port
- time
- type
properties:
dpid:
type: string
description: Switch datapath ID
example: 00:00:00:00:00:00:00:01
port:
type: integer
description: Incoming port in the switch
example: 1
time:
type: string
description: Date time when the iteration was computed
example: "2022-01-25 13:44:52.387021"
type:
type: string
description: Type of the step. May be "starting" or "trace".
example: "trace"
vlan:
type: integer
description: VLAN ID
example: 100
/api/amlight/sdntrace_cp/trace/{trace_id}:
get:
summary: Get the result of a trace
parameters:
- name: trace_id
schema:
type: integer
required: true
description: Trace ID
in: path
responses:
200:
description: Ok.
content:
application/json:
schema:
type: object
properties:
request:
type: object
request_id:
type: integer
description: ID of the trace
example: 30001
result:
type: array
items:
type: object
properties:
dpid:
type: string
description: Datapath ID of the switch
example: 00:00:00:00:00:00:00:01
port:
type: integer
description: Incoming port of the packet in this switch
example: 1
time:
type: string
description: Start time in the first switch, elapsed time otherwise
example: "2018-03-22 14:50:56.888483"
type:
type: string
description: Type of this step. May be starting, trace, last or loop.
example: trace
start_time:
type: string
description: Start time of the trace
example: "2018-03-22 14:50:56.888483"
total_time:
type: string
description: "Elapsed time on this trace"
example: "0:00:00.256709"