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 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)
102 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
103 @param mask_width - The length of the subnet mask assigned
104 @param host_address - Host IP address
105 @param router_address - Router IP address
106 @param host_mac - Host MAC address
108 typeonly define dhcp_lease
116 u8 router_address[16];
120 /** \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;
125 define dhcp_compl_event
129 vl_api_dhcp_lease_t lease;
133 rpc dhcp_client_config returns dhcp_client_config_reply events dhcp_compl_event;
136 /** \brief Dump the DHCP client configurations
138 define dhcp_client_dump
144 /** \brief DHCP Client details returned from dump
145 * @param client - The configured client
146 * @param lease - The learned lease data
148 define dhcp_client_details
151 vl_api_dhcp_client_t client;
152 vl_api_dhcp_lease_t lease;
155 /** \brief Dump DHCP proxy table
156 @param client_index - opaque cookie to identify the sender
157 @param True for IPv6 proxy table
159 define dhcp_proxy_dump
166 typeonly manual_print manual_endian define dhcp_server
172 /** \brief Tell client about a DHCP completion event
173 @param client_index - opaque cookie to identify the sender
175 manual_endian manual_print define dhcp_proxy_details
182 u8 vss_vpn_ascii_id[129];
184 u8 dhcp_src_address[16];
186 vl_api_dhcp_server_t servers[count];
189 /** \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
194 autoreply define dhcp6_duid_ll_set
201 /** \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
205 autoreply define dhcp6_clients_enable_disable
212 /** \brief Struct representing DHCPv6 address
213 @param address - address
214 @param valid_time - valid lifetime
215 @param preferred_time - preferred lifetime
217 typeonly define dhcp6_address_info
224 /** \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
230 typeonly define dhcp6_pd_prefix_info
238 /** \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
259 autoreply define dhcp6_send_client_message
274 vl_api_dhcp6_address_info_t addresses[n_addresses];
277 /** \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
298 autoreply define dhcp6_pd_send_client_message
313 vl_api_dhcp6_pd_prefix_info_t prefixes[n_prefixes];
317 rpc want_dhcp6_reply_events returns want_dhcp6_reply_events_reply
318 events dhcp6_reply_event;
322 rpc want_dhcp6_pd_reply_events returns want_dhcp6_pd_reply_events_reply
323 events dhcp6_pd_reply_event;
326 /** \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
332 autoreply define want_dhcp6_reply_events
340 /** \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
346 autoreply define want_dhcp6_pd_reply_events
354 /** \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
369 define dhcp6_reply_event
378 u16 inner_status_code;
382 vl_api_dhcp6_address_info_t addresses[n_addresses];
385 /** \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
400 define dhcp6_pd_reply_event
409 u16 inner_status_code;
413 vl_api_dhcp6_pd_prefix_info_t prefixes[n_prefixes];
418 * eval: (c-set-style "gnu")