1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
/*
* Copyright (c) 2016 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.
*/
/**
* @file snat.api
* @brief VPP control-plane API messages.
*
* This file defines VPP control-plane API messages which are generally
* called through a shared memory interface.
*/
/** \brief Add/del S-NAT address range
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_ip4 - 1 if address type is IPv4
@first_ip_address - first IP address
@last_ip_address - last IP address
@is_add - 1 if add, 0 if delete
*/
define snat_add_address_range {
u32 client_index;
u32 context;
u8 is_ip4;
u8 first_ip_address[16];
u8 last_ip_address[16];
u8 is_add;
};
/** \brief Add S-NAT address range reply
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param retval - return code
*/
define snat_add_address_range_reply {
u32 context;
i32 retval;
};
/** \brief Dump S-NAT addresses
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define snat_address_dump {
u32 client_index;
u32 context;
};
/** \brief S-NAT address details response
@param context - sender context, to match reply w/ request
@param is_ip4 - 1 if address type is IPv4
@param ip_address - IP address
*/
define snat_address_details {
u32 context;
u8 is_ip4;
u8 ip_address[16];
};
/** \brief Enable/disable S-NAT feature on the interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - 1 if add, 0 if delete
@param is_inside - 1 if inside, 0 if outside
@param sw_if_index - software index of the interface
*/
define snat_interface_add_del_feature {
u32 client_index;
u32 context;
u8 is_add;
u8 is_inside;
u32 sw_if_index;
};
/** \brief Enable/disable S-NAT feature on the interface reply
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param retval - return code
*/
define snat_interface_add_del_feature_reply {
u32 context;
i32 retval;
};
/** \brief Dump interfaces with S-NAT feature
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define snat_interface_dump {
u32 client_index;
u32 context;
};
/** \brief S-NAT interface details response
@param context - sender context, to match reply w/ request
@param is_inside - 1 if inside, 0 if outside
@param sw_if_index - software index of the interface
*/
define snat_interface_details {
u32 context;
u8 is_inside;
u32 sw_if_index;
};
/** \brief Add/delete S-NAT static mapping
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - 1 if add, 0 if delete
@param is_ip4 - 1 if address type is IPv4
@param addr_only - 1 if address only mapping
@param local_ip_address - local IP address
@param external_ip_address - external IP address
@param local_port - local port number
@param external_port - external port number
@param vfr_id - VRF ID
*/
define snat_add_static_mapping {
u32 client_index;
u32 context;
u8 is_add;
u8 is_ip4;
u8 addr_only;
u8 local_ip_address[16];
u8 external_ip_address[16];
u16 local_port;
u16 external_port;
u32 vrf_id;
};
/** \brief Add/delete S-NAT static mapping reply
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param retval - return code
*/
define snat_add_static_mapping_reply {
u32 context;
i32 retval;
};
/** \brief Dump S-NAT static mappings
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define snat_static_mapping_dump {
u32 client_index;
u32 context;
};
/** \brief S-NAT static mapping details response
@param context - sender context, to match reply w/ request
@param is_ip4 - 1 if address type is IPv4
@param addr_only - 1 if address only mapping
@param local_ip_address - local IP address
@param external_ip_address - external IP address
@param local_port - local port number
@param external_port - external port number
@param vfr_id - VRF ID
*/
define snat_static_mapping_details {
u32 context;
u8 is_ip4;
u8 addr_only;
u8 local_ip_address[16];
u8 external_ip_address[16];
u16 local_port;
u16 external_port;
u32 vrf_id;
};
/** \brief Control ping from client to api server request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define snat_control_ping
{
u32 client_index;
u32 context;
};
/** \brief Control ping from the client to the server response
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param vpe_pid - the pid of the vpe, returned by the server
*/
define snat_control_ping_reply
{
u32 context;
i32 retval;
u32 client_index;
u32 vpe_pid;
};
/** \brief Show S-NAT plugin startup config
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define snat_show_config
{
u32 client_index;
u32 context;
};
/** \brief Show S-NAT plugin startup config reply
@param context - sender context, to match reply w/ request
@param retval - return code for the request
@param static_mapping_only - if 1 dynamic translations disabled
@param static_mapping_connection_tracking - if 1 create session data
@param translation_buckets - number of translation hash buckets
@param translation_memory_size - translation hash memory size
@param user_buckets - number of user hash buckets
@param user_memory_size - user hash memory size
@param max_translations_per_user - maximum number of translations per user
@param outside_vrf_id - outside VRF id
@param inside_vrf_id - default inside VRF id
*/
define snat_show_config_reply
{
u32 context;
i32 retval;
u8 static_mapping_only;
u8 static_mapping_connection_tracking;
u32 translation_buckets;
u32 translation_memory_size;
u32 user_buckets;
u32 user_memory_size;
u32 max_translations_per_user;
u32 outside_vrf_id;
u32 inside_vrf_id;
};
/** \brief Set S-NAT workers
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param worker_mask - S-NAT workers mask
*/
define snat_set_workers {
u32 client_index;
u32 context;
u64 worker_mask;
};
/** \brief Set S-NAT workers reply
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param retval - return code
*/
define snat_set_workers_reply {
u32 context;
i32 retval;
};
/** \brief Dump S-NAT workers
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
define snat_worker_dump {
u32 client_index;
u32 context;
};
/** \brief S-NAT workers details response
@param context - sender context, to match reply w/ request
@param worker_index - worker index
@param lcore_id - lcore ID
@param name - worker name
*/
define snat_worker_details {
u32 context;
u32 worker_index;
u32 lcore_id;
u8 name[64];
};
|
