1 # NB NB NB NB NB NB NB NB NB NB NB
3 # NOTE: The API binary wrappers in this file are in the process of being
4 # deprecated. DO NOT ADD NEW WRAPPERS HERE. Call the functions using
5 # named arguments directly instead.
10 from collections import deque
12 from six import moves, iteritems
13 from vpp_papi import VPPApiClient, mac_pton
15 from vpp_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID
19 # Dictionary keyed on message name to override default values for
23 'map_add_domain': {'mtu': 1280},
24 'syslog_set_sender': {'collector_port': 514,
26 'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
27 'acl_interface_list_dump': {'sw_if_index': 4294967295, },
28 'app_namespace_add_del': {'sw_if_index': 4294967295, },
29 'bd_ip_mac_add_del': {'is_add': 1, },
30 'bfd_udp_add': {'is_authenticated': False, 'bfd_key_id': None,
32 'bfd_udp_auth_activate': {'bfd_key_id': None, 'conf_key_id': None,
34 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
36 'bier_disp_table_add_del': {'is_add': 1, },
37 'bier_imp_add': {'is_add': 1, },
38 'bier_route_add_del': {'is_add': 1, },
39 'bier_table_add_del': {'is_add': 1, },
40 'bond_create': {'mac_address': '', 'id': 0xFFFFFFFF},
41 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
42 'learn': 1, 'is_add': 1, },
43 'bvi_create': {'user_instance': 4294967295, },
45 'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
46 'nbuckets': 2, 'memory_size': 2097152,
47 'next_table_index': 4294967295,
48 'miss_next_index': 4294967295, },
49 'dhcp6_client_enable_disable': {'enable': 1, },
50 'dhcp6_clients_enable_disable': {'enable': 1, },
51 'dhcp6_pd_client_enable_disable': {'enable': 1, },
52 'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
53 'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
54 'dhcp_proxy_config': {'is_add': 1, },
55 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
56 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
57 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
58 'decap_next_index': 4294967295, },
59 'gre_tunnel_add_del': {'instance': 4294967295, 'is_add': 1, },
60 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
61 'decap_next_index': 4294967295, },
62 'input_acl_set_interface': {'ip4_table_index': 4294967295,
63 'ip6_table_index': 4294967295,
64 'l2_table_index': 4294967295, },
65 'ip6_add_del_address_using_prefix': {'is_add': 1, },
66 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
67 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
68 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
69 'classify_table_index': 4294967295, 'is_add': 1, },
70 'ip_mroute_add_del': {'is_add': 1, },
71 'ip_neighbor_add_del': {'is_add': 1, },
72 'ip_punt_police': {'is_add': 1, },
73 'ip_punt_redirect': {'is_add': 1, },
74 'ip_route_add_del': {'is_add': 1, },
75 'ip_table_add_del': {'is_add': 1, },
76 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
77 'ipsec_interface_add_del_spd': {'is_add': 1, },
78 'ipsec_sad_entry_add_del': {'is_add': 1, },
79 'ipsec_spd_add_del': {'is_add': 1, },
80 'ipsec_spd_dump': {'sa_id': 4294967295, },
81 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
82 'remote_port_stop': 65535, 'priority': 100,
85 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
86 'l2_emulation': {'enable': 1, },
87 'l2fib_add_del': {'is_add': 1, },
88 'lb_conf': {'sticky_buckets_per_core': 4294967295,
89 'flow_timeout': 4294967295},
90 'lisp_add_del_adjacency': {'is_add': 1, },
91 'lisp_add_del_local_eid': {'is_add': 1, },
92 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
93 'lisp_add_del_locator_set': {'is_add': 1, },
94 'lisp_add_del_remote_mapping': {'is_add': 1, },
95 'macip_acl_add_replace': {'acl_index': 4294967295, },
96 'macip_acl_dump': {'acl_index': 4294967295, },
97 'macip_acl_interface_add_del': {'is_add': 1, },
98 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
99 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
100 'mr_next_hop_weight': 1,
101 'mr_next_hop_via_label': 1048576,
103 'mr_classify_table_index': 4294967295, },
104 'mpls_table_add_del': {'is_add': 1, },
105 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
106 'next_hop_weight': 1,
107 'next_hop_via_label': 1048576,
109 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
110 'output_acl_set_interface': {'ip4_table_index': 4294967295,
111 'ip6_table_index': 4294967295,
112 'l2_table_index': 4294967295, },
113 'pppoe_add_del_session': {'is_add': 1, },
114 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
115 'proxy_arp_add_del': {'is_add': 1, },
116 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
117 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
119 'set_ipfix_exporter': {'collector_port': 4739, },
120 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
121 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
122 'svs_enable_disable': {'is_enable': 1, },
123 'svs_route_add_del': {'is_add': 1, },
124 'svs_table_add_del': {'is_add': 1, },
125 'sw_interface_add_del_address': {'is_add': 1, },
126 'sw_interface_dump': {'sw_if_index': 4294967295, },
127 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
128 'pref_lifetime': 4294967295, },
129 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
130 'sw_interface_set_l2_bridge': {'enable': 1, },
131 'sw_interface_set_mpls_enable': {'enable': 1, },
132 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
133 'sw_interface_set_unnumbered': {'is_add': 1, },
134 'sw_interface_span_enable_disable': {'state': 1, },
135 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
136 'decap_next_index': 4294967295,
137 'instance': 4294967295, },
138 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
139 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
141 'want_bfd_events': {'enable_disable': 1, },
142 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
143 'want_dhcp6_reply_events': {'enable_disable': 1, },
144 'want_igmp_events': {'enable': 1, },
145 'want_interface_events': {'enable_disable': 1, },
146 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
147 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
148 'want_ip6_ra_events': {'enable_disable': 1, },
149 'want_l2_macs_events': {'enable_disable': 1, },
153 class CliFailedCommandError(Exception):
154 """ cli command failed."""
157 class CliSyntaxError(Exception):
158 """ cli command had a syntax error."""
161 class UnexpectedApiReturnValueError(Exception):
162 """ exception raised when the API return value is unexpected """
166 class VppPapiProvider(object):
167 """VPP-api provider using vpp-papi
169 @property hook: hook object providing before and after api/cli hooks
172 _zero, _negative = range(2)
174 def __init__(self, name, shm_prefix, test_class, read_timeout):
175 self.hook = Hook(test_class)
177 self.shm_prefix = shm_prefix
178 self.test_class = test_class
179 self._expect_api_retval = self._zero
180 self._expect_stack = []
182 # install_dir is a class attribute. We need to set it before
183 # calling the constructor.
184 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
188 if os.environ['SOCKET'] == '1':
193 self.vpp = VPPApiClient(logger=test_class.logger,
194 read_timeout=read_timeout,
195 use_socket=use_socket,
196 server_address=test_class.api_sock)
197 self._events = deque()
202 def assert_negative_api_retval(self):
203 """ Expect API failure - used with with, e.g.:
204 with self.vapi.assert_negative_api_retval():
205 self.vapi.<api call expected to fail>
207 self._expect_stack.append(self._expect_api_retval)
208 self._expect_api_retval = self._negative
211 def assert_zero_api_retval(self):
212 """ Expect API success - used with with, e.g.:
213 with self.vapi.assert_negative_api_retval():
214 self.vapi.<api call expected to succeed>
216 note: this is useful only inside another with block
217 as success is the default expected value
219 self._expect_stack.append(self._expect_api_retval)
220 self._expect_api_retval = self._zero
223 def __exit__(self, exc_type, exc_value, traceback):
224 self._expect_api_retval = self._expect_stack.pop()
226 def register_hook(self, hook):
227 """Replace hook registration with new hook
234 def collect_events(self):
235 """ Collect all events from the internal queue and clear the queue. """
237 self._events = deque()
240 def wait_for_event(self, timeout, name=None):
241 """ Wait for and return next event. """
243 self.test_class.logger.debug("Expecting event '%s' within %ss",
246 self.test_class.logger.debug("Expecting event within %ss",
249 self.test_class.logger.debug("Not waiting, event already queued")
250 limit = time.time() + timeout
251 while time.time() < limit:
253 e = self._events.popleft()
254 if name and type(e).__name__ != name:
256 "Unexpected event received: %s, expected: %s" %
257 (type(e).__name__, name))
258 self.test_class.logger.debug("Returning event %s:%s" %
261 self.test_class.sleep(0) # yield
262 raise Exception("Event did not occur within timeout")
264 def __call__(self, name, event):
265 """ Enqueue event in the internal event queue. """
266 # FIXME use the name instead of relying on type(e).__name__ ?
267 # FIXME #2 if this throws, it is eaten silently, Ole?
268 self.test_class.logger.debug("New event: %s: %s" % (name, event))
269 self._events.append(event)
271 def factory(self, name, apifn):
273 fields = apifn._func.msg.fields
275 # add positional and kw arguments
277 for i, o in enumerate(fields[3:]):
280 except BaseException:
284 if name in defaultmapping:
285 for k, v in iteritems(defaultmapping[name]):
289 return self.api(apifn, d)
293 def __getattribute__(self, name):
295 method = super(VppPapiProvider, self).__getattribute__(name)
296 except AttributeError:
297 method = self.factory(name, getattr(self.papi, name))
298 # lazily load the method so we don't need to call factory
299 # again for this name.
300 setattr(self, name, method)
304 """Connect the API to VPP"""
305 self.vpp.connect(self.name, self.shm_prefix)
306 self.papi = self.vpp.api
307 self.vpp.register_event_callback(self)
309 def disconnect(self):
310 """Disconnect the API from VPP"""
311 self.vpp.disconnect()
313 def api(self, api_fn, api_args, expected_retval=0):
314 """ Call API function and check it's return value.
315 Call the appropriate hooks before and after the API call
317 :param api_fn: API function to call
318 :param api_args: tuple of API function arguments
319 :param expected_retval: Expected return value (Default value = 0)
320 :returns: reply from the API
323 self.hook.before_api(api_fn.__name__, api_args)
324 reply = api_fn(**api_args)
325 if self._expect_api_retval == self._negative:
326 if hasattr(reply, 'retval') and reply.retval >= 0:
327 msg = "API call passed unexpectedly: expected negative " \
328 "return value instead of %d in %s" % \
329 (reply.retval, moves.reprlib.repr(reply))
330 self.test_class.logger.info(msg)
331 raise UnexpectedApiReturnValueError(msg)
332 elif self._expect_api_retval == self._zero:
333 if hasattr(reply, 'retval') and reply.retval != expected_retval:
334 msg = "API call failed, expected %d return value instead " \
335 "of %d in %s" % (expected_retval, reply.retval,
337 self.test_class.logger.info(msg)
338 raise UnexpectedApiReturnValueError(msg)
340 raise Exception("Internal error, unexpected value for "
341 "self._expect_api_retval %s" %
342 self._expect_api_retval)
343 self.hook.after_api(api_fn.__name__, api_args)
347 """ Execute a CLI, calling the before/after hooks appropriately.
349 :param cli: CLI to execute
353 self.hook.before_cli(cli)
355 r = self.papi.cli_inband(cmd=cli)
356 self.hook.after_cli(cli)
358 raise CliSyntaxError(r.reply)
360 raise CliFailedCommandError(r.reply)
361 if hasattr(r, 'reply'):
364 def ppcli(self, cli):
365 """ Helper method to print CLI command in case of info logging level.
367 :param cli: CLI to execute
370 return cli + "\n" + str(self.cli(cli))
372 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
373 return self.api(self.papi.want_ip4_arp_events,
374 {'enable_disable': enable_disable,
376 'pid': os.getpid(), })
378 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
379 return self.api(self.papi.want_ip6_nd_events,
380 {'enable_disable': enable_disable,
382 'pid': os.getpid(), })
384 def want_ip6_ra_events(self, enable_disable=1):
385 return self.api(self.papi.want_ip6_ra_events,
386 {'enable_disable': enable_disable,
387 'pid': os.getpid(), })
389 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
391 return self.api(self.papi.ip6nd_send_router_solicitation,
396 'sw_if_index': sw_if_index})
398 def want_interface_events(self, enable_disable=1):
399 return self.api(self.papi.want_interface_events,
400 {'enable_disable': enable_disable,
401 'pid': os.getpid(), })
403 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
404 max_macs_in_event=0, learn_limit=0):
405 return self.api(self.papi.want_l2_macs_events,
406 {'enable_disable': enable_disable,
407 'scan_delay': scan_delay,
408 'max_macs_in_event': max_macs_in_event,
409 'learn_limit': learn_limit,
410 'pid': os.getpid(), })
412 def want_dhcp6_reply_events(self, enable_disable=1):
413 return self.api(self.papi.want_dhcp6_reply_events,
414 {'enable_disable': enable_disable,
417 def want_dhcp6_pd_reply_events(self, enable_disable=1):
418 return self.api(self.papi.want_dhcp6_pd_reply_events,
419 {'enable_disable': enable_disable,
422 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
423 prefixes, server_index=0xFFFFFFFF,
424 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
426 return self.api(self.papi.dhcp6_pd_send_client_message,
427 {'sw_if_index': sw_if_index,
428 'server_index': server_index,
434 'msg_type': msg_type,
437 'n_prefixes': len(prefixes),
438 'prefixes': prefixes})
440 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
442 return self.api(self.papi.dhcp6_client_enable_disable,
443 {'sw_if_index': sw_if_index,
446 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
448 return self.api(self.papi.dhcp6_pd_client_enable_disable,
449 {'sw_if_index': sw_if_index,
450 'prefix_group': prefix_group,
453 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
454 prefix_length, prefix_group,
456 return self.api(self.papi.ip6_add_del_address_using_prefix,
457 {'sw_if_index': sw_if_index,
458 'prefix_group': prefix_group,
460 'prefix_length': prefix_length,
463 def sw_interface_set_mac_address(self, sw_if_index, mac):
464 return self.api(self.papi.sw_interface_set_mac_address,
465 {'sw_if_index': sw_if_index,
468 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
469 """Create p2p ethernet subinterface
471 :param sw_if_index: main (parent) interface
472 :param remote_mac: client (remote) mac address
476 self.papi.p2p_ethernet_add,
477 {'parent_if_index': sw_if_index,
478 'remote_mac': remote_mac,
479 'subif_id': subif_id})
481 def p2p_ethernet_del(self, sw_if_index, remote_mac):
482 """Delete p2p ethernet subinterface
484 :param sw_if_index: main (parent) interface
485 :param remote_mac: client (remote) mac address
489 self.papi.p2p_ethernet_del,
490 {'parent_if_index': sw_if_index,
491 'remote_mac': remote_mac})
493 def create_vlan_subif(self, sw_if_index, vlan):
500 return self.api(self.papi.create_vlan_subif,
501 {'sw_if_index': sw_if_index,
504 def create_loopback(self, mac=''):
507 :param mac: (Optional)
509 return self.api(self.papi.create_loopback,
510 {'mac_address': mac})
512 def ip_table_add_del(self,
519 :param is_add: (Default value = 1)
520 :param is_ipv6: (Default value = 0)
525 self.papi.ip_table_add_del,
528 'table_id': table_id,
533 def ip_table_dump(self):
534 return self.api(self.papi.ip_table_dump, {})
536 def ip_route_dump(self, table_id, is_ip6=False):
537 return self.api(self.papi.ip_route_dump,
539 'table_id': table_id,
543 def ip_neighbor_add_del(self,
549 """ Add neighbor MAC to IPv4 or IPv6 address.
554 :param is_add: (Default value = 1)
555 :param flags: (Default value = 0/NONE)
558 self.papi.ip_neighbor_add_del,
562 'sw_if_index': sw_if_index,
564 'mac_address': mac_address,
565 'ip_address': ip_address
570 def proxy_arp_add_del(self,
575 """ Config Proxy Arp Range.
577 :param low_address: Start address in the rnage to Proxy for
578 :param hi_address: End address in the rnage to Proxy for
579 :param vrf_id: The VRF/table in which to proxy
583 self.papi.proxy_arp_add_del,
586 'table_id': table_id,
592 def proxy_arp_intfc_enable_disable(self,
595 """ Enable/Disable an interface for proxy ARP requests
597 :param sw_if_index: Interface
598 :param enable_disable: Enable/Disable
602 self.papi.proxy_arp_intfc_enable_disable,
603 {'sw_if_index': sw_if_index,
604 'enable_disable': is_enable
608 def gre_tunnel_add_del(self,
620 :param outer_fib_id: (Default value = 0)
621 :param tunnel_type: (Default value = 0)
622 :param instance: (Default value = 0xFFFFFFFF)
623 :param session_id: (Default value = 0)
624 :param is_add: (Default value = 1)
625 :param is_ipv6: (Default value = 0)
629 self.papi.gre_tunnel_add_del,
634 'instance': instance,
637 'outer_fib_id': outer_fib_id,
638 'session_id': session_id}
642 def udp_encap_add(self,
653 :param outer_fib_id: (Default value = 0)
657 self.papi.udp_encap_add,
662 'src_port': src_port,
663 'dst_port': dst_port,
668 def udp_encap_del(self, id):
669 return self.api(self.papi.udp_encap_del, {'id': id})
671 def udp_encap_dump(self):
672 return self.api(self.papi.udp_encap_dump, {})
674 def want_udp_encap_stats(self, enable=1):
675 return self.api(self.papi.want_udp_encap_stats,
679 def mpls_route_dump(self, table_id):
680 return self.api(self.papi.mpls_route_dump,
682 'mt_table_id': table_id
685 def mpls_table_dump(self):
686 return self.api(self.papi.mpls_table_dump, {})
688 def mpls_table_add_del(
695 :param is_add: (Default value = 1)
700 self.papi.mpls_table_add_del,
703 'mt_table_id': table_id,
705 'mt_is_add': is_add})
707 def mpls_route_add_del(self,
716 """ MPLS Route add/del """
718 self.papi.mpls_route_add_del,
721 'mr_table_id': table_id,
724 'mr_eos_proto': eos_proto,
725 'mr_is_multicast': is_multicast,
726 'mr_n_paths': len(paths),
730 'mr_is_multipath': is_multipath})
732 def mpls_ip_bind_unbind(
742 self.papi.mpls_ip_bind_unbind,
743 {'mb_mpls_table_id': table_id,
745 'mb_ip_table_id': ip_table_id,
746 'mb_is_bind': is_bind,
747 'mb_prefix': prefix})
749 def mpls_tunnel_add_del(
759 self.papi.mpls_tunnel_add_del,
760 {'mt_is_add': is_add,
763 'mt_sw_if_index': tun_sw_if_index,
764 'mt_l2_only': l2_only,
765 'mt_is_multicast': is_multicast,
766 'mt_n_paths': len(paths),
770 def classify_add_del_table(
775 table_index=0xFFFFFFFF,
779 next_table_index=0xFFFFFFFF,
780 miss_next_index=0xFFFFFFFF,
782 current_data_offset=0):
786 :param match_n_vectors: (Default value = 1)
787 :param table_index: (Default value = 0xFFFFFFFF)
788 :param nbuckets: (Default value = 2)
789 :param memory_size: (Default value = 2097152)
790 :param skip_n_vectors: (Default value = 0)
791 :param next_table_index: (Default value = 0xFFFFFFFF)
792 :param miss_next_index: (Default value = 0xFFFFFFFF)
793 :param current_data_flag: (Default value = 0)
794 :param current_data_offset: (Default value = 0)
797 mask_len = ((len(mask) - 1) / 16 + 1) * 16
798 mask = mask + '\0' * (mask_len - len(mask))
800 self.papi.classify_add_del_table,
802 'table_index': table_index,
803 'nbuckets': nbuckets,
804 'memory_size': memory_size,
805 'skip_n_vectors': skip_n_vectors,
806 'match_n_vectors': match_n_vectors,
807 'next_table_index': next_table_index,
808 'miss_next_index': miss_next_index,
809 'current_data_flag': current_data_flag,
810 'current_data_offset': current_data_offset,
811 'mask_len': mask_len,
814 def classify_add_del_session(
819 opaque_index=0xFFFFFFFF,
820 hit_next_index=0xFFFFFFFF,
828 :param opaque_index: (Default value = 0xFFFFFFFF)
829 :param hit_next_index: (Default value = 0xFFFFFFFF)
830 :param advance: (Default value = 0)
831 :param action: (Default value = 0)
832 :param metadata: (Default value = 0)
835 match_len = ((len(match) - 1) / 16 + 1) * 16
836 match = match + '\0' * (match_len - len(match))
838 self.papi.classify_add_del_session,
840 'table_index': table_index,
841 'hit_next_index': hit_next_index,
842 'opaque_index': opaque_index,
845 'metadata': metadata,
846 'match_len': match_len,
849 def input_acl_set_interface(
853 ip4_table_index=0xFFFFFFFF,
854 ip6_table_index=0xFFFFFFFF,
855 l2_table_index=0xFFFFFFFF):
859 :param ip4_table_index: (Default value = 0xFFFFFFFF)
860 :param ip6_table_index: (Default value = 0xFFFFFFFF)
861 :param l2_table_index: (Default value = 0xFFFFFFFF)
865 self.papi.input_acl_set_interface,
866 {'sw_if_index': sw_if_index,
867 'ip4_table_index': ip4_table_index,
868 'ip6_table_index': ip6_table_index,
869 'l2_table_index': l2_table_index,
872 def output_acl_set_interface(
876 ip4_table_index=0xFFFFFFFF,
877 ip6_table_index=0xFFFFFFFF,
878 l2_table_index=0xFFFFFFFF):
882 :param ip4_table_index: (Default value = 0xFFFFFFFF)
883 :param ip6_table_index: (Default value = 0xFFFFFFFF)
884 :param l2_table_index: (Default value = 0xFFFFFFFF)
888 self.papi.output_acl_set_interface,
889 {'sw_if_index': sw_if_index,
890 'ip4_table_index': ip4_table_index,
891 'ip6_table_index': ip6_table_index,
892 'l2_table_index': l2_table_index,
895 def set_ipfix_exporter(
905 self.papi.set_ipfix_exporter,
907 'collector_address': collector_address,
908 'collector_port': collector_port,
909 'src_address': src_address,
911 'path_mtu': path_mtu,
912 'template_interval': template_interval,
913 'udp_checksum': udp_checksum,
916 def dhcp_proxy_config(self,
924 self.papi.dhcp_proxy_config,
926 'rx_vrf_id': rx_table_id,
927 'server_vrf_id': server_table_id,
930 'dhcp_server': dhcp_server,
931 'dhcp_src_address': dhcp_src_address,
934 def dhcp_proxy_set_vss(self,
943 self.papi.dhcp_proxy_set_vss,
946 'vss_type': vss_type,
947 'vpn_ascii_id': vpn_ascii_id,
949 'vpn_index': vpn_index,
954 def dhcp_client_config(self,
959 set_broadcast_flag=1,
963 self.papi.dhcp_client_config,
967 'sw_if_index': sw_if_index,
968 'hostname': hostname,
970 'want_dhcp_event': want_dhcp_events,
971 'set_broadcast_flag': set_broadcast_flag,
976 def ip_mroute_add_del(self,
985 IP Multicast Route add/del
988 self.papi.ip_mroute_add_del,
991 'is_multipath': is_multipath,
993 'table_id': table_id,
994 'entry_flags': e_flags,
997 'n_paths': len(paths),
1002 def mfib_signal_dump(self):
1003 return self.api(self.papi.mfib_signal_dump, {})
1005 def ip_mroute_dump(self, table_id, is_ip6=False):
1006 return self.api(self.papi.ip_mroute_dump,
1008 'table_id': table_id,
1012 def lisp_enable_disable(self, is_enabled):
1014 self.papi.lisp_enable_disable,
1016 'is_en': is_enabled,
1019 def lisp_add_del_locator_set(self,
1023 self.papi.lisp_add_del_locator_set,
1026 'locator_set_name': ls_name
1029 def lisp_add_del_locator(self,
1036 self.papi.lisp_add_del_locator,
1039 'locator_set_name': ls_name,
1040 'sw_if_index': sw_if_index,
1041 'priority': priority,
1045 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1047 self.papi.lisp_locator_dump,
1049 'is_index_set': is_index_set,
1051 'ls_index': ls_index,
1054 def lisp_add_del_local_eid(self,
1064 self.papi.lisp_add_del_local_eid,
1066 'locator_set_name': ls_name,
1068 'eid_type': eid_type,
1070 'prefix_len': prefix_len,
1076 def lisp_eid_table_dump(self,
1084 self.papi.lisp_eid_table_dump,
1087 'prefix_length': prefix_length,
1089 'eid_type': eid_type,
1091 'filter': filter_opt,
1094 def lisp_add_del_remote_mapping(self,
1104 self.papi.lisp_add_del_remote_mapping,
1107 'eid_type': eid_type,
1109 'eid_len': eid_prefix_len,
1110 'rloc_num': rlocs_num,
1113 'is_src_dst': is_src_dst,
1116 def lisp_add_del_adjacency(self,
1125 self.papi.lisp_add_del_adjacency,
1129 'eid_type': eid_type,
1132 'leid_len': leid_len,
1133 'reid_len': reid_len,
1136 def gtpu_add_del_tunnel(
1142 mcast_sw_if_index=0xFFFFFFFF,
1144 decap_next_index=0xFFFFFFFF,
1148 :param is_add: (Default value = 1)
1149 :param is_ipv6: (Default value = 0)
1152 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1153 :param encap_vrf_id: (Default value = 0)
1154 :param decap_next_index: (Default value = 0xFFFFFFFF)
1155 :param teid: (Default value = 0)
1158 return self.api(self.papi.gtpu_add_del_tunnel,
1161 'src_address': src_addr,
1162 'dst_address': dst_addr,
1163 'mcast_sw_if_index': mcast_sw_if_index,
1164 'encap_vrf_id': encap_vrf_id,
1165 'decap_next_index': decap_next_index,
1168 def vxlan_gpe_add_del_tunnel(
1172 mcast_sw_if_index=0xFFFFFFFF,
1183 :param is_add: (Default value = 1)
1184 :param is_ipv6: (Default value = 0)
1185 :param encap_vrf_id: (Default value = 0)
1186 :param decap_vrf_id: (Default value = 0)
1187 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1188 :param protocol: (Default value = 3)
1189 :param vni: (Default value = 0)
1192 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1197 'mcast_sw_if_index': mcast_sw_if_index,
1198 'encap_vrf_id': encap_vrf_id,
1199 'decap_vrf_id': decap_vrf_id,
1200 'protocol': protocol,
1203 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1204 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1205 {'sw_if_index': sw_if_index,
1206 '_no_type_conversion': True})
1208 def pppoe_add_del_session(
1218 :param is_add: (Default value = 1)
1219 :param is_ipv6: (Default value = 0)
1221 :param session_id: (Default value = 0)
1223 :param decap_vrf_id: (Default value = 0)
1226 return self.api(self.papi.pppoe_add_del_session,
1229 'session_id': session_id,
1230 'client_ip': client_ip,
1231 'decap_vrf_id': decap_vrf_id,
1232 'client_mac': client_mac})
1234 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1235 return self.api(self.papi.sr_mpls_policy_add,
1239 'n_segments': len(segments),
1240 'segments': segments})
1242 def sr_mpls_policy_del(self, bsid):
1243 return self.api(self.papi.sr_mpls_policy_del,
1246 def sr_localsid_add_del(self,
1253 sw_if_index=0xFFFFFFFF,
1257 """ Add/del IPv6 SR local-SID.
1260 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1261 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1264 :param is_del: (Default value = 0)
1265 :param end_psp: (Default value = 0)
1266 :param sw_if_index: (Default value = 0xFFFFFFFF)
1267 :param vlan_index: (Default value = 0)
1268 :param fib_table: (Default value = 0)
1271 self.papi.sr_localsid_add_del,
1273 'localsid': localsid,
1275 'behavior': behavior,
1276 'sw_if_index': sw_if_index,
1277 'vlan_index': vlan_index,
1278 'fib_table': fib_table,
1279 'nh_addr4': nh_addr4,
1280 'nh_addr6': nh_addr6
1294 :param bsid_addr: bindingSID of the SR Policy
1295 :param weight: weight of the sid list. optional. (default: 1)
1296 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1298 :param type: type/behavior of the SR policy. (default or spray) \
1300 :param fib_table: VRF where to install the FIB entry for the BSID \
1302 :param n_segments: number of segments \
1304 :param segments: a vector of IPv6 address composing the segment list \
1308 self.papi.sr_policy_add,
1309 {'bsid_addr': bsid_addr,
1311 'is_encap': is_encap,
1313 'fib_table': fib_table,
1314 'n_segments': n_segments,
1315 'segments': segments
1324 :param bsid: bindingSID of the SR Policy
1325 :param sr_policy_index: index of the sr policy (default: 0)
1328 self.papi.sr_policy_del,
1329 {'bsid_addr': bsid_addr,
1330 'sr_policy_index': sr_policy_index
1333 def sr_steering_add_del(
1344 Steer traffic L2 and L3 traffic through a given SR policy
1346 :param is_del: delete or add
1347 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1348 :param sr_policy: is the index of the SR Policy (alt to bsid)
1349 :param table_id: is the VRF where to install the FIB entry for the BSID
1350 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1351 :param mask_width: is the mask for L3 traffic type
1352 :param sw_if_index: is the incoming interface for L2 traffic
1353 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1356 self.papi.sr_steering_add_del,
1358 'bsid_addr': bsid_addr,
1359 'sr_policy_index': sr_policy_index,
1360 'table_id': table_id,
1361 'prefix_addr': prefix_addr,
1362 'mask_width': mask_width,
1363 'sw_if_index': sw_if_index,
1364 'traffic_type': traffic_type
1367 def acl_add_replace(self, acl_index, r, tag='',
1369 """Add/replace an ACL
1370 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1371 :param acl_rule r: ACL rules array.
1372 :param str tag: symbolic tag (description) for this ACL.
1373 :param int count: number of rules.
1375 return self.api(self.papi.acl_add_replace,
1376 {'acl_index': acl_index,
1380 expected_retval=expected_retval)
1382 def acl_del(self, acl_index, expected_retval=0):
1388 return self.api(self.papi.acl_del,
1389 {'acl_index': acl_index},
1390 expected_retval=expected_retval)
1392 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1394 return self.api(self.papi.acl_interface_set_acl_list,
1395 {'sw_if_index': sw_if_index,
1399 expected_retval=expected_retval)
1401 def acl_interface_set_etype_whitelist(self, sw_if_index,
1404 return self.api(self.papi.acl_interface_set_etype_whitelist,
1405 {'sw_if_index': sw_if_index,
1406 'count': len(whitelist),
1408 'whitelist': whitelist},
1409 expected_retval=expected_retval)
1411 def acl_interface_add_del(self,
1415 """ Add/Delete ACL to/from interface
1419 :param is_add: (Default value = 1)
1422 return self.api(self.papi.acl_interface_add_del,
1425 'sw_if_index': sw_if_index,
1426 'acl_index': acl_index})
1428 def acl_dump(self, acl_index, expected_retval=0):
1429 return self.api(self.papi.acl_dump,
1430 {'acl_index': acl_index},
1431 expected_retval=expected_retval)
1433 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1435 return self.api(self.papi.acl_interface_list_dump,
1436 {'sw_if_index': sw_if_index},
1437 expected_retval=expected_retval)
1439 def macip_acl_add(self, rules, tag=""):
1442 :param rules: list of rules for given acl
1446 return self.api(self.papi.macip_acl_add,
1448 'count': len(rules),
1451 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1454 :param rules: list of rules for given acl
1458 return self.api(self.papi.macip_acl_add_replace,
1459 {'acl_index': acl_index,
1461 'count': len(rules),
1464 def macip_acl_interface_add_del(self,
1468 """ Add MACIP acl to interface
1472 :param is_add: (Default value = 1)
1475 return self.api(self.papi.macip_acl_interface_add_del,
1477 'sw_if_index': sw_if_index,
1478 'acl_index': acl_index})
1480 def macip_acl_dump(self, acl_index=4294967295):
1481 """ Return MACIP acl dump
1485 self.papi.macip_acl_dump, {'acl_index': acl_index})
1487 def policer_add_del(self,
1498 conform_action_type=1,
1500 exceed_action_type=0,
1502 violate_action_type=0,
1504 return self.api(self.papi.policer_add_del,
1511 'rate_type': rate_type,
1512 'round_type': round_type,
1514 'color_aware': color_aware,
1515 'conform_action_type': conform_action_type,
1516 'conform_dscp': conform_dscp,
1517 'exceed_action_type': exceed_action_type,
1518 'exceed_dscp': exceed_dscp,
1519 'violate_action_type': violate_action_type,
1520 'violate_dscp': violate_dscp})
1522 def ip_punt_police(self,
1526 return self.api(self.papi.ip_punt_police,
1527 {'policer_index': policer_index,
1531 def ip_punt_redirect(self,
1536 return self.api(self.papi.ip_punt_redirect,
1537 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1538 'tx_sw_if_index': tx_sw_if_index,
1542 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1543 return self.api(self.papi.ip_punt_redirect_dump,
1544 {'sw_if_index': sw_if_index,
1545 'is_ipv6': is_ipv6})
1547 def bier_table_add_del(self,
1551 """ BIER Table add/del """
1553 self.papi.bier_table_add_del,
1554 {'bt_tbl_id': {"bt_set": bti.set_id,
1555 "bt_sub_domain": bti.sub_domain_id,
1556 "bt_hdr_len_id": bti.hdr_len_id},
1557 'bt_label': mpls_label,
1558 'bt_is_add': is_add})
1560 def bier_table_dump(self):
1561 return self.api(self.papi.bier_table_dump, {})
1563 def bier_route_add_del(self,
1569 """ BIER Route add/del """
1571 self.papi.bier_route_add_del,
1574 'br_tbl_id': {"bt_set": bti.set_id,
1575 "bt_sub_domain": bti.sub_domain_id,
1576 "bt_hdr_len_id": bti.hdr_len_id},
1578 'br_n_paths': len(paths),
1581 'br_is_add': is_add,
1582 'br_is_replace': is_replace
1585 def bier_route_dump(self, bti):
1587 self.papi.bier_route_dump,
1588 {'br_tbl_id': {"bt_set": bti.set_id,
1589 "bt_sub_domain": bti.sub_domain_id,
1590 "bt_hdr_len_id": bti.hdr_len_id}})
1592 def bier_imp_add(self,
1597 """ BIER Imposition Add """
1599 self.papi.bier_imp_add,
1600 {'bi_tbl_id': {"bt_set": bti.set_id,
1601 "bt_sub_domain": bti.sub_domain_id,
1602 "bt_hdr_len_id": bti.hdr_len_id},
1604 'bi_n_bytes': len(ibytes),
1605 'bi_bytes': ibytes})
1607 def bier_imp_del(self, bi_index):
1608 """ BIER Imposition del """
1610 self.papi.bier_imp_del,
1611 {'bi_index': bi_index})
1613 def bier_imp_dump(self):
1614 return self.api(self.papi.bier_imp_dump, {})
1616 def bier_disp_table_add_del(self,
1619 """ BIER Disposition Table add/del """
1621 self.papi.bier_disp_table_add_del,
1622 {'bdt_tbl_id': bdti,
1623 'bdt_is_add': is_add})
1625 def bier_disp_table_dump(self):
1626 return self.api(self.papi.bier_disp_table_dump, {})
1628 def bier_disp_entry_add_del(self,
1638 """ BIER Route add/del """
1640 while (len(lstack) < 16):
1643 self.papi.bier_disp_entry_add_del,
1644 {'bde_tbl_id': bdti,
1646 'bde_payload_proto': payload_proto,
1648 'bde_paths': [{'table_id': next_hop_tbl_id,
1649 'rpf_id': next_hop_rpf_id,
1651 'label_stack': lstack}],
1652 'bde_is_add': is_add})
1654 def bier_disp_entry_dump(self, bdti):
1656 self.papi.bier_disp_entry_dump,
1657 {'bde_tbl_id': bdti})
1659 def session_enable_disable(self, is_enabled):
1661 self.papi.session_enable_disable,
1662 {'is_enable': is_enabled})
1664 def ipsec_spd_add_del(self, spd_id, is_add=1):
1665 """ SPD add/del - Wrapper to add or del ipsec SPD
1666 Sample CLI : 'ipsec spd add 1'
1668 :param spd_id - SPD ID to be created in the vpp . mandatory
1669 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1671 :returns: reply from the API
1674 self.papi.ipsec_spd_add_del, {
1675 'spd_id': spd_id, 'is_add': is_add})
1677 def ipsec_spds_dump(self):
1678 return self.api(self.papi.ipsec_spds_dump, {})
1680 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1681 """ IPSEC interface SPD add/del - \
1682 Wrapper to associate/disassociate SPD to interface in VPP
1683 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1685 :param spd_id - SPD ID to associate with the interface . mandatory
1686 :param sw_if_index - Interface Index which needs to ipsec \
1687 association mandatory
1688 :param is_add - add(1) or del(0) association with interface \
1689 (Default 1 - add) . optional
1690 :returns: reply from the API
1693 self.papi.ipsec_interface_add_del_spd,
1694 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1696 def ipsec_spd_interface_dump(self, spd_index=None):
1697 return self.api(self.papi.ipsec_spd_interface_dump,
1698 {'spd_index': spd_index if spd_index else 0,
1699 'spd_index_valid': 1 if spd_index else 0})
1701 def ipsec_sad_entry_add_del(self,
1704 integrity_algorithm,
1709 tunnel_src_address='',
1710 tunnel_dst_address='',
1714 """ IPSEC SA add/del
1715 :param sad_id: security association ID
1716 :param spi: security param index of the SA in decimal
1717 :param integrity_algorithm:
1718 :param integrity_key:
1719 :param crypto_algorithm:
1721 :param protocol: AH(0) or ESP(1) protocol
1722 :param tunnel_src_address: tunnel mode outer src address
1723 :param tunnel_dst_address: tunnel mode outer dst address
1726 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1727 crypto and ipsec algorithms
1730 self.papi.ipsec_sad_entry_add_del,
1737 'tunnel_src': tunnel_src_address,
1738 'tunnel_dst': tunnel_dst_address,
1739 'protocol': protocol,
1740 'integrity_algorithm': integrity_algorithm,
1742 'length': len(integrity_key),
1743 'data': integrity_key,
1745 'crypto_algorithm': crypto_algorithm,
1747 'length': len(crypto_key),
1755 def ipsec_sa_dump(self, sa_id=None):
1756 return self.api(self.papi.ipsec_sa_dump,
1757 {'sa_id': sa_id if sa_id else 0xffffffff})
1759 def ipsec_spd_entry_add_del(self,
1762 local_address_start,
1764 remote_address_start,
1765 remote_address_stop,
1767 local_port_stop=65535,
1768 remote_port_start=0,
1769 remote_port_stop=65535,
1777 """ IPSEC policy SPD add/del -
1778 Wrapper to configure ipsec SPD policy entries in VPP
1779 :param spd_id: SPD ID for the policy
1780 :param local_address_start: local-ip-range start address
1781 :param local_address_stop : local-ip-range stop address
1782 :param remote_address_start: remote-ip-range start address
1783 :param remote_address_stop : remote-ip-range stop address
1784 :param local_port_start: (Default value = 0)
1785 :param local_port_stop: (Default value = 65535)
1786 :param remote_port_start: (Default value = 0)
1787 :param remote_port_stop: (Default value = 65535)
1788 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1789 :param sa_id: Security Association ID for mapping it to SPD
1790 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1792 :param priority: value for the spd action (Default value = 100)
1793 :param is_outbound: flag for inbound(0) or outbound(1)
1795 :param is_add: (Default value = 1)
1798 self.papi.ipsec_spd_entry_add_del,
1805 'local_address_start': local_address_start,
1806 'local_address_stop': local_address_stop,
1807 'remote_address_start': remote_address_start,
1808 'remote_address_stop': remote_address_stop,
1809 'local_port_start': local_port_start,
1810 'local_port_stop': local_port_stop,
1811 'remote_port_start': remote_port_start,
1812 'remote_port_stop': remote_port_stop,
1813 'protocol': protocol,
1815 'priority': priority,
1816 'is_outbound': is_outbound,
1820 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1821 return self.api(self.papi.ipsec_spd_dump,
1825 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1826 remote_spi, crypto_alg, local_crypto_key,
1827 remote_crypto_key, integ_alg, local_integ_key,
1828 remote_integ_key, is_add=1, esn=0, salt=0,
1829 anti_replay=1, renumber=0,
1830 udp_encap=0, show_instance=0):
1832 self.papi.ipsec_tunnel_if_add_del,
1834 'local_ip': local_ip,
1835 'remote_ip': remote_ip,
1836 'local_spi': local_spi,
1837 'remote_spi': remote_spi,
1838 'crypto_alg': crypto_alg,
1839 'local_crypto_key_len': len(local_crypto_key),
1840 'local_crypto_key': local_crypto_key,
1841 'remote_crypto_key_len': len(remote_crypto_key),
1842 'remote_crypto_key': remote_crypto_key,
1843 'integ_alg': integ_alg,
1844 'local_integ_key_len': len(local_integ_key),
1845 'local_integ_key': local_integ_key,
1846 'remote_integ_key_len': len(remote_integ_key),
1847 'remote_integ_key': remote_integ_key,
1850 'anti_replay': anti_replay,
1851 'renumber': renumber,
1852 'show_instance': show_instance,
1853 'udp_encap': udp_encap,
1857 def ipsec_select_backend(self, protocol, index):
1858 return self.api(self.papi.ipsec_select_backend,
1859 {'protocol': protocol, 'index': index})
1861 def ipsec_backend_dump(self):
1862 return self.api(self.papi.ipsec_backend_dump, {})
1864 def app_namespace_add_del(self,
1868 sw_if_index=0xFFFFFFFF,
1871 self.papi.app_namespace_add_del,
1873 'sw_if_index': sw_if_index,
1874 'ip4_fib_id': ip4_fib_id,
1875 'ip6_fib_id': ip6_fib_id,
1876 'namespace_id': namespace_id,
1877 'namespace_id_len': len(namespace_id)})
1879 def punt_socket_register(self, reg, pathname,
1881 """ Register punt socket """
1882 return self.api(self.papi.punt_socket_register,
1883 {'header_version': header_version,
1885 'pathname': pathname})
1887 def punt_socket_deregister(self, reg):
1888 """ Unregister punt socket """
1889 return self.api(self.papi.punt_socket_deregister,
1892 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1894 """ GBP endpoint Add """
1895 return self.api(self.papi.gbp_endpoint_add,
1897 'sw_if_index': sw_if_index,
1908 def gbp_endpoint_del(self, handle):
1909 """ GBP endpoint Del """
1910 return self.api(self.papi.gbp_endpoint_del,
1913 def gbp_endpoint_dump(self):
1914 """ GBP endpoint Dump """
1915 return self.api(self.papi.gbp_endpoint_dump,
1916 {'_no_type_conversion': True})
1918 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1919 rd, uplink_sw_if_index,
1921 """ GBP endpoint group Add """
1922 return self.api(self.papi.gbp_endpoint_group_add,
1925 'uplink_sw_if_index': uplink_sw_if_index,
1930 'retention': retention
1933 def gbp_endpoint_group_del(self, sclass):
1934 """ GBP endpoint group Del """
1935 return self.api(self.papi.gbp_endpoint_group_del,
1938 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1941 bm_flood_sw_if_index):
1942 """ GBP bridge-domain Add """
1943 return self.api(self.papi.gbp_bridge_domain_add,
1947 'bvi_sw_if_index': bvi_sw_if_index,
1948 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1949 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1954 def gbp_bridge_domain_del(self, bd_id):
1955 """ GBP bridge-domain Del """
1956 return self.api(self.papi.gbp_bridge_domain_del,
1959 def gbp_route_domain_add(self, rd_id,
1964 ip6_uu_sw_if_index):
1965 """ GBP route-domain Add """
1966 return self.api(self.papi.gbp_route_domain_add,
1970 'ip4_table_id': ip4_table_id,
1971 'ip6_table_id': ip6_table_id,
1972 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1973 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1977 def gbp_route_domain_del(self, rd_id):
1978 """ GBP route-domain Del """
1979 return self.api(self.papi.gbp_route_domain_del,
1982 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1983 """ GBP recirc Add/Del """
1984 return self.api(self.papi.gbp_recirc_add_del,
1988 'sw_if_index': sw_if_index,
1991 def gbp_recirc_dump(self):
1992 """ GBP recirc Dump """
1993 return self.api(self.papi.gbp_recirc_dump, {})
1995 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1996 """ GBP recirc Add/Del """
1997 return self.api(self.papi.gbp_ext_itf_add_del,
2000 'sw_if_index': sw_if_index,
2005 def gbp_ext_itf_dump(self):
2006 """ GBP recirc Dump """
2007 return self.api(self.papi.gbp_ext_itf_dump, {})
2009 def gbp_subnet_add_del(self, is_add, rd_id,
2011 sw_if_index=0xffffffff,
2013 """ GBP Subnet Add/Del """
2014 return self.api(self.papi.gbp_subnet_add_del,
2018 'sw_if_index': sw_if_index,
2023 def gbp_subnet_dump(self):
2024 """ GBP Subnet Dump """
2025 return self.api(self.papi.gbp_subnet_dump,
2026 {'_no_type_conversion': True})
2028 def gbp_contract_dump(self):
2029 """ GBP contract Dump """
2030 return self.api(self.papi.gbp_contract_dump, {})
2032 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2033 """ GBP VXLAN tunnel add """
2034 return self.api(self.papi.gbp_vxlan_tunnel_add,
2039 'bd_rd_id': bd_rd_id,
2044 def gbp_vxlan_tunnel_del(self, vni):
2045 """ GBP VXLAN tunnel del """
2046 return self.api(self.papi.gbp_vxlan_tunnel_del,
2051 def gbp_vxlan_tunnel_dump(self):
2052 """ GBP VXLAN tunnel add/del """
2053 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2055 def igmp_enable_disable(self, sw_if_index, enable, host):
2056 """ Enable/disable IGMP on a given interface """
2057 return self.api(self.papi.igmp_enable_disable,
2060 'sw_if_index': sw_if_index})
2062 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2063 """ Add/del IGMP proxy device """
2064 return self.api(self.papi.igmp_proxy_device_add_del,
2065 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2068 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2069 """ Add/del interface to/from IGMP proxy device """
2070 return self.api(self.papi.igmp_proxy_device_add_del_interface,
2071 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2074 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2075 """ Listen for new (S,G) on specified interface
2077 :param enable: add/del
2078 :param sw_if_index: interface sw index
2079 :param saddr: source ip4 addr
2080 :param gaddr: group ip4 addr
2082 return self.api(self.papi.igmp_listen,
2087 'sw_if_index': sw_if_index,
2088 'n_srcs': len(saddrs),
2094 def igmp_clear_interface(self, sw_if_index):
2095 """ Remove all (S,G)s from specified interface
2096 doesn't send IGMP report!
2099 self.papi.igmp_clear_interface, {
2100 'sw_if_index': sw_if_index})
2102 def want_igmp_events(self, enable=1):
2103 return self.api(self.papi.want_igmp_events, {'enable': enable,
2104 'pid': os.getpid()})
2113 interface_id=0xFFFFFFFF):
2116 :param lb: load balance
2117 :param numa_only: tx on local numa node for lacp mode
2118 :param use_custom_mac: use custom mac
2119 :param mac_address: mac address
2120 :param interface_id: custom interface ID
2123 self.papi.bond_create,
2126 'numa_only': numa_only,
2127 'use_custom_mac': use_custom_mac,
2128 'mac_address': mac_address,
2132 def pipe_delete(self, parent_sw_if_index):
2133 return self.api(self.papi.pipe_delete,
2134 {'parent_sw_if_index': parent_sw_if_index})
2136 def svs_table_add_del(self, af, table_id, is_add=1):
2137 return self.api(self.papi.svs_table_add_del,
2139 'table_id': table_id,
2144 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2145 return self.api(self.papi.svs_route_add_del,
2147 'table_id': table_id,
2148 'source_table_id': src_table_id,
2153 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2154 return self.api(self.papi.svs_enable_disable,
2157 'table_id': table_id,
2158 'sw_if_index': sw_if_index,
2159 'is_enable': is_enable,