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 typeonly manual_print manual_endian define one_local_locator
23 /** \brief add or delete locator_set
24 @param client_index - opaque cookie to identify the sender
25 @param context - sender context, to match reply w/ request
26 @param is_add - add address if non-zero, else delete
27 @param locator_set_name - locator name
28 @param locator_num - number of locators
29 @param locators - locator records
31 manual_endian manual_print define one_add_del_locator_set
36 u8 locator_set_name[64];
38 vl_api_one_local_locator_t locators[locator_num];
41 /** \brief Reply for locator_set add/del
42 @param context - returned sender context, to match reply w/ request
43 @param retval - return code
44 @param ls_index - locator set index
46 define one_add_del_locator_set_reply
53 /** \brief add or delete locator for locator set
54 @param client_index - opaque cookie to identify the sender
55 @param context - sender context, to match reply w/ request
56 @param is_add - add address if non-zero, else delete
57 @param locator_set_name - name of locator_set to add/del locator
58 @param sw_if_index - index of the interface
59 @param priority - priority of the locator
60 @param weight - weight of the locator
62 autoreply define one_add_del_locator
67 u8 locator_set_name[64];
73 /** \brief add or delete ONE eid-table
74 @param client_index - opaque cookie to identify the sender
75 @param context - sender context, to match reply w/ request
76 @param is_add - add address if non-zero, else delete
81 @param eid - EID can be ip4, ip6 or mac
82 @param prefix_len - prefix len
83 @param locator_set_name - name of locator_set to add/del eid-table
84 @param vni - virtual network instance
89 @param key - secret key
91 autoreply define one_add_del_local_eid
99 u8 locator_set_name[64];
105 /** \brief Set TTL for map register messages
106 @param client_index - opaque cookie to identify the sender
107 @param context - sender context, to match reply w/ request
108 @param ttl - time to live
110 autoreply define one_map_register_set_ttl
117 /** \brief Get TTL for map register messages
118 @param client_index - opaque cookie to identify the sender
119 @param context - sender context, to match reply w/ request
121 define show_one_map_register_ttl
127 /** \brief Contains current TTL for map register messages
128 @param client_index - opaque cookie to identify the sender
129 @param retval - return code
130 @param ttl - time to live
132 define show_one_map_register_ttl_reply
139 /** \brief Add/delete map server
140 @param client_index - opaque cookie to identify the sender
141 @param context - sender context, to match reply w/ request
142 @param is_add - add address if non-zero; delete otherwise
143 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
144 @param ip_address - map server IP address
146 autoreply define one_add_del_map_server
155 /** \brief add or delete map-resolver
156 @param client_index - opaque cookie to identify the sender
157 @param context - sender context, to match reply w/ request
158 @param is_add - add address if non-zero, else delete
159 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
160 @param ip_address - array of address bytes
162 autoreply define one_add_del_map_resolver
171 /** \brief enable or disable ONE feature
172 @param client_index - opaque cookie to identify the sender
173 @param context - sender context, to match reply w/ request
174 @param is_en - enable protocol if non-zero, else disable
176 autoreply define one_enable_disable
183 /** \brief configure or delete ONE NSH mapping
184 @param client_index - opaque cookie to identify the sender
185 @param context - sender context, to match reply w/ request
186 @param ls_name - locator set name
187 @param is_add - add locator set if non-zero; delete otherwise
189 autoreply define one_nsh_set_locator_set
197 /** \brief configure or disable ONE PITR node
198 @param client_index - opaque cookie to identify the sender
199 @param context - sender context, to match reply w/ request
200 @param ls_name - locator set name
201 @param is_add - add locator set if non-zero, else disable pitr
203 autoreply define one_pitr_set_locator_set
211 /** \brief configure or disable use of PETR
212 @param client_index - opaque cookie to identify the sender
213 @param context - sender context, to match reply w/ request
214 @param is_ip4 - Address is IPv4 if set and IPv6 otherwise
215 @param address - PETR IP address
216 @param is_add - add locator set if non-zero, else disable PETR
218 autoreply define one_use_petr
227 /** \brief Request for ONE PETR status
228 @param client_index - opaque cookie to identify the sender
229 @param context - sender context, to match reply w/ request
231 define show_one_use_petr
237 /** \brief ONE PETR status, enable or disable
238 @param context - sender context, to match reply w/ request
239 @param status - ONE PETR enable if non-zero, else disable
240 @param is_ip4 - Address is IPv4 if non-zero, else IPv6
241 @param address - PETR IP address
243 define show_one_use_petr_reply
252 /** \brief Get state of ONE RLOC probing
253 @param client_index - opaque cookie to identify the sender
254 @param context - sender context, to match reply w/ request
256 define show_one_rloc_probe_state
262 /** \brief Reply for show_one_rloc_probe_state
263 @param context - returned sender context, to match reply w/ request
264 @param retval - return code
265 @param is_enabled - state of RLOC probing
267 define show_one_rloc_probe_state_reply
274 /** \brief enable/disable ONE RLOC probing
275 @param client_index - opaque cookie to identify the sender
276 @param context - sender context, to match reply w/ request
277 @param is_enable - enable if non-zero; disable otherwise
279 autoreply define one_rloc_probe_enable_disable
286 /** \brief enable/disable ONE map-register
287 @param client_index - opaque cookie to identify the sender
288 @param context - sender context, to match reply w/ request
289 @param is_enable - enable if non-zero; disable otherwise
291 autoreply define one_map_register_enable_disable
298 /** \brief Get state of ONE map-register
299 @param client_index - opaque cookie to identify the sender
300 @param context - sender context, to match reply w/ request
302 define show_one_map_register_state
308 /** \brief Reply for show_one_map_register_state
309 @param context - returned sender context, to match reply w/ request
310 @param retval - return code
312 define show_one_map_register_state_reply
319 /** \brief set ONE map-request mode. Based on configuration VPP will send
320 src/dest or just normal destination map requests.
321 @param client_index - opaque cookie to identify the sender
322 @param context - sender context, to match reply w/ request
323 @param mode - new map-request mode. Supported values are:
325 1 - source/destaination
327 autoreply define one_map_request_mode
334 /** \brief Request for ONE map-request mode
335 @param client_index - opaque cookie to identify the sender
336 @param context - sender context, to match reply w/ request
338 define show_one_map_request_mode
344 /** \brief Reply for show_one_map_request_mode
345 @param context - returned sender context, to match reply w/ request
346 @param retval - return code
347 @param mode - map-request mode
349 define show_one_map_request_mode_reply
356 typeonly manual_endian manual_print define one_remote_locator
364 /** \brief add or delete remote static mapping
365 @param client_index - opaque cookie to identify the sender
366 @param context - sender context, to match reply w/ request
367 @param is_add - add address if non-zero, else delete
368 @param is_src_dst - flag indicating src/dst based routing policy
369 @param del_all - if set, delete all remote mappings
370 @param vni - virtual network instance
371 @param action - negative map-reply action
376 3 : NSH : both information (service path ID and service index) are
377 encoded in 'eid' field in a following way:
382 @param deid - dst EID
383 @param seid - src EID, valid only if is_src_dst is enabled
384 @param rloc_num - number of remote locators
385 @param rlocs - remote locator records
387 autoreply manual_print manual_endian define one_add_del_remote_mapping
402 vl_api_one_remote_locator_t rlocs[rloc_num];
405 /** \brief Add/delete L2 ARP entries
406 @param client_index - opaque cookie to identify the sender
407 @param context - sender context, to match reply w/ request
408 @param is_add - add if non-zero; delete otherwise
409 @param bd - bridge domain
410 @param mac - MAC address
411 @param ip4 - IPv4 address
413 autoreply define one_add_del_l2_arp_entry
423 /** \brief Request for L2 ARP entries from specified bridge domain
424 @param client_index - opaque cookie to identify the sender
425 @param context - sender context, to match reply w/ request
426 @param bd - bridge domain
428 define one_l2_arp_entries_get
435 typeonly manual_print manual_endian define one_l2_arp_entry
441 /** \brief Reply with L2 ARP entries from specified bridge domain
442 @param context - sender context, to match reply w/ request
443 @param retval - error code
444 @param count - number of elements in the list
445 @param vl_api_one_arp_entry_t - list of entries
447 manual_print manual_endian define one_l2_arp_entries_get_reply
452 vl_api_one_l2_arp_entry_t entries[count];
455 /** \brief Request for list of bridge domains used by L2 ARP table
456 @param client_index - opaque cookie to identify the sender
457 @param context - sender context, to match reply w/ request
459 define one_l2_arp_bd_get
465 /** \brief Reply with list of bridge domains used by L2 ARP table
466 @param context - sender context, to match reply w/ request
467 @param count - number of elements in the list
468 @param bridge_domains - list of BDs
470 manual_print manual_endian define one_l2_arp_bd_get_reply
475 u32 bridge_domains[count];
478 /** \brief add or delete ONE adjacency adjacency
479 @param client_index - opaque cookie to identify the sender
480 @param context - sender context, to match reply w/ request
481 @param is_add - add address if non-zero, else delete
482 @param vni - virtual network instance
487 @param reid - remote EID
488 @param leid - local EID
490 autoreply define one_add_del_adjacency
503 /** \brief add or delete map request itr rlocs
504 @param client_index - opaque cookie to identify the sender
505 @param context - sender context, to match reply w/ request
506 @param is_add - add address if non-zero, else delete
507 @param locator_set_name - locator set name
509 autoreply define one_add_del_map_request_itr_rlocs
514 u8 locator_set_name[64];
517 /** \brief map/unmap vni/bd_index to vrf
518 @param client_index - opaque cookie to identify the sender
519 @param context - sender context, to match reply w/ request
520 @param is_add - add or delete mapping
521 @param dp_table - virtual network id/bridge domain index
524 autoreply define one_eid_table_add_del_map
534 /** \brief Request for map one locator status
535 @param client_index - opaque cookie to identify the sender
536 @param context - sender context, to match reply w/ request
537 @param locator_set_index - index of locator_set
538 @param ls_name - locator set name
539 @param is_index_set - flag indicating whether ls_name or ls_index is set
541 define one_locator_dump
550 /** \brief ONE locator_set status
551 @param local - if is set, then locator is local
552 @param locator_set_name - name of the locator_set
553 @param sw_if_index - sw_if_index of the locator
554 @param priority - locator priority
555 @param weight - locator weight
557 define one_locator_details
568 /** \brief ONE locator_set status
569 @param context - sender context, to match reply w/ request
570 @param ls_index - locator set index
571 @param ls_name - name of the locator set
573 define one_locator_set_details
580 /** \brief Request for locator_set summary status
581 @param client_index - opaque cookie to identify the sender
582 @param context - sender context, to match reply w/ request
583 @param filter - filter type
586 1: local locator sets
587 2: remote locator sets
589 define one_locator_set_dump
596 /** \brief Dump ONE eid-table
597 @param client_index - opaque cookie to identify the sender
598 @param context - sender context, to match reply w/ request
599 @param locator_set_index - index of locator_set, if ~0 then the mapping
601 @param action - negative map request action
602 @param is_local - local if non-zero, else remote
607 @param is_src_dst - EID is type of source/destination
608 @param eid - EID can be ip4, ip6 or mac
609 @param eid_prefix_len - prefix length
610 @param seid - source EID can be ip4, ip6 or mac
611 @param seid_prefix_len - source prefix length
612 @param vni - virtual network instance
613 @param ttl - time to live
614 @param authoritative - authoritative
619 @param key - secret key
622 define one_eid_table_details
625 u32 locator_set_index;
641 /** \brief Request for eid table summary status
642 @param client_index - opaque cookie to identify the sender
643 @param context - sender context, to match reply w/ request
644 @param eid_set - if non-zero request info about specific mapping
645 @param vni - virtual network instance; valid only if eid_set != 0
646 @param prefix_length - prefix length if EID is IP address;
647 valid only if eid_set != 0
648 @param eid_type - EID type; valid only if eid_set != 0
652 2: EID is ethernet address
653 3 : NSH : both information (service path ID and service index) are
654 encoded in 'eid' field in a following way:
659 @param eid - endpoint identifier
660 @param filter - filter type;
666 define one_eid_table_dump
678 /** \brief ONE adjacency
683 @param reid - remote EID
684 @param leid - local EID
685 @param reid_prefix_len - remote EID IP prefix length
686 @param leid_prefix_len - local EID IP prefix length
688 typeonly manual_print manual_endian define one_adjacency
697 /** \brief ONE adjacency reply
698 @param count - number of adjacencies
699 @param adjacencies - array of adjacencies
701 manual_endian manual_print define one_adjacencies_get_reply
706 vl_api_one_adjacency_t adjacencies[count];
709 /** \brief Request for ONE adjacencies
710 @param client_index - opaque cookie to identify the sender
711 @param context - sender context, to match reply w/ request
712 @param vni - filter adjacencies by VNI
714 define one_adjacencies_get
721 /** \brief Shows relationship between vni and vrf/bd
722 @param dp_table - VRF index or bridge domain index
723 @param vni - vitual network instance
725 define one_eid_table_map_details
732 /** \brief Request for one_eid_table_map_details
733 @param client_index - opaque cookie to identify the sender
734 @param context - sender context, to match reply w/ request
735 @param is_l2 - if set dump vni/bd mappings else vni/vrf
737 define one_eid_table_map_dump
744 /** \brief Dumps all VNIs used in mappings
745 @param client_index - opaque cookie to identify the sender
746 @param context - sender context, to match reply w/ request
748 define one_eid_table_vni_dump
754 /** \brief reply to one_eid_table_vni_dump
755 @param client_index - opaque cookie to identify the sender
756 @param context - sender context, to match reply w/ request
757 @param vni - virtual network instance
759 define one_eid_table_vni_details
766 /** \brief ONE map resolver status
767 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
768 @param ip_address - array of address bytes
770 define one_map_resolver_details
777 /** \brief Request for map resolver summary status
778 @param client_index - opaque cookie to identify the sender
779 @param context - sender context, to match reply w/ request
781 define one_map_resolver_dump
787 /** \brief ONE map server details
788 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
789 @param ip_address - array of address bytes
791 define one_map_server_details
798 /** \brief Request for map server summary status
799 @param client_index - opaque cookie to identify the sender
800 @param context - sender context, to match reply w/ request
802 define one_map_server_dump
808 /** \brief Request for ONE status
809 @param client_index - opaque cookie to identify the sender
810 @param context - sender context, to match reply w/ request
812 define show_one_status
818 /** \brief ONE status
819 @param context - sender context, to match reply w/ request
820 @param feature_status - enabled if non-zero, else disabled
821 @param gpe_status - enabled if non-zero, else disabled
823 define show_one_status_reply
831 /** \brief Get ONE map request itr rlocs status
832 @param context - sender context, to match reply w/ request
833 @param locator_set_name - name of the locator_set
835 define one_get_map_request_itr_rlocs
841 /** \brief Request for map request itr rlocs summary status
843 define one_get_map_request_itr_rlocs_reply
847 u8 locator_set_name[64];
850 /** \brief Request for ONE NSH mapping
851 @param client_index - opaque cookie to identify the sender
852 @param context - sender context, to match reply w/ request
854 define show_one_nsh_mapping
860 /** \brief Reply for ONE NSH mapping
861 @param context - sender context, to match reply w/ request
862 @param is_set - is ONE NSH mapping set
863 @param locator_set_name - name of the locator_set if NSH mapping is set
865 define show_one_nsh_mapping_reply
870 u8 locator_set_name[64];
873 /** \brief Request for ONE PITR status
874 @param client_index - opaque cookie to identify the sender
875 @param context - sender context, to match reply w/ request
883 /** \brief Status of ONE PITR, enable or disable
884 @param context - sender context, to match reply w/ request
885 @param status - ONE PITR enable if non-zero, else disable
886 @param locator_set_name - name of the locator_set
888 define show_one_pitr_reply
893 u8 locator_set_name[64];
896 define one_stats_dump
902 define one_stats_details
919 autoreply define one_stats_flush
925 autoreply define one_stats_enable_disable
932 define show_one_stats_enable_disable
938 define show_one_stats_enable_disable_reply
945 autoreply define one_map_register_fallback_threshold
952 define show_one_map_register_fallback_threshold
958 define show_one_map_register_fallback_threshold_reply
965 autoreply define one_enable_disable_xtr_mode
972 define one_show_xtr_mode
978 define one_show_xtr_mode_reply
985 autoreply define one_enable_disable_petr_mode
992 define one_show_petr_mode
998 define one_show_petr_mode_reply
1005 autoreply define one_enable_disable_pitr_mode
1012 define one_show_pitr_mode
1018 define one_show_pitr_mode_reply
1027 * eval: (c-set-style "gnu")