src/vnet/ip6-nd/ip6_nd.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2018 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /** \file
  18
  19     This file defines vpp IP control-plane API messages which are generally
  20     called through a shared memory interface.
  21 */
  22
  23 option version = "1.0.0";
  24
  25 import "vnet/ip/ip_types.api";
  26 import "vnet/interface_types.api";
  27
  28 /** \brief IPv6 router advertisement config request
  29     @param client_index - opaque cookie to identify the sender
  30     @param context - sender context, to match reply w/ request
  31     @param suppress -
  32     @param managed -
  33     @param other -
  34     @param ll_option -
  35     @param send_unicast -
  36     @param cease -
  37     @param is_no -
  38     @param default_router -
  39     @param max_interval -
  40     @param min_interval -
  41     @param lifetime -
  42     @param initial_count -
  43     @param initial_interval -
  44 */
  45 autoreply define sw_interface_ip6nd_ra_config
  46 {
  47   u32 client_index;
  48   u32 context;
  49   vl_api_interface_index_t sw_if_index;
  50   u8 suppress;
  51   u8 managed;
  52   u8 other;
  53   u8 ll_option;
  54   u8 send_unicast;
  55   u8 cease;
  56   bool is_no;
  57   u8 default_router;
  58   u32 max_interval;
  59   u32 min_interval;
  60   u32 lifetime;
  61   u32 initial_count;
  62   u32 initial_interval;
  63 };
  64
  65 /** \brief IPv6 router advertisement prefix config request
  66     @param client_index - opaque cookie to identify the sender
  67     @param context - sender context, to match reply w/ request
  68     @param sw_if_index - The interface the RA prefix information is for
  69     @param prefix - The prefix to advertise
  70     @param use_default - Revert to default settings
  71     @param no_advertise - Do not advertise this prefix
  72     @param off_link - The prefix is off link (it is not configured on the interface)
  73                       Configures the L-flag, When set, indicates that this
  74                       prefix can be used for on-link determination.
  75     @param no_autoconfig - Setting for the A-flag. When
  76                            set indicates that this prefix can be used for
  77                           stateless address configuration.
  78     @param no_onlink - The prefix is not on link. Make sure this is consistent
  79                        with the off_link parameter else YMMV
  80     @param is_no - add/delete
  81     @param val_lifetime - The length of time in
  82                      seconds (relative to the time the packet is sent)
  83                      that the prefix is valid for the purpose of on-link
  84                      determination.  A value of all one bits
  85                      (0xffffffff) represents infinity
  86     @param pref_lifetime - The length of time in
  87                      seconds (relative to the time the packet is sent)
  88                      that addresses generated from the prefix via
  89                      stateless address autoconfiguration remain
  90                      preferred [ADDRCONF].  A value of all one bits
  91                      (0xffffffff) represents infinity.
  92 */
  93 autoreply define sw_interface_ip6nd_ra_prefix
  94 {
  95   u32 client_index;
  96   u32 context;
  97   vl_api_interface_index_t sw_if_index;
  98   vl_api_prefix_t prefix;
  99   bool use_default;
 100   bool no_advertise;
 101   bool off_link;
 102   bool no_autoconfig;
 103   bool no_onlink;
 104   bool is_no;
 105   u32 val_lifetime;
 106   u32 pref_lifetime;
 107 };
 108
 109 /** \brief IPv6 ND (mirror) proxy
 110     @param client_index - opaque cookie to identify the sender
 111     @param context - sender context, to match reply w/ request
 112     @param sw_if_index - The interface the host is on
 113     @param is_enable - enable or disable
 114 */
 115 autoreply define ip6nd_proxy_enable_disable
 116 {
 117   u32 client_index;
 118   u32 context;
 119   vl_api_interface_index_t sw_if_index;
 120   bool is_enable;
 121 };
 122
 123 /** \brief IPv6 ND proxy config
 124     @param client_index - opaque cookie to identify the sender
 125     @param context - sender context, to match reply w/ request
 126     @param sw_if_index - The interface the host is on
 127     @param ip - The address of the host for which to proxy for
 128     @param is_add - Adding or deleting
 129 */
 130 autoreply define ip6nd_proxy_add_del
 131 {
 132   u32 client_index;
 133   u32 context;
 134   vl_api_interface_index_t sw_if_index;
 135   bool is_add;
 136   vl_api_ip6_address_t ip;
 137 };
 138
 139 /** \brief IPv6 ND proxy details returned after request
 140     @param context - sender context, to match reply w/ request
 141     @param sw_if_index - The interface the host is on
 142     @param ip - The address of the host for which to proxy for
 143 */
 144 define ip6nd_proxy_details
 145 {
 146   u32 context;
 147   vl_api_interface_index_t sw_if_index;
 148   vl_api_ip6_address_t ip;
 149 };
 150
 151 /** \brief IPv6 ND proxy dump request
 152     @param context - sender context, to match reply w/ request
 153 */
 154 define ip6nd_proxy_dump
 155 {
 156   u32 client_index;
 157   u32 context;
 158 };
 159
 160 /** \brief Start / stop sending router solicitation
 161     @param client_index - opaque cookie to identify the sender
 162     @param context - sender context, to match reply w/ request
 163     @param irt - initial retransmission time
 164     @param mrt - maximum retransmission time
 165     @param mrc - maximum retransmission count
 166     @param mrd - maximum retransmission duration
 167     @param sw_if_index - software interface index of interface
 168                          for sending router solicitation
 169     @param stop - if non-zero then stop sending router solicitation,
 170                   otherwise start sending router solicitation
 171 */
 172 autoreply define ip6nd_send_router_solicitation
 173 {
 174   u32 client_index;
 175   u32 context;
 176   u32 irt;
 177   u32 mrt;
 178   u32 mrc;
 179   u32 mrd;
 180   vl_api_interface_index_t sw_if_index;
 181   bool stop;
 182 };
 183
 184 service {
 185   rpc want_ip6_ra_events returns want_ip6_ra_events_reply
 186     events ip6_ra_event;
 187 };
 188
 189 /** \brief Register for ip6 router advertisement events
 190     @param client_index - opaque cookie to identify the sender
 191     @param context - sender context, to match reply w/ request
 192     @param enable - 1 => register for events, 0 => cancel registration
 193     @param pid - sender's pid
 194 */
 195 autoreply define want_ip6_ra_events
 196 {
 197   u32 client_index;
 198   u32 context;
 199   bool enable;
 200   u32 pid;
 201 };
 202
 203 /** \brief Struct representing RA prefix info
 204     @param prefix - RA prefix info destination address
 205     @param flags - RA prefix info flags
 206     @param valid_time - RA prefix info valid time
 207     @param preferred_time - RA prefix info preferred time
 208 */
 209 typedef ip6_ra_prefix_info
 210 {
 211   vl_api_prefix_t prefix;
 212   u8 flags;
 213   u32 valid_time;
 214   u32 preferred_time;
 215 };
 216
 217 /** \brief Tell client about a router advertisement event
 218     @param client_index - opaque cookie to identify the sender
 219     @param pid - client pid registered to receive notification
 220     @param current_hop_limit - RA current hop limit
 221     @param flags - RA flags
 222     @param router_lifetime_in_sec - RA lifetime in seconds
 223     @param router_addr - The router's address
 224     @param neighbor_reachable_time_in_msec - RA neighbor reachable time in msec
 225     @param time_in_msec_between_retransmitted_neighbor_solicitations -
 226                time in msec between retransmitted neighbor solicitations
 227     @param n_prefixes -
 228     @param prefixes -
 229 */
 230 define ip6_ra_event
 231 {
 232   u32 client_index;
 233   u32 pid;
 234   vl_api_interface_index_t sw_if_index;
 235   vl_api_ip6_address_t router_addr;
 236   u8 current_hop_limit;
 237   u8 flags;
 238   u16 router_lifetime_in_sec;
 239   u32 neighbor_reachable_time_in_msec;
 240   u32 time_in_msec_between_retransmitted_neighbor_solicitations;
 241   u32 n_prefixes;
 242   vl_api_ip6_ra_prefix_info_t prefixes[n_prefixes];
 243 };
 244
 245
 246 /*
 247  * Local Variables:
 248  * eval: (c-set-style "gnu")
 249  * End:
 250  */