FD.io VPP  v17.07.01-10-g3be13f0
Vector Packet Processing
interface.api
Go to the documentation of this file.
1 /** \brief Set flags on the interface
2  @param client_index - opaque cookie to identify the sender
3  @param context - sender context, to match reply w/ request
4  @param sw_if_index - index of the interface to set flags on
5  @param admin_up_down - set the admin state, 1 = up, 0 = down
6  @param link_up_down - Oper state sent on change event, not used in config.
7  @param deleted - interface was deleted
8 */
9 autoreply define sw_interface_set_flags
10 {
14  /* 1 = up, 0 = down */
18 };
19 
20 /** \brief Set interface MTU
21  @param client_index - opaque cookie to identify the sender
22  @param context - sender context, to match reply w/ request
23  @param sw_if_index - index of the interface to set MTU on
24  @param mtu - MTU
25 */
26 autoreply define sw_interface_set_mtu
27 {
32 };
33 
34 /** \brief Register for interface events
35  @param client_index - opaque cookie to identify the sender
36  @param context - sender context, to match reply w/ request
37  @param enable_disable - 1 => register for events, 0 => cancel registration
38  @param pid - sender's pid
39 */
40 autoreply define want_interface_events
41 {
46 };
47 
48 /** \brief Interface details structure (fix this)
49  @param sw_if_index - index of the interface
50  @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
51  @param l2_address_length - length of the interface's l2 address
52  @param pid - the interface's l2 address
53  @param interface_name - name of the interface
54  @param link_duplex - 1 if half duplex, 2 if full duplex
55  @param link_speed - 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
56  @param link_MTU - max. transmittion unit
57  @param sub_if_id - A number 0-N to uniquely identify this subif on super if
58  @param sub_dot1ad - 0 = dot1q, 1 = dot1ad
59  @param sub_dot1ah - 1 = dot1ah, 0 = otherwise
60  @param sub_number_of_tags - Number of tags (0 - 2)
61  @param sub_outer_vlan_id
62  @param sub_inner_vlan_id
63  @param sub_exact_match
64  @param sub_default
65  @param sub_outer_vlan_id_any
66  @param sub_inner_vlan_id_any
67  @param vtr_op - vlan tag rewrite operation
68  @param vtr_push_dot1q
69  @param vtr_tag1
70  @param vtr_tag2
71  @param pbb_outer_tag - translate pbb s-tag
72  @param pbb_b_dmac[6] - B-tag remote mac address
73  @param pbb_b_smac[6] - B-tag local mac address
74  @param pbb_b_vlanid - B-tag vlanid
75  @param pbb_i_sid - I-tag service id
76 */
77 define sw_interface_details
78 {
81 
82  /* index of sup interface (e.g. hw interface).
83  equal to sw_if_index for super hw interface. */
85 
86  /* Layer 2 address, if applicable */
88  u8 l2_address[8];
89 
90  /* Interface name */
91  u8 interface_name[64];
92 
93  /* 1 = up, 0 = down */
96 
97  /* 1 = half duplex, 2 = full duplex */
99 
100  /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
102 
103  /* MTU */
105 
106  /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */
108 
109  /* 0 = dot1q, 1=dot1ad */
111  /* 1 = dot1h, 1=otherwise */
113 
114  /* Number of tags 0-2 */
122 
123  /* vlan tag rewrite state */
125  u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
126  u32 vtr_tag1; // first pushed tag
127  u32 vtr_tag2; // second pushed tag
128  u8 tag[64];
129 
130  /* pbb tag rewrite info */
132  u8 b_dmac[6];
133  u8 b_smac[6];
136 };
137 
138 /* works */
139 define sw_interface_dump
140 {
144  u8 name_filter[49];
145 };
146 
147 /** \brief Set or delete one or all ip addresses on a specified interface
148  @param client_index - opaque cookie to identify the sender
149  @param context - sender context, to match reply w/ request
150  @param sw_if_index - index of the interface to add/del addresses
151  @param is_add - add address if non-zero, else delete
152  @param is_ipv6 - if non-zero the address is ipv6, else ipv4
153  @param del_all - if non-zero delete all addresses on the interface
154  @param address_length - address length in bytes, 4 for ip4, 16 for ip6
155  @param address - array of address bytes
156 */
157 autoreply define sw_interface_add_del_address
158 {
166  u8 address[16];
167 };
168 
169 /** \brief Associate the specified interface with a fib table
170  @param client_index - opaque cookie to identify the sender
171  @param context - sender context, to match reply w/ request
172  @param sw_if_index - index of the interface
173  @param is_ipv6 - if non-zero ipv6, else ipv4
174  @param vrf_id - fib table/vrd id to associate the interface with
175 */
176 autoreply define sw_interface_set_table
177 {
183 };
184 
185 /** \brief Get VRF id assigned to interface
186  @param client_index - opaque cookie to identify the sender
187  @param context - sender context, to match reply w/ request
188  @param sw_if_index - index of the interface
189 */
190 define sw_interface_get_table
191 {
196 };
197 
198 /** \brief Reply to get_sw_interface_vrf
199  @param context - sender context which was passed in the request
200  @param vrf_id - VRF id assigned to the interface
201 */
202 define sw_interface_get_table_reply
203 {
207 };
208 
209 typeonly manual_print manual_endian define vlib_counter
210 {
211  u64 packets; /**< packet counter */
212  u64 bytes; /**< byte counter */
213 };
214 
215 /** \brief Simple stats counters structure
216  @param vnet_counter_type- such as ip4, ip6, punts, etc
217  @param first_sw_if_index - first sw index in block of index, counts
218  @param count - number of counters, equal to the number of interfaces in
219  this stats block
220  @param data - contiguous block of u64 counters
221 */
222 manual_print manual_endian define vnet_interface_simple_counters
223 {
224  /* enums - plural - in vnet/interface.h */
228  u64 data[count];
229 };
230 
231 /** \brief Combined stats counters structure
232  @param vnet_counter_type- such as ip4, ip6, punts, etc
233  @param first_sw_if_index - first sw index in block of index, counts
234  @param count - number of counters, equal to the number of interfaces in
235  this stats block
236  @param data - contiguous block of vlib_counter_t structures
237 */
238 manual_print manual_endian define vnet_interface_combined_counters
239 {
240  /* enums - plural - in vnet/interface.h */
245 };
246 
247 /** \brief Set unnumbered interface add / del request
248  @param client_index - opaque cookie to identify the sender
249  @param context - sender context, to match reply w/ request
250  @param sw_if_index - interface with an IP address
251  @param unnumbered_sw_if_index - interface which will use the address
252  @param is_add - if non-zero set the association, else unset it
253 */
254 autoreply define sw_interface_set_unnumbered
255 {
258  u32 sw_if_index; /* use this intfc address */
259  u32 unnumbered_sw_if_index; /* on this interface */
261 };
262 
263 /** \brief Clear interface statistics
264  @param client_index - opaque cookie to identify the sender
265  @param context - sender context, to match reply w/ request
266  @param sw_if_index - index of the interface to clear statistics
267 */
268 autoreply define sw_interface_clear_stats
269 {
273 };
274 
275 /** \brief Set / clear software interface tag
276  @param client_index - opaque cookie to identify the sender
277  @param context - sender context, to match reply w/ request
278  @param sw_if_index - the interface
279  @param add_del - 1 = add, 0 = delete
280  @param tag - an ascii tag
281 */
282 autoreply define sw_interface_tag_add_del
283 {
288  u8 tag[64];
289 };
290 
291 /** \brief Set an interface's MAC address
292  @param client_index - opaque cookie to identify the sender
293  @param context - sender context, to match reply w/ request
294  @param sw_if_index - the interface whose MAC will be set
295  @param mac_addr - the new MAC address
296 */
297 autoreply define sw_interface_set_mac_address
298 {
302  u8 mac_address[6];
303 };
304 
305 /*
306  * Local Variables:
307  * eval: (c-set-style "gnu")
308  * End:
309  */
int i32
Definition: types.h:81
u64 bytes
byte counter
Definition: interface.api:212
unsigned long u64
Definition: types.h:89
u64 packets
packet counter
Definition: interface.api:211
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56