blob: ac1e68509e7f837dac6fa5f73b5660f31a14ee9f [file] [log] [blame]
Pavel Kotucekc8d87702017-01-25 07:25:32 +01001/*
2 * Copyright (c) 2015-2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
Juraj Sloboda81119e82018-05-25 14:02:20 +020016option version = "2.0.1";
Dave Barach0d056e52017-09-28 15:11:16 -040017
Pavel Kotucekc8d87702017-01-25 07:25:32 +010018/** \brief DHCP Proxy config add / del request
19 @param client_index - opaque cookie to identify the sender
20 @param context - sender context, to match reply w/ request
Neale Ranns20a175a2017-02-14 07:28:41 -080021 @param rx_vrf_id - Rx/interface vrf id
22 @param server_vrf_id - server vrf id
Pavel Kotucekc8d87702017-01-25 07:25:32 +010023 @param if_ipv6 - ipv6 if non-zero, else ipv4
24 @param is_add - add the config if non-zero, else delete
25 @param insert_circuit_id - option82 suboption 1 fib number
26 @param dhcp_server[] - server address
27 @param dhcp_src_address[] - <fix this, need details>
28*/
Dave Barach11b8dbf2017-04-24 10:46:54 -040029autoreply define dhcp_proxy_config
Pavel Kotucekc8d87702017-01-25 07:25:32 +010030{
31 u32 client_index;
32 u32 context;
Neale Ranns20a175a2017-02-14 07:28:41 -080033 u32 rx_vrf_id;
34 u32 server_vrf_id;
Pavel Kotucekc8d87702017-01-25 07:25:32 +010035 u8 is_ipv6;
36 u8 is_add;
Pavel Kotucekc8d87702017-01-25 07:25:32 +010037 u8 dhcp_server[16];
38 u8 dhcp_src_address[16];
39};
40
Pavel Kotucekc8d87702017-01-25 07:25:32 +010041/** \brief DHCP Proxy set / unset vss request
42 @param client_index - opaque cookie to identify the sender
43 @param context - sender context, to match reply w/ request
44 @param tbl_id - table id
John Lo70bfcaf2017-11-14 13:19:26 -050045 @vss_type - 0: use ASCI vpn_id; 1: use oui/vpn_index; 255: global vpn
46 @vpn_ascii - null terminated ASCII VPN ID up to 128 characters
47 @param oui - first part of rfc2685 vpn id, 3 bytes oui
48 @param vpn_index - second part of rfc2685 vpn id, 4 bytes vpn index
Pavel Kotucekc8d87702017-01-25 07:25:32 +010049 @param is_ipv6 - ip6 if non-zero, else ip4
50 @param is_add - set vss if non-zero, else delete
51*/
Dave Barach11b8dbf2017-04-24 10:46:54 -040052autoreply define dhcp_proxy_set_vss
Pavel Kotucekc8d87702017-01-25 07:25:32 +010053{
54 u32 client_index;
55 u32 context;
56 u32 tbl_id;
John Lo70bfcaf2017-11-14 13:19:26 -050057 u8 vss_type;
58 u8 vpn_ascii_id[129];
Pavel Kotucekc8d87702017-01-25 07:25:32 +010059 u32 oui;
John Lo70bfcaf2017-11-14 13:19:26 -050060 u32 vpn_index;
Pavel Kotucekc8d87702017-01-25 07:25:32 +010061 u8 is_ipv6;
62 u8 is_add;
63};
64
Neale Rannsdaff1782018-05-16 04:12:18 -070065/** \brief DHCP Client config data
Pavel Kotucekc8d87702017-01-25 07:25:32 +010066 @param sw_if_index - index of the interface for DHCP client
67 @param hostname - hostname
Neale Rannsdaff1782018-05-16 04:12:18 -070068 @param id - Client ID - option 61
Pavel Kotucekc8d87702017-01-25 07:25:32 +010069 @param want_dhcp_event - DHCP event sent to the sender
70 via dhcp_compl_event API message if non-zero
Neale Ranns54c6dc42018-01-17 10:29:10 -080071 @param set_broadcast_flag - in the DHCP Discover to control
72 how the resulting OFFER is addressed.
Pavel Kotucekc8d87702017-01-25 07:25:32 +010073 @param pid - sender's pid
74*/
Neale Rannsdaff1782018-05-16 04:12:18 -070075typeonly define dhcp_client
Pavel Kotucekc8d87702017-01-25 07:25:32 +010076{
Pavel Kotucekc8d87702017-01-25 07:25:32 +010077 u32 sw_if_index;
78 u8 hostname[64];
Neale Rannsdaff1782018-05-16 04:12:18 -070079 u8 id[64];
Pavel Kotucekc8d87702017-01-25 07:25:32 +010080 u8 want_dhcp_event;
Neale Ranns54c6dc42018-01-17 10:29:10 -080081 u8 set_broadcast_flag;
Pavel Kotucekc8d87702017-01-25 07:25:32 +010082 u32 pid;
83};
84
Neale Rannsdaff1782018-05-16 04:12:18 -070085/** \brief DHCP Client config add / del request
Pavel Kotucekc8d87702017-01-25 07:25:32 +010086 @param client_index - opaque cookie to identify the sender
Neale Rannsdaff1782018-05-16 04:12:18 -070087 @param context - sender context, to match reply w/ request
88 @param is_add - add the config if non-zero, else delete
89 @param client - client configuration data
90*/
91autoreply define dhcp_client_config
92{
93 u32 client_index;
94 u32 context;
95 u8 is_add;
96 vl_api_dhcp_client_t client;
97};
98
99/** \brief Data learned by the client during the DHCP process
100 @param sw_if_index - the interface on which the client is configured
101 @param state - the state of the lease (see dhcp_client_state_t)
Pavel Kotucekc8d87702017-01-25 07:25:32 +0100102 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
Neale Ranns4729b1e2017-07-06 01:39:05 -0700103 @param mask_width - The length of the subnet mask assigned
Pavel Kotucekc8d87702017-01-25 07:25:32 +0100104 @param host_address - Host IP address
105 @param router_address - Router IP address
106 @param host_mac - Host MAC address
107*/
Neale Rannsdaff1782018-05-16 04:12:18 -0700108typeonly define dhcp_lease
Pavel Kotucekc8d87702017-01-25 07:25:32 +0100109{
Neale Rannsdaff1782018-05-16 04:12:18 -0700110 u32 sw_if_index;
111 u8 state;
Pavel Kotucekc8d87702017-01-25 07:25:32 +0100112 u8 hostname[64];
113 u8 is_ipv6;
Neale Ranns4729b1e2017-07-06 01:39:05 -0700114 u8 mask_width;
Pavel Kotucekc8d87702017-01-25 07:25:32 +0100115 u8 host_address[16];
116 u8 router_address[16];
117 u8 host_mac[6];
118};
119
Neale Rannsdaff1782018-05-16 04:12:18 -0700120/** \brief Tell client about a DHCP completion event
121 @param client_index - opaque cookie to identify the sender
122 @param pid - client pid registered to receive notification
123 @param lease - Data learned during the DHCP process;
124*/
125define dhcp_compl_event
126{
127 u32 client_index;
128 u32 pid;
129 vl_api_dhcp_lease_t lease;
130};
131
Marek Gradzki51e59682018-03-06 10:05:44 +0100132service {
133 rpc dhcp_client_config returns dhcp_client_config_reply events dhcp_compl_event;
134};
135
Neale Rannsdaff1782018-05-16 04:12:18 -0700136/** \brief Dump the DHCP client configurations
137 */
138define dhcp_client_dump
139{
140 u32 client_index;
141 u32 context;
142};
143
144/** \brief DHCP Client details returned from dump
145 * @param client - The configured client
146 * @param lease - The learned lease data
147 */
148define dhcp_client_details
149{
150 u32 context;
151 vl_api_dhcp_client_t client;
152 vl_api_dhcp_lease_t lease;
153};
154
Neale Ranns20a175a2017-02-14 07:28:41 -0800155/** \brief Dump DHCP proxy table
156 @param client_index - opaque cookie to identify the sender
157 @param True for IPv6 proxy table
158*/
159define dhcp_proxy_dump
160{
161 u32 client_index;
162 u32 context;
163 u8 is_ip6;
164};
165
Neale Ranns3466c302017-02-16 07:45:03 -0800166typeonly manual_print manual_endian define dhcp_server
167{
168 u32 server_vrf_id;
169 u8 dhcp_server[16];
170};
171
Neale Ranns20a175a2017-02-14 07:28:41 -0800172/** \brief Tell client about a DHCP completion event
173 @param client_index - opaque cookie to identify the sender
174*/
Neale Ranns3466c302017-02-16 07:45:03 -0800175manual_endian manual_print define dhcp_proxy_details
Neale Ranns20a175a2017-02-14 07:28:41 -0800176{
177 u32 context;
178 u32 rx_vrf_id;
Neale Ranns20a175a2017-02-14 07:28:41 -0800179 u32 vss_oui;
180 u32 vss_fib_id;
John Lo70bfcaf2017-11-14 13:19:26 -0500181 u8 vss_type;
182 u8 vss_vpn_ascii_id[129];
Neale Ranns20a175a2017-02-14 07:28:41 -0800183 u8 is_ipv6;
Neale Ranns20a175a2017-02-14 07:28:41 -0800184 u8 dhcp_src_address[16];
Neale Ranns3466c302017-02-16 07:45:03 -0800185 u8 count;
186 vl_api_dhcp_server_t servers[count];
Neale Ranns20a175a2017-02-14 07:28:41 -0800187};
188
Juraj Slobodad9778c22018-06-12 10:21:05 +0200189/** \brief Set DHCPv6 DUID-LL
190 @param client_index - opaque cookie to identify the sender
191 @param context - sender context, to match reply w/ request
192 @param duid_ll - DUID-LL binary string
193*/
194autoreply define dhcp6_duid_ll_set
195{
196 u32 client_index;
197 u32 context;
198 u8 duid_ll[10];
199};
200
Juraj Sloboda81119e82018-05-25 14:02:20 +0200201/** \brief Enable/disable listening on DHCPv6 client port
202 @param client_index - opaque cookie to identify the sender
203 @param context - sender context, to match reply w/ request
204*/
205autoreply define dhcp6_clients_enable_disable
206{
207 u32 client_index;
208 u32 context;
209 u8 enable;
210};
211
Juraj Slobodadd3b8f72018-05-04 14:20:06 +0200212/** \brief Struct representing DHCPv6 address
213 @param address - address
214 @param valid_time - valid lifetime
215 @param preferred_time - preferred lifetime
216*/
217typeonly define dhcp6_address_info
218{
219 u8 address[16];
220 u32 valid_time;
221 u32 preferred_time;
222};
223
Juraj Sloboda81119e82018-05-25 14:02:20 +0200224/** \brief Struct representing DHCPv6 PD prefix
225 @param prefix - prefix
226 @param prefix_length - prefix length
227 @param valid_time - valid lifetime
228 @param preferred_time - preferred lifetime
229*/
230typeonly define dhcp6_pd_prefix_info
231{
232 u8 prefix[16];
233 u8 prefix_length;
234 u32 valid_time;
235 u32 preferred_time;
236};
237
Juraj Slobodadd3b8f72018-05-04 14:20:06 +0200238/** \brief Send DHCPv6 client message of specified type
239 @param client_index - opaque cookie to identify the sender
240 @param context - sender context, to match reply w/ request
241 @param sw_if_index - index of TX interface, also identifies IAID
242 @param server_index - used to dentify DHCPv6 server,
243 unique for each DHCPv6 server on the link,
244 value obrtained from dhcp6_reply_event API message,
245 use ~0 to send message to all DHCPv6 servers
246 @param irt - initial retransmission time
247 @param mrt - maximum retransmission time
248 @param mrc - maximum retransmission count
249 @param mrd - maximum retransmission duration
250 for sending the message
251 @param stop - if non-zero then stop resending the message,
252 otherwise start sending the message
253 @param msg_type - message type
254 @param T1 - value of T1 in IA_NA option
255 @param T2 - value of T2 in IA_NA option
256 @param n_addresses - number of addresses in IA_NA option
257 @param addresses - list of addresses in IA_NA option
258*/
259autoreply define dhcp6_send_client_message
260{
261 u32 client_index;
262 u32 context;
263 u32 sw_if_index;
264 u32 server_index;
265 u32 irt;
266 u32 mrt;
267 u32 mrc;
268 u32 mrd;
269 u8 stop;
270 u8 msg_type;
271 u32 T1;
272 u32 T2;
273 u32 n_addresses;
274 vl_api_dhcp6_address_info_t addresses[n_addresses];
275};
276
Juraj Sloboda81119e82018-05-25 14:02:20 +0200277/** \brief Send DHCPv6 PD client message of specified type
278 @param client_index - opaque cookie to identify the sender
279 @param context - sender context, to match reply w/ request
280 @param sw_if_index - index of TX interface
281 @param server_index - used to dentify DHCPv6 server,
282 unique for each DHCPv6 server on the link,
283 value obrtained from dhcp6_pd_reply_event API message,
284 use ~0 to send message to all DHCPv6 servers
285 @param irt - initial retransmission time
286 @param mrt - maximum retransmission time
287 @param mrc - maximum retransmission count
288 @param mrd - maximum retransmission duration
289 for sending the message
290 @param stop - if non-zero then stop resending the message,
291 otherwise start sending the message
292 @param msg_type - message type
293 @param T1 - value of T1 in IA_PD option
294 @param T2 - value of T2 in IA_PD option
295 @param n_prefixes - number of addresses in IA_PD option
296 @param prefixes - list of prefixes in IA_PD option
297*/
298autoreply define dhcp6_pd_send_client_message
299{
300 u32 client_index;
301 u32 context;
302 u32 sw_if_index;
303 u32 server_index;
304 u32 irt;
305 u32 mrt;
306 u32 mrc;
307 u32 mrd;
308 u8 stop;
309 u8 msg_type;
310 u32 T1;
311 u32 T2;
312 u32 n_prefixes;
313 vl_api_dhcp6_pd_prefix_info_t prefixes[n_prefixes];
314};
315
316service {
Juraj Slobodadd3b8f72018-05-04 14:20:06 +0200317 rpc want_dhcp6_reply_events returns want_dhcp6_reply_events_reply
318 events dhcp6_reply_event;
319};
320
321service {
Juraj Sloboda81119e82018-05-25 14:02:20 +0200322 rpc want_dhcp6_pd_reply_events returns want_dhcp6_pd_reply_events_reply
323 events dhcp6_pd_reply_event;
324};
325
Juraj Slobodadd3b8f72018-05-04 14:20:06 +0200326/** \brief Register for DHCPv6 reply events
327 @param client_index - opaque cookie to identify the sender
328 @param context - sender context, to match reply w/ request
329 @param enable_disable - 1 => register for events, 0 => cancel registration
330 @param pid - sender's pid
331*/
332autoreply define want_dhcp6_reply_events
333{
334 u32 client_index;
335 u32 context;
336 u8 enable_disable;
337 u32 pid;
338};
339
Juraj Sloboda81119e82018-05-25 14:02:20 +0200340/** \brief Register for DHCPv6 PD reply events
341 @param client_index - opaque cookie to identify the sender
342 @param context - sender context, to match reply w/ request
343 @param enable_disable - 1 => register for events, 0 => cancel registration
344 @param pid - sender's pid
345*/
346autoreply define want_dhcp6_pd_reply_events
347{
348 u32 client_index;
349 u32 context;
350 u8 enable_disable;
351 u32 pid;
352};
353
Juraj Slobodadd3b8f72018-05-04 14:20:06 +0200354/** \brief Tell client about a DHCPv6 server reply event
355 @param client_index - opaque cookie to identify the sender
356 @param pid - client pid registered to receive notification
357 @param sw_if_index - index of RX interface, also identifies IAID
358 @param server_index - used to dentify DHCPv6 server,
359 unique for each DHCPv6 server on the link
360 @param msg_type - message type
361 @param T1 - value of T1 in IA_NA option
362 @param T2 - value of T2 in IA_NA option
363 @param inner_status_code - value of status code inside IA_NA option
364 @param status_code - value of status code
365 @param preference - value of preference option in reply message
366 @param n_addresses - number of addresses in IA_NA option
367 @param addresses - list of addresses in IA_NA option
368*/
369define dhcp6_reply_event
370{
371 u32 client_index;
372 u32 pid;
373 u32 sw_if_index;
374 u32 server_index;
375 u8 msg_type;
376 u32 T1;
377 u32 T2;
378 u16 inner_status_code;
379 u16 status_code;
380 u8 preference;
381 u32 n_addresses;
382 vl_api_dhcp6_address_info_t addresses[n_addresses];
383};
384
Juraj Sloboda81119e82018-05-25 14:02:20 +0200385/** \brief Tell client about a DHCPv6 PD server reply event
386 @param client_index - opaque cookie to identify the sender
387 @param pid - client pid registered to receive notification
388 @param sw_if_index - index of RX interface
389 @param server_index - used to dentify DHCPv6 server,
390 unique for each DHCPv6 server on the link
391 @param msg_type - message type
392 @param T1 - value of T1 in IA_PD option
393 @param T2 - value of T2 in IA_PD option
394 @param inner_status_code - value of status code inside IA_PD option
395 @param status_code - value of the main status code of DHCPv6 message
396 @param preference - value of preference option in reply message
397 @param n_prefixes - number of prefixes in IA_PD option
398 @param prefixes - list of prefixes in IA_PD option
399*/
400define dhcp6_pd_reply_event
401{
402 u32 client_index;
403 u32 pid;
404 u32 sw_if_index;
405 u32 server_index;
406 u8 msg_type;
407 u32 T1;
408 u32 T2;
409 u16 inner_status_code;
410 u16 status_code;
411 u8 preference;
412 u32 n_prefixes;
413 vl_api_dhcp6_pd_prefix_info_t prefixes[n_prefixes];
414};
415
Pavel Kotucekc8d87702017-01-25 07:25:32 +0100416/*
417 * Local Variables:
418 * eval: (c-set-style "gnu")
419 * End:
Dave Barach11b8dbf2017-04-24 10:46:54 -0400420 */