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
23 'map_add_domain': {'mtu': 1280},
24 'syslog_set_sender': {'collector_port': 514,
26 'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
27 'acl_interface_list_dump': {'sw_if_index': 4294967295, },
28 'app_namespace_add_del': {'sw_if_index': 4294967295, },
29 'bd_ip_mac_add_del': {'is_add': 1, },
30 'bfd_udp_add': {'is_authenticated': False, 'bfd_key_id': None,
32 'bfd_udp_auth_activate': {'bfd_key_id': None, 'conf_key_id': None,
34 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
36 'bier_disp_table_add_del': {'is_add': 1, },
37 'bier_imp_add': {'is_add': 1, },
38 'bier_route_add_del': {'is_add': 1, },
39 'bier_table_add_del': {'is_add': 1, },
40 'bond_create': {'mac_address': '', 'id': 0xFFFFFFFF},
41 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
42 'learn': 1, 'is_add': 1, },
43 'bvi_create': {'user_instance': 4294967295, },
45 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
46 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
47 'decap_next_index': 4294967295, },
48 'gre_tunnel_add_del': {'instance': 4294967295, 'is_add': 1, },
49 'input_acl_set_interface': {'ip4_table_index': 4294967295,
50 'ip6_table_index': 4294967295,
51 'l2_table_index': 4294967295, },
52 'ip6_add_del_address_using_prefix': {'is_add': 1, },
53 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
54 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
55 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
56 'classify_table_index': 4294967295, 'is_add': 1, },
57 'ip_mroute_add_del': {'is_add': 1, },
58 'ip_neighbor_add_del': {'is_add': 1, },
59 'ip_punt_police': {'is_add': 1, },
60 'ip_punt_redirect': {'is_add': 1, },
61 'ip_route_add_del': {'is_add': 1, },
62 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
63 'ipsec_interface_add_del_spd': {'is_add': 1, },
64 'ipsec_sad_entry_add_del': {'is_add': 1, },
65 'ipsec_spd_add_del': {'is_add': 1, },
66 'ipsec_spd_dump': {'sa_id': 4294967295, },
67 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
68 'remote_port_stop': 65535, 'priority': 100,
71 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
72 'l2_emulation': {'enable': 1, },
73 'l2fib_add_del': {'is_add': 1, },
74 'lb_conf': {'sticky_buckets_per_core': 4294967295,
75 'flow_timeout': 4294967295},
76 'lisp_add_del_adjacency': {'is_add': 1, },
77 'lisp_add_del_local_eid': {'is_add': 1, },
78 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
79 'lisp_add_del_locator_set': {'is_add': 1, },
80 'lisp_add_del_remote_mapping': {'is_add': 1, },
81 'macip_acl_add_replace': {'acl_index': 4294967295, },
82 'macip_acl_dump': {'acl_index': 4294967295, },
83 'macip_acl_interface_add_del': {'is_add': 1, },
84 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
85 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
86 'mr_next_hop_weight': 1,
87 'mr_next_hop_via_label': 1048576,
89 'mr_classify_table_index': 4294967295, },
90 'mpls_table_add_del': {'is_add': 1, },
91 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
93 'next_hop_via_label': 1048576,
95 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
96 'output_acl_set_interface': {'ip4_table_index': 4294967295,
97 'ip6_table_index': 4294967295,
98 'l2_table_index': 4294967295, },
99 'pppoe_add_del_session': {'is_add': 1, },
100 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
101 'proxy_arp_add_del': {'is_add': 1, },
102 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
103 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
105 'set_ipfix_exporter': {'collector_port': 4739, },
106 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
107 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
108 'svs_enable_disable': {'is_enable': 1, },
109 'svs_route_add_del': {'is_add': 1, },
110 'svs_table_add_del': {'is_add': 1, },
111 'sw_interface_add_del_address': {'is_add': 1, },
112 'sw_interface_dump': {'sw_if_index': 4294967295, },
113 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
114 'pref_lifetime': 4294967295, },
115 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
116 'sw_interface_set_l2_bridge': {'enable': 1, },
117 'sw_interface_set_mpls_enable': {'enable': 1, },
118 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
119 'sw_interface_set_unnumbered': {'is_add': 1, },
120 'sw_interface_span_enable_disable': {'state': 1, },
121 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
122 'decap_next_index': 4294967295,
123 'instance': 4294967295, },
124 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
125 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
127 'want_bfd_events': {'enable_disable': 1, },
128 'want_igmp_events': {'enable': 1, },
129 'want_interface_events': {'enable_disable': 1, },
130 'want_l2_macs_events': {'enable_disable': 1, },
134 class CliFailedCommandError(Exception):
135 """ cli command failed."""
138 class CliSyntaxError(Exception):
139 """ cli command had a syntax error."""
142 class UnexpectedApiReturnValueError(Exception):
143 """ exception raised when the API return value is unexpected """
147 class VppPapiProvider(object):
148 """VPP-api provider using vpp-papi
150 @property hook: hook object providing before and after api/cli hooks
153 _zero, _negative = range(2)
155 def __init__(self, name, shm_prefix, test_class, read_timeout):
156 self.hook = Hook(test_class)
158 self.shm_prefix = shm_prefix
159 self.test_class = test_class
160 self._expect_api_retval = self._zero
161 self._expect_stack = []
163 # install_dir is a class attribute. We need to set it before
164 # calling the constructor.
165 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
169 if os.environ['SOCKET'] == '1':
174 self.vpp = VPPApiClient(logger=test_class.logger,
175 read_timeout=read_timeout,
176 use_socket=use_socket,
177 server_address=test_class.api_sock)
178 self._events = deque()
183 def assert_negative_api_retval(self):
184 """ Expect API failure - used with with, e.g.:
185 with self.vapi.assert_negative_api_retval():
186 self.vapi.<api call expected to fail>
188 self._expect_stack.append(self._expect_api_retval)
189 self._expect_api_retval = self._negative
192 def assert_zero_api_retval(self):
193 """ Expect API success - used with with, e.g.:
194 with self.vapi.assert_negative_api_retval():
195 self.vapi.<api call expected to succeed>
197 note: this is useful only inside another with block
198 as success is the default expected value
200 self._expect_stack.append(self._expect_api_retval)
201 self._expect_api_retval = self._zero
204 def __exit__(self, exc_type, exc_value, traceback):
205 self._expect_api_retval = self._expect_stack.pop()
207 def register_hook(self, hook):
208 """Replace hook registration with new hook
215 def collect_events(self):
216 """ Collect all events from the internal queue and clear the queue. """
218 self._events = deque()
221 def wait_for_event(self, timeout, name=None):
222 """ Wait for and return next event. """
224 self.test_class.logger.debug("Expecting event '%s' within %ss",
227 self.test_class.logger.debug("Expecting event within %ss",
230 self.test_class.logger.debug("Not waiting, event already queued")
231 limit = time.time() + timeout
232 while time.time() < limit:
234 e = self._events.popleft()
235 if name and type(e).__name__ != name:
237 "Unexpected event received: %s, expected: %s" %
238 (type(e).__name__, name))
239 self.test_class.logger.debug("Returning event %s:%s" %
242 self.test_class.sleep(0) # yield
243 raise Exception("Event did not occur within timeout")
245 def __call__(self, name, event):
246 """ Enqueue event in the internal event queue. """
247 # FIXME use the name instead of relying on type(e).__name__ ?
248 # FIXME #2 if this throws, it is eaten silently, Ole?
249 self.test_class.logger.debug("New event: %s: %s" % (name, event))
250 self._events.append(event)
252 def factory(self, name, apifn):
254 fields = apifn._func.msg.fields
256 # add positional and kw arguments
258 for i, o in enumerate(fields[3:]):
261 except BaseException:
265 if name in defaultmapping:
266 for k, v in iteritems(defaultmapping[name]):
270 return self.api(apifn, d)
274 def __getattribute__(self, name):
276 method = super(VppPapiProvider, self).__getattribute__(name)
277 except AttributeError:
278 method = self.factory(name, getattr(self.papi, name))
279 # lazily load the method so we don't need to call factory
280 # again for this name.
281 setattr(self, name, method)
285 """Connect the API to VPP"""
286 self.vpp.connect(self.name, self.shm_prefix)
287 self.papi = self.vpp.api
288 self.vpp.register_event_callback(self)
290 def disconnect(self):
291 """Disconnect the API from VPP"""
292 self.vpp.disconnect()
294 def api(self, api_fn, api_args, expected_retval=0):
295 """ Call API function and check it's return value.
296 Call the appropriate hooks before and after the API call
298 :param api_fn: API function to call
299 :param api_args: tuple of API function arguments
300 :param expected_retval: Expected return value (Default value = 0)
301 :returns: reply from the API
304 self.hook.before_api(api_fn.__name__, api_args)
305 reply = api_fn(**api_args)
306 if self._expect_api_retval == self._negative:
307 if hasattr(reply, 'retval') and reply.retval >= 0:
308 msg = "API call passed unexpectedly: expected negative " \
309 "return value instead of %d in %s" % \
310 (reply.retval, moves.reprlib.repr(reply))
311 self.test_class.logger.info(msg)
312 raise UnexpectedApiReturnValueError(msg)
313 elif self._expect_api_retval == self._zero:
314 if hasattr(reply, 'retval') and reply.retval != expected_retval:
315 msg = "API call failed, expected %d return value instead " \
316 "of %d in %s" % (expected_retval, reply.retval,
318 self.test_class.logger.info(msg)
319 raise UnexpectedApiReturnValueError(msg)
321 raise Exception("Internal error, unexpected value for "
322 "self._expect_api_retval %s" %
323 self._expect_api_retval)
324 self.hook.after_api(api_fn.__name__, api_args)
327 def cli_return_response(self, cli):
328 """ Execute a CLI, calling the before/after hooks appropriately.
329 Return the reply without examining it
331 :param cli: CLI to execute
332 :returns: response object
335 self.hook.before_cli(cli)
337 r = self.papi.cli_inband(cmd=cli)
338 self.hook.after_cli(cli)
342 """ Execute a CLI, calling the before/after hooks appropriately.
344 :param cli: CLI to execute
348 r = self.cli_return_response(cli)
350 raise CliSyntaxError(r.reply)
352 raise CliFailedCommandError(r.reply)
353 if hasattr(r, 'reply'):
356 def ppcli(self, cli):
357 """ Helper method to print CLI command in case of info logging level.
359 :param cli: CLI to execute
362 return cli + "\n" + self.cli(cli)
364 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
366 return self.api(self.papi.ip6nd_send_router_solicitation,
371 'sw_if_index': sw_if_index})
373 def want_interface_events(self, enable_disable=1):
374 return self.api(self.papi.want_interface_events,
375 {'enable_disable': enable_disable,
376 'pid': os.getpid(), })
378 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
379 max_macs_in_event=0, learn_limit=0):
380 return self.api(self.papi.want_l2_macs_events,
381 {'enable_disable': enable_disable,
382 'scan_delay': scan_delay,
383 'max_macs_in_event': max_macs_in_event,
384 'learn_limit': learn_limit,
385 'pid': os.getpid(), })
387 def sw_interface_set_mac_address(self, sw_if_index, mac):
388 return self.api(self.papi.sw_interface_set_mac_address,
389 {'sw_if_index': sw_if_index,
392 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
393 """Create p2p ethernet subinterface
395 :param sw_if_index: main (parent) interface
396 :param remote_mac: client (remote) mac address
400 self.papi.p2p_ethernet_add,
401 {'parent_if_index': sw_if_index,
402 'remote_mac': remote_mac,
403 'subif_id': subif_id})
405 def p2p_ethernet_del(self, sw_if_index, remote_mac):
406 """Delete p2p ethernet subinterface
408 :param sw_if_index: main (parent) interface
409 :param remote_mac: client (remote) mac address
413 self.papi.p2p_ethernet_del,
414 {'parent_if_index': sw_if_index,
415 'remote_mac': remote_mac})
417 def create_vlan_subif(self, sw_if_index, vlan):
424 return self.api(self.papi.create_vlan_subif,
425 {'sw_if_index': sw_if_index,
428 def create_loopback(self, mac=''):
431 :param mac: (Optional)
433 return self.api(self.papi.create_loopback,
434 {'mac_address': mac})
436 def ip_route_dump(self, table_id, is_ip6=False):
437 return self.api(self.papi.ip_route_dump,
439 'table_id': table_id,
443 def ip_neighbor_add_del(self,
449 """ Add neighbor MAC to IPv4 or IPv6 address.
454 :param is_add: (Default value = 1)
455 :param flags: (Default value = 0/NONE)
458 self.papi.ip_neighbor_add_del,
462 'sw_if_index': sw_if_index,
464 'mac_address': mac_address,
465 'ip_address': ip_address
470 def proxy_arp_add_del(self,
475 """ Config Proxy Arp Range.
477 :param low_address: Start address in the rnage to Proxy for
478 :param hi_address: End address in the rnage to Proxy for
479 :param vrf_id: The VRF/table in which to proxy
483 self.papi.proxy_arp_add_del,
486 'table_id': table_id,
492 def proxy_arp_intfc_enable_disable(self,
495 """ Enable/Disable an interface for proxy ARP requests
497 :param sw_if_index: Interface
498 :param enable_disable: Enable/Disable
502 self.papi.proxy_arp_intfc_enable_disable,
503 {'sw_if_index': sw_if_index,
508 def gre_tunnel_add_del(self,
521 :param outer_fib_id: (Default value = 0)
522 :param tunnel_type: (Default value = 0)
523 :param instance: (Default value = 0xFFFFFFFF)
524 :param session_id: (Default value = 0)
525 :param is_add: (Default value = 1)
526 :param is_ipv6: (Default value = 0)
530 self.papi.gre_tunnel_add_del,
536 'instance': instance,
539 'outer_table_id': outer_table_id,
540 'session_id': session_id}
544 def udp_encap_add(self,
555 :param outer_fib_id: (Default value = 0)
559 self.papi.udp_encap_add,
564 'src_port': src_port,
565 'dst_port': dst_port,
570 def udp_encap_del(self, id):
571 return self.api(self.papi.udp_encap_del, {'id': id})
573 def udp_encap_dump(self):
574 return self.api(self.papi.udp_encap_dump, {})
576 def want_udp_encap_stats(self, enable=1):
577 return self.api(self.papi.want_udp_encap_stats,
581 def mpls_route_dump(self, table_id):
582 return self.api(self.papi.mpls_route_dump,
584 'mt_table_id': table_id
587 def mpls_table_dump(self):
588 return self.api(self.papi.mpls_table_dump, {})
590 def mpls_table_add_del(
597 :param is_add: (Default value = 1)
602 self.papi.mpls_table_add_del,
605 'mt_table_id': table_id,
607 'mt_is_add': is_add})
609 def mpls_route_add_del(self,
618 """ MPLS Route add/del """
620 self.papi.mpls_route_add_del,
623 'mr_table_id': table_id,
626 'mr_eos_proto': eos_proto,
627 'mr_is_multicast': is_multicast,
628 'mr_n_paths': len(paths),
632 'mr_is_multipath': is_multipath})
634 def mpls_ip_bind_unbind(
644 self.papi.mpls_ip_bind_unbind,
645 {'mb_mpls_table_id': table_id,
647 'mb_ip_table_id': ip_table_id,
648 'mb_is_bind': is_bind,
649 'mb_prefix': prefix})
651 def mpls_tunnel_add_del(
661 self.papi.mpls_tunnel_add_del,
662 {'mt_is_add': is_add,
665 'mt_sw_if_index': tun_sw_if_index,
666 'mt_l2_only': l2_only,
667 'mt_is_multicast': is_multicast,
668 'mt_n_paths': len(paths),
672 def input_acl_set_interface(
676 ip4_table_index=0xFFFFFFFF,
677 ip6_table_index=0xFFFFFFFF,
678 l2_table_index=0xFFFFFFFF):
682 :param ip4_table_index: (Default value = 0xFFFFFFFF)
683 :param ip6_table_index: (Default value = 0xFFFFFFFF)
684 :param l2_table_index: (Default value = 0xFFFFFFFF)
688 self.papi.input_acl_set_interface,
689 {'sw_if_index': sw_if_index,
690 'ip4_table_index': ip4_table_index,
691 'ip6_table_index': ip6_table_index,
692 'l2_table_index': l2_table_index,
695 def output_acl_set_interface(
699 ip4_table_index=0xFFFFFFFF,
700 ip6_table_index=0xFFFFFFFF,
701 l2_table_index=0xFFFFFFFF):
705 :param ip4_table_index: (Default value = 0xFFFFFFFF)
706 :param ip6_table_index: (Default value = 0xFFFFFFFF)
707 :param l2_table_index: (Default value = 0xFFFFFFFF)
711 self.papi.output_acl_set_interface,
712 {'sw_if_index': sw_if_index,
713 'ip4_table_index': ip4_table_index,
714 'ip6_table_index': ip6_table_index,
715 'l2_table_index': l2_table_index,
718 def set_ipfix_exporter(
728 self.papi.set_ipfix_exporter,
730 'collector_address': collector_address,
731 'collector_port': collector_port,
732 'src_address': src_address,
734 'path_mtu': path_mtu,
735 'template_interval': template_interval,
736 'udp_checksum': udp_checksum,
739 def ip_mroute_add_del(self,
748 IP Multicast Route add/del
751 self.papi.ip_mroute_add_del,
754 'is_multipath': is_multipath,
756 'table_id': table_id,
757 'entry_flags': e_flags,
760 'n_paths': len(paths),
765 def mfib_signal_dump(self):
766 return self.api(self.papi.mfib_signal_dump, {})
768 def ip_mroute_dump(self, table_id, is_ip6=False):
769 return self.api(self.papi.ip_mroute_dump,
771 'table_id': table_id,
775 def lisp_enable_disable(self, is_enabled):
777 self.papi.lisp_enable_disable,
782 def lisp_add_del_locator_set(self,
786 self.papi.lisp_add_del_locator_set,
789 'locator_set_name': ls_name
792 def lisp_add_del_locator(self,
799 self.papi.lisp_add_del_locator,
802 'locator_set_name': ls_name,
803 'sw_if_index': sw_if_index,
804 'priority': priority,
808 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
810 self.papi.lisp_locator_dump,
812 'is_index_set': is_index_set,
814 'ls_index': ls_index,
817 def lisp_add_del_local_eid(self,
827 self.papi.lisp_add_del_local_eid,
829 'locator_set_name': ls_name,
831 'eid_type': eid_type,
833 'prefix_len': prefix_len,
839 def lisp_eid_table_dump(self,
847 self.papi.lisp_eid_table_dump,
850 'prefix_length': prefix_length,
852 'eid_type': eid_type,
854 'filter': filter_opt,
857 def lisp_add_del_remote_mapping(self,
867 self.papi.lisp_add_del_remote_mapping,
870 'eid_type': eid_type,
872 'eid_len': eid_prefix_len,
873 'rloc_num': rlocs_num,
876 'is_src_dst': is_src_dst,
879 def lisp_add_del_adjacency(self,
888 self.papi.lisp_add_del_adjacency,
892 'eid_type': eid_type,
895 'leid_len': leid_len,
896 'reid_len': reid_len,
899 def vxlan_gpe_add_del_tunnel(
903 mcast_sw_if_index=0xFFFFFFFF,
914 :param is_add: (Default value = 1)
915 :param is_ipv6: (Default value = 0)
916 :param encap_vrf_id: (Default value = 0)
917 :param decap_vrf_id: (Default value = 0)
918 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
919 :param protocol: (Default value = 3)
920 :param vni: (Default value = 0)
923 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
928 'mcast_sw_if_index': mcast_sw_if_index,
929 'encap_vrf_id': encap_vrf_id,
930 'decap_vrf_id': decap_vrf_id,
931 'protocol': protocol,
934 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
935 return self.api(self.papi.vxlan_gbp_tunnel_dump,
936 {'sw_if_index': sw_if_index})
938 def pppoe_add_del_session(
947 :param is_add: (Default value = 1)
948 :param is_ipv6: (Default value = 0)
950 :param session_id: (Default value = 0)
952 :param decap_vrf_id: (Default value = 0)
955 return self.api(self.papi.pppoe_add_del_session,
957 'session_id': session_id,
958 'client_ip': client_ip,
959 'decap_vrf_id': decap_vrf_id,
960 'client_mac': client_mac})
962 def sr_mpls_policy_add(self, bsid, weight, type, segments):
963 return self.api(self.papi.sr_mpls_policy_add,
967 'n_segments': len(segments),
968 'segments': segments})
970 def sr_mpls_policy_del(self, bsid):
971 return self.api(self.papi.sr_mpls_policy_del,
974 def sr_localsid_add_del(self,
981 sw_if_index=0xFFFFFFFF,
985 """ Add/del IPv6 SR local-SID.
988 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
989 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
992 :param is_del: (Default value = 0)
993 :param end_psp: (Default value = 0)
994 :param sw_if_index: (Default value = 0xFFFFFFFF)
995 :param vlan_index: (Default value = 0)
996 :param fib_table: (Default value = 0)
999 self.papi.sr_localsid_add_del,
1001 'localsid': localsid,
1003 'behavior': behavior,
1004 'sw_if_index': sw_if_index,
1005 'vlan_index': vlan_index,
1006 'fib_table': fib_table,
1007 'nh_addr4': nh_addr4,
1008 'nh_addr6': nh_addr6
1022 :param bsid_addr: bindingSID of the SR Policy
1023 :param weight: weight of the sid list. optional. (default: 1)
1024 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1026 :param type: type/behavior of the SR policy. (default or spray) \
1028 :param fib_table: VRF where to install the FIB entry for the BSID \
1030 :param n_segments: number of segments \
1032 :param segments: a vector of IPv6 address composing the segment list \
1036 self.papi.sr_policy_add,
1037 {'bsid_addr': bsid_addr,
1039 'is_encap': is_encap,
1041 'fib_table': fib_table,
1042 'n_segments': n_segments,
1043 'segments': segments
1052 :param bsid: bindingSID of the SR Policy
1053 :param sr_policy_index: index of the sr policy (default: 0)
1056 self.papi.sr_policy_del,
1057 {'bsid_addr': bsid_addr,
1058 'sr_policy_index': sr_policy_index
1061 def sr_steering_add_del(
1072 Steer traffic L2 and L3 traffic through a given SR policy
1074 :param is_del: delete or add
1075 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1076 :param sr_policy: is the index of the SR Policy (alt to bsid)
1077 :param table_id: is the VRF where to install the FIB entry for the BSID
1078 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1079 :param mask_width: is the mask for L3 traffic type
1080 :param sw_if_index: is the incoming interface for L2 traffic
1081 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1084 self.papi.sr_steering_add_del,
1086 'bsid_addr': bsid_addr,
1087 'sr_policy_index': sr_policy_index,
1088 'table_id': table_id,
1089 'prefix_addr': prefix_addr,
1090 'mask_width': mask_width,
1091 'sw_if_index': sw_if_index,
1092 'traffic_type': traffic_type
1095 def acl_add_replace(self, acl_index, r, tag='',
1097 """Add/replace an ACL
1098 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1099 :param acl_rule r: ACL rules array.
1100 :param str tag: symbolic tag (description) for this ACL.
1101 :param int count: number of rules.
1103 return self.api(self.papi.acl_add_replace,
1104 {'acl_index': acl_index,
1108 expected_retval=expected_retval)
1110 def acl_del(self, acl_index, expected_retval=0):
1116 return self.api(self.papi.acl_del,
1117 {'acl_index': acl_index},
1118 expected_retval=expected_retval)
1120 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1122 return self.api(self.papi.acl_interface_set_acl_list,
1123 {'sw_if_index': sw_if_index,
1127 expected_retval=expected_retval)
1129 def acl_interface_set_etype_whitelist(self, sw_if_index,
1132 return self.api(self.papi.acl_interface_set_etype_whitelist,
1133 {'sw_if_index': sw_if_index,
1134 'count': len(whitelist),
1136 'whitelist': whitelist},
1137 expected_retval=expected_retval)
1139 def acl_interface_add_del(self,
1143 """ Add/Delete ACL to/from interface
1147 :param is_add: (Default value = 1)
1150 return self.api(self.papi.acl_interface_add_del,
1153 'sw_if_index': sw_if_index,
1154 'acl_index': acl_index})
1156 def acl_dump(self, acl_index, expected_retval=0):
1157 return self.api(self.papi.acl_dump,
1158 {'acl_index': acl_index},
1159 expected_retval=expected_retval)
1161 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1163 return self.api(self.papi.acl_interface_list_dump,
1164 {'sw_if_index': sw_if_index},
1165 expected_retval=expected_retval)
1167 def macip_acl_add(self, rules, tag=""):
1170 :param rules: list of rules for given acl
1174 return self.api(self.papi.macip_acl_add,
1176 'count': len(rules),
1179 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1182 :param rules: list of rules for given acl
1186 return self.api(self.papi.macip_acl_add_replace,
1187 {'acl_index': acl_index,
1189 'count': len(rules),
1192 def macip_acl_interface_add_del(self,
1196 """ Add MACIP acl to interface
1200 :param is_add: (Default value = 1)
1203 return self.api(self.papi.macip_acl_interface_add_del,
1205 'sw_if_index': sw_if_index,
1206 'acl_index': acl_index})
1208 def macip_acl_dump(self, acl_index=4294967295):
1209 """ Return MACIP acl dump
1213 self.papi.macip_acl_dump, {'acl_index': acl_index})
1215 def policer_add_del(self,
1226 conform_action_type=1,
1228 exceed_action_type=0,
1230 violate_action_type=0,
1232 return self.api(self.papi.policer_add_del,
1239 'rate_type': rate_type,
1240 'round_type': round_type,
1242 'color_aware': color_aware,
1243 'conform_action_type': conform_action_type,
1244 'conform_dscp': conform_dscp,
1245 'exceed_action_type': exceed_action_type,
1246 'exceed_dscp': exceed_dscp,
1247 'violate_action_type': violate_action_type,
1248 'violate_dscp': violate_dscp})
1250 def ip_punt_police(self,
1254 return self.api(self.papi.ip_punt_police,
1255 {'policer_index': policer_index,
1259 def ip_punt_redirect(self,
1264 return self.api(self.papi.ip_punt_redirect,
1265 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1266 'tx_sw_if_index': tx_sw_if_index,
1270 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1271 return self.api(self.papi.ip_punt_redirect_dump,
1272 {'sw_if_index': sw_if_index,
1273 'is_ipv6': is_ipv6})
1275 def bier_table_add_del(self,
1279 """ BIER Table add/del """
1281 self.papi.bier_table_add_del,
1282 {'bt_tbl_id': {"bt_set": bti.set_id,
1283 "bt_sub_domain": bti.sub_domain_id,
1284 "bt_hdr_len_id": bti.hdr_len_id},
1285 'bt_label': mpls_label,
1286 'bt_is_add': is_add})
1288 def bier_table_dump(self):
1289 return self.api(self.papi.bier_table_dump, {})
1291 def bier_route_add_del(self,
1297 """ BIER Route add/del """
1299 self.papi.bier_route_add_del,
1302 'br_tbl_id': {"bt_set": bti.set_id,
1303 "bt_sub_domain": bti.sub_domain_id,
1304 "bt_hdr_len_id": bti.hdr_len_id},
1306 'br_n_paths': len(paths),
1309 'br_is_add': is_add,
1310 'br_is_replace': is_replace
1313 def bier_route_dump(self, bti):
1315 self.papi.bier_route_dump,
1316 {'br_tbl_id': {"bt_set": bti.set_id,
1317 "bt_sub_domain": bti.sub_domain_id,
1318 "bt_hdr_len_id": bti.hdr_len_id}})
1320 def bier_imp_add(self,
1325 """ BIER Imposition Add """
1327 self.papi.bier_imp_add,
1328 {'bi_tbl_id': {"bt_set": bti.set_id,
1329 "bt_sub_domain": bti.sub_domain_id,
1330 "bt_hdr_len_id": bti.hdr_len_id},
1332 'bi_n_bytes': len(ibytes),
1333 'bi_bytes': ibytes})
1335 def bier_imp_del(self, bi_index):
1336 """ BIER Imposition del """
1338 self.papi.bier_imp_del,
1339 {'bi_index': bi_index})
1341 def bier_imp_dump(self):
1342 return self.api(self.papi.bier_imp_dump, {})
1344 def bier_disp_table_add_del(self,
1347 """ BIER Disposition Table add/del """
1349 self.papi.bier_disp_table_add_del,
1350 {'bdt_tbl_id': bdti,
1351 'bdt_is_add': is_add})
1353 def bier_disp_table_dump(self):
1354 return self.api(self.papi.bier_disp_table_dump, {})
1356 def bier_disp_entry_add_del(self,
1366 """ BIER Route add/del """
1368 while (len(lstack) < 16):
1371 self.papi.bier_disp_entry_add_del,
1372 {'bde_tbl_id': bdti,
1374 'bde_payload_proto': payload_proto,
1376 'bde_paths': [{'table_id': next_hop_tbl_id,
1377 'rpf_id': next_hop_rpf_id,
1379 'label_stack': lstack}],
1380 'bde_is_add': is_add})
1382 def bier_disp_entry_dump(self, bdti):
1384 self.papi.bier_disp_entry_dump,
1385 {'bde_tbl_id': bdti})
1387 def session_enable_disable(self, is_enabled):
1389 self.papi.session_enable_disable,
1390 {'is_enable': is_enabled})
1392 def ipsec_spd_add_del(self, spd_id, is_add=1):
1393 """ SPD add/del - Wrapper to add or del ipsec SPD
1394 Sample CLI : 'ipsec spd add 1'
1396 :param spd_id - SPD ID to be created in the vpp . mandatory
1397 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1399 :returns: reply from the API
1402 self.papi.ipsec_spd_add_del, {
1403 'spd_id': spd_id, 'is_add': is_add})
1405 def ipsec_spds_dump(self):
1406 return self.api(self.papi.ipsec_spds_dump, {})
1408 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1409 """ IPSEC interface SPD add/del - \
1410 Wrapper to associate/disassociate SPD to interface in VPP
1411 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1413 :param spd_id - SPD ID to associate with the interface . mandatory
1414 :param sw_if_index - Interface Index which needs to ipsec \
1415 association mandatory
1416 :param is_add - add(1) or del(0) association with interface \
1417 (Default 1 - add) . optional
1418 :returns: reply from the API
1421 self.papi.ipsec_interface_add_del_spd,
1422 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1424 def ipsec_spd_interface_dump(self, spd_index=None):
1425 return self.api(self.papi.ipsec_spd_interface_dump,
1426 {'spd_index': spd_index if spd_index else 0,
1427 'spd_index_valid': 1 if spd_index else 0})
1429 def ipsec_sad_entry_add_del(self,
1432 integrity_algorithm,
1437 tunnel_src_address='',
1438 tunnel_dst_address='',
1442 """ IPSEC SA add/del
1443 :param sad_id: security association ID
1444 :param spi: security param index of the SA in decimal
1445 :param integrity_algorithm:
1446 :param integrity_key:
1447 :param crypto_algorithm:
1449 :param protocol: AH(0) or ESP(1) protocol
1450 :param tunnel_src_address: tunnel mode outer src address
1451 :param tunnel_dst_address: tunnel mode outer dst address
1454 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1455 crypto and ipsec algorithms
1458 self.papi.ipsec_sad_entry_add_del,
1465 'tunnel_src': tunnel_src_address,
1466 'tunnel_dst': tunnel_dst_address,
1467 'protocol': protocol,
1468 'integrity_algorithm': integrity_algorithm,
1470 'length': len(integrity_key),
1471 'data': integrity_key,
1473 'crypto_algorithm': crypto_algorithm,
1475 'length': len(crypto_key),
1483 def ipsec_sa_dump(self, sa_id=None):
1484 return self.api(self.papi.ipsec_sa_dump,
1485 {'sa_id': sa_id if sa_id else 0xffffffff})
1487 def ipsec_spd_entry_add_del(self,
1490 local_address_start,
1492 remote_address_start,
1493 remote_address_stop,
1495 local_port_stop=65535,
1496 remote_port_start=0,
1497 remote_port_stop=65535,
1505 """ IPSEC policy SPD add/del -
1506 Wrapper to configure ipsec SPD policy entries in VPP
1507 :param spd_id: SPD ID for the policy
1508 :param local_address_start: local-ip-range start address
1509 :param local_address_stop : local-ip-range stop address
1510 :param remote_address_start: remote-ip-range start address
1511 :param remote_address_stop : remote-ip-range stop address
1512 :param local_port_start: (Default value = 0)
1513 :param local_port_stop: (Default value = 65535)
1514 :param remote_port_start: (Default value = 0)
1515 :param remote_port_stop: (Default value = 65535)
1516 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1517 :param sa_id: Security Association ID for mapping it to SPD
1518 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1520 :param priority: value for the spd action (Default value = 100)
1521 :param is_outbound: flag for inbound(0) or outbound(1)
1523 :param is_add: (Default value = 1)
1526 self.papi.ipsec_spd_entry_add_del,
1533 'local_address_start': local_address_start,
1534 'local_address_stop': local_address_stop,
1535 'remote_address_start': remote_address_start,
1536 'remote_address_stop': remote_address_stop,
1537 'local_port_start': local_port_start,
1538 'local_port_stop': local_port_stop,
1539 'remote_port_start': remote_port_start,
1540 'remote_port_stop': remote_port_stop,
1541 'protocol': protocol,
1543 'priority': priority,
1544 'is_outbound': is_outbound,
1548 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1549 return self.api(self.papi.ipsec_spd_dump,
1553 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1554 remote_spi, crypto_alg, local_crypto_key,
1555 remote_crypto_key, integ_alg, local_integ_key,
1556 remote_integ_key, is_add=1, esn=0, salt=0,
1557 anti_replay=1, renumber=0,
1558 udp_encap=0, show_instance=0xffffffff):
1560 self.papi.ipsec_tunnel_if_add_del,
1562 'local_ip': local_ip,
1563 'remote_ip': remote_ip,
1564 'local_spi': local_spi,
1565 'remote_spi': remote_spi,
1566 'crypto_alg': crypto_alg,
1567 'local_crypto_key_len': len(local_crypto_key),
1568 'local_crypto_key': local_crypto_key,
1569 'remote_crypto_key_len': len(remote_crypto_key),
1570 'remote_crypto_key': remote_crypto_key,
1571 'integ_alg': integ_alg,
1572 'local_integ_key_len': len(local_integ_key),
1573 'local_integ_key': local_integ_key,
1574 'remote_integ_key_len': len(remote_integ_key),
1575 'remote_integ_key': remote_integ_key,
1578 'anti_replay': anti_replay,
1579 'renumber': renumber,
1580 'show_instance': show_instance,
1581 'udp_encap': udp_encap,
1585 def ipsec_select_backend(self, protocol, index):
1586 return self.api(self.papi.ipsec_select_backend,
1587 {'protocol': protocol, 'index': index})
1589 def ipsec_backend_dump(self):
1590 return self.api(self.papi.ipsec_backend_dump, {})
1592 def app_namespace_add_del(self,
1596 sw_if_index=0xFFFFFFFF,
1599 self.papi.app_namespace_add_del,
1601 'sw_if_index': sw_if_index,
1602 'ip4_fib_id': ip4_fib_id,
1603 'ip6_fib_id': ip6_fib_id,
1604 'namespace_id': namespace_id,
1605 'namespace_id_len': len(namespace_id)})
1607 def punt_socket_register(self, reg, pathname,
1609 """ Register punt socket """
1610 return self.api(self.papi.punt_socket_register,
1611 {'header_version': header_version,
1613 'pathname': pathname})
1615 def punt_socket_deregister(self, reg):
1616 """ Unregister punt socket """
1617 return self.api(self.papi.punt_socket_deregister,
1620 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1622 """ GBP endpoint Add """
1623 return self.api(self.papi.gbp_endpoint_add,
1625 'sw_if_index': sw_if_index,
1636 def gbp_endpoint_del(self, handle):
1637 """ GBP endpoint Del """
1638 return self.api(self.papi.gbp_endpoint_del,
1641 def gbp_endpoint_dump(self):
1642 """ GBP endpoint Dump """
1643 return self.api(self.papi.gbp_endpoint_dump, {})
1645 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1646 rd, uplink_sw_if_index,
1648 """ GBP endpoint group Add """
1649 return self.api(self.papi.gbp_endpoint_group_add,
1652 'uplink_sw_if_index': uplink_sw_if_index,
1657 'retention': retention
1660 def gbp_endpoint_group_del(self, sclass):
1661 """ GBP endpoint group Del """
1662 return self.api(self.papi.gbp_endpoint_group_del,
1665 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1668 bm_flood_sw_if_index):
1669 """ GBP bridge-domain Add """
1670 return self.api(self.papi.gbp_bridge_domain_add,
1674 'bvi_sw_if_index': bvi_sw_if_index,
1675 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1676 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1681 def gbp_bridge_domain_del(self, bd_id):
1682 """ GBP bridge-domain Del """
1683 return self.api(self.papi.gbp_bridge_domain_del,
1686 def gbp_route_domain_add(self, rd_id,
1691 ip6_uu_sw_if_index):
1692 """ GBP route-domain Add """
1693 return self.api(self.papi.gbp_route_domain_add,
1697 'ip4_table_id': ip4_table_id,
1698 'ip6_table_id': ip6_table_id,
1699 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1700 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1704 def gbp_route_domain_del(self, rd_id):
1705 """ GBP route-domain Del """
1706 return self.api(self.papi.gbp_route_domain_del,
1709 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1710 """ GBP recirc Add/Del """
1711 return self.api(self.papi.gbp_recirc_add_del,
1715 'sw_if_index': sw_if_index,
1718 def gbp_recirc_dump(self):
1719 """ GBP recirc Dump """
1720 return self.api(self.papi.gbp_recirc_dump, {})
1722 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1723 """ GBP recirc Add/Del """
1724 return self.api(self.papi.gbp_ext_itf_add_del,
1727 'sw_if_index': sw_if_index,
1732 def gbp_ext_itf_dump(self):
1733 """ GBP recirc Dump """
1734 return self.api(self.papi.gbp_ext_itf_dump, {})
1736 def gbp_subnet_add_del(self, is_add, rd_id,
1738 sw_if_index=0xffffffff,
1740 """ GBP Subnet Add/Del """
1741 return self.api(self.papi.gbp_subnet_add_del,
1745 'sw_if_index': sw_if_index,
1750 def gbp_subnet_dump(self):
1751 """ GBP Subnet Dump """
1752 return self.api(self.papi.gbp_subnet_dump, {})
1754 def gbp_contract_dump(self):
1755 """ GBP contract Dump """
1756 return self.api(self.papi.gbp_contract_dump, {})
1758 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1759 """ GBP VXLAN tunnel add """
1760 return self.api(self.papi.gbp_vxlan_tunnel_add,
1765 'bd_rd_id': bd_rd_id,
1770 def gbp_vxlan_tunnel_del(self, vni):
1771 """ GBP VXLAN tunnel del """
1772 return self.api(self.papi.gbp_vxlan_tunnel_del,
1777 def gbp_vxlan_tunnel_dump(self):
1778 """ GBP VXLAN tunnel add/del """
1779 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1781 def igmp_enable_disable(self, sw_if_index, enable, host):
1782 """ Enable/disable IGMP on a given interface """
1783 return self.api(self.papi.igmp_enable_disable,
1786 'sw_if_index': sw_if_index})
1788 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1789 """ Add/del IGMP proxy device """
1790 return self.api(self.papi.igmp_proxy_device_add_del,
1791 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1794 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1795 """ Add/del interface to/from IGMP proxy device """
1796 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1797 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1800 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1801 """ Listen for new (S,G) on specified interface
1803 :param enable: add/del
1804 :param sw_if_index: interface sw index
1805 :param saddr: source ip4 addr
1806 :param gaddr: group ip4 addr
1808 return self.api(self.papi.igmp_listen,
1813 'sw_if_index': sw_if_index,
1814 'n_srcs': len(saddrs),
1820 def igmp_clear_interface(self, sw_if_index):
1821 """ Remove all (S,G)s from specified interface
1822 doesn't send IGMP report!
1825 self.papi.igmp_clear_interface, {
1826 'sw_if_index': sw_if_index})
1828 def want_igmp_events(self, enable=1):
1829 return self.api(self.papi.want_igmp_events, {'enable': enable,
1830 'pid': os.getpid()})
1839 interface_id=0xFFFFFFFF):
1842 :param lb: load balance
1843 :param numa_only: tx on local numa node for lacp mode
1844 :param use_custom_mac: use custom mac
1845 :param mac_address: mac address
1846 :param interface_id: custom interface ID
1849 self.papi.bond_create,
1852 'numa_only': numa_only,
1853 'use_custom_mac': use_custom_mac,
1854 'mac_address': mac_address,
1858 def pipe_delete(self, parent_sw_if_index):
1859 return self.api(self.papi.pipe_delete,
1860 {'parent_sw_if_index': parent_sw_if_index})
1862 def svs_table_add_del(self, af, table_id, is_add=1):
1863 return self.api(self.papi.svs_table_add_del,
1865 'table_id': table_id,
1870 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
1871 return self.api(self.papi.svs_route_add_del,
1873 'table_id': table_id,
1874 'source_table_id': src_table_id,
1879 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
1880 return self.api(self.papi.svs_enable_disable,
1883 'table_id': table_id,
1884 'sw_if_index': sw_if_index,
1885 'is_enable': is_enable,
1888 def feature_gso_enable_disable(self, sw_if_index, enable_disable=1):
1889 return self.api(self.papi.feature_gso_enable_disable,
1891 'sw_if_index': sw_if_index,
1892 'enable_disable': enable_disable,