aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/gbp/gbp.api
blob: 6bdcc5d7e0ccda6343c3f9f8e823022958849eb8 (plain)
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
/* Hey Emacs use -*- mode: C -*- */
/*
 * Copyright (c) 2018 Cisco and/or its affiliates.
 * 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.
 */

option version = "2.0.0";

import "vnet/ip/ip_types.api";
import "vnet/ethernet/ethernet_types.api";

enum gbp_bridge_domain_flags
{
  GBP_BD_API_FLAG_NONE = 0,
  GBP_BD_API_FLAG_DO_NOT_LEARN = 1,
};

typedef gbp_bridge_domain
{
  u32 bd_id;
  vl_api_gbp_bridge_domain_flags_t flags;
  u32 bvi_sw_if_index;
  u32 uu_fwd_sw_if_index;
};

autoreply define gbp_bridge_domain_add
{
  u32 client_index;
  u32 context;
  vl_api_gbp_bridge_domain_t bd;
};
autoreply define gbp_bridge_domain_del
{
  u32 client_index;
  u32 context;
  u32 bd_id;
};
autoreply define gbp_bridge_domain_dump
{
  u32 client_index;
  u32 context;
};
define gbp_bridge_domain_details
{
  u32 context;
  vl_api_gbp_bridge_domain_t bd;
};

typedef gbp_route_domain
{
  u32 rd_id;
  u32 ip4_table_id;
  u32 ip6_table_id;
  u32 ip4_uu_sw_if_index;
  u32 ip6_uu_sw_if_index;
};

autoreply define gbp_route_domain_add
{
  u32 client_index;
  u32 context;
  vl_api_gbp_route_domain_t rd;
};
autoreply define gbp_route_domain_del
{
  u32 client_index;
  u32 context;
  u32 rd_id;
};
autoreply define gbp_route_domain_dump
{
  u32 client_index;
  u32 context;
};
define gbp_route_domain_details
{
  u32 context;
  vl_api_gbp_route_domain_t rd;
};

/** \brief Endpoint
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
*/

enum gbp_endpoint_flags
{
  NONE = 0,
  BOUNCE = 0x1,
  REMOTE = 0x2,
  LEARNT = 0x4,
  /* hey Ole WTF */
  REMOTE_LEARNT = 0x6,
};

typedef gbp_endpoint_tun
{
  vl_api_address_t src;
  vl_api_address_t dst;
};

typedef gbp_endpoint
{
  u32 sw_if_index;
  u16 epg_id;
  vl_api_gbp_endpoint_flags_t flags;
  vl_api_mac_address_t mac;
  vl_api_gbp_endpoint_tun_t tun;
  u8 n_ips;
  vl_api_address_t ips[n_ips];
};

define gbp_endpoint_add
{
  u32 client_index;
  u32 context;
  vl_api_gbp_endpoint_t endpoint;
};

define gbp_endpoint_add_reply
{
  u32 context;
  i32 retval;
  u32 handle;
};

autoreply define gbp_endpoint_del
{
  u32 client_index;
  u32 context;
  u32 handle;
};

define gbp_endpoint_dump
{
  u32 client_index;
  u32 context;
};

define gbp_endpoint_details
{
  u32 context;
  f64 age;
  u32 handle;
  vl_api_gbp_endpoint_t endpoint;
};

typeonly define gbp_endpoint_group
{
  u16 epg_id;
  u32 bd_id;
  u32 rd_id;
  u32 uplink_sw_if_index;
};

autoreply define gbp_endpoint_group_add
{
  u32 client_index;
  u32 context;
  vl_api_gbp_endpoint_group_t epg;
};
autoreply define gbp_endpoint_group_del
{
  u32 client_index;
  u32 context;
  u16 epg_id;
};

define gbp_endpoint_group_dump
{
  u32 client_index;
  u32 context;
};

define gbp_endpoint_group_details
{
  u32 context;
  vl_api_gbp_endpoint_group_t epg;
};

typeonly define gbp_recirc
{
  u32 sw_if_index;
  u16 epg_id;
  u8  is_ext;
};

