abf.api revision 669d07dc
1/* Hey Emacs use -*- mode: C -*- */
2/*
3 * Copyright (c) 2016 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17/** \file
18    This file defines the vpp control-plane API messages
19    used to control the ABF plugin
20*/
21
22option version = "1.0.0";
23import "vnet/fib/fib_types.api";
24
25/** \brief Get the plugin version
26    @param client_index - opaque cookie to identify the sender
27    @param context - sender context, to match reply w/ request
28*/
29define abf_plugin_get_version
30{
31  u32 client_index;
32  u32 context;
33};
34
35/** \brief Reply to get the plugin version
36    @param context - returned sender context, to match reply w/ request
37    @param major - Incremented every time a known breaking behavior change is introduced
38    @param minor - Incremented with small changes, may be used to avoid buggy versions
39*/
40define abf_plugin_get_version_reply
41{
42  u32 context;
43  u32 major;
44  u32 minor;
45};
46
47/** \brief A description of an ABF policy
48    @param policy_id User chosen Identifier for the policy
49    @param acl_index The ACL that the policy will match against
50    @param n_paths Number of paths
51    @param paths The set of forwarding paths that are being added or removed.
52 */
53typeonly define abf_policy
54{
55  u32 policy_id;
56  u32 acl_index;
57  u8 n_paths;
58  vl_api_fib_path_t paths[n_paths];
59};
60
61/** \brief A description of an ABF policy
62    @param is_add Is this the addition or removal of paths from the policy
63           If the policy does not exist it is created. If the last path
64           Is being removed, the policy is deleted
65    @param policy The policy
66 */
67autoreply define abf_policy_add_del
68{
69  u32 client_index;
70  u32 context;
71  u8 is_add;
72  vl_api_abf_policy_t policy;
73};
74
75/** \brief Policy description returned in the dump
76 */
77define abf_policy_details
78{
79  u32 context;
80  vl_api_abf_policy_t policy;
81};
82
83/** \brief Dump all ABF policies
84 */
85define abf_policy_dump
86{
87  u32 client_index;
88  u32 context;
89};
90
91/** \brief A description of a policy attachment to an interface
92    @param The policy ID to attach
93    @param sw_if_index The interface to attach to
94    @param priority The priority of the attachment, w.r.t. to other attachments
95              on this interface. lower value is 'better'
96    @param is_ipv6 Does this attachment apply to IPv6 packets (or IPv4)
97*/
98typeonly define abf_itf_attach
99{
100  u32 policy_id;
101  u32 sw_if_index;
102  u32 priority;
103  u8 is_ipv6;
104};
105
106/** \brief Add or delete a policy attachment to an interface
107 */
108autoreply define abf_itf_attach_add_del
109{
110  u32 client_index;
111  u32 context;
112  u8 is_add;
113  vl_api_abf_itf_attach_t attach;
114};
115
116/** \brief Attachment details from a dump
117 */
118define abf_itf_attach_details
119{
120  u32 context;
121  vl_api_abf_itf_attach_t attach;
122};
123
124/** \brief Dump all the policy attachments
125 */
126define abf_itf_attach_dump
127{
128  u32 client_index;
129  u32 context;
130};
131
132