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
22 /** \brief Want Stats, enable/disable ALL stats updates
23 @param client_index - opaque cookie to identify the sender
24 @param context - sender context, to match reply w/ request
25 @param enable_disable - 1 = enable stats, 0 = disable
26 @param pid - pid of process requesting stats updates
28 autoreply define want_stats
36 /** \brief Want Interface Simple Stats, register for detailed interface stats
37 @param client_index - opaque cookie to identify the sender
38 @param context - sender context, to match reply w/ request
39 @param enable_disable - 1 = enable stats, 0 = disable
40 @param pid - pid of process requesting stats updates
42 Please consider using want_per_interface_simple_stats with sw_if_index=~0
44 autoreply define want_interface_simple_stats
52 /** \brief Want Per Interface simple Stats, register for continuous stats
53 @param client_index - opaque cookie to identify the sender
54 @param context - sender context, to match reply w/ request
55 @param enable_disable - 1 = enable stats, 0 = disable
56 @param pid - pid of process requesting stats updates
57 @param num - number of sw_if_indexes
58 @param sw_ifs - array of sw_if_index
60 autoreply define want_per_interface_simple_stats
71 /** \brief Want Interface Combined Stats, register for continuous stats
72 @param client_index - opaque cookie to identify the sender
73 @param context - sender context, to match reply w/ request
74 @param enable_disable - 1 = enable stats, 0 = disable
75 @param pid - pid of process requesting stats updates
77 Please consider using want_per_interface_combined_stats with sw_if_index=~0
80 autoreply define want_interface_combined_stats
88 /** \brief Want Per Interface Combined Stats, register for continuous stats
89 @param client_index - opaque cookie to identify the sender
90 @param context - sender context, to match reply w/ request
91 @param enable_disable - 1 = enable stats, 0 = disable
92 @param pid - pid of process requesting stats updates
93 @param num - number of sw_if_indexes
94 @param sw_ifs - array of sw_if_index
96 autoreply define want_per_interface_combined_stats
107 /** \brief Want IP4 FIB Stats, register for continuous stats
108 @param client_index - opaque cookie to identify the sender
109 @param context - sender context, to match reply w/ request
110 @param enable_disable - 1 = enable stats, 0 = disable
111 @param pid - pid of process requesting stats updates
113 autoreply define want_ip4_fib_stats
121 /** \brief Want IP6 FIB Stats, register for continuous stats
122 @param client_index - opaque cookie to identify the sender
123 @param context - sender context, to match reply w/ request
124 @param enable_disable - 1 = enable stats, 0 = disable
125 @param pid - pid of process requesting stats updates
127 autoreply define want_ip6_fib_stats
135 /** \brief Want IP4 NBR Stats, register for continuous stats
136 @param client_index - opaque cookie to identify the sender
137 @param context - sender context, to match reply w/ request
138 @param enable_disable - 1 = enable stats, 0 = disable
139 @param pid - pid of process requesting stats updates
141 autoreply define want_ip4_nbr_stats
149 /** \brief Want IP6 NBR Stats, register for continuous stats
150 @param client_index - opaque cookie to identify the sender
151 @param context - sender context, to match reply w/ request
152 @param enable_disable - 1 = enable stats, 0 = disable
153 @param pid - pid of process requesting stats updates
155 autoreply define want_ip6_nbr_stats
163 typeonly manual_print manual_endian define ip4_fib_counter
171 manual_print manual_endian define vnet_ip4_fib_counters
175 vl_api_ip4_fib_counter_t c[count];
178 typeonly manual_print manual_endian define ip4_nbr_counter
187 * @brief Per-neighbour (i.e. per-adjacency) coutners
188 * @param count The size of the array of counters
189 * @param sw_if_index The interface the adjacency is on
190 * @param begin Flag to indicate this is the first set of stats for this
191 * interface. If this flag is not set the it is a continuation of
192 * stats for this interface
195 manual_print manual_endian define vnet_ip4_nbr_counters
200 vl_api_ip4_nbr_counter_t c[count];
203 typeonly manual_print manual_endian define ip6_fib_counter
211 manual_print manual_endian define vnet_ip6_fib_counters
215 vl_api_ip6_fib_counter_t c[count];
218 typeonly manual_print manual_endian define ip6_nbr_counter
226 manual_print manual_endian define vnet_ip6_nbr_counters
231 vl_api_ip6_nbr_counter_t c[count];
235 /** \brief Request for a single block of summary stats
236 @param client_index - opaque cookie to identify the sender
237 @param context - sender context, to match reply w/ request
239 define vnet_get_summary_stats
245 /** \brief Reply for vnet_get_summary_stats request
246 @param context - sender context, to match reply w/ request
247 @param retval - return code for request
252 define vnet_get_summary_stats_reply
263 * eval: (c-set-style "gnu")