2 * Copyright (c) 2015-2017 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.0";
18 import "vnet/interface_types.api";
19 import "vnet/lisp-cp/lisp_types.api";
21 /** \brief add or delete locator_set
22 @param client_index - opaque cookie to identify the sender
23 @param context - sender context, to match reply w/ request
24 @param is_add - add address if non-zero, else delete
25 @param locator_set_name - locator name
26 @param locator_num - number of locators
27 @param locators - locator records
29 manual_endian manual_print define one_add_del_locator_set
33 bool is_add [default=true];
34 string locator_set_name[64];
36 vl_api_local_locator_t locators[locator_num];
39 /** \brief Reply for locator_set add/del
40 @param context - returned sender context, to match reply w/ request
41 @param retval - return code
42 @param ls_index - locator set index
44 define one_add_del_locator_set_reply
51 /** \brief add or delete locator for locator set
52 @param client_index - opaque cookie to identify the sender
53 @param context - sender context, to match reply w/ request
54 @param is_add - add address if non-zero, else delete
55 @param locator_set_name - name of locator_set to add/del locator
56 @param sw_if_index - index of the interface
57 @param priority - priority of the locator
58 @param weight - weight of the locator
60 autoreply define one_add_del_locator
64 bool is_add [default=true];
65 string locator_set_name[64];
66 vl_api_interface_index_t sw_if_index;
72 /** \brief add or delete ONE eid-table
73 @param client_index - opaque cookie to identify the sender
74 @param context - sender context, to match reply w/ request
75 @param is_add - add address if non-zero, else delete
76 @param eid - endpoint identifier
77 @param locator_set_name - name of locator_set to add/del eid-table
78 @param vni - virtual network instance
79 @param key - secret key
81 autoreply define one_add_del_local_eid
85 bool is_add [default=true];
87 string locator_set_name[64];
89 vl_api_hmac_key_t key;
92 /** \brief Set TTL for map register messages
93 @param client_index - opaque cookie to identify the sender
94 @param context - sender context, to match reply w/ request
95 @param ttl - time to live
97 autoreply define one_map_register_set_ttl
104 /** \brief Get TTL for map register messages
105 @param client_index - opaque cookie to identify the sender
106 @param context - sender context, to match reply w/ request
108 define show_one_map_register_ttl
114 /** \brief Contains current TTL for map register messages
115 @param client_index - opaque cookie to identify the sender
116 @param retval - return code
117 @param ttl - time to live
119 define show_one_map_register_ttl_reply
126 /** \brief Add/delete map server
127 @param client_index - opaque cookie to identify the sender
128 @param context - sender context, to match reply w/ request
129 @param is_add - add address if non-zero; delete otherwise
130 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
131 @param ip_address - map server IP address
133 autoreply define one_add_del_map_server
137 bool is_add [default=true];
138 vl_api_address_t ip_address;
141 /** \brief add or delete map-resolver
142 @param client_index - opaque cookie to identify the sender
143 @param context - sender context, to match reply w/ request
144 @param is_add - add address if non-zero, else delete
145 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
146 @param ip_address - array of address bytes
148 autoreply define one_add_del_map_resolver
152 bool is_add [default=true];
153 vl_api_address_t ip_address;
156 /** \brief enable or disable ONE feature
157 @param client_index - opaque cookie to identify the sender
158 @param context - sender context, to match reply w/ request
159 @param is_enable - enable protocol if non-zero, else disable
161 autoreply define one_enable_disable
165 bool is_enable [default=true];
168 /** \brief configure or delete ONE NSH mapping
169 @param client_index - opaque cookie to identify the sender
170 @param context - sender context, to match reply w/ request
171 @param ls_name - locator set name
172 @param is_add - add locator set if non-zero; delete otherwise
174 autoreply define one_nsh_set_locator_set
178 bool is_add [default=true];
182 /** \brief configure or disable ONE PITR node
183 @param client_index - opaque cookie to identify the sender
184 @param context - sender context, to match reply w/ request
185 @param ls_name - locator set name
186 @param is_add - add locator set if non-zero, else disable pitr
188 autoreply define one_pitr_set_locator_set
192 bool is_add [default=true];
196 /** \brief configure or disable use of PETR
197 @param client_index - opaque cookie to identify the sender
198 @param context - sender context, to match reply w/ request
199 @param is_ip4 - Address is IPv4 if set and IPv6 otherwise
200 @param address - PETR IP address
201 @param is_add - add locator set if non-zero, else disable PETR
203 autoreply define one_use_petr
207 vl_api_address_t ip_address;
208 bool is_add [default=true];
211 /** \brief Request for ONE PETR status
212 @param client_index - opaque cookie to identify the sender
213 @param context - sender context, to match reply w/ request
215 define show_one_use_petr
221 /** \brief ONE PETR status, enable or disable
222 @param context - sender context, to match reply w/ request
223 @param enable - ONE PETR enable if non-zero, else disable
224 @param is_ip4 - Address is IPv4 if non-zero, else IPv6
225 @param address - PETR IP address
227 define show_one_use_petr_reply
232 vl_api_address_t ip_address;
235 /** \brief Get state of ONE RLOC probing
236 @param client_index - opaque cookie to identify the sender
237 @param context - sender context, to match reply w/ request
239 define show_one_rloc_probe_state
245 /** \brief Reply for show_one_rloc_probe_state
246 @param context - returned sender context, to match reply w/ request
247 @param retval - return code
248 @param is_enable - state of RLOC probing
250 define show_one_rloc_probe_state_reply
257 /** \brief enable/disable ONE RLOC probing
258 @param client_index - opaque cookie to identify the sender
259 @param context - sender context, to match reply w/ request
260 @param is_enable - enable if non-zero; disable otherwise
262 autoreply define one_rloc_probe_enable_disable
266 bool is_enable [default=true];
269 /** \brief enable/disable ONE map-register
270 @param client_index - opaque cookie to identify the sender
271 @param context - sender context, to match reply w/ request
272 @param is_enable - enable if non-zero; disable otherwise
274 autoreply define one_map_register_enable_disable
278 bool is_enable [default=true];
281 /** \brief Get state of ONE map-register
282 @param client_index - opaque cookie to identify the sender
283 @param context - sender context, to match reply w/ request
285 define show_one_map_register_state
291 /** \brief Reply for show_one_map_register_state
292 @param context - returned sender context, to match reply w/ request
293 @param retval - return code
295 define show_one_map_register_state_reply
304 ONE_MAP_MODE_API_DST_ONLY = 0,
305 ONE_MAP_MODE_API_SRC_DST = 1,
308 /** \brief set ONE map-request mode. Based on configuration VPP will send
309 src/dest or just normal destination map requests.
310 @param client_index - opaque cookie to identify the sender
311 @param context - sender context, to match reply w/ request
312 @param mode - new map-request mode. Supported values are:
314 1 - source/destination
316 autoreply define one_map_request_mode
320 vl_api_one_map_mode_t mode;
323 /** \brief Request for ONE map-request mode
324 @param client_index - opaque cookie to identify the sender
325 @param context - sender context, to match reply w/ request
327 define show_one_map_request_mode
333 /** \brief Reply for show_one_map_request_mode
334 @param context - returned sender context, to match reply w/ request
335 @param retval - return code
336 @param mode - map-request mode
338 define show_one_map_request_mode_reply
342 vl_api_one_map_mode_t mode;
345 /** \brief add or delete remote static mapping
346 @param client_index - opaque cookie to identify the sender
347 @param context - sender context, to match reply w/ request
348 @param is_add - add address if non-zero, else delete
349 @param is_src_dst - flag indicating src/dst based routing policy
350 @param del_all - if set, delete all remote mappings
351 @param vni - virtual network instance
352 @param action - negative map-reply action
353 @param deid - dst EID
354 @param seid - src EID, valid only if is_src_dst is enabled
355 @param rloc_num - number of remote locators
356 @param rlocs - remote locator records
358 autoreply manual_print manual_endian define one_add_del_remote_mapping
362 bool is_add [default=true];
370 vl_api_remote_locator_t rlocs[rloc_num];
373 typedef one_l2_arp_entry
375 vl_api_mac_address_t mac;
376 vl_api_ip4_address_t ip4;
379 /** \brief Add/delete L2 ARP entries
380 @param client_index - opaque cookie to identify the sender
381 @param context - sender context, to match reply w/ request
382 @param is_add - add if non-zero; delete otherwise
383 @param bd - bridge domain
384 @param entry - ARP entry
386 autoreply define one_add_del_l2_arp_entry
390 bool is_add [default=true];
392 vl_api_one_l2_arp_entry_t entry;
395 /** \brief Request for L2 ARP entries from specified bridge domain
396 @param client_index - opaque cookie to identify the sender
397 @param context - sender context, to match reply w/ request
398 @param bd - bridge domain
400 define one_l2_arp_entries_get
407 /** \brief Reply with L2 ARP entries from specified bridge domain
408 @param context - sender context, to match reply w/ request
409 @param retval - error code
410 @param count - number of elements in the list
411 @param vl_api_one_arp_entry_t - list of entries
413 manual_print manual_endian define one_l2_arp_entries_get_reply
418 vl_api_one_l2_arp_entry_t entries[count];
421 typedef one_ndp_entry
423 vl_api_mac_address_t mac;
424 vl_api_ip6_address_t ip6;
428 autoreply define one_add_del_ndp_entry
432 bool is_add [default=true];
434 vl_api_one_ndp_entry_t entry;
437 define one_ndp_entries_get
444 manual_print manual_endian define one_ndp_entries_get_reply
449 vl_api_one_ndp_entry_t entries[count];
452 /** \brief Set ONE transport protocol
453 @param client_index - opaque cookie to identify the sender
454 @param context - sender context, to match reply w/ request
455 @param protocol - supported values:
456 1: UDP based LISP (default)
459 autoreply define one_set_transport_protocol
466 define one_get_transport_protocol
472 define one_get_transport_protocol_reply
479 /** \brief Request for list of bridge domains used by neighbor discovery
480 @param client_index - opaque cookie to identify the sender
481 @param context - sender context, to match reply w/ request
483 define one_ndp_bd_get
489 /** \brief Reply with list of bridge domains used by neighbor discovery
490 @param context - sender context, to match reply w/ request
491 @param count - number of elements in the list
492 @param bridge_domains - list of BDs
494 manual_print manual_endian define one_ndp_bd_get_reply
499 u32 bridge_domains[count];
502 /** \brief Request for list of bridge domains used by L2 ARP table
503 @param client_index - opaque cookie to identify the sender
504 @param context - sender context, to match reply w/ request
506 define one_l2_arp_bd_get
512 /** \brief Reply with list of bridge domains used by L2 ARP table
513 @param context - sender context, to match reply w/ request
514 @param count - number of elements in the list
515 @param bridge_domains - list of BDs
517 manual_print manual_endian define one_l2_arp_bd_get_reply
522 u32 bridge_domains[count];
525 /** \brief add or delete ONE adjacency adjacency
526 @param client_index - opaque cookie to identify the sender
527 @param context - sender context, to match reply w/ request
528 @param is_add - add address if non-zero, else delete
529 @param vni - virtual network instance
530 @param reid - remote EID
531 @param leid - local EID
533 autoreply define one_add_del_adjacency
543 /** \brief add or delete map request itr rlocs
544 @param client_index - opaque cookie to identify the sender
545 @param context - sender context, to match reply w/ request
546 @param is_add - add address if non-zero, else delete
547 @param locator_set_name - locator set name
549 autoreply define one_add_del_map_request_itr_rlocs
553 bool is_add [default=true];
554 string locator_set_name[64];
557 /** \brief map/unmap vni/bd_index to vrf
558 @param client_index - opaque cookie to identify the sender
559 @param context - sender context, to match reply w/ request
560 @param is_add - add or delete mapping
561 @param dp_table - virtual network id/bridge domain index
565 autoreply define one_eid_table_add_del_map
569 bool is_add [default=true];
575 /** \brief Request for map one locator status
576 @param client_index - opaque cookie to identify the sender
577 @param context - sender context, to match reply w/ request
578 @param locator_set_index - index of locator_set
579 @param ls_name - locator set name
580 @param is_index_set - flag indicating whether ls_name or ls_index is set
582 define one_locator_dump
591 /** \brief ONE locator_set status
592 @param local - if is set, then locator is local
593 @param locator_set_name - name of the locator_set
594 @param sw_if_index - sw_if_index of the locator
595 @param priority - locator priority
596 @param weight - locator weight
598 define one_locator_details
602 vl_api_interface_index_t sw_if_index;
603 vl_api_address_t ip_address;
608 /** \brief ONE locator_set status
609 @param context - sender context, to match reply w/ request
610 @param ls_index - locator set index
611 @param ls_name - name of the locator set
613 define one_locator_set_details
622 ONE_FILTER_API_ALL = 0,
623 ONE_FILTER_API_LOCAL = 1,
624 ONE_FILTER_API_REMOTE = 2,
627 /** \brief Request for locator_set summary status
628 @param client_index - opaque cookie to identify the sender
629 @param context - sender context, to match reply w/ request
630 @param filter - filter type
633 1: local locator sets
634 2: remote locator sets
636 define one_locator_set_dump
640 vl_api_one_filter_t filter;
643 /** \brief Dump ONE eid-table
644 @param context - sender context, to match reply w/ request
645 @param locator_set_index - index of locator_set, if ~0 then the mapping
647 @param action - negative map request action
648 @param is_local - local if non-zero, else remote
649 @param is_src_dst - EID is type of source/destination
650 @param deid - dst EID
651 @param seid - src EID
652 @param vni - virtual network instance
653 @param ttl - time to live
654 @param authoritative - authoritative
655 @param key - secret key
658 // FIXME: action, authoritative
660 define one_eid_table_details
663 u32 locator_set_index;
672 vl_api_hmac_key_t key;
675 /** \brief Request for eid table summary status
676 @param client_index - opaque cookie to identify the sender
677 @param context - sender context, to match reply w/ request
678 @param eid_set - if non-zero request info about specific mapping
679 @param vni - virtual network instance; valid only if eid_set != 0
680 @param eid - endpoint identifier
681 @param filter - filter type;
687 define one_eid_table_dump
694 vl_api_one_filter_t filter;
697 /** \brief ONE adjacency
698 @param reid - remote EID
699 @param leid - local EID
701 typedef one_adjacency
707 /** \brief ONE adjacency reply
708 @param count - number of adjacencies
709 @param adjacencies - array of adjacencies
711 manual_endian manual_print define one_adjacencies_get_reply
716 vl_api_one_adjacency_t adjacencies[count];
719 /** \brief Request for ONE adjacencies
720 @param client_index - opaque cookie to identify the sender
721 @param context - sender context, to match reply w/ request
722 @param vni - filter adjacencies by VNI
724 define one_adjacencies_get
731 /** \brief Shows relationship between vni and vrf/bd
732 @param dp_table - VRF index or bridge domain index
733 @param vni - virtual network instance
735 define one_eid_table_map_details
742 /** \brief Request for one_eid_table_map_details
743 @param client_index - opaque cookie to identify the sender
744 @param context - sender context, to match reply w/ request
745 @param is_l2 - if set dump vni/bd mappings else vni/vrf
747 define one_eid_table_map_dump
754 /** \brief Dumps all VNIs used in mappings
755 @param client_index - opaque cookie to identify the sender
756 @param context - sender context, to match reply w/ request
758 define one_eid_table_vni_dump
764 /** \brief reply to one_eid_table_vni_dump
765 @param context - sender context, to match reply w/ request
766 @param vni - virtual network instance
768 define one_eid_table_vni_details
774 /** \brief ONE map resolver status
775 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
776 @param ip_address - array of address bytes
778 define one_map_resolver_details
781 vl_api_address_t ip_address;
784 /** \brief Request for map resolver summary status
785 @param client_index - opaque cookie to identify the sender
786 @param context - sender context, to match reply w/ request
788 define one_map_resolver_dump
794 /** \brief ONE map server details
795 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
796 @param ip_address - array of address bytes
798 define one_map_server_details
801 vl_api_address_t ip_address;
804 /** \brief Request for map server summary status
805 @param client_index - opaque cookie to identify the sender
806 @param context - sender context, to match reply w/ request
808 define one_map_server_dump
814 /** \brief Request for ONE status
815 @param client_index - opaque cookie to identify the sender
816 @param context - sender context, to match reply w/ request
818 define show_one_status
824 /** \brief ONE status
825 @param context - sender context, to match reply w/ request
826 @param feature_status - enabled if non-zero, else disabled
827 @param gpe_status - enabled if non-zero, else disabled
829 define show_one_status_reply
837 /** \brief Get ONE map request itr rlocs status
838 @param context - sender context, to match reply w/ request
839 @param locator_set_name - name of the locator_set
841 define one_get_map_request_itr_rlocs
847 /** \brief Request for map request itr rlocs summary status
849 define one_get_map_request_itr_rlocs_reply
853 string locator_set_name[64];
856 /** \brief Request for ONE NSH mapping
857 @param client_index - opaque cookie to identify the sender
858 @param context - sender context, to match reply w/ request
860 define show_one_nsh_mapping
866 /** \brief Reply for ONE NSH mapping
867 @param context - sender context, to match reply w/ request
868 @param is_set - is ONE NSH mapping set
869 @param locator_set_name - name of the locator_set if NSH mapping is set
871 define show_one_nsh_mapping_reply
876 string locator_set_name[64];
879 /** \brief Request for ONE PITR status
880 @param client_index - opaque cookie to identify the sender
881 @param context - sender context, to match reply w/ request
889 /** \brief Status of ONE PITR, enable or disable
890 @param context - sender context, to match reply w/ request
891 @param status - ONE PITR enable if non-zero, else disable
892 @param locator_set_name - name of the locator_set
894 define show_one_pitr_reply
899 string locator_set_name[64];
902 define one_stats_dump
908 define one_stats_details
914 vl_api_address_t rloc;
915 vl_api_address_t lloc;
921 autoreply define one_stats_flush
927 autoreply define one_stats_enable_disable
931 bool is_enable [default=true];
934 define show_one_stats_enable_disable
940 define show_one_stats_enable_disable_reply
947 autoreply define one_map_register_fallback_threshold
954 define show_one_map_register_fallback_threshold
960 define show_one_map_register_fallback_threshold_reply
967 autoreply define one_enable_disable_xtr_mode
971 bool is_enable [default=true];
974 define one_show_xtr_mode
980 define one_show_xtr_mode_reply
987 autoreply define one_enable_disable_petr_mode
991 bool is_enable [default=true];
994 define one_show_petr_mode
1000 define one_show_petr_mode_reply
1007 autoreply define one_enable_disable_pitr_mode
1011 bool is_enable [default=true];
1014 define one_show_pitr_mode
1020 define one_show_pitr_mode_reply
1029 * eval: (c-set-style "gnu")