stn.api revision 7929f9f5
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
22option version = "2.0.0";
23import "vnet/interface_types.api";
24import "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*/
33autoreply manual_print define stn_add_del_rule {
34  u32 client_index;
35  u32 context;
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*/
45define stn_rules_dump {
46  u32 client_index;
47  u32 context;
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*/
56define stn_rules_details {
57  u32 context;
58  vl_api_address_t ip_address;
59  vl_api_interface_index_t sw_if_index;
60};
61
62