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.
11 from six import moves, iteritems
12 from config import config
13 from vpp_papi import VPPApiClient
15 from vpp_papi_exceptions import (
16 CliFailedCommandError,
18 UnexpectedApiReturnValueError,
22 # Dictionary keyed on message name to override default values for
26 "acl_interface_add_del": {"is_add": 1, "is_input": 1},
27 "bd_ip_mac_add_del": {
30 "bfd_udp_add": {"is_authenticated": False, "bfd_key_id": None, "conf_key_id": None},
31 "bfd_udp_auth_activate": {
36 "bier_disp_entry_add_del": {
37 "next_hop_rpf_id": -1,
41 "bier_disp_table_add_del": {
47 "bier_route_add_del": {
50 "bier_table_add_del": {
54 "geneve_add_del_tunnel": {
55 "mcast_sw_if_index": 4294967295,
57 "decap_next_index": 4294967295,
59 "input_acl_set_interface": {
60 "ip4_table_index": 4294967295,
61 "ip6_table_index": 4294967295,
62 "l2_table_index": 4294967295,
64 "ip6_add_del_address_using_prefix": {
67 "ip6nd_send_router_solicitation": {
72 "next_hop_sw_if_index": 4294967295,
74 "next_hop_via_label": 1048576,
75 "classify_table_index": 4294967295,
78 "ip_mroute_add_del": {
81 "ip_neighbor_add_del": {
84 "ipsec_interface_add_del_spd": {
87 "ipsec_spd_add_del": {
93 "ipsec_spd_entry_add_del": {
94 "local_port_stop": 65535,
95 "remote_port_stop": 65535,
100 "ipsec_tunnel_if_add_del": {
110 "lisp_add_del_adjacency": {
113 "lisp_add_del_local_eid": {
116 "lisp_add_del_locator": {
121 "lisp_add_del_locator_set": {
124 "lisp_add_del_remote_mapping": {
127 "macip_acl_interface_add_del": {
130 "mpls_ip_bind_unbind": {
134 "mpls_route_add_del": {
135 "mr_next_hop_sw_if_index": 4294967295,
136 "mr_next_hop_weight": 1,
137 "mr_next_hop_via_label": 1048576,
139 "mr_classify_table_index": 4294967295,
141 "mpls_table_add_del": {
144 "mpls_tunnel_add_del": {
145 "next_hop_sw_if_index": 4294967295,
146 "next_hop_weight": 1,
147 "next_hop_via_label": 1048576,
150 "output_acl_set_interface": {
151 "ip4_table_index": 4294967295,
152 "ip6_table_index": 4294967295,
153 "l2_table_index": 4294967295,
155 "pppoe_add_del_session": {
160 "conform_action": {"type": 1},
162 "set_ipfix_exporter": {
163 "collector_port": 4739,
169 "sw_interface_add_del_address": {
172 "sw_interface_ip6nd_ra_prefix": {
173 "val_lifetime": 4294967295,
174 "pref_lifetime": 4294967295,
176 "sw_interface_set_ip_directed_broadcast": {
179 "sw_interface_set_l2_bridge": {
182 "sw_interface_set_mpls_enable": {
185 "sw_interface_set_mtu": {
188 "sw_interface_set_unnumbered": {
191 "sw_interface_span_enable_disable": {
194 "vxlan_add_del_tunnel": {
195 "mcast_sw_if_index": 4294967295,
197 "decap_next_index": 4294967295,
198 "instance": 4294967295,
203 "want_igmp_events": {
206 "want_interface_events": {
209 "want_l2_macs_events": {
213 "want_l2_macs_events2": {
220 def as_fn_signature(d):
221 return ", ".join(f"{k}={v}" for k, v in d.items())
224 class VppPapiProvider(object):
225 """VPP-api provider using vpp-papi
227 @property hook: hook object providing before and after api/cli hooks
230 _zero, _negative = range(2)
232 def __init__(self, name, test_class, read_timeout):
233 self.hook = Hook(test_class)
235 self.test_class = test_class
236 self._expect_api_retval = self._zero
237 self._expect_stack = []
239 # install_dir is a class attribute. We need to set it before
240 # calling the constructor.
241 VPPApiClient.apidir = config.vpp_install_dir
243 self.vpp = VPPApiClient(
244 logger=test_class.logger,
245 read_timeout=read_timeout,
247 server_address=test_class.get_api_sock_path(),
249 self._events = queue.Queue()
254 def assert_negative_api_retval(self):
255 """Expect API failure - used with with, e.g.::
257 with self.vapi.assert_negative_api_retval():
258 self.vapi.<api call expected to fail>
262 self._expect_stack.append(self._expect_api_retval)
263 self._expect_api_retval = self._negative
266 def assert_zero_api_retval(self):
267 """Expect API success - used with with, e.g.::
269 with self.vapi.assert_negative_api_retval():
270 self.vapi.<api call expected to succeed>
272 :note: this is useful only inside another with block
273 as success is the default expected value
275 self._expect_stack.append(self._expect_api_retval)
276 self._expect_api_retval = self._zero
279 def __exit__(self, exc_type, exc_value, traceback):
280 self._expect_api_retval = self._expect_stack.pop()
282 def register_hook(self, hook):
283 """Replace hook registration with new hook
290 def collect_events(self):
291 """Collect all events from the internal queue and clear the queue."""
295 e = self._events.get(block=False)
301 def wait_for_event(self, timeout, name=None):
302 """Wait for and return next event."""
304 self.test_class.logger.debug(
305 "Expecting event '%s' within %ss", name, timeout
308 self.test_class.logger.debug("Expecting event within %ss", timeout)
310 e = self._events.get(timeout=timeout)
312 raise Exception("Event did not occur within timeout")
313 msgname = type(e).__name__
314 if name and msgname != name:
315 raise Exception("Unexpected event received: %s, expected: %s" % msgname)
316 self.test_class.logger.debug("Returning event %s:%s" % (name, e))
319 def __call__(self, name, event):
320 """Enqueue event in the internal event queue."""
321 self.test_class.logger.debug("New event: %s: %s" % (name, event))
322 self._events.put(event)
324 def factory(self, name, apifn):
326 fields = apifn._func.msg.fields
328 # add positional and kw arguments
330 for i, o in enumerate(fields[3:]):
333 except BaseException:
337 if name in defaultmapping:
338 for k, v in iteritems(defaultmapping[name]):
342 return self.api(apifn, d)
346 def __getattribute__(self, name):
348 method = super(VppPapiProvider, self).__getattribute__(name)
349 except AttributeError:
350 method = self.factory(name, getattr(self.papi, name))
351 # lazily load the method so we don't need to call factory
352 # again for this name.
353 setattr(self, name, method)
357 """Connect the API to VPP"""
358 # This might be called before VPP is prepared to listen to the socket
360 while not os.path.exists(self.test_class.get_api_sock_path()):
365 self.vpp.connect(self.name[:63])
366 self.papi = self.vpp.api
367 self.vpp.register_event_callback(self)
369 def disconnect(self):
370 """Disconnect the API from VPP"""
371 self.vpp.disconnect()
373 def api(self, api_fn, api_args, expected_retval=0):
374 """Call API function and check it's return value.
375 Call the appropriate hooks before and after the API call
377 :param api_fn: API function to call
378 :param api_args: tuple of API function arguments
379 :param expected_retval: Expected return value (Default value = 0)
380 :returns: reply from the API
383 self.hook.before_api(api_fn.__name__, api_args)
384 reply = api_fn(**api_args)
385 if self._expect_api_retval == self._negative:
386 if hasattr(reply, "retval") and reply.retval >= 0:
388 "%s(%s) passed unexpectedly: expected negative "
389 "return value instead of %d in %s"
392 as_fn_signature(api_args),
394 moves.reprlib.repr(reply),
397 self.test_class.logger.info(msg)
398 raise UnexpectedApiReturnValueError(reply.retval, msg)
399 elif self._expect_api_retval == self._zero:
400 if hasattr(reply, "retval") and reply.retval != expected_retval:
402 "%s(%s) failed, expected %d return value instead "
406 as_fn_signature(api_args),
412 self.test_class.logger.info(msg)
413 raise UnexpectedApiReturnValueError(reply.retval, msg)
416 "Internal error, unexpected value for "
417 "self._expect_api_retval %s" % self._expect_api_retval
419 self.hook.after_api(api_fn.__name__, api_args)
422 def cli_return_response(self, cli):
423 """Execute a CLI, calling the before/after hooks appropriately.
424 Return the reply without examining it
426 :param cli: CLI to execute
427 :returns: response object
430 self.hook.before_cli(cli)
432 r = self.papi.cli_inband(cmd=cli)
433 self.hook.after_cli(cli)
437 """Execute a CLI, calling the before/after hooks appropriately.
439 :param cli: CLI to execute
443 r = self.cli_return_response(cli)
445 raise CliSyntaxError(r.reply)
447 raise CliFailedCommandError(r.reply)
448 if hasattr(r, "reply"):
451 def ppcli(self, cli):
452 """Helper method to print CLI command in case of info logging level.
454 :param cli: CLI to execute
457 return cli + "\n" + self.cli(cli)
459 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120, mrc=0, mrd=0):
461 self.papi.ip6nd_send_router_solicitation,
467 "sw_if_index": sw_if_index,
471 def want_interface_events(self, enable_disable=1):
473 self.papi.want_interface_events,
475 "enable_disable": enable_disable,
480 def sw_interface_set_mac_address(self, sw_if_index, mac):
482 self.papi.sw_interface_set_mac_address,
483 {"sw_if_index": sw_if_index, "mac_address": mac},
486 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
487 """Create p2p ethernet subinterface
489 :param sw_if_index: main (parent) interface
490 :param remote_mac: client (remote) mac address
494 self.papi.p2p_ethernet_add,
496 "parent_if_index": sw_if_index,
497 "remote_mac": remote_mac,
498 "subif_id": subif_id,
502 def p2p_ethernet_del(self, sw_if_index, remote_mac):
503 """Delete p2p ethernet subinterface
505 :param sw_if_index: main (parent) interface
506 :param remote_mac: client (remote) mac address
510 self.papi.p2p_ethernet_del,
511 {"parent_if_index": sw_if_index, "remote_mac": remote_mac},
514 def create_vlan_subif(self, sw_if_index, vlan):
522 self.papi.create_vlan_subif, {"sw_if_index": sw_if_index, "vlan_id": vlan}
525 def create_loopback(self, mac=""):
528 :param mac: (Optional)
530 return self.api(self.papi.create_loopback, {"mac_address": mac})
532 def ip_route_dump(self, table_id, is_ip6=False):
534 self.papi.ip_route_dump, {"table": {"table_id": table_id, "is_ip6": is_ip6}}
537 def ip_route_v2_dump(self, table_id, is_ip6=False, src=0):
539 self.papi.ip_route_v2_dump,
540 {"src": src, "table": {"table_id": table_id, "is_ip6": is_ip6}},
543 def ip_neighbor_add_del(
544 self, sw_if_index, mac_address, ip_address, is_add=1, flags=0
546 """Add neighbor MAC to IPv4 or IPv6 address.
551 :param is_add: (Default value = 1)
552 :param flags: (Default value = 0/NONE)
555 self.papi.ip_neighbor_add_del,
559 "sw_if_index": sw_if_index,
561 "mac_address": mac_address,
562 "ip_address": ip_address,
567 def udp_encap_add(self, src_ip, dst_ip, src_port, dst_port, table_id=0):
573 :param outer_fib_id: (Default value = 0)
577 self.papi.udp_encap_add,
582 "src_port": src_port,
583 "dst_port": dst_port,
584 "table_id": table_id,
589 def udp_encap_del(self, id):
590 return self.api(self.papi.udp_encap_del, {"id": id})
592 def udp_encap_dump(self):
593 return self.api(self.papi.udp_encap_dump, {})
595 def want_udp_encap_stats(self, enable=1):
597 self.papi.want_udp_encap_stats, {"enable": enable, "pid": os.getpid()}
600 def mpls_route_dump(self, table_id):
601 return self.api(self.papi.mpls_route_dump, {"table": {"mt_table_id": table_id}})
603 def mpls_table_dump(self):
604 return self.api(self.papi.mpls_table_dump, {})
606 def mpls_table_add_del(self, table_id, is_add=1):
610 :param is_add: (Default value = 1)
615 self.papi.mpls_table_add_del,
618 "mt_table_id": table_id,
624 def mpls_route_add_del(
625 self, table_id, label, eos, eos_proto, is_multicast, paths, is_add, is_multipath
627 """MPLS Route add/del"""
629 self.papi.mpls_route_add_del,
632 "mr_table_id": table_id,
635 "mr_eos_proto": eos_proto,
636 "mr_is_multicast": is_multicast,
637 "mr_n_paths": len(paths),
641 "mr_is_multipath": is_multipath,
645 def mpls_ip_bind_unbind(self, label, prefix, table_id=0, ip_table_id=0, is_bind=1):
648 self.papi.mpls_ip_bind_unbind,
650 "mb_mpls_table_id": table_id,
652 "mb_ip_table_id": ip_table_id,
653 "mb_is_bind": is_bind,
658 def mpls_tunnel_add_del(
659 self, tun_sw_if_index, paths, is_add=1, l2_only=0, is_multicast=0
663 self.papi.mpls_tunnel_add_del,
667 "mt_sw_if_index": tun_sw_if_index,
668 "mt_l2_only": l2_only,
669 "mt_is_multicast": is_multicast,
670 "mt_n_paths": len(paths),
676 def input_acl_set_interface(
680 ip4_table_index=0xFFFFFFFF,
681 ip6_table_index=0xFFFFFFFF,
682 l2_table_index=0xFFFFFFFF,
687 :param ip4_table_index: (Default value = 0xFFFFFFFF)
688 :param ip6_table_index: (Default value = 0xFFFFFFFF)
689 :param l2_table_index: (Default value = 0xFFFFFFFF)
693 self.papi.input_acl_set_interface,
695 "sw_if_index": sw_if_index,
696 "ip4_table_index": ip4_table_index,
697 "ip6_table_index": ip6_table_index,
698 "l2_table_index": l2_table_index,
703 def output_acl_set_interface(
707 ip4_table_index=0xFFFFFFFF,
708 ip6_table_index=0xFFFFFFFF,
709 l2_table_index=0xFFFFFFFF,
714 :param ip4_table_index: (Default value = 0xFFFFFFFF)
715 :param ip6_table_index: (Default value = 0xFFFFFFFF)
716 :param l2_table_index: (Default value = 0xFFFFFFFF)
720 self.papi.output_acl_set_interface,
722 "sw_if_index": sw_if_index,
723 "ip4_table_index": ip4_table_index,
724 "ip6_table_index": ip6_table_index,
725 "l2_table_index": l2_table_index,
730 def set_ipfix_exporter(
741 self.papi.set_ipfix_exporter,
743 "collector_address": collector_address,
744 "collector_port": collector_port,
745 "src_address": src_address,
747 "path_mtu": path_mtu,
748 "template_interval": template_interval,
749 "udp_checksum": udp_checksum,
753 def mfib_signal_dump(self):
754 return self.api(self.papi.mfib_signal_dump, {})
756 def ip_mroute_dump(self, table_id, is_ip6=False):
758 self.papi.ip_mroute_dump,
759 {"table": {"table_id": table_id, "is_ip6": is_ip6}},
762 def pppoe_add_del_session(
763 self, client_ip, client_mac, session_id=0, is_add=1, decap_vrf_id=0
767 :param is_add: (Default value = 1)
768 :param is_ipv6: (Default value = 0)
770 :param session_id: (Default value = 0)
772 :param decap_vrf_id: (Default value = 0)
776 self.papi.pppoe_add_del_session,
779 "session_id": session_id,
780 "client_ip": client_ip,
781 "decap_vrf_id": decap_vrf_id,
782 "client_mac": client_mac,
786 def sr_mpls_policy_add(self, bsid, weight, type, segments):
788 self.papi.sr_mpls_policy_add,
793 "n_segments": len(segments),
794 "segments": segments,
798 def sr_mpls_policy_del(self, bsid):
799 return self.api(self.papi.sr_mpls_policy_del, {"bsid": bsid})
801 def bier_table_add_del(self, bti, mpls_label, is_add=1):
802 """BIER Table add/del"""
804 self.papi.bier_table_add_del,
807 "bt_set": bti.set_id,
808 "bt_sub_domain": bti.sub_domain_id,
809 "bt_hdr_len_id": bti.hdr_len_id,
811 "bt_label": mpls_label,
816 def bier_table_dump(self):
817 return self.api(self.papi.bier_table_dump, {})
819 def bier_route_add_del(self, bti, bp, paths, is_add=1, is_replace=0):
820 """BIER Route add/del"""
822 self.papi.bier_route_add_del,
826 "bt_set": bti.set_id,
827 "bt_sub_domain": bti.sub_domain_id,
828 "bt_hdr_len_id": bti.hdr_len_id,
831 "br_n_paths": len(paths),
835 "br_is_replace": is_replace,
839 def bier_route_dump(self, bti):
841 self.papi.bier_route_dump,
844 "bt_set": bti.set_id,
845 "bt_sub_domain": bti.sub_domain_id,
846 "bt_hdr_len_id": bti.hdr_len_id,
851 def bier_imp_add(self, bti, src, ibytes, is_add=1):
852 """BIER Imposition Add"""
854 self.papi.bier_imp_add,
857 "bt_set": bti.set_id,
858 "bt_sub_domain": bti.sub_domain_id,
859 "bt_hdr_len_id": bti.hdr_len_id,
862 "bi_n_bytes": len(ibytes),
867 def bier_imp_del(self, bi_index):
868 """BIER Imposition del"""
869 return self.api(self.papi.bier_imp_del, {"bi_index": bi_index})
871 def bier_imp_dump(self):
872 return self.api(self.papi.bier_imp_dump, {})
874 def bier_disp_table_add_del(self, bdti, is_add=1):
875 """BIER Disposition Table add/del"""
877 self.papi.bier_disp_table_add_del,
878 {"bdt_tbl_id": bdti, "bdt_is_add": is_add},
881 def bier_disp_table_dump(self):
882 return self.api(self.papi.bier_disp_table_dump, {})
884 def bier_disp_entry_add_del(
896 """BIER Route add/del"""
898 while len(lstack) < 16:
901 self.papi.bier_disp_entry_add_del,
905 "bde_payload_proto": payload_proto,
909 "table_id": next_hop_tbl_id,
910 "rpf_id": next_hop_rpf_id,
912 "label_stack": lstack,
915 "bde_is_add": is_add,
919 def bier_disp_entry_dump(self, bdti):
920 return self.api(self.papi.bier_disp_entry_dump, {"bde_tbl_id": bdti})
922 def ipsec_spd_add_del(self, spd_id, is_add=1):
923 """SPD add/del - Wrapper to add or del ipsec SPD
924 Sample CLI : 'ipsec spd add 1'
926 :param spd_id - SPD ID to be created in the vpp . mandatory
927 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
929 :returns: reply from the API
932 self.papi.ipsec_spd_add_del, {"spd_id": spd_id, "is_add": is_add}
935 def ipsec_spds_dump(self):
936 return self.api(self.papi.ipsec_spds_dump, {})
938 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
939 """ IPSEC interface SPD add/del - \
940 Wrapper to associate/disassociate SPD to interface in VPP
941 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
943 :param spd_id - SPD ID to associate with the interface . mandatory
944 :param sw_if_index - Interface Index which needs to ipsec \
945 association mandatory
946 :param is_add - add(1) or del(0) association with interface \
947 (Default 1 - add) . optional
948 :returns: reply from the API
951 self.papi.ipsec_interface_add_del_spd,
952 {"spd_id": spd_id, "sw_if_index": sw_if_index, "is_add": is_add},
955 def ipsec_spd_interface_dump(self, spd_index=None):
957 self.papi.ipsec_spd_interface_dump,
959 "spd_index": spd_index if spd_index else 0,
960 "spd_index_valid": 1 if spd_index else 0,
964 def ipsec_spd_entry_add_del(
970 remote_address_start,
973 local_port_stop=65535,
975 remote_port_stop=65535,
976 protocol=socket.IPPROTO_RAW,
984 """IPSEC policy SPD add/del -
985 Wrapper to configure ipsec SPD policy entries in VPP
987 :param spd_id: SPD ID for the policy
988 :param local_address_start: local-ip-range start address
989 :param local_address_stop: local-ip-range stop address
990 :param remote_address_start: remote-ip-range start address
991 :param remote_address_stop: remote-ip-range stop address
992 :param local_port_start: (Default value = 0)
993 :param local_port_stop: (Default value = 65535)
994 :param remote_port_start: (Default value = 0)
995 :param remote_port_stop: (Default value = 65535)
996 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
997 :param sa_id: Security Association ID for mapping it to SPD
998 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1000 :param priority: value for the spd action (Default value = 100)
1001 :param is_outbound: flag for inbound(0) or outbound(1)
1003 :param is_add: (Default value = 1)
1006 self.papi.ipsec_spd_entry_add_del_v2,
1012 "local_address_start": local_address_start,
1013 "local_address_stop": local_address_stop,
1014 "remote_address_start": remote_address_start,
1015 "remote_address_stop": remote_address_stop,
1016 "local_port_start": local_port_start,
1017 "local_port_stop": local_port_stop,
1018 "remote_port_start": remote_port_start,
1019 "remote_port_stop": remote_port_stop,
1020 "protocol": protocol,
1022 "priority": priority,
1023 "is_outbound": is_outbound,
1028 def ipsec_spd_dump(self, spd_id, sa_id=0xFFFFFFFF):
1029 return self.api(self.papi.ipsec_spd_dump, {"spd_id": spd_id, "sa_id": sa_id})
1031 def ipsec_tunnel_if_add_del(
1049 show_instance=0xFFFFFFFF,
1052 self.papi.ipsec_tunnel_if_add_del,
1054 "local_ip": local_ip,
1055 "remote_ip": remote_ip,
1056 "local_spi": local_spi,
1057 "remote_spi": remote_spi,
1058 "crypto_alg": crypto_alg,
1059 "local_crypto_key_len": len(local_crypto_key),
1060 "local_crypto_key": local_crypto_key,
1061 "remote_crypto_key_len": len(remote_crypto_key),
1062 "remote_crypto_key": remote_crypto_key,
1063 "integ_alg": integ_alg,
1064 "local_integ_key_len": len(local_integ_key),
1065 "local_integ_key": local_integ_key,
1066 "remote_integ_key_len": len(remote_integ_key),
1067 "remote_integ_key": remote_integ_key,
1070 "anti_replay": anti_replay,
1071 "renumber": renumber,
1072 "show_instance": show_instance,
1073 "udp_encap": udp_encap,
1078 def ipsec_select_backend(self, protocol, index):
1080 self.papi.ipsec_select_backend, {"protocol": protocol, "index": index}
1083 def ipsec_backend_dump(self):
1084 return self.api(self.papi.ipsec_backend_dump, {})
1086 def punt_socket_register(self, reg, pathname, header_version=1):
1087 """Register punt socket"""
1089 self.papi.punt_socket_register,
1090 {"header_version": header_version, "punt": reg, "pathname": pathname},
1093 def punt_socket_deregister(self, reg):
1094 """Unregister punt socket"""
1095 return self.api(self.papi.punt_socket_deregister, {"punt": reg})
1097 def igmp_enable_disable(self, sw_if_index, enable, host):
1098 """Enable/disable IGMP on a given interface"""
1100 self.papi.igmp_enable_disable,
1101 {"enable": enable, "mode": host, "sw_if_index": sw_if_index},
1104 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1105 """Add/del IGMP proxy device"""
1107 self.papi.igmp_proxy_device_add_del,
1108 {"vrf_id": vrf_id, "sw_if_index": sw_if_index, "add": add},
1111 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1112 """Add/del interface to/from IGMP proxy device"""
1114 self.papi.igmp_proxy_device_add_del_interface,
1115 {"vrf_id": vrf_id, "sw_if_index": sw_if_index, "add": add},
1118 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1119 """Listen for new (S,G) on specified interface
1121 :param enable: add/delas
1122 :param sw_if_index: interface sw index
1123 :param saddr: source ip4 addr
1124 :param gaddr: group ip4 addr
1127 self.papi.igmp_listen,
1131 "sw_if_index": sw_if_index,
1132 "n_srcs": len(saddrs),
1139 def igmp_clear_interface(self, sw_if_index):
1140 """Remove all (S,G)s from specified interface
1141 doesn't send IGMP report!
1143 return self.api(self.papi.igmp_clear_interface, {"sw_if_index": sw_if_index})
1145 def want_igmp_events(self, enable=1):
1147 self.papi.want_igmp_events, {"enable": enable, "pid": os.getpid()}