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 the stats API
21 option version = "1.0.0";
23 /** \brief Want Stats, enable/disable ALL stats updates
24 @param client_index - opaque cookie to identify the sender
25 @param context - sender context, to match reply w/ request
26 @param enable_disable - 1 = enable stats, 0 = disable
27 @param pid - pid of process requesting stats updates
29 autoreply define want_stats
37 /** \brief Want Interface Simple Stats, register for detailed interface stats
38 @param client_index - opaque cookie to identify the sender
39 @param context - sender context, to match reply w/ request
40 @param enable_disable - 1 = enable stats, 0 = disable
41 @param pid - pid of process requesting stats updates
43 Please consider using want_per_interface_simple_stats with sw_if_index=~0
45 autoreply define want_interface_simple_stats
53 /** \brief Want Per Interface simple Stats, register for continuous stats
54 @param client_index - opaque cookie to identify the sender
55 @param context - sender context, to match reply w/ request
56 @param enable_disable - 1 = enable stats, 0 = disable
57 @param pid - pid of process requesting stats updates
58 @param num - number of sw_if_indexes
59 @param sw_ifs - array of sw_if_index
61 autoreply define want_per_interface_simple_stats
72 /** \brief Want Interface Combined Stats, register for continuous stats
73 @param client_index - opaque cookie to identify the sender
74 @param context - sender context, to match reply w/ request
75 @param enable_disable - 1 = enable stats, 0 = disable
76 @param pid - pid of process requesting stats updates
78 Please consider using want_per_interface_combined_stats with sw_if_index=~0
81 autoreply define want_interface_combined_stats
89 /** \brief Want Per Interface Combined Stats, register for continuous stats
90 @param client_index - opaque cookie to identify the sender
91 @param context - sender context, to match reply w/ request
92 @param enable_disable - 1 = enable stats, 0 = disable
93 @param pid - pid of process requesting stats updates
94 @param num - number of sw_if_indexes
95 @param sw_ifs - array of sw_if_index
97 autoreply define want_per_interface_combined_stats
108 /** \brief Want IP4 FIB Stats, register for continuous stats
109 @param client_index - opaque cookie to identify the sender
110 @param context - sender context, to match reply w/ request
111 @param enable_disable - 1 = enable stats, 0 = disable
112 @param pid - pid of process requesting stats updates
114 autoreply define want_ip4_fib_stats
122 /** \brief Want IP6 FIB Stats, register for continuous stats
123 @param client_index - opaque cookie to identify the sender
124 @param context - sender context, to match reply w/ request
125 @param enable_disable - 1 = enable stats, 0 = disable
126 @param pid - pid of process requesting stats updates
128 autoreply define want_ip6_fib_stats
136 /** \brief Want IP4 muilticast FIB Stats, register for continuous stats
137 @param client_index - opaque cookie to identify the sender
138 @param context - sender context, to match reply w/ request
139 @param enable_disable - 1 = enable stats, 0 = disable
140 @param pid - pid of process requesting stats updates
142 autoreply define want_ip4_mfib_stats
150 /** \brief Want IP6 multicast FIB Stats, register for continuous stats
151 @param client_index - opaque cookie to identify the sender
152 @param context - sender context, to match reply w/ request
153 @param enable_disable - 1 = enable stats, 0 = disable
154 @param pid - pid of process requesting stats updates
156 autoreply define want_ip6_mfib_stats
164 /** \brief Want IP4 NBR Stats, register for continuous stats
165 @param client_index - opaque cookie to identify the sender
166 @param context - sender context, to match reply w/ request
167 @param enable_disable - 1 = enable stats, 0 = disable
168 @param pid - pid of process requesting stats updates
170 autoreply define want_ip4_nbr_stats
178 /** \brief Want IP6 NBR Stats, register for continuous stats
179 @param client_index - opaque cookie to identify the sender
180 @param context - sender context, to match reply w/ request
181 @param enable_disable - 1 = enable stats, 0 = disable
182 @param pid - pid of process requesting stats updates
184 autoreply define want_ip6_nbr_stats
192 typeonly manual_print manual_endian define ip4_fib_counter
200 manual_print manual_endian define vnet_ip4_fib_counters
204 vl_api_ip4_fib_counter_t c[count];
207 typeonly manual_print manual_endian define ip4_mfib_counter
216 manual_print manual_endian define vnet_ip4_mfib_counters
220 vl_api_ip4_mfib_counter_t c[count];
223 typeonly manual_print manual_endian define ip4_nbr_counter
232 * @brief Per-neighbour (i.e. per-adjacency) coutners
233 * @param count The size of the array of counters
234 * @param sw_if_index The interface the adjacency is on
235 * @param begin Flag to indicate this is the first set of stats for this
236 * interface. If this flag is not set the it is a continuation of
237 * stats for this interface
240 manual_print manual_endian define vnet_ip4_nbr_counters
245 vl_api_ip4_nbr_counter_t c[count];
248 typeonly manual_print manual_endian define ip6_fib_counter
256 manual_print manual_endian define vnet_ip6_fib_counters
260 vl_api_ip6_fib_counter_t c[count];
263 typeonly manual_print manual_endian define ip6_mfib_counter
272 manual_print manual_endian define vnet_ip6_mfib_counters
276 vl_api_ip6_mfib_counter_t c[count];
279 typeonly manual_print manual_endian define ip6_nbr_counter
287 manual_print manual_endian define vnet_ip6_nbr_counters
292 vl_api_ip6_nbr_counter_t c[count];
296 /** \brief Request for a single block of summary stats
297 @param client_index - opaque cookie to identify the sender
298 @param context - sender context, to match reply w/ request
300 define vnet_get_summary_stats
306 /** \brief Reply for vnet_get_summary_stats request
307 @param context - sender context, to match reply w/ request
308 @param retval - return code for request
313 define vnet_get_summary_stats_reply
324 * eval: (c-set-style "gnu")