Files
vpp/src/plugins/ip_session_redirect/ip_session_redirect.api
Benoît Ganne 83e73709c3 ip_session_redirect: add session redirect plugin
This feature enables the use of the classifier and ip-in-out-acl nodes
to redirect matching sessions via arbitrary fib paths instead of relying
on additional VRFs.

Type: feature

Change-Id: Ia59d35481c2555aec96c806b62bf29671abb295a
Signed-off-by: Benoît Ganne <bganne@cisco.com>
2023-05-16 13:29:04 +00:00

107 lines
3.3 KiB
Plaintext

/*
* 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:
*/