2 * Copyright (c) 2015-2020 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.
16 option version = "2.0.0";
18 import "vnet/interface_types.api";
19 import "vnet/policer/policer_types.api";
21 /** \brief policer bind: Associate/disassociate a policer with a worker thread.
22 @param client_index - opaque cookie to identify the sender
23 @param context - sender context, to match reply w/ request
24 @param name - policer name to bind
25 @param worker_index - the worker thread to bind to
26 @param bind_enable - Associate/disassociate
28 autoreply define policer_bind
38 /** \brief policer input: Apply policer as an input feature.
39 @param client_index - opaque cookie to identify the sender
40 @param context - sender context, to match reply w/ request
41 @param name - policer name
42 @param sw_if_index - interface to apply the policer
43 @param apply - Apply/remove
45 autoreply define policer_input
51 vl_api_interface_index_t sw_if_index;
55 /** \brief Add/del policer
56 @param client_index - opaque cookie to identify the sender
57 @param context - sender context, to match reply w/ request
58 @param is_add - add policer if non-zero, else delete
59 @param name - policer name
62 @param cb - Committed Burst
63 @param eb - Excess or Peak Burst
64 @param rate_type - rate type
65 @param round_type - rounding type
66 @param type - policer algorithm
67 @param color_aware - 0=color-blind, 1=color-aware
68 @param conform_action - conform action
69 @param exceed_action - exceed action type
70 @param violate_action - violate action type
72 define policer_add_del
83 vl_api_sse2_qos_rate_type_t rate_type;
84 vl_api_sse2_qos_round_type_t round_type;
85 vl_api_sse2_qos_policer_type_t type;
87 vl_api_sse2_qos_action_t conform_action;
88 vl_api_sse2_qos_action_t exceed_action;
89 vl_api_sse2_qos_action_t violate_action;
92 /** \brief Add/del policer response
93 @param context - sender context, to match reply w/ request
94 @param retval - return value for request
95 @param policer_index - for add, returned index of the new policer
97 define policer_add_del_reply
104 /** \brief Get list of policers
105 @param client_index - opaque cookie to identify the sender
106 @param context - sender context, to match reply w/ request
107 @param match_name_valid - if 0 request all policers otherwise use match_name
108 @param match_name - policer name
115 bool match_name_valid;
116 string match_name[64];
119 /** \brief Policer operational state response.
120 @param context - sender context, to match reply w/ request
121 @param name - policer name
124 @param cb - Committed Burst
125 @param eb - Excess or Peak Burst
126 @param rate_type - rate type
127 @param round_type - rounding type
128 @param type - policer algorithm
129 @param conform_action - conform action
130 @param exceed_action - exceed action
131 @param violate_action - violate action
132 @param single_rate - 1 = single rate policer, 0 = two rate policer
133 @param color_aware - for hierarchical policing
134 @param scale - power-of-2 shift amount for lower rates
135 @param cir_tokens_per_period - number of tokens for each period
136 @param pir_tokens_per_period - number of tokens for each period for 2-rate policer
137 @param current_limit - current limit
138 @param current_bucket - current bucket
139 @param extended_limit - extended limit
140 @param extended_bucket - extended bucket
141 @param last_update_time - last update time
143 define policer_details
152 vl_api_sse2_qos_rate_type_t rate_type;
153 vl_api_sse2_qos_round_type_t round_type;
154 vl_api_sse2_qos_policer_type_t type;
155 vl_api_sse2_qos_action_t conform_action;
156 vl_api_sse2_qos_action_t exceed_action;
157 vl_api_sse2_qos_action_t violate_action;
161 u32 cir_tokens_per_period;
162 u32 pir_tokens_per_period;
167 u64 last_update_time;
172 * eval: (c-set-style "gnu")