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 autoreply define want_interface_simple_stats
50 /** \brief Want Interface Combined Stats, register for continuous stats
51 @param client_index - opaque cookie to identify the sender
52 @param context - sender context, to match reply w/ request
53 @param enable_disable - 1 = enable stats, 0 = disable
54 @param pid - pid of process requesting stats updates
56 autoreply define want_interface_combined_stats
64 /** \brief Want IP4 FIB Stats, register for continuous stats
65 @param client_index - opaque cookie to identify the sender
66 @param context - sender context, to match reply w/ request
67 @param enable_disable - 1 = enable stats, 0 = disable
68 @param pid - pid of process requesting stats updates
70 autoreply define want_ip4_fib_stats
78 /** \brief Want IP6 FIB Stats, register for continuous stats
79 @param client_index - opaque cookie to identify the sender
80 @param context - sender context, to match reply w/ request
81 @param enable_disable - 1 = enable stats, 0 = disable
82 @param pid - pid of process requesting stats updates
84 autoreply define want_ip6_fib_stats
92 /** \brief Want IP4 NBR Stats, register for continuous stats
93 @param client_index - opaque cookie to identify the sender
94 @param context - sender context, to match reply w/ request
95 @param enable_disable - 1 = enable stats, 0 = disable
96 @param pid - pid of process requesting stats updates
98 autoreply define want_ip4_nbr_stats
106 /** \brief Want IP6 NBR Stats, register for continuous stats
107 @param client_index - opaque cookie to identify the sender
108 @param context - sender context, to match reply w/ request
109 @param enable_disable - 1 = enable stats, 0 = disable
110 @param pid - pid of process requesting stats updates
112 autoreply define want_ip6_nbr_stats
120 typeonly manual_print manual_endian define ip4_fib_counter
128 manual_print manual_endian define vnet_ip4_fib_counters
132 vl_api_ip4_fib_counter_t c[count];
135 typeonly manual_print manual_endian define ip4_nbr_counter
144 * @brief Per-neighbour (i.e. per-adjacency) coutners
145 * @param count The size of the array of counters
146 * @param sw_if_index The interface the adjacency is on
147 * @param begin Flag to indicate this is the first set of stats for this
148 * interface. If this flag is not set the it is a continuation of
149 * stats for this interface
152 manual_print manual_endian define vnet_ip4_nbr_counters
157 vl_api_ip4_nbr_counter_t c[count];
160 typeonly manual_print manual_endian define ip6_fib_counter
168 manual_print manual_endian define vnet_ip6_fib_counters
172 vl_api_ip6_fib_counter_t c[count];
175 typeonly manual_print manual_endian define ip6_nbr_counter
183 manual_print manual_endian define vnet_ip6_nbr_counters
188 vl_api_ip6_nbr_counter_t c[count];
192 /** \brief Request for a single block of summary stats
193 @param client_index - opaque cookie to identify the sender
194 @param context - sender context, to match reply w/ request
196 define vnet_get_summary_stats
202 /** \brief Reply for vnet_get_summary_stats request
203 @param context - sender context, to match reply w/ request
204 @param retval - return code for request
209 define vnet_get_summary_stats_reply
220 * eval: (c-set-style "gnu")