aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/ip_session_redirect/ip_session_redirect.api
blob: 2bf2373dbd203ff068fb45ff5a8dd7b517797dde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/*
 * Copyright (c) 2021-2022 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

option version = "0.3.0";
import "vnet/interface_types.api";
import "vnet/fib/fib_types.api";

/** \brief Add or update a session redirection
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param table_index - classifier table index
    @param opaque_index - classifier session opaque index
    @param match_len - classifier session match length in bytes (max is 80-bytes)
    @param match - classifier session match
    @param is_punt - true = punted traffic, false = forwarded traffic
    @param n_paths - number of paths
    @param paths - the paths of the redirect
*/

autoreply define ip_session_redirect_add
{
  option deprecated;
  u32 client_index;
  u32 context;

  u32 table_index;
  u8 match_len;
  u8 match[80];
  u32 opaque_index [default=0xffffffff];
  bool is_punt;
  u8 n_paths;
  vl_api_fib_path_t paths[n_paths];

  option vat_help = "table <index> match <match> via <path>";
  option status="in_progress";
};

/** \brief Add or update a session redirection - version 2
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param table_index - classifier table index
    @param opaque_index - classifier session opaque index
    @param proto - protocol of forwarded packets (default autodetect from path nh)
    @param is_punt - true = punted traffic, false = forwarded traffic
    @param match_len - classifier session match length in bytes (max is 80-bytes)
    @param match - classifier session match
    @param n_paths - number of paths
    @param paths - the paths of the redirect
*/

autoreply define ip_session_redirect_add_v2
{
  u32 client_index;
  u32 context;

  u32 table_index;
  u32 opaque_index [default=0xffffffff];
  vl_api_fib_path_nh_proto_t proto [default=0xffffffff];
  bool is_punt;
  u8 match_len;
  u8 match[80];
  u8 n_paths;
  vl_api_fib_path_t paths[n_paths];

  option vat_help = "table <index> match <match> via <path>";
  option status="in_progress";
};

/** \brief Delete a session redirection
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param table_index - classifier table index
    @param match_len - classifier session match length in bytes (max is 80-bytes)
    @param match - classifier session match
*/

autoreply define ip_session_redirect_del
{
  u32 client_index;
  u32 context;

  u32 table_index;
  u8 match_len;
  u8 match[match_len];

  option vat_help = "session-index <index> table <index> match <match>";
  option status="in_progress";
};

/*
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */