src/vnet/ip/ip.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2018 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /** \file
  18
  19     This file defines vpp IP control-plane API messages which are generally
  20     called through a shared memory interface.
  21 */
  22
  23 option version = "1.3.0";
  24 import "vnet/ip/ip_types.api";
  25 import "vnet/fib/fib_types.api";
  26 import "vnet/ethernet/ethernet_types.api";
  27
  28 /** \brief Add / del table request
  29            A table can be added multiple times, but need be deleted only once.
  30     @param client_index - opaque cookie to identify the sender
  31     @param context - sender context, to match reply w/ request
  32     @param is_ipv6 - V4 or V6 table
  33     @param table_id - table ID associated with the route
  34                       This table ID will apply to both the unicats
  35                       and mlticast FIBs
  36     @param name - A client provided name/tag for the table. If this is
  37                   not set by the client, then VPP will generate something
  38                   meaningfull.
  39 */
  40 autoreply define ip_table_add_del
  41 {
  42   u32 client_index;
  43   u32 context;
  44   u32 table_id;
  45   u8 is_ipv6;
  46   u8 is_add;
  47   u8 name[64];
  48 };
  49
  50 /** \brief Dump IP fib table
  51     @param client_index - opaque cookie to identify the sender
  52 */
  53 define ip_fib_dump
  54 {
  55   u32 client_index;
  56   u32 context;
  57 };
  58
  59 /** \brief IP FIB table response
  60     @param table_id - IP fib table id
  61     @address_length - mask length
  62     @address - ip4 prefix
  63     @param count - the number of fib_path in path
  64     @param path  - array of of fib_path structures
  65 */
  66 manual_endian manual_print define ip_fib_details
  67 {
  68   u32 context;
  69   u32 table_id;
  70   u8  table_name[64];
  71   u8  address_length;
  72   u8  address[4];
  73   u32 count;
  74   u32 stats_index;
  75   vl_api_fib_path_t path[count];
  76 };
  77
  78 /** \brief Dump IP6 fib table
  79     @param client_index - opaque cookie to identify the sender
  80 */
  81 define ip6_fib_dump
  82 {
  83   u32 client_index;
  84   u32 context;
  85 };
  86
  87 /** \brief IP6 FIB table entry response
  88     @param table_id - IP6 fib table id
  89     @param address_length - mask length
  90     @param address - ip6 prefix
  91     @param count - the number of fib_path in path
  92     @param path  - array of of fib_path structures
  93 */
  94 manual_endian manual_print define ip6_fib_details
  95 {
  96   u32 context;
  97   u32 table_id;
  98   u8  table_name[64];
  99   u8  address_length;
 100   u8  address[16];
 101   u32 count;
 102   u32 stats_index;
 103   vl_api_fib_path_t path[count];
 104 };
 105
 106 /** \brief Dump IP neighboors
 107     @param client_index - opaque cookie to identify the sender
 108     @param context - sender context, to match reply w/ request
 109     @param sw_if_index - the interface to dump neighboors, ~0 == all
 110     @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
 111 */
 112 define ip_neighbor_dump
 113 {
 114     u32 client_index;
 115     u32 context;
 116     u32 sw_if_index;
 117     u8  is_ipv6;
 118 };
 119
 120 /** \brief IP neighboors dump response
 121     @param context - sender context which was passed in the request
 122     @param sw_if_index - The interface used to reach the neighbor
 123     @param stats_index - An index in the stats segment that can be used to read
 124                          the counters for this neighbour.
 125     @param is_static - [1|0] to indicate if neighbor is statically configured
 126     @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
 127 */
 128 define ip_neighbor_details {
 129     u32 context;
 130     u32 sw_if_index;
 131     u32 stats_index;
 132     u8  is_static;
 133     u8  is_ipv6;
 134     u8  mac_address[6];
 135     u8  ip_address[16];
 136 };
 137
 138 /** \brief IP neighbor add / del request
 139     @param client_index - opaque cookie to identify the sender
 140     @param context - sender context, to match reply w/ request
 141     @param sw_if_index - interface used to reach neighbor
 142     @param is_add - 1 to add neighbor, 0 to delete
 143     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 144     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 145     @param is_static - A static neighbor Entry - there are not flushed
 146                        If the interface goes down.
 147     @param is_no_adj_fib - Do not create a corresponding entry in the FIB
 148                            table for the neighbor.
 149     @param mac_address - l2 address of the neighbor
 150     @param dst_address - ip4 or ip6 address of the neighbor
 151 */
 152 define ip_neighbor_add_del
 153 {
 154   u32 client_index;
 155   u32 context;
 156   u32 sw_if_index;
 157   /* 1 = add, 0 = delete */
 158   u8 is_add;
 159   u8 is_ipv6;
 160   u8 is_static;
 161   u8 is_no_adj_fib;
 162   u8 mac_address[6];
 163   u8 dst_address[16];
 164 };
 165
 166 define ip_neighbor_add_del_reply
 167 {
 168   u32 context;
 169   i32 retval;
 170   u32 stats_index;
 171 };
 172
 173 /** \brief Set the ip flow hash config for a fib request
 174     @param client_index - opaque cookie to identify the sender
 175     @param context - sender context, to match reply w/ request
 176     @param vrf_id - vrf/fib id
 177     @param is_ipv6 - if non-zero the fib is ip6, else ip4
 178     @param src - if non-zero include src in flow hash
 179     @param dst - if non-zero include dst in flow hash
 180     @param sport - if non-zero include sport in flow hash
 181     @param dport - if non-zero include dport in flow hash
 182     @param proto -if non-zero include proto in flow hash
 183     @param reverse - if non-zero include reverse in flow hash
 184 */
 185 autoreply define set_ip_flow_hash
 186 {
 187   u32 client_index;
 188   u32 context;
 189   u32 vrf_id;
 190   u8 is_ipv6;
 191   u8 src;
 192   u8 dst;
 193   u8 sport;
 194   u8 dport;
 195   u8 proto;
 196   u8 reverse;
 197 };
 198
 199 /** \brief IPv6 router advertisement config request
 200     @param client_index - opaque cookie to identify the sender
 201     @param context - sender context, to match reply w/ request
 202     @param suppress -
 203     @param managed -
 204     @param other -
 205     @param ll_option -
 206     @param send_unicast -
 207     @param cease -
 208     @param is_no -
 209     @param default_router -
 210     @param max_interval -
 211     @param min_interval -
 212     @param lifetime -
 213     @param initial_count -
 214     @param initial_interval -
 215 */
 216 autoreply define sw_interface_ip6nd_ra_config
 217 {
 218   u32 client_index;
 219   u32 context;
 220   u32 sw_if_index;
 221   u8 suppress;
 222   u8 managed;
 223   u8 other;
 224   u8 ll_option;
 225   u8 send_unicast;
 226   u8 cease;
 227   u8 is_no;
 228   u8 default_router;
 229   u32 max_interval;
 230   u32 min_interval;
 231   u32 lifetime;
 232   u32 initial_count;
 233   u32 initial_interval;
 234 };
 235
 236 /** \brief IPv6 router advertisement prefix config request
 237     @param client_index - opaque cookie to identify the sender
 238     @param context - sender context, to match reply w/ request
 239     @param sw_if_index - The interface the RA prefix information is for
 240     @param address[] - The prefix to advertise
 241     @param address_length - the prefix length
 242     @param use_default - Revert to default settings
 243     @param no_advertise - Do not advertise this prefix
 244     @param off_link - The prefix is off link (it is not configured on the interface)
 245                       Configures the L-flag, When set, indicates that this
 246                       prefix can be used for on-link determination.
 247     @param no_autoconfig - Setting for the A-flag. When
 248                            set indicates that this prefix can be used for
 249                           stateless address configuration.
 250     @param no_onlink - The prefix is not on link. Make sure this is consistent
 251                        with the off_link parameter else YMMV
 252     @param is_no - add/delete
 253     @param val_lifetime - The length of time in
 254                      seconds (relative to the time the packet is sent)
 255                      that the prefix is valid for the purpose of on-link
 256                      determination.  A value of all one bits
 257                      (0xffffffff) represents infinity
 258     @param pref_lifetime - The length of time in
 259                      seconds (relative to the time the packet is sent)
 260                      that addresses generated from the prefix via
 261                      stateless address autoconfiguration remain
 262                      preferred [ADDRCONF].  A value of all one bits
 263                      (0xffffffff) represents infinity.
 264 */
 265 autoreply define sw_interface_ip6nd_ra_prefix
 266 {
 267   u32 client_index;
 268   u32 context;
 269   u32 sw_if_index;
 270   u8 address[16];
 271   u8 address_length;
 272   u8 use_default;
 273   u8 no_advertise;
 274   u8 off_link;
 275   u8 no_autoconfig;
 276   u8 no_onlink;
 277   u8 is_no;
 278   u32 val_lifetime;
 279   u32 pref_lifetime;
 280 };
 281
 282 /** \brief IPv6 ND proxy config
 283     @param client_index - opaque cookie to identify the sender
 284     @param context - sender context, to match reply w/ request
 285     @param sw_if_index - The interface the host is on
 286     @param address - The address of the host for which to proxy for
 287     @param is_add - Adding or deleting
 288 */
 289 autoreply define ip6nd_proxy_add_del
 290 {
 291   u32 client_index;
 292   u32 context;
 293   u32 sw_if_index;
 294   u8 is_del;
 295   u8 address[16];
 296 };
 297
 298 /** \brief IPv6 ND proxy details returned after request
 299     @param context - sender context, to match reply w/ request
 300     @param retval - return code for the request
 301 */
 302 define ip6nd_proxy_details
 303 {
 304   u32 context;
 305   u32 sw_if_index;
 306   u8 address[16];
 307 };
 308
 309 /** \brief IPv6 ND proxy dump request
 310     @param context - sender context, to match reply w/ request
 311     @param retval - return code for the request
 312     @param sw_if_index - The interface the host is on
 313     @param address - The address of the host for which to proxy for
 314 */
 315 define ip6nd_proxy_dump
 316 {
 317   u32 client_index;
 318   u32 context;
 319 };
 320
 321 /** \brief Start / stop sending router solicitation
 322     @param client_index - opaque cookie to identify the sender
 323     @param context - sender context, to match reply w/ request
 324     @param irt - initial retransmission time
 325     @param mrt - maximum retransmission time
 326     @param mrc - maximum retransmission count
 327     @param mrd - maximum retransmission duration
 328     @param sw_if_index - software interface index of interface
 329                          for sending router solicitation
 330     @param stop - if non-zero then stop sending router solicitation,
 331                   otherwise start sending router solicitation
 332 */
 333 autoreply define ip6nd_send_router_solicitation
 334 {
 335   u32 client_index;
 336   u32 context;
 337   u32 irt;
 338   u32 mrt;
 339   u32 mrc;
 340   u32 mrd;
 341   u32 sw_if_index;
 342   u8 stop;
 343 };
 344
 345 /** \brief IPv6 interface enable / disable request
 346     @param client_index - opaque cookie to identify the sender
 347     @param context - sender context, to match reply w/ request
 348     @param sw_if_index - interface used to reach neighbor
 349     @param enable - if non-zero enable ip6 on interface, else disable
 350 */
 351 autoreply define sw_interface_ip6_enable_disable
 352 {
 353   u32 client_index;
 354   u32 context;
 355   u32 sw_if_index;
 356   u8 enable;                    /* set to true if enable */
 357 };
 358
 359 /** \brief Add / del route request
 360     @param client_index - opaque cookie to identify the sender
 361     @param context - sender context, to match reply w/ request
 362     @param sw_if_index - software index of the new vlan's parent interface
 363     @param vrf_id - fib table /vrf associated with the route
 364     @param lookup_in_vrf -
 365     @param classify_table_index -
 366     @param is_add - 1 if adding the route, 0 if deleting
 367     @param is_drop - Drop the packet
 368     @param is_unreach - Drop the packet and rate limit send ICMP unreachable
 369     @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
 370     @param is_ipv6 - 0 if an ip4 route, else ip6
 371     @param is_local - The route will result in packets sent to VPP IP stack
 372     @param is_udp_encap - The path describes a UDP-o-IP encapsulation.
 373     @param is_classify -
 374     @param is_multipath - Set to 1 if this is a multipath route, else 0
 375     @param is_dvr - Does the route resolve via a DVR interface.
 376     @param is_source_lookup - The the path is a deaggregate path (i.e. a lookup
 377                               in another table) is the lookup on the packet's
 378                               source address or destination.
 379     @param next_hop_weight - Weight for Unequal cost multi-path
 380     @param next_hop_preference - Path that are up that have the best preference are
 381                                  are used for forwarding. lower value is better.
 382     @param next_hop_id - Used when the path resolves via an object that has a unique
 383                          identifier.
 384     @param dst_address_length -
 385     @param dst_address[16] -
 386     @param next_hop_address[16] -
 387     @param next_hop_n_out_labels - the number of labels in the label stack
 388     @param next_hop_out_label_stack - the next-hop output label stack, outer most first
 389     @param next_hop_via_label - The next-hop is a resolved via a local label
 390 */
 391 define ip_add_del_route
 392 {
 393   u32 client_index;
 394   u32 context;
 395   u32 next_hop_sw_if_index;
 396   u32 table_id;
 397   u32 classify_table_index;
 398   u32 next_hop_table_id;
 399   u32 next_hop_id;
 400   u8 is_add;
 401   u8 is_drop;
 402   u8 is_unreach;
 403   u8 is_prohibit;
 404   u8 is_ipv6;
 405   u8 is_local;
 406   u8 is_classify;
 407   u8 is_multipath;
 408   u8 is_resolve_host;
 409   u8 is_resolve_attached;
 410   u8 is_dvr;
 411   u8 is_source_lookup;
 412   u8 is_udp_encap;
 413   u8 next_hop_weight;
 414   u8 next_hop_preference;
 415   u8 next_hop_proto;
 416   u8 dst_address_length;
 417   u8 dst_address[16];
 418   u8 next_hop_address[16];
 419   u8 next_hop_n_out_labels;
 420   u32 next_hop_via_label;
 421   vl_api_fib_mpls_label_t next_hop_out_label_stack[next_hop_n_out_labels];
 422 };
 423
 424 define ip_add_del_route_reply
 425 {
 426   u32 context;
 427   i32 retval;
 428   u32 stats_index;
 429 };
 430
 431 /** \brief Add / del route request
 432
 433     Adds a route, consisting both of the MFIB entry to match packets
 434     (which may already exist) and a path to send those packets down.
 435     Routes can be entered repeatedly to add multiple paths.  Deletions are
 436     per-path.
 437
 438     @param client_index - opaque cookie to identify the sender
 439     @param context - sender context, to match reply w/ request
 440     @param table_id - fib table /vrf associated with the route
 441     @param is_add - true if adding a route; false if deleting one
 442     @param is_ipv6 - true iff all the addresses are v6
 443     @param entry_flags - see fib_entry_flag_t
 444     @param itf_flags - see mfib_entry_flags_t
 445     @param next_hop_afi - see dpo_proto_t; the type of destination description
 446     @param src_address - the source of the packet
 447     @param grp_address - the group the packet is destined to
 448     @param nh_address - the nexthop to forward the packet to
 449     @param next_hop_sw_if_index - interface to emit packet on
 450
 451     BIER AFIs use the BIER imposition ID.  v4 and v6 AFIs use either the
 452     interface or the nexthop address.
 453
 454     Note that if the route is source-specific (S is supplied, not all 0s),
 455     the prefix match is treated as exact (prefixlen /32 or /128).
 456
 457     FIXME not complete yet
 458 */
 459 define ip_mroute_add_del
 460 {
 461   u32 client_index;
 462   u32 context;
 463   u32 next_hop_sw_if_index;
 464   u32 table_id;
 465   u32 entry_flags;
 466   u32 itf_flags;
 467   u32 rpf_id;
 468   u32 bier_imp;
 469   u16 grp_address_length;
 470   u8 next_hop_afi;
 471   u8 is_add;
 472   u8 is_ipv6;
 473   u8 is_local;
 474   u8 grp_address[16];
 475   u8 src_address[16];
 476   u8 nh_address[16];
 477 };
 478
 479 define ip_mroute_add_del_reply
 480 {
 481   u32 context;
 482   i32 retval;
 483   u32 stats_index;
 484 };
 485
 486 /** \brief Dump IP multicast fib table
 487     @param client_index - opaque cookie to identify the sender
 488 */
 489 define ip_mfib_dump
 490 {
 491   u32 client_index;
 492   u32 context;
 493 };
 494
 495 /** \brief IP Multicast FIB table response
 496     @param table_id - IP fib table id
 497     @address_length - mask length
 498     @grp_address - Group address/prefix
 499     @src_address - Source address
 500     @param count - the number of fib_path in path
 501     @param path  - array of of fib_path structures
 502 */
 503 manual_endian manual_print define ip_mfib_details
 504 {
 505   u32 context;
 506   u32 table_id;
 507   u32 entry_flags;
 508   u32 rpf_id;
 509   u8  address_length;
 510   u8  grp_address[4];
 511   u8  src_address[4];
 512   u32 count;
 513   u32 stats_index;
 514   vl_api_fib_path_t path[count];
 515 };
 516
 517 /** \brief Dump IP6 multicast fib table
 518     @param client_index - opaque cookie to identify the sender
 519 */
 520 define ip6_mfib_dump
 521 {
 522   u32 client_index;
 523   u32 context;
 524 };
 525
 526 /** \brief IP6 Multicast FIB table response
 527     @param table_id - IP fib table id
 528     @address_length - mask length
 529     @grp_address - Group address/prefix
 530     @src_address - Source address
 531     @param count - the number of fib_path in path
 532     @param path  - array of of fib_path structures
 533 */
 534 manual_endian manual_print define ip6_mfib_details
 535 {
 536   u32 context;
 537   u32 table_id;
 538   u8  address_length;
 539   u8  grp_address[16];
 540   u8  src_address[16];
 541   u32 count;
 542   vl_api_fib_path_t path[count];
 543 };
 544
 545 define ip_address_details
 546 {
 547   u32 context;
 548   u8 ip[16];
 549   u8 prefix_length;
 550   u32 sw_if_index;
 551   u8 is_ipv6;
 552 };
 553
 554 define ip_address_dump
 555 {
 556   u32 client_index;
 557   u32 context;
 558   u32 sw_if_index;
 559   u8 is_ipv6;
 560 };
 561
 562 /** \brief IP unnumbered configurations
 563     @param sw_if_index The interface that has unnumbered configuration
 564     @param ip_sw_if_index The IP interface that it is unnnumbered to
 565 */
 566 define ip_unnumbered_details
 567 {
 568   u32 context;
 569   u32 sw_if_index;
 570   u32 ip_sw_if_index;
 571 };
 572
 573 /** \brief Dump IP unnumbered configurations
 574     @param sw_if_index ~0 for all interfaces, else the interface desired
 575 */
 576 define ip_unnumbered_dump
 577 {
 578   u32 client_index;
 579   u32 context;
 580   u32 sw_if_index;
 581 };
 582
 583 define ip_details
 584 {
 585   u32 context;
 586   u32 sw_if_index;
 587   u8 is_ipv6;
 588 };
 589
 590 define ip_dump
 591 {
 592   u32 client_index;
 593   u32 context;
 594   u8 is_ipv6;
 595 };
 596
 597 define mfib_signal_dump
 598 {
 599   u32 client_index;
 600   u32 context;
 601 };
 602
 603 define mfib_signal_details
 604 {
 605   u32 context;
 606   u32 sw_if_index;
 607   u32 table_id;
 608   u16 grp_address_len;
 609   u8 grp_address[16];
 610   u8 src_address[16];
 611   u16 ip_packet_len;
 612   u8 ip_packet_data[256];
 613 };
 614
 615 /** \brief IP punt policer
 616     @param client_index - opaque cookie to identify the sender
 617     @param context - sender context, to match reply w/ request
 618     @param is_add - 1 to add neighbor, 0 to delete
 619     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 620     @param policer_index - Index of policer to use
 621 */
 622 autoreply define ip_punt_police
 623 {
 624   u32 client_index;
 625   u32 context;
 626   u32 policer_index;
 627   u8 is_add;
 628   u8 is_ip6;
 629 };
 630
 631 /** \brief IP punt redirect
 632     @param client_index - opaque cookie to identify the sender
 633     @param context - sender context, to match reply w/ request
 634     @param is_add - 1 to add neighbor, 0 to delete
 635     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 636     @param tx_sw_if_index - the TX interface to which traffic shoulde be
 637                             redirected.
 638     @param nh - The next-hop to redirect the traffic to.
 639 */
 640 autoreply define ip_punt_redirect
 641 {
 642   u32 client_index;
 643   u32 context;
 644   u32 rx_sw_if_index;
 645   u32 tx_sw_if_index;
 646   u8 is_add;
 647   u8 is_ip6;
 648   u8 nh[16];
 649 };
 650
 651 autoreply define ip_container_proxy_add_del
 652 {
 653   u32 client_index;
 654   u32 context;
 655   u8 ip[16];
 656   u8 is_ip4;
 657   u8 plen;
 658   u32 sw_if_index;
 659   u8 is_add;
 660 };
 661
 662 define ip_container_proxy_dump
 663 {
 664   u32 client_index;
 665   u32 context;
 666 };
 667
 668 define ip_container_proxy_details
 669 {
 670   u32 context;
 671   u32 sw_if_index;
 672   vl_api_prefix_t prefix;
 673 };
 674
 675 /** \brief Configure IP source and L4 port-range check
 676     @param client_index - opaque cookie to identify the sender
 677     @param context - sender context, to match reply w/ request
 678     @param is_ip6 - 1 if source address type is IPv6
 679     @param is_add - 1 if add, 0 if delete
 680     @param mask_length - mask length for address entry
 681     @param address - array of address bytes
 682     @param number_of_ranges - length of low_port and high_port arrays (must match)
 683     @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
 684     @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
 685     @param vrf_id - fib table/vrf id to associate the source and port-range check with
 686     @note To specify a single port set low_port and high_port entry the same
 687 */
 688 autoreply define ip_source_and_port_range_check_add_del
 689 {
 690   u32 client_index;
 691   u32 context;
 692   u8 is_ipv6;
 693   u8 is_add;
 694   u8 mask_length;
 695   u8 address[16];
 696   u8 number_of_ranges;
 697   u16 low_ports[32];
 698   u16 high_ports[32];
 699   u32 vrf_id;
 700 };
 701
 702 /** \brief Set interface source and L4 port-range request
 703     @param client_index - opaque cookie to identify the sender
 704     @param context - sender context, to match reply w/ request
 705     @param interface_id - interface index
 706     @param tcp_vrf_id - VRF associated with source and TCP port-range check
 707     @param udp_vrf_id - VRF associated with source and TCP port-range check
 708 */
 709 autoreply define ip_source_and_port_range_check_interface_add_del
 710 {
 711   u32 client_index;
 712   u32 context;
 713   u8 is_add;
 714   u32 sw_if_index;
 715   u32 tcp_in_vrf_id;
 716   u32 tcp_out_vrf_id;
 717   u32 udp_in_vrf_id;
 718   u32 udp_out_vrf_id;
 719 };
 720
 721 /** \brief Enable/disable periodic IP neighbor scan
 722     @param client_index - opaque cookie to identify the sender
 723     @param context - sender context, to match reply w/ request
 724     @param mode - 0: disable, 1: IPv4, 2: IPv6, 3: both IPv4/v6
 725     @param scan_interval - neighbor scan interval in minutes, 0: default to 1
 726     @param max_proc_time - max processing time per run in usec, 0: default to 20
 727     @param max_update - max neighbor probe/delete per run, 0: default to 10
 728     @param scan_int_delay - delay in msec to resume scan if exceed max proc
 729                             time or update, 0: default to 1
 730     @param stale_threshold - threshold in minutes for neighbor deletion,
 731                              0: default to 4*scan_interval
 732 */
 733 autoreply define ip_scan_neighbor_enable_disable
 734 {
 735   u32 client_index;
 736   u32 context;
 737   u8 mode;
 738   u8 scan_interval;
 739   u8 max_proc_time;
 740   u8 max_update;
 741   u8 scan_int_delay;
 742   u8 stale_threshold;
 743 };
 744
 745 /** \brief IP probe neighbor address on an interface by sending an
 746            ARP request (for IP4) or ICMP6 Neighbor Solicitation (for IP6)
 747     @param client_index - opaque cookie to identify the sender
 748     @param context - sender context, to match reply w/ request
 749     @param sw_if_index - interface index
 750     @param dst_address - target IP address to send IP addr resolution request
 751     @param is_ipv6 - [1|0] to indicate if address family is IPv[6|4]
 752 */
 753 autoreply define ip_probe_neighbor
 754 {
 755   u32 client_index;
 756   u32 context;
 757   u32 sw_if_index;
 758   u8 dst_address[16];
 759   u8 is_ipv6;
 760 };
 761
 762 /** \brief Register for IP4 ARP resolution event on receing ARP reply or
 763            MAC/IP info from ARP requests in L2 BDs
 764     @param client_index - opaque cookie to identify the sender
 765     @param context - sender context, to match reply w/ request
 766     @param enable_disable - 1 => register for events, 0 => cancel registration
 767     @param pid - sender's pid
 768     @param address - exact IP4 address of interested arp resolution event, or
 769                      0 to get MAC/IP info from ARP requests in BDs
 770 */
 771 autoreply define want_ip4_arp_events
 772 {
 773   u32 client_index;
 774   u32 context;
 775   u8 enable_disable;
 776   u32 pid;
 777   u32 address;
 778 };
 779
 780 /** \brief Tell client about an IP4 ARP resolution event or
 781            MAC/IP info from ARP requests in L2 BDs
 782     @param client_index - opaque cookie to identify the sender
 783     @param address - the exact ip4 address of interest
 784     @param pid - client pid registered to receive notification
 785     @param sw_if_index - interface which received ARP packet
 786     @param new_mac - the new mac address
 787     @param mac_ip - 0: ARP resolution event, 1: MAC/IP info from L2 BDs
 788 */
 789 define ip4_arp_event
 790 {
 791   u32 client_index;
 792   u32 address;
 793   u32 pid;
 794   u32 sw_if_index;
 795   u8 new_mac[6];
 796   u8 mac_ip;
 797 };
 798
 799 service {
 800   rpc want_ip4_arp_events returns want_ip4_arp_events_reply
 801     events ip4_arp_event;
 802 };
 803
 804 /** \brief Register for IP6 ND resolution event on recieving NA reply
 805            MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs
 806     @param client_index - opaque cookie to identify the sender
 807     @param context - sender context, to match reply w/ request
 808     @param enable_disable - 1 => register for events, 0 => cancel registration
 809     @param pid - sender's pid
 810     @param address - the exact IP6 address of interested ND resolution event, or
 811                      0 to get MAC/IP info from ICMP6 NS in L2 BDs.
 812 */
 813 autoreply define want_ip6_nd_events
 814 {
 815   u32 client_index;
 816   u32 context;
 817   u8 enable_disable;
 818   u32 pid;
 819   u8 address[16];
 820 };
 821
 822 /** \brief Tell client about an IP6 ND resolution or
 823            MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs.
 824     @param client_index - opaque cookie to identify the sender
 825     @param pid - client pid registered to receive notification
 826     @param sw_if_index - interface which received ARP packet
 827     @param address - the exact ip6 address of interest
 828     @param new_mac - the new mac address
 829     @param mac_ip - 0: ND resolution event, 1: MAC/IP info from L2 BDs
 830 */
 831 define ip6_nd_event
 832 {
 833   u32 client_index;
 834   u32 pid;
 835   u32 sw_if_index;
 836   u8 address[16];
 837   u8 new_mac[6];
 838   u8 mac_ip;
 839 };
 840
 841 service {
 842   rpc want_ip6_ra_events returns want_ip6_ra_events_reply
 843     events ip6_ra_event;
 844 };
 845
 846 /** \brief Register for ip6 router advertisement events
 847     @param client_index - opaque cookie to identify the sender
 848     @param context - sender context, to match reply w/ request
 849     @param enable_disable - 1 => register for events, 0 => cancel registration
 850     @param pid - sender's pid
 851 */
 852 autoreply define want_ip6_ra_events
 853 {
 854   u32 client_index;
 855   u32 context;
 856   u8 enable_disable;
 857   u32 pid;
 858 };
 859
 860 /** \brief Struct representing RA prefix info
 861     @param dst_address - RA prefix info destination address
 862     @param dst_address_length - RA prefix info destination address length
 863     @param flags - RA prefix info flags
 864     @param valid_time - RA prefix info valid time
 865     @param preferred_time - RA prefix info preferred time
 866 */
 867 typeonly define ip6_ra_prefix_info
 868 {
 869   u8 dst_address[16];
 870   u8 dst_address_length;
 871   u8 flags;
 872   u32 valid_time;
 873   u32 preferred_time;
 874 };
 875
 876 /** \brief Tell client about a router advertisement event
 877     @param client_index - opaque cookie to identify the sender
 878     @param pid - client pid registered to receive notification
 879     @param current_hop_limit - RA current hop limit
 880     @param flags - RA flags
 881     @param router_lifetime_in_sec - RA lifetime in seconds
 882     @param neighbor_reachable_time_in_msec - RA neighbor reachable time in msec
 883     @param time_in_msec_between_retransmitted_neighbor_solicitations -
 884                time in msec between retransmitted neighbor solicitations
 885     @param n_prefixes -
 886     @param prefixes -
 887 */
 888 define ip6_ra_event
 889 {
 890   u32 client_index;
 891   u32 pid;
 892   u32 sw_if_index;
 893   u8 router_address[16];
 894   u8 current_hop_limit;
 895   u8 flags;
 896   u16 router_lifetime_in_sec;
 897   u32 neighbor_reachable_time_in_msec;
 898   u32 time_in_msec_between_retransmitted_neighbor_solicitations;
 899   u32 n_prefixes;
 900   vl_api_ip6_ra_prefix_info_t prefixes[n_prefixes];
 901 };
 902
 903 service {
 904   rpc want_ip6_nd_events returns want_ip6_nd_events_reply
 905     events ip6_nd_event;
 906 };
 907
 908 /** \brief Proxy ARP configuration type
 909     @param vrf_id - VRF / Fib table ID
 910     @param low_address[4] - Low address of the Proxy ARP range
 911     @param hi_address[4] - High address of the Proxy ARP range
 912 */
 913 typeonly define proxy_arp
 914 {
 915   u32 vrf_id;
 916   u8 low_address[4];
 917   u8 hi_address[4];
 918 };
 919
 920 /** \brief Proxy ARP add / del request
 921     @param client_index - opaque cookie to identify the sender
 922     @param context - sender context, to match reply w/ request
 923     @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
 924     @param proxy - Proxy configuration
 925 */
 926 autoreply define proxy_arp_add_del
 927 {
 928   u32 client_index;
 929   u32 context;
 930   u8 is_add;
 931   vl_api_proxy_arp_t proxy;
 932 };
 933
 934 /** \brief Proxy ARP dump request
 935  */
 936 define proxy_arp_dump
 937 {
 938   u32 client_index;
 939   u32 context;
 940 };
 941
 942 /** \brief Proxy ARP dump details reply
 943  * @param proxy - Same data as used to configure
 944  */
 945 define proxy_arp_details
 946 {
 947   u32 context;
 948   vl_api_proxy_arp_t proxy;
 949 };
 950
 951 /** \brief Proxy ARP add / del interface request
 952     @param client_index - opaque cookie to identify the sender
 953     @param context - sender context, to match reply w/ request
 954     @param sw_if_index - Which interface to enable / disable Proxy Arp on
 955     @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
 956 */
 957 autoreply define proxy_arp_intfc_enable_disable
 958 {
 959   u32 client_index;
 960   u32 context;
 961   u32 sw_if_index;
 962   /* 1 = on, 0 = off */
 963   u8 enable_disable;
 964 };
 965
 966 /** \brief Proxy ARP interface dump request
 967  */
 968 define proxy_arp_intfc_dump
 969 {
 970   u32 client_index;
 971   u32 context;
 972 };
 973
 974 /** \brief Proxy ARP interface dump details reply
 975  * @param sw_if_index The interface on which ARP proxy is enabled.
 976  */
 977 define proxy_arp_intfc_details
 978 {
 979   u32 context;
 980   u32 sw_if_index;
 981 };
 982
 983 /** \brief Reset fib table request
 984     @param client_index - opaque cookie to identify the sender
 985     @param context - sender context, to match reply w/ request
 986     @param vrf_id - vrf/table id of the fib table to reset
 987     @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
 988 */
 989 autoreply define reset_fib
 990 {
 991   u32 client_index;
 992   u32 context;
 993   u32 vrf_id;
 994   u8 is_ipv6;
 995 };
 996
 997 /** \brief Set max allowed ARP or ip6 neighbor entries request
 998     @param client_index - opaque cookie to identify the sender
 999     @param context - sender context, to match reply w/ request
1000     @param is_ipv6 - neighbor limit if non-zero, else ARP limit
1001     @param arp_neighbor_limit - the new limit, defaults are ~ 50k
1002 */
1003 autoreply define set_arp_neighbor_limit
1004 {
1005   u32 client_index;
1006   u32 context;
1007   u8 is_ipv6;
1008   u32 arp_neighbor_limit;
1009 };
1010
1011 /** \brief IOAM enable : Enable in-band OAM
1012     @param id - profile id
1013     @param seqno - To enable Seqno Processing
1014     @param analyse - Enabling analysis of iOAM at decap node
1015     @param pow_enable - Proof of Work enabled or not flag
1016     @param trace_enable - iOAM Trace enabled or not flag
1017 */
1018 autoreply define ioam_enable
1019 {
1020   u32 client_index;
1021   u32 context;
1022   u16 id;
1023   u8 seqno;
1024   u8 analyse;
1025   u8 pot_enable;
1026   u8 trace_enable;
1027   u32 node_id;
1028 };
1029
1030 /** \brief iOAM disable
1031     @param client_index - opaque cookie to identify the sender
1032     @param context - sender context, to match reply w/ request
1033     @param index - MAP Domain index
1034 */
1035 autoreply define ioam_disable
1036 {
1037   u32 client_index;
1038   u32 context;
1039   u16 id;
1040 };
1041
1042 autoreply define ip_reassembly_set
1043 {
1044   u32 client_index;
1045   u32 context;
1046   u32 timeout_ms;
1047   u32 max_reassemblies;
1048   u32 expire_walk_interval_ms;
1049   u8 is_ip6;
1050 };
1051
1052 define ip_reassembly_get
1053 {
1054   u32 client_index;
1055   u32 context;
1056   u8 is_ip6;
1057 };
1058
1059 define ip_reassembly_get_reply
1060 {
1061   u32 context;
1062   i32 retval;
1063   u32 timeout_ms;
1064   u32 max_reassemblies;
1065   u32 expire_walk_interval_ms;
1066   u8 is_ip6;
1067 };
1068
1069 /** \brief Enable/disable reassembly feature
1070     @param client_index - opaque cookie to identify the sender
1071     @param context - sender context, to match reply w/ request
1072     @param sw_if_index - interface to enable/disable feature on
1073     @param enable_ip4 - enable ip4 reassembly if non-zero, disable if 0
1074     @param enable_ip6 - enable ip6 reassembly if non-zero, disable if 0
1075 */
1076 autoreply define ip_reassembly_enable_disable
1077 {
1078   u32 client_index;
1079   u32 context;
1080   u32 sw_if_index;
1081   u8 enable_ip4;
1082   u8 enable_ip6;
1083 };
1084
1085 /*
1086  * Local Variables:
1087  * eval: (c-set-style "gnu")
1088  * End:
1089  */