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 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
98 'want_bfd_events': {'enable_disable': 1, },
99 'want_igmp_events': {'enable': 1, },
100 'want_interface_events': {'enable_disable': 1, },
101 'want_l2_macs_events': {'enable_disable': 1, 'pid': os.getpid(), },
102 'want_l2_macs_events2': {'enable_disable': 1, 'pid': os.getpid(), },
106 def as_fn_signature(d):
107 return ", ".join(f"{k}={v}" for k, v in d.items())
110 class CliFailedCommandError(Exception):
111 """ cli command failed."""
114 class CliSyntaxError(Exception):
115 """ cli command had a syntax error."""
118 class UnexpectedApiReturnValueError(Exception):
119 """ exception raised when the API return value is unexpected """
123 class VppPapiProvider(object):
124 """VPP-api provider using vpp-papi
126 @property hook: hook object providing before and after api/cli hooks
129 _zero, _negative = range(2)
131 def __init__(self, name, test_class, read_timeout):
132 self.hook = Hook(test_class)
134 self.test_class = test_class
135 self._expect_api_retval = self._zero
136 self._expect_stack = []
138 # install_dir is a class attribute. We need to set it before
139 # calling the constructor.
140 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
142 self.vpp = VPPApiClient(logger=test_class.logger,
143 read_timeout=read_timeout,
145 server_address=test_class.get_api_sock_path())
146 self._events = queue.Queue()
151 def assert_negative_api_retval(self):
152 """ Expect API failure - used with with, e.g.:
153 with self.vapi.assert_negative_api_retval():
154 self.vapi.<api call expected to fail>
156 self._expect_stack.append(self._expect_api_retval)
157 self._expect_api_retval = self._negative
160 def assert_zero_api_retval(self):
161 """ Expect API success - used with with, e.g.:
162 with self.vapi.assert_negative_api_retval():
163 self.vapi.<api call expected to succeed>
165 note: this is useful only inside another with block
166 as success is the default expected value
168 self._expect_stack.append(self._expect_api_retval)
169 self._expect_api_retval = self._zero
172 def __exit__(self, exc_type, exc_value, traceback):
173 self._expect_api_retval = self._expect_stack.pop()
175 def register_hook(self, hook):
176 """Replace hook registration with new hook
183 def collect_events(self):
184 """ Collect all events from the internal queue and clear the queue. """
188 e = self._events.get(block=False)
194 def wait_for_event(self, timeout, name=None):
195 """ Wait for and return next event. """
197 self.test_class.logger.debug("Expecting event '%s' within %ss",
200 self.test_class.logger.debug("Expecting event within %ss",
203 e = self._events.get(timeout=timeout)
205 raise Exception("Event did not occur within timeout")
206 msgname = type(e).__name__
207 if name and msgname != name:
208 raise Exception("Unexpected event received: %s, expected: %s"
210 self.test_class.logger.debug("Returning event %s:%s" % (name, e))
213 def __call__(self, name, event):
214 """ Enqueue event in the internal event queue. """
215 self.test_class.logger.debug("New event: %s: %s" % (name, event))
216 self._events.put(event)
218 def factory(self, name, apifn):
220 fields = apifn._func.msg.fields
222 # add positional and kw arguments
224 for i, o in enumerate(fields[3:]):
227 except BaseException:
231 if name in defaultmapping:
232 for k, v in iteritems(defaultmapping[name]):
236 return self.api(apifn, d)
240 def __getattribute__(self, name):
242 method = super(VppPapiProvider, self).__getattribute__(name)
243 except AttributeError:
244 method = self.factory(name, getattr(self.papi, name))
245 # lazily load the method so we don't need to call factory
246 # again for this name.
247 setattr(self, name, method)
251 """Connect the API to VPP"""
252 # This might be called before VPP is prepared to listen to the socket
254 while not os.path.exists(self.test_class.get_api_sock_path()):
259 self.vpp.connect(self.name[:63])
260 self.papi = self.vpp.api
261 self.vpp.register_event_callback(self)
263 def disconnect(self):
264 """Disconnect the API from VPP"""
265 self.vpp.disconnect()
267 def api(self, api_fn, api_args, expected_retval=0):
268 """ Call API function and check it's return value.
269 Call the appropriate hooks before and after the API call
271 :param api_fn: API function to call
272 :param api_args: tuple of API function arguments
273 :param expected_retval: Expected return value (Default value = 0)
274 :returns: reply from the API
277 self.hook.before_api(api_fn.__name__, api_args)
278 reply = api_fn(**api_args)
279 if self._expect_api_retval == self._negative:
280 if hasattr(reply, 'retval') and reply.retval >= 0:
281 msg = "%s(%s) passed unexpectedly: expected negative " \
282 "return value instead of %d in %s" % \
283 (api_fn.__name__, as_fn_signature(api_args),
285 moves.reprlib.repr(reply))
286 self.test_class.logger.info(msg)
287 raise UnexpectedApiReturnValueError(msg)
288 elif self._expect_api_retval == self._zero:
289 if hasattr(reply, 'retval') and reply.retval != expected_retval:
290 msg = "%s(%s) failed, expected %d return value instead " \
291 "of %d in %s" % (api_fn.__name__,
292 as_fn_signature(api_args),
293 expected_retval, reply.retval,
295 self.test_class.logger.info(msg)
296 raise UnexpectedApiReturnValueError(msg)
298 raise Exception("Internal error, unexpected value for "
299 "self._expect_api_retval %s" %
300 self._expect_api_retval)
301 self.hook.after_api(api_fn.__name__, api_args)
304 def cli_return_response(self, cli):
305 """ Execute a CLI, calling the before/after hooks appropriately.
306 Return the reply without examining it
308 :param cli: CLI to execute
309 :returns: response object
312 self.hook.before_cli(cli)
314 r = self.papi.cli_inband(cmd=cli)
315 self.hook.after_cli(cli)
319 """ Execute a CLI, calling the before/after hooks appropriately.
321 :param cli: CLI to execute
325 r = self.cli_return_response(cli)
327 raise CliSyntaxError(r.reply)
329 raise CliFailedCommandError(r.reply)
330 if hasattr(r, 'reply'):
333 def ppcli(self, cli):
334 """ Helper method to print CLI command in case of info logging level.
336 :param cli: CLI to execute
339 return cli + "\n" + self.cli(cli)
341 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
343 return self.api(self.papi.ip6nd_send_router_solicitation,
348 'sw_if_index': sw_if_index})
350 def want_interface_events(self, enable_disable=1):
351 return self.api(self.papi.want_interface_events,
352 {'enable_disable': enable_disable,
353 'pid': os.getpid(), })
355 def sw_interface_set_mac_address(self, sw_if_index, mac):
356 return self.api(self.papi.sw_interface_set_mac_address,
357 {'sw_if_index': sw_if_index,
360 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
361 """Create p2p ethernet subinterface
363 :param sw_if_index: main (parent) interface
364 :param remote_mac: client (remote) mac address
368 self.papi.p2p_ethernet_add,
369 {'parent_if_index': sw_if_index,
370 'remote_mac': remote_mac,
371 'subif_id': subif_id})
373 def p2p_ethernet_del(self, sw_if_index, remote_mac):
374 """Delete p2p ethernet subinterface
376 :param sw_if_index: main (parent) interface
377 :param remote_mac: client (remote) mac address
381 self.papi.p2p_ethernet_del,
382 {'parent_if_index': sw_if_index,
383 'remote_mac': remote_mac})
385 def create_vlan_subif(self, sw_if_index, vlan):
392 return self.api(self.papi.create_vlan_subif,
393 {'sw_if_index': sw_if_index,
396 def create_loopback(self, mac=''):
399 :param mac: (Optional)
401 return self.api(self.papi.create_loopback,
402 {'mac_address': mac})
404 def ip_route_dump(self, table_id, is_ip6=False):
405 return self.api(self.papi.ip_route_dump,
407 'table_id': table_id,
411 def ip_route_v2_dump(self, table_id, is_ip6=False, src=0):
412 return self.api(self.papi.ip_route_v2_dump,
416 'table_id': table_id,
421 def ip_neighbor_add_del(self,
427 """ Add neighbor MAC to IPv4 or IPv6 address.
432 :param is_add: (Default value = 1)
433 :param flags: (Default value = 0/NONE)
436 self.papi.ip_neighbor_add_del,
440 'sw_if_index': sw_if_index,
442 'mac_address': mac_address,
443 'ip_address': ip_address
448 def udp_encap_add(self,
459 :param outer_fib_id: (Default value = 0)
463 self.papi.udp_encap_add,
468 'src_port': src_port,
469 'dst_port': dst_port,
474 def udp_encap_del(self, id):
475 return self.api(self.papi.udp_encap_del, {'id': id})
477 def udp_encap_dump(self):
478 return self.api(self.papi.udp_encap_dump, {})
480 def want_udp_encap_stats(self, enable=1):
481 return self.api(self.papi.want_udp_encap_stats,
485 def mpls_route_dump(self, table_id):
486 return self.api(self.papi.mpls_route_dump,
488 'mt_table_id': table_id
491 def mpls_table_dump(self):
492 return self.api(self.papi.mpls_table_dump, {})
494 def mpls_table_add_del(
501 :param is_add: (Default value = 1)
506 self.papi.mpls_table_add_del,
509 'mt_table_id': table_id,
511 'mt_is_add': is_add})
513 def mpls_route_add_del(self,
522 """ MPLS Route add/del """
524 self.papi.mpls_route_add_del,
527 'mr_table_id': table_id,
530 'mr_eos_proto': eos_proto,
531 'mr_is_multicast': is_multicast,
532 'mr_n_paths': len(paths),
536 'mr_is_multipath': is_multipath})
538 def mpls_ip_bind_unbind(
548 self.papi.mpls_ip_bind_unbind,
549 {'mb_mpls_table_id': table_id,
551 'mb_ip_table_id': ip_table_id,
552 'mb_is_bind': is_bind,
553 'mb_prefix': prefix})
555 def mpls_tunnel_add_del(
565 self.papi.mpls_tunnel_add_del,
566 {'mt_is_add': is_add,
569 'mt_sw_if_index': tun_sw_if_index,
570 'mt_l2_only': l2_only,
571 'mt_is_multicast': is_multicast,
572 'mt_n_paths': len(paths),
576 def input_acl_set_interface(
580 ip4_table_index=0xFFFFFFFF,
581 ip6_table_index=0xFFFFFFFF,
582 l2_table_index=0xFFFFFFFF):
586 :param ip4_table_index: (Default value = 0xFFFFFFFF)
587 :param ip6_table_index: (Default value = 0xFFFFFFFF)
588 :param l2_table_index: (Default value = 0xFFFFFFFF)
592 self.papi.input_acl_set_interface,
593 {'sw_if_index': sw_if_index,
594 'ip4_table_index': ip4_table_index,
595 'ip6_table_index': ip6_table_index,
596 'l2_table_index': l2_table_index,
599 def output_acl_set_interface(
603 ip4_table_index=0xFFFFFFFF,
604 ip6_table_index=0xFFFFFFFF,
605 l2_table_index=0xFFFFFFFF):
609 :param ip4_table_index: (Default value = 0xFFFFFFFF)
610 :param ip6_table_index: (Default value = 0xFFFFFFFF)
611 :param l2_table_index: (Default value = 0xFFFFFFFF)
615 self.papi.output_acl_set_interface,
616 {'sw_if_index': sw_if_index,
617 'ip4_table_index': ip4_table_index,
618 'ip6_table_index': ip6_table_index,
619 'l2_table_index': l2_table_index,
622 def set_ipfix_exporter(
632 self.papi.set_ipfix_exporter,
634 'collector_address': collector_address,
635 'collector_port': collector_port,
636 'src_address': src_address,
638 'path_mtu': path_mtu,
639 'template_interval': template_interval,
640 'udp_checksum': udp_checksum,
643 def mfib_signal_dump(self):
644 return self.api(self.papi.mfib_signal_dump, {})
646 def ip_mroute_dump(self, table_id, is_ip6=False):
647 return self.api(self.papi.ip_mroute_dump,
649 'table_id': table_id,
653 def vxlan_gpe_add_del_tunnel(
657 mcast_sw_if_index=0xFFFFFFFF,
668 :param is_add: (Default value = 1)
669 :param is_ipv6: (Default value = 0)
670 :param encap_vrf_id: (Default value = 0)
671 :param decap_vrf_id: (Default value = 0)
672 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
673 :param protocol: (Default value = 3)
674 :param vni: (Default value = 0)
677 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
682 'mcast_sw_if_index': mcast_sw_if_index,
683 'encap_vrf_id': encap_vrf_id,
684 'decap_vrf_id': decap_vrf_id,
685 'protocol': protocol,
688 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
689 return self.api(self.papi.vxlan_gbp_tunnel_dump,
690 {'sw_if_index': sw_if_index})
692 def pppoe_add_del_session(
701 :param is_add: (Default value = 1)
702 :param is_ipv6: (Default value = 0)
704 :param session_id: (Default value = 0)
706 :param decap_vrf_id: (Default value = 0)
709 return self.api(self.papi.pppoe_add_del_session,
711 'session_id': session_id,
712 'client_ip': client_ip,
713 'decap_vrf_id': decap_vrf_id,
714 'client_mac': client_mac})
716 def sr_mpls_policy_add(self, bsid, weight, type, segments):
717 return self.api(self.papi.sr_mpls_policy_add,
721 'n_segments': len(segments),
722 'segments': segments})
724 def sr_mpls_policy_del(self, bsid):
725 return self.api(self.papi.sr_mpls_policy_del,
728 def bier_table_add_del(self,
732 """ BIER Table add/del """
734 self.papi.bier_table_add_del,
735 {'bt_tbl_id': {"bt_set": bti.set_id,
736 "bt_sub_domain": bti.sub_domain_id,
737 "bt_hdr_len_id": bti.hdr_len_id},
738 'bt_label': mpls_label,
739 'bt_is_add': is_add})
741 def bier_table_dump(self):
742 return self.api(self.papi.bier_table_dump, {})
744 def bier_route_add_del(self,
750 """ BIER Route add/del """
752 self.papi.bier_route_add_del,
755 'br_tbl_id': {"bt_set": bti.set_id,
756 "bt_sub_domain": bti.sub_domain_id,
757 "bt_hdr_len_id": bti.hdr_len_id},
759 'br_n_paths': len(paths),
763 'br_is_replace': is_replace
766 def bier_route_dump(self, bti):
768 self.papi.bier_route_dump,
769 {'br_tbl_id': {"bt_set": bti.set_id,
770 "bt_sub_domain": bti.sub_domain_id,
771 "bt_hdr_len_id": bti.hdr_len_id}})
773 def bier_imp_add(self,
778 """ BIER Imposition Add """
780 self.papi.bier_imp_add,
781 {'bi_tbl_id': {"bt_set": bti.set_id,
782 "bt_sub_domain": bti.sub_domain_id,
783 "bt_hdr_len_id": bti.hdr_len_id},
785 'bi_n_bytes': len(ibytes),
788 def bier_imp_del(self, bi_index):
789 """ BIER Imposition del """
791 self.papi.bier_imp_del,
792 {'bi_index': bi_index})
794 def bier_imp_dump(self):
795 return self.api(self.papi.bier_imp_dump, {})
797 def bier_disp_table_add_del(self,
800 """ BIER Disposition Table add/del """
802 self.papi.bier_disp_table_add_del,
804 'bdt_is_add': is_add})
806 def bier_disp_table_dump(self):
807 return self.api(self.papi.bier_disp_table_dump, {})
809 def bier_disp_entry_add_del(self,
819 """ BIER Route add/del """
821 while (len(lstack) < 16):
824 self.papi.bier_disp_entry_add_del,
827 'bde_payload_proto': payload_proto,
829 'bde_paths': [{'table_id': next_hop_tbl_id,
830 'rpf_id': next_hop_rpf_id,
832 'label_stack': lstack}],
833 'bde_is_add': is_add})
835 def bier_disp_entry_dump(self, bdti):
837 self.papi.bier_disp_entry_dump,
838 {'bde_tbl_id': bdti})
840 def ipsec_spd_add_del(self, spd_id, is_add=1):
841 """ SPD add/del - Wrapper to add or del ipsec SPD
842 Sample CLI : 'ipsec spd add 1'
844 :param spd_id - SPD ID to be created in the vpp . mandatory
845 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
847 :returns: reply from the API
850 self.papi.ipsec_spd_add_del, {
851 'spd_id': spd_id, 'is_add': is_add})
853 def ipsec_spds_dump(self):
854 return self.api(self.papi.ipsec_spds_dump, {})
856 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
857 """ IPSEC interface SPD add/del - \
858 Wrapper to associate/disassociate SPD to interface in VPP
859 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
861 :param spd_id - SPD ID to associate with the interface . mandatory
862 :param sw_if_index - Interface Index which needs to ipsec \
863 association mandatory
864 :param is_add - add(1) or del(0) association with interface \
865 (Default 1 - add) . optional
866 :returns: reply from the API
869 self.papi.ipsec_interface_add_del_spd,
870 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
872 def ipsec_spd_interface_dump(self, spd_index=None):
873 return self.api(self.papi.ipsec_spd_interface_dump,
874 {'spd_index': spd_index if spd_index else 0,
875 'spd_index_valid': 1 if spd_index else 0})
877 def ipsec_spd_entry_add_del(self,
882 remote_address_start,
885 local_port_stop=65535,
887 remote_port_stop=65535,
895 """ IPSEC policy SPD add/del -
896 Wrapper to configure ipsec SPD policy entries in VPP
897 :param spd_id: SPD ID for the policy
898 :param local_address_start: local-ip-range start address
899 :param local_address_stop : local-ip-range stop address
900 :param remote_address_start: remote-ip-range start address
901 :param remote_address_stop : remote-ip-range stop address
902 :param local_port_start: (Default value = 0)
903 :param local_port_stop: (Default value = 65535)
904 :param remote_port_start: (Default value = 0)
905 :param remote_port_stop: (Default value = 65535)
906 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
907 :param sa_id: Security Association ID for mapping it to SPD
908 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
910 :param priority: value for the spd action (Default value = 100)
911 :param is_outbound: flag for inbound(0) or outbound(1)
913 :param is_add: (Default value = 1)
916 self.papi.ipsec_spd_entry_add_del,
923 'local_address_start': local_address_start,
924 'local_address_stop': local_address_stop,
925 'remote_address_start': remote_address_start,
926 'remote_address_stop': remote_address_stop,
927 'local_port_start': local_port_start,
928 'local_port_stop': local_port_stop,
929 'remote_port_start': remote_port_start,
930 'remote_port_stop': remote_port_stop,
931 'protocol': protocol,
933 'priority': priority,
934 'is_outbound': is_outbound,
938 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
939 return self.api(self.papi.ipsec_spd_dump,
943 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
944 remote_spi, crypto_alg, local_crypto_key,
945 remote_crypto_key, integ_alg, local_integ_key,
946 remote_integ_key, is_add=1, esn=0, salt=0,
947 anti_replay=1, renumber=0,
948 udp_encap=0, show_instance=0xffffffff):
950 self.papi.ipsec_tunnel_if_add_del,
952 'local_ip': local_ip,
953 'remote_ip': remote_ip,
954 'local_spi': local_spi,
955 'remote_spi': remote_spi,
956 'crypto_alg': crypto_alg,
957 'local_crypto_key_len': len(local_crypto_key),
958 'local_crypto_key': local_crypto_key,
959 'remote_crypto_key_len': len(remote_crypto_key),
960 'remote_crypto_key': remote_crypto_key,
961 'integ_alg': integ_alg,
962 'local_integ_key_len': len(local_integ_key),
963 'local_integ_key': local_integ_key,
964 'remote_integ_key_len': len(remote_integ_key),
965 'remote_integ_key': remote_integ_key,
968 'anti_replay': anti_replay,
969 'renumber': renumber,
970 'show_instance': show_instance,
971 'udp_encap': udp_encap,
975 def ipsec_select_backend(self, protocol, index):
976 return self.api(self.papi.ipsec_select_backend,
977 {'protocol': protocol, 'index': index})
979 def ipsec_backend_dump(self):
980 return self.api(self.papi.ipsec_backend_dump, {})
982 def punt_socket_register(self, reg, pathname,
984 """ Register punt socket """
985 return self.api(self.papi.punt_socket_register,
986 {'header_version': header_version,
988 'pathname': pathname})
990 def punt_socket_deregister(self, reg):
991 """ Unregister punt socket """
992 return self.api(self.papi.punt_socket_deregister,
995 def gbp_endpoint_dump(self):
996 """ GBP endpoint Dump """
997 return self.api(self.papi.gbp_endpoint_dump, {})
999 def gbp_recirc_dump(self):
1000 """ GBP recirc Dump """
1001 return self.api(self.papi.gbp_recirc_dump, {})
1003 def gbp_ext_itf_dump(self):
1004 """ GBP recirc Dump """
1005 return self.api(self.papi.gbp_ext_itf_dump, {})
1007 def gbp_subnet_dump(self):
1008 """ GBP Subnet Dump """
1009 return self.api(self.papi.gbp_subnet_dump, {})
1011 def gbp_contract_dump(self):
1012 """ GBP contract Dump """
1013 return self.api(self.papi.gbp_contract_dump, {})
1015 def gbp_vxlan_tunnel_dump(self):
1016 """ GBP VXLAN tunnel add/del """
1017 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1019 def igmp_enable_disable(self, sw_if_index, enable, host):
1020 """ Enable/disable IGMP on a given interface """
1021 return self.api(self.papi.igmp_enable_disable,
1024 'sw_if_index': sw_if_index})
1026 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1027 """ Add/del IGMP proxy device """
1028 return self.api(self.papi.igmp_proxy_device_add_del,
1029 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1032 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1033 """ Add/del interface to/from IGMP proxy device """
1034 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1035 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1038 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1039 """ Listen for new (S,G) on specified interface
1041 :param enable: add/del
1042 :param sw_if_index: interface sw index
1043 :param saddr: source ip4 addr
1044 :param gaddr: group ip4 addr
1046 return self.api(self.papi.igmp_listen,
1051 'sw_if_index': sw_if_index,
1052 'n_srcs': len(saddrs),
1058 def igmp_clear_interface(self, sw_if_index):
1059 """ Remove all (S,G)s from specified interface
1060 doesn't send IGMP report!
1063 self.papi.igmp_clear_interface, {
1064 'sw_if_index': sw_if_index})
1066 def want_igmp_events(self, enable=1):
1067 return self.api(self.papi.want_igmp_events, {'enable': enable,
1068 'pid': os.getpid()})