src/vnet/l2tp/l2tp.api

   1 /*
   2  * Copyright (c) 2015-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 option version = "1.0.0";
  17
  18 /** \brief l2tpv3 tunnel interface create request
  19     @param client_index - opaque cookie to identify the sender
  20     @param context - sender context, to match reply w/ request
  21     @param client_address - remote client tunnel ip address
  22     @param client_address - local tunnel ip address
  23     @param is_ipv6 - ipv6 if non-zero, else ipv4
  24     @param local_session_id - local tunnel session id
  25     @param remote_session_id - remote tunnel session id
  26     @param local_cookie - local tunnel cookie
  27     @param l2_sublayer_present - l2 sublayer is present in packets if non-zero
  28     @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
  29 */
  30 define l2tpv3_create_tunnel
  31 {
  32   u32 client_index;
  33   u32 context;
  34   u8 client_address[16];
  35   u8 our_address[16];
  36   u8 is_ipv6;
  37   u32 local_session_id;
  38   u32 remote_session_id;
  39   u64 local_cookie;
  40   u64 remote_cookie;
  41   u8 l2_sublayer_present;
  42   u32 encap_vrf_id;
  43 };
  44
  45 /** \brief l2tpv3 tunnel interface create response
  46     @param context - sender context, to match reply w/ request
  47     @param retval - return code for the request
  48     @param sw_if_index - index of the new tunnel interface
  49 */
  50 define l2tpv3_create_tunnel_reply
  51 {
  52   u32 context;
  53   i32 retval;
  54   u32 sw_if_index;
  55 };
  56
  57 autoreply define l2tpv3_set_tunnel_cookies
  58 {
  59   u32 client_index;
  60   u32 context;
  61   u32 sw_if_index;
  62   u64 new_local_cookie;
  63   u64 new_remote_cookie;
  64 };
  65
  66 define sw_if_l2tpv3_tunnel_details
  67 {
  68   u32 context;
  69   u32 sw_if_index;
  70   u8 interface_name[64];
  71   u8 client_address[16];
  72   u8 our_address[16];
  73   u32 local_session_id;
  74   u32 remote_session_id;
  75   u64 local_cookie[2];
  76   u64 remote_cookie;
  77   u8 l2_sublayer_present;
  78 };
  79
  80 define sw_if_l2tpv3_tunnel_dump
  81 {
  82   u32 client_index;
  83   u32 context;
  84 };
  85
  86 autoreply define l2tpv3_interface_enable_disable
  87 {
  88   u32 client_index;
  89   u32 context;
  90   u8 enable_disable;
  91   u32 sw_if_index;
  92 };
  93
  94 autoreply define l2tpv3_set_lookup_key
  95 {
  96   u32 client_index;
  97   u32 context;
  98   /* 0 = ip6 src_address, 1 = ip6 dst_address, 2 = session_id */
  99   u8 key;
 100 };
 101
 102 /*
 103  * Local Variables:
 104  * eval: (c-set-style "gnu")
 105  * End:
 106  */