src/vnet/ip/ip.api

   1 /*
   2  * Copyright (c) 2016 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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 /** \file
  17
  18     This file defines vpp IP control-plane API messages which are generally
  19     called through a shared memory interface.
  20 */
  21
  22 option version = "1.2.2";
  23 import "vnet/fib/fib_types.api";
  24
  25 /** \brief Add / del table request
  26            A table can be added multiple times, but need be deleted only once.
  27     @param client_index - opaque cookie to identify the sender
  28     @param context - sender context, to match reply w/ request
  29     @param is_ipv6 - V4 or V6 table
  30     @param table_id - table ID associated with the route
  31                       This table ID will apply to both the unicats
  32                       and mlticast FIBs
  33     @param name - A client provided name/tag for the table. If this is
  34                   not set by the client, then VPP will generate something
  35                   meaningfull.
  36 */
  37 autoreply define ip_table_add_del
  38 {
  39   u32 client_index;
  40   u32 context;
  41   u32 table_id;
  42   u8 is_ipv6;
  43   u8 is_add;
  44   u8 name[64];
  45 };
  46
  47 /** \brief Dump IP fib table
  48     @param client_index - opaque cookie to identify the sender
  49 */
  50 define ip_fib_dump
  51 {
  52   u32 client_index;
  53   u32 context;
  54 };
  55
  56 /** \brief IP FIB table response
  57     @param table_id - IP fib table id
  58     @address_length - mask length
  59     @address - ip4 prefix
  60     @param count - the number of fib_path in path
  61     @param path  - array of of fib_path structures
  62 */
  63 manual_endian manual_print define ip_fib_details
  64 {
  65   u32 context;
  66   u32 table_id;
  67   u8  table_name[64];
  68   u8  address_length;
  69   u8  address[4];
  70   u32 count;
  71   vl_api_fib_path_t path[count];
  72 };
  73
  74 /** \brief Dump IP6 fib table
  75     @param client_index - opaque cookie to identify the sender
  76 */
  77 define ip6_fib_dump
  78 {
  79   u32 client_index;
  80   u32 context;
  81 };
  82
  83 /** \brief IP6 FIB table entry response
  84     @param table_id - IP6 fib table id
  85     @param address_length - mask length
  86     @param address - ip6 prefix
  87     @param count - the number of fib_path in path
  88     @param path  - array of of fib_path structures
  89 */
  90 manual_endian manual_print define ip6_fib_details
  91 {
  92   u32 context;
  93   u32 table_id;
  94   u8  table_name[64];
  95   u8  address_length;
  96   u8  address[16];
  97   u32 count;
  98   vl_api_fib_path_t path[count];
  99 };
 100
 101 /** \brief Dump IP neighboors
 102     @param client_index - opaque cookie to identify the sender
 103     @param context - sender context, to match reply w/ request
 104     @param sw_if_index - the interface to dump neighboors, ~0 == all
 105     @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
 106 */
 107 define ip_neighbor_dump
 108 {
 109     u32 client_index;
 110     u32 context;
 111     u32 sw_if_index;
 112     u8  is_ipv6;
 113 };
 114
 115 /** \brief IP neighboors dump response
 116     @param context - sender context which was passed in the request
 117     @param sw_if_index - The interface used to reach the neighbor
 118     @param is_static - [1|0] to indicate if neighbor is statically configured
 119     @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
 120 */
 121 define ip_neighbor_details {
 122     u32 context;
 123     u32 sw_if_index;
 124     u8  is_static;
 125     u8  is_ipv6;
 126     u8  mac_address[6];
 127     u8  ip_address[16];
 128 };
 129
 130 /** \brief IP neighbor add / del request
 131     @param client_index - opaque cookie to identify the sender
 132     @param context - sender context, to match reply w/ request
 133     @param sw_if_index - interface used to reach neighbor
 134     @param is_add - 1 to add neighbor, 0 to delete
 135     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 136     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 137     @param is_static - A static neighbor Entry - there are not flushed
 138                        If the interface goes down.
 139     @param is_no_adj_fib - Do not create a corresponding entry in the FIB
 140                            table for the neighbor.
 141     @param mac_address - l2 address of the neighbor
 142     @param dst_address - ip4 or ip6 address of the neighbor
 143 */
 144 autoreply define ip_neighbor_add_del
 145 {
 146   u32 client_index;
 147   u32 context;
 148   u32 sw_if_index;
 149   /* 1 = add, 0 = delete */
 150   u8 is_add;
 151   u8 is_ipv6;
 152   u8 is_static;
 153   u8 is_no_adj_fib;
 154   u8 mac_address[6];
 155   u8 dst_address[16];
 156 };
 157
 158 /** \brief Set the ip flow hash config for a fib request
 159     @param client_index - opaque cookie to identify the sender
 160     @param context - sender context, to match reply w/ request
 161     @param vrf_id - vrf/fib id
 162     @param is_ipv6 - if non-zero the fib is ip6, else ip4
 163     @param src - if non-zero include src in flow hash
 164     @param dst - if non-zero include dst in flow hash
 165     @param sport - if non-zero include sport in flow hash
 166     @param dport - if non-zero include dport in flow hash
 167     @param proto -if non-zero include proto in flow hash
 168     @param reverse - if non-zero include reverse in flow hash
 169 */
 170 autoreply define set_ip_flow_hash
 171 {
 172   u32 client_index;
 173   u32 context;
 174   u32 vrf_id;
 175   u8 is_ipv6;
 176   u8 src;
 177   u8 dst;
 178   u8 sport;
 179   u8 dport;
 180   u8 proto;
 181   u8 reverse;
 182 };
 183
 184 /** \brief IPv6 router advertisement config request
 185     @param client_index - opaque cookie to identify the sender
 186     @param context - sender context, to match reply w/ request
 187     @param suppress -
 188     @param managed -
 189     @param other -
 190     @param ll_option -
 191     @param send_unicast -
 192     @param cease -
 193     @param is_no -
 194     @param default_router -
 195     @param max_interval -
 196     @param min_interval -
 197     @param lifetime -
 198     @param initial_count -
 199     @param initial_interval -
 200 */
 201 autoreply define sw_interface_ip6nd_ra_config
 202 {
 203   u32 client_index;
 204   u32 context;
 205   u32 sw_if_index;
 206   u8 suppress;
 207   u8 managed;
 208   u8 other;
 209   u8 ll_option;
 210   u8 send_unicast;
 211   u8 cease;
 212   u8 is_no;
 213   u8 default_router;
 214   u32 max_interval;
 215   u32 min_interval;
 216   u32 lifetime;
 217   u32 initial_count;
 218   u32 initial_interval;
 219 };
 220
 221 /** \brief IPv6 router advertisement prefix config request
 222     @param client_index - opaque cookie to identify the sender
 223     @param context - sender context, to match reply w/ request
 224     @param sw_if_index - The interface the RA prefix information is for
 225     @param address[] - The prefix to advertise
 226     @param address_length - the prefix length
 227     @param use_default - Revert to default settings
 228     @param no_advertise - Do not advertise this prefix
 229     @param off_link - The prefix is off link (it is not configured on the interface)
 230                       Configures the L-flag, When set, indicates that this
 231                       prefix can be used for on-link determination.
 232     @param no_autoconfig - Setting for the A-flag. When
 233                            set indicates that this prefix can be used for
 234                           stateless address configuration.
 235     @param no_onlink - The prefix is not on link. Make sure this is consistent
 236                        with the off_link parameter else YMMV
 237     @param is_no - add/delete
 238     @param val_lifetime - The length of time in
 239                      seconds (relative to the time the packet is sent)
 240                      that the prefix is valid for the purpose of on-link
 241                      determination.  A value of all one bits
 242                      (0xffffffff) represents infinity
 243     @param pref_lifetime - The length of time in
 244                      seconds (relative to the time the packet is sent)
 245                      that addresses generated from the prefix via
 246                      stateless address autoconfiguration remain
 247                      preferred [ADDRCONF].  A value of all one bits
 248                      (0xffffffff) represents infinity.
 249 */
 250 autoreply define sw_interface_ip6nd_ra_prefix
 251 {
 252   u32 client_index;
 253   u32 context;
 254   u32 sw_if_index;
 255   u8 address[16];
 256   u8 address_length;
 257   u8 use_default;
 258   u8 no_advertise;
 259   u8 off_link;
 260   u8 no_autoconfig;
 261   u8 no_onlink;
 262   u8 is_no;
 263   u32 val_lifetime;
 264   u32 pref_lifetime;
 265 };
 266
 267 /** \brief IPv6 ND proxy config
 268     @param client_index - opaque cookie to identify the sender
 269     @param context - sender context, to match reply w/ request
 270     @param sw_if_index - The interface the host is on
 271     @param address - The address of the host for which to proxy for
 272     @param is_add - Adding or deleting
 273 */
 274 autoreply define ip6nd_proxy_add_del
 275 {
 276   u32 client_index;
 277   u32 context;
 278   u32 sw_if_index;
 279   u8 is_del;
 280   u8 address[16];
 281 };
 282
 283 /** \brief IPv6 ND proxy details returned after request
 284     @param context - sender context, to match reply w/ request
 285     @param retval - return code for the request
 286 */
 287 define ip6nd_proxy_details
 288 {
 289   u32 client_index;
 290   u32 context;
 291   u32 sw_if_index;
 292   u8 address[16];
 293 };
 294
 295 /** \brief IPv6 ND proxy dump request
 296     @param context - sender context, to match reply w/ request
 297     @param retval - return code for the request
 298     @param sw_if_index - The interface the host is on
 299     @param address - The address of the host for which to proxy for
 300 */
 301 define ip6nd_proxy_dump
 302 {
 303   u32 client_index;
 304   u32 context;
 305 };
 306
 307 /** \brief Start / stop sending router solicitation
 308     @param client_index - opaque cookie to identify the sender
 309     @param context - sender context, to match reply w/ request
 310     @param irt - initial retransmission time
 311     @param mrt - maximum retransmission time
 312     @param mrc - maximum retransmission count
 313     @param mrd - maximum retransmission duration
 314     @param sw_if_index - software interface index of interface
 315                          for sending router solicitation
 316     @param stop - if non-zero then stop sending router solicitation,
 317                   otherwise start sending router solicitation
 318 */
 319 autoreply define ip6nd_send_router_solicitation
 320 {
 321   u32 client_index;
 322   u32 context;
 323   u32 irt;
 324   u32 mrt;
 325   u32 mrc;
 326   u32 mrd;
 327   u32 sw_if_index;
 328   u8 stop;
 329 };
 330
 331 /** \brief IPv6 interface enable / disable request
 332     @param client_index - opaque cookie to identify the sender
 333     @param context - sender context, to match reply w/ request
 334     @param sw_if_index - interface used to reach neighbor
 335     @param enable - if non-zero enable ip6 on interface, else disable
 336 */
 337 autoreply define sw_interface_ip6_enable_disable
 338 {
 339   u32 client_index;
 340   u32 context;
 341   u32 sw_if_index;
 342   u8 enable;                    /* set to true if enable */
 343 };
 344
 345 /** \brief IPv6 set link local address on interface 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 to set link local on
 349     @param address[] - the new link local address
 350 */
 351 autoreply define sw_interface_ip6_set_link_local_address
 352 {
 353   u32 client_index;
 354   u32 context;
 355   u32 sw_if_index;
 356   u8 address[16];
 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 autoreply 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 /** \brief Add / del route request
 425     @param client_index - opaque cookie to identify the sender
 426     @param context - sender context, to match reply w/ request
 427     @param sw_if_index - software index of the new vlan's parent interface
 428     @param vrf_id - fib table /vrf associated with the route
 429     @param next_hop_afi - Use dpo_proto_t
 430     FIXME
 431 */
 432 autoreply define ip_mroute_add_del
 433 {
 434   u32 client_index;
 435   u32 context;
 436   u32 next_hop_sw_if_index;
 437   u32 table_id;
 438   u32 entry_flags;
 439   u32 itf_flags;
 440   u32 rpf_id;
 441   u32 bier_imp;
 442   u16 grp_address_length;
 443   u8 next_hop_afi;
 444   u8 is_add;
 445   u8 is_ipv6;
 446   u8 is_local;
 447   u8 grp_address[16];
 448   u8 src_address[16];
 449 };
 450
 451 /** \brief Dump IP multicast fib table
 452     @param client_index - opaque cookie to identify the sender
 453 */
 454 define ip_mfib_dump
 455 {
 456   u32 client_index;
 457   u32 context;
 458 };
 459
 460 /** \brief IP Multicast FIB table response
 461     @param table_id - IP fib table id
 462     @address_length - mask length
 463     @grp_address - Group address/prefix
 464     @src_address - Source address
 465     @param count - the number of fib_path in path
 466     @param path  - array of of fib_path structures
 467 */
 468 manual_endian manual_print define ip_mfib_details
 469 {
 470   u32 context;
 471   u32 table_id;
 472   u32 entry_flags;
 473   u32 rpf_id;
 474   u8  address_length;
 475   u8  grp_address[4];
 476   u8  src_address[4];
 477   u32 count;
 478   vl_api_fib_path_t path[count];
 479 };
 480
 481 /** \brief Dump IP6 multicast fib table
 482     @param client_index - opaque cookie to identify the sender
 483 */
 484 define ip6_mfib_dump
 485 {
 486   u32 client_index;
 487   u32 context;
 488 };
 489
 490 /** \brief IP6 Multicast FIB table response
 491     @param table_id - IP fib table id
 492     @address_length - mask length
 493     @grp_address - Group address/prefix
 494     @src_address - Source address
 495     @param count - the number of fib_path in path
 496     @param path  - array of of fib_path structures
 497 */
 498 manual_endian manual_print define ip6_mfib_details
 499 {
 500   u32 context;
 501   u32 table_id;
 502   u8  address_length;
 503   u8  grp_address[16];
 504   u8  src_address[16];
 505   u32 count;
 506   vl_api_fib_path_t path[count];
 507 };
 508
 509 define ip_address_details
 510 {
 511   u32 client_index;
 512   u32 context;
 513   u8 ip[16];
 514   u8 prefix_length;
 515   u32 sw_if_index;
 516   u8 is_ipv6;
 517 };
 518
 519 define ip_address_dump
 520 {
 521   u32 client_index;
 522   u32 context;
 523   u32 sw_if_index;
 524   u8 is_ipv6;
 525 };
 526
 527 define ip_details
 528 {
 529   u32 sw_if_index;
 530   u32 context;
 531   u8 is_ipv6;
 532 };
 533
 534 define ip_dump
 535 {
 536   u32 client_index;
 537   u32 context;
 538   u8 is_ipv6;
 539 };
 540
 541 define mfib_signal_dump
 542 {
 543   u32 client_index;
 544   u32 context;
 545 };
 546
 547 define mfib_signal_details
 548 {
 549   u32 client_index;
 550   u32 context;
 551   u32 sw_if_index;
 552   u32 table_id;
 553   u16 grp_address_len;
 554   u8 grp_address[16];
 555   u8 src_address[16];
 556   u16 ip_packet_len;
 557   u8 ip_packet_data[256];
 558 };
 559
 560 /** \brief IP punt policer
 561     @param client_index - opaque cookie to identify the sender
 562     @param context - sender context, to match reply w/ request
 563     @param is_add - 1 to add neighbor, 0 to delete
 564     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 565     @param policer_index - Index of policer to use
 566 */
 567 autoreply define ip_punt_police
 568 {
 569   u32 client_index;
 570   u32 context;
 571   u32 policer_index;
 572   u8 is_add;
 573   u8 is_ip6;
 574 };
 575
 576 /** \brief IP punt redirect
 577     @param client_index - opaque cookie to identify the sender
 578     @param context - sender context, to match reply w/ request
 579     @param is_add - 1 to add neighbor, 0 to delete
 580     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 581     @param tx_sw_if_index - the TX interface to which traffic shoulde be
 582                             redirected.
 583     @param nh - The next-hop to redirect the traffic to.
 584 */
 585 autoreply define ip_punt_redirect
 586 {
 587   u32 client_index;
 588   u32 context;
 589   u32 rx_sw_if_index;
 590   u32 tx_sw_if_index;
 591   u8 is_add;
 592   u8 is_ip6;
 593   u8 nh[16];
 594 };
 595
 596 autoreply define ip_container_proxy_add_del
 597 {
 598   u32 client_index;
 599   u32 context;
 600   u8 ip[16];
 601   u8 is_ip4;
 602   u8 plen;
 603   u32 sw_if_index;
 604   u8 is_add;
 605 };
 606
 607 /** \brief Configure IP source and L4 port-range check
 608     @param client_index - opaque cookie to identify the sender
 609     @param context - sender context, to match reply w/ request
 610     @param is_ip6 - 1 if source address type is IPv6
 611     @param is_add - 1 if add, 0 if delete
 612     @param mask_length - mask length for address entry
 613     @param address - array of address bytes
 614     @param number_of_ranges - length of low_port and high_port arrays (must match)
 615     @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
 616     @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
 617     @param vrf_id - fib table/vrf id to associate the source and port-range check with
 618     @note To specify a single port set low_port and high_port entry the same
 619 */
 620 autoreply define ip_source_and_port_range_check_add_del
 621 {
 622   u32 client_index;
 623   u32 context;
 624   u8 is_ipv6;
 625   u8 is_add;
 626   u8 mask_length;
 627   u8 address[16];
 628   u8 number_of_ranges;
 629   u16 low_ports[32];
 630   u16 high_ports[32];
 631   u32 vrf_id;
 632 };
 633
 634 /** \brief Set interface source and L4 port-range request
 635     @param client_index - opaque cookie to identify the sender
 636     @param context - sender context, to match reply w/ request
 637     @param interface_id - interface index
 638     @param tcp_vrf_id - VRF associated with source and TCP port-range check
 639     @param udp_vrf_id - VRF associated with source and TCP port-range check
 640 */
 641 autoreply define ip_source_and_port_range_check_interface_add_del
 642 {
 643   u32 client_index;
 644   u32 context;
 645   u8 is_add;
 646   u32 sw_if_index;
 647   u32 tcp_in_vrf_id;
 648   u32 tcp_out_vrf_id;
 649   u32 udp_in_vrf_id;
 650   u32 udp_out_vrf_id;
 651 };
 652
 653 /** \brief IP probe neighbor address on an interface by sending an
 654            ARP request (for IP4) or ICMP6 Neighbor Solicitation (for IP6)
 655     @param client_index - opaque cookie to identify the sender
 656     @param context - sender context, to match reply w/ request
 657     @param sw_if_index - interface index
 658     @param dst_address - target IP address to send IP addr resolution request
 659     @param is_ipv6 - [1|0] to indicate if address family is IPv[6|4]
 660 */
 661 autoreply define ip_probe_neighbor
 662 {
 663   u32 client_index;
 664   u32 context;
 665   u32 sw_if_index;
 666   u8 dst_address[16];
 667   u8 is_ipv6;
 668 };
 669
 670 /** \brief Register for IP4 ARP resolution event on receing ARP reply or
 671            MAC/IP info from ARP requests in L2 BDs
 672     @param client_index - opaque cookie to identify the sender
 673     @param context - sender context, to match reply w/ request
 674     @param enable_disable - 1 => register for events, 0 => cancel registration
 675     @param pid - sender's pid
 676     @param address - exact IP4 address of interested arp resolution event, or
 677                      0 to get MAC/IP info from ARP requests in BDs
 678 */
 679 autoreply define want_ip4_arp_events
 680 {
 681   u32 client_index;
 682   u32 context;
 683   u8 enable_disable;
 684   u32 pid;
 685   u32 address;
 686 };
 687
 688 /** \brief Tell client about an IP4 ARP resolution event or
 689            MAC/IP info from ARP requests in L2 BDs
 690     @param client_index - opaque cookie to identify the sender
 691     @param address - the exact ip4 address of interest
 692     @param pid - client pid registered to receive notification
 693     @param sw_if_index - interface which received ARP packet
 694     @param new_mac - the new mac address
 695     @param mac_ip - 0: ARP resolution event, 1: MAC/IP info from L2 BDs
 696 */
 697 define ip4_arp_event
 698 {
 699   u32 client_index;
 700   u32 address;
 701   u32 pid;
 702   u32 sw_if_index;
 703   u8 new_mac[6];
 704   u8 mac_ip;
 705 };
 706
 707 service {
 708   rpc want_ip4_arp_events returns want_ip4_arp_events_reply
 709     events ip4_arp_event;
 710 };
 711
 712 /** \brief Register for IP6 ND resolution event on recieving NA reply
 713            MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs
 714     @param client_index - opaque cookie to identify the sender
 715     @param context - sender context, to match reply w/ request
 716     @param enable_disable - 1 => register for events, 0 => cancel registration
 717     @param pid - sender's pid
 718     @param address - the exact IP6 address of interested ND resolution event, or
 719                      0 to get MAC/IP info from ICMP6 NS in L2 BDs.
 720 */
 721 autoreply define want_ip6_nd_events
 722 {
 723   u32 client_index;
 724   u32 context;
 725   u8 enable_disable;
 726   u32 pid;
 727   u8 address[16];
 728 };
 729
 730 /** \brief Tell client about an IP6 ND resolution or
 731            MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs.
 732     @param client_index - opaque cookie to identify the sender
 733     @param pid - client pid registered to receive notification
 734     @param sw_if_index - interface which received ARP packet
 735     @param address - the exact ip6 address of interest
 736     @param new_mac - the new mac address
 737     @param mac_ip - 0: ND resolution event, 1: MAC/IP info from L2 BDs
 738 */
 739 define ip6_nd_event
 740 {
 741   u32 client_index;
 742   u32 pid;
 743   u32 sw_if_index;
 744   u8 address[16];
 745   u8 new_mac[6];
 746   u8 mac_ip;
 747 };
 748
 749 service {
 750   rpc want_ip6_ra_events returns want_ip6_ra_events_reply
 751     events ip6_ra_event;
 752 };
 753
 754 /** \brief Register for ip6 router advertisement events
 755     @param client_index - opaque cookie to identify the sender
 756     @param context - sender context, to match reply w/ request
 757     @param enable_disable - 1 => register for events, 0 => cancel registration
 758     @param pid - sender's pid
 759 */
 760 autoreply define want_ip6_ra_events
 761 {
 762   u32 client_index;
 763   u32 context;
 764   u8 enable_disable;
 765   u32 pid;
 766 };
 767
 768 /** \brief Struct representing RA prefix info
 769     @param dst_address - RA prefix info destination address
 770     @param dst_address_length - RA prefix info destination address length
 771     @param flags - RA prefix info flags
 772     @param valid_time - RA prefix info valid time
 773     @param preferred_time - RA prefix info preferred time
 774 */
 775 typeonly define ip6_ra_prefix_info
 776 {
 777   u8 dst_address[16];
 778   u8 dst_address_length;
 779   u8 flags;
 780   u32 valid_time;
 781   u32 preferred_time;
 782 };
 783
 784 /** \brief Tell client about a router advertisement event
 785     @param client_index - opaque cookie to identify the sender
 786     @param pid - client pid registered to receive notification
 787     @param current_hop_limit - RA current hop limit
 788     @param flags - RA flags
 789     @param router_lifetime_in_sec - RA lifetime in seconds
 790     @param neighbor_reachable_time_in_msec - RA neighbor reachable time in msec
 791     @param time_in_msec_between_retransmitted_neighbor_solicitations -
 792                time in msec between retransmitted neighbor solicitations
 793     @param n_prefixes -
 794     @param prefixes -
 795 */
 796 define ip6_ra_event
 797 {
 798   u32 client_index;
 799   u32 pid;
 800   u32 sw_if_index;
 801   u8 router_address[16];
 802   u8 current_hop_limit;
 803   u8 flags;
 804   u16 router_lifetime_in_sec;
 805   u32 neighbor_reachable_time_in_msec;
 806   u32 time_in_msec_between_retransmitted_neighbor_solicitations;
 807   u32 n_prefixes;
 808   vl_api_ip6_ra_prefix_info_t prefixes[n_prefixes];
 809 };
 810
 811 service {
 812   rpc want_ip6_nd_events returns want_ip6_nd_events_reply
 813     events ip6_nd_event;
 814 };
 815
 816 /** \brief Proxy ARP add / del request
 817     @param client_index - opaque cookie to identify the sender
 818     @param context - sender context, to match reply w/ request
 819     @param vrf_id - VRF / Fib table ID
 820     @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
 821     @param low_address[4] - Low address of the Proxy ARP range
 822     @param hi_address[4] - High address of the Proxy ARP range
 823 */
 824 autoreply define proxy_arp_add_del
 825 {
 826   u32 client_index;
 827   u32 context;
 828   u32 vrf_id;
 829   u8 is_add;
 830   u8 low_address[4];
 831   u8 hi_address[4];
 832 };
 833
 834 /** \brief Proxy ARP add / del request
 835     @param client_index - opaque cookie to identify the sender
 836     @param context - sender context, to match reply w/ request
 837     @param sw_if_index - Which interface to enable / disable Proxy Arp on
 838     @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
 839 */
 840 autoreply define proxy_arp_intfc_enable_disable
 841 {
 842   u32 client_index;
 843   u32 context;
 844   u32 sw_if_index;
 845   /* 1 = on, 0 = off */
 846   u8 enable_disable;
 847 };
 848
 849 /** \brief Reset fib table request
 850     @param client_index - opaque cookie to identify the sender
 851     @param context - sender context, to match reply w/ request
 852     @param vrf_id - vrf/table id of the fib table to reset
 853     @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
 854 */
 855 autoreply define reset_fib
 856 {
 857   u32 client_index;
 858   u32 context;
 859   u32 vrf_id;
 860   u8 is_ipv6;
 861 };
 862
 863 /** \brief Set max allowed ARP or ip6 neighbor entries request
 864     @param client_index - opaque cookie to identify the sender
 865     @param context - sender context, to match reply w/ request
 866     @param is_ipv6 - neighbor limit if non-zero, else ARP limit
 867     @param arp_neighbor_limit - the new limit, defaults are ~ 50k
 868 */
 869 autoreply define set_arp_neighbor_limit
 870 {
 871   u32 client_index;
 872   u32 context;
 873   u8 is_ipv6;
 874   u32 arp_neighbor_limit;
 875 };
 876
 877 /** \brief IOAM enable : Enable in-band OAM
 878     @param id - profile id
 879     @param seqno - To enable Seqno Processing
 880     @param analyse - Enabling analysis of iOAM at decap node
 881     @param pow_enable - Proof of Work enabled or not flag
 882     @param trace_enable - iOAM Trace enabled or not flag
 883 */
 884 autoreply define ioam_enable
 885 {
 886   u32 client_index;
 887   u32 context;
 888   u16 id;
 889   u8 seqno;
 890   u8 analyse;
 891   u8 pot_enable;
 892   u8 trace_enable;
 893   u32 node_id;
 894 };
 895
 896 /** \brief iOAM disable
 897     @param client_index - opaque cookie to identify the sender
 898     @param context - sender context, to match reply w/ request
 899     @param index - MAP Domain index
 900 */
 901 autoreply define ioam_disable
 902 {
 903   u32 client_index;
 904   u32 context;
 905   u16 id;
 906 };
 907
 908 autoreply define ip_reassembly_set
 909 {
 910   u32 client_index;
 911   u32 context;
 912   u32 timeout_ms;
 913   u32 max_reassemblies;
 914   u32 expire_walk_interval_ms;
 915   u8 is_ip6;
 916 };
 917
 918 define ip_reassembly_get
 919 {
 920   u32 client_index;
 921   u32 context;
 922   u8 is_ip6;
 923 };
 924
 925 define ip_reassembly_get_reply
 926 {
 927   u32 client_index;
 928   u32 context;
 929   i32 retval;
 930   u32 timeout_ms;
 931   u32 max_reassemblies;
 932   u32 expire_walk_interval_ms;
 933   u8 is_ip6;
 934 };
 935
 936 /** \brief Enable/disable reassembly feature
 937     @param client_index - opaque cookie to identify the sender
 938     @param context - sender context, to match reply w/ request
 939     @param sw_if_index - interface to enable/disable feature on
 940     @param enable_ip4 - enable ip4 reassembly if non-zero, disable if 0
 941     @param enable_ip6 - enable ip6 reassembly if non-zero, disable if 0
 942 */
 943 autoreply define ip_reassembly_enable_disable
 944 {
 945   u32 client_index;
 946   u32 context;
 947   u32 sw_if_index;
 948   u8 enable_ip4;
 949   u8 enable_ip6;
 950 };
 951
 952 /*
 953  * Local Variables:
 954  * eval: (c-set-style "gnu")
 955  * End:
 956  */