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 = "1.0.0";
18 typeonly manual_print manual_endian define local_locator
25 /** \brief add or delete locator_set
26 @param client_index - opaque cookie to identify the sender
27 @param context - sender context, to match reply w/ request
28 @param is_add - add address if non-zero, else delete
29 @param locator_set_name - locator name
30 @param locator_num - number of locators
31 @param locators - LISP locator records
33 manual_endian manual_print define lisp_add_del_locator_set
38 u8 locator_set_name[64];
40 vl_api_local_locator_t locators[locator_num];
43 /** \brief Reply for locator_set add/del
44 @param context - returned sender context, to match reply w/ request
45 @param retval - return code
46 @param ls_index - locator set index
48 define lisp_add_del_locator_set_reply
55 /** \brief add or delete locator for locator_set
56 @param client_index - opaque cookie to identify the sender
57 @param context - sender context, to match reply w/ request
58 @param is_add - add address if non-zero, else delete
59 @param locator_set_name - name of locator_set to add/del locator
60 @param sw_if_index - index of the interface
61 @param priority - priority of the lisp locator
62 @param weight - weight of the lisp locator
64 autoreply define lisp_add_del_locator
69 u8 locator_set_name[64];
75 /** \brief add or delete lisp eid-table
76 @param client_index - opaque cookie to identify the sender
77 @param context - sender context, to match reply w/ request
78 @param is_add - add address if non-zero, else delete
83 @param eid - EID can be ip4, ip6 or mac
84 @param prefix_len - prefix len
85 @param locator_set_name - name of locator_set to add/del eid-table
86 @param vni - virtual network instance
91 @param key - secret key
93 autoreply define lisp_add_del_local_eid
101 u8 locator_set_name[64];
107 /** \brief Add/delete map server
108 @param client_index - opaque cookie to identify the sender
109 @param context - sender context, to match reply w/ request
110 @param is_add - add address if non-zero; delete otherwise
111 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
112 @param ip_address - map server IP address
114 autoreply define lisp_add_del_map_server
123 /** \brief add or delete map-resolver
124 @param client_index - opaque cookie to identify the sender
125 @param context - sender context, to match reply w/ request
126 @param is_add - add address if non-zero, else delete
127 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
128 @param ip_address - array of address bytes
130 autoreply define lisp_add_del_map_resolver
139 /** \brief enable or disable LISP feature
140 @param client_index - opaque cookie to identify the sender
141 @param context - sender context, to match reply w/ request
142 @param is_en - enable protocol if non-zero, else disable
144 autoreply define lisp_enable_disable
151 /** \brief configure or disable LISP PITR node
152 @param client_index - opaque cookie to identify the sender
153 @param context - sender context, to match reply w/ request
154 @param ls_name - locator set name
155 @param is_add - add locator set if non-zero, else disable pitr
157 autoreply define lisp_pitr_set_locator_set
165 /** \brief configure or disable use of PETR
166 @param client_index - opaque cookie to identify the sender
167 @param context - sender context, to match reply w/ request
168 @param is_ip4 - Address is IPv4 if set and IPv6 otherwise
169 @param address - PETR IP address
170 @param is_add - add locator set if non-zero, else disable pitr
172 autoreply define lisp_use_petr
181 /** \brief Request for LISP PETR status
182 @param client_index - opaque cookie to identify the sender
183 @param context - sender context, to match reply w/ request
185 define show_lisp_use_petr
191 /** \brief LISP PETR status, enable or disable
192 @param context - sender context, to match reply w/ request
193 @param status - LISP PETR enable if non-zero, else disable
194 @param is_ip4 - Address is IPv4 if non-zero, else IPv6
195 @param address - PETR IP address
197 define show_lisp_use_petr_reply
206 /** \brief Get state of LISP RLOC probing
207 @param client_index - opaque cookie to identify the sender
208 @param context - sender context, to match reply w/ request
210 define show_lisp_rloc_probe_state
216 /** \brief Reply for show_lisp_rloc_probe_state
217 @param context - returned sender context, to match reply w/ request
218 @param retval - return code
219 @param is_enabled - state of RLOC probing
221 define show_lisp_rloc_probe_state_reply
228 /** \brief enable/disable LISP RLOC probing
229 @param client_index - opaque cookie to identify the sender
230 @param context - sender context, to match reply w/ request
231 @param is_enable - enable if non-zero; disable otherwise
233 autoreply define lisp_rloc_probe_enable_disable
240 /** \brief enable/disable LISP map-register
241 @param client_index - opaque cookie to identify the sender
242 @param context - sender context, to match reply w/ request
243 @param is_enable - enable if non-zero; disable otherwise
245 autoreply define lisp_map_register_enable_disable
252 /** \brief Get state of LISP map-register
253 @param client_index - opaque cookie to identify the sender
254 @param context - sender context, to match reply w/ request
256 define show_lisp_map_register_state
262 /** \brief Reply for show_lisp_map_register_state
263 @param context - returned sender context, to match reply w/ request
264 @param retval - return code
266 define show_lisp_map_register_state_reply
273 /** \brief set LISP map-request mode. Based on configuration VPP will send
274 src/dest or just normal destination map requests.
275 @param client_index - opaque cookie to identify the sender
276 @param context - sender context, to match reply w/ request
277 @param mode - new map-request mode. Supported values are:
279 1 - source/destaination
281 autoreply define lisp_map_request_mode
288 /** \brief Request for LISP map-request mode
289 @param client_index - opaque cookie to identify the sender
290 @param context - sender context, to match reply w/ request
292 define show_lisp_map_request_mode
298 /** \brief Reply for show_lisp_map_request_mode
299 @param context - returned sender context, to match reply w/ request
300 @param retval - return code
301 @param mode - map-request mode
303 define show_lisp_map_request_mode_reply
310 typeonly manual_endian manual_print define remote_locator
318 /** \brief add or delete remote static mapping
319 @param client_index - opaque cookie to identify the sender
320 @param context - sender context, to match reply w/ request
321 @param is_add - add address if non-zero, else delete
322 @param is_src_dst - flag indicating src/dst based routing policy
323 @param del_all - if set, delete all remote mappings
324 @param vni - virtual network instance
325 @param action - negative map-reply action
330 @param deid - dst EID
331 @param seid - src EID, valid only if is_src_dst is enabled
332 @param rloc_num - number of remote locators
333 @param rlocs - remote locator records
335 autoreply manual_print manual_endian define lisp_add_del_remote_mapping
350 vl_api_remote_locator_t rlocs[rloc_num];
353 /** \brief add or delete LISP adjacency adjacency
354 @param client_index - opaque cookie to identify the sender
355 @param context - sender context, to match reply w/ request
356 @param is_add - add address if non-zero, else delete
357 @param vni - virtual network instance
362 @param reid - remote EID
363 @param leid - local EID
365 autoreply define lisp_add_del_adjacency
378 /** \brief add or delete map request itr rlocs
379 @param client_index - opaque cookie to identify the sender
380 @param context - sender context, to match reply w/ request
381 @param is_add - add address if non-zero, else delete
382 @param locator_set_name - locator set name
384 autoreply define lisp_add_del_map_request_itr_rlocs
389 u8 locator_set_name[64];
392 /** \brief Reply for lisp_add_del_map_request_itr_rlocs
393 @param context - returned sender context, to match reply w/ request
394 @param retval - return code
397 /** \brief map/unmap vni/bd_index to vrf
398 @param client_index - opaque cookie to identify the sender
399 @param context - sender context, to match reply w/ request
400 @param is_add - add or delete mapping
401 @param dp_table - virtual network id/bridge domain index
404 autoreply define lisp_eid_table_add_del_map
414 /** \brief Request for map lisp locator status
415 @param client_index - opaque cookie to identify the sender
416 @param context - sender context, to match reply w/ request
417 @param locator_set_index - index of locator_set
418 @param ls_name - locator set name
419 @param is_index_set - flag indicating whether ls_name or ls_index is set
421 define lisp_locator_dump
430 /** \brief LISP locator_set status
431 @param local - if is set, then locator is local
432 @param locator_set_name - name of the locator_set
433 @param sw_if_index - sw_if_index of the locator
434 @param priority - locator priority
435 @param weight - locator weight
437 define lisp_locator_details
448 /** \brief LISP locator_set status
449 @param context - sender context, to match reply w/ request
450 @param ls_index - locator set index
451 @param ls_name - name of the locator set
453 define lisp_locator_set_details
460 /** \brief Request for locator_set summary status
461 @param client_index - opaque cookie to identify the sender
462 @param context - sender context, to match reply w/ request
463 @param filter - filter type
466 1: local locator sets
467 2: remote locator sets
469 define lisp_locator_set_dump
476 /** \brief Dump lisp eid-table
477 @param client_index - opaque cookie to identify the sender
478 @param context - sender context, to match reply w/ request
479 @param locator_set_index - index of locator_set, if ~0 then the mapping
481 @param action - negative map request action
482 @param is_local - local if non-zero, else remote
487 @param is_src_dst - EID is type of source/destination
488 @param eid - EID can be ip4, ip6 or mac
489 @param eid_prefix_len - prefix length
490 @param seid - source EID can be ip4, ip6 or mac
491 @param seid_prefix_len - source prefix length
492 @param vni - virtual network instance
493 @param ttl - time to live
494 @param authoritative - authoritative
499 @param key - secret key
502 define lisp_eid_table_details
505 u32 locator_set_index;
521 /** \brief Request for eid table summary status
522 @param client_index - opaque cookie to identify the sender
523 @param context - sender context, to match reply w/ request
524 @param eid_set - if non-zero request info about specific mapping
525 @param vni - virtual network instance; valid only if eid_set != 0
526 @param prefix_length - prefix length if EID is IP address;
527 valid only if eid_set != 0
528 @param eid_type - EID type; valid only if eid_set != 0
532 2: EID is ethernet address
533 @param eid - endpoint identifier
534 @param filter - filter type;
540 define lisp_eid_table_dump
552 /** \brief LISP adjacency
557 @param reid - remote EID
558 @param leid - local EID
559 @param reid_prefix_len - remote EID IP prefix length
560 @param leid_prefix_len - local EID IP prefix length
562 typeonly manual_print manual_endian define lisp_adjacency
571 /** \brief LISP adjacency reply
572 @param count - number of adjacencies
573 @param adjacencies - array of adjacencies
575 manual_endian manual_print define lisp_adjacencies_get_reply
580 vl_api_lisp_adjacency_t adjacencies[count];
583 /** \brief Request for LISP adjacencies
584 @param client_index - opaque cookie to identify the sender
585 @param context - sender context, to match reply w/ request
586 @param vni - filter adjacencies by VNI
588 define lisp_adjacencies_get
595 /** \brief Shows relationship between vni and vrf/bd
596 @param dp_table - VRF index or bridge domain index
597 @param vni - vitual network instance
599 define lisp_eid_table_map_details
606 /** \brief Request for lisp_eid_table_map_details
607 @param client_index - opaque cookie to identify the sender
608 @param context - sender context, to match reply w/ request
609 @param is_l2 - if set dump vni/bd mappings else vni/vrf
611 define lisp_eid_table_map_dump
618 /** \brief Dumps all VNIs used in mappings
619 @param client_index - opaque cookie to identify the sender
620 @param context - sender context, to match reply w/ request
622 define lisp_eid_table_vni_dump
628 /** \brief reply to lisp_eid_table_vni_dump
629 @param client_index - opaque cookie to identify the sender
630 @param context - sender context, to match reply w/ request
631 @param vni - virtual network instance
633 define lisp_eid_table_vni_details
640 /** \brief LISP map resolver status
641 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
642 @param ip_address - array of address bytes
644 define lisp_map_resolver_details
651 /** \brief Request for map resolver summary status
652 @param client_index - opaque cookie to identify the sender
653 @param context - sender context, to match reply w/ request
655 define lisp_map_resolver_dump
661 /** \brief LISP map server details
662 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
663 @param ip_address - array of address bytes
665 define lisp_map_server_details
672 /** \brief Request for map server summary status
673 @param client_index - opaque cookie to identify the sender
674 @param context - sender context, to match reply w/ request
676 define lisp_map_server_dump
682 /** \brief Request for lisp-gpe protocol status
683 @param client_index - opaque cookie to identify the sender
684 @param context - sender context, to match reply w/ request
686 define show_lisp_status
692 /** \brief Status of lisp, enable or disable
693 @param context - sender context, to match reply w/ request
694 @param feature_status - lisp enable if non-zero, else disable
695 @param gpe_status - lisp enable if non-zero, else disable
697 define show_lisp_status_reply
705 /** \brief Get LISP map request itr rlocs status
706 @param context - sender context, to match reply w/ request
707 @param locator_set_name - name of the locator_set
709 define lisp_get_map_request_itr_rlocs
715 /** \brief Request for map request itr rlocs summary status
717 define lisp_get_map_request_itr_rlocs_reply
721 u8 locator_set_name[64];
724 /** \brief Request for lisp pitr status
725 @param client_index - opaque cookie to identify the sender
726 @param context - sender context, to match reply w/ request
728 define show_lisp_pitr
734 /** \brief Status of lisp pitr, enable or disable
735 @param context - sender context, to match reply w/ request
736 @param status - lisp pitr enable if non-zero, else disable
737 @param locator_set_name - name of the locator_set
739 define show_lisp_pitr_reply
744 u8 locator_set_name[64];
749 * eval: (c-set-style "gnu")