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 self.vpp = VPPApiClient(
240 apidir=config.extern_apidir + [config.vpp_install_dir],
241 logger=test_class.logger,
242 read_timeout=read_timeout,
244 server_address=test_class.get_api_sock_path(),
246 self._events = queue.Queue()
251 def assert_negative_api_retval(self):
252 """Expect API failure - used with with, e.g.::
254 with self.vapi.assert_negative_api_retval():
255 self.vapi.<api call expected to fail>
259 self._expect_stack.append(self._expect_api_retval)
260 self._expect_api_retval = self._negative
263 def assert_zero_api_retval(self):
264 """Expect API success - used with with, e.g.::
266 with self.vapi.assert_negative_api_retval():
267 self.vapi.<api call expected to succeed>
269 :note: this is useful only inside another with block
270 as success is the default expected value
272 self._expect_stack.append(self._expect_api_retval)
273 self._expect_api_retval = self._zero
276 def __exit__(self, exc_type, exc_value, traceback):
277 self._expect_api_retval = self._expect_stack.pop()
279 def register_hook(self, hook):
280 """Replace hook registration with new hook
287 def collect_events(self):
288 """Collect all events from the internal queue and clear the queue."""
292 e = self._events.get(block=False)
298 def wait_for_event(self, timeout, name=None):
299 """Wait for and return next event."""
301 self.test_class.logger.debug(
302 "Expecting event '%s' within %ss", name, timeout
305 self.test_class.logger.debug("Expecting event within %ss", timeout)
307 e = self._events.get(timeout=timeout)
309 raise Exception("Event did not occur within timeout")
310 msgname = type(e).__name__
311 if name and msgname != name:
312 raise Exception("Unexpected event received: %s, expected: %s" % msgname)
313 self.test_class.logger.debug("Returning event %s:%s" % (name, e))
316 def __call__(self, name, event):
317 """Enqueue event in the internal event queue."""
318 self.test_class.logger.debug("New event: %s: %s" % (name, event))
319 self._events.put(event)
321 def factory(self, name, apifn):
323 fields = apifn._func.msg.fields
325 # add positional and kw arguments
327 for i, o in enumerate(fields[3:]):
330 except BaseException:
334 if name in defaultmapping:
335 for k, v in iteritems(defaultmapping[name]):
339 return self.api(apifn, d)
343 def __getattribute__(self, name):
345 method = super(VppPapiProvider, self).__getattribute__(name)
346 except AttributeError:
347 method = self.factory(name, getattr(self.papi, name))
348 # lazily load the method so we don't need to call factory
349 # again for this name.
350 setattr(self, name, method)
354 """Connect the API to VPP"""
355 # This might be called before VPP is prepared to listen to the socket
357 while not os.path.exists(self.test_class.get_api_sock_path()):
362 self.vpp.connect(self.name[:63])
363 self.papi = self.vpp.api
364 self.vpp.register_event_callback(self)
366 def disconnect(self):
367 """Disconnect the API from VPP"""
368 self.vpp.disconnect()
370 def api(self, api_fn, api_args, expected_retval=0):
371 """Call API function and check it's return value.
372 Call the appropriate hooks before and after the API call
374 :param api_fn: API function to call
375 :param api_args: tuple of API function arguments
376 :param expected_retval: Expected return value (Default value = 0)
377 :returns: reply from the API
380 self.hook.before_api(api_fn.__name__, api_args)
381 reply = api_fn(**api_args)
382 if self._expect_api_retval == self._negative:
383 if hasattr(reply, "retval") and reply.retval >= 0:
385 "%s(%s) passed unexpectedly: expected negative "
386 "return value instead of %d in %s"
389 as_fn_signature(api_args),
391 moves.reprlib.repr(reply),
394 self.test_class.logger.info(msg)
395 raise UnexpectedApiReturnValueError(reply.retval, msg)
396 elif self._expect_api_retval == self._zero:
397 if hasattr(reply, "retval") and reply.retval != expected_retval:
399 "%s(%s) failed, expected %d return value instead "
403 as_fn_signature(api_args),
409 self.test_class.logger.info(msg)
410 raise UnexpectedApiReturnValueError(reply.retval, msg)
413 "Internal error, unexpected value for "
414 "self._expect_api_retval %s" % self._expect_api_retval
416 self.hook.after_api(api_fn.__name__, api_args)
419 def cli_return_response(self, cli):
420 """Execute a CLI, calling the before/after hooks appropriately.
421 Return the reply without examining it
423 :param cli: CLI to execute
424 :returns: response object
427 self.hook.before_cli(cli)
429 r = self.papi.cli_inband(cmd=cli)
430 self.hook.after_cli(cli)
434 """Execute a CLI, calling the before/after hooks appropriately.
436 :param cli: CLI to execute
440 r = self.cli_return_response(cli)
442 raise CliSyntaxError(r.reply)
444 raise CliFailedCommandError(r.reply)
445 if hasattr(r, "reply"):
448 def ppcli(self, cli):
449 """Helper method to print CLI command in case of info logging level.
451 :param cli: CLI to execute
454 return cli + "\n" + self.cli(cli)
456 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120, mrc=0, mrd=0):
458 self.papi.ip6nd_send_router_solicitation,
464 "sw_if_index": sw_if_index,
468 def want_interface_events(self, enable_disable=1):
470 self.papi.want_interface_events,
472 "enable_disable": enable_disable,
477 def sw_interface_set_mac_address(self, sw_if_index, mac):
479 self.papi.sw_interface_set_mac_address,
480 {"sw_if_index": sw_if_index, "mac_address": mac},
483 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
484 """Create p2p ethernet subinterface
486 :param sw_if_index: main (parent) interface
487 :param remote_mac: client (remote) mac address
491 self.papi.p2p_ethernet_add,
493 "parent_if_index": sw_if_index,
494 "remote_mac": remote_mac,
495 "subif_id": subif_id,
499 def p2p_ethernet_del(self, sw_if_index, remote_mac):
500 """Delete p2p ethernet subinterface
502 :param sw_if_index: main (parent) interface
503 :param remote_mac: client (remote) mac address
507 self.papi.p2p_ethernet_del,
508 {"parent_if_index": sw_if_index, "remote_mac": remote_mac},
511 def create_vlan_subif(self, sw_if_index, vlan):
519 self.papi.create_vlan_subif, {"sw_if_index": sw_if_index, "vlan_id": vlan}
522 def create_loopback(self, mac=""):
525 :param mac: (Optional)
527 return self.api(self.papi.create_loopback, {"mac_address": mac})
529 def ip_route_dump(self, table_id, is_ip6=False):
531 self.papi.ip_route_dump, {"table": {"table_id": table_id, "is_ip6": is_ip6}}
534 def ip_route_v2_dump(self, table_id, is_ip6=False, src=0):
536 self.papi.ip_route_v2_dump,
537 {"src": src, "table": {"table_id": table_id, "is_ip6": is_ip6}},
540 def ip_neighbor_add_del(
541 self, sw_if_index, mac_address, ip_address, is_add=1, flags=0
543 """Add neighbor MAC to IPv4 or IPv6 address.
548 :param is_add: (Default value = 1)
549 :param flags: (Default value = 0/NONE)
552 self.papi.ip_neighbor_add_del,
556 "sw_if_index": sw_if_index,
558 "mac_address": mac_address,
559 "ip_address": ip_address,
564 def udp_encap_add(self, src_ip, dst_ip, src_port, dst_port, table_id=0):
570 :param outer_fib_id: (Default value = 0)
574 self.papi.udp_encap_add,
579 "src_port": src_port,
580 "dst_port": dst_port,
581 "table_id": table_id,
586 def udp_encap_del(self, id):
587 return self.api(self.papi.udp_encap_del, {"id": id})
589 def udp_encap_dump(self):
590 return self.api(self.papi.udp_encap_dump, {})
592 def want_udp_encap_stats(self, enable=1):
594 self.papi.want_udp_encap_stats, {"enable": enable, "pid": os.getpid()}
597 def mpls_route_dump(self, table_id):
598 return self.api(self.papi.mpls_route_dump, {"table": {"mt_table_id": table_id}})
600 def mpls_table_dump(self):
601 return self.api(self.papi.mpls_table_dump, {})
603 def mpls_table_add_del(self, table_id, is_add=1):
607 :param is_add: (Default value = 1)
612 self.papi.mpls_table_add_del,
615 "mt_table_id": table_id,
621 def mpls_route_add_del(
622 self, table_id, label, eos, eos_proto, is_multicast, paths, is_add, is_multipath
624 """MPLS Route add/del"""
626 self.papi.mpls_route_add_del,
629 "mr_table_id": table_id,
632 "mr_eos_proto": eos_proto,
633 "mr_is_multicast": is_multicast,
634 "mr_n_paths": len(paths),
638 "mr_is_multipath": is_multipath,
642 def mpls_ip_bind_unbind(self, label, prefix, table_id=0, ip_table_id=0, is_bind=1):
645 self.papi.mpls_ip_bind_unbind,
647 "mb_mpls_table_id": table_id,
649 "mb_ip_table_id": ip_table_id,
650 "mb_is_bind": is_bind,
655 def mpls_tunnel_add_del(
656 self, tun_sw_if_index, paths, is_add=1, l2_only=0, is_multicast=0
660 self.papi.mpls_tunnel_add_del,
664 "mt_sw_if_index": tun_sw_if_index,
665 "mt_l2_only": l2_only,
666 "mt_is_multicast": is_multicast,
667 "mt_n_paths": len(paths),
673 def input_acl_set_interface(
677 ip4_table_index=0xFFFFFFFF,
678 ip6_table_index=0xFFFFFFFF,
679 l2_table_index=0xFFFFFFFF,
684 :param ip4_table_index: (Default value = 0xFFFFFFFF)
685 :param ip6_table_index: (Default value = 0xFFFFFFFF)
686 :param l2_table_index: (Default value = 0xFFFFFFFF)
690 self.papi.input_acl_set_interface,
692 "sw_if_index": sw_if_index,
693 "ip4_table_index": ip4_table_index,
694 "ip6_table_index": ip6_table_index,
695 "l2_table_index": l2_table_index,
700 def output_acl_set_interface(
704 ip4_table_index=0xFFFFFFFF,
705 ip6_table_index=0xFFFFFFFF,
706 l2_table_index=0xFFFFFFFF,
711 :param ip4_table_index: (Default value = 0xFFFFFFFF)
712 :param ip6_table_index: (Default value = 0xFFFFFFFF)
713 :param l2_table_index: (Default value = 0xFFFFFFFF)
717 self.papi.output_acl_set_interface,
719 "sw_if_index": sw_if_index,
720 "ip4_table_index": ip4_table_index,
721 "ip6_table_index": ip6_table_index,
722 "l2_table_index": l2_table_index,
727 def set_ipfix_exporter(
738 self.papi.set_ipfix_exporter,
740 "collector_address": collector_address,
741 "collector_port": collector_port,
742 "src_address": src_address,
744 "path_mtu": path_mtu,
745 "template_interval": template_interval,
746 "udp_checksum": udp_checksum,
750 def mfib_signal_dump(self):
751 return self.api(self.papi.mfib_signal_dump, {})
753 def ip_mroute_dump(self, table_id, is_ip6=False):
755 self.papi.ip_mroute_dump,
756 {"table": {"table_id": table_id, "is_ip6": is_ip6}},
759 def pppoe_add_del_session(
760 self, client_ip, client_mac, session_id=0, is_add=1, decap_vrf_id=0
764 :param is_add: (Default value = 1)
765 :param is_ipv6: (Default value = 0)
767 :param session_id: (Default value = 0)
769 :param decap_vrf_id: (Default value = 0)
773 self.papi.pppoe_add_del_session,
776 "session_id": session_id,
777 "client_ip": client_ip,
778 "decap_vrf_id": decap_vrf_id,
779 "client_mac": client_mac,
783 def sr_mpls_policy_add(self, bsid, weight, type, segments):
785 self.papi.sr_mpls_policy_add,
790 "n_segments": len(segments),
791 "segments": segments,
795 def sr_mpls_policy_del(self, bsid):
796 return self.api(self.papi.sr_mpls_policy_del, {"bsid": bsid})
798 def bier_table_add_del(self, bti, mpls_label, is_add=1):
799 """BIER Table add/del"""
801 self.papi.bier_table_add_del,
804 "bt_set": bti.set_id,
805 "bt_sub_domain": bti.sub_domain_id,
806 "bt_hdr_len_id": bti.hdr_len_id,
808 "bt_label": mpls_label,
813 def bier_table_dump(self):
814 return self.api(self.papi.bier_table_dump, {})
816 def bier_route_add_del(self, bti, bp, paths, is_add=1, is_replace=0):
817 """BIER Route add/del"""
819 self.papi.bier_route_add_del,
823 "bt_set": bti.set_id,
824 "bt_sub_domain": bti.sub_domain_id,
825 "bt_hdr_len_id": bti.hdr_len_id,
828 "br_n_paths": len(paths),
832 "br_is_replace": is_replace,
836 def bier_route_dump(self, bti):
838 self.papi.bier_route_dump,
841 "bt_set": bti.set_id,
842 "bt_sub_domain": bti.sub_domain_id,
843 "bt_hdr_len_id": bti.hdr_len_id,
848 def bier_imp_add(self, bti, src, ibytes, is_add=1):
849 """BIER Imposition Add"""
851 self.papi.bier_imp_add,
854 "bt_set": bti.set_id,
855 "bt_sub_domain": bti.sub_domain_id,
856 "bt_hdr_len_id": bti.hdr_len_id,
859 "bi_n_bytes": len(ibytes),
864 def bier_imp_del(self, bi_index):
865 """BIER Imposition del"""
866 return self.api(self.papi.bier_imp_del, {"bi_index": bi_index})
868 def bier_imp_dump(self):
869 return self.api(self.papi.bier_imp_dump, {})
871 def bier_disp_table_add_del(self, bdti, is_add=1):
872 """BIER Disposition Table add/del"""
874 self.papi.bier_disp_table_add_del,
875 {"bdt_tbl_id": bdti, "bdt_is_add": is_add},
878 def bier_disp_table_dump(self):
879 return self.api(self.papi.bier_disp_table_dump, {})
881 def bier_disp_entry_add_del(
893 """BIER Route add/del"""
895 while len(lstack) < 16:
898 self.papi.bier_disp_entry_add_del,
902 "bde_payload_proto": payload_proto,
906 "table_id": next_hop_tbl_id,
907 "rpf_id": next_hop_rpf_id,
909 "label_stack": lstack,
912 "bde_is_add": is_add,
916 def bier_disp_entry_dump(self, bdti):
917 return self.api(self.papi.bier_disp_entry_dump, {"bde_tbl_id": bdti})
919 def ipsec_spd_add_del(self, spd_id, is_add=1):
920 """SPD add/del - Wrapper to add or del ipsec SPD
921 Sample CLI : 'ipsec spd add 1'
923 :param spd_id - SPD ID to be created in the vpp . mandatory
924 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
926 :returns: reply from the API
929 self.papi.ipsec_spd_add_del, {"spd_id": spd_id, "is_add": is_add}
932 def ipsec_spds_dump(self):
933 return self.api(self.papi.ipsec_spds_dump, {})
935 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
936 """ IPSEC interface SPD add/del - \
937 Wrapper to associate/disassociate SPD to interface in VPP
938 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
940 :param spd_id - SPD ID to associate with the interface . mandatory
941 :param sw_if_index - Interface Index which needs to ipsec \
942 association mandatory
943 :param is_add - add(1) or del(0) association with interface \
944 (Default 1 - add) . optional
945 :returns: reply from the API
948 self.papi.ipsec_interface_add_del_spd,
949 {"spd_id": spd_id, "sw_if_index": sw_if_index, "is_add": is_add},
952 def ipsec_spd_interface_dump(self, spd_index=None):
954 self.papi.ipsec_spd_interface_dump,
956 "spd_index": spd_index if spd_index else 0,
957 "spd_index_valid": 1 if spd_index else 0,
961 def ipsec_spd_entry_add_del(
967 remote_address_start,
970 local_port_stop=65535,
972 remote_port_stop=65535,
973 protocol=socket.IPPROTO_RAW,
981 """IPSEC policy SPD add/del -
982 Wrapper to configure ipsec SPD policy entries in VPP
984 :param spd_id: SPD ID for the policy
985 :param local_address_start: local-ip-range start address
986 :param local_address_stop: local-ip-range stop address
987 :param remote_address_start: remote-ip-range start address
988 :param remote_address_stop: remote-ip-range stop address
989 :param local_port_start: (Default value = 0)
990 :param local_port_stop: (Default value = 65535)
991 :param remote_port_start: (Default value = 0)
992 :param remote_port_stop: (Default value = 65535)
993 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
994 :param sa_id: Security Association ID for mapping it to SPD
995 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
997 :param priority: value for the spd action (Default value = 100)
998 :param is_outbound: flag for inbound(0) or outbound(1)
1000 :param is_add: (Default value = 1)
1003 self.papi.ipsec_spd_entry_add_del_v2,
1009 "local_address_start": local_address_start,
1010 "local_address_stop": local_address_stop,
1011 "remote_address_start": remote_address_start,
1012 "remote_address_stop": remote_address_stop,
1013 "local_port_start": local_port_start,
1014 "local_port_stop": local_port_stop,
1015 "remote_port_start": remote_port_start,
1016 "remote_port_stop": remote_port_stop,
1017 "protocol": protocol,
1019 "priority": priority,
1020 "is_outbound": is_outbound,
1025 def ipsec_spd_dump(self, spd_id, sa_id=0xFFFFFFFF):
1026 return self.api(self.papi.ipsec_spd_dump, {"spd_id": spd_id, "sa_id": sa_id})
1028 def ipsec_tunnel_if_add_del(
1046 show_instance=0xFFFFFFFF,
1049 self.papi.ipsec_tunnel_if_add_del,
1051 "local_ip": local_ip,
1052 "remote_ip": remote_ip,
1053 "local_spi": local_spi,
1054 "remote_spi": remote_spi,
1055 "crypto_alg": crypto_alg,
1056 "local_crypto_key_len": len(local_crypto_key),
1057 "local_crypto_key": local_crypto_key,
1058 "remote_crypto_key_len": len(remote_crypto_key),
1059 "remote_crypto_key": remote_crypto_key,
1060 "integ_alg": integ_alg,
1061 "local_integ_key_len": len(local_integ_key),
1062 "local_integ_key": local_integ_key,
1063 "remote_integ_key_len": len(remote_integ_key),
1064 "remote_integ_key": remote_integ_key,
1067 "anti_replay": anti_replay,
1068 "renumber": renumber,
1069 "show_instance": show_instance,
1070 "udp_encap": udp_encap,
1075 def ipsec_select_backend(self, protocol, index):
1077 self.papi.ipsec_select_backend, {"protocol": protocol, "index": index}
1080 def ipsec_backend_dump(self):
1081 return self.api(self.papi.ipsec_backend_dump, {})
1083 def punt_socket_register(self, reg, pathname, header_version=1):
1084 """Register punt socket"""
1086 self.papi.punt_socket_register,
1087 {"header_version": header_version, "punt": reg, "pathname": pathname},
1090 def punt_socket_deregister(self, reg):
1091 """Unregister punt socket"""
1092 return self.api(self.papi.punt_socket_deregister, {"punt": reg})
1094 def igmp_enable_disable(self, sw_if_index, enable, host):
1095 """Enable/disable IGMP on a given interface"""
1097 self.papi.igmp_enable_disable,
1098 {"enable": enable, "mode": host, "sw_if_index": sw_if_index},
1101 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1102 """Add/del IGMP proxy device"""
1104 self.papi.igmp_proxy_device_add_del,
1105 {"vrf_id": vrf_id, "sw_if_index": sw_if_index, "add": add},
1108 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1109 """Add/del interface to/from IGMP proxy device"""
1111 self.papi.igmp_proxy_device_add_del_interface,
1112 {"vrf_id": vrf_id, "sw_if_index": sw_if_index, "add": add},
1115 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1116 """Listen for new (S,G) on specified interface
1118 :param enable: add/delas
1119 :param sw_if_index: interface sw index
1120 :param saddr: source ip4 addr
1121 :param gaddr: group ip4 addr
1124 self.papi.igmp_listen,
1128 "sw_if_index": sw_if_index,
1129 "n_srcs": len(saddrs),
1136 def igmp_clear_interface(self, sw_if_index):
1137 """Remove all (S,G)s from specified interface
1138 doesn't send IGMP report!
1140 return self.api(self.papi.igmp_clear_interface, {"sw_if_index": sw_if_index})
1142 def want_igmp_events(self, enable=1):
1144 self.papi.want_igmp_events, {"enable": enable, "pid": os.getpid()}