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 CliFailedCommandError, CliSyntaxError,\
16 UnexpectedApiReturnValueError
19 # Dictionary keyed on message name to override default values for
24 'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
25 'bd_ip_mac_add_del': {'is_add': 1, },
26 'bfd_udp_add': {'is_authenticated': False, 'bfd_key_id': None,
28 'bfd_udp_auth_activate': {'bfd_key_id': None, 'conf_key_id': None,
30 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
32 'bier_disp_table_add_del': {'is_add': 1, },
33 'bier_imp_add': {'is_add': 1, },
34 'bier_route_add_del': {'is_add': 1, },
35 'bier_table_add_del': {'is_add': 1, },
36 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
37 'learn': 1, 'is_add': 1, },
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 'ipsec_interface_add_del_spd': {'is_add': 1, },
52 'ipsec_spd_add_del': {'is_add': 1, },
53 'ipsec_spd_dump': {'sa_id': 4294967295, },
54 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
55 'remote_port_stop': 65535, 'priority': 100,
58 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
59 'l2_emulation': {'enable': 1, },
60 'l2fib_add_del': {'is_add': 1, },
61 'lisp_add_del_adjacency': {'is_add': 1, },
62 'lisp_add_del_local_eid': {'is_add': 1, },
63 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
64 'lisp_add_del_locator_set': {'is_add': 1, },
65 'lisp_add_del_remote_mapping': {'is_add': 1, },
66 'macip_acl_interface_add_del': {'is_add': 1, },
67 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
68 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
69 'mr_next_hop_weight': 1,
70 'mr_next_hop_via_label': 1048576,
72 'mr_classify_table_index': 4294967295, },
73 'mpls_table_add_del': {'is_add': 1, },
74 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
76 'next_hop_via_label': 1048576,
78 'output_acl_set_interface': {'ip4_table_index': 4294967295,
79 'ip6_table_index': 4294967295,
80 'l2_table_index': 4294967295, },
81 'pppoe_add_del_session': {'is_add': 1, },
82 'policer_add_del': {'is_add': 1, 'conform_action': {'type': 1}, },
83 'set_ipfix_exporter': {'collector_port': 4739, },
84 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
85 'sw_interface_add_del_address': {'is_add': 1, },
86 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
87 'pref_lifetime': 4294967295, },
88 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
89 'sw_interface_set_l2_bridge': {'enable': 1, },
90 'sw_interface_set_mpls_enable': {'enable': 1, },
91 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
92 'sw_interface_set_unnumbered': {'is_add': 1, },
93 'sw_interface_span_enable_disable': {'state': 1, },
94 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
95 'decap_next_index': 4294967295,
96 'instance': 4294967295, },
97 'want_bfd_events': {'enable_disable': 1, },
98 'want_igmp_events': {'enable': 1, },
99 'want_interface_events': {'enable_disable': 1, },
100 'want_l2_macs_events': {'enable_disable': 1, 'pid': os.getpid(), },
101 'want_l2_macs_events2': {'enable_disable': 1, 'pid': os.getpid(), },
105 def as_fn_signature(d):
106 return ", ".join(f"{k}={v}" for k, v in d.items())
109 class VppPapiProvider(object):
110 """VPP-api provider using vpp-papi
112 @property hook: hook object providing before and after api/cli hooks
115 _zero, _negative = range(2)
117 def __init__(self, name, test_class, read_timeout):
118 self.hook = Hook(test_class)
120 self.test_class = test_class
121 self._expect_api_retval = self._zero
122 self._expect_stack = []
124 # install_dir is a class attribute. We need to set it before
125 # calling the constructor.
126 VPPApiClient.apidir = config.vpp_install_dir
128 self.vpp = VPPApiClient(logger=test_class.logger,
129 read_timeout=read_timeout,
131 server_address=test_class.get_api_sock_path())
132 self._events = queue.Queue()
137 def assert_negative_api_retval(self):
138 """ Expect API failure - used with with, e.g.::
140 with self.vapi.assert_negative_api_retval():
141 self.vapi.<api call expected to fail>
145 self._expect_stack.append(self._expect_api_retval)
146 self._expect_api_retval = self._negative
149 def assert_zero_api_retval(self):
150 """ Expect API success - used with with, e.g.::
152 with self.vapi.assert_negative_api_retval():
153 self.vapi.<api call expected to succeed>
155 :note: this is useful only inside another with block
156 as success is the default expected value
158 self._expect_stack.append(self._expect_api_retval)
159 self._expect_api_retval = self._zero
162 def __exit__(self, exc_type, exc_value, traceback):
163 self._expect_api_retval = self._expect_stack.pop()
165 def register_hook(self, hook):
166 """Replace hook registration with new hook
173 def collect_events(self):
174 """ Collect all events from the internal queue and clear the queue. """
178 e = self._events.get(block=False)
184 def wait_for_event(self, timeout, name=None):
185 """ Wait for and return next event. """
187 self.test_class.logger.debug("Expecting event '%s' within %ss",
190 self.test_class.logger.debug("Expecting event within %ss",
193 e = self._events.get(timeout=timeout)
195 raise Exception("Event did not occur within timeout")
196 msgname = type(e).__name__
197 if name and msgname != name:
198 raise Exception("Unexpected event received: %s, expected: %s"
200 self.test_class.logger.debug("Returning event %s:%s" % (name, e))
203 def __call__(self, name, event):
204 """ Enqueue event in the internal event queue. """
205 self.test_class.logger.debug("New event: %s: %s" % (name, event))
206 self._events.put(event)
208 def factory(self, name, apifn):
210 fields = apifn._func.msg.fields
212 # add positional and kw arguments
214 for i, o in enumerate(fields[3:]):
217 except BaseException:
221 if name in defaultmapping:
222 for k, v in iteritems(defaultmapping[name]):
226 return self.api(apifn, d)
230 def __getattribute__(self, name):
232 method = super(VppPapiProvider, self).__getattribute__(name)
233 except AttributeError:
234 method = self.factory(name, getattr(self.papi, name))
235 # lazily load the method so we don't need to call factory
236 # again for this name.
237 setattr(self, name, method)
241 """Connect the API to VPP"""
242 # This might be called before VPP is prepared to listen to the socket
244 while not os.path.exists(self.test_class.get_api_sock_path()):
249 self.vpp.connect(self.name[:63])
250 self.papi = self.vpp.api
251 self.vpp.register_event_callback(self)
253 def disconnect(self):
254 """Disconnect the API from VPP"""
255 self.vpp.disconnect()
257 def api(self, api_fn, api_args, expected_retval=0):
258 """ Call API function and check it's return value.
259 Call the appropriate hooks before and after the API call
261 :param api_fn: API function to call
262 :param api_args: tuple of API function arguments
263 :param expected_retval: Expected return value (Default value = 0)
264 :returns: reply from the API
267 self.hook.before_api(api_fn.__name__, api_args)
268 reply = api_fn(**api_args)
269 if self._expect_api_retval == self._negative:
270 if hasattr(reply, 'retval') and reply.retval >= 0:
271 msg = "%s(%s) passed unexpectedly: expected negative " \
272 "return value instead of %d in %s" % \
273 (api_fn.__name__, as_fn_signature(api_args),
275 moves.reprlib.repr(reply))
276 self.test_class.logger.info(msg)
277 raise UnexpectedApiReturnValueError(reply.retval, msg)
278 elif self._expect_api_retval == self._zero:
279 if hasattr(reply, 'retval') and reply.retval != expected_retval:
280 msg = "%s(%s) failed, expected %d return value instead " \
281 "of %d in %s" % (api_fn.__name__,
282 as_fn_signature(api_args),
283 expected_retval, reply.retval,
285 self.test_class.logger.info(msg)
286 raise UnexpectedApiReturnValueError(reply.retval, msg)
288 raise Exception("Internal error, unexpected value for "
289 "self._expect_api_retval %s" %
290 self._expect_api_retval)
291 self.hook.after_api(api_fn.__name__, api_args)
294 def cli_return_response(self, cli):
295 """ Execute a CLI, calling the before/after hooks appropriately.
296 Return the reply without examining it
298 :param cli: CLI to execute
299 :returns: response object
302 self.hook.before_cli(cli)
304 r = self.papi.cli_inband(cmd=cli)
305 self.hook.after_cli(cli)
309 """ Execute a CLI, calling the before/after hooks appropriately.
311 :param cli: CLI to execute
315 r = self.cli_return_response(cli)
317 raise CliSyntaxError(r.reply)
319 raise CliFailedCommandError(r.reply)
320 if hasattr(r, 'reply'):
323 def ppcli(self, cli):
324 """ Helper method to print CLI command in case of info logging level.
326 :param cli: CLI to execute
329 return cli + "\n" + self.cli(cli)
331 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
333 return self.api(self.papi.ip6nd_send_router_solicitation,
338 'sw_if_index': sw_if_index})
340 def want_interface_events(self, enable_disable=1):
341 return self.api(self.papi.want_interface_events,
342 {'enable_disable': enable_disable,
343 'pid': os.getpid(), })
345 def sw_interface_set_mac_address(self, sw_if_index, mac):
346 return self.api(self.papi.sw_interface_set_mac_address,
347 {'sw_if_index': sw_if_index,
350 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
351 """Create p2p ethernet subinterface
353 :param sw_if_index: main (parent) interface
354 :param remote_mac: client (remote) mac address
358 self.papi.p2p_ethernet_add,
359 {'parent_if_index': sw_if_index,
360 'remote_mac': remote_mac,
361 'subif_id': subif_id})
363 def p2p_ethernet_del(self, sw_if_index, remote_mac):
364 """Delete p2p ethernet subinterface
366 :param sw_if_index: main (parent) interface
367 :param remote_mac: client (remote) mac address
371 self.papi.p2p_ethernet_del,
372 {'parent_if_index': sw_if_index,
373 'remote_mac': remote_mac})
375 def create_vlan_subif(self, sw_if_index, vlan):
382 return self.api(self.papi.create_vlan_subif,
383 {'sw_if_index': sw_if_index,
386 def create_loopback(self, mac=''):
389 :param mac: (Optional)
391 return self.api(self.papi.create_loopback,
392 {'mac_address': mac})
394 def ip_route_dump(self, table_id, is_ip6=False):
395 return self.api(self.papi.ip_route_dump,
397 'table_id': table_id,
401 def ip_route_v2_dump(self, table_id, is_ip6=False, src=0):
402 return self.api(self.papi.ip_route_v2_dump,
406 'table_id': table_id,
411 def ip_neighbor_add_del(self,
417 """ Add neighbor MAC to IPv4 or IPv6 address.
422 :param is_add: (Default value = 1)
423 :param flags: (Default value = 0/NONE)
426 self.papi.ip_neighbor_add_del,
430 'sw_if_index': sw_if_index,
432 'mac_address': mac_address,
433 'ip_address': ip_address
438 def udp_encap_add(self,
449 :param outer_fib_id: (Default value = 0)
453 self.papi.udp_encap_add,
458 'src_port': src_port,
459 'dst_port': dst_port,
464 def udp_encap_del(self, id):
465 return self.api(self.papi.udp_encap_del, {'id': id})
467 def udp_encap_dump(self):
468 return self.api(self.papi.udp_encap_dump, {})
470 def want_udp_encap_stats(self, enable=1):
471 return self.api(self.papi.want_udp_encap_stats,
475 def mpls_route_dump(self, table_id):
476 return self.api(self.papi.mpls_route_dump,
478 'mt_table_id': table_id
481 def mpls_table_dump(self):
482 return self.api(self.papi.mpls_table_dump, {})
484 def mpls_table_add_del(
491 :param is_add: (Default value = 1)
496 self.papi.mpls_table_add_del,
499 'mt_table_id': table_id,
501 'mt_is_add': is_add})
503 def mpls_route_add_del(self,
512 """ MPLS Route add/del """
514 self.papi.mpls_route_add_del,
517 'mr_table_id': table_id,
520 'mr_eos_proto': eos_proto,
521 'mr_is_multicast': is_multicast,
522 'mr_n_paths': len(paths),
526 'mr_is_multipath': is_multipath})
528 def mpls_ip_bind_unbind(
538 self.papi.mpls_ip_bind_unbind,
539 {'mb_mpls_table_id': table_id,
541 'mb_ip_table_id': ip_table_id,
542 'mb_is_bind': is_bind,
543 'mb_prefix': prefix})
545 def mpls_tunnel_add_del(
555 self.papi.mpls_tunnel_add_del,
556 {'mt_is_add': is_add,
559 'mt_sw_if_index': tun_sw_if_index,
560 'mt_l2_only': l2_only,
561 'mt_is_multicast': is_multicast,
562 'mt_n_paths': len(paths),
566 def input_acl_set_interface(
570 ip4_table_index=0xFFFFFFFF,
571 ip6_table_index=0xFFFFFFFF,
572 l2_table_index=0xFFFFFFFF):
576 :param ip4_table_index: (Default value = 0xFFFFFFFF)
577 :param ip6_table_index: (Default value = 0xFFFFFFFF)
578 :param l2_table_index: (Default value = 0xFFFFFFFF)
582 self.papi.input_acl_set_interface,
583 {'sw_if_index': sw_if_index,
584 'ip4_table_index': ip4_table_index,
585 'ip6_table_index': ip6_table_index,
586 'l2_table_index': l2_table_index,
589 def output_acl_set_interface(
593 ip4_table_index=0xFFFFFFFF,
594 ip6_table_index=0xFFFFFFFF,
595 l2_table_index=0xFFFFFFFF):
599 :param ip4_table_index: (Default value = 0xFFFFFFFF)
600 :param ip6_table_index: (Default value = 0xFFFFFFFF)
601 :param l2_table_index: (Default value = 0xFFFFFFFF)
605 self.papi.output_acl_set_interface,
606 {'sw_if_index': sw_if_index,
607 'ip4_table_index': ip4_table_index,
608 'ip6_table_index': ip6_table_index,
609 'l2_table_index': l2_table_index,
612 def set_ipfix_exporter(
622 self.papi.set_ipfix_exporter,
624 'collector_address': collector_address,
625 'collector_port': collector_port,
626 'src_address': src_address,
628 'path_mtu': path_mtu,
629 'template_interval': template_interval,
630 'udp_checksum': udp_checksum,
633 def mfib_signal_dump(self):
634 return self.api(self.papi.mfib_signal_dump, {})
636 def ip_mroute_dump(self, table_id, is_ip6=False):
637 return self.api(self.papi.ip_mroute_dump,
639 'table_id': table_id,
643 def pppoe_add_del_session(
652 :param is_add: (Default value = 1)
653 :param is_ipv6: (Default value = 0)
655 :param session_id: (Default value = 0)
657 :param decap_vrf_id: (Default value = 0)
660 return self.api(self.papi.pppoe_add_del_session,
662 'session_id': session_id,
663 'client_ip': client_ip,
664 'decap_vrf_id': decap_vrf_id,
665 'client_mac': client_mac})
667 def sr_mpls_policy_add(self, bsid, weight, type, segments):
668 return self.api(self.papi.sr_mpls_policy_add,
672 'n_segments': len(segments),
673 'segments': segments})
675 def sr_mpls_policy_del(self, bsid):
676 return self.api(self.papi.sr_mpls_policy_del,
679 def bier_table_add_del(self,
683 """ BIER Table add/del """
685 self.papi.bier_table_add_del,
686 {'bt_tbl_id': {"bt_set": bti.set_id,
687 "bt_sub_domain": bti.sub_domain_id,
688 "bt_hdr_len_id": bti.hdr_len_id},
689 'bt_label': mpls_label,
690 'bt_is_add': is_add})
692 def bier_table_dump(self):
693 return self.api(self.papi.bier_table_dump, {})
695 def bier_route_add_del(self,
701 """ BIER Route add/del """
703 self.papi.bier_route_add_del,
706 'br_tbl_id': {"bt_set": bti.set_id,
707 "bt_sub_domain": bti.sub_domain_id,
708 "bt_hdr_len_id": bti.hdr_len_id},
710 'br_n_paths': len(paths),
714 'br_is_replace': is_replace
717 def bier_route_dump(self, bti):
719 self.papi.bier_route_dump,
720 {'br_tbl_id': {"bt_set": bti.set_id,
721 "bt_sub_domain": bti.sub_domain_id,
722 "bt_hdr_len_id": bti.hdr_len_id}})
724 def bier_imp_add(self,
729 """ BIER Imposition Add """
731 self.papi.bier_imp_add,
732 {'bi_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 'bi_n_bytes': len(ibytes),
739 def bier_imp_del(self, bi_index):
740 """ BIER Imposition del """
742 self.papi.bier_imp_del,
743 {'bi_index': bi_index})
745 def bier_imp_dump(self):
746 return self.api(self.papi.bier_imp_dump, {})
748 def bier_disp_table_add_del(self,
751 """ BIER Disposition Table add/del """
753 self.papi.bier_disp_table_add_del,
755 'bdt_is_add': is_add})
757 def bier_disp_table_dump(self):
758 return self.api(self.papi.bier_disp_table_dump, {})
760 def bier_disp_entry_add_del(self,
770 """ BIER Route add/del """
772 while (len(lstack) < 16):
775 self.papi.bier_disp_entry_add_del,
778 'bde_payload_proto': payload_proto,
780 'bde_paths': [{'table_id': next_hop_tbl_id,
781 'rpf_id': next_hop_rpf_id,
783 'label_stack': lstack}],
784 'bde_is_add': is_add})
786 def bier_disp_entry_dump(self, bdti):
788 self.papi.bier_disp_entry_dump,
789 {'bde_tbl_id': bdti})
791 def ipsec_spd_add_del(self, spd_id, is_add=1):
792 """ SPD add/del - Wrapper to add or del ipsec SPD
793 Sample CLI : 'ipsec spd add 1'
795 :param spd_id - SPD ID to be created in the vpp . mandatory
796 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
798 :returns: reply from the API
801 self.papi.ipsec_spd_add_del, {
802 'spd_id': spd_id, 'is_add': is_add})
804 def ipsec_spds_dump(self):
805 return self.api(self.papi.ipsec_spds_dump, {})
807 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
808 """ IPSEC interface SPD add/del - \
809 Wrapper to associate/disassociate SPD to interface in VPP
810 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
812 :param spd_id - SPD ID to associate with the interface . mandatory
813 :param sw_if_index - Interface Index which needs to ipsec \
814 association mandatory
815 :param is_add - add(1) or del(0) association with interface \
816 (Default 1 - add) . optional
817 :returns: reply from the API
820 self.papi.ipsec_interface_add_del_spd,
821 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
823 def ipsec_spd_interface_dump(self, spd_index=None):
824 return self.api(self.papi.ipsec_spd_interface_dump,
825 {'spd_index': spd_index if spd_index else 0,
826 'spd_index_valid': 1 if spd_index else 0})
828 def ipsec_spd_entry_add_del(self,
833 remote_address_start,
836 local_port_stop=65535,
838 remote_port_stop=65535,
846 """ IPSEC policy SPD add/del -
847 Wrapper to configure ipsec SPD policy entries in VPP
849 :param spd_id: SPD ID for the policy
850 :param local_address_start: local-ip-range start address
851 :param local_address_stop: local-ip-range stop address
852 :param remote_address_start: remote-ip-range start address
853 :param remote_address_stop: remote-ip-range stop address
854 :param local_port_start: (Default value = 0)
855 :param local_port_stop: (Default value = 65535)
856 :param remote_port_start: (Default value = 0)
857 :param remote_port_stop: (Default value = 65535)
858 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
859 :param sa_id: Security Association ID for mapping it to SPD
860 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
862 :param priority: value for the spd action (Default value = 100)
863 :param is_outbound: flag for inbound(0) or outbound(1)
865 :param is_add: (Default value = 1)
868 self.papi.ipsec_spd_entry_add_del,
875 'local_address_start': local_address_start,
876 'local_address_stop': local_address_stop,
877 'remote_address_start': remote_address_start,
878 'remote_address_stop': remote_address_stop,
879 'local_port_start': local_port_start,
880 'local_port_stop': local_port_stop,
881 'remote_port_start': remote_port_start,
882 'remote_port_stop': remote_port_stop,
883 'protocol': protocol,
885 'priority': priority,
886 'is_outbound': is_outbound,
890 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
891 return self.api(self.papi.ipsec_spd_dump,
895 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
896 remote_spi, crypto_alg, local_crypto_key,
897 remote_crypto_key, integ_alg, local_integ_key,
898 remote_integ_key, is_add=1, esn=0, salt=0,
899 anti_replay=1, renumber=0,
900 udp_encap=0, show_instance=0xffffffff):
902 self.papi.ipsec_tunnel_if_add_del,
904 'local_ip': local_ip,
905 'remote_ip': remote_ip,
906 'local_spi': local_spi,
907 'remote_spi': remote_spi,
908 'crypto_alg': crypto_alg,
909 'local_crypto_key_len': len(local_crypto_key),
910 'local_crypto_key': local_crypto_key,
911 'remote_crypto_key_len': len(remote_crypto_key),
912 'remote_crypto_key': remote_crypto_key,
913 'integ_alg': integ_alg,
914 'local_integ_key_len': len(local_integ_key),
915 'local_integ_key': local_integ_key,
916 'remote_integ_key_len': len(remote_integ_key),
917 'remote_integ_key': remote_integ_key,
920 'anti_replay': anti_replay,
921 'renumber': renumber,
922 'show_instance': show_instance,
923 'udp_encap': udp_encap,
927 def ipsec_select_backend(self, protocol, index):
928 return self.api(self.papi.ipsec_select_backend,
929 {'protocol': protocol, 'index': index})
931 def ipsec_backend_dump(self):
932 return self.api(self.papi.ipsec_backend_dump, {})
934 def punt_socket_register(self, reg, pathname,
936 """ Register punt socket """
937 return self.api(self.papi.punt_socket_register,
938 {'header_version': header_version,
940 'pathname': pathname})
942 def punt_socket_deregister(self, reg):
943 """ Unregister punt socket """
944 return self.api(self.papi.punt_socket_deregister,
947 def igmp_enable_disable(self, sw_if_index, enable, host):
948 """ Enable/disable IGMP on a given interface """
949 return self.api(self.papi.igmp_enable_disable,
952 'sw_if_index': sw_if_index})
954 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
955 """ Add/del IGMP proxy device """
956 return self.api(self.papi.igmp_proxy_device_add_del,
957 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
960 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
961 """ Add/del interface to/from IGMP proxy device """
962 return self.api(self.papi.igmp_proxy_device_add_del_interface,
963 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
966 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
967 """ Listen for new (S,G) on specified interface
969 :param enable: add/delas
970 :param sw_if_index: interface sw index
971 :param saddr: source ip4 addr
972 :param gaddr: group ip4 addr
974 return self.api(self.papi.igmp_listen,
979 'sw_if_index': sw_if_index,
980 'n_srcs': len(saddrs),
986 def igmp_clear_interface(self, sw_if_index):
987 """ Remove all (S,G)s from specified interface
988 doesn't send IGMP report!
991 self.papi.igmp_clear_interface, {
992 'sw_if_index': sw_if_index})
994 def want_igmp_events(self, enable=1):
995 return self.api(self.papi.want_igmp_events, {'enable': enable,