autoreply define gbp_recirc_add_del
{
  u32 client_index;
  u32 context;
  u8  is_add;
  vl_api_gbp_recirc_t recirc;
};

define gbp_recirc_dump
{
  u32 client_index;
  u32 context;
};

define gbp_recirc_details
{
  u32 context;
  vl_api_gbp_recirc_t recirc;
};

enum gbp_subnet_type
{
  GBP_API_SUBNET_TRANSPORT,
  GBP_API_SUBNET_STITCHED_INTERNAL,
  GBP_API_SUBNET_STITCHED_EXTERNAL,
};

typeonly define gbp_subnet
{
  u32 rd_id;
  u32 sw_if_index;
  u16 epg_id;
  vl_api_gbp_subnet_type_t type;
  vl_api_prefix_t prefix;
};

autoreply define gbp_subnet_add_del
{
  u32 client_index;
  u32 context;
  u8  is_add;
  vl_api_gbp_subnet_t subnet;
};

define gbp_subnet_dump
{
  u32 client_index;
  u32 context;
};

define gbp_subnet_details
{
  u32 context;
  vl_api_gbp_subnet_t subnet;
};

typedef gbp_next_hop
{
  vl_api_address_t ip;
  vl_api_mac_address_t mac;
  u32 bd_id;
  u32 rd_id;
};

enum gbp_hash_mode
{
  GBP_API_HASH_MODE_SRC_IP,
  GBP_API_HASH_MODE_DST_IP,
  GBP_API_HASH_MODE_SYMMETRIC,
};

typedef gbp_next_hop_set
{
  vl_api_gbp_hash_mode_t hash_mode;
  u8 n_nhs;
  vl_api_gbp_next_hop_t nhs[8];
};

enum gbp_rule_action
{
  GBP_API_RULE_PERMIT,
  GBP_API_RULE_DENY,
  GBP_API_RULE_REDIRECT,
};

typedef gbp_rule
{
  vl_api_gbp_rule_action_t action;
  vl_api_gbp_next_hop_set_t nh_set;
};

typedef gbp_contract
{
  u16 src_epg;
  u16 dst_epg;
  u32 acl_index;
  u8  n_rules;
  vl_api_gbp_rule_t rules[n_rules];
};

autoreply define gbp_contract_add_del
{
  u32 client_index;
  u32 context;
  u8  is_add;
  vl_api_gbp_contract_t contract;
};

define gbp_contract_dump
{
  u32 client_index;
  u32 context;
};

define gbp_contract_details
{
  u32 context;
  vl_api_gbp_contract_t contract;
};

/**
 * @brief Set the time throeshold after which an endpoint is
          considered inative and is aged/reaped by the scanner
 * @param threshold In seconds
 */
autoreply define gbp_endpoint_learn_set_inactive_threshold
{
  u32 client_index;
  u32 context;
  u32 threshold;
};

/**
 * @brief Configure a 'base' tunnel from which learned tunnels
 *        are permitted to derive
 *        A base tunnel consists only of the VNI, any src,dst IP
 *        pair is thus allowed.
 */
enum gbp_vxlan_tunnel_mode
{
  GBP_VXLAN_TUNNEL_MODE_L2,
  GBP_VXLAN_TUNNEL_MODE_L3,
};

typedef gbp_vxlan_tunnel
{
  u32 vni;
  vl_api_gbp_vxlan_tunnel_mode_t mode;
  u32 bd_rd_id;
};

define gbp_vxlan_tunnel_add
{
  u32 client_index;
  u32 context;
  vl_api_gbp_vxlan_tunnel_t tunnel;
};

define gbp_vxlan_tunnel_add_reply
{
  u32 context;
  i32 retval;
  u32 sw_if_index;
};

autoreply define gbp_vxlan_tunnel_del
{
  u32 client_index;
  u32 context;
  u32 vni;
};

define gbp_vxlan_tunnel_dump
{
  u32 client_index;
  u32 context;
};

define gbp_vxlan_tunnel_details
{
  u32 context;
  vl_api_gbp_vxlan_tunnel_t tunnel;
};

/*
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */