blob: 165898f9820a2b1590bb7f2033368bcdb265c133 [file] [log] [blame]
Dave Barach0d056e52017-09-28 15:11:16 -04001/* Hey Emacs use -*- mode: C -*- */
Pavel Kotucek0f971d82017-01-03 10:48:54 +01002/*
3 * Copyright (c) 2015-2016 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 */
Pablo Camarillofb380952016-12-07 18:34:18 +010016
Takeru Hayasakac4c205b2022-12-30 16:41:44 +090017option version = "2.1.0";
Pablo Camarillo3337bd22018-06-19 15:49:02 +020018
Jakub Grajciar0938eba2020-03-04 13:08:27 +010019import "vnet/interface_types.api";
20import "vnet/ip/ip_types.api";
21import "vnet/srv6/sr_types.api";
22
Pablo Camarillo3337bd22018-06-19 15:49:02 +020023
Paul Vinciguerrae7174822019-08-07 00:05:59 -040024typedef srv6_sid_list
Pablo Camarillo3337bd22018-06-19 15:49:02 +020025{
26 u8 num_sids;
27 u32 weight;
Jakub Grajciar0938eba2020-03-04 13:08:27 +010028 vl_api_ip6_address_t sids[16];
Pablo Camarillo3337bd22018-06-19 15:49:02 +020029};
Dave Barach0d056e52017-09-28 15:11:16 -040030
Chinmaya Agarwal30fa97d2020-07-13 22:34:12 +053031typedef srv6_sid_list_with_sl_index
32{
33 u8 num_sids;
34 u32 weight;
35 u32 sl_index;
36 vl_api_ip6_address_t sids[16];
37};
38
Pablo Camarillofb380952016-12-07 18:34:18 +010039/** \brief IPv6 SR LocalSID add/del request
Pavel Kotucek0f971d82017-01-03 10:48:54 +010040 @param client_index - opaque cookie to identify the sender
41 @param context - sender context, to match reply w/ request
Pablo Camarillofb380952016-12-07 18:34:18 +010042 @param is_del Boolean of whether its a delete instruction
43 @param localsid_addr IPv6 address of the localsid
44 @param end_psp Boolean of whether decapsulation is allowed in this function
45 @param behavior Type of behavior (function) for this localsid
Dave Barach0d056e52017-09-28 15:11:16 -040046 @param sw_if_index Only for L2/L3 xconnect. OIF. In VRF variant the
Paul Vinciguerrac0e94412020-04-28 01:12:04 -040047 fib_table. Default:0xffffffff
Pablo Camarillofb380952016-12-07 18:34:18 +010048 @param vlan_index Only for L2 xconnect. Outgoing VLAN tag.
49 @param fib_table FIB table in which we should install the localsid entry
Jakub Grajciar0938eba2020-03-04 13:08:27 +010050 @param nh_addr Next Hop IPv46 address. Only for L2/L3 xconnect.
Pavel Kotucek0f971d82017-01-03 10:48:54 +010051*/
Dave Barach11b8dbf2017-04-24 10:46:54 -040052autoreply define sr_localsid_add_del
Pavel Kotucek0f971d82017-01-03 10:48:54 +010053{
54 u32 client_index;
55 u32 context;
Jakub Grajciar0938eba2020-03-04 13:08:27 +010056 bool is_del [default=false];
57 vl_api_ip6_address_t localsid;
58 bool end_psp;
59 vl_api_sr_behavior_t behavior;
Paul Vinciguerrac0e94412020-04-28 01:12:04 -040060 vl_api_interface_index_t sw_if_index [default=0xffffffff];
Pablo Camarillofb380952016-12-07 18:34:18 +010061 u32 vlan_index;
62 u32 fib_table;
Jakub Grajciar0938eba2020-03-04 13:08:27 +010063 vl_api_address_t nh_addr;
Juraj Slobodae9fcf232018-04-23 10:14:37 +020064};
65
Pablo Camarillofb380952016-12-07 18:34:18 +010066/** \brief IPv6 SR policy add
67 @param client_index - opaque cookie to identify the sender
68 @param context - sender context, to match reply w/ request
69 @param bsid is the bindingSID of the SR Policy
70 @param weight is the weight of the sid list. optional.
71 @param is_encap is the behavior of the SR policy. (0.SRH insert // 1.Encapsulation)
Jakub Grajciar0938eba2020-03-04 13:08:27 +010072 @param is_spray is the type of the SR policy. (0.Default // 1.Spray)
Pablo Camarillofb380952016-12-07 18:34:18 +010073 @param fib_table is the VRF where to install the FIB entry for the BSID
Pablo Camarillo3337bd22018-06-19 15:49:02 +020074 @param sids is a srv6_sid_list object
Pablo Camarillofb380952016-12-07 18:34:18 +010075*/
Dave Barach11b8dbf2017-04-24 10:46:54 -040076autoreply define sr_policy_add
Pablo Camarillofb380952016-12-07 18:34:18 +010077{
78 u32 client_index;
79 u32 context;
Jakub Grajciar0938eba2020-03-04 13:08:27 +010080 vl_api_ip6_address_t bsid_addr;
Pablo Camarillofb380952016-12-07 18:34:18 +010081 u32 weight;
Jakub Grajciar0938eba2020-03-04 13:08:27 +010082 bool is_encap;
83 bool is_spray;
Pablo Camarillofb380952016-12-07 18:34:18 +010084 u32 fib_table;
Pablo Camarillo3337bd22018-06-19 15:49:02 +020085 vl_api_srv6_sid_list_t sids;
Pavel Kotucek0f971d82017-01-03 10:48:54 +010086};
87
Pablo Camarillofb380952016-12-07 18:34:18 +010088/** \brief IPv6 SR policy modification
Pavel Kotucek0f971d82017-01-03 10:48:54 +010089 @param client_index - opaque cookie to identify the sender
90 @param context - sender context, to match reply w/ request
Pablo Camarillofb380952016-12-07 18:34:18 +010091 @param bsid is the bindingSID of the SR Policy
92 @param sr_policy_index is the index of the SR policy
93 @param fib_table is the VRF where to install the FIB entry for the BSID
94 @param operation is the operation to perform (among the top ones)
Pablo Camarillofb380952016-12-07 18:34:18 +010095 @param sl_index is the index of the Segment List to modify/delete
96 @param weight is the weight of the sid list. optional.
Pablo Camarillo3337bd22018-06-19 15:49:02 +020097 @param sids is a srv6_sid_list object
Pavel Kotucek0f971d82017-01-03 10:48:54 +010098*/
Dave Barach11b8dbf2017-04-24 10:46:54 -040099autoreply define sr_policy_mod
Pavel Kotucek0f971d82017-01-03 10:48:54 +0100100{
101 u32 client_index;
102 u32 context;
Jakub Grajciar0938eba2020-03-04 13:08:27 +0100103 vl_api_ip6_address_t bsid_addr;
Pablo Camarillofb380952016-12-07 18:34:18 +0100104 u32 sr_policy_index;
105 u32 fib_table;
Jakub Grajciar0938eba2020-03-04 13:08:27 +0100106 vl_api_sr_policy_op_t operation;
Pablo Camarillofb380952016-12-07 18:34:18 +0100107 u32 sl_index;
108 u32 weight;
Pablo Camarillo3337bd22018-06-19 15:49:02 +0200109 vl_api_srv6_sid_list_t sids;
Pavel Kotucek0f971d82017-01-03 10:48:54 +0100110};
111
Takeru Hayasakac4c205b2022-12-30 16:41:44 +0900112enum sr_policy_type : u8
113{
114 SR_API_POLICY_TYPE_DEFAULT = 0,
115 SR_API_POLICY_TYPE_SPRAY = 1,
116 SR_API_POLICY_TYPE_TEF = 2,
117};
118
119/** \brief IPv6 SR policy add
120 @param client_index - opaque cookie to identify the sender
121 @param context - sender context, to match reply w/ request
122 @param bsid is the bindingSID of the SR Policy
123 @param weight is the weight of the sid list. optional.
124 @param is_encap is the behavior of the SR policy. (0.SRH insert // 1.Encapsulation)
125 @param type is the SR policy param. (0.Default // 1.Spray // 2.Tef)
126 @param fib_table is the VRF where to install the FIB entry for the BSID
127 @param sids is a srv6_sid_list object
128 @param encap_src is a encaps IPv6 source addr. optional.
129*/
130autoreply define sr_policy_add_v2
131{
132 u32 client_index;
133 u32 context;
134 vl_api_ip6_address_t bsid_addr;
135 u32 weight;
136 bool is_encap;
137 vl_api_sr_policy_type_t type [default=0x0];
138 u32 fib_table;
139 vl_api_srv6_sid_list_t sids;
140 vl_api_ip6_address_t encap_src;
141 option status="in_progress";
142};
143
144/** \brief IPv6 SR policy modification
145 @param client_index - opaque cookie to identify the sender
146 @param context - sender context, to match reply w/ request
147 @param bsid is the bindingSID of the SR Policy
148 @param sr_policy_index is the index of the SR policy
149 @param fib_table is the VRF where to install the FIB entry for the BSID
150 @param operation is the operation to perform (among the top ones)
151 @param sl_index is the index of the Segment List to modify/delete
152 @param weight is the weight of the sid list. optional.
153 @param sids is a srv6_sid_list object
154 @param encap_src is a encaps IPv6 source addr. optional.
155*/
156autoreply define sr_policy_mod_v2
157{
158 u32 client_index;
159 u32 context;
160 vl_api_ip6_address_t bsid_addr;
161 u32 sr_policy_index;
162 u32 fib_table;
163 vl_api_sr_policy_op_t operation;
164 u32 sl_index;
165 u32 weight;
166 vl_api_srv6_sid_list_t sids;
167 vl_api_ip6_address_t encap_src;
168 option status="in_progress";
169};
170
Pablo Camarillofb380952016-12-07 18:34:18 +0100171/** \brief IPv6 SR policy deletion
172 @param client_index - opaque cookie to identify the sender
173 @param context - sender context, to match reply w/ request
174 @param bsid is the bindingSID of the SR Policy
175 @param index is the index of the SR policy
176*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400177autoreply define sr_policy_del
Pablo Camarillofb380952016-12-07 18:34:18 +0100178{
179 u32 client_index;
180 u32 context;
Jakub Grajciar0938eba2020-03-04 13:08:27 +0100181 vl_api_ip6_address_t bsid_addr;
Pablo Camarillofb380952016-12-07 18:34:18 +0100182 u32 sr_policy_index;
183};
184
Pablo Camarillo1a5e3012017-11-16 16:02:50 +0100185/** \brief IPv6 SR Set SRv6 encapsulation source
186 @param client_index - opaque cookie to identify the sender
187 @param context - sender context, to match reply w/ request
188 @param bsid is the bindingSID of the SR Policy
189 @param index is the index of the SR policy
190*/
191autoreply define sr_set_encap_source
192{
193 u32 client_index;
194 u32 context;
Jakub Grajciar0938eba2020-03-04 13:08:27 +0100195 vl_api_ip6_address_t encaps_source;
Pablo Camarillo1a5e3012017-11-16 16:02:50 +0100196};
197
Ignas Bačiuseeb5fb32019-10-03 17:15:38 +0300198/** \brief IPv6 SR Set SRv6 encapsulation hop-limit
199 @param client_index - opaque cookie to identify the sender
200 @param context - sender context, to match reply w/ request
201 @param hop_limit is the hop-limit value to set
202*/
203autoreply define sr_set_encap_hop_limit
204{
205 u32 client_index;
206 u32 context;
207 u8 hop_limit;
208};
209
Pablo Camarillofb380952016-12-07 18:34:18 +0100210/** \brief IPv6 SR steering add/del
211 @param client_index - opaque cookie to identify the sender
212 @param context - sender context, to match reply w/ request
213 @param is_del
214 @param bsid is the bindingSID of the SR Policy (alt to sr_policy_index)
215 @param sr_policy is the index of the SR Policy (alt to bsid)
216 @param table_id is the VRF where to install the FIB entry for the BSID
217 @param prefix is the IPv4/v6 address for L3 traffic type
218 @param mask_width is the mask for L3 traffic type
219 @param sw_if_index is the incoming interface for L2 traffic
220 @param traffic_type describes the type of traffic
221*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400222autoreply define sr_steering_add_del
Pablo Camarillofb380952016-12-07 18:34:18 +0100223{
224 u32 client_index;
225 u32 context;
Jakub Grajciar0938eba2020-03-04 13:08:27 +0100226 bool is_del [default=false];
227 vl_api_ip6_address_t bsid_addr;
Pablo Camarillofb380952016-12-07 18:34:18 +0100228 u32 sr_policy_index;
229 u32 table_id;
Jakub Grajciar0938eba2020-03-04 13:08:27 +0100230 vl_api_prefix_t prefix;
231 vl_api_interface_index_t sw_if_index;
232 vl_api_sr_steer_t traffic_type;
Pablo Camarillofb380952016-12-07 18:34:18 +0100233};
234
Pablo Camarillofb380952016-12-07 18:34:18 +0100235/** \brief Dump the list of SR LocalSIDs
236 @param client_index - opaque cookie to identify the sender
237 @param context - sender context, to match reply w/ request
238*/
Pablo Camarillo1a5e3012017-11-16 16:02:50 +0100239define sr_localsids_dump
Pablo Camarillofb380952016-12-07 18:34:18 +0100240{
241 u32 client_index;
242 u32 context;
Pablo Camarillo1a5e3012017-11-16 16:02:50 +0100243};
Pablo Camarillofb380952016-12-07 18:34:18 +0100244
Pablo Camarillo1a5e3012017-11-16 16:02:50 +0100245define sr_localsids_details
Pablo Camarillofb380952016-12-07 18:34:18 +0100246{
247 u32 context;
Jakub Grajciar0938eba2020-03-04 13:08:27 +0100248 vl_api_ip6_address_t addr;
249 bool end_psp;
250 vl_api_sr_behavior_t behavior;
Pablo Camarillofb380952016-12-07 18:34:18 +0100251 u32 fib_table;
Pablo Camarillo3337bd22018-06-19 15:49:02 +0200252 u32 vlan_index;
Jakub Grajciar0938eba2020-03-04 13:08:27 +0100253 vl_api_address_t xconnect_nh_addr;
Pablo Camarillo1a5e3012017-11-16 16:02:50 +0100254 u32 xconnect_iface_or_vrf_table;
255};
Pablo Camarillofb380952016-12-07 18:34:18 +0100256
ChinmayaAgarwal9503eb52022-09-27 12:25:22 +0530257
258/** \brief Dump the list of SR LocalSIDs along with packet statistics
259 @param client_index - opaque cookie to identify the sender
260 @param context - sender context, to match reply w/ request
261*/
262define sr_localsids_with_packet_stats_dump
263{
264 u32 client_index;
265 u32 context;
266 option status="in_progress";
267};
268
269define sr_localsids_with_packet_stats_details
270{
271 u32 context;
272 vl_api_ip6_address_t addr;
273 bool end_psp;
274 vl_api_sr_behavior_t behavior;
275 u32 fib_table;
276 u32 vlan_index;
277 vl_api_address_t xconnect_nh_addr;
278 u32 xconnect_iface_or_vrf_table;
279 u64 good_traffic_bytes;
280 u64 good_traffic_pkt_count;
281 u64 bad_traffic_bytes;
282 u64 bad_traffic_pkt_count;
283 option status="in_progress";
284};
285
286
287
Pablo Camarillo3337bd22018-06-19 15:49:02 +0200288/** \brief Dump the list of SR policies
289 @param client_index - opaque cookie to identify the sender
290 @param context - sender context, to match reply w/ request
291*/
292define sr_policies_dump
293{
Ondrej Fabry5c476e72023-04-27 00:00:40 +0200294 option deprecated;
295
Pablo Camarillo3337bd22018-06-19 15:49:02 +0200296 u32 client_index;
297 u32 context;
298};
299
Chinmaya Agarwal30fa97d2020-07-13 22:34:12 +0530300
Pablo Camarillo3337bd22018-06-19 15:49:02 +0200301define sr_policies_details
302{
303 u32 context;
Jakub Grajciar0938eba2020-03-04 13:08:27 +0100304 vl_api_ip6_address_t bsid;
305 bool is_spray;
306 bool is_encap;
Pablo Camarillo3337bd22018-06-19 15:49:02 +0200307 u32 fib_table;
308 u8 num_sid_lists;
309 vl_api_srv6_sid_list_t sid_lists[num_sid_lists];
310};
311
Takeru Hayasakac4c205b2022-12-30 16:41:44 +0900312/** \brief Dump the list of SR policies v2
313 @param client_index - opaque cookie to identify the sender
314 @param context - sender context, to match reply w/ request
315*/
316define sr_policies_v2_dump
317{
318 u32 client_index;
319 u32 context;
320};
321
322define sr_policies_v2_details
323{
324 u32 context;
325 vl_api_ip6_address_t bsid;
326 vl_api_ip6_address_t encap_src;
327 vl_api_sr_policy_type_t type;
328 bool is_encap;
329 u32 fib_table;
330 u8 num_sid_lists;
331 vl_api_srv6_sid_list_t sid_lists[num_sid_lists];
332 option in_progress;
333};
334
Chinmaya Agarwal30fa97d2020-07-13 22:34:12 +0530335/** \brief Dump the list of SR policies along with actual segment list index on VPP
336 @param client_index - opaque cookie to identify the sender
337 @param context - sender context, to match reply w/ request
338*/
339define sr_policies_with_sl_index_dump
340{
341 u32 client_index;
342 u32 context;
343 option status="in_progress";
344};
345
346
347define sr_policies_with_sl_index_details
348{
349 u32 context;
350 vl_api_ip6_address_t bsid;
351 bool is_spray;
352 bool is_encap;
353 u32 fib_table;
354 u8 num_sid_lists;
355 vl_api_srv6_sid_list_with_sl_index_t sid_lists[num_sid_lists];
356 option status="in_progress";
357};
358
Pablo Camarillo3337bd22018-06-19 15:49:02 +0200359/** \brief Dump the steering policies
360 @param client_index - opaque cookie to identify the sender
361 @param context - sender context, to match reply w/ request
362*/
363define sr_steering_pol_dump
364{
365 u32 client_index;
366 u32 context;
367};
368
369define sr_steering_pol_details
370{
371 u32 context;
Jakub Grajciar0938eba2020-03-04 13:08:27 +0100372 vl_api_sr_steer_t traffic_type;
Pablo Camarillo3337bd22018-06-19 15:49:02 +0200373 u32 fib_table;
Jakub Grajciar0938eba2020-03-04 13:08:27 +0100374 vl_api_prefix_t prefix;
375 vl_api_interface_index_t sw_if_index;
376 vl_api_ip6_address_t bsid;
Pablo Camarillo3337bd22018-06-19 15:49:02 +0200377};
378
Pavel Kotucek0f971d82017-01-03 10:48:54 +0100379/*
Dave Barach0d056e52017-09-28 15:11:16 -0400380 * fd.io coding-style-patch-verification: OFF
Pavel Kotucek0f971d82017-01-03 10:48:54 +0100381 * Local Variables:
382 * eval: (c-set-style "gnu")
383 * End:
384 */