2 * Copyright (c) 2015-2016 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 This file defines packet-generator interface APIs.
21 option version = "2.0.0";
23 import "vnet/interface_types.api";
25 /** \brief PacketGenerator create interface request
26 @param client_index - opaque cookie to identify the sender
27 @param context - sender context, to match reply w/ request
28 @param interface_id - interface index
29 @param gso_enabled - enable gso on this interface
30 @param gso_size - gso size on this interface
32 define pg_create_interface
36 vl_api_interface_index_t interface_id;
41 /** \brief PacketGenerator create interface response
42 @param context - sender context, to match reply w/ request
43 @param retval - return value for request
45 define pg_create_interface_reply
49 vl_api_interface_index_t sw_if_index;
52 /** \brief PacketGenerator interface enable/disable packet coalesce
53 @param client_index - opaque cookie to identify the sender
54 @param context - sender context, to match reply w/ request
55 @param interface_id - interface index
56 @param coalesce_enabled - enable/disable packet coalesce on this interface
58 autoreply define pg_interface_enable_disable_coalesce
62 vl_api_interface_index_t sw_if_index;
63 bool coalesce_enabled;
64 option status="in_progress";
67 /** \brief PacketGenerator capture packets on given interface request
68 @param client_index - opaque cookie to identify the sender
69 @param context - sender context, to match reply w/ request
70 @param interface_id - pg interface index
71 @param is_enabled - 1 if enabling streams, 0 if disabling
72 @param count - number of packets to be captured
73 @param pcap_file_name - pacp file name to store captured packets
75 autoreply define pg_capture
79 vl_api_interface_index_t interface_id;
80 bool is_enabled [default=true];
82 string pcap_file_name[];
85 /** \brief Enable / disable packet generator request
86 @param client_index - opaque cookie to identify the sender
87 @param context - sender context, to match reply w/ request
88 @param is_enabled - 1 if enabling streams, 0 if disabling
89 @param stream_name - stream name to be enable/disabled, if not specified handle all streams
91 autoreply define pg_enable_disable
95 bool is_enabled [default=true];
101 * eval: (c-set-style "gnu")