1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2016 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 * This file defines the vpp control-plane API messages
20 * used to control the Source VRF select (SVS) plugin
23 option version = "1.0.0";
24 import "vnet/ip/ip_types.api";
27 * brief Get the plugin version
28 * @param client_index - opaque cookie to identify the sender
29 *@param context - sender context, to match reply w/ request
31 define svs_plugin_get_version
38 * @brief Reply to get the plugin version
39 * @param context - returned sender context, to match reply w/ request
40 * @param major - Incremented every time a known breaking behavior change is introduced
41 * @param minor - Incremented with small changes, may be used to avoid buggy versions
43 define svs_plugin_get_version_reply
51 * @brief Add a table in which to add routes that will match against source
53 * @param client_index - opaque cookie to identify the sender
54 * @param context - sender context, to match reply w/ request
55 * @param af - Address Family
56 * @param table_id - User provided ID for the table
57 * @param is_add - add or delete
59 autoreply define svs_table_add_del
64 vl_api_address_family_t af;
69 * @brief Add a route into the source address matching table
70 * @param client_index - opaque cookie to identify the sender
71 * @param context - sender context, to match reply w/ request
72 * @param prefix - prefix
73 * @param table_id - The SVS table (from svs_table_add_del)
74 * @param source_table_id - This is the table ID that will be used for
75 * the subsequent lookup of the packet. The V in SVS.
76 * this table must exist (from e.g. ip_table_add_del)
78 autoreply define svs_route_add_del
83 vl_api_prefix_t prefix;
89 * @brief Enable SVS on a given interface by using the given table to match
90 * RX'd packets' source addresses
91 * @param client_index - opaque cookie to identify the sender
92 * @param context - sender context, to match reply w/ request
93 * @param af - Address Family
94 * @param table_id - The SVS table (from svs_table_add_del)
95 * @param sw_if_index - Interface
97 autoreply define svs_enable_disable
102 vl_api_address_family_t af;
108 * @brief Dump the SVS table mappings of table_id to interface
109 * To see the routes added to a given table use ip_fib_dump()
118 * @brief SVS table-id to interface mapping
119 * @param context - sender context, to match reply w/ request
120 * @param af - Address Family
121 * @param table_id - The SVS table (from svs_table_add_del)
122 * @param sw_if_index - Interface
129 vl_api_address_family_t af;