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_spd_add_del': {'is_add': 1, },
57 'ipsec_spd_dump': {'sa_id': 4294967295, },
58 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
59 'remote_port_stop': 65535, 'priority': 100,
62 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
63 'l2_emulation': {'enable': 1, },
64 'l2fib_add_del': {'is_add': 1, },
65 'lisp_add_del_adjacency': {'is_add': 1, },
66 'lisp_add_del_local_eid': {'is_add': 1, },
67 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
68 'lisp_add_del_locator_set': {'is_add': 1, },
69 'lisp_add_del_remote_mapping': {'is_add': 1, },
70 'macip_acl_interface_add_del': {'is_add': 1, },
71 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
72 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
73 'mr_next_hop_weight': 1,
74 'mr_next_hop_via_label': 1048576,
76 'mr_classify_table_index': 4294967295, },
77 'mpls_table_add_del': {'is_add': 1, },
78 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
80 'next_hop_via_label': 1048576,
82 'output_acl_set_interface': {'ip4_table_index': 4294967295,
83 'ip6_table_index': 4294967295,
84 'l2_table_index': 4294967295, },
85 'pppoe_add_del_session': {'is_add': 1, },
86 'policer_add_del': {'is_add': 1, 'conform_action': {'type': 1}, },
87 'proxy_arp_add_del': {'is_add': 1, },
88 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
89 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
91 'set_ipfix_exporter': {'collector_port': 4739, },
92 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
93 'svs_enable_disable': {'is_enable': 1, },
94 'svs_route_add_del': {'is_add': 1, },
95 'svs_table_add_del': {'is_add': 1, },
96 'sw_interface_add_del_address': {'is_add': 1, },
97 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
98 'pref_lifetime': 4294967295, },
99 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
100 'sw_interface_set_l2_bridge': {'enable': 1, },
101 'sw_interface_set_mpls_enable': {'enable': 1, },
102 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
103 'sw_interface_set_unnumbered': {'is_add': 1, },
104 'sw_interface_span_enable_disable': {'state': 1, },
105 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
106 'decap_next_index': 4294967295,
107 'instance': 4294967295, },
108 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
110 'want_bfd_events': {'enable_disable': 1, },
111 'want_igmp_events': {'enable': 1, },
112 'want_interface_events': {'enable_disable': 1, },
113 'want_l2_macs_events': {'enable_disable': 1, 'pid': os.getpid(), },
117 def as_fn_signature(d):
118 return ", ".join(f"{k}={v}" for k, v in d.items())
121 class CliFailedCommandError(Exception):
122 """ cli command failed."""
125 class CliSyntaxError(Exception):
126 """ cli command had a syntax error."""
129 class UnexpectedApiReturnValueError(Exception):
130 """ exception raised when the API return value is unexpected """
134 class VppPapiProvider(object):
135 """VPP-api provider using vpp-papi
137 @property hook: hook object providing before and after api/cli hooks
140 _zero, _negative = range(2)
142 def __init__(self, name, shm_prefix, test_class, read_timeout):
143 self.hook = Hook(test_class)
145 self.shm_prefix = shm_prefix
146 self.test_class = test_class
147 self._expect_api_retval = self._zero
148 self._expect_stack = []
150 # install_dir is a class attribute. We need to set it before
151 # calling the constructor.
152 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
156 if os.environ['SOCKET'] == '1':
161 self.vpp = VPPApiClient(logger=test_class.logger,
162 read_timeout=read_timeout,
163 use_socket=use_socket,
164 server_address=test_class.api_sock)
165 self._events = deque()
170 def assert_negative_api_retval(self):
171 """ Expect API failure - used with with, e.g.:
172 with self.vapi.assert_negative_api_retval():
173 self.vapi.<api call expected to fail>
175 self._expect_stack.append(self._expect_api_retval)
176 self._expect_api_retval = self._negative
179 def assert_zero_api_retval(self):
180 """ Expect API success - used with with, e.g.:
181 with self.vapi.assert_negative_api_retval():
182 self.vapi.<api call expected to succeed>
184 note: this is useful only inside another with block
185 as success is the default expected value
187 self._expect_stack.append(self._expect_api_retval)
188 self._expect_api_retval = self._zero
191 def __exit__(self, exc_type, exc_value, traceback):
192 self._expect_api_retval = self._expect_stack.pop()
194 def register_hook(self, hook):
195 """Replace hook registration with new hook
202 def collect_events(self):
203 """ Collect all events from the internal queue and clear the queue. """
205 self._events = deque()
208 def wait_for_event(self, timeout, name=None):
209 """ Wait for and return next event. """
211 self.test_class.logger.debug("Expecting event '%s' within %ss",
214 self.test_class.logger.debug("Expecting event within %ss",
217 self.test_class.logger.debug("Not waiting, event already queued")
218 limit = time.time() + timeout
219 while time.time() < limit:
221 e = self._events.popleft()
222 if name and type(e).__name__ != name:
224 "Unexpected event received: %s, expected: %s" %
225 (type(e).__name__, name))
226 self.test_class.logger.debug("Returning event %s:%s" %
229 self.test_class.sleep(0) # yield
230 raise Exception("Event did not occur within timeout")
232 def __call__(self, name, event):
233 """ Enqueue event in the internal event queue. """
234 # FIXME use the name instead of relying on type(e).__name__ ?
235 # FIXME #2 if this throws, it is eaten silently, Ole?
236 self.test_class.logger.debug("New event: %s: %s" % (name, event))
237 self._events.append(event)
239 def factory(self, name, apifn):
241 fields = apifn._func.msg.fields
243 # add positional and kw arguments
245 for i, o in enumerate(fields[3:]):
248 except BaseException:
252 if name in defaultmapping:
253 for k, v in iteritems(defaultmapping[name]):
257 return self.api(apifn, d)
261 def __getattribute__(self, name):
263 method = super(VppPapiProvider, self).__getattribute__(name)
264 except AttributeError:
265 method = self.factory(name, getattr(self.papi, name))
266 # lazily load the method so we don't need to call factory
267 # again for this name.
268 setattr(self, name, method)
272 """Connect the API to VPP"""
273 self.vpp.connect(self.name, self.shm_prefix)
274 self.papi = self.vpp.api
275 self.vpp.register_event_callback(self)
277 def disconnect(self):
278 """Disconnect the API from VPP"""
279 self.vpp.disconnect()
281 def api(self, api_fn, api_args, expected_retval=0):
282 """ Call API function and check it's return value.
283 Call the appropriate hooks before and after the API call
285 :param api_fn: API function to call
286 :param api_args: tuple of API function arguments
287 :param expected_retval: Expected return value (Default value = 0)
288 :returns: reply from the API
291 self.hook.before_api(api_fn.__name__, api_args)
292 reply = api_fn(**api_args)
293 if self._expect_api_retval == self._negative:
294 if hasattr(reply, 'retval') and reply.retval >= 0:
295 msg = "%s(%s) passed unexpectedly: expected negative " \
296 "return value instead of %d in %s" % \
297 (api_fn.__name__, as_fn_signature(api_args),
299 moves.reprlib.repr(reply))
300 self.test_class.logger.info(msg)
301 raise UnexpectedApiReturnValueError(msg)
302 elif self._expect_api_retval == self._zero:
303 if hasattr(reply, 'retval') and reply.retval != expected_retval:
304 msg = "%s(%s) failed, expected %d return value instead " \
305 "of %d in %s" % (api_fn.__name__,
306 as_fn_signature(api_args),
307 expected_retval, reply.retval,
309 self.test_class.logger.info(msg)
310 raise UnexpectedApiReturnValueError(msg)
312 raise Exception("Internal error, unexpected value for "
313 "self._expect_api_retval %s" %
314 self._expect_api_retval)
315 self.hook.after_api(api_fn.__name__, api_args)
318 def cli_return_response(self, cli):
319 """ Execute a CLI, calling the before/after hooks appropriately.
320 Return the reply without examining it
322 :param cli: CLI to execute
323 :returns: response object
326 self.hook.before_cli(cli)
328 r = self.papi.cli_inband(cmd=cli)
329 self.hook.after_cli(cli)
333 """ Execute a CLI, calling the before/after hooks appropriately.
335 :param cli: CLI to execute
339 r = self.cli_return_response(cli)
341 raise CliSyntaxError(r.reply)
343 raise CliFailedCommandError(r.reply)
344 if hasattr(r, 'reply'):
347 def ppcli(self, cli):
348 """ Helper method to print CLI command in case of info logging level.
350 :param cli: CLI to execute
353 return cli + "\n" + self.cli(cli)
355 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
357 return self.api(self.papi.ip6nd_send_router_solicitation,
362 'sw_if_index': sw_if_index})
364 def want_interface_events(self, enable_disable=1):
365 return self.api(self.papi.want_interface_events,
366 {'enable_disable': enable_disable,
367 'pid': os.getpid(), })
369 def sw_interface_set_mac_address(self, sw_if_index, mac):
370 return self.api(self.papi.sw_interface_set_mac_address,
371 {'sw_if_index': sw_if_index,
374 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
375 """Create p2p ethernet subinterface
377 :param sw_if_index: main (parent) interface
378 :param remote_mac: client (remote) mac address
382 self.papi.p2p_ethernet_add,
383 {'parent_if_index': sw_if_index,
384 'remote_mac': remote_mac,
385 'subif_id': subif_id})
387 def p2p_ethernet_del(self, sw_if_index, remote_mac):
388 """Delete p2p ethernet subinterface
390 :param sw_if_index: main (parent) interface
391 :param remote_mac: client (remote) mac address
395 self.papi.p2p_ethernet_del,
396 {'parent_if_index': sw_if_index,
397 'remote_mac': remote_mac})
399 def create_vlan_subif(self, sw_if_index, vlan):
406 return self.api(self.papi.create_vlan_subif,
407 {'sw_if_index': sw_if_index,
410 def create_loopback(self, mac=''):
413 :param mac: (Optional)
415 return self.api(self.papi.create_loopback,
416 {'mac_address': mac})
418 def ip_route_dump(self, table_id, is_ip6=False):
419 return self.api(self.papi.ip_route_dump,
421 '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 proxy_arp_add_del(self,
457 """ Config Proxy Arp Range.
459 :param low_address: Start address in the rnage to Proxy for
460 :param hi_address: End address in the rnage to Proxy for
461 :param vrf_id: The VRF/table in which to proxy
465 self.papi.proxy_arp_add_del,
468 'table_id': table_id,
474 def proxy_arp_intfc_enable_disable(self,
477 """ Enable/Disable an interface for proxy ARP requests
479 :param sw_if_index: Interface
480 :param enable_disable: Enable/Disable
484 self.papi.proxy_arp_intfc_enable_disable,
485 {'sw_if_index': sw_if_index,
490 def udp_encap_add(self,
501 :param outer_fib_id: (Default value = 0)
505 self.papi.udp_encap_add,
510 'src_port': src_port,
511 'dst_port': dst_port,
516 def udp_encap_del(self, id):
517 return self.api(self.papi.udp_encap_del, {'id': id})
519 def udp_encap_dump(self):
520 return self.api(self.papi.udp_encap_dump, {})
522 def want_udp_encap_stats(self, enable=1):
523 return self.api(self.papi.want_udp_encap_stats,
527 def mpls_route_dump(self, table_id):
528 return self.api(self.papi.mpls_route_dump,
530 'mt_table_id': table_id
533 def mpls_table_dump(self):
534 return self.api(self.papi.mpls_table_dump, {})
536 def mpls_table_add_del(
543 :param is_add: (Default value = 1)
548 self.papi.mpls_table_add_del,
551 'mt_table_id': table_id,
553 'mt_is_add': is_add})
555 def mpls_route_add_del(self,
564 """ MPLS Route add/del """
566 self.papi.mpls_route_add_del,
569 'mr_table_id': table_id,
572 'mr_eos_proto': eos_proto,
573 'mr_is_multicast': is_multicast,
574 'mr_n_paths': len(paths),
578 'mr_is_multipath': is_multipath})
580 def mpls_ip_bind_unbind(
590 self.papi.mpls_ip_bind_unbind,
591 {'mb_mpls_table_id': table_id,
593 'mb_ip_table_id': ip_table_id,
594 'mb_is_bind': is_bind,
595 'mb_prefix': prefix})
597 def mpls_tunnel_add_del(
607 self.papi.mpls_tunnel_add_del,
608 {'mt_is_add': is_add,
611 'mt_sw_if_index': tun_sw_if_index,
612 'mt_l2_only': l2_only,
613 'mt_is_multicast': is_multicast,
614 'mt_n_paths': len(paths),
618 def input_acl_set_interface(
622 ip4_table_index=0xFFFFFFFF,
623 ip6_table_index=0xFFFFFFFF,
624 l2_table_index=0xFFFFFFFF):
628 :param ip4_table_index: (Default value = 0xFFFFFFFF)
629 :param ip6_table_index: (Default value = 0xFFFFFFFF)
630 :param l2_table_index: (Default value = 0xFFFFFFFF)
634 self.papi.input_acl_set_interface,
635 {'sw_if_index': sw_if_index,
636 'ip4_table_index': ip4_table_index,
637 'ip6_table_index': ip6_table_index,
638 'l2_table_index': l2_table_index,
641 def output_acl_set_interface(
645 ip4_table_index=0xFFFFFFFF,
646 ip6_table_index=0xFFFFFFFF,
647 l2_table_index=0xFFFFFFFF):
651 :param ip4_table_index: (Default value = 0xFFFFFFFF)
652 :param ip6_table_index: (Default value = 0xFFFFFFFF)
653 :param l2_table_index: (Default value = 0xFFFFFFFF)
657 self.papi.output_acl_set_interface,
658 {'sw_if_index': sw_if_index,
659 'ip4_table_index': ip4_table_index,
660 'ip6_table_index': ip6_table_index,
661 'l2_table_index': l2_table_index,
664 def set_ipfix_exporter(
674 self.papi.set_ipfix_exporter,
676 'collector_address': collector_address,
677 'collector_port': collector_port,
678 'src_address': src_address,
680 'path_mtu': path_mtu,
681 'template_interval': template_interval,
682 'udp_checksum': udp_checksum,
685 def mfib_signal_dump(self):
686 return self.api(self.papi.mfib_signal_dump, {})
688 def ip_mroute_dump(self, table_id, is_ip6=False):
689 return self.api(self.papi.ip_mroute_dump,
691 'table_id': table_id,
695 def vxlan_gpe_add_del_tunnel(
699 mcast_sw_if_index=0xFFFFFFFF,
710 :param is_add: (Default value = 1)
711 :param is_ipv6: (Default value = 0)
712 :param encap_vrf_id: (Default value = 0)
713 :param decap_vrf_id: (Default value = 0)
714 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
715 :param protocol: (Default value = 3)
716 :param vni: (Default value = 0)
719 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
724 'mcast_sw_if_index': mcast_sw_if_index,
725 'encap_vrf_id': encap_vrf_id,
726 'decap_vrf_id': decap_vrf_id,
727 'protocol': protocol,
730 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
731 return self.api(self.papi.vxlan_gbp_tunnel_dump,
732 {'sw_if_index': sw_if_index})
734 def pppoe_add_del_session(
743 :param is_add: (Default value = 1)
744 :param is_ipv6: (Default value = 0)
746 :param session_id: (Default value = 0)
748 :param decap_vrf_id: (Default value = 0)
751 return self.api(self.papi.pppoe_add_del_session,
753 'session_id': session_id,
754 'client_ip': client_ip,
755 'decap_vrf_id': decap_vrf_id,
756 'client_mac': client_mac})
758 def sr_mpls_policy_add(self, bsid, weight, type, segments):
759 return self.api(self.papi.sr_mpls_policy_add,
763 'n_segments': len(segments),
764 'segments': segments})
766 def sr_mpls_policy_del(self, bsid):
767 return self.api(self.papi.sr_mpls_policy_del,
770 def ip_punt_police(self,
774 return self.api(self.papi.ip_punt_police,
775 {'policer_index': policer_index,
779 def ip_punt_redirect(self,
784 return self.api(self.papi.ip_punt_redirect,
785 {'punt': {'rx_sw_if_index': rx_sw_if_index,
786 'tx_sw_if_index': tx_sw_if_index,
790 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
791 return self.api(self.papi.ip_punt_redirect_dump,
792 {'sw_if_index': sw_if_index,
795 def bier_table_add_del(self,
799 """ BIER Table add/del """
801 self.papi.bier_table_add_del,
802 {'bt_tbl_id': {"bt_set": bti.set_id,
803 "bt_sub_domain": bti.sub_domain_id,
804 "bt_hdr_len_id": bti.hdr_len_id},
805 'bt_label': mpls_label,
806 'bt_is_add': is_add})
808 def bier_table_dump(self):
809 return self.api(self.papi.bier_table_dump, {})
811 def bier_route_add_del(self,
817 """ BIER Route add/del """
819 self.papi.bier_route_add_del,
822 'br_tbl_id': {"bt_set": bti.set_id,
823 "bt_sub_domain": bti.sub_domain_id,
824 "bt_hdr_len_id": bti.hdr_len_id},
826 'br_n_paths': len(paths),
830 'br_is_replace': is_replace
833 def bier_route_dump(self, bti):
835 self.papi.bier_route_dump,
836 {'br_tbl_id': {"bt_set": bti.set_id,
837 "bt_sub_domain": bti.sub_domain_id,
838 "bt_hdr_len_id": bti.hdr_len_id}})
840 def bier_imp_add(self,
845 """ BIER Imposition Add """
847 self.papi.bier_imp_add,
848 {'bi_tbl_id': {"bt_set": bti.set_id,
849 "bt_sub_domain": bti.sub_domain_id,
850 "bt_hdr_len_id": bti.hdr_len_id},
852 'bi_n_bytes': len(ibytes),
855 def bier_imp_del(self, bi_index):
856 """ BIER Imposition del """
858 self.papi.bier_imp_del,
859 {'bi_index': bi_index})
861 def bier_imp_dump(self):
862 return self.api(self.papi.bier_imp_dump, {})
864 def bier_disp_table_add_del(self,
867 """ BIER Disposition Table add/del """
869 self.papi.bier_disp_table_add_del,
871 'bdt_is_add': is_add})
873 def bier_disp_table_dump(self):
874 return self.api(self.papi.bier_disp_table_dump, {})
876 def bier_disp_entry_add_del(self,
886 """ BIER Route add/del """
888 while (len(lstack) < 16):
891 self.papi.bier_disp_entry_add_del,
894 'bde_payload_proto': payload_proto,
896 'bde_paths': [{'table_id': next_hop_tbl_id,
897 'rpf_id': next_hop_rpf_id,
899 'label_stack': lstack}],
900 'bde_is_add': is_add})
902 def bier_disp_entry_dump(self, bdti):
904 self.papi.bier_disp_entry_dump,
905 {'bde_tbl_id': bdti})
907 def session_enable_disable(self, is_enabled):
909 self.papi.session_enable_disable,
910 {'is_enable': is_enabled})
912 def ipsec_spd_add_del(self, spd_id, is_add=1):
913 """ SPD add/del - Wrapper to add or del ipsec SPD
914 Sample CLI : 'ipsec spd add 1'
916 :param spd_id - SPD ID to be created in the vpp . mandatory
917 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
919 :returns: reply from the API
922 self.papi.ipsec_spd_add_del, {
923 'spd_id': spd_id, 'is_add': is_add})
925 def ipsec_spds_dump(self):
926 return self.api(self.papi.ipsec_spds_dump, {})
928 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
929 """ IPSEC interface SPD add/del - \
930 Wrapper to associate/disassociate SPD to interface in VPP
931 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
933 :param spd_id - SPD ID to associate with the interface . mandatory
934 :param sw_if_index - Interface Index which needs to ipsec \
935 association mandatory
936 :param is_add - add(1) or del(0) association with interface \
937 (Default 1 - add) . optional
938 :returns: reply from the API
941 self.papi.ipsec_interface_add_del_spd,
942 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
944 def ipsec_spd_interface_dump(self, spd_index=None):
945 return self.api(self.papi.ipsec_spd_interface_dump,
946 {'spd_index': spd_index if spd_index else 0,
947 'spd_index_valid': 1 if spd_index else 0})
949 def ipsec_sa_dump(self, sa_id=None):
950 return self.api(self.papi.ipsec_sa_dump,
951 {'sa_id': sa_id if sa_id else 0xffffffff})
953 def ipsec_spd_entry_add_del(self,
958 remote_address_start,
961 local_port_stop=65535,
963 remote_port_stop=65535,
971 """ IPSEC policy SPD add/del -
972 Wrapper to configure ipsec SPD policy entries in VPP
973 :param spd_id: SPD ID for the policy
974 :param local_address_start: local-ip-range start address
975 :param local_address_stop : local-ip-range stop address
976 :param remote_address_start: remote-ip-range start address
977 :param remote_address_stop : remote-ip-range stop address
978 :param local_port_start: (Default value = 0)
979 :param local_port_stop: (Default value = 65535)
980 :param remote_port_start: (Default value = 0)
981 :param remote_port_stop: (Default value = 65535)
982 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
983 :param sa_id: Security Association ID for mapping it to SPD
984 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
986 :param priority: value for the spd action (Default value = 100)
987 :param is_outbound: flag for inbound(0) or outbound(1)
989 :param is_add: (Default value = 1)
992 self.papi.ipsec_spd_entry_add_del,
999 'local_address_start': local_address_start,
1000 'local_address_stop': local_address_stop,
1001 'remote_address_start': remote_address_start,
1002 'remote_address_stop': remote_address_stop,
1003 'local_port_start': local_port_start,
1004 'local_port_stop': local_port_stop,
1005 'remote_port_start': remote_port_start,
1006 'remote_port_stop': remote_port_stop,
1007 'protocol': protocol,
1009 'priority': priority,
1010 'is_outbound': is_outbound,
1014 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1015 return self.api(self.papi.ipsec_spd_dump,
1019 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1020 remote_spi, crypto_alg, local_crypto_key,
1021 remote_crypto_key, integ_alg, local_integ_key,
1022 remote_integ_key, is_add=1, esn=0, salt=0,
1023 anti_replay=1, renumber=0,
1024 udp_encap=0, show_instance=0xffffffff):
1026 self.papi.ipsec_tunnel_if_add_del,
1028 'local_ip': local_ip,
1029 'remote_ip': remote_ip,
1030 'local_spi': local_spi,
1031 'remote_spi': remote_spi,
1032 'crypto_alg': crypto_alg,
1033 'local_crypto_key_len': len(local_crypto_key),
1034 'local_crypto_key': local_crypto_key,
1035 'remote_crypto_key_len': len(remote_crypto_key),
1036 'remote_crypto_key': remote_crypto_key,
1037 'integ_alg': integ_alg,
1038 'local_integ_key_len': len(local_integ_key),
1039 'local_integ_key': local_integ_key,
1040 'remote_integ_key_len': len(remote_integ_key),
1041 'remote_integ_key': remote_integ_key,
1044 'anti_replay': anti_replay,
1045 'renumber': renumber,
1046 'show_instance': show_instance,
1047 'udp_encap': udp_encap,
1051 def ipsec_select_backend(self, protocol, index):
1052 return self.api(self.papi.ipsec_select_backend,
1053 {'protocol': protocol, 'index': index})
1055 def ipsec_backend_dump(self):
1056 return self.api(self.papi.ipsec_backend_dump, {})
1058 def app_namespace_add_del(self,
1062 sw_if_index=0xFFFFFFFF,
1065 self.papi.app_namespace_add_del,
1067 'sw_if_index': sw_if_index,
1068 'ip4_fib_id': ip4_fib_id,
1069 'ip6_fib_id': ip6_fib_id,
1070 'namespace_id': namespace_id})
1072 def punt_socket_register(self, reg, pathname,
1074 """ Register punt socket """
1075 return self.api(self.papi.punt_socket_register,
1076 {'header_version': header_version,
1078 'pathname': pathname})
1080 def punt_socket_deregister(self, reg):
1081 """ Unregister punt socket """
1082 return self.api(self.papi.punt_socket_deregister,
1085 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1087 """ GBP endpoint Add """
1088 return self.api(self.papi.gbp_endpoint_add,
1090 'sw_if_index': sw_if_index,
1101 def gbp_endpoint_del(self, handle):
1102 """ GBP endpoint Del """
1103 return self.api(self.papi.gbp_endpoint_del,
1106 def gbp_endpoint_dump(self):
1107 """ GBP endpoint Dump """
1108 return self.api(self.papi.gbp_endpoint_dump, {})
1110 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1111 rd, uplink_sw_if_index,
1113 """ GBP endpoint group Add """
1114 return self.api(self.papi.gbp_endpoint_group_add,
1117 'uplink_sw_if_index': uplink_sw_if_index,
1122 'retention': retention
1125 def gbp_endpoint_group_del(self, sclass):
1126 """ GBP endpoint group Del """
1127 return self.api(self.papi.gbp_endpoint_group_del,
1130 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1133 bm_flood_sw_if_index):
1134 """ GBP bridge-domain Add """
1135 return self.api(self.papi.gbp_bridge_domain_add,
1139 'bvi_sw_if_index': bvi_sw_if_index,
1140 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1141 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1146 def gbp_bridge_domain_del(self, bd_id):
1147 """ GBP bridge-domain Del """
1148 return self.api(self.papi.gbp_bridge_domain_del,
1151 def gbp_route_domain_add(self, rd_id,
1156 ip6_uu_sw_if_index):
1157 """ GBP route-domain Add """
1158 return self.api(self.papi.gbp_route_domain_add,
1162 'ip4_table_id': ip4_table_id,
1163 'ip6_table_id': ip6_table_id,
1164 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1165 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1169 def gbp_route_domain_del(self, rd_id):
1170 """ GBP route-domain Del """
1171 return self.api(self.papi.gbp_route_domain_del,
1174 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1175 """ GBP recirc Add/Del """
1176 return self.api(self.papi.gbp_recirc_add_del,
1180 'sw_if_index': sw_if_index,
1183 def gbp_recirc_dump(self):
1184 """ GBP recirc Dump """
1185 return self.api(self.papi.gbp_recirc_dump, {})
1187 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1188 """ GBP recirc Add/Del """
1189 return self.api(self.papi.gbp_ext_itf_add_del,
1192 'sw_if_index': sw_if_index,
1197 def gbp_ext_itf_dump(self):
1198 """ GBP recirc Dump """
1199 return self.api(self.papi.gbp_ext_itf_dump, {})
1201 def gbp_subnet_add_del(self, is_add, rd_id,
1203 sw_if_index=0xffffffff,
1205 """ GBP Subnet Add/Del """
1206 return self.api(self.papi.gbp_subnet_add_del,
1210 'sw_if_index': sw_if_index,
1215 def gbp_subnet_dump(self):
1216 """ GBP Subnet Dump """
1217 return self.api(self.papi.gbp_subnet_dump, {})
1219 def gbp_contract_dump(self):
1220 """ GBP contract Dump """
1221 return self.api(self.papi.gbp_contract_dump, {})
1223 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1224 """ GBP VXLAN tunnel add """
1225 return self.api(self.papi.gbp_vxlan_tunnel_add,
1230 'bd_rd_id': bd_rd_id,
1235 def gbp_vxlan_tunnel_del(self, vni):
1236 """ GBP VXLAN tunnel del """
1237 return self.api(self.papi.gbp_vxlan_tunnel_del,
1242 def gbp_vxlan_tunnel_dump(self):
1243 """ GBP VXLAN tunnel add/del """
1244 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1246 def igmp_enable_disable(self, sw_if_index, enable, host):
1247 """ Enable/disable IGMP on a given interface """
1248 return self.api(self.papi.igmp_enable_disable,
1251 'sw_if_index': sw_if_index})
1253 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1254 """ Add/del IGMP proxy device """
1255 return self.api(self.papi.igmp_proxy_device_add_del,
1256 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1259 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1260 """ Add/del interface to/from IGMP proxy device """
1261 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1262 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1265 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1266 """ Listen for new (S,G) on specified interface
1268 :param enable: add/del
1269 :param sw_if_index: interface sw index
1270 :param saddr: source ip4 addr
1271 :param gaddr: group ip4 addr
1273 return self.api(self.papi.igmp_listen,
1278 'sw_if_index': sw_if_index,
1279 'n_srcs': len(saddrs),
1285 def igmp_clear_interface(self, sw_if_index):
1286 """ Remove all (S,G)s from specified interface
1287 doesn't send IGMP report!
1290 self.papi.igmp_clear_interface, {
1291 'sw_if_index': sw_if_index})
1293 def want_igmp_events(self, enable=1):
1294 return self.api(self.papi.want_igmp_events, {'enable': enable,
1295 'pid': os.getpid()})
1304 interface_id=0xFFFFFFFF):
1307 :param lb: load balance
1308 :param numa_only: tx on local numa node for lacp mode
1309 :param use_custom_mac: use custom mac
1310 :param mac_address: mac address
1311 :param interface_id: custom interface ID
1314 self.papi.bond_create,
1317 'numa_only': numa_only,
1318 'use_custom_mac': use_custom_mac,
1319 'mac_address': mac_address,
1323 def pipe_delete(self, parent_sw_if_index):
1324 return self.api(self.papi.pipe_delete,
1325 {'parent_sw_if_index': parent_sw_if_index})
1327 def svs_table_add_del(self, af, table_id, is_add=1):
1328 return self.api(self.papi.svs_table_add_del,
1330 'table_id': table_id,
1335 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
1336 return self.api(self.papi.svs_route_add_del,
1338 'table_id': table_id,
1339 'source_table_id': src_table_id,
1344 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
1345 return self.api(self.papi.svs_enable_disable,
1348 'table_id': table_id,
1349 'sw_if_index': sw_if_index,
1350 'is_enable': is_enable,
1353 def feature_gso_enable_disable(self, sw_if_index, enable_disable=1):
1354 return self.api(self.papi.feature_gso_enable_disable,
1356 'sw_if_index': sw_if_index,
1357 'enable_disable': enable_disable,