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
18 # Dictionary keyed on message name to override default values for
23 'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
24 'bd_ip_mac_add_del': {'is_add': 1, },
25 'bfd_udp_add': {'is_authenticated': False, 'bfd_key_id': None,
27 'bfd_udp_auth_activate': {'bfd_key_id': None, 'conf_key_id': None,
29 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
31 'bier_disp_table_add_del': {'is_add': 1, },
32 'bier_imp_add': {'is_add': 1, },
33 'bier_route_add_del': {'is_add': 1, },
34 'bier_table_add_del': {'is_add': 1, },
35 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
36 'learn': 1, 'is_add': 1, },
38 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
39 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
40 'decap_next_index': 4294967295, },
41 'input_acl_set_interface': {'ip4_table_index': 4294967295,
42 'ip6_table_index': 4294967295,
43 'l2_table_index': 4294967295, },
44 'ip6_add_del_address_using_prefix': {'is_add': 1, },
45 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
46 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
47 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
48 'classify_table_index': 4294967295, 'is_add': 1, },
49 'ip_mroute_add_del': {'is_add': 1, },
50 'ip_neighbor_add_del': {'is_add': 1, },
51 'ip_route_add_del': {'is_add': 1, },
52 'ipsec_interface_add_del_spd': {'is_add': 1, },
53 'ipsec_spd_add_del': {'is_add': 1, },
54 'ipsec_spd_dump': {'sa_id': 4294967295, },
55 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
56 'remote_port_stop': 65535, 'priority': 100,
59 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
60 'l2_emulation': {'enable': 1, },
61 'l2fib_add_del': {'is_add': 1, },
62 'lisp_add_del_adjacency': {'is_add': 1, },
63 'lisp_add_del_local_eid': {'is_add': 1, },
64 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
65 'lisp_add_del_locator_set': {'is_add': 1, },
66 'lisp_add_del_remote_mapping': {'is_add': 1, },
67 'macip_acl_interface_add_del': {'is_add': 1, },
68 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
69 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
70 'mr_next_hop_weight': 1,
71 'mr_next_hop_via_label': 1048576,
73 'mr_classify_table_index': 4294967295, },
74 'mpls_table_add_del': {'is_add': 1, },
75 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
77 'next_hop_via_label': 1048576,
79 'output_acl_set_interface': {'ip4_table_index': 4294967295,
80 'ip6_table_index': 4294967295,
81 'l2_table_index': 4294967295, },
82 'pppoe_add_del_session': {'is_add': 1, },
83 'policer_add_del': {'is_add': 1, 'conform_action': {'type': 1}, },
84 'set_ipfix_exporter': {'collector_port': 4739, },
85 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
86 'sw_interface_add_del_address': {'is_add': 1, },
87 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
88 'pref_lifetime': 4294967295, },
89 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
90 'sw_interface_set_l2_bridge': {'enable': 1, },
91 'sw_interface_set_mpls_enable': {'enable': 1, },
92 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
93 'sw_interface_set_unnumbered': {'is_add': 1, },
94 'sw_interface_span_enable_disable': {'state': 1, },
95 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
96 'decap_next_index': 4294967295,
97 'instance': 4294967295, },
98 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
100 'want_bfd_events': {'enable_disable': 1, },
101 'want_igmp_events': {'enable': 1, },
102 'want_interface_events': {'enable_disable': 1, },
103 'want_l2_macs_events': {'enable_disable': 1, 'pid': os.getpid(), },
104 'want_l2_macs_events2': {'enable_disable': 1, 'pid': os.getpid(), },
108 def as_fn_signature(d):
109 return ", ".join(f"{k}={v}" for k, v in d.items())
112 class CliFailedCommandError(Exception):
113 """ cli command failed."""
116 class CliSyntaxError(Exception):
117 """ cli command had a syntax error."""
120 class UnexpectedApiReturnValueError(Exception):
121 """ exception raised when the API return value is unexpected """
125 class VppPapiProvider(object):
126 """VPP-api provider using vpp-papi
128 @property hook: hook object providing before and after api/cli hooks
131 _zero, _negative = range(2)
133 def __init__(self, name, test_class, read_timeout):
134 self.hook = Hook(test_class)
136 self.test_class = test_class
137 self._expect_api_retval = self._zero
138 self._expect_stack = []
140 # install_dir is a class attribute. We need to set it before
141 # calling the constructor.
142 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
144 self.vpp = VPPApiClient(logger=test_class.logger,
145 read_timeout=read_timeout,
147 server_address=test_class.api_sock)
148 self._events = queue.Queue()
153 def assert_negative_api_retval(self):
154 """ Expect API failure - used with with, e.g.:
155 with self.vapi.assert_negative_api_retval():
156 self.vapi.<api call expected to fail>
158 self._expect_stack.append(self._expect_api_retval)
159 self._expect_api_retval = self._negative
162 def assert_zero_api_retval(self):
163 """ Expect API success - used with with, e.g.:
164 with self.vapi.assert_negative_api_retval():
165 self.vapi.<api call expected to succeed>
167 note: this is useful only inside another with block
168 as success is the default expected value
170 self._expect_stack.append(self._expect_api_retval)
171 self._expect_api_retval = self._zero
174 def __exit__(self, exc_type, exc_value, traceback):
175 self._expect_api_retval = self._expect_stack.pop()
177 def register_hook(self, hook):
178 """Replace hook registration with new hook
185 def collect_events(self):
186 """ Collect all events from the internal queue and clear the queue. """
190 e = self._events.get(block=False)
196 def wait_for_event(self, timeout, name=None):
197 """ Wait for and return next event. """
199 self.test_class.logger.debug("Expecting event '%s' within %ss",
202 self.test_class.logger.debug("Expecting event within %ss",
205 e = self._events.get(timeout=timeout)
207 raise Exception("Event did not occur within timeout")
208 msgname = type(e).__name__
209 if name and msgname != name:
210 raise Exception("Unexpected event received: %s, expected: %s"
212 self.test_class.logger.debug("Returning event %s:%s" % (name, e))
215 def __call__(self, name, event):
216 """ Enqueue event in the internal event queue. """
217 self.test_class.logger.debug("New event: %s: %s" % (name, event))
218 self._events.put(event)
220 def factory(self, name, apifn):
222 fields = apifn._func.msg.fields
224 # add positional and kw arguments
226 for i, o in enumerate(fields[3:]):
229 except BaseException:
233 if name in defaultmapping:
234 for k, v in iteritems(defaultmapping[name]):
238 return self.api(apifn, d)
242 def __getattribute__(self, name):
244 method = super(VppPapiProvider, self).__getattribute__(name)
245 except AttributeError:
246 method = self.factory(name, getattr(self.papi, name))
247 # lazily load the method so we don't need to call factory
248 # again for this name.
249 setattr(self, name, method)
253 """Connect the API to VPP"""
254 # This might be called before VPP is prepared to listen to the socket
256 while not os.path.exists(self.test_class.api_sock):
261 self.vpp.connect(self.name[:63])
262 self.papi = self.vpp.api
263 self.vpp.register_event_callback(self)
265 def disconnect(self):
266 """Disconnect the API from VPP"""
267 self.vpp.disconnect()
269 def api(self, api_fn, api_args, expected_retval=0):
270 """ Call API function and check it's return value.
271 Call the appropriate hooks before and after the API call
273 :param api_fn: API function to call
274 :param api_args: tuple of API function arguments
275 :param expected_retval: Expected return value (Default value = 0)
276 :returns: reply from the API
279 self.hook.before_api(api_fn.__name__, api_args)
280 reply = api_fn(**api_args)
281 if self._expect_api_retval == self._negative:
282 if hasattr(reply, 'retval') and reply.retval >= 0:
283 msg = "%s(%s) passed unexpectedly: expected negative " \
284 "return value instead of %d in %s" % \
285 (api_fn.__name__, as_fn_signature(api_args),
287 moves.reprlib.repr(reply))
288 self.test_class.logger.info(msg)
289 raise UnexpectedApiReturnValueError(msg)
290 elif self._expect_api_retval == self._zero:
291 if hasattr(reply, 'retval') and reply.retval != expected_retval:
292 msg = "%s(%s) failed, expected %d return value instead " \
293 "of %d in %s" % (api_fn.__name__,
294 as_fn_signature(api_args),
295 expected_retval, reply.retval,
297 self.test_class.logger.info(msg)
298 raise UnexpectedApiReturnValueError(msg)
300 raise Exception("Internal error, unexpected value for "
301 "self._expect_api_retval %s" %
302 self._expect_api_retval)
303 self.hook.after_api(api_fn.__name__, api_args)
306 def cli_return_response(self, cli):
307 """ Execute a CLI, calling the before/after hooks appropriately.
308 Return the reply without examining it
310 :param cli: CLI to execute
311 :returns: response object
314 self.hook.before_cli(cli)
316 r = self.papi.cli_inband(cmd=cli)
317 self.hook.after_cli(cli)
321 """ Execute a CLI, calling the before/after hooks appropriately.
323 :param cli: CLI to execute
327 r = self.cli_return_response(cli)
329 raise CliSyntaxError(r.reply)
331 raise CliFailedCommandError(r.reply)
332 if hasattr(r, 'reply'):
335 def ppcli(self, cli):
336 """ Helper method to print CLI command in case of info logging level.
338 :param cli: CLI to execute
341 return cli + "\n" + self.cli(cli)
343 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
345 return self.api(self.papi.ip6nd_send_router_solicitation,
350 'sw_if_index': sw_if_index})
352 def want_interface_events(self, enable_disable=1):
353 return self.api(self.papi.want_interface_events,
354 {'enable_disable': enable_disable,
355 'pid': os.getpid(), })
357 def sw_interface_set_mac_address(self, sw_if_index, mac):
358 return self.api(self.papi.sw_interface_set_mac_address,
359 {'sw_if_index': sw_if_index,
362 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
363 """Create p2p ethernet subinterface
365 :param sw_if_index: main (parent) interface
366 :param remote_mac: client (remote) mac address
370 self.papi.p2p_ethernet_add,
371 {'parent_if_index': sw_if_index,
372 'remote_mac': remote_mac,
373 'subif_id': subif_id})
375 def p2p_ethernet_del(self, sw_if_index, remote_mac):
376 """Delete p2p ethernet subinterface
378 :param sw_if_index: main (parent) interface
379 :param remote_mac: client (remote) mac address
383 self.papi.p2p_ethernet_del,
384 {'parent_if_index': sw_if_index,
385 'remote_mac': remote_mac})
387 def create_vlan_subif(self, sw_if_index, vlan):
394 return self.api(self.papi.create_vlan_subif,
395 {'sw_if_index': sw_if_index,
398 def create_loopback(self, mac=''):
401 :param mac: (Optional)
403 return self.api(self.papi.create_loopback,
404 {'mac_address': mac})
406 def ip_route_dump(self, table_id, is_ip6=False):
407 return self.api(self.papi.ip_route_dump,
409 'table_id': table_id,
413 def ip_neighbor_add_del(self,
419 """ Add neighbor MAC to IPv4 or IPv6 address.
424 :param is_add: (Default value = 1)
425 :param flags: (Default value = 0/NONE)
428 self.papi.ip_neighbor_add_del,
432 'sw_if_index': sw_if_index,
434 'mac_address': mac_address,
435 'ip_address': ip_address
440 def udp_encap_add(self,
451 :param outer_fib_id: (Default value = 0)
455 self.papi.udp_encap_add,
460 'src_port': src_port,
461 'dst_port': dst_port,
466 def udp_encap_del(self, id):
467 return self.api(self.papi.udp_encap_del, {'id': id})
469 def udp_encap_dump(self):
470 return self.api(self.papi.udp_encap_dump, {})
472 def want_udp_encap_stats(self, enable=1):
473 return self.api(self.papi.want_udp_encap_stats,
477 def mpls_route_dump(self, table_id):
478 return self.api(self.papi.mpls_route_dump,
480 'mt_table_id': table_id
483 def mpls_table_dump(self):
484 return self.api(self.papi.mpls_table_dump, {})
486 def mpls_table_add_del(
493 :param is_add: (Default value = 1)
498 self.papi.mpls_table_add_del,
501 'mt_table_id': table_id,
503 'mt_is_add': is_add})
505 def mpls_route_add_del(self,
514 """ MPLS Route add/del """
516 self.papi.mpls_route_add_del,
519 'mr_table_id': table_id,
522 'mr_eos_proto': eos_proto,
523 'mr_is_multicast': is_multicast,
524 'mr_n_paths': len(paths),
528 'mr_is_multipath': is_multipath})
530 def mpls_ip_bind_unbind(
540 self.papi.mpls_ip_bind_unbind,
541 {'mb_mpls_table_id': table_id,
543 'mb_ip_table_id': ip_table_id,
544 'mb_is_bind': is_bind,
545 'mb_prefix': prefix})
547 def mpls_tunnel_add_del(
557 self.papi.mpls_tunnel_add_del,
558 {'mt_is_add': is_add,
561 'mt_sw_if_index': tun_sw_if_index,
562 'mt_l2_only': l2_only,
563 'mt_is_multicast': is_multicast,
564 'mt_n_paths': len(paths),
568 def input_acl_set_interface(
572 ip4_table_index=0xFFFFFFFF,
573 ip6_table_index=0xFFFFFFFF,
574 l2_table_index=0xFFFFFFFF):
578 :param ip4_table_index: (Default value = 0xFFFFFFFF)
579 :param ip6_table_index: (Default value = 0xFFFFFFFF)
580 :param l2_table_index: (Default value = 0xFFFFFFFF)
584 self.papi.input_acl_set_interface,
585 {'sw_if_index': sw_if_index,
586 'ip4_table_index': ip4_table_index,
587 'ip6_table_index': ip6_table_index,
588 'l2_table_index': l2_table_index,
591 def output_acl_set_interface(
595 ip4_table_index=0xFFFFFFFF,
596 ip6_table_index=0xFFFFFFFF,
597 l2_table_index=0xFFFFFFFF):
601 :param ip4_table_index: (Default value = 0xFFFFFFFF)
602 :param ip6_table_index: (Default value = 0xFFFFFFFF)
603 :param l2_table_index: (Default value = 0xFFFFFFFF)
607 self.papi.output_acl_set_interface,
608 {'sw_if_index': sw_if_index,
609 'ip4_table_index': ip4_table_index,
610 'ip6_table_index': ip6_table_index,
611 'l2_table_index': l2_table_index,
614 def set_ipfix_exporter(
624 self.papi.set_ipfix_exporter,
626 'collector_address': collector_address,
627 'collector_port': collector_port,
628 'src_address': src_address,
630 'path_mtu': path_mtu,
631 'template_interval': template_interval,
632 'udp_checksum': udp_checksum,
635 def mfib_signal_dump(self):
636 return self.api(self.papi.mfib_signal_dump, {})
638 def ip_mroute_dump(self, table_id, is_ip6=False):
639 return self.api(self.papi.ip_mroute_dump,
641 'table_id': table_id,
645 def vxlan_gpe_add_del_tunnel(
649 mcast_sw_if_index=0xFFFFFFFF,
660 :param is_add: (Default value = 1)
661 :param is_ipv6: (Default value = 0)
662 :param encap_vrf_id: (Default value = 0)
663 :param decap_vrf_id: (Default value = 0)
664 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
665 :param protocol: (Default value = 3)
666 :param vni: (Default value = 0)
669 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
674 'mcast_sw_if_index': mcast_sw_if_index,
675 'encap_vrf_id': encap_vrf_id,
676 'decap_vrf_id': decap_vrf_id,
677 'protocol': protocol,
680 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
681 return self.api(self.papi.vxlan_gbp_tunnel_dump,
682 {'sw_if_index': sw_if_index})
684 def pppoe_add_del_session(
693 :param is_add: (Default value = 1)
694 :param is_ipv6: (Default value = 0)
696 :param session_id: (Default value = 0)
698 :param decap_vrf_id: (Default value = 0)
701 return self.api(self.papi.pppoe_add_del_session,
703 'session_id': session_id,
704 'client_ip': client_ip,
705 'decap_vrf_id': decap_vrf_id,
706 'client_mac': client_mac})
708 def sr_mpls_policy_add(self, bsid, weight, type, segments):
709 return self.api(self.papi.sr_mpls_policy_add,
713 'n_segments': len(segments),
714 'segments': segments})
716 def sr_mpls_policy_del(self, bsid):
717 return self.api(self.papi.sr_mpls_policy_del,
720 def bier_table_add_del(self,
724 """ BIER Table add/del """
726 self.papi.bier_table_add_del,
727 {'bt_tbl_id': {"bt_set": bti.set_id,
728 "bt_sub_domain": bti.sub_domain_id,
729 "bt_hdr_len_id": bti.hdr_len_id},
730 'bt_label': mpls_label,
731 'bt_is_add': is_add})
733 def bier_table_dump(self):
734 return self.api(self.papi.bier_table_dump, {})
736 def bier_route_add_del(self,
742 """ BIER Route add/del """
744 self.papi.bier_route_add_del,
747 'br_tbl_id': {"bt_set": bti.set_id,
748 "bt_sub_domain": bti.sub_domain_id,
749 "bt_hdr_len_id": bti.hdr_len_id},
751 'br_n_paths': len(paths),
755 'br_is_replace': is_replace
758 def bier_route_dump(self, bti):
760 self.papi.bier_route_dump,
761 {'br_tbl_id': {"bt_set": bti.set_id,
762 "bt_sub_domain": bti.sub_domain_id,
763 "bt_hdr_len_id": bti.hdr_len_id}})
765 def bier_imp_add(self,
770 """ BIER Imposition Add """
772 self.papi.bier_imp_add,
773 {'bi_tbl_id': {"bt_set": bti.set_id,
774 "bt_sub_domain": bti.sub_domain_id,
775 "bt_hdr_len_id": bti.hdr_len_id},
777 'bi_n_bytes': len(ibytes),
780 def bier_imp_del(self, bi_index):
781 """ BIER Imposition del """
783 self.papi.bier_imp_del,
784 {'bi_index': bi_index})
786 def bier_imp_dump(self):
787 return self.api(self.papi.bier_imp_dump, {})
789 def bier_disp_table_add_del(self,
792 """ BIER Disposition Table add/del """
794 self.papi.bier_disp_table_add_del,
796 'bdt_is_add': is_add})
798 def bier_disp_table_dump(self):
799 return self.api(self.papi.bier_disp_table_dump, {})
801 def bier_disp_entry_add_del(self,
811 """ BIER Route add/del """
813 while (len(lstack) < 16):
816 self.papi.bier_disp_entry_add_del,
819 'bde_payload_proto': payload_proto,
821 'bde_paths': [{'table_id': next_hop_tbl_id,
822 'rpf_id': next_hop_rpf_id,
824 'label_stack': lstack}],
825 'bde_is_add': is_add})
827 def bier_disp_entry_dump(self, bdti):
829 self.papi.bier_disp_entry_dump,
830 {'bde_tbl_id': bdti})
832 def ipsec_spd_add_del(self, spd_id, is_add=1):
833 """ SPD add/del - Wrapper to add or del ipsec SPD
834 Sample CLI : 'ipsec spd add 1'
836 :param spd_id - SPD ID to be created in the vpp . mandatory
837 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
839 :returns: reply from the API
842 self.papi.ipsec_spd_add_del, {
843 'spd_id': spd_id, 'is_add': is_add})
845 def ipsec_spds_dump(self):
846 return self.api(self.papi.ipsec_spds_dump, {})
848 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
849 """ IPSEC interface SPD add/del - \
850 Wrapper to associate/disassociate SPD to interface in VPP
851 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
853 :param spd_id - SPD ID to associate with the interface . mandatory
854 :param sw_if_index - Interface Index which needs to ipsec \
855 association mandatory
856 :param is_add - add(1) or del(0) association with interface \
857 (Default 1 - add) . optional
858 :returns: reply from the API
861 self.papi.ipsec_interface_add_del_spd,
862 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
864 def ipsec_spd_interface_dump(self, spd_index=None):
865 return self.api(self.papi.ipsec_spd_interface_dump,
866 {'spd_index': spd_index if spd_index else 0,
867 'spd_index_valid': 1 if spd_index else 0})
869 def ipsec_spd_entry_add_del(self,
874 remote_address_start,
877 local_port_stop=65535,
879 remote_port_stop=65535,
887 """ IPSEC policy SPD add/del -
888 Wrapper to configure ipsec SPD policy entries in VPP
889 :param spd_id: SPD ID for the policy
890 :param local_address_start: local-ip-range start address
891 :param local_address_stop : local-ip-range stop address
892 :param remote_address_start: remote-ip-range start address
893 :param remote_address_stop : remote-ip-range stop address
894 :param local_port_start: (Default value = 0)
895 :param local_port_stop: (Default value = 65535)
896 :param remote_port_start: (Default value = 0)
897 :param remote_port_stop: (Default value = 65535)
898 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
899 :param sa_id: Security Association ID for mapping it to SPD
900 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
902 :param priority: value for the spd action (Default value = 100)
903 :param is_outbound: flag for inbound(0) or outbound(1)
905 :param is_add: (Default value = 1)
908 self.papi.ipsec_spd_entry_add_del,
915 'local_address_start': local_address_start,
916 'local_address_stop': local_address_stop,
917 'remote_address_start': remote_address_start,
918 'remote_address_stop': remote_address_stop,
919 'local_port_start': local_port_start,
920 'local_port_stop': local_port_stop,
921 'remote_port_start': remote_port_start,
922 'remote_port_stop': remote_port_stop,
923 'protocol': protocol,
925 'priority': priority,
926 'is_outbound': is_outbound,
930 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
931 return self.api(self.papi.ipsec_spd_dump,
935 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
936 remote_spi, crypto_alg, local_crypto_key,
937 remote_crypto_key, integ_alg, local_integ_key,
938 remote_integ_key, is_add=1, esn=0, salt=0,
939 anti_replay=1, renumber=0,
940 udp_encap=0, show_instance=0xffffffff):
942 self.papi.ipsec_tunnel_if_add_del,
944 'local_ip': local_ip,
945 'remote_ip': remote_ip,
946 'local_spi': local_spi,
947 'remote_spi': remote_spi,
948 'crypto_alg': crypto_alg,
949 'local_crypto_key_len': len(local_crypto_key),
950 'local_crypto_key': local_crypto_key,
951 'remote_crypto_key_len': len(remote_crypto_key),
952 'remote_crypto_key': remote_crypto_key,
953 'integ_alg': integ_alg,
954 'local_integ_key_len': len(local_integ_key),
955 'local_integ_key': local_integ_key,
956 'remote_integ_key_len': len(remote_integ_key),
957 'remote_integ_key': remote_integ_key,
960 'anti_replay': anti_replay,
961 'renumber': renumber,
962 'show_instance': show_instance,
963 'udp_encap': udp_encap,
967 def ipsec_select_backend(self, protocol, index):
968 return self.api(self.papi.ipsec_select_backend,
969 {'protocol': protocol, 'index': index})
971 def ipsec_backend_dump(self):
972 return self.api(self.papi.ipsec_backend_dump, {})
974 def punt_socket_register(self, reg, pathname,
976 """ Register punt socket """
977 return self.api(self.papi.punt_socket_register,
978 {'header_version': header_version,
980 'pathname': pathname})
982 def punt_socket_deregister(self, reg):
983 """ Unregister punt socket """
984 return self.api(self.papi.punt_socket_deregister,
987 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
989 """ GBP endpoint Add """
990 return self.api(self.papi.gbp_endpoint_add,
992 'sw_if_index': sw_if_index,
1003 def gbp_endpoint_del(self, handle):
1004 """ GBP endpoint Del """
1005 return self.api(self.papi.gbp_endpoint_del,
1008 def gbp_endpoint_dump(self):
1009 """ GBP endpoint Dump """
1010 return self.api(self.papi.gbp_endpoint_dump, {})
1012 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1013 rd, uplink_sw_if_index,
1015 """ GBP endpoint group Add """
1016 return self.api(self.papi.gbp_endpoint_group_add,
1019 'uplink_sw_if_index': uplink_sw_if_index,
1024 'retention': retention
1027 def gbp_endpoint_group_del(self, sclass):
1028 """ GBP endpoint group Del """
1029 return self.api(self.papi.gbp_endpoint_group_del,
1032 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1035 bm_flood_sw_if_index):
1036 """ GBP bridge-domain Add """
1037 return self.api(self.papi.gbp_bridge_domain_add,
1041 'bvi_sw_if_index': bvi_sw_if_index,
1042 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1043 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1048 def gbp_bridge_domain_del(self, bd_id):
1049 """ GBP bridge-domain Del """
1050 return self.api(self.papi.gbp_bridge_domain_del,
1053 def gbp_route_domain_add(self, rd_id,
1058 ip6_uu_sw_if_index):
1059 """ GBP route-domain Add """
1060 return self.api(self.papi.gbp_route_domain_add,
1064 'ip4_table_id': ip4_table_id,
1065 'ip6_table_id': ip6_table_id,
1066 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1067 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1071 def gbp_route_domain_del(self, rd_id):
1072 """ GBP route-domain Del """
1073 return self.api(self.papi.gbp_route_domain_del,
1076 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1077 """ GBP recirc Add/Del """
1078 return self.api(self.papi.gbp_recirc_add_del,
1082 'sw_if_index': sw_if_index,
1085 def gbp_recirc_dump(self):
1086 """ GBP recirc Dump """
1087 return self.api(self.papi.gbp_recirc_dump, {})
1089 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1090 """ GBP recirc Add/Del """
1091 return self.api(self.papi.gbp_ext_itf_add_del,
1094 'sw_if_index': sw_if_index,
1099 def gbp_ext_itf_dump(self):
1100 """ GBP recirc Dump """
1101 return self.api(self.papi.gbp_ext_itf_dump, {})
1103 def gbp_subnet_add_del(self, is_add, rd_id,
1105 sw_if_index=0xffffffff,
1107 """ GBP Subnet Add/Del """
1108 return self.api(self.papi.gbp_subnet_add_del,
1112 'sw_if_index': sw_if_index,
1117 def gbp_subnet_dump(self):
1118 """ GBP Subnet Dump """
1119 return self.api(self.papi.gbp_subnet_dump, {})
1121 def gbp_contract_dump(self):
1122 """ GBP contract Dump """
1123 return self.api(self.papi.gbp_contract_dump, {})
1125 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1126 """ GBP VXLAN tunnel add """
1127 return self.api(self.papi.gbp_vxlan_tunnel_add,
1132 'bd_rd_id': bd_rd_id,
1137 def gbp_vxlan_tunnel_del(self, vni):
1138 """ GBP VXLAN tunnel del """
1139 return self.api(self.papi.gbp_vxlan_tunnel_del,
1144 def gbp_vxlan_tunnel_dump(self):
1145 """ GBP VXLAN tunnel add/del """
1146 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1148 def igmp_enable_disable(self, sw_if_index, enable, host):
1149 """ Enable/disable IGMP on a given interface """
1150 return self.api(self.papi.igmp_enable_disable,
1153 'sw_if_index': sw_if_index})
1155 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1156 """ Add/del IGMP proxy device """
1157 return self.api(self.papi.igmp_proxy_device_add_del,
1158 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1161 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1162 """ Add/del interface to/from IGMP proxy device """
1163 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1164 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1167 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1168 """ Listen for new (S,G) on specified interface
1170 :param enable: add/del
1171 :param sw_if_index: interface sw index
1172 :param saddr: source ip4 addr
1173 :param gaddr: group ip4 addr
1175 return self.api(self.papi.igmp_listen,
1180 'sw_if_index': sw_if_index,
1181 'n_srcs': len(saddrs),
1187 def igmp_clear_interface(self, sw_if_index):
1188 """ Remove all (S,G)s from specified interface
1189 doesn't send IGMP report!
1192 self.papi.igmp_clear_interface, {
1193 'sw_if_index': sw_if_index})
1195 def want_igmp_events(self, enable=1):
1196 return self.api(self.papi.want_igmp_events, {'enable': enable,
1197 'pid': os.getpid()})