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.
8 autoreply define sw_interface_set_flags
13 /* 1 = up, 0 = down */
17 /** \brief Set interface MTU
18 @param client_index - opaque cookie to identify the sender
19 @param context - sender context, to match reply w/ request
20 @param sw_if_index - index of the interface to set MTU on
23 autoreply define sw_interface_set_mtu
31 /** \brief Interface Event generated by want_interface_events
32 @param context - sender context, to match reply w/ request
33 @param sw_if_index - index of the interface of the event
34 @param admin_up_down - The administrative state; 1 = up, 0 = down
35 @param link_up_down - The operational state; 1 = up, 0 = down
36 @param deleted - interface was deleted
38 define sw_interface_event
47 /** \brief Register for interface events
48 @param client_index - opaque cookie to identify the sender
49 @param context - sender context, to match reply w/ request
50 @param enable_disable - 1 => register for events, 0 => cancel registration
51 @param pid - sender's pid
53 autoreply define want_interface_events
61 /** \brief Interface details structure (fix this)
62 @param sw_if_index - index of the interface
63 @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
64 @param l2_address_length - length of the interface's l2 address
65 @param pid - the interface's l2 address
66 @param interface_name - name of the interface
67 @param link_duplex - 1 if half duplex, 2 if full duplex
68 @param link_speed - 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
69 @param link_MTU - max. transmittion unit
70 @param sub_if_id - A number 0-N to uniquely identify this subif on super if
71 @param sub_dot1ad - 0 = dot1q, 1 = dot1ad
72 @param sub_dot1ah - 1 = dot1ah, 0 = otherwise
73 @param sub_number_of_tags - Number of tags (0 - 2)
74 @param sub_outer_vlan_id
75 @param sub_inner_vlan_id
76 @param sub_exact_match
78 @param sub_outer_vlan_id_any
79 @param sub_inner_vlan_id_any
80 @param vtr_op - vlan tag rewrite operation
84 @param pbb_outer_tag - translate pbb s-tag
85 @param pbb_b_dmac[6] - B-tag remote mac address
86 @param pbb_b_smac[6] - B-tag local mac address
87 @param pbb_b_vlanid - B-tag vlanid
88 @param pbb_i_sid - I-tag service id
90 define sw_interface_details
95 /* index of sup interface (e.g. hw interface).
96 equal to sw_if_index for super hw interface. */
99 /* Layer 2 address, if applicable */
100 u32 l2_address_length;
104 u8 interface_name[64];
106 /* 1 = up, 0 = down */
110 /* 1 = half duplex, 2 = full duplex */
113 /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
119 /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */
122 /* 0 = dot1q, 1=dot1ad */
124 /* 1 = dot1h, 1=otherwise */
127 /* Number of tags 0-2 */
128 u8 sub_number_of_tags;
129 u16 sub_outer_vlan_id;
130 u16 sub_inner_vlan_id;
133 u8 sub_outer_vlan_id_any;
134 u8 sub_inner_vlan_id_any;
136 /* vlan tag rewrite state */
138 u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
139 u32 vtr_tag1; // first pushed tag
140 u32 vtr_tag2; // second pushed tag
143 /* pbb tag rewrite info */
152 define sw_interface_dump
156 u8 name_filter_valid;
160 /** \brief Set or delete one or all ip addresses on a specified interface
161 @param client_index - opaque cookie to identify the sender
162 @param context - sender context, to match reply w/ request
163 @param sw_if_index - index of the interface to add/del addresses
164 @param is_add - add address if non-zero, else delete
165 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
166 @param del_all - if non-zero delete all addresses on the interface
167 @param address_length - address length in bytes, 4 for ip4, 16 for ip6
168 @param address - array of address bytes
170 autoreply define sw_interface_add_del_address
182 /** \brief Associate the specified interface with a fib table
183 @param client_index - opaque cookie to identify the sender
184 @param context - sender context, to match reply w/ request
185 @param sw_if_index - index of the interface
186 @param is_ipv6 - if non-zero ipv6, else ipv4
187 @param vrf_id - fib table/vrd id to associate the interface with
189 autoreply define sw_interface_set_table
198 /** \brief Get VRF id assigned to interface
199 @param client_index - opaque cookie to identify the sender
200 @param context - sender context, to match reply w/ request
201 @param sw_if_index - index of the interface
203 define sw_interface_get_table
211 /** \brief Reply to get_sw_interface_vrf
212 @param context - sender context which was passed in the request
213 @param vrf_id - VRF id assigned to the interface
215 define sw_interface_get_table_reply
222 typeonly manual_print manual_endian define vlib_counter
224 u64 packets; /**< packet counter */
225 u64 bytes; /**< byte counter */
228 /** \brief Simple stats counters structure
229 @param vnet_counter_type- such as ip4, ip6, punts, etc
230 @param first_sw_if_index - first sw index in block of index, counts
231 @param count - number of counters, equal to the number of interfaces in
233 @param data - contiguous block of u64 counters
235 manual_print manual_endian define vnet_interface_simple_counters
237 /* enums - plural - in vnet/interface.h */
238 u8 vnet_counter_type;
239 u32 first_sw_if_index;
244 /** \brief Combined stats counters structure
245 @param vnet_counter_type- such as ip4, ip6, punts, etc
246 @param first_sw_if_index - first sw index in block of index, counts
247 @param count - number of counters, equal to the number of interfaces in
249 @param data - contiguous block of vlib_counter_t structures
251 manual_print manual_endian define vnet_interface_combined_counters
253 /* enums - plural - in vnet/interface.h */
254 u8 vnet_counter_type;
255 u32 first_sw_if_index;
257 vl_api_vlib_counter_t data[count];
260 /** \brief Set unnumbered interface add / del request
261 @param client_index - opaque cookie to identify the sender
262 @param context - sender context, to match reply w/ request
263 @param sw_if_index - interface with an IP address
264 @param unnumbered_sw_if_index - interface which will use the address
265 @param is_add - if non-zero set the association, else unset it
267 autoreply define sw_interface_set_unnumbered
271 u32 sw_if_index; /* use this intfc address */
272 u32 unnumbered_sw_if_index; /* on this interface */
276 /** \brief Clear interface statistics
277 @param client_index - opaque cookie to identify the sender
278 @param context - sender context, to match reply w/ request
279 @param sw_if_index - index of the interface to clear statistics
281 autoreply define sw_interface_clear_stats
288 /** \brief Set / clear software interface tag
289 @param client_index - opaque cookie to identify the sender
290 @param context - sender context, to match reply w/ request
291 @param sw_if_index - the interface
292 @param add_del - 1 = add, 0 = delete
293 @param tag - an ascii tag
295 autoreply define sw_interface_tag_add_del
304 /** \brief Set an interface's MAC address
305 @param client_index - opaque cookie to identify the sender
306 @param context - sender context, to match reply w/ request
307 @param sw_if_index - the interface whose MAC will be set
308 @param mac_addr - the new MAC address
310 autoreply define sw_interface_set_mac_address
320 * eval: (c-set-style "gnu")