vnet/vnet/ipsec-gre/ipsec_gre.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 /** \brief Add / del ipsec gre tunnel request
  17     @param client_index - opaque cookie to identify the sender
  18     @param context - sender context, to match reply w/ request
  19     @param local_sa_id - local SA id
  20     @param remote_sa_id - remote SA id
  21     @param is_add - 1 if adding the tunnel, 0 if deleting
  22     @param src_address - tunnel source address
  23     @param dst_address - tunnel destination address
  24 */
  25 define ipsec_gre_add_del_tunnel {
  26     u32 client_index;
  27     u32 context;
  28     u32 local_sa_id;
  29     u32 remote_sa_id;
  30     u8 is_add;
  31     u8 src_address[4];
  32     u8 dst_address[4];
  33 };
  34
  35 /** \brief Reply for add / del ipsec gre tunnel request
  36     @param context - returned sender context, to match reply w/ request
  37     @param retval - return code
  38     @param sw_if_index - software index of the new ipsec gre tunnel
  39 */
  40 define ipsec_gre_add_del_tunnel_reply {
  41     u32 context;
  42     i32 retval;
  43     u32 sw_if_index;
  44 };
  45
  46 /** \brief Dump ipsec gre tunnel table
  47     @param client_index - opaque cookie to identify the sender
  48     @param context - sender context, to match reply w/ request
  49     @param tunnel_index - gre tunnel identifier or -1 in case of all tunnels
  50 */
  51 define ipsec_gre_tunnel_dump {
  52     u32 client_index;
  53     u32 context;
  54     u32 sw_if_index;
  55 };
  56
  57 /** \brief ipsec gre tunnel operational state response
  58     @param context - returned sender context, to match reply w/ request
  59     @param sw_if_index - software index of the ipsec gre tunnel
  60     @param local_sa_id - local SA id
  61     @param remote_sa_id - remote SA id
  62     @param src_address - tunnel source address
  63     @param dst_address - tunnel destination address
  64 */
  65 define ipsec_gre_tunnel_details {
  66     u32 context;
  67     u32 sw_if_index;
  68     u32 local_sa_id;
  69     u32 remote_sa_id;
  70     u8 src_address[4];
  71     u8 dst_address[4];
  72 };
  73
  74 /*
  75  * Local Variables:
  76  * eval: (c-set-style "gnu")
  77  * End:
  78  */
  79