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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 option version = "2.0.1";
18 import "vnet/ip/ip_types.api";
20 /** \brief DHCP Proxy config add / del request
21 @param client_index - opaque cookie to identify the sender
22 @param context - sender context, to match reply w/ request
23 @param rx_vrf_id - Rx/interface vrf id
24 @param server_vrf_id - server vrf id
25 @param if_ipv6 - ipv6 if non-zero, else ipv4
26 @param is_add - add the config if non-zero, else delete
27 @param insert_circuit_id - option82 suboption 1 fib number
28 @param dhcp_server[] - server address
29 @param dhcp_src_address[] - <fix this, need details>
31 autoreply define dhcp_proxy_config
40 u8 dhcp_src_address[16];
43 /** \brief DHCP Proxy set / unset vss request
44 @param client_index - opaque cookie to identify the sender
45 @param context - sender context, to match reply w/ request
46 @param tbl_id - table id
47 @vss_type - 0: use ASCI vpn_id; 1: use oui/vpn_index; 255: global vpn
48 @vpn_ascii - null terminated ASCII VPN ID up to 128 characters
49 @param oui - first part of rfc2685 vpn id, 3 bytes oui
50 @param vpn_index - second part of rfc2685 vpn id, 4 bytes vpn index
51 @param is_ipv6 - ip6 if non-zero, else ip4
52 @param is_add - set vss if non-zero, else delete
54 autoreply define dhcp_proxy_set_vss
67 /** \brief DHCP Client config data
68 @param sw_if_index - index of the interface for DHCP client
69 @param hostname - hostname
70 @param id - Client ID - option 61
71 @param want_dhcp_event - DHCP event sent to the sender
72 via dhcp_compl_event API message if non-zero
73 @param set_broadcast_flag - in the DHCP Discover to control
74 how the resulting OFFER is addressed.
75 @param dscp - DSCP value set in IP packets sent by the client
76 @param pid - sender's pid
84 u8 set_broadcast_flag;
85 vl_api_ip_dscp_t dscp;
89 /** \brief DHCP Client config add / del request
90 @param client_index - opaque cookie to identify the sender
91 @param context - sender context, to match reply w/ request
92 @param is_add - add the config if non-zero, else delete
93 @param client - client configuration data
95 autoreply define dhcp_client_config
100 vl_api_dhcp_client_t client;
103 /** \brief Struct representing domain server
104 @param address - IP address
106 typedef domain_server
111 /** \brief Data learned by the client during the DHCP process
112 @param sw_if_index - the interface on which the client is configured
113 @param state - the state of the lease (see dhcp_client_state_t)
114 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
115 @param mask_width - The length of the subnet mask assigned
116 @param host_address - Host IP address
117 @param router_address - Router IP address
118 @param host_mac - Host MAC address
128 u8 router_address[16];
131 vl_api_domain_server_t domain_server[count];
134 /** \brief Tell client about a DHCP completion event
135 @param client_index - opaque cookie to identify the sender
136 @param pid - client pid registered to receive notification
137 @param lease - Data learned during the DHCP process;
139 define dhcp_compl_event
143 vl_api_dhcp_lease_t lease;
147 rpc dhcp_client_config returns dhcp_client_config_reply events dhcp_compl_event;
150 /** \brief Dump the DHCP client configurations
152 define dhcp_client_dump
158 /** \brief DHCP Client details returned from dump
159 * @param client - The configured client
160 * @param lease - The learned lease data
162 define dhcp_client_details
165 vl_api_dhcp_client_t client;
166 vl_api_dhcp_lease_t lease;
169 /** \brief Dump DHCP proxy table
170 @param client_index - opaque cookie to identify the sender
171 @param True for IPv6 proxy table
173 define dhcp_proxy_dump
186 /** \brief Tell client about a DHCP completion event
187 @param client_index - opaque cookie to identify the sender
189 manual_endian manual_print define dhcp_proxy_details
196 u8 vss_vpn_ascii_id[129];
198 u8 dhcp_src_address[16];
200 vl_api_dhcp_server_t servers[count];
203 /** \brief Set DHCPv6 DUID-LL
204 @param client_index - opaque cookie to identify the sender
205 @param context - sender context, to match reply w/ request
206 @param duid_ll - DUID-LL binary string
208 autoreply define dhcp6_duid_ll_set
215 /** \brief Enable/disable listening on DHCPv6 client port
216 @param client_index - opaque cookie to identify the sender
217 @param context - sender context, to match reply w/ request
219 autoreply define dhcp6_clients_enable_disable
226 /** \brief Struct representing DHCPv6 address
227 @param address - address
228 @param valid_time - valid lifetime
229 @param preferred_time - preferred lifetime
231 typedef dhcp6_address_info
238 /** \brief Struct representing DHCPv6 PD prefix
239 @param prefix - prefix
240 @param prefix_length - prefix length
241 @param valid_time - valid lifetime
242 @param preferred_time - preferred lifetime
244 typedef dhcp6_pd_prefix_info
252 /** \brief Send DHCPv6 client message of specified type
253 @param client_index - opaque cookie to identify the sender
254 @param context - sender context, to match reply w/ request
255 @param sw_if_index - index of TX interface, also identifies IAID
256 @param server_index - used to dentify DHCPv6 server,
257 unique for each DHCPv6 server on the link,
258 value obrtained from dhcp6_reply_event API message,
259 use ~0 to send message to all DHCPv6 servers
260 @param irt - initial retransmission time
261 @param mrt - maximum retransmission time
262 @param mrc - maximum retransmission count
263 @param mrd - maximum retransmission duration
264 for sending the message
265 @param stop - if non-zero then stop resending the message,
266 otherwise start sending the message
267 @param msg_type - message type
268 @param T1 - value of T1 in IA_NA option
269 @param T2 - value of T2 in IA_NA option
270 @param n_addresses - number of addresses in IA_NA option
271 @param addresses - list of addresses in IA_NA option
273 autoreply define dhcp6_send_client_message
288 vl_api_dhcp6_address_info_t addresses[n_addresses];
291 /** \brief Send DHCPv6 PD client message of specified type
292 @param client_index - opaque cookie to identify the sender
293 @param context - sender context, to match reply w/ request
294 @param sw_if_index - index of TX interface
295 @param server_index - used to dentify DHCPv6 server,
296 unique for each DHCPv6 server on the link,
297 value obrtained from dhcp6_pd_reply_event API message,
298 use ~0 to send message to all DHCPv6 servers
299 @param irt - initial retransmission time
300 @param mrt - maximum retransmission time
301 @param mrc - maximum retransmission count
302 @param mrd - maximum retransmission duration
303 for sending the message
304 @param stop - if non-zero then stop resending the message,
305 otherwise start sending the message
306 @param msg_type - message type
307 @param T1 - value of T1 in IA_PD option
308 @param T2 - value of T2 in IA_PD option
309 @param n_prefixes - number of addresses in IA_PD option
310 @param prefixes - list of prefixes in IA_PD option
312 autoreply define dhcp6_pd_send_client_message
327 vl_api_dhcp6_pd_prefix_info_t prefixes[n_prefixes];
331 rpc want_dhcp6_reply_events returns want_dhcp6_reply_events_reply
332 events dhcp6_reply_event;
336 rpc want_dhcp6_pd_reply_events returns want_dhcp6_pd_reply_events_reply
337 events dhcp6_pd_reply_event;
340 /** \brief Register for DHCPv6 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
346 autoreply define want_dhcp6_reply_events
354 /** \brief Register for DHCPv6 PD reply events
355 @param client_index - opaque cookie to identify the sender
356 @param context - sender context, to match reply w/ request
357 @param enable_disable - 1 => register for events, 0 => cancel registration
358 @param pid - sender's pid
360 autoreply define want_dhcp6_pd_reply_events
368 /** \brief Tell client about a DHCPv6 server reply event
369 @param client_index - opaque cookie to identify the sender
370 @param pid - client pid registered to receive notification
371 @param sw_if_index - index of RX interface, also identifies IAID
372 @param server_index - used to dentify DHCPv6 server,
373 unique for each DHCPv6 server on the link
374 @param msg_type - message type
375 @param T1 - value of T1 in IA_NA option
376 @param T2 - value of T2 in IA_NA option
377 @param inner_status_code - value of status code inside IA_NA option
378 @param status_code - value of status code
379 @param preference - value of preference option in reply message
380 @param n_addresses - number of addresses in IA_NA option
381 @param addresses - list of addresses in IA_NA option
383 define dhcp6_reply_event
392 u16 inner_status_code;
396 vl_api_dhcp6_address_info_t addresses[n_addresses];
399 /** \brief Tell client about a DHCPv6 PD server reply event
400 @param client_index - opaque cookie to identify the sender
401 @param pid - client pid registered to receive notification
402 @param sw_if_index - index of RX interface
403 @param server_index - used to dentify DHCPv6 server,
404 unique for each DHCPv6 server on the link
405 @param msg_type - message type
406 @param T1 - value of T1 in IA_PD option
407 @param T2 - value of T2 in IA_PD option
408 @param inner_status_code - value of status code inside IA_PD option
409 @param status_code - value of the main status code of DHCPv6 message
410 @param preference - value of preference option in reply message
411 @param n_prefixes - number of prefixes in IA_PD option
412 @param prefixes - list of prefixes in IA_PD option
414 define dhcp6_pd_reply_event
423 u16 inner_status_code;
427 vl_api_dhcp6_pd_prefix_info_t prefixes[n_prefixes];
432 * eval: (c-set-style "gnu")