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 = "1.0.0";
18 typeonly manual_print manual_endian define one_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 - locator records
33 manual_endian manual_print define one_add_del_locator_set
38 u8 locator_set_name[64];
40 vl_api_one_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 one_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 locator
62 @param weight - weight of the locator
64 autoreply define one_add_del_locator
69 u8 locator_set_name[64];
75 /** \brief add or delete ONE 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 one_add_del_local_eid
101 u8 locator_set_name[64];
107 /** \brief Set TTL for map register messages
108 @param client_index - opaque cookie to identify the sender
109 @param context - sender context, to match reply w/ request
110 @param ttl - time to live
112 autoreply define one_map_register_set_ttl
119 /** \brief Get TTL for map register messages
120 @param client_index - opaque cookie to identify the sender
121 @param context - sender context, to match reply w/ request
123 define show_one_map_register_ttl
129 /** \brief Contains current TTL for map register messages
130 @param client_index - opaque cookie to identify the sender
131 @param retval - return code
132 @param ttl - time to live
134 define show_one_map_register_ttl_reply
141 /** \brief Add/delete map server
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; delete otherwise
145 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
146 @param ip_address - map server IP address
148 autoreply define one_add_del_map_server
157 /** \brief add or delete map-resolver
158 @param client_index - opaque cookie to identify the sender
159 @param context - sender context, to match reply w/ request
160 @param is_add - add address if non-zero, else delete
161 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
162 @param ip_address - array of address bytes
164 autoreply define one_add_del_map_resolver
173 /** \brief enable or disable ONE feature
174 @param client_index - opaque cookie to identify the sender
175 @param context - sender context, to match reply w/ request
176 @param is_en - enable protocol if non-zero, else disable
178 autoreply define one_enable_disable
185 /** \brief configure or delete ONE NSH mapping
186 @param client_index - opaque cookie to identify the sender
187 @param context - sender context, to match reply w/ request
188 @param ls_name - locator set name
189 @param is_add - add locator set if non-zero; delete otherwise
191 autoreply define one_nsh_set_locator_set
199 /** \brief configure or disable ONE PITR node
200 @param client_index - opaque cookie to identify the sender
201 @param context - sender context, to match reply w/ request
202 @param ls_name - locator set name
203 @param is_add - add locator set if non-zero, else disable pitr
205 autoreply define one_pitr_set_locator_set
213 /** \brief configure or disable use of PETR
214 @param client_index - opaque cookie to identify the sender
215 @param context - sender context, to match reply w/ request
216 @param is_ip4 - Address is IPv4 if set and IPv6 otherwise
217 @param address - PETR IP address
218 @param is_add - add locator set if non-zero, else disable PETR
220 autoreply define one_use_petr
229 /** \brief Request for ONE PETR status
230 @param client_index - opaque cookie to identify the sender
231 @param context - sender context, to match reply w/ request
233 define show_one_use_petr
239 /** \brief ONE PETR status, enable or disable
240 @param context - sender context, to match reply w/ request
241 @param status - ONE PETR enable if non-zero, else disable
242 @param is_ip4 - Address is IPv4 if non-zero, else IPv6
243 @param address - PETR IP address
245 define show_one_use_petr_reply
254 /** \brief Get state of ONE RLOC probing
255 @param client_index - opaque cookie to identify the sender
256 @param context - sender context, to match reply w/ request
258 define show_one_rloc_probe_state
264 /** \brief Reply for show_one_rloc_probe_state
265 @param context - returned sender context, to match reply w/ request
266 @param retval - return code
267 @param is_enabled - state of RLOC probing
269 define show_one_rloc_probe_state_reply
276 /** \brief enable/disable ONE RLOC probing
277 @param client_index - opaque cookie to identify the sender
278 @param context - sender context, to match reply w/ request
279 @param is_enable - enable if non-zero; disable otherwise
281 autoreply define one_rloc_probe_enable_disable
288 /** \brief enable/disable ONE map-register
289 @param client_index - opaque cookie to identify the sender
290 @param context - sender context, to match reply w/ request
291 @param is_enable - enable if non-zero; disable otherwise
293 autoreply define one_map_register_enable_disable
300 /** \brief Get state of ONE map-register
301 @param client_index - opaque cookie to identify the sender
302 @param context - sender context, to match reply w/ request
304 define show_one_map_register_state
310 /** \brief Reply for show_one_map_register_state
311 @param context - returned sender context, to match reply w/ request
312 @param retval - return code
314 define show_one_map_register_state_reply
321 /** \brief set ONE map-request mode. Based on configuration VPP will send
322 src/dest or just normal destination map requests.
323 @param client_index - opaque cookie to identify the sender
324 @param context - sender context, to match reply w/ request
325 @param mode - new map-request mode. Supported values are:
327 1 - source/destination
329 autoreply define one_map_request_mode
336 /** \brief Request for ONE map-request mode
337 @param client_index - opaque cookie to identify the sender
338 @param context - sender context, to match reply w/ request
340 define show_one_map_request_mode
346 /** \brief Reply for show_one_map_request_mode
347 @param context - returned sender context, to match reply w/ request
348 @param retval - return code
349 @param mode - map-request mode
351 define show_one_map_request_mode_reply
358 typeonly manual_endian manual_print define one_remote_locator
366 /** \brief add or delete remote static mapping
367 @param client_index - opaque cookie to identify the sender
368 @param context - sender context, to match reply w/ request
369 @param is_add - add address if non-zero, else delete
370 @param is_src_dst - flag indicating src/dst based routing policy
371 @param del_all - if set, delete all remote mappings
372 @param vni - virtual network instance
373 @param action - negative map-reply action
378 3 : NSH : both information (service path ID and service index) are
379 encoded in 'eid' field in a following way:
384 @param deid - dst EID
385 @param seid - src EID, valid only if is_src_dst is enabled
386 @param rloc_num - number of remote locators
387 @param rlocs - remote locator records
389 autoreply manual_print manual_endian define one_add_del_remote_mapping
404 vl_api_one_remote_locator_t rlocs[rloc_num];
407 /** \brief Add/delete L2 ARP entries
408 @param client_index - opaque cookie to identify the sender
409 @param context - sender context, to match reply w/ request
410 @param is_add - add if non-zero; delete otherwise
411 @param bd - bridge domain
412 @param mac - MAC address
413 @param ip4 - IPv4 address
415 autoreply define one_add_del_l2_arp_entry
425 /** \brief Request for L2 ARP entries from specified bridge domain
426 @param client_index - opaque cookie to identify the sender
427 @param context - sender context, to match reply w/ request
428 @param bd - bridge domain
430 define one_l2_arp_entries_get
437 typeonly manual_print manual_endian define one_l2_arp_entry
443 /** \brief Reply with L2 ARP entries from specified bridge domain
444 @param context - sender context, to match reply w/ request
445 @param retval - error code
446 @param count - number of elements in the list
447 @param vl_api_one_arp_entry_t - list of entries
449 manual_print manual_endian define one_l2_arp_entries_get_reply
454 vl_api_one_l2_arp_entry_t entries[count];
457 autoreply define one_add_del_ndp_entry
467 define one_ndp_entries_get
474 typeonly manual_print manual_endian define one_ndp_entry
480 manual_print manual_endian define one_ndp_entries_get_reply
485 vl_api_one_ndp_entry_t entries[count];
488 /** \brief Set ONE transport protocol
489 @param client_index - opaque cookie to identify the sender
490 @param context - sender context, to match reply w/ request
491 @param protocol - supported values:
492 1: UDP based LISP (default)
495 autoreply define one_set_transport_protocol
502 define one_get_transport_protocol
508 define one_get_transport_protocol_reply
515 /** \brief Request for list of bridge domains used by neighbor discovery
516 @param client_index - opaque cookie to identify the sender
517 @param context - sender context, to match reply w/ request
519 define one_ndp_bd_get
525 /** \brief Reply with list of bridge domains used by neighbor discovery
526 @param context - sender context, to match reply w/ request
527 @param count - number of elements in the list
528 @param bridge_domains - list of BDs
530 manual_print manual_endian define one_ndp_bd_get_reply
535 u32 bridge_domains[count];
538 /** \brief Request for list of bridge domains used by L2 ARP table
539 @param client_index - opaque cookie to identify the sender
540 @param context - sender context, to match reply w/ request
542 define one_l2_arp_bd_get
548 /** \brief Reply with list of bridge domains used by L2 ARP table
549 @param context - sender context, to match reply w/ request
550 @param count - number of elements in the list
551 @param bridge_domains - list of BDs
553 manual_print manual_endian define one_l2_arp_bd_get_reply
558 u32 bridge_domains[count];
561 /** \brief add or delete ONE adjacency adjacency
562 @param client_index - opaque cookie to identify the sender
563 @param context - sender context, to match reply w/ request
564 @param is_add - add address if non-zero, else delete
565 @param vni - virtual network instance
570 @param reid - remote EID
571 @param leid - local EID
573 autoreply define one_add_del_adjacency
586 /** \brief add or delete map request itr rlocs
587 @param client_index - opaque cookie to identify the sender
588 @param context - sender context, to match reply w/ request
589 @param is_add - add address if non-zero, else delete
590 @param locator_set_name - locator set name
592 autoreply define one_add_del_map_request_itr_rlocs
597 u8 locator_set_name[64];
600 /** \brief map/unmap vni/bd_index to vrf
601 @param client_index - opaque cookie to identify the sender
602 @param context - sender context, to match reply w/ request
603 @param is_add - add or delete mapping
604 @param dp_table - virtual network id/bridge domain index
607 autoreply define one_eid_table_add_del_map
617 /** \brief Request for map one locator status
618 @param client_index - opaque cookie to identify the sender
619 @param context - sender context, to match reply w/ request
620 @param locator_set_index - index of locator_set
621 @param ls_name - locator set name
622 @param is_index_set - flag indicating whether ls_name or ls_index is set
624 define one_locator_dump
633 /** \brief ONE locator_set status
634 @param local - if is set, then locator is local
635 @param locator_set_name - name of the locator_set
636 @param sw_if_index - sw_if_index of the locator
637 @param priority - locator priority
638 @param weight - locator weight
640 define one_locator_details
651 /** \brief ONE locator_set status
652 @param context - sender context, to match reply w/ request
653 @param ls_index - locator set index
654 @param ls_name - name of the locator set
656 define one_locator_set_details
663 /** \brief Request for locator_set summary status
664 @param client_index - opaque cookie to identify the sender
665 @param context - sender context, to match reply w/ request
666 @param filter - filter type
669 1: local locator sets
670 2: remote locator sets
672 define one_locator_set_dump
679 /** \brief Dump ONE eid-table
680 @param client_index - opaque cookie to identify the sender
681 @param context - sender context, to match reply w/ request
682 @param locator_set_index - index of locator_set, if ~0 then the mapping
684 @param action - negative map request action
685 @param is_local - local if non-zero, else remote
690 @param is_src_dst - EID is type of source/destination
691 @param eid - EID can be ip4, ip6 or mac
692 @param eid_prefix_len - prefix length
693 @param seid - source EID can be ip4, ip6 or mac
694 @param seid_prefix_len - source prefix length
695 @param vni - virtual network instance
696 @param ttl - time to live
697 @param authoritative - authoritative
702 @param key - secret key
705 define one_eid_table_details
708 u32 locator_set_index;
724 /** \brief Request for eid table summary status
725 @param client_index - opaque cookie to identify the sender
726 @param context - sender context, to match reply w/ request
727 @param eid_set - if non-zero request info about specific mapping
728 @param vni - virtual network instance; valid only if eid_set != 0
729 @param prefix_length - prefix length if EID is IP address;
730 valid only if eid_set != 0
731 @param eid_type - EID type; valid only if eid_set != 0
735 2: EID is ethernet address
736 3 : NSH : both information (service path ID and service index) are
737 encoded in 'eid' field in a following way:
742 @param eid - endpoint identifier
743 @param filter - filter type;
749 define one_eid_table_dump
761 /** \brief ONE adjacency
766 @param reid - remote EID
767 @param leid - local EID
768 @param reid_prefix_len - remote EID IP prefix length
769 @param leid_prefix_len - local EID IP prefix length
771 typeonly manual_print manual_endian define one_adjacency
780 /** \brief ONE adjacency reply
781 @param count - number of adjacencies
782 @param adjacencies - array of adjacencies
784 manual_endian manual_print define one_adjacencies_get_reply
789 vl_api_one_adjacency_t adjacencies[count];
792 /** \brief Request for ONE adjacencies
793 @param client_index - opaque cookie to identify the sender
794 @param context - sender context, to match reply w/ request
795 @param vni - filter adjacencies by VNI
797 define one_adjacencies_get
804 /** \brief Shows relationship between vni and vrf/bd
805 @param dp_table - VRF index or bridge domain index
806 @param vni - virtual network instance
808 define one_eid_table_map_details
815 /** \brief Request for one_eid_table_map_details
816 @param client_index - opaque cookie to identify the sender
817 @param context - sender context, to match reply w/ request
818 @param is_l2 - if set dump vni/bd mappings else vni/vrf
820 define one_eid_table_map_dump
827 /** \brief Dumps all VNIs used in mappings
828 @param client_index - opaque cookie to identify the sender
829 @param context - sender context, to match reply w/ request
831 define one_eid_table_vni_dump
837 /** \brief reply to one_eid_table_vni_dump
838 @param context - sender context, to match reply w/ request
839 @param vni - virtual network instance
841 define one_eid_table_vni_details
847 /** \brief ONE map resolver status
848 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
849 @param ip_address - array of address bytes
851 define one_map_resolver_details
858 /** \brief Request for map resolver summary status
859 @param client_index - opaque cookie to identify the sender
860 @param context - sender context, to match reply w/ request
862 define one_map_resolver_dump
868 /** \brief ONE map server details
869 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
870 @param ip_address - array of address bytes
872 define one_map_server_details
879 /** \brief Request for map server summary status
880 @param client_index - opaque cookie to identify the sender
881 @param context - sender context, to match reply w/ request
883 define one_map_server_dump
889 /** \brief Request for ONE status
890 @param client_index - opaque cookie to identify the sender
891 @param context - sender context, to match reply w/ request
893 define show_one_status
899 /** \brief ONE status
900 @param context - sender context, to match reply w/ request
901 @param feature_status - enabled if non-zero, else disabled
902 @param gpe_status - enabled if non-zero, else disabled
904 define show_one_status_reply
912 /** \brief Get ONE map request itr rlocs status
913 @param context - sender context, to match reply w/ request
914 @param locator_set_name - name of the locator_set
916 define one_get_map_request_itr_rlocs
922 /** \brief Request for map request itr rlocs summary status
924 define one_get_map_request_itr_rlocs_reply
928 u8 locator_set_name[64];
931 /** \brief Request for ONE NSH mapping
932 @param client_index - opaque cookie to identify the sender
933 @param context - sender context, to match reply w/ request
935 define show_one_nsh_mapping
941 /** \brief Reply for ONE NSH mapping
942 @param context - sender context, to match reply w/ request
943 @param is_set - is ONE NSH mapping set
944 @param locator_set_name - name of the locator_set if NSH mapping is set
946 define show_one_nsh_mapping_reply
951 u8 locator_set_name[64];
954 /** \brief Request for ONE PITR status
955 @param client_index - opaque cookie to identify the sender
956 @param context - sender context, to match reply w/ request
964 /** \brief Status of ONE PITR, enable or disable
965 @param context - sender context, to match reply w/ request
966 @param status - ONE PITR enable if non-zero, else disable
967 @param locator_set_name - name of the locator_set
969 define show_one_pitr_reply
974 u8 locator_set_name[64];
977 define one_stats_dump
983 define one_stats_details
1000 autoreply define one_stats_flush
1006 autoreply define one_stats_enable_disable
1013 define show_one_stats_enable_disable
1019 define show_one_stats_enable_disable_reply
1026 autoreply define one_map_register_fallback_threshold
1033 define show_one_map_register_fallback_threshold
1039 define show_one_map_register_fallback_threshold_reply
1046 autoreply define one_enable_disable_xtr_mode
1053 define one_show_xtr_mode
1059 define one_show_xtr_mode_reply
1066 autoreply define one_enable_disable_petr_mode
1073 define one_show_petr_mode
1079 define one_show_petr_mode_reply
1086 autoreply define one_enable_disable_pitr_mode
1093 define one_show_pitr_mode
1099 define one_show_pitr_mode_reply
1108 * eval: (c-set-style "gnu")