FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
stn.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 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 /**
17  * @file stn.api
18  * @brief VPP control-plane API messages for STN plugin.
19  *
20  */
21 
22 option version = "2.0.0";
23 import "vnet/interface_types.api";
24 import "vnet/ip/ip_types.api";
25 
26 /** \brief Add/del STN rules
27  @param client_index - opaque cookie to identify the sender
28  @param context - sender context, to match reply w/ request
29  @param ip_address - STN rule IP address
30  @param sw_if_index - Interface index
31  @param is_add - 1 if add, 0 if delete
32 */
33 autoreply define stn_add_del_rule {
36  vl_api_address_t ip_address;
37  vl_api_interface_index_t sw_if_index;
38  bool is_add;
39 };
40 
41 /** \brief Dump STN rules
42  @param client_index - opaque cookie to identify the sender
43  @param context - sender context, to match reply w/ request
44 */
45 define stn_rules_dump {
48 };
49 
50 /** \brief STN response to rules request
51  @param context - sender context, to match reply w/ request
52  @param is_ip4 - 1 if address type is IPv4
53  @param ip_address - IP address
54  @param sw_if_index - Interface index
55 */
56 define stn_rules_details {
58  vl_api_address_t ip_address;
59  vl_api_interface_index_t sw_if_index;
60 };
61 
vl_api_stn_rules_details_t::ip_address
vl_api_address_t ip_address
Definition: stn.api:58
vl_api_stn_add_del_rule_t::ip_address
vl_api_address_t ip_address
Definition: stn.api:36
vl_api_stn_add_del_rule_t::context
u32 context
Definition: stn.api:35
vl_api_stn_rules_dump_t
Dump STN rules.
Definition: stn.api:45
vl_api_stn_rules_details_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: stn.api:59
vl_api_stn_add_del_rule_t
Add/del STN rules.
Definition: stn.api:33
vl_api_stn_rules_dump_t::context
u32 context
Definition: stn.api:47
version
option version
Definition: stn.api:22
vl_api_stn_rules_details_t::context
u32 context
Definition: stn.api:57
u32
unsigned int u32
Definition: types.h:88
vl_api_stn_rules_dump_t::client_index
u32 client_index
Definition: stn.api:46
vl_api_stn_rules_details_t
STN response to rules request.
Definition: stn.api:56
vl_api_stn_add_del_rule_t::client_index
u32 client_index
Definition: stn.api:34
vl_api_stn_add_del_rule_t::is_add
bool is_add
Definition: stn.api:38
vl_api_stn_add_del_rule_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: stn.api:37