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.::
154 with self.vapi.assert_negative_api_retval():
155 self.vapi.<api call expected to fail>
159 self._expect_stack.append(self._expect_api_retval)
160 self._expect_api_retval = self._negative
163 def assert_zero_api_retval(self):
164 """ Expect API success - used with with, e.g.::
166 with self.vapi.assert_negative_api_retval():
167 self.vapi.<api call expected to succeed>
169 :note: this is useful only inside another with block
170 as success is the default expected value
172 self._expect_stack.append(self._expect_api_retval)
173 self._expect_api_retval = self._zero
176 def __exit__(self, exc_type, exc_value, traceback):
177 self._expect_api_retval = self._expect_stack.pop()
179 def register_hook(self, hook):
180 """Replace hook registration with new hook
187 def collect_events(self):
188 """ Collect all events from the internal queue and clear the queue. """
192 e = self._events.get(block=False)
198 def wait_for_event(self, timeout, name=None):
199 """ Wait for and return next event. """
201 self.test_class.logger.debug("Expecting event '%s' within %ss",
204 self.test_class.logger.debug("Expecting event within %ss",
207 e = self._events.get(timeout=timeout)
209 raise Exception("Event did not occur within timeout")
210 msgname = type(e).__name__
211 if name and msgname != name:
212 raise Exception("Unexpected event received: %s, expected: %s"
214 self.test_class.logger.debug("Returning event %s:%s" % (name, e))
217 def __call__(self, name, event):
218 """ Enqueue event in the internal event queue. """
219 self.test_class.logger.debug("New event: %s: %s" % (name, event))
220 self._events.put(event)
222 def factory(self, name, apifn):
224 fields = apifn._func.msg.fields
226 # add positional and kw arguments
228 for i, o in enumerate(fields[3:]):
231 except BaseException:
235 if name in defaultmapping:
236 for k, v in iteritems(defaultmapping[name]):
240 return self.api(apifn, d)
244 def __getattribute__(self, name):
246 method = super(VppPapiProvider, self).__getattribute__(name)
247 except AttributeError:
248 method = self.factory(name, getattr(self.papi, name))
249 # lazily load the method so we don't need to call factory
250 # again for this name.
251 setattr(self, name, method)
255 """Connect the API to VPP"""
256 # This might be called before VPP is prepared to listen to the socket
258 while not os.path.exists(self.test_class.get_api_sock_path()):
263 self.vpp.connect(self.name[:63])
264 self.papi = self.vpp.api
265 self.vpp.register_event_callback(self)
267 def disconnect(self):
268 """Disconnect the API from VPP"""
269 self.vpp.disconnect()
271 def api(self, api_fn, api_args, expected_retval=0):
272 """ Call API function and check it's return value.
273 Call the appropriate hooks before and after the API call
275 :param api_fn: API function to call
276 :param api_args: tuple of API function arguments
277 :param expected_retval: Expected return value (Default value = 0)
278 :returns: reply from the API
281 self.hook.before_api(api_fn.__name__, api_args)
282 reply = api_fn(**api_args)
283 if self._expect_api_retval == self._negative:
284 if hasattr(reply, 'retval') and reply.retval >= 0:
285 msg = "%s(%s) passed unexpectedly: expected negative " \
286 "return value instead of %d in %s" % \
287 (api_fn.__name__, as_fn_signature(api_args),
289 moves.reprlib.repr(reply))
290 self.test_class.logger.info(msg)
291 raise UnexpectedApiReturnValueError(msg)
292 elif self._expect_api_retval == self._zero:
293 if hasattr(reply, 'retval') and reply.retval != expected_retval:
294 msg = "%s(%s) failed, expected %d return value instead " \
295 "of %d in %s" % (api_fn.__name__,
296 as_fn_signature(api_args),
297 expected_retval, reply.retval,
299 self.test_class.logger.info(msg)
300 raise UnexpectedApiReturnValueError(msg)
302 raise Exception("Internal error, unexpected value for "
303 "self._expect_api_retval %s" %
304 self._expect_api_retval)
305 self.hook.after_api(api_fn.__name__, api_args)
308 def cli_return_response(self, cli):
309 """ Execute a CLI, calling the before/after hooks appropriately.
310 Return the reply without examining it
312 :param cli: CLI to execute
313 :returns: response object
316 self.hook.before_cli(cli)
318 r = self.papi.cli_inband(cmd=cli)
319 self.hook.after_cli(cli)
323 """ Execute a CLI, calling the before/after hooks appropriately.
325 :param cli: CLI to execute
329 r = self.cli_return_response(cli)
331 raise CliSyntaxError(r.reply)
333 raise CliFailedCommandError(r.reply)
334 if hasattr(r, 'reply'):
337 def ppcli(self, cli):
338 """ Helper method to print CLI command in case of info logging level.
340 :param cli: CLI to execute
343 return cli + "\n" + self.cli(cli)
345 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
347 return self.api(self.papi.ip6nd_send_router_solicitation,
352 'sw_if_index': sw_if_index})
354 def want_interface_events(self, enable_disable=1):
355 return self.api(self.papi.want_interface_events,
356 {'enable_disable': enable_disable,
357 'pid': os.getpid(), })
359 def sw_interface_set_mac_address(self, sw_if_index, mac):
360 return self.api(self.papi.sw_interface_set_mac_address,
361 {'sw_if_index': sw_if_index,
364 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
365 """Create p2p ethernet subinterface
367 :param sw_if_index: main (parent) interface
368 :param remote_mac: client (remote) mac address
372 self.papi.p2p_ethernet_add,
373 {'parent_if_index': sw_if_index,
374 'remote_mac': remote_mac,
375 'subif_id': subif_id})
377 def p2p_ethernet_del(self, sw_if_index, remote_mac):
378 """Delete p2p ethernet subinterface
380 :param sw_if_index: main (parent) interface
381 :param remote_mac: client (remote) mac address
385 self.papi.p2p_ethernet_del,
386 {'parent_if_index': sw_if_index,
387 'remote_mac': remote_mac})
389 def create_vlan_subif(self, sw_if_index, vlan):
396 return self.api(self.papi.create_vlan_subif,
397 {'sw_if_index': sw_if_index,
400 def create_loopback(self, mac=''):
403 :param mac: (Optional)
405 return self.api(self.papi.create_loopback,
406 {'mac_address': mac})
408 def ip_route_dump(self, table_id, is_ip6=False):
409 return self.api(self.papi.ip_route_dump,
411 'table_id': table_id,
415 def ip_route_v2_dump(self, table_id, is_ip6=False, src=0):
416 return self.api(self.papi.ip_route_v2_dump,
420 'table_id': table_id,
425 def ip_neighbor_add_del(self,
431 """ Add neighbor MAC to IPv4 or IPv6 address.
436 :param is_add: (Default value = 1)
437 :param flags: (Default value = 0/NONE)
440 self.papi.ip_neighbor_add_del,
444 'sw_if_index': sw_if_index,
446 'mac_address': mac_address,
447 'ip_address': ip_address
452 def udp_encap_add(self,
463 :param outer_fib_id: (Default value = 0)
467 self.papi.udp_encap_add,
472 'src_port': src_port,
473 'dst_port': dst_port,
478 def udp_encap_del(self, id):
479 return self.api(self.papi.udp_encap_del, {'id': id})
481 def udp_encap_dump(self):
482 return self.api(self.papi.udp_encap_dump, {})
484 def want_udp_encap_stats(self, enable=1):
485 return self.api(self.papi.want_udp_encap_stats,
489 def mpls_route_dump(self, table_id):
490 return self.api(self.papi.mpls_route_dump,
492 'mt_table_id': table_id
495 def mpls_table_dump(self):
496 return self.api(self.papi.mpls_table_dump, {})
498 def mpls_table_add_del(
505 :param is_add: (Default value = 1)
510 self.papi.mpls_table_add_del,
513 'mt_table_id': table_id,
515 'mt_is_add': is_add})
517 def mpls_route_add_del(self,
526 """ MPLS Route add/del """
528 self.papi.mpls_route_add_del,
531 'mr_table_id': table_id,
534 'mr_eos_proto': eos_proto,
535 'mr_is_multicast': is_multicast,
536 'mr_n_paths': len(paths),
540 'mr_is_multipath': is_multipath})
542 def mpls_ip_bind_unbind(
552 self.papi.mpls_ip_bind_unbind,
553 {'mb_mpls_table_id': table_id,
555 'mb_ip_table_id': ip_table_id,
556 'mb_is_bind': is_bind,
557 'mb_prefix': prefix})
559 def mpls_tunnel_add_del(
569 self.papi.mpls_tunnel_add_del,
570 {'mt_is_add': is_add,
573 'mt_sw_if_index': tun_sw_if_index,
574 'mt_l2_only': l2_only,
575 'mt_is_multicast': is_multicast,
576 'mt_n_paths': len(paths),
580 def input_acl_set_interface(
584 ip4_table_index=0xFFFFFFFF,
585 ip6_table_index=0xFFFFFFFF,
586 l2_table_index=0xFFFFFFFF):
590 :param ip4_table_index: (Default value = 0xFFFFFFFF)
591 :param ip6_table_index: (Default value = 0xFFFFFFFF)
592 :param l2_table_index: (Default value = 0xFFFFFFFF)
596 self.papi.input_acl_set_interface,
597 {'sw_if_index': sw_if_index,
598 'ip4_table_index': ip4_table_index,
599 'ip6_table_index': ip6_table_index,
600 'l2_table_index': l2_table_index,
603 def output_acl_set_interface(
607 ip4_table_index=0xFFFFFFFF,
608 ip6_table_index=0xFFFFFFFF,
609 l2_table_index=0xFFFFFFFF):
613 :param ip4_table_index: (Default value = 0xFFFFFFFF)
614 :param ip6_table_index: (Default value = 0xFFFFFFFF)
615 :param l2_table_index: (Default value = 0xFFFFFFFF)
619 self.papi.output_acl_set_interface,
620 {'sw_if_index': sw_if_index,
621 'ip4_table_index': ip4_table_index,
622 'ip6_table_index': ip6_table_index,
623 'l2_table_index': l2_table_index,
626 def set_ipfix_exporter(
636 self.papi.set_ipfix_exporter,
638 'collector_address': collector_address,
639 'collector_port': collector_port,
640 'src_address': src_address,
642 'path_mtu': path_mtu,
643 'template_interval': template_interval,
644 'udp_checksum': udp_checksum,
647 def mfib_signal_dump(self):
648 return self.api(self.papi.mfib_signal_dump, {})
650 def ip_mroute_dump(self, table_id, is_ip6=False):
651 return self.api(self.papi.ip_mroute_dump,
653 'table_id': table_id,
657 def vxlan_gpe_add_del_tunnel(
661 mcast_sw_if_index=0xFFFFFFFF,
672 :param is_add: (Default value = 1)
673 :param is_ipv6: (Default value = 0)
674 :param encap_vrf_id: (Default value = 0)
675 :param decap_vrf_id: (Default value = 0)
676 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
677 :param protocol: (Default value = 3)
678 :param vni: (Default value = 0)
681 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
686 'mcast_sw_if_index': mcast_sw_if_index,
687 'encap_vrf_id': encap_vrf_id,
688 'decap_vrf_id': decap_vrf_id,
689 'protocol': protocol,
692 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
693 return self.api(self.papi.vxlan_gbp_tunnel_dump,
694 {'sw_if_index': sw_if_index})
696 def pppoe_add_del_session(
705 :param is_add: (Default value = 1)
706 :param is_ipv6: (Default value = 0)
708 :param session_id: (Default value = 0)
710 :param decap_vrf_id: (Default value = 0)
713 return self.api(self.papi.pppoe_add_del_session,
715 'session_id': session_id,
716 'client_ip': client_ip,
717 'decap_vrf_id': decap_vrf_id,
718 'client_mac': client_mac})
720 def sr_mpls_policy_add(self, bsid, weight, type, segments):
721 return self.api(self.papi.sr_mpls_policy_add,
725 'n_segments': len(segments),
726 'segments': segments})
728 def sr_mpls_policy_del(self, bsid):
729 return self.api(self.papi.sr_mpls_policy_del,
732 def bier_table_add_del(self,
736 """ BIER Table add/del """
738 self.papi.bier_table_add_del,
739 {'bt_tbl_id': {"bt_set": bti.set_id,
740 "bt_sub_domain": bti.sub_domain_id,
741 "bt_hdr_len_id": bti.hdr_len_id},
742 'bt_label': mpls_label,
743 'bt_is_add': is_add})
745 def bier_table_dump(self):
746 return self.api(self.papi.bier_table_dump, {})
748 def bier_route_add_del(self,
754 """ BIER Route add/del """
756 self.papi.bier_route_add_del,
759 'br_tbl_id': {"bt_set": bti.set_id,
760 "bt_sub_domain": bti.sub_domain_id,
761 "bt_hdr_len_id": bti.hdr_len_id},
763 'br_n_paths': len(paths),
767 'br_is_replace': is_replace
770 def bier_route_dump(self, bti):
772 self.papi.bier_route_dump,
773 {'br_tbl_id': {"bt_set": bti.set_id,
774 "bt_sub_domain": bti.sub_domain_id,
775 "bt_hdr_len_id": bti.hdr_len_id}})
777 def bier_imp_add(self,
782 """ BIER Imposition Add """
784 self.papi.bier_imp_add,
785 {'bi_tbl_id': {"bt_set": bti.set_id,
786 "bt_sub_domain": bti.sub_domain_id,
787 "bt_hdr_len_id": bti.hdr_len_id},
789 'bi_n_bytes': len(ibytes),
792 def bier_imp_del(self, bi_index):
793 """ BIER Imposition del """
795 self.papi.bier_imp_del,
796 {'bi_index': bi_index})
798 def bier_imp_dump(self):
799 return self.api(self.papi.bier_imp_dump, {})
801 def bier_disp_table_add_del(self,
804 """ BIER Disposition Table add/del """
806 self.papi.bier_disp_table_add_del,
808 'bdt_is_add': is_add})
810 def bier_disp_table_dump(self):
811 return self.api(self.papi.bier_disp_table_dump, {})
813 def bier_disp_entry_add_del(self,
823 """ BIER Route add/del """
825 while (len(lstack) < 16):
828 self.papi.bier_disp_entry_add_del,
831 'bde_payload_proto': payload_proto,
833 'bde_paths': [{'table_id': next_hop_tbl_id,
834 'rpf_id': next_hop_rpf_id,
836 'label_stack': lstack}],
837 'bde_is_add': is_add})
839 def bier_disp_entry_dump(self, bdti):
841 self.papi.bier_disp_entry_dump,
842 {'bde_tbl_id': bdti})
844 def ipsec_spd_add_del(self, spd_id, is_add=1):
845 """ SPD add/del - Wrapper to add or del ipsec SPD
846 Sample CLI : 'ipsec spd add 1'
848 :param spd_id - SPD ID to be created in the vpp . mandatory
849 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
851 :returns: reply from the API
854 self.papi.ipsec_spd_add_del, {
855 'spd_id': spd_id, 'is_add': is_add})
857 def ipsec_spds_dump(self):
858 return self.api(self.papi.ipsec_spds_dump, {})
860 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
861 """ IPSEC interface SPD add/del - \
862 Wrapper to associate/disassociate SPD to interface in VPP
863 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
865 :param spd_id - SPD ID to associate with the interface . mandatory
866 :param sw_if_index - Interface Index which needs to ipsec \
867 association mandatory
868 :param is_add - add(1) or del(0) association with interface \
869 (Default 1 - add) . optional
870 :returns: reply from the API
873 self.papi.ipsec_interface_add_del_spd,
874 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
876 def ipsec_spd_interface_dump(self, spd_index=None):
877 return self.api(self.papi.ipsec_spd_interface_dump,
878 {'spd_index': spd_index if spd_index else 0,
879 'spd_index_valid': 1 if spd_index else 0})
881 def ipsec_spd_entry_add_del(self,
886 remote_address_start,
889 local_port_stop=65535,
891 remote_port_stop=65535,
899 """ IPSEC policy SPD add/del -
900 Wrapper to configure ipsec SPD policy entries in VPP
902 :param spd_id: SPD ID for the policy
903 :param local_address_start: local-ip-range start address
904 :param local_address_stop: local-ip-range stop address
905 :param remote_address_start: remote-ip-range start address
906 :param remote_address_stop: remote-ip-range stop address
907 :param local_port_start: (Default value = 0)
908 :param local_port_stop: (Default value = 65535)
909 :param remote_port_start: (Default value = 0)
910 :param remote_port_stop: (Default value = 65535)
911 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
912 :param sa_id: Security Association ID for mapping it to SPD
913 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
915 :param priority: value for the spd action (Default value = 100)
916 :param is_outbound: flag for inbound(0) or outbound(1)
918 :param is_add: (Default value = 1)
921 self.papi.ipsec_spd_entry_add_del,
928 'local_address_start': local_address_start,
929 'local_address_stop': local_address_stop,
930 'remote_address_start': remote_address_start,
931 'remote_address_stop': remote_address_stop,
932 'local_port_start': local_port_start,
933 'local_port_stop': local_port_stop,
934 'remote_port_start': remote_port_start,
935 'remote_port_stop': remote_port_stop,
936 'protocol': protocol,
938 'priority': priority,
939 'is_outbound': is_outbound,
943 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
944 return self.api(self.papi.ipsec_spd_dump,
948 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
949 remote_spi, crypto_alg, local_crypto_key,
950 remote_crypto_key, integ_alg, local_integ_key,
951 remote_integ_key, is_add=1, esn=0, salt=0,
952 anti_replay=1, renumber=0,
953 udp_encap=0, show_instance=0xffffffff):
955 self.papi.ipsec_tunnel_if_add_del,
957 'local_ip': local_ip,
958 'remote_ip': remote_ip,
959 'local_spi': local_spi,
960 'remote_spi': remote_spi,
961 'crypto_alg': crypto_alg,
962 'local_crypto_key_len': len(local_crypto_key),
963 'local_crypto_key': local_crypto_key,
964 'remote_crypto_key_len': len(remote_crypto_key),
965 'remote_crypto_key': remote_crypto_key,
966 'integ_alg': integ_alg,
967 'local_integ_key_len': len(local_integ_key),
968 'local_integ_key': local_integ_key,
969 'remote_integ_key_len': len(remote_integ_key),
970 'remote_integ_key': remote_integ_key,
973 'anti_replay': anti_replay,
974 'renumber': renumber,
975 'show_instance': show_instance,
976 'udp_encap': udp_encap,
980 def ipsec_select_backend(self, protocol, index):
981 return self.api(self.papi.ipsec_select_backend,
982 {'protocol': protocol, 'index': index})
984 def ipsec_backend_dump(self):
985 return self.api(self.papi.ipsec_backend_dump, {})
987 def punt_socket_register(self, reg, pathname,
989 """ Register punt socket """
990 return self.api(self.papi.punt_socket_register,
991 {'header_version': header_version,
993 'pathname': pathname})
995 def punt_socket_deregister(self, reg):
996 """ Unregister punt socket """
997 return self.api(self.papi.punt_socket_deregister,
1000 def gbp_endpoint_dump(self):
1001 """ GBP endpoint Dump """
1002 return self.api(self.papi.gbp_endpoint_dump, {})
1004 def gbp_recirc_dump(self):
1005 """ GBP recirc Dump """
1006 return self.api(self.papi.gbp_recirc_dump, {})
1008 def gbp_ext_itf_dump(self):
1009 """ GBP recirc Dump """
1010 return self.api(self.papi.gbp_ext_itf_dump, {})
1012 def gbp_subnet_dump(self):
1013 """ GBP Subnet Dump """
1014 return self.api(self.papi.gbp_subnet_dump, {})
1016 def gbp_contract_dump(self):
1017 """ GBP contract Dump """
1018 return self.api(self.papi.gbp_contract_dump, {})
1020 def gbp_vxlan_tunnel_dump(self):
1021 """ GBP VXLAN tunnel add/del """
1022 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1024 def igmp_enable_disable(self, sw_if_index, enable, host):
1025 """ Enable/disable IGMP on a given interface """
1026 return self.api(self.papi.igmp_enable_disable,
1029 'sw_if_index': sw_if_index})
1031 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1032 """ Add/del IGMP proxy device """
1033 return self.api(self.papi.igmp_proxy_device_add_del,
1034 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1037 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1038 """ Add/del interface to/from IGMP proxy device """
1039 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1040 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1043 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1044 """ Listen for new (S,G) on specified interface
1046 :param enable: add/delas
1047 :param sw_if_index: interface sw index
1048 :param saddr: source ip4 addr
1049 :param gaddr: group ip4 addr
1051 return self.api(self.papi.igmp_listen,
1056 'sw_if_index': sw_if_index,
1057 'n_srcs': len(saddrs),
1063 def igmp_clear_interface(self, sw_if_index):
1064 """ Remove all (S,G)s from specified interface
1065 doesn't send IGMP report!
1068 self.papi.igmp_clear_interface, {
1069 'sw_if_index': sw_if_index})
1071 def want_igmp_events(self, enable=1):
1072 return self.api(self.papi.want_igmp_events, {'enable': enable,
1073 'pid': os.getpid()})