FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
map.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 
16 vl_api_version 1.0.0
17 
18 /** \brief Add MAP domains
19  @param client_index - opaque cookie to identify the sender
20  @param context - sender context, to match reply w/ request
21  @param ip6_prefix - Rule IPv6 prefix
22  @param ip4_prefix - Rule IPv4 prefix
23  @param ip6_src - MAP domain IPv6 BR address / Tunnel source
24  @param ip6_prefix_len - Rule IPv6 prefix length
25  @param ip4_prefix_len - Rule IPv4 prefix length
26  @param ea_bits_len - Embedded Address bits length
27  @param psid_offset - Port Set Identifider (PSID) offset
28  @param psid_length - PSID length
29  @param is_translation - MAP-E / MAP-T
30  @param mtu - MTU
31 */
32 define map_add_domain
33 {
36  u8 ip6_prefix[16];
37  u8 ip4_prefix[4];
38  u8 ip6_src[16];
47 };
48 
49 /** \brief Reply for MAP domain add
50  @param context - returned sender context, to match reply w/ request
51  @param index - MAP domain index
52  @param retval - return code
53 */
54 define map_add_domain_reply
55 {
59 };
60 
61 /** \brief Delete MAP domain
62  @param client_index - opaque cookie to identify the sender
63  @param context - sender context, to match reply w/ request
64  @param index - MAP Domain index
65 */
66 autoreply define map_del_domain
67 {
71 };
72 
73 
74 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
75  @param client_index - opaque cookie to identify the sender
76  @param context - sender context, to match reply w/ request
77  @param index - MAP Domain index
78  @param is_add - If 1 add rule, if 0 delete rule
79  @param ip6_dst - MAP CE IPv6 address
80  @param psid - Rule PSID
81 */
82 autoreply define map_add_del_rule
83 {
88  u8 ip6_dst[16];
90 };
91 
92 
93 /** \brief Get list of map domains
94  @param client_index - opaque cookie to identify the sender
95 */
96 define map_domain_dump
97 {
100 };
101 
102 define map_domain_details
103 {
106  u8 ip6_prefix[16];
107  u8 ip4_prefix[4];
108  u8 ip6_src[16];
118 };
119 
120 define map_rule_dump
121 {
125 };
126 
127 define map_rule_details
128 {
130  u8 ip6_dst[16];
132 };
133 
134 /** \brief Request for a single block of summary stats
135  @param client_index - opaque cookie to identify the sender
136  @param context - sender context, to match reply w/ request
137 */
138 define map_summary_stats
139 {
142 };
143 
144 /** \brief Reply for map_summary_stats request
145  @param context - sender context, to match reply w/ request
146  @param retval - return code for request
147  @param total_bindings -
148  @param total_pkts -
149  @param total_ip4_fragments -
150  @param total_security_check -
151 */
152 define map_summary_stats_reply
153 {
157  u64 total_pkts[2];
158  u64 total_bytes[2];
160  u64 total_security_check[2];
161 };
#define vl_api_version(n, v)
Definition: jvpp_registry.c:18
int i32
Definition: types.h:81
unsigned long u64
Definition: types.h:89
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56