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.
18 This file defines the vpp control-plane API messages
19 used to control the ABF plugin
22 option version = "0.2.0";
23 import "vnet/ip/ip_types.api";
24 import "vnet/fib/fib_types.api";
25 import "vnet/interface_types.api";
27 enum cnat_translation_flags:u8
29 CNAT_TRANSLATION_ALLOC_PORT = 1,
32 enum cnat_endpoint_tuple_flags:u8
34 /* Dont translate said endpoint tuple but
42 CNAT_LB_TYPE_DEFAULT = 0,
43 CNAT_LB_TYPE_MAGLEV = 1,
46 /* An enpoint is either
48 * An interface, an address familiy and a port */
51 vl_api_address_t addr;
52 vl_api_interface_index_t sw_if_index;
53 vl_api_address_family_t if_af;
57 typedef cnat_endpoint_tuple
59 vl_api_cnat_endpoint_t dst_ep;
60 vl_api_cnat_endpoint_t src_ep;
64 typedef cnat_translation
66 vl_api_cnat_endpoint_t vip;
68 vl_api_ip_proto_t ip_proto;
71 vl_api_cnat_lb_type_t lb_type;
73 vl_api_cnat_endpoint_tuple_t paths[n_paths];
76 define cnat_translation_update
80 vl_api_cnat_translation_t translation;
83 define cnat_translation_update_reply
90 autoreply define cnat_translation_del
97 define cnat_translation_details
100 vl_api_cnat_translation_t translation;
103 define cnat_translation_dump
109 autoreply define cnat_session_purge
117 vl_api_cnat_endpoint_t src;
118 vl_api_cnat_endpoint_t dst;
119 vl_api_cnat_endpoint_t new;
120 vl_api_ip_proto_t ip_proto;
125 define cnat_session_details
128 vl_api_cnat_session_t session;
131 define cnat_session_dump
137 autoreply define cnat_set_snat_addresses
141 vl_api_ip4_address_t snat_ip4;
142 vl_api_ip6_address_t snat_ip6;
143 vl_api_interface_index_t sw_if_index;
146 define cnat_get_snat_addresses
152 define cnat_get_snat_addresses_reply
157 vl_api_ip4_address_t snat_ip4;
158 vl_api_ip6_address_t snat_ip6;
159 vl_api_interface_index_t sw_if_index;
162 autoreply define cnat_snat_policy_add_del_exclude_pfx
167 vl_api_prefix_t prefix;
170 enum cnat_snat_policy_table:u8
172 CNAT_POLICY_INCLUDE_V4 = 0,
173 CNAT_POLICY_INCLUDE_V6 = 1,
177 autoreply define cnat_snat_policy_add_del_if
181 vl_api_interface_index_t sw_if_index;
183 vl_api_cnat_snat_policy_table_t table;
186 /* A snat policy controls what traffic is srcNATed */
187 enum cnat_snat_policies:u8
189 /* No filter applied, srcNAT everything */
190 CNAT_POLICY_NONE = 0,
191 /* Filter by interface list : snat_policy_add_del_if
192 * and prefix list : snat_policy_add_del_if */
193 CNAT_POLICY_IF_PFX = 1,
194 /* Kubernetes specific policy */
198 autoreply define cnat_set_snat_policy
202 vl_api_cnat_snat_policies_t policy;
206 * fd.io coding-style-patch-verification: ON
209 * eval: (c-set-style "gnu")