src/plugins/ip_session_redirect/ip_session_redirect.api

   1 /*
   2  * Copyright (c) 2021-2022 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 = "0.3.0";
  17 import "vnet/interface_types.api";
  18 import "vnet/fib/fib_types.api";
  19
  20 /** \brief Add or update a session redirection
  21     @param client_index - opaque cookie to identify the sender
  22     @param context - sender context, to match reply w/ request
  23     @param table_index - classifier table index
  24     @param opaque_index - classifier session opaque index
  25     @param match_len - classifier session match length in bytes (max is 80-bytes)
  26     @param match - classifier session match
  27     @param is_punt - true = punted traffic, false = forwarded traffic
  28     @param n_paths - number of paths
  29     @param paths - the paths of the redirect
  30 */
  31
  32 autoreply define ip_session_redirect_add
  33 {
  34   option deprecated;
  35   u32 client_index;
  36   u32 context;
  37
  38   u32 table_index;
  39   u8 match_len;
  40   u8 match[80];
  41   u32 opaque_index [default=0xffffffff];
  42   bool is_punt;
  43   u8 n_paths;
  44   vl_api_fib_path_t paths[n_paths];
  45
  46   option vat_help = "table <index> match <match> via <path>";
  47   option status="in_progress";
  48 };
  49
  50 /** \brief Add or update a session redirection - version 2
  51     @param client_index - opaque cookie to identify the sender
  52     @param context - sender context, to match reply w/ request
  53     @param table_index - classifier table index
  54     @param opaque_index - classifier session opaque index
  55     @param proto - protocol of forwarded packets (default autodetect from path nh)
  56     @param is_punt - true = punted traffic, false = forwarded traffic
  57     @param match_len - classifier session match length in bytes (max is 80-bytes)
  58     @param match - classifier session match
  59     @param n_paths - number of paths
  60     @param paths - the paths of the redirect
  61 */
  62
  63 autoreply define ip_session_redirect_add_v2
  64 {
  65   u32 client_index;
  66   u32 context;
  67
  68   u32 table_index;
  69   u32 opaque_index [default=0xffffffff];
  70   vl_api_fib_path_nh_proto_t proto [default=0xffffffff];
  71   bool is_punt;
  72   u8 match_len;
  73   u8 match[80];
  74   u8 n_paths;
  75   vl_api_fib_path_t paths[n_paths];
  76
  77   option vat_help = "table <index> match <match> via <path>";
  78   option status="in_progress";
  79 };
  80
  81 /** \brief Delete a session redirection
  82     @param client_index - opaque cookie to identify the sender
  83     @param context - sender context, to match reply w/ request
  84     @param table_index - classifier table index
  85     @param match_len - classifier session match length in bytes (max is 80-bytes)
  86     @param match - classifier session match
  87 */
  88
  89 autoreply define ip_session_redirect_del
  90 {
  91   u32 client_index;
  92   u32 context;
  93
  94   u32 table_index;
  95   u8 match_len;
  96   u8 match[match_len];
  97
  98   option vat_help = "session-index <index> table <index> match <match>";
  99   option status="in_progress";
 100 };
 101
 102 /*
 103  * Local Variables:
 104  * eval: (c-set-style "gnu")
 105  * End:
 106  */