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 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
39 'decap_next_index': 4294967295, },
40 'input_acl_set_interface': {'ip4_table_index': 4294967295,
41 'ip6_table_index': 4294967295,
42 'l2_table_index': 4294967295, },
43 'ip6_add_del_address_using_prefix': {'is_add': 1, },
44 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
45 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
46 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
47 'classify_table_index': 4294967295, 'is_add': 1, },
48 'ip_mroute_add_del': {'is_add': 1, },
49 'ip_neighbor_add_del': {'is_add': 1, },
50 'ipsec_interface_add_del_spd': {'is_add': 1, },
51 'ipsec_spd_add_del': {'is_add': 1, },
52 'ipsec_spd_dump': {'sa_id': 4294967295, },
53 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
54 'remote_port_stop': 65535, 'priority': 100,
57 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
58 'l2_emulation': {'enable': 1, },
59 'l2fib_add_del': {'is_add': 1, },
60 'lisp_add_del_adjacency': {'is_add': 1, },
61 'lisp_add_del_local_eid': {'is_add': 1, },
62 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
63 'lisp_add_del_locator_set': {'is_add': 1, },
64 'lisp_add_del_remote_mapping': {'is_add': 1, },
65 'macip_acl_interface_add_del': {'is_add': 1, },
66 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
67 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
68 'mr_next_hop_weight': 1,
69 'mr_next_hop_via_label': 1048576,
71 'mr_classify_table_index': 4294967295, },
72 'mpls_table_add_del': {'is_add': 1, },
73 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
75 'next_hop_via_label': 1048576,
77 'output_acl_set_interface': {'ip4_table_index': 4294967295,
78 'ip6_table_index': 4294967295,
79 'l2_table_index': 4294967295, },
80 'pppoe_add_del_session': {'is_add': 1, },
81 'policer_add_del': {'is_add': 1, 'conform_action': {'type': 1}, },
82 'set_ipfix_exporter': {'collector_port': 4739, },
83 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
84 'sw_interface_add_del_address': {'is_add': 1, },
85 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
86 'pref_lifetime': 4294967295, },
87 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
88 'sw_interface_set_l2_bridge': {'enable': 1, },
89 'sw_interface_set_mpls_enable': {'enable': 1, },
90 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
91 'sw_interface_set_unnumbered': {'is_add': 1, },
92 'sw_interface_span_enable_disable': {'state': 1, },
93 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
94 'decap_next_index': 4294967295,
95 'instance': 4294967295, },
96 'want_bfd_events': {'enable_disable': 1, },
97 'want_igmp_events': {'enable': 1, },
98 'want_interface_events': {'enable_disable': 1, },
99 'want_l2_macs_events': {'enable_disable': 1, 'pid': os.getpid(), },
100 'want_l2_macs_events2': {'enable_disable': 1, 'pid': os.getpid(), },
104 def as_fn_signature(d):
105 return ", ".join(f"{k}={v}" for k, v in d.items())
108 class CliFailedCommandError(Exception):
109 """ cli command failed."""
112 class CliSyntaxError(Exception):
113 """ cli command had a syntax error."""
116 class UnexpectedApiReturnValueError(Exception):
117 """ exception raised when the API return value is unexpected """
121 class VppPapiProvider(object):
122 """VPP-api provider using vpp-papi
124 @property hook: hook object providing before and after api/cli hooks
127 _zero, _negative = range(2)
129 def __init__(self, name, test_class, read_timeout):
130 self.hook = Hook(test_class)
132 self.test_class = test_class
133 self._expect_api_retval = self._zero
134 self._expect_stack = []
136 # install_dir is a class attribute. We need to set it before
137 # calling the constructor.
138 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
140 self.vpp = VPPApiClient(logger=test_class.logger,
141 read_timeout=read_timeout,
143 server_address=test_class.get_api_sock_path())
144 self._events = queue.Queue()
149 def assert_negative_api_retval(self):
150 """ Expect API failure - used with with, e.g.::
152 with self.vapi.assert_negative_api_retval():
153 self.vapi.<api call expected to fail>
157 self._expect_stack.append(self._expect_api_retval)
158 self._expect_api_retval = self._negative
161 def assert_zero_api_retval(self):
162 """ 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.get_api_sock_path()):
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_route_v2_dump(self, table_id, is_ip6=False, src=0):
414 return self.api(self.papi.ip_route_v2_dump,
418 'table_id': table_id,
423 def ip_neighbor_add_del(self,
429 """ Add neighbor MAC to IPv4 or IPv6 address.
434 :param is_add: (Default value = 1)
435 :param flags: (Default value = 0/NONE)
438 self.papi.ip_neighbor_add_del,
442 'sw_if_index': sw_if_index,
444 'mac_address': mac_address,
445 'ip_address': ip_address
450 def udp_encap_add(self,
461 :param outer_fib_id: (Default value = 0)
465 self.papi.udp_encap_add,
470 'src_port': src_port,
471 'dst_port': dst_port,
476 def udp_encap_del(self, id):
477 return self.api(self.papi.udp_encap_del, {'id': id})
479 def udp_encap_dump(self):
480 return self.api(self.papi.udp_encap_dump, {})
482 def want_udp_encap_stats(self, enable=1):
483 return self.api(self.papi.want_udp_encap_stats,
487 def mpls_route_dump(self, table_id):
488 return self.api(self.papi.mpls_route_dump,
490 'mt_table_id': table_id
493 def mpls_table_dump(self):
494 return self.api(self.papi.mpls_table_dump, {})
496 def mpls_table_add_del(
503 :param is_add: (Default value = 1)
508 self.papi.mpls_table_add_del,
511 'mt_table_id': table_id,
513 'mt_is_add': is_add})
515 def mpls_route_add_del(self,
524 """ MPLS Route add/del """
526 self.papi.mpls_route_add_del,
529 'mr_table_id': table_id,
532 'mr_eos_proto': eos_proto,
533 'mr_is_multicast': is_multicast,
534 'mr_n_paths': len(paths),
538 'mr_is_multipath': is_multipath})
540 def mpls_ip_bind_unbind(
550 self.papi.mpls_ip_bind_unbind,
551 {'mb_mpls_table_id': table_id,
553 'mb_ip_table_id': ip_table_id,
554 'mb_is_bind': is_bind,
555 'mb_prefix': prefix})
557 def mpls_tunnel_add_del(
567 self.papi.mpls_tunnel_add_del,
568 {'mt_is_add': is_add,
571 'mt_sw_if_index': tun_sw_if_index,
572 'mt_l2_only': l2_only,
573 'mt_is_multicast': is_multicast,
574 'mt_n_paths': len(paths),
578 def input_acl_set_interface(
582 ip4_table_index=0xFFFFFFFF,
583 ip6_table_index=0xFFFFFFFF,
584 l2_table_index=0xFFFFFFFF):
588 :param ip4_table_index: (Default value = 0xFFFFFFFF)
589 :param ip6_table_index: (Default value = 0xFFFFFFFF)
590 :param l2_table_index: (Default value = 0xFFFFFFFF)
594 self.papi.input_acl_set_interface,
595 {'sw_if_index': sw_if_index,
596 'ip4_table_index': ip4_table_index,
597 'ip6_table_index': ip6_table_index,
598 'l2_table_index': l2_table_index,
601 def output_acl_set_interface(
605 ip4_table_index=0xFFFFFFFF,
606 ip6_table_index=0xFFFFFFFF,
607 l2_table_index=0xFFFFFFFF):
611 :param ip4_table_index: (Default value = 0xFFFFFFFF)
612 :param ip6_table_index: (Default value = 0xFFFFFFFF)
613 :param l2_table_index: (Default value = 0xFFFFFFFF)
617 self.papi.output_acl_set_interface,
618 {'sw_if_index': sw_if_index,
619 'ip4_table_index': ip4_table_index,
620 'ip6_table_index': ip6_table_index,
621 'l2_table_index': l2_table_index,
624 def set_ipfix_exporter(
634 self.papi.set_ipfix_exporter,
636 'collector_address': collector_address,
637 'collector_port': collector_port,
638 'src_address': src_address,
640 'path_mtu': path_mtu,
641 'template_interval': template_interval,
642 'udp_checksum': udp_checksum,
645 def mfib_signal_dump(self):
646 return self.api(self.papi.mfib_signal_dump, {})
648 def ip_mroute_dump(self, table_id, is_ip6=False):
649 return self.api(self.papi.ip_mroute_dump,
651 'table_id': table_id,
655 def pppoe_add_del_session(
664 :param is_add: (Default value = 1)
665 :param is_ipv6: (Default value = 0)
667 :param session_id: (Default value = 0)
669 :param decap_vrf_id: (Default value = 0)
672 return self.api(self.papi.pppoe_add_del_session,
674 'session_id': session_id,
675 'client_ip': client_ip,
676 'decap_vrf_id': decap_vrf_id,
677 'client_mac': client_mac})
679 def sr_mpls_policy_add(self, bsid, weight, type, segments):
680 return self.api(self.papi.sr_mpls_policy_add,
684 'n_segments': len(segments),
685 'segments': segments})
687 def sr_mpls_policy_del(self, bsid):
688 return self.api(self.papi.sr_mpls_policy_del,
691 def bier_table_add_del(self,
695 """ BIER Table add/del """
697 self.papi.bier_table_add_del,
698 {'bt_tbl_id': {"bt_set": bti.set_id,
699 "bt_sub_domain": bti.sub_domain_id,
700 "bt_hdr_len_id": bti.hdr_len_id},
701 'bt_label': mpls_label,
702 'bt_is_add': is_add})
704 def bier_table_dump(self):
705 return self.api(self.papi.bier_table_dump, {})
707 def bier_route_add_del(self,
713 """ BIER Route add/del """
715 self.papi.bier_route_add_del,
718 'br_tbl_id': {"bt_set": bti.set_id,
719 "bt_sub_domain": bti.sub_domain_id,
720 "bt_hdr_len_id": bti.hdr_len_id},
722 'br_n_paths': len(paths),
726 'br_is_replace': is_replace
729 def bier_route_dump(self, bti):
731 self.papi.bier_route_dump,
732 {'br_tbl_id': {"bt_set": bti.set_id,
733 "bt_sub_domain": bti.sub_domain_id,
734 "bt_hdr_len_id": bti.hdr_len_id}})
736 def bier_imp_add(self,
741 """ BIER Imposition Add """
743 self.papi.bier_imp_add,
744 {'bi_tbl_id': {"bt_set": bti.set_id,
745 "bt_sub_domain": bti.sub_domain_id,
746 "bt_hdr_len_id": bti.hdr_len_id},
748 'bi_n_bytes': len(ibytes),
751 def bier_imp_del(self, bi_index):
752 """ BIER Imposition del """
754 self.papi.bier_imp_del,
755 {'bi_index': bi_index})
757 def bier_imp_dump(self):
758 return self.api(self.papi.bier_imp_dump, {})
760 def bier_disp_table_add_del(self,
763 """ BIER Disposition Table add/del """
765 self.papi.bier_disp_table_add_del,
767 'bdt_is_add': is_add})
769 def bier_disp_table_dump(self):
770 return self.api(self.papi.bier_disp_table_dump, {})
772 def bier_disp_entry_add_del(self,
782 """ BIER Route add/del """
784 while (len(lstack) < 16):
787 self.papi.bier_disp_entry_add_del,
790 'bde_payload_proto': payload_proto,
792 'bde_paths': [{'table_id': next_hop_tbl_id,
793 'rpf_id': next_hop_rpf_id,
795 'label_stack': lstack}],
796 'bde_is_add': is_add})
798 def bier_disp_entry_dump(self, bdti):
800 self.papi.bier_disp_entry_dump,
801 {'bde_tbl_id': bdti})
803 def ipsec_spd_add_del(self, spd_id, is_add=1):
804 """ SPD add/del - Wrapper to add or del ipsec SPD
805 Sample CLI : 'ipsec spd add 1'
807 :param spd_id - SPD ID to be created in the vpp . mandatory
808 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
810 :returns: reply from the API
813 self.papi.ipsec_spd_add_del, {
814 'spd_id': spd_id, 'is_add': is_add})
816 def ipsec_spds_dump(self):
817 return self.api(self.papi.ipsec_spds_dump, {})
819 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
820 """ IPSEC interface SPD add/del - \
821 Wrapper to associate/disassociate SPD to interface in VPP
822 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
824 :param spd_id - SPD ID to associate with the interface . mandatory
825 :param sw_if_index - Interface Index which needs to ipsec \
826 association mandatory
827 :param is_add - add(1) or del(0) association with interface \
828 (Default 1 - add) . optional
829 :returns: reply from the API
832 self.papi.ipsec_interface_add_del_spd,
833 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
835 def ipsec_spd_interface_dump(self, spd_index=None):
836 return self.api(self.papi.ipsec_spd_interface_dump,
837 {'spd_index': spd_index if spd_index else 0,
838 'spd_index_valid': 1 if spd_index else 0})
840 def ipsec_spd_entry_add_del(self,
845 remote_address_start,
848 local_port_stop=65535,
850 remote_port_stop=65535,
858 """ IPSEC policy SPD add/del -
859 Wrapper to configure ipsec SPD policy entries in VPP
861 :param spd_id: SPD ID for the policy
862 :param local_address_start: local-ip-range start address
863 :param local_address_stop: local-ip-range stop address
864 :param remote_address_start: remote-ip-range start address
865 :param remote_address_stop: remote-ip-range stop address
866 :param local_port_start: (Default value = 0)
867 :param local_port_stop: (Default value = 65535)
868 :param remote_port_start: (Default value = 0)
869 :param remote_port_stop: (Default value = 65535)
870 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
871 :param sa_id: Security Association ID for mapping it to SPD
872 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
874 :param priority: value for the spd action (Default value = 100)
875 :param is_outbound: flag for inbound(0) or outbound(1)
877 :param is_add: (Default value = 1)
880 self.papi.ipsec_spd_entry_add_del,
887 'local_address_start': local_address_start,
888 'local_address_stop': local_address_stop,
889 'remote_address_start': remote_address_start,
890 'remote_address_stop': remote_address_stop,
891 'local_port_start': local_port_start,
892 'local_port_stop': local_port_stop,
893 'remote_port_start': remote_port_start,
894 'remote_port_stop': remote_port_stop,
895 'protocol': protocol,
897 'priority': priority,
898 'is_outbound': is_outbound,
902 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
903 return self.api(self.papi.ipsec_spd_dump,
907 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
908 remote_spi, crypto_alg, local_crypto_key,
909 remote_crypto_key, integ_alg, local_integ_key,
910 remote_integ_key, is_add=1, esn=0, salt=0,
911 anti_replay=1, renumber=0,
912 udp_encap=0, show_instance=0xffffffff):
914 self.papi.ipsec_tunnel_if_add_del,
916 'local_ip': local_ip,
917 'remote_ip': remote_ip,
918 'local_spi': local_spi,
919 'remote_spi': remote_spi,
920 'crypto_alg': crypto_alg,
921 'local_crypto_key_len': len(local_crypto_key),
922 'local_crypto_key': local_crypto_key,
923 'remote_crypto_key_len': len(remote_crypto_key),
924 'remote_crypto_key': remote_crypto_key,
925 'integ_alg': integ_alg,
926 'local_integ_key_len': len(local_integ_key),
927 'local_integ_key': local_integ_key,
928 'remote_integ_key_len': len(remote_integ_key),
929 'remote_integ_key': remote_integ_key,
932 'anti_replay': anti_replay,
933 'renumber': renumber,
934 'show_instance': show_instance,
935 'udp_encap': udp_encap,
939 def ipsec_select_backend(self, protocol, index):
940 return self.api(self.papi.ipsec_select_backend,
941 {'protocol': protocol, 'index': index})
943 def ipsec_backend_dump(self):
944 return self.api(self.papi.ipsec_backend_dump, {})
946 def punt_socket_register(self, reg, pathname,
948 """ Register punt socket """
949 return self.api(self.papi.punt_socket_register,
950 {'header_version': header_version,
952 'pathname': pathname})
954 def punt_socket_deregister(self, reg):
955 """ Unregister punt socket """
956 return self.api(self.papi.punt_socket_deregister,
959 def igmp_enable_disable(self, sw_if_index, enable, host):
960 """ Enable/disable IGMP on a given interface """
961 return self.api(self.papi.igmp_enable_disable,
964 'sw_if_index': sw_if_index})
966 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
967 """ Add/del IGMP proxy device """
968 return self.api(self.papi.igmp_proxy_device_add_del,
969 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
972 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
973 """ Add/del interface to/from IGMP proxy device """
974 return self.api(self.papi.igmp_proxy_device_add_del_interface,
975 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
978 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
979 """ Listen for new (S,G) on specified interface
981 :param enable: add/delas
982 :param sw_if_index: interface sw index
983 :param saddr: source ip4 addr
984 :param gaddr: group ip4 addr
986 return self.api(self.papi.igmp_listen,
991 'sw_if_index': sw_if_index,
992 'n_srcs': len(saddrs),
998 def igmp_clear_interface(self, sw_if_index):
999 """ Remove all (S,G)s from specified interface
1000 doesn't send IGMP report!
1003 self.papi.igmp_clear_interface, {
1004 'sw_if_index': sw_if_index})
1006 def want_igmp_events(self, enable=1):
1007 return self.api(self.papi.want_igmp_events, {'enable': enable,
1008 'pid': os.getpid()})