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 /** \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
21 @param rx_vrf_id - Rx/interface vrf id
22 @param server_vrf_id - server vrf id
23 @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>
29 autoreply define dhcp_proxy_config
38 u8 dhcp_src_address[16];
41 /** \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
45 @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
49 @param is_ipv6 - ip6 if non-zero, else ip4
50 @param is_add - set vss if non-zero, else delete
52 autoreply define dhcp_proxy_set_vss
65 /** \brief DHCP Client config data
66 @param sw_if_index - index of the interface for DHCP client
67 @param hostname - hostname
68 @param id - Client ID - option 61
69 @param want_dhcp_event - DHCP event sent to the sender
70 via dhcp_compl_event API message if non-zero
71 @param set_broadcast_flag - in the DHCP Discover to control
72 how the resulting OFFER is addressed.
73 @param pid - sender's pid
75 typeonly define dhcp_client
81 u8 set_broadcast_flag;
85 /** \brief DHCP Client config add / del request
86 @param client_index - opaque cookie to identify the sender
87 @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
91 autoreply define dhcp_client_config
96 vl_api_dhcp_client_t client;
99 /** \brief Struct representing domain server
100 @param address - IP address
102 typeonly manual_print manual_endian define domain_server
107 /** \brief Data learned by the client during the DHCP process
108 @param sw_if_index - the interface on which the client is configured
109 @param state - the state of the lease (see dhcp_client_state_t)
110 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
111 @param mask_width - The length of the subnet mask assigned
112 @param host_address - Host IP address
113 @param router_address - Router IP address
114 @param host_mac - Host MAC address
116 typeonly define dhcp_lease
124 u8 router_address[16];
127 vl_api_domain_server_t domain_server[count];
130 /** \brief Tell client about a DHCP completion event
131 @param client_index - opaque cookie to identify the sender
132 @param pid - client pid registered to receive notification
133 @param lease - Data learned during the DHCP process;
135 define dhcp_compl_event
139 vl_api_dhcp_lease_t lease;
143 rpc dhcp_client_config returns dhcp_client_config_reply events dhcp_compl_event;
146 /** \brief Dump the DHCP client configurations
148 define dhcp_client_dump
154 /** \brief DHCP Client details returned from dump
155 * @param client - The configured client
156 * @param lease - The learned lease data
158 define dhcp_client_details
161 vl_api_dhcp_client_t client;
162 vl_api_dhcp_lease_t lease;
165 /** \brief Dump DHCP proxy table
166 @param client_index - opaque cookie to identify the sender
167 @param True for IPv6 proxy table
169 define dhcp_proxy_dump
176 typeonly manual_print manual_endian define dhcp_server
182 /** \brief Tell client about a DHCP completion event
183 @param client_index - opaque cookie to identify the sender
185 manual_endian manual_print define dhcp_proxy_details
192 u8 vss_vpn_ascii_id[129];
194 u8 dhcp_src_address[16];
196 vl_api_dhcp_server_t servers[count];
199 /** \brief Set DHCPv6 DUID-LL
200 @param client_index - opaque cookie to identify the sender
201 @param context - sender context, to match reply w/ request
202 @param duid_ll - DUID-LL binary string
204 autoreply define dhcp6_duid_ll_set
211 /** \brief Enable/disable listening on DHCPv6 client port
212 @param client_index - opaque cookie to identify the sender
213 @param context - sender context, to match reply w/ request
215 autoreply define dhcp6_clients_enable_disable
222 /** \brief Struct representing DHCPv6 address
223 @param address - address
224 @param valid_time - valid lifetime
225 @param preferred_time - preferred lifetime
227 typeonly define dhcp6_address_info
234 /** \brief Struct representing DHCPv6 PD prefix
235 @param prefix - prefix
236 @param prefix_length - prefix length
237 @param valid_time - valid lifetime
238 @param preferred_time - preferred lifetime
240 typeonly define dhcp6_pd_prefix_info
248 /** \brief Send DHCPv6 client message of specified type
249 @param client_index - opaque cookie to identify the sender
250 @param context - sender context, to match reply w/ request
251 @param sw_if_index - index of TX interface, also identifies IAID
252 @param server_index - used to dentify DHCPv6 server,
253 unique for each DHCPv6 server on the link,
254 value obrtained from dhcp6_reply_event API message,
255 use ~0 to send message to all DHCPv6 servers
256 @param irt - initial retransmission time
257 @param mrt - maximum retransmission time
258 @param mrc - maximum retransmission count
259 @param mrd - maximum retransmission duration
260 for sending the message
261 @param stop - if non-zero then stop resending the message,
262 otherwise start sending the message
263 @param msg_type - message type
264 @param T1 - value of T1 in IA_NA option
265 @param T2 - value of T2 in IA_NA option
266 @param n_addresses - number of addresses in IA_NA option
267 @param addresses - list of addresses in IA_NA option
269 autoreply define dhcp6_send_client_message
284 vl_api_dhcp6_address_info_t addresses[n_addresses];
287 /** \brief Send DHCPv6 PD client message of specified type
288 @param client_index - opaque cookie to identify the sender
289 @param context - sender context, to match reply w/ request
290 @param sw_if_index - index of TX interface
291 @param server_index - used to dentify DHCPv6 server,
292 unique for each DHCPv6 server on the link,
293 value obrtained from dhcp6_pd_reply_event API message,
294 use ~0 to send message to all DHCPv6 servers
295 @param irt - initial retransmission time
296 @param mrt - maximum retransmission time
297 @param mrc - maximum retransmission count
298 @param mrd - maximum retransmission duration
299 for sending the message
300 @param stop - if non-zero then stop resending the message,
301 otherwise start sending the message
302 @param msg_type - message type
303 @param T1 - value of T1 in IA_PD option
304 @param T2 - value of T2 in IA_PD option
305 @param n_prefixes - number of addresses in IA_PD option
306 @param prefixes - list of prefixes in IA_PD option
308 autoreply define dhcp6_pd_send_client_message
323 vl_api_dhcp6_pd_prefix_info_t prefixes[n_prefixes];
327 rpc want_dhcp6_reply_events returns want_dhcp6_reply_events_reply
328 events dhcp6_reply_event;
332 rpc want_dhcp6_pd_reply_events returns want_dhcp6_pd_reply_events_reply
333 events dhcp6_pd_reply_event;
336 /** \brief Register for DHCPv6 reply events
337 @param client_index - opaque cookie to identify the sender
338 @param context - sender context, to match reply w/ request
339 @param enable_disable - 1 => register for events, 0 => cancel registration
340 @param pid - sender's pid
342 autoreply define want_dhcp6_reply_events
350 /** \brief Register for DHCPv6 PD reply events
351 @param client_index - opaque cookie to identify the sender
352 @param context - sender context, to match reply w/ request
353 @param enable_disable - 1 => register for events, 0 => cancel registration
354 @param pid - sender's pid
356 autoreply define want_dhcp6_pd_reply_events
364 /** \brief Tell client about a DHCPv6 server reply event
365 @param client_index - opaque cookie to identify the sender
366 @param pid - client pid registered to receive notification
367 @param sw_if_index - index of RX interface, also identifies IAID
368 @param server_index - used to dentify DHCPv6 server,
369 unique for each DHCPv6 server on the link
370 @param msg_type - message type
371 @param T1 - value of T1 in IA_NA option
372 @param T2 - value of T2 in IA_NA option
373 @param inner_status_code - value of status code inside IA_NA option
374 @param status_code - value of status code
375 @param preference - value of preference option in reply message
376 @param n_addresses - number of addresses in IA_NA option
377 @param addresses - list of addresses in IA_NA option
379 define dhcp6_reply_event
388 u16 inner_status_code;
392 vl_api_dhcp6_address_info_t addresses[n_addresses];
395 /** \brief Tell client about a DHCPv6 PD server reply event
396 @param client_index - opaque cookie to identify the sender
397 @param pid - client pid registered to receive notification
398 @param sw_if_index - index of RX interface
399 @param server_index - used to dentify DHCPv6 server,
400 unique for each DHCPv6 server on the link
401 @param msg_type - message type
402 @param T1 - value of T1 in IA_PD option
403 @param T2 - value of T2 in IA_PD option
404 @param inner_status_code - value of status code inside IA_PD option
405 @param status_code - value of the main status code of DHCPv6 message
406 @param preference - value of preference option in reply message
407 @param n_prefixes - number of prefixes in IA_PD option
408 @param prefixes - list of prefixes in IA_PD option
410 define dhcp6_pd_reply_event
419 u16 inner_status_code;
423 vl_api_dhcp6_pd_prefix_info_t prefixes[n_prefixes];
428 * eval: (c-set-style "gnu")