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 Add/delete map server
106 @param client_index - opaque cookie to identify the sender
107 @param context - sender context, to match reply w/ request
108 @param is_add - add address if non-zero; delete otherwise
109 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
110 @param ip_address - map server IP address
112 autoreply define one_add_del_map_server
121 /** \brief add or delete map-resolver
122 @param client_index - opaque cookie to identify the sender
123 @param context - sender context, to match reply w/ request
124 @param is_add - add address if non-zero, else delete
125 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
126 @param ip_address - array of address bytes
128 autoreply define one_add_del_map_resolver
137 /** \brief enable or disable ONE feature
138 @param client_index - opaque cookie to identify the sender
139 @param context - sender context, to match reply w/ request
140 @param is_en - enable protocol if non-zero, else disable
142 autoreply define one_enable_disable
149 /** \brief configure or delete ONE NSH mapping
150 @param client_index - opaque cookie to identify the sender
151 @param context - sender context, to match reply w/ request
152 @param ls_name - locator set name
153 @param is_add - add locator set if non-zero; delete otherwise
155 autoreply define one_nsh_set_locator_set
163 /** \brief configure or disable ONE PITR node
164 @param client_index - opaque cookie to identify the sender
165 @param context - sender context, to match reply w/ request
166 @param ls_name - locator set name
167 @param is_add - add locator set if non-zero, else disable pitr
169 autoreply define one_pitr_set_locator_set
177 /** \brief configure or disable use of PETR
178 @param client_index - opaque cookie to identify the sender
179 @param context - sender context, to match reply w/ request
180 @param is_ip4 - Address is IPv4 if set and IPv6 otherwise
181 @param address - PETR IP address
182 @param is_add - add locator set if non-zero, else disable PETR
184 autoreply define one_use_petr
193 /** \brief Request for ONE PETR status
194 @param client_index - opaque cookie to identify the sender
195 @param context - sender context, to match reply w/ request
197 define show_one_use_petr
203 /** \brief ONE PETR status, enable or disable
204 @param context - sender context, to match reply w/ request
205 @param status - ONE PETR enable if non-zero, else disable
206 @param is_ip4 - Address is IPv4 if non-zero, else IPv6
207 @param address - PETR IP address
209 define show_one_use_petr_reply
218 /** \brief Get state of ONE RLOC probing
219 @param client_index - opaque cookie to identify the sender
220 @param context - sender context, to match reply w/ request
222 define show_one_rloc_probe_state
228 /** \brief Reply for show_one_rloc_probe_state
229 @param context - returned sender context, to match reply w/ request
230 @param retval - return code
231 @param is_enabled - state of RLOC probing
233 define show_one_rloc_probe_state_reply
240 /** \brief enable/disable ONE RLOC probing
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 one_rloc_probe_enable_disable
252 /** \brief enable/disable ONE map-register
253 @param client_index - opaque cookie to identify the sender
254 @param context - sender context, to match reply w/ request
255 @param is_enable - enable if non-zero; disable otherwise
257 autoreply define one_map_register_enable_disable
264 /** \brief Get state of ONE map-register
265 @param client_index - opaque cookie to identify the sender
266 @param context - sender context, to match reply w/ request
268 define show_one_map_register_state
274 /** \brief Reply for show_one_map_register_state
275 @param context - returned sender context, to match reply w/ request
276 @param retval - return code
278 define show_one_map_register_state_reply
285 /** \brief set ONE map-request mode. Based on configuration VPP will send
286 src/dest or just normal destination map requests.
287 @param client_index - opaque cookie to identify the sender
288 @param context - sender context, to match reply w/ request
289 @param mode - new map-request mode. Supported values are:
291 1 - source/destaination
293 autoreply define one_map_request_mode
300 /** \brief Request for ONE map-request mode
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_request_mode
310 /** \brief Reply for show_one_map_request_mode
311 @param context - returned sender context, to match reply w/ request
312 @param retval - return code
313 @param mode - map-request mode
315 define show_one_map_request_mode_reply
322 typeonly manual_endian manual_print define one_remote_locator
330 /** \brief add or delete remote static mapping
331 @param client_index - opaque cookie to identify the sender
332 @param context - sender context, to match reply w/ request
333 @param is_add - add address if non-zero, else delete
334 @param is_src_dst - flag indicating src/dst based routing policy
335 @param del_all - if set, delete all remote mappings
336 @param vni - virtual network instance
337 @param action - negative map-reply action
342 3 : NSH : both information (service path ID and service index) are
343 encoded in 'eid' field in a following way:
348 @param deid - dst EID
349 @param seid - src EID, valid only if is_src_dst is enabled
350 @param rloc_num - number of remote locators
351 @param rlocs - remote locator records
353 autoreply manual_print manual_endian define one_add_del_remote_mapping
368 vl_api_one_remote_locator_t rlocs[rloc_num];
371 /** \brief Add/delete L2 ARP entries
372 @param client_index - opaque cookie to identify the sender
373 @param context - sender context, to match reply w/ request
374 @param is_add - add if non-zero; delete otherwise
375 @param bd - bridge domain
376 @param mac - MAC address
377 @param ip4 - IPv4 address
379 autoreply define one_add_del_l2_arp_entry
389 /** \brief Request for L2 ARP entries from specified bridge domain
390 @param client_index - opaque cookie to identify the sender
391 @param context - sender context, to match reply w/ request
392 @param bd - bridge domain
394 define one_l2_arp_entries_get
401 typeonly manual_print manual_endian define one_l2_arp_entry
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 /** \brief Request for list of bridge domains used by L2 ARP table
422 @param client_index - opaque cookie to identify the sender
423 @param context - sender context, to match reply w/ request
425 define one_l2_arp_bd_get
431 /** \brief Reply with list of bridge domains used by L2 ARP table
432 @param context - sender context, to match reply w/ request
433 @param count - number of elements in the list
434 @param bridge_domains - list of BDs
436 manual_print manual_endian define one_l2_arp_bd_get_reply
441 u32 bridge_domains[count];
444 /** \brief add or delete ONE adjacency adjacency
445 @param client_index - opaque cookie to identify the sender
446 @param context - sender context, to match reply w/ request
447 @param is_add - add address if non-zero, else delete
448 @param vni - virtual network instance
453 @param reid - remote EID
454 @param leid - local EID
456 autoreply define one_add_del_adjacency
469 /** \brief add or delete map request itr rlocs
470 @param client_index - opaque cookie to identify the sender
471 @param context - sender context, to match reply w/ request
472 @param is_add - add address if non-zero, else delete
473 @param locator_set_name - locator set name
475 autoreply define one_add_del_map_request_itr_rlocs
480 u8 locator_set_name[64];
483 /** \brief map/unmap vni/bd_index to vrf
484 @param client_index - opaque cookie to identify the sender
485 @param context - sender context, to match reply w/ request
486 @param is_add - add or delete mapping
487 @param dp_table - virtual network id/bridge domain index
490 autoreply define one_eid_table_add_del_map
500 /** \brief Request for map one locator status
501 @param client_index - opaque cookie to identify the sender
502 @param context - sender context, to match reply w/ request
503 @param locator_set_index - index of locator_set
504 @param ls_name - locator set name
505 @param is_index_set - flag indicating whether ls_name or ls_index is set
507 define one_locator_dump
516 /** \brief ONE locator_set status
517 @param local - if is set, then locator is local
518 @param locator_set_name - name of the locator_set
519 @param sw_if_index - sw_if_index of the locator
520 @param priority - locator priority
521 @param weight - locator weight
523 define one_locator_details
534 /** \brief ONE locator_set status
535 @param context - sender context, to match reply w/ request
536 @param ls_index - locator set index
537 @param ls_name - name of the locator set
539 define one_locator_set_details
546 /** \brief Request for locator_set summary status
547 @param client_index - opaque cookie to identify the sender
548 @param context - sender context, to match reply w/ request
549 @param filter - filter type
552 1: local locator sets
553 2: remote locator sets
555 define one_locator_set_dump
562 /** \brief Dump ONE eid-table
563 @param client_index - opaque cookie to identify the sender
564 @param context - sender context, to match reply w/ request
565 @param locator_set_index - index of locator_set, if ~0 then the mapping
567 @param action - negative map request action
568 @param is_local - local if non-zero, else remote
573 @param is_src_dst - EID is type of source/destination
574 @param eid - EID can be ip4, ip6 or mac
575 @param eid_prefix_len - prefix length
576 @param seid - source EID can be ip4, ip6 or mac
577 @param seid_prefix_len - source prefix length
578 @param vni - virtual network instance
579 @param ttl - time to live
580 @param authoritative - authoritative
585 @param key - secret key
588 define one_eid_table_details
591 u32 locator_set_index;
607 /** \brief Request for eid table summary status
608 @param client_index - opaque cookie to identify the sender
609 @param context - sender context, to match reply w/ request
610 @param eid_set - if non-zero request info about specific mapping
611 @param vni - virtual network instance; valid only if eid_set != 0
612 @param prefix_length - prefix length if EID is IP address;
613 valid only if eid_set != 0
614 @param eid_type - EID type; valid only if eid_set != 0
618 2: EID is ethernet address
619 3 : NSH : both information (service path ID and service index) are
620 encoded in 'eid' field in a following way:
625 @param eid - endpoint identifier
626 @param filter - filter type;
632 define one_eid_table_dump
644 /** \brief ONE adjacency
649 @param reid - remote EID
650 @param leid - local EID
651 @param reid_prefix_len - remote EID IP prefix length
652 @param leid_prefix_len - local EID IP prefix length
654 typeonly manual_print manual_endian define one_adjacency
663 /** \brief ONE adjacency reply
664 @param count - number of adjacencies
665 @param adjacencies - array of adjacencies
667 manual_endian manual_print define one_adjacencies_get_reply
672 vl_api_one_adjacency_t adjacencies[count];
675 /** \brief Request for ONE adjacencies
676 @param client_index - opaque cookie to identify the sender
677 @param context - sender context, to match reply w/ request
678 @param vni - filter adjacencies by VNI
680 define one_adjacencies_get
687 /** \brief Shows relationship between vni and vrf/bd
688 @param dp_table - VRF index or bridge domain index
689 @param vni - vitual network instance
691 define one_eid_table_map_details
698 /** \brief Request for one_eid_table_map_details
699 @param client_index - opaque cookie to identify the sender
700 @param context - sender context, to match reply w/ request
701 @param is_l2 - if set dump vni/bd mappings else vni/vrf
703 define one_eid_table_map_dump
710 /** \brief Dumps all VNIs used in mappings
711 @param client_index - opaque cookie to identify the sender
712 @param context - sender context, to match reply w/ request
714 define one_eid_table_vni_dump
720 /** \brief reply to one_eid_table_vni_dump
721 @param client_index - opaque cookie to identify the sender
722 @param context - sender context, to match reply w/ request
723 @param vni - virtual network instance
725 define one_eid_table_vni_details
732 /** \brief ONE map resolver status
733 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
734 @param ip_address - array of address bytes
736 define one_map_resolver_details
743 /** \brief Request for map resolver summary status
744 @param client_index - opaque cookie to identify the sender
745 @param context - sender context, to match reply w/ request
747 define one_map_resolver_dump
753 /** \brief ONE map server details
754 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
755 @param ip_address - array of address bytes
757 define one_map_server_details
764 /** \brief Request for map server summary status
765 @param client_index - opaque cookie to identify the sender
766 @param context - sender context, to match reply w/ request
768 define one_map_server_dump
774 /** \brief Request for ONE status
775 @param client_index - opaque cookie to identify the sender
776 @param context - sender context, to match reply w/ request
778 define show_one_status
784 /** \brief ONE status
785 @param context - sender context, to match reply w/ request
786 @param feature_status - enabled if non-zero, else disabled
787 @param gpe_status - enabled if non-zero, else disabled
789 define show_one_status_reply
797 /** \brief Get ONE map request itr rlocs status
798 @param context - sender context, to match reply w/ request
799 @param locator_set_name - name of the locator_set
801 define one_get_map_request_itr_rlocs
807 /** \brief Request for map request itr rlocs summary status
809 define one_get_map_request_itr_rlocs_reply
813 u8 locator_set_name[64];
816 /** \brief Request for ONE NSH mapping
817 @param client_index - opaque cookie to identify the sender
818 @param context - sender context, to match reply w/ request
820 define show_one_nsh_mapping
826 /** \brief Reply for ONE NSH mapping
827 @param context - sender context, to match reply w/ request
828 @param is_set - is ONE NSH mapping set
829 @param locator_set_name - name of the locator_set if NSH mapping is set
831 define show_one_nsh_mapping_reply
836 u8 locator_set_name[64];
839 /** \brief Request for ONE PITR status
840 @param client_index - opaque cookie to identify the sender
841 @param context - sender context, to match reply w/ request
849 /** \brief Status of ONE PITR, enable or disable
850 @param context - sender context, to match reply w/ request
851 @param status - ONE PITR enable if non-zero, else disable
852 @param locator_set_name - name of the locator_set
854 define show_one_pitr_reply
859 u8 locator_set_name[64];
862 define one_stats_dump
868 define one_stats_details
885 autoreply define one_stats_flush
891 autoreply define one_stats_enable_disable
898 define show_one_stats_enable_disable
904 define show_one_stats_enable_disable_reply
913 * eval: (c-set-style "gnu")