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
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 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
40 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
41 'decap_next_index': 4294967295, },
42 'input_acl_set_interface': {'ip4_table_index': 4294967295,
43 'ip6_table_index': 4294967295,
44 'l2_table_index': 4294967295, },
45 'ip6_add_del_address_using_prefix': {'is_add': 1, },
46 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
47 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
48 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
49 'classify_table_index': 4294967295, 'is_add': 1, },
50 'ip_mroute_add_del': {'is_add': 1, },
51 'ip_neighbor_add_del': {'is_add': 1, },
52 'ip_punt_police': {'is_add': 1, },
53 'ip_punt_redirect': {'is_add': 1, },
54 'ip_route_add_del': {'is_add': 1, },
55 'ipsec_interface_add_del_spd': {'is_add': 1, },
56 'ipsec_sad_entry_add_del': {'is_add': 1, },
57 'ipsec_spd_add_del': {'is_add': 1, },
58 'ipsec_spd_dump': {'sa_id': 4294967295, },
59 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
60 'remote_port_stop': 65535, 'priority': 100,
63 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
64 'l2_emulation': {'enable': 1, },
65 'l2fib_add_del': {'is_add': 1, },
66 'lisp_add_del_adjacency': {'is_add': 1, },
67 'lisp_add_del_local_eid': {'is_add': 1, },
68 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
69 'lisp_add_del_locator_set': {'is_add': 1, },
70 'lisp_add_del_remote_mapping': {'is_add': 1, },
71 'macip_acl_interface_add_del': {'is_add': 1, },
72 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
73 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
74 'mr_next_hop_weight': 1,
75 'mr_next_hop_via_label': 1048576,
77 'mr_classify_table_index': 4294967295, },
78 'mpls_table_add_del': {'is_add': 1, },
79 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
81 'next_hop_via_label': 1048576,
83 'output_acl_set_interface': {'ip4_table_index': 4294967295,
84 'ip6_table_index': 4294967295,
85 'l2_table_index': 4294967295, },
86 'pppoe_add_del_session': {'is_add': 1, },
87 'policer_add_del': {'is_add': 1, 'conform_action': {'type': 1}, },
88 'proxy_arp_add_del': {'is_add': 1, },
89 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
90 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
92 'set_ipfix_exporter': {'collector_port': 4739, },
93 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
94 'svs_enable_disable': {'is_enable': 1, },
95 'svs_route_add_del': {'is_add': 1, },
96 'svs_table_add_del': {'is_add': 1, },
97 'sw_interface_add_del_address': {'is_add': 1, },
98 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
99 'pref_lifetime': 4294967295, },
100 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
101 'sw_interface_set_l2_bridge': {'enable': 1, },
102 'sw_interface_set_mpls_enable': {'enable': 1, },
103 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
104 'sw_interface_set_unnumbered': {'is_add': 1, },
105 'sw_interface_span_enable_disable': {'state': 1, },
106 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
107 'decap_next_index': 4294967295,
108 'instance': 4294967295, },
109 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
111 'want_bfd_events': {'enable_disable': 1, },
112 'want_igmp_events': {'enable': 1, },
113 'want_interface_events': {'enable_disable': 1, },
114 'want_l2_macs_events': {'enable_disable': 1, 'pid': os.getpid(), },
118 def as_fn_signature(d):
119 return ", ".join(f"{k}={v}" for k, v in d.items())
122 class CliFailedCommandError(Exception):
123 """ cli command failed."""
126 class CliSyntaxError(Exception):
127 """ cli command had a syntax error."""
130 class UnexpectedApiReturnValueError(Exception):
131 """ exception raised when the API return value is unexpected """
135 class VppPapiProvider(object):
136 """VPP-api provider using vpp-papi
138 @property hook: hook object providing before and after api/cli hooks
141 _zero, _negative = range(2)
143 def __init__(self, name, shm_prefix, test_class, read_timeout):
144 self.hook = Hook(test_class)
146 self.shm_prefix = shm_prefix
147 self.test_class = test_class
148 self._expect_api_retval = self._zero
149 self._expect_stack = []
151 # install_dir is a class attribute. We need to set it before
152 # calling the constructor.
153 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
157 if os.environ['SOCKET'] == '1':
162 self.vpp = VPPApiClient(logger=test_class.logger,
163 read_timeout=read_timeout,
164 use_socket=use_socket,
165 server_address=test_class.api_sock)
166 self._events = deque()
171 def assert_negative_api_retval(self):
172 """ Expect API failure - used with with, e.g.:
173 with self.vapi.assert_negative_api_retval():
174 self.vapi.<api call expected to fail>
176 self._expect_stack.append(self._expect_api_retval)
177 self._expect_api_retval = self._negative
180 def assert_zero_api_retval(self):
181 """ Expect API success - used with with, e.g.:
182 with self.vapi.assert_negative_api_retval():
183 self.vapi.<api call expected to succeed>
185 note: this is useful only inside another with block
186 as success is the default expected value
188 self._expect_stack.append(self._expect_api_retval)
189 self._expect_api_retval = self._zero
192 def __exit__(self, exc_type, exc_value, traceback):
193 self._expect_api_retval = self._expect_stack.pop()
195 def register_hook(self, hook):
196 """Replace hook registration with new hook
203 def collect_events(self):
204 """ Collect all events from the internal queue and clear the queue. """
206 self._events = deque()
209 def wait_for_event(self, timeout, name=None):
210 """ Wait for and return next event. """
212 self.test_class.logger.debug("Expecting event '%s' within %ss",
215 self.test_class.logger.debug("Expecting event within %ss",
218 self.test_class.logger.debug("Not waiting, event already queued")
219 limit = time.time() + timeout
220 while time.time() < limit:
222 e = self._events.popleft()
223 if name and type(e).__name__ != name:
225 "Unexpected event received: %s, expected: %s" %
226 (type(e).__name__, name))
227 self.test_class.logger.debug("Returning event %s:%s" %
230 self.test_class.sleep(0) # yield
231 raise Exception("Event did not occur within timeout")
233 def __call__(self, name, event):
234 """ Enqueue event in the internal event queue. """
235 # FIXME use the name instead of relying on type(e).__name__ ?
236 # FIXME #2 if this throws, it is eaten silently, Ole?
237 self.test_class.logger.debug("New event: %s: %s" % (name, event))
238 self._events.append(event)
240 def factory(self, name, apifn):
242 fields = apifn._func.msg.fields
244 # add positional and kw arguments
246 for i, o in enumerate(fields[3:]):
249 except BaseException:
253 if name in defaultmapping:
254 for k, v in iteritems(defaultmapping[name]):
258 return self.api(apifn, d)
262 def __getattribute__(self, name):
264 method = super(VppPapiProvider, self).__getattribute__(name)
265 except AttributeError:
266 method = self.factory(name, getattr(self.papi, name))
267 # lazily load the method so we don't need to call factory
268 # again for this name.
269 setattr(self, name, method)
273 """Connect the API to VPP"""
274 self.vpp.connect(self.name, self.shm_prefix)
275 self.papi = self.vpp.api
276 self.vpp.register_event_callback(self)
278 def disconnect(self):
279 """Disconnect the API from VPP"""
280 self.vpp.disconnect()
282 def api(self, api_fn, api_args, expected_retval=0):
283 """ Call API function and check it's return value.
284 Call the appropriate hooks before and after the API call
286 :param api_fn: API function to call
287 :param api_args: tuple of API function arguments
288 :param expected_retval: Expected return value (Default value = 0)
289 :returns: reply from the API
292 self.hook.before_api(api_fn.__name__, api_args)
293 reply = api_fn(**api_args)
294 if self._expect_api_retval == self._negative:
295 if hasattr(reply, 'retval') and reply.retval >= 0:
296 msg = "%s(%s) passed unexpectedly: expected negative " \
297 "return value instead of %d in %s" % \
298 (api_fn.__name__, as_fn_signature(api_args),
300 moves.reprlib.repr(reply))
301 self.test_class.logger.info(msg)
302 raise UnexpectedApiReturnValueError(msg)
303 elif self._expect_api_retval == self._zero:
304 if hasattr(reply, 'retval') and reply.retval != expected_retval:
305 msg = "%s(%s) failed, expected %d return value instead " \
306 "of %d in %s" % (api_fn.__name__,
307 as_fn_signature(api_args),
308 expected_retval, reply.retval,
310 self.test_class.logger.info(msg)
311 raise UnexpectedApiReturnValueError(msg)
313 raise Exception("Internal error, unexpected value for "
314 "self._expect_api_retval %s" %
315 self._expect_api_retval)
316 self.hook.after_api(api_fn.__name__, api_args)
319 def cli_return_response(self, cli):
320 """ Execute a CLI, calling the before/after hooks appropriately.
321 Return the reply without examining it
323 :param cli: CLI to execute
324 :returns: response object
327 self.hook.before_cli(cli)
329 r = self.papi.cli_inband(cmd=cli)
330 self.hook.after_cli(cli)
334 """ Execute a CLI, calling the before/after hooks appropriately.
336 :param cli: CLI to execute
340 r = self.cli_return_response(cli)
342 raise CliSyntaxError(r.reply)
344 raise CliFailedCommandError(r.reply)
345 if hasattr(r, 'reply'):
348 def ppcli(self, cli):
349 """ Helper method to print CLI command in case of info logging level.
351 :param cli: CLI to execute
354 return cli + "\n" + self.cli(cli)
356 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
358 return self.api(self.papi.ip6nd_send_router_solicitation,
363 'sw_if_index': sw_if_index})
365 def want_interface_events(self, enable_disable=1):
366 return self.api(self.papi.want_interface_events,
367 {'enable_disable': enable_disable,
368 'pid': os.getpid(), })
370 def sw_interface_set_mac_address(self, sw_if_index, mac):
371 return self.api(self.papi.sw_interface_set_mac_address,
372 {'sw_if_index': sw_if_index,
375 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
376 """Create p2p ethernet subinterface
378 :param sw_if_index: main (parent) interface
379 :param remote_mac: client (remote) mac address
383 self.papi.p2p_ethernet_add,
384 {'parent_if_index': sw_if_index,
385 'remote_mac': remote_mac,
386 'subif_id': subif_id})
388 def p2p_ethernet_del(self, sw_if_index, remote_mac):
389 """Delete p2p ethernet subinterface
391 :param sw_if_index: main (parent) interface
392 :param remote_mac: client (remote) mac address
396 self.papi.p2p_ethernet_del,
397 {'parent_if_index': sw_if_index,
398 'remote_mac': remote_mac})
400 def create_vlan_subif(self, sw_if_index, vlan):
407 return self.api(self.papi.create_vlan_subif,
408 {'sw_if_index': sw_if_index,
411 def create_loopback(self, mac=''):
414 :param mac: (Optional)
416 return self.api(self.papi.create_loopback,
417 {'mac_address': mac})
419 def ip_route_dump(self, table_id, is_ip6=False):
420 return self.api(self.papi.ip_route_dump,
422 'table_id': table_id,
426 def ip_neighbor_add_del(self,
432 """ Add neighbor MAC to IPv4 or IPv6 address.
437 :param is_add: (Default value = 1)
438 :param flags: (Default value = 0/NONE)
441 self.papi.ip_neighbor_add_del,
445 'sw_if_index': sw_if_index,
447 'mac_address': mac_address,
448 'ip_address': ip_address
453 def proxy_arp_add_del(self,
458 """ Config Proxy Arp Range.
460 :param low_address: Start address in the rnage to Proxy for
461 :param hi_address: End address in the rnage to Proxy for
462 :param vrf_id: The VRF/table in which to proxy
466 self.papi.proxy_arp_add_del,
469 'table_id': table_id,
475 def proxy_arp_intfc_enable_disable(self,
478 """ Enable/Disable an interface for proxy ARP requests
480 :param sw_if_index: Interface
481 :param enable_disable: Enable/Disable
485 self.papi.proxy_arp_intfc_enable_disable,
486 {'sw_if_index': sw_if_index,
491 def udp_encap_add(self,
502 :param outer_fib_id: (Default value = 0)
506 self.papi.udp_encap_add,
511 'src_port': src_port,
512 'dst_port': dst_port,
517 def udp_encap_del(self, id):
518 return self.api(self.papi.udp_encap_del, {'id': id})
520 def udp_encap_dump(self):
521 return self.api(self.papi.udp_encap_dump, {})
523 def want_udp_encap_stats(self, enable=1):
524 return self.api(self.papi.want_udp_encap_stats,
528 def mpls_route_dump(self, table_id):
529 return self.api(self.papi.mpls_route_dump,
531 'mt_table_id': table_id
534 def mpls_table_dump(self):
535 return self.api(self.papi.mpls_table_dump, {})
537 def mpls_table_add_del(
544 :param is_add: (Default value = 1)
549 self.papi.mpls_table_add_del,
552 'mt_table_id': table_id,
554 'mt_is_add': is_add})
556 def mpls_route_add_del(self,
565 """ MPLS Route add/del """
567 self.papi.mpls_route_add_del,
570 'mr_table_id': table_id,
573 'mr_eos_proto': eos_proto,
574 'mr_is_multicast': is_multicast,
575 'mr_n_paths': len(paths),
579 'mr_is_multipath': is_multipath})
581 def mpls_ip_bind_unbind(
591 self.papi.mpls_ip_bind_unbind,
592 {'mb_mpls_table_id': table_id,
594 'mb_ip_table_id': ip_table_id,
595 'mb_is_bind': is_bind,
596 'mb_prefix': prefix})
598 def mpls_tunnel_add_del(
608 self.papi.mpls_tunnel_add_del,
609 {'mt_is_add': is_add,
612 'mt_sw_if_index': tun_sw_if_index,
613 'mt_l2_only': l2_only,
614 'mt_is_multicast': is_multicast,
615 'mt_n_paths': len(paths),
619 def input_acl_set_interface(
623 ip4_table_index=0xFFFFFFFF,
624 ip6_table_index=0xFFFFFFFF,
625 l2_table_index=0xFFFFFFFF):
629 :param ip4_table_index: (Default value = 0xFFFFFFFF)
630 :param ip6_table_index: (Default value = 0xFFFFFFFF)
631 :param l2_table_index: (Default value = 0xFFFFFFFF)
635 self.papi.input_acl_set_interface,
636 {'sw_if_index': sw_if_index,
637 'ip4_table_index': ip4_table_index,
638 'ip6_table_index': ip6_table_index,
639 'l2_table_index': l2_table_index,
642 def output_acl_set_interface(
646 ip4_table_index=0xFFFFFFFF,
647 ip6_table_index=0xFFFFFFFF,
648 l2_table_index=0xFFFFFFFF):
652 :param ip4_table_index: (Default value = 0xFFFFFFFF)
653 :param ip6_table_index: (Default value = 0xFFFFFFFF)
654 :param l2_table_index: (Default value = 0xFFFFFFFF)
658 self.papi.output_acl_set_interface,
659 {'sw_if_index': sw_if_index,
660 'ip4_table_index': ip4_table_index,
661 'ip6_table_index': ip6_table_index,
662 'l2_table_index': l2_table_index,
665 def set_ipfix_exporter(
675 self.papi.set_ipfix_exporter,
677 'collector_address': collector_address,
678 'collector_port': collector_port,
679 'src_address': src_address,
681 'path_mtu': path_mtu,
682 'template_interval': template_interval,
683 'udp_checksum': udp_checksum,
686 def mfib_signal_dump(self):
687 return self.api(self.papi.mfib_signal_dump, {})
689 def ip_mroute_dump(self, table_id, is_ip6=False):
690 return self.api(self.papi.ip_mroute_dump,
692 'table_id': table_id,
696 def vxlan_gpe_add_del_tunnel(
700 mcast_sw_if_index=0xFFFFFFFF,
711 :param is_add: (Default value = 1)
712 :param is_ipv6: (Default value = 0)
713 :param encap_vrf_id: (Default value = 0)
714 :param decap_vrf_id: (Default value = 0)
715 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
716 :param protocol: (Default value = 3)
717 :param vni: (Default value = 0)
720 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
725 'mcast_sw_if_index': mcast_sw_if_index,
726 'encap_vrf_id': encap_vrf_id,
727 'decap_vrf_id': decap_vrf_id,
728 'protocol': protocol,
731 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
732 return self.api(self.papi.vxlan_gbp_tunnel_dump,
733 {'sw_if_index': sw_if_index})
735 def pppoe_add_del_session(
744 :param is_add: (Default value = 1)
745 :param is_ipv6: (Default value = 0)
747 :param session_id: (Default value = 0)
749 :param decap_vrf_id: (Default value = 0)
752 return self.api(self.papi.pppoe_add_del_session,
754 'session_id': session_id,
755 'client_ip': client_ip,
756 'decap_vrf_id': decap_vrf_id,
757 'client_mac': client_mac})
759 def sr_mpls_policy_add(self, bsid, weight, type, segments):
760 return self.api(self.papi.sr_mpls_policy_add,
764 'n_segments': len(segments),
765 'segments': segments})
767 def sr_mpls_policy_del(self, bsid):
768 return self.api(self.papi.sr_mpls_policy_del,
771 def ip_punt_police(self,
775 return self.api(self.papi.ip_punt_police,
776 {'policer_index': policer_index,
780 def ip_punt_redirect(self,
785 return self.api(self.papi.ip_punt_redirect,
786 {'punt': {'rx_sw_if_index': rx_sw_if_index,
787 'tx_sw_if_index': tx_sw_if_index,
791 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
792 return self.api(self.papi.ip_punt_redirect_dump,
793 {'sw_if_index': sw_if_index,
796 def bier_table_add_del(self,
800 """ BIER Table add/del """
802 self.papi.bier_table_add_del,
803 {'bt_tbl_id': {"bt_set": bti.set_id,
804 "bt_sub_domain": bti.sub_domain_id,
805 "bt_hdr_len_id": bti.hdr_len_id},
806 'bt_label': mpls_label,
807 'bt_is_add': is_add})
809 def bier_table_dump(self):
810 return self.api(self.papi.bier_table_dump, {})
812 def bier_route_add_del(self,
818 """ BIER Route add/del """
820 self.papi.bier_route_add_del,
823 'br_tbl_id': {"bt_set": bti.set_id,
824 "bt_sub_domain": bti.sub_domain_id,
825 "bt_hdr_len_id": bti.hdr_len_id},
827 'br_n_paths': len(paths),
831 'br_is_replace': is_replace
834 def bier_route_dump(self, bti):
836 self.papi.bier_route_dump,
837 {'br_tbl_id': {"bt_set": bti.set_id,
838 "bt_sub_domain": bti.sub_domain_id,
839 "bt_hdr_len_id": bti.hdr_len_id}})
841 def bier_imp_add(self,
846 """ BIER Imposition Add """
848 self.papi.bier_imp_add,
849 {'bi_tbl_id': {"bt_set": bti.set_id,
850 "bt_sub_domain": bti.sub_domain_id,
851 "bt_hdr_len_id": bti.hdr_len_id},
853 'bi_n_bytes': len(ibytes),
856 def bier_imp_del(self, bi_index):
857 """ BIER Imposition del """
859 self.papi.bier_imp_del,
860 {'bi_index': bi_index})
862 def bier_imp_dump(self):
863 return self.api(self.papi.bier_imp_dump, {})
865 def bier_disp_table_add_del(self,
868 """ BIER Disposition Table add/del """
870 self.papi.bier_disp_table_add_del,
872 'bdt_is_add': is_add})
874 def bier_disp_table_dump(self):
875 return self.api(self.papi.bier_disp_table_dump, {})
877 def bier_disp_entry_add_del(self,
887 """ BIER Route add/del """
889 while (len(lstack) < 16):
892 self.papi.bier_disp_entry_add_del,
895 'bde_payload_proto': payload_proto,
897 'bde_paths': [{'table_id': next_hop_tbl_id,
898 'rpf_id': next_hop_rpf_id,
900 'label_stack': lstack}],
901 'bde_is_add': is_add})
903 def bier_disp_entry_dump(self, bdti):
905 self.papi.bier_disp_entry_dump,
906 {'bde_tbl_id': bdti})
908 def session_enable_disable(self, is_enabled):
910 self.papi.session_enable_disable,
911 {'is_enable': is_enabled})
913 def ipsec_spd_add_del(self, spd_id, is_add=1):
914 """ SPD add/del - Wrapper to add or del ipsec SPD
915 Sample CLI : 'ipsec spd add 1'
917 :param spd_id - SPD ID to be created in the vpp . mandatory
918 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
920 :returns: reply from the API
923 self.papi.ipsec_spd_add_del, {
924 'spd_id': spd_id, 'is_add': is_add})
926 def ipsec_spds_dump(self):
927 return self.api(self.papi.ipsec_spds_dump, {})
929 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
930 """ IPSEC interface SPD add/del - \
931 Wrapper to associate/disassociate SPD to interface in VPP
932 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
934 :param spd_id - SPD ID to associate with the interface . mandatory
935 :param sw_if_index - Interface Index which needs to ipsec \
936 association mandatory
937 :param is_add - add(1) or del(0) association with interface \
938 (Default 1 - add) . optional
939 :returns: reply from the API
942 self.papi.ipsec_interface_add_del_spd,
943 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
945 def ipsec_spd_interface_dump(self, spd_index=None):
946 return self.api(self.papi.ipsec_spd_interface_dump,
947 {'spd_index': spd_index if spd_index else 0,
948 'spd_index_valid': 1 if spd_index else 0})
950 def ipsec_sad_entry_add_del(self,
958 tunnel_src_address='',
959 tunnel_dst_address='',
964 :param sad_id: security association ID
965 :param spi: security param index of the SA in decimal
966 :param integrity_algorithm:
967 :param integrity_key:
968 :param crypto_algorithm:
970 :param protocol: AH(0) or ESP(1) protocol
971 :param tunnel_src_address: tunnel mode outer src address
972 :param tunnel_dst_address: tunnel mode outer dst address
975 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
976 crypto and ipsec algorithms
979 self.papi.ipsec_sad_entry_add_del,
986 'tunnel_src': tunnel_src_address,
987 'tunnel_dst': tunnel_dst_address,
988 'protocol': protocol,
989 'integrity_algorithm': integrity_algorithm,
991 'length': len(integrity_key),
992 'data': integrity_key,
994 'crypto_algorithm': crypto_algorithm,
996 'length': len(crypto_key),
1004 def ipsec_sa_dump(self, sa_id=None):
1005 return self.api(self.papi.ipsec_sa_dump,
1006 {'sa_id': sa_id if sa_id else 0xffffffff})
1008 def ipsec_spd_entry_add_del(self,
1011 local_address_start,
1013 remote_address_start,
1014 remote_address_stop,
1016 local_port_stop=65535,
1017 remote_port_start=0,
1018 remote_port_stop=65535,
1026 """ IPSEC policy SPD add/del -
1027 Wrapper to configure ipsec SPD policy entries in VPP
1028 :param spd_id: SPD ID for the policy
1029 :param local_address_start: local-ip-range start address
1030 :param local_address_stop : local-ip-range stop address
1031 :param remote_address_start: remote-ip-range start address
1032 :param remote_address_stop : remote-ip-range stop address
1033 :param local_port_start: (Default value = 0)
1034 :param local_port_stop: (Default value = 65535)
1035 :param remote_port_start: (Default value = 0)
1036 :param remote_port_stop: (Default value = 65535)
1037 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1038 :param sa_id: Security Association ID for mapping it to SPD
1039 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1041 :param priority: value for the spd action (Default value = 100)
1042 :param is_outbound: flag for inbound(0) or outbound(1)
1044 :param is_add: (Default value = 1)
1047 self.papi.ipsec_spd_entry_add_del,
1054 'local_address_start': local_address_start,
1055 'local_address_stop': local_address_stop,
1056 'remote_address_start': remote_address_start,
1057 'remote_address_stop': remote_address_stop,
1058 'local_port_start': local_port_start,
1059 'local_port_stop': local_port_stop,
1060 'remote_port_start': remote_port_start,
1061 'remote_port_stop': remote_port_stop,
1062 'protocol': protocol,
1064 'priority': priority,
1065 'is_outbound': is_outbound,
1069 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1070 return self.api(self.papi.ipsec_spd_dump,
1074 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1075 remote_spi, crypto_alg, local_crypto_key,
1076 remote_crypto_key, integ_alg, local_integ_key,
1077 remote_integ_key, is_add=1, esn=0, salt=0,
1078 anti_replay=1, renumber=0,
1079 udp_encap=0, show_instance=0xffffffff):
1081 self.papi.ipsec_tunnel_if_add_del,
1083 'local_ip': local_ip,
1084 'remote_ip': remote_ip,
1085 'local_spi': local_spi,
1086 'remote_spi': remote_spi,
1087 'crypto_alg': crypto_alg,
1088 'local_crypto_key_len': len(local_crypto_key),
1089 'local_crypto_key': local_crypto_key,
1090 'remote_crypto_key_len': len(remote_crypto_key),
1091 'remote_crypto_key': remote_crypto_key,
1092 'integ_alg': integ_alg,
1093 'local_integ_key_len': len(local_integ_key),
1094 'local_integ_key': local_integ_key,
1095 'remote_integ_key_len': len(remote_integ_key),
1096 'remote_integ_key': remote_integ_key,
1099 'anti_replay': anti_replay,
1100 'renumber': renumber,
1101 'show_instance': show_instance,
1102 'udp_encap': udp_encap,
1106 def ipsec_select_backend(self, protocol, index):
1107 return self.api(self.papi.ipsec_select_backend,
1108 {'protocol': protocol, 'index': index})
1110 def ipsec_backend_dump(self):
1111 return self.api(self.papi.ipsec_backend_dump, {})
1113 def app_namespace_add_del(self,
1117 sw_if_index=0xFFFFFFFF,
1120 self.papi.app_namespace_add_del,
1122 'sw_if_index': sw_if_index,
1123 'ip4_fib_id': ip4_fib_id,
1124 'ip6_fib_id': ip6_fib_id,
1125 'namespace_id': namespace_id})
1127 def punt_socket_register(self, reg, pathname,
1129 """ Register punt socket """
1130 return self.api(self.papi.punt_socket_register,
1131 {'header_version': header_version,
1133 'pathname': pathname})
1135 def punt_socket_deregister(self, reg):
1136 """ Unregister punt socket """
1137 return self.api(self.papi.punt_socket_deregister,
1140 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1142 """ GBP endpoint Add """
1143 return self.api(self.papi.gbp_endpoint_add,
1145 'sw_if_index': sw_if_index,
1156 def gbp_endpoint_del(self, handle):
1157 """ GBP endpoint Del """
1158 return self.api(self.papi.gbp_endpoint_del,
1161 def gbp_endpoint_dump(self):
1162 """ GBP endpoint Dump """
1163 return self.api(self.papi.gbp_endpoint_dump, {})
1165 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1166 rd, uplink_sw_if_index,
1168 """ GBP endpoint group Add """
1169 return self.api(self.papi.gbp_endpoint_group_add,
1172 'uplink_sw_if_index': uplink_sw_if_index,
1177 'retention': retention
1180 def gbp_endpoint_group_del(self, sclass):
1181 """ GBP endpoint group Del """
1182 return self.api(self.papi.gbp_endpoint_group_del,
1185 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1188 bm_flood_sw_if_index):
1189 """ GBP bridge-domain Add """
1190 return self.api(self.papi.gbp_bridge_domain_add,
1194 'bvi_sw_if_index': bvi_sw_if_index,
1195 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1196 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1201 def gbp_bridge_domain_del(self, bd_id):
1202 """ GBP bridge-domain Del """
1203 return self.api(self.papi.gbp_bridge_domain_del,
1206 def gbp_route_domain_add(self, rd_id,
1211 ip6_uu_sw_if_index):
1212 """ GBP route-domain Add """
1213 return self.api(self.papi.gbp_route_domain_add,
1217 'ip4_table_id': ip4_table_id,
1218 'ip6_table_id': ip6_table_id,
1219 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1220 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1224 def gbp_route_domain_del(self, rd_id):
1225 """ GBP route-domain Del """
1226 return self.api(self.papi.gbp_route_domain_del,
1229 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1230 """ GBP recirc Add/Del """
1231 return self.api(self.papi.gbp_recirc_add_del,
1235 'sw_if_index': sw_if_index,
1238 def gbp_recirc_dump(self):
1239 """ GBP recirc Dump """
1240 return self.api(self.papi.gbp_recirc_dump, {})
1242 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1243 """ GBP recirc Add/Del """
1244 return self.api(self.papi.gbp_ext_itf_add_del,
1247 'sw_if_index': sw_if_index,
1252 def gbp_ext_itf_dump(self):
1253 """ GBP recirc Dump """
1254 return self.api(self.papi.gbp_ext_itf_dump, {})
1256 def gbp_subnet_add_del(self, is_add, rd_id,
1258 sw_if_index=0xffffffff,
1260 """ GBP Subnet Add/Del """
1261 return self.api(self.papi.gbp_subnet_add_del,
1265 'sw_if_index': sw_if_index,
1270 def gbp_subnet_dump(self):
1271 """ GBP Subnet Dump """
1272 return self.api(self.papi.gbp_subnet_dump, {})
1274 def gbp_contract_dump(self):
1275 """ GBP contract Dump """
1276 return self.api(self.papi.gbp_contract_dump, {})
1278 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1279 """ GBP VXLAN tunnel add """
1280 return self.api(self.papi.gbp_vxlan_tunnel_add,
1285 'bd_rd_id': bd_rd_id,
1290 def gbp_vxlan_tunnel_del(self, vni):
1291 """ GBP VXLAN tunnel del """
1292 return self.api(self.papi.gbp_vxlan_tunnel_del,
1297 def gbp_vxlan_tunnel_dump(self):
1298 """ GBP VXLAN tunnel add/del """
1299 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1301 def igmp_enable_disable(self, sw_if_index, enable, host):
1302 """ Enable/disable IGMP on a given interface """
1303 return self.api(self.papi.igmp_enable_disable,
1306 'sw_if_index': sw_if_index})
1308 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1309 """ Add/del IGMP proxy device """
1310 return self.api(self.papi.igmp_proxy_device_add_del,
1311 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1314 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1315 """ Add/del interface to/from IGMP proxy device """
1316 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1317 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1320 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1321 """ Listen for new (S,G) on specified interface
1323 :param enable: add/del
1324 :param sw_if_index: interface sw index
1325 :param saddr: source ip4 addr
1326 :param gaddr: group ip4 addr
1328 return self.api(self.papi.igmp_listen,
1333 'sw_if_index': sw_if_index,
1334 'n_srcs': len(saddrs),
1340 def igmp_clear_interface(self, sw_if_index):
1341 """ Remove all (S,G)s from specified interface
1342 doesn't send IGMP report!
1345 self.papi.igmp_clear_interface, {
1346 'sw_if_index': sw_if_index})
1348 def want_igmp_events(self, enable=1):
1349 return self.api(self.papi.want_igmp_events, {'enable': enable,
1350 'pid': os.getpid()})
1359 interface_id=0xFFFFFFFF):
1362 :param lb: load balance
1363 :param numa_only: tx on local numa node for lacp mode
1364 :param use_custom_mac: use custom mac
1365 :param mac_address: mac address
1366 :param interface_id: custom interface ID
1369 self.papi.bond_create,
1372 'numa_only': numa_only,
1373 'use_custom_mac': use_custom_mac,
1374 'mac_address': mac_address,
1378 def pipe_delete(self, parent_sw_if_index):
1379 return self.api(self.papi.pipe_delete,
1380 {'parent_sw_if_index': parent_sw_if_index})
1382 def svs_table_add_del(self, af, table_id, is_add=1):
1383 return self.api(self.papi.svs_table_add_del,
1385 'table_id': table_id,
1390 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
1391 return self.api(self.papi.svs_route_add_del,
1393 'table_id': table_id,
1394 'source_table_id': src_table_id,
1399 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
1400 return self.api(self.papi.svs_enable_disable,
1403 'table_id': table_id,
1404 'sw_if_index': sw_if_index,
1405 'is_enable': is_enable,
1408 def feature_gso_enable_disable(self, sw_if_index, enable_disable=1):
1409 return self.api(self.papi.feature_gso_enable_disable,
1411 'sw_if_index': sw_if_index,
1412 'enable_disable': enable_disable,