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.4";
  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   u8 nh_address[16];
 450 };
 451
 452 /** \brief Dump IP multicast fib table
 453     @param client_index - opaque cookie to identify the sender
 454 */
 455 define ip_mfib_dump
 456 {
 457   u32 client_index;
 458   u32 context;
 459 };
 460
 461 /** \brief IP Multicast FIB table response
 462     @param table_id - IP fib table id
 463     @address_length - mask length
 464     @grp_address - Group address/prefix
 465     @src_address - Source address
 466     @param count - the number of fib_path in path
 467     @param path  - array of of fib_path structures
 468 */
 469 manual_endian manual_print define ip_mfib_details
 470 {
 471   u32 context;
 472   u32 table_id;
 473   u32 entry_flags;
 474   u32 rpf_id;
 475   u8  address_length;
 476   u8  grp_address[4];
 477   u8  src_address[4];
 478   u32 count;
 479   vl_api_fib_path_t path[count];
 480 };
 481
 482 /** \brief Dump IP6 multicast fib table
 483     @param client_index - opaque cookie to identify the sender
 484 */
 485 define ip6_mfib_dump
 486 {
 487   u32 client_index;
 488   u32 context;
 489 };
 490
 491 /** \brief IP6 Multicast FIB table response
 492     @param table_id - IP fib table id
 493     @address_length - mask length
 494     @grp_address - Group address/prefix
 495     @src_address - Source address
 496     @param count - the number of fib_path in path
 497     @param path  - array of of fib_path structures
 498 */
 499 manual_endian manual_print define ip6_mfib_details
 500 {
 501   u32 context;
 502   u32 table_id;
 503   u8  address_length;
 504   u8  grp_address[16];
 505   u8  src_address[16];
 506   u32 count;
 507   vl_api_fib_path_t path[count];
 508 };
 509
 510 define ip_address_details
 511 {
 512   u32 client_index;
 513   u32 context;
 514   u8 ip[16];
 515   u8 prefix_length;
 516   u32 sw_if_index;
 517   u8 is_ipv6;
 518 };
 519
 520 define ip_address_dump
 521 {
 522   u32 client_index;
 523   u32 context;
 524   u32 sw_if_index;
 525   u8 is_ipv6;
 526 };
 527
 528 /** \brief IP unnumbered configurations
 529     @param sw_if_index The interface that has unnumbered configuration
 530     @param ip_sw_if_index The IP interface that it is unnnumbered to
 531 */
 532 define ip_unnumbered_details
 533 {
 534   u32 client_index;
 535   u32 context;
 536   u32 sw_if_index;
 537   u32 ip_sw_if_index;
 538 };
 539
 540 /** \brief Dump IP unnumbered configurations
 541     @param sw_if_index ~0 for all interfaces, else the interface desired
 542 */
 543 define ip_unnumbered_dump
 544 {
 545   u32 client_index;
 546   u32 context;
 547   u32 sw_if_index;
 548 };
 549
 550 define ip_details
 551 {
 552   u32 sw_if_index;
 553   u32 context;
 554   u8 is_ipv6;
 555 };
 556
 557 define ip_dump
 558 {
 559   u32 client_index;
 560   u32 context;
 561   u8 is_ipv6;
 562 };
 563
 564 define mfib_signal_dump
 565 {
 566   u32 client_index;
 567   u32 context;
 568 };
 569
 570 define mfib_signal_details
 571 {
 572   u32 client_index;
 573   u32 context;
 574   u32 sw_if_index;
 575   u32 table_id;
 576   u16 grp_address_len;
 577   u8 grp_address[16];
 578   u8 src_address[16];
 579   u16 ip_packet_len;
 580   u8 ip_packet_data[256];
 581 };
 582
 583 /** \brief IP punt policer
 584     @param client_index - opaque cookie to identify the sender
 585     @param context - sender context, to match reply w/ request
 586     @param is_add - 1 to add neighbor, 0 to delete
 587     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 588     @param policer_index - Index of policer to use
 589 */
 590 autoreply define ip_punt_police
 591 {
 592   u32 client_index;
 593   u32 context;
 594   u32 policer_index;
 595   u8 is_add;
 596   u8 is_ip6;
 597 };
 598
 599 /** \brief IP punt redirect
 600     @param client_index - opaque cookie to identify the sender
 601     @param context - sender context, to match reply w/ request
 602     @param is_add - 1 to add neighbor, 0 to delete
 603     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 604     @param tx_sw_if_index - the TX interface to which traffic shoulde be
 605                             redirected.
 606     @param nh - The next-hop to redirect the traffic to.
 607 */
 608 autoreply define ip_punt_redirect
 609 {
 610   u32 client_index;
 611   u32 context;
 612   u32 rx_sw_if_index;
 613   u32 tx_sw_if_index;
 614   u8 is_add;
 615   u8 is_ip6;
 616   u8 nh[16];
 617 };
 618
 619 autoreply define ip_container_proxy_add_del
 620 {
 621   u32 client_index;
 622   u32 context;
 623   u8 ip[16];
 624   u8 is_ip4;
 625   u8 plen;
 626   u32 sw_if_index;
 627   u8 is_add;
 628 };
 629
 630 /** \brief Configure IP source and L4 port-range check
 631     @param client_index - opaque cookie to identify the sender
 632     @param context - sender context, to match reply w/ request
 633     @param is_ip6 - 1 if source address type is IPv6
 634     @param is_add - 1 if add, 0 if delete
 635     @param mask_length - mask length for address entry
 636     @param address - array of address bytes
 637     @param number_of_ranges - length of low_port and high_port arrays (must match)
 638     @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
 639     @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
 640     @param vrf_id - fib table/vrf id to associate the source and port-range check with
 641     @note To specify a single port set low_port and high_port entry the same
 642 */
 643 autoreply define ip_source_and_port_range_check_add_del
 644 {
 645   u32 client_index;
 646   u32 context;
 647   u8 is_ipv6;
 648   u8 is_add;
 649   u8 mask_length;
 650   u8 address[16];
 651   u8 number_of_ranges;
 652   u16 low_ports[32];
 653   u16 high_ports[32];
 654   u32 vrf_id;
 655 };
 656
 657 /** \brief Set interface source and L4 port-range request
 658     @param client_index - opaque cookie to identify the sender
 659     @param context - sender context, to match reply w/ request
 660     @param interface_id - interface index
 661     @param tcp_vrf_id - VRF associated with source and TCP port-range check
 662     @param udp_vrf_id - VRF associated with source and TCP port-range check
 663 */
 664 autoreply define ip_source_and_port_range_check_interface_add_del
 665 {
 666   u32 client_index;
 667   u32 context;
 668   u8 is_add;
 669   u32 sw_if_index;
 670   u32 tcp_in_vrf_id;
 671   u32 tcp_out_vrf_id;
 672   u32 udp_in_vrf_id;
 673   u32 udp_out_vrf_id;
 674 };
 675
 676 /** \brief Enable/disable periodic IP neighbor scan
 677     @param client_index - opaque cookie to identify the sender
 678     @param context - sender context, to match reply w/ request
 679     @param mode - 0: disable, 1: IPv4, 2: IPv6, 3: both IPv4/v6
 680     @param scan_interval - neighbor scan interval in minutes, 0: default to 1
 681     @param max_proc_time - max processing time per run in usec, 0: default to 20
 682     @param max_update - max neighbor probe/delete per run, 0: default to 10
 683     @param scan_int_delay - delay in msec to resume scan if exceed max proc
 684                             time or update, 0: default to 1
 685     @param stale_threshold - threshold in minutes for neighbor deletion,
 686                              0: default to 4*scan_interval
 687 */
 688 autoreply define ip_scan_neighbor_enable_disable
 689 {
 690   u32 client_index;
 691   u32 context;
 692   u8 mode;
 693   u8 scan_interval;
 694   u8 max_proc_time;
 695   u8 max_update;
 696   u8 scan_int_delay;
 697   u8 stale_threshold;
 698 };
 699
 700 /** \brief IP probe neighbor address on an interface by sending an
 701            ARP request (for IP4) or ICMP6 Neighbor Solicitation (for IP6)
 702     @param client_index - opaque cookie to identify the sender
 703     @param context - sender context, to match reply w/ request
 704     @param sw_if_index - interface index
 705     @param dst_address - target IP address to send IP addr resolution request
 706     @param is_ipv6 - [1|0] to indicate if address family is IPv[6|4]
 707 */
 708 autoreply define ip_probe_neighbor
 709 {
 710   u32 client_index;
 711   u32 context;
 712   u32 sw_if_index;
 713   u8 dst_address[16];
 714   u8 is_ipv6;
 715 };
 716
 717 /** \brief Register for IP4 ARP resolution event on receing ARP reply or
 718            MAC/IP info from ARP requests in L2 BDs
 719     @param client_index - opaque cookie to identify the sender
 720     @param context - sender context, to match reply w/ request
 721     @param enable_disable - 1 => register for events, 0 => cancel registration
 722     @param pid - sender's pid
 723     @param address - exact IP4 address of interested arp resolution event, or
 724                      0 to get MAC/IP info from ARP requests in BDs
 725 */
 726 autoreply define want_ip4_arp_events
 727 {
 728   u32 client_index;
 729   u32 context;
 730   u8 enable_disable;
 731   u32 pid;
 732   u32 address;
 733 };
 734
 735 /** \brief Tell client about an IP4 ARP resolution event or
 736            MAC/IP info from ARP requests in L2 BDs
 737     @param client_index - opaque cookie to identify the sender
 738     @param address - the exact ip4 address of interest
 739     @param pid - client pid registered to receive notification
 740     @param sw_if_index - interface which received ARP packet
 741     @param new_mac - the new mac address
 742     @param mac_ip - 0: ARP resolution event, 1: MAC/IP info from L2 BDs
 743 */
 744 define ip4_arp_event
 745 {
 746   u32 client_index;
 747   u32 address;
 748   u32 pid;
 749   u32 sw_if_index;
 750   u8 new_mac[6];
 751   u8 mac_ip;
 752 };
 753
 754 service {
 755   rpc want_ip4_arp_events returns want_ip4_arp_events_reply
 756     events ip4_arp_event;
 757 };
 758
 759 /** \brief Register for IP6 ND resolution event on recieving NA reply
 760            MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs
 761     @param client_index - opaque cookie to identify the sender
 762     @param context - sender context, to match reply w/ request
 763     @param enable_disable - 1 => register for events, 0 => cancel registration
 764     @param pid - sender's pid
 765     @param address - the exact IP6 address of interested ND resolution event, or
 766                      0 to get MAC/IP info from ICMP6 NS in L2 BDs.
 767 */
 768 autoreply define want_ip6_nd_events
 769 {
 770   u32 client_index;
 771   u32 context;
 772   u8 enable_disable;
 773   u32 pid;
 774   u8 address[16];
 775 };
 776
 777 /** \brief Tell client about an IP6 ND resolution or
 778            MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs.
 779     @param client_index - opaque cookie to identify the sender
 780     @param pid - client pid registered to receive notification
 781     @param sw_if_index - interface which received ARP packet
 782     @param address - the exact ip6 address of interest
 783     @param new_mac - the new mac address
 784     @param mac_ip - 0: ND resolution event, 1: MAC/IP info from L2 BDs
 785 */
 786 define ip6_nd_event
 787 {
 788   u32 client_index;
 789   u32 pid;
 790   u32 sw_if_index;
 791   u8 address[16];
 792   u8 new_mac[6];
 793   u8 mac_ip;
 794 };
 795
 796 service {
 797   rpc want_ip6_ra_events returns want_ip6_ra_events_reply
 798     events ip6_ra_event;
 799 };
 800
 801 /** \brief Register for ip6 router advertisement events
 802     @param client_index - opaque cookie to identify the sender
 803     @param context - sender context, to match reply w/ request
 804     @param enable_disable - 1 => register for events, 0 => cancel registration
 805     @param pid - sender's pid
 806 */
 807 autoreply define want_ip6_ra_events
 808 {
 809   u32 client_index;
 810   u32 context;
 811   u8 enable_disable;
 812   u32 pid;
 813 };
 814
 815 /** \brief Struct representing RA prefix info
 816     @param dst_address - RA prefix info destination address
 817     @param dst_address_length - RA prefix info destination address length
 818     @param flags - RA prefix info flags
 819     @param valid_time - RA prefix info valid time
 820     @param preferred_time - RA prefix info preferred time
 821 */
 822 typeonly define ip6_ra_prefix_info
 823 {
 824   u8 dst_address[16];
 825   u8 dst_address_length;
 826   u8 flags;
 827   u32 valid_time;
 828   u32 preferred_time;
 829 };
 830
 831 /** \brief Tell client about a router advertisement event
 832     @param client_index - opaque cookie to identify the sender
 833     @param pid - client pid registered to receive notification
 834     @param current_hop_limit - RA current hop limit
 835     @param flags - RA flags
 836     @param router_lifetime_in_sec - RA lifetime in seconds
 837     @param neighbor_reachable_time_in_msec - RA neighbor reachable time in msec
 838     @param time_in_msec_between_retransmitted_neighbor_solicitations -
 839                time in msec between retransmitted neighbor solicitations
 840     @param n_prefixes -
 841     @param prefixes -
 842 */
 843 define ip6_ra_event
 844 {
 845   u32 client_index;
 846   u32 pid;
 847   u32 sw_if_index;
 848   u8 router_address[16];
 849   u8 current_hop_limit;
 850   u8 flags;
 851   u16 router_lifetime_in_sec;
 852   u32 neighbor_reachable_time_in_msec;
 853   u32 time_in_msec_between_retransmitted_neighbor_solicitations;
 854   u32 n_prefixes;
 855   vl_api_ip6_ra_prefix_info_t prefixes[n_prefixes];
 856 };
 857
 858 service {
 859   rpc want_ip6_nd_events returns want_ip6_nd_events_reply
 860     events ip6_nd_event;
 861 };
 862
 863 /** \brief Proxy ARP add / del request
 864     @param client_index - opaque cookie to identify the sender
 865     @param context - sender context, to match reply w/ request
 866     @param vrf_id - VRF / Fib table ID
 867     @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
 868     @param low_address[4] - Low address of the Proxy ARP range
 869     @param hi_address[4] - High address of the Proxy ARP range
 870 */
 871 autoreply define proxy_arp_add_del
 872 {
 873   u32 client_index;
 874   u32 context;
 875   u32 vrf_id;
 876   u8 is_add;
 877   u8 low_address[4];
 878   u8 hi_address[4];
 879 };
 880
 881 /** \brief Proxy ARP add / del request
 882     @param client_index - opaque cookie to identify the sender
 883     @param context - sender context, to match reply w/ request
 884     @param sw_if_index - Which interface to enable / disable Proxy Arp on
 885     @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
 886 */
 887 autoreply define proxy_arp_intfc_enable_disable
 888 {
 889   u32 client_index;
 890   u32 context;
 891   u32 sw_if_index;
 892   /* 1 = on, 0 = off */
 893   u8 enable_disable;
 894 };
 895
 896 /** \brief Reset fib table request
 897     @param client_index - opaque cookie to identify the sender
 898     @param context - sender context, to match reply w/ request
 899     @param vrf_id - vrf/table id of the fib table to reset
 900     @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
 901 */
 902 autoreply define reset_fib
 903 {
 904   u32 client_index;
 905   u32 context;
 906   u32 vrf_id;
 907   u8 is_ipv6;
 908 };
 909
 910 /** \brief Set max allowed ARP or ip6 neighbor entries request
 911     @param client_index - opaque cookie to identify the sender
 912     @param context - sender context, to match reply w/ request
 913     @param is_ipv6 - neighbor limit if non-zero, else ARP limit
 914     @param arp_neighbor_limit - the new limit, defaults are ~ 50k
 915 */
 916 autoreply define set_arp_neighbor_limit
 917 {
 918   u32 client_index;
 919   u32 context;
 920   u8 is_ipv6;
 921   u32 arp_neighbor_limit;
 922 };
 923
 924 /** \brief IOAM enable : Enable in-band OAM
 925     @param id - profile id
 926     @param seqno - To enable Seqno Processing
 927     @param analyse - Enabling analysis of iOAM at decap node
 928     @param pow_enable - Proof of Work enabled or not flag
 929     @param trace_enable - iOAM Trace enabled or not flag
 930 */
 931 autoreply define ioam_enable
 932 {
 933   u32 client_index;
 934   u32 context;
 935   u16 id;
 936   u8 seqno;
 937   u8 analyse;
 938   u8 pot_enable;
 939   u8 trace_enable;
 940   u32 node_id;
 941 };
 942
 943 /** \brief iOAM disable
 944     @param client_index - opaque cookie to identify the sender
 945     @param context - sender context, to match reply w/ request
 946     @param index - MAP Domain index
 947 */
 948 autoreply define ioam_disable
 949 {
 950   u32 client_index;
 951   u32 context;
 952   u16 id;
 953 };
 954
 955 autoreply define ip_reassembly_set
 956 {
 957   u32 client_index;
 958   u32 context;
 959   u32 timeout_ms;
 960   u32 max_reassemblies;
 961   u32 expire_walk_interval_ms;
 962   u8 is_ip6;
 963 };
 964
 965 define ip_reassembly_get
 966 {
 967   u32 client_index;
 968   u32 context;
 969   u8 is_ip6;
 970 };
 971
 972 define ip_reassembly_get_reply
 973 {
 974   u32 client_index;
 975   u32 context;
 976   i32 retval;
 977   u32 timeout_ms;
 978   u32 max_reassemblies;
 979   u32 expire_walk_interval_ms;
 980   u8 is_ip6;
 981 };
 982
 983 /** \brief Enable/disable reassembly feature
 984     @param client_index - opaque cookie to identify the sender
 985     @param context - sender context, to match reply w/ request
 986     @param sw_if_index - interface to enable/disable feature on
 987     @param enable_ip4 - enable ip4 reassembly if non-zero, disable if 0
 988     @param enable_ip6 - enable ip6 reassembly if non-zero, disable if 0
 989 */
 990 autoreply define ip_reassembly_enable_disable
 991 {
 992   u32 client_index;
 993   u32 context;
 994   u32 sw_if_index;
 995   u8 enable_ip4;
 996   u8 enable_ip6;
 997 };
 998
 999 /*
1000  * Local Variables:
1001  * eval: (c-set-style "gnu")
1002  * End:
1003  */