FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
udp_ping.api
Go to the documentation of this file.
1 /* Hey Emacs use -*- mode: C -*- */
2 /*
3  * Copyright (c) 2017 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:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16 
17 option version = "3.0.0";
18 import "vnet/ip/ip_types.api";
19 
20 /** \brief UDP-Probe Add/Delete request
21  @param src_ip_address - Source ipv4/v6 address for the udp-ping flow
22  @param dst_ip_address - Destination ipv4/v6 address for the udp-ping flow
23  @param start_src_port - Starting source port of port range for udp-ping
24  @param end_src_port - End source port of port range for udp-ping
25  @param start_dst_port - Starting destination port of port range for udp-ping
26  @param end_dst_port - End destination port of port range for udp-ping
27  @param interval - Time interval in seconds at which udp-probe need to be sent
28  @param is_ipv4 - To determine whether IPv4 or IPv6 address is used
29  @param dis - TRUE is delete, FALSE if Add
30 */
31 autoreply define udp_ping_add_del {
34  vl_api_address_t src_ip_address;
35  vl_api_address_t dst_ip_address;
43  u8 reserve[3];
44 };
45 
46 /** \brief Udp-probe export add/del request
47  @param context - sender context, to match reply w/ request
48  @param retval - return value for request
49  @param enable - If TRUE then enable export else disable
50 */
51 autoreply define udp_ping_export {
54  bool enable;
55 };
56 
unsigned char u8
Definition: types.h:56
vl_api_address_t dst_ip_address
Definition: udp_ping.api:35
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
vl_api_address_t src_ip_address
Definition: udp_ping.api:34
option version
Definition: udp_ping.api:17