FD.io VPP  v19.08-24-ge6a5712
Vector Packet Processing
gre.api
Go to the documentation of this file.
1 /* Hey Emacs use -*- mode: C -*- */
2 /*
3  * Copyright (c) 2015-2019 Cisco and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 option version = "2.0.0";
18 
19 import "vnet/interface_types.api";
20 import "vnet/ip/ip_types.api";
21 
22 /** \brief A GRE tunnel type
23 */
25 {
29 };
30 
31 /** \brief A GRE tunnel
32  @param client_index - opaque cookie to identify the sender
33  @param context - sender context, to match reply w/ request
34  @param tunnel_type - 0: L3, 1: TEB, 2: ERSPAN
35  @param instance - optional unique custom device instance, else ~0.
36  @param src - Source IP address
37  @param dst - Destination IP address, can be multicast
38  @param outer_fib_id - Encap FIB table ID
39  @param session_id - session for ERSPAN tunnel, range 0-1023
40  @param sw_if_index - ignored on create/delete, present in details.
41 */
42 typedef gre_tunnel
43 {
44  u32 client_index;
47  vl_api_gre_tunnel_type_t type;
50  vl_api_interface_index_t sw_if_index;
51  vl_api_address_t src;
52  vl_api_address_t dst;
53 };
54 
55 define gre_tunnel_add_del
56 {
59  bool is_add;
60  vl_api_gre_tunnel_t tunnel;
61 };
62 
63 define gre_tunnel_add_del_reply
64 {
67  vl_api_interface_index_t sw_if_index;
68 };
69 
70 define gre_tunnel_dump
71 {
74  vl_api_interface_index_t sw_if_index;
75 };
76 
77 define gre_tunnel_details
78 {
80  vl_api_gre_tunnel_t tunnel;
81 };
82 
83 /*
84  * Local Variables:
85  * eval: (c-set-style "gnu")
86  * End:
87  */
option version
Definition: gre.api:17
vl_api_address_t src
Definition: gre.api:51
vl_api_gre_tunnel_type_t type
Definition: gre.api:47
vl_api_interface_index_t sw_if_index
Definition: gre.api:67
typedef gre_tunnel
A GRE tunnel.
Definition: gre.api:43
vl_api_interface_index_t sw_if_index
Definition: gre.api:50
unsigned int u32
Definition: types.h:88
gre_tunnel_type
A GRE tunnel type.
Definition: gre.api:24
unsigned short u16
Definition: types.h:57
vl_api_address_t dst
Definition: gre.api:52
vl_api_gre_tunnel_t tunnel
Definition: gre.api:80
vl_api_gre_tunnel_t tunnel
Definition: gre.api:60
signed int i32
Definition: types.h:77
u16 session_id
Definition: gre.api:46
vl_api_interface_index_t sw_if_index
Definition: gre.api:74
u32 outer_fib_id
Definition: gre.api:49
u32 instance
Definition: gre.api:48
u32 context
Definition: gre.api:45