2 * Copyright (c) 2020 Intel 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 = "1.0.3";
18 import "vnet/interface_types.api";
19 import "vnet/ip/ip_types.api";
20 import "vnet/flow/flow_types.api";
22 /** \brief flow add request
23 @param client_index - opaque cookie to identify the sender
24 @param context - sender context, to match reply w/ request
25 @param flow - flow rule
33 vl_api_flow_rule_t flow;
34 option vat_help = "test flow add [src-ip <ip-addr/mask>] [dst-ip <ip-addr/mask>] [src-port <port/mask>] [dst-port <port/mask>] [proto <ip-proto>]";
37 /** \brief flow add request v2
38 @param client_index - opaque cookie to identify the sender
39 @param context - sender context, to match reply w/ request
40 @param flow - flow rule v2
46 vl_api_flow_rule_v2_t flow;
47 option vat_help = "test flow add [src-ip <ip-addr/mask>] [dst-ip <ip-addr/mask>] [src-port <port/mask>] [dst-port <port/mask>] [proto <ip-proto>] [spec <spec-string>] [mask <mask-string>]";
50 /** \brief reply for adding flow
51 @param context - sender context, to match reply w/ request
52 @param retval - return code
53 @param flow_index - flow index, can be used for flow del/enable/disable
64 /** \brief reply for adding flow v2
65 @param context - sender context, to match reply w/ request
66 @param retval - return code
67 @param flow_index - flow index, can be used for flow del/enable/disable
69 define flow_add_v2_reply
76 /** \brief flow del request
77 @param client_index - opaque cookie to identify the sender
78 @param context - sender context, to match reply w/ request
79 @param flow_index - flow index
81 autoreply define flow_del
86 option vat_help = "test flow del index <index>";
89 /** \brief flow enable request
90 @param client_index - opaque cookie to identify the sender
91 @param context - sender context, to match reply w/ request
92 @param flow_index - flow index
93 @param hw_if_index - hardware interface index
95 autoreply define flow_enable
101 option vat_help = "test flow enable index <index> <interface name>";
104 /** \brief flow disable request
105 @param client_index - opaque cookie to identify the sender
106 @param context - sender context, to match reply w/ request
107 @param flow_index - flow index
108 @param hw_if_index - hardware interface index
110 autoreply define flow_disable
116 option vat_help = "test flow disable index <index> <interface name>";
121 * eval: (c-set-style "gnu")