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