FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
abf.api
Go to the documentation of this file.
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 
22 option version = "1.0.0";
23 import "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 */
29 define abf_plugin_get_version
30 {
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 */
40 define abf_plugin_get_version_reply
41 {
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  */
53 typeonly define abf_policy
54 {
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  */
67 autoreply define abf_policy_add_del
68 {
73 };
74 
75 /** \brief Policy description returned in the dump
76  */
77 define abf_policy_details
78 {
81 };
82 
83 /** \brief Dump all ABF policies
84  */
85 define abf_policy_dump
86 {
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 */
98 typeonly define abf_itf_attach
99 {
104 };
105 
106 /** \brief Add or delete a policy attachment to an interface
107  */
108 autoreply define abf_itf_attach_add_del
109 {
114 };
115 
116 /** \brief Attachment details from a dump
117  */
118 define abf_itf_attach_details
119 {
122 };
123 
124 /** \brief Dump all the policy attachments
125  */
126 define abf_itf_attach_dump
127 {
130 };
131 
vl_api_abf_policy_t policy
Definition: abf.api:80
option version
Definition: abf.api:22
unsigned char u8
Definition: types.h:56
vl_api_abf_itf_attach_t attach
Definition: abf.api:121
unsigned int u32
Definition: types.h:88
vl_api_abf_policy_t policy
Definition: abf.api:72
FIB path.
Definition: fib_types.api:47
A description of an ABF policy.
Definition: abf.api:53
int abf_itf_attach(fib_protocol_t fproto, u32 policy_id, u32 priority, u32 sw_if_index)
A description of a policy attachment to an interface.
Definition: abf.api:98
vl_api_abf_itf_attach_t attach
Definition: abf.api:113