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_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
131 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
132 'want_ip6_ra_events': {'enable_disable': 1, },
133 'want_l2_macs_events': {'enable_disable': 1, },
137 class CliFailedCommandError(Exception):
138 """ cli command failed."""
141 class CliSyntaxError(Exception):
142 """ cli command had a syntax error."""
145 class UnexpectedApiReturnValueError(Exception):
146 """ exception raised when the API return value is unexpected """
150 class VppPapiProvider(object):
151 """VPP-api provider using vpp-papi
153 @property hook: hook object providing before and after api/cli hooks
156 _zero, _negative = range(2)
158 def __init__(self, name, shm_prefix, test_class, read_timeout):
159 self.hook = Hook(test_class)
161 self.shm_prefix = shm_prefix
162 self.test_class = test_class
163 self._expect_api_retval = self._zero
164 self._expect_stack = []
166 # install_dir is a class attribute. We need to set it before
167 # calling the constructor.
168 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
172 if os.environ['SOCKET'] == '1':
177 self.vpp = VPPApiClient(logger=test_class.logger,
178 read_timeout=read_timeout,
179 use_socket=use_socket,
180 server_address=test_class.api_sock)
181 self._events = deque()
186 def assert_negative_api_retval(self):
187 """ Expect API failure - used with with, e.g.:
188 with self.vapi.assert_negative_api_retval():
189 self.vapi.<api call expected to fail>
191 self._expect_stack.append(self._expect_api_retval)
192 self._expect_api_retval = self._negative
195 def assert_zero_api_retval(self):
196 """ Expect API success - used with with, e.g.:
197 with self.vapi.assert_negative_api_retval():
198 self.vapi.<api call expected to succeed>
200 note: this is useful only inside another with block
201 as success is the default expected value
203 self._expect_stack.append(self._expect_api_retval)
204 self._expect_api_retval = self._zero
207 def __exit__(self, exc_type, exc_value, traceback):
208 self._expect_api_retval = self._expect_stack.pop()
210 def register_hook(self, hook):
211 """Replace hook registration with new hook
218 def collect_events(self):
219 """ Collect all events from the internal queue and clear the queue. """
221 self._events = deque()
224 def wait_for_event(self, timeout, name=None):
225 """ Wait for and return next event. """
227 self.test_class.logger.debug("Expecting event '%s' within %ss",
230 self.test_class.logger.debug("Expecting event within %ss",
233 self.test_class.logger.debug("Not waiting, event already queued")
234 limit = time.time() + timeout
235 while time.time() < limit:
237 e = self._events.popleft()
238 if name and type(e).__name__ != name:
240 "Unexpected event received: %s, expected: %s" %
241 (type(e).__name__, name))
242 self.test_class.logger.debug("Returning event %s:%s" %
245 self.test_class.sleep(0) # yield
246 raise Exception("Event did not occur within timeout")
248 def __call__(self, name, event):
249 """ Enqueue event in the internal event queue. """
250 # FIXME use the name instead of relying on type(e).__name__ ?
251 # FIXME #2 if this throws, it is eaten silently, Ole?
252 self.test_class.logger.debug("New event: %s: %s" % (name, event))
253 self._events.append(event)
255 def factory(self, name, apifn):
257 fields = apifn._func.msg.fields
259 # add positional and kw arguments
261 for i, o in enumerate(fields[3:]):
264 except BaseException:
268 if name in defaultmapping:
269 for k, v in iteritems(defaultmapping[name]):
273 return self.api(apifn, d)
277 def __getattribute__(self, name):
279 method = super(VppPapiProvider, self).__getattribute__(name)
280 except AttributeError:
281 method = self.factory(name, getattr(self.papi, name))
282 # lazily load the method so we don't need to call factory
283 # again for this name.
284 setattr(self, name, method)
288 """Connect the API to VPP"""
289 self.vpp.connect(self.name, self.shm_prefix)
290 self.papi = self.vpp.api
291 self.vpp.register_event_callback(self)
293 def disconnect(self):
294 """Disconnect the API from VPP"""
295 self.vpp.disconnect()
297 def api(self, api_fn, api_args, expected_retval=0):
298 """ Call API function and check it's return value.
299 Call the appropriate hooks before and after the API call
301 :param api_fn: API function to call
302 :param api_args: tuple of API function arguments
303 :param expected_retval: Expected return value (Default value = 0)
304 :returns: reply from the API
307 self.hook.before_api(api_fn.__name__, api_args)
308 reply = api_fn(**api_args)
309 if self._expect_api_retval == self._negative:
310 if hasattr(reply, 'retval') and reply.retval >= 0:
311 msg = "API call passed unexpectedly: expected negative " \
312 "return value instead of %d in %s" % \
313 (reply.retval, moves.reprlib.repr(reply))
314 self.test_class.logger.info(msg)
315 raise UnexpectedApiReturnValueError(msg)
316 elif self._expect_api_retval == self._zero:
317 if hasattr(reply, 'retval') and reply.retval != expected_retval:
318 msg = "API call failed, expected %d return value instead " \
319 "of %d in %s" % (expected_retval, reply.retval,
321 self.test_class.logger.info(msg)
322 raise UnexpectedApiReturnValueError(msg)
324 raise Exception("Internal error, unexpected value for "
325 "self._expect_api_retval %s" %
326 self._expect_api_retval)
327 self.hook.after_api(api_fn.__name__, api_args)
330 def cli_return_response(self, cli):
331 """ Execute a CLI, calling the before/after hooks appropriately.
332 Return the reply without examining it
334 :param cli: CLI to execute
335 :returns: response object
338 self.hook.before_cli(cli)
340 r = self.papi.cli_inband(cmd=cli)
341 self.hook.after_cli(cli)
345 """ Execute a CLI, calling the before/after hooks appropriately.
347 :param cli: CLI to execute
351 r = self.cli_return_response(cli)
353 raise CliSyntaxError(r.reply)
355 raise CliFailedCommandError(r.reply)
356 if hasattr(r, 'reply'):
359 def ppcli(self, cli):
360 """ Helper method to print CLI command in case of info logging level.
362 :param cli: CLI to execute
365 return cli + "\n" + self.cli(cli)
367 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
368 return self.api(self.papi.want_ip4_arp_events,
369 {'enable_disable': enable_disable,
371 'pid': os.getpid(), })
373 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
374 return self.api(self.papi.want_ip6_nd_events,
375 {'enable_disable': enable_disable,
377 'pid': os.getpid(), })
379 def want_ip6_ra_events(self, enable_disable=1):
380 return self.api(self.papi.want_ip6_ra_events,
381 {'enable_disable': enable_disable,
382 'pid': os.getpid(), })
384 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
386 return self.api(self.papi.ip6nd_send_router_solicitation,
391 'sw_if_index': sw_if_index})
393 def want_interface_events(self, enable_disable=1):
394 return self.api(self.papi.want_interface_events,
395 {'enable_disable': enable_disable,
396 'pid': os.getpid(), })
398 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
399 max_macs_in_event=0, learn_limit=0):
400 return self.api(self.papi.want_l2_macs_events,
401 {'enable_disable': enable_disable,
402 'scan_delay': scan_delay,
403 'max_macs_in_event': max_macs_in_event,
404 'learn_limit': learn_limit,
405 'pid': os.getpid(), })
407 def sw_interface_set_mac_address(self, sw_if_index, mac):
408 return self.api(self.papi.sw_interface_set_mac_address,
409 {'sw_if_index': sw_if_index,
412 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
413 """Create p2p ethernet subinterface
415 :param sw_if_index: main (parent) interface
416 :param remote_mac: client (remote) mac address
420 self.papi.p2p_ethernet_add,
421 {'parent_if_index': sw_if_index,
422 'remote_mac': remote_mac,
423 'subif_id': subif_id})
425 def p2p_ethernet_del(self, sw_if_index, remote_mac):
426 """Delete p2p ethernet subinterface
428 :param sw_if_index: main (parent) interface
429 :param remote_mac: client (remote) mac address
433 self.papi.p2p_ethernet_del,
434 {'parent_if_index': sw_if_index,
435 'remote_mac': remote_mac})
437 def create_vlan_subif(self, sw_if_index, vlan):
444 return self.api(self.papi.create_vlan_subif,
445 {'sw_if_index': sw_if_index,
448 def create_loopback(self, mac=''):
451 :param mac: (Optional)
453 return self.api(self.papi.create_loopback,
454 {'mac_address': mac})
456 def ip_route_dump(self, table_id, is_ip6=False):
457 return self.api(self.papi.ip_route_dump,
459 'table_id': table_id,
463 def ip_neighbor_add_del(self,
469 """ Add neighbor MAC to IPv4 or IPv6 address.
474 :param is_add: (Default value = 1)
475 :param flags: (Default value = 0/NONE)
478 self.papi.ip_neighbor_add_del,
482 'sw_if_index': sw_if_index,
484 'mac_address': mac_address,
485 'ip_address': ip_address
490 def proxy_arp_add_del(self,
495 """ Config Proxy Arp Range.
497 :param low_address: Start address in the rnage to Proxy for
498 :param hi_address: End address in the rnage to Proxy for
499 :param vrf_id: The VRF/table in which to proxy
503 self.papi.proxy_arp_add_del,
506 'table_id': table_id,
512 def proxy_arp_intfc_enable_disable(self,
515 """ Enable/Disable an interface for proxy ARP requests
517 :param sw_if_index: Interface
518 :param enable_disable: Enable/Disable
522 self.papi.proxy_arp_intfc_enable_disable,
523 {'sw_if_index': sw_if_index,
524 'enable_disable': is_enable
528 def gre_tunnel_add_del(self,
541 :param outer_fib_id: (Default value = 0)
542 :param tunnel_type: (Default value = 0)
543 :param instance: (Default value = 0xFFFFFFFF)
544 :param session_id: (Default value = 0)
545 :param is_add: (Default value = 1)
546 :param is_ipv6: (Default value = 0)
550 self.papi.gre_tunnel_add_del,
556 'instance': instance,
559 'outer_table_id': outer_table_id,
560 'session_id': session_id}
564 def udp_encap_add(self,
575 :param outer_fib_id: (Default value = 0)
579 self.papi.udp_encap_add,
584 'src_port': src_port,
585 'dst_port': dst_port,
590 def udp_encap_del(self, id):
591 return self.api(self.papi.udp_encap_del, {'id': id})
593 def udp_encap_dump(self):
594 return self.api(self.papi.udp_encap_dump, {})
596 def want_udp_encap_stats(self, enable=1):
597 return self.api(self.papi.want_udp_encap_stats,
601 def mpls_route_dump(self, table_id):
602 return self.api(self.papi.mpls_route_dump,
604 'mt_table_id': table_id
607 def mpls_table_dump(self):
608 return self.api(self.papi.mpls_table_dump, {})
610 def mpls_table_add_del(
617 :param is_add: (Default value = 1)
622 self.papi.mpls_table_add_del,
625 'mt_table_id': table_id,
627 'mt_is_add': is_add})
629 def mpls_route_add_del(self,
638 """ MPLS Route add/del """
640 self.papi.mpls_route_add_del,
643 'mr_table_id': table_id,
646 'mr_eos_proto': eos_proto,
647 'mr_is_multicast': is_multicast,
648 'mr_n_paths': len(paths),
652 'mr_is_multipath': is_multipath})
654 def mpls_ip_bind_unbind(
664 self.papi.mpls_ip_bind_unbind,
665 {'mb_mpls_table_id': table_id,
667 'mb_ip_table_id': ip_table_id,
668 'mb_is_bind': is_bind,
669 'mb_prefix': prefix})
671 def mpls_tunnel_add_del(
681 self.papi.mpls_tunnel_add_del,
682 {'mt_is_add': is_add,
685 'mt_sw_if_index': tun_sw_if_index,
686 'mt_l2_only': l2_only,
687 'mt_is_multicast': is_multicast,
688 'mt_n_paths': len(paths),
692 def input_acl_set_interface(
696 ip4_table_index=0xFFFFFFFF,
697 ip6_table_index=0xFFFFFFFF,
698 l2_table_index=0xFFFFFFFF):
702 :param ip4_table_index: (Default value = 0xFFFFFFFF)
703 :param ip6_table_index: (Default value = 0xFFFFFFFF)
704 :param l2_table_index: (Default value = 0xFFFFFFFF)
708 self.papi.input_acl_set_interface,
709 {'sw_if_index': sw_if_index,
710 'ip4_table_index': ip4_table_index,
711 'ip6_table_index': ip6_table_index,
712 'l2_table_index': l2_table_index,
715 def output_acl_set_interface(
719 ip4_table_index=0xFFFFFFFF,
720 ip6_table_index=0xFFFFFFFF,
721 l2_table_index=0xFFFFFFFF):
725 :param ip4_table_index: (Default value = 0xFFFFFFFF)
726 :param ip6_table_index: (Default value = 0xFFFFFFFF)
727 :param l2_table_index: (Default value = 0xFFFFFFFF)
731 self.papi.output_acl_set_interface,
732 {'sw_if_index': sw_if_index,
733 'ip4_table_index': ip4_table_index,
734 'ip6_table_index': ip6_table_index,
735 'l2_table_index': l2_table_index,
738 def set_ipfix_exporter(
748 self.papi.set_ipfix_exporter,
750 'collector_address': collector_address,
751 'collector_port': collector_port,
752 'src_address': src_address,
754 'path_mtu': path_mtu,
755 'template_interval': template_interval,
756 'udp_checksum': udp_checksum,
759 def ip_mroute_add_del(self,
768 IP Multicast Route add/del
771 self.papi.ip_mroute_add_del,
774 'is_multipath': is_multipath,
776 'table_id': table_id,
777 'entry_flags': e_flags,
780 'n_paths': len(paths),
785 def mfib_signal_dump(self):
786 return self.api(self.papi.mfib_signal_dump, {})
788 def ip_mroute_dump(self, table_id, is_ip6=False):
789 return self.api(self.papi.ip_mroute_dump,
791 'table_id': table_id,
795 def lisp_enable_disable(self, is_enabled):
797 self.papi.lisp_enable_disable,
802 def lisp_add_del_locator_set(self,
806 self.papi.lisp_add_del_locator_set,
809 'locator_set_name': ls_name
812 def lisp_add_del_locator(self,
819 self.papi.lisp_add_del_locator,
822 'locator_set_name': ls_name,
823 'sw_if_index': sw_if_index,
824 'priority': priority,
828 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
830 self.papi.lisp_locator_dump,
832 'is_index_set': is_index_set,
834 'ls_index': ls_index,
837 def lisp_add_del_local_eid(self,
847 self.papi.lisp_add_del_local_eid,
849 'locator_set_name': ls_name,
851 'eid_type': eid_type,
853 'prefix_len': prefix_len,
859 def lisp_eid_table_dump(self,
867 self.papi.lisp_eid_table_dump,
870 'prefix_length': prefix_length,
872 'eid_type': eid_type,
874 'filter': filter_opt,
877 def lisp_add_del_remote_mapping(self,
887 self.papi.lisp_add_del_remote_mapping,
890 'eid_type': eid_type,
892 'eid_len': eid_prefix_len,
893 'rloc_num': rlocs_num,
896 'is_src_dst': is_src_dst,
899 def lisp_add_del_adjacency(self,
908 self.papi.lisp_add_del_adjacency,
912 'eid_type': eid_type,
915 'leid_len': leid_len,
916 'reid_len': reid_len,
919 def vxlan_gpe_add_del_tunnel(
923 mcast_sw_if_index=0xFFFFFFFF,
934 :param is_add: (Default value = 1)
935 :param is_ipv6: (Default value = 0)
936 :param encap_vrf_id: (Default value = 0)
937 :param decap_vrf_id: (Default value = 0)
938 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
939 :param protocol: (Default value = 3)
940 :param vni: (Default value = 0)
943 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
948 'mcast_sw_if_index': mcast_sw_if_index,
949 'encap_vrf_id': encap_vrf_id,
950 'decap_vrf_id': decap_vrf_id,
951 'protocol': protocol,
954 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
955 return self.api(self.papi.vxlan_gbp_tunnel_dump,
956 {'sw_if_index': sw_if_index})
958 def pppoe_add_del_session(
967 :param is_add: (Default value = 1)
968 :param is_ipv6: (Default value = 0)
970 :param session_id: (Default value = 0)
972 :param decap_vrf_id: (Default value = 0)
975 return self.api(self.papi.pppoe_add_del_session,
977 'session_id': session_id,
978 'client_ip': client_ip,
979 'decap_vrf_id': decap_vrf_id,
980 'client_mac': client_mac})
982 def sr_mpls_policy_add(self, bsid, weight, type, segments):
983 return self.api(self.papi.sr_mpls_policy_add,
987 'n_segments': len(segments),
988 'segments': segments})
990 def sr_mpls_policy_del(self, bsid):
991 return self.api(self.papi.sr_mpls_policy_del,
994 def sr_localsid_add_del(self,
1001 sw_if_index=0xFFFFFFFF,
1005 """ Add/del IPv6 SR local-SID.
1008 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1009 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1012 :param is_del: (Default value = 0)
1013 :param end_psp: (Default value = 0)
1014 :param sw_if_index: (Default value = 0xFFFFFFFF)
1015 :param vlan_index: (Default value = 0)
1016 :param fib_table: (Default value = 0)
1019 self.papi.sr_localsid_add_del,
1021 'localsid': localsid,
1023 'behavior': behavior,
1024 'sw_if_index': sw_if_index,
1025 'vlan_index': vlan_index,
1026 'fib_table': fib_table,
1027 'nh_addr4': nh_addr4,
1028 'nh_addr6': nh_addr6
1042 :param bsid_addr: bindingSID of the SR Policy
1043 :param weight: weight of the sid list. optional. (default: 1)
1044 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1046 :param type: type/behavior of the SR policy. (default or spray) \
1048 :param fib_table: VRF where to install the FIB entry for the BSID \
1050 :param n_segments: number of segments \
1052 :param segments: a vector of IPv6 address composing the segment list \
1056 self.papi.sr_policy_add,
1057 {'bsid_addr': bsid_addr,
1059 'is_encap': is_encap,
1061 'fib_table': fib_table,
1062 'n_segments': n_segments,
1063 'segments': segments
1072 :param bsid: bindingSID of the SR Policy
1073 :param sr_policy_index: index of the sr policy (default: 0)
1076 self.papi.sr_policy_del,
1077 {'bsid_addr': bsid_addr,
1078 'sr_policy_index': sr_policy_index
1081 def sr_steering_add_del(
1092 Steer traffic L2 and L3 traffic through a given SR policy
1094 :param is_del: delete or add
1095 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1096 :param sr_policy: is the index of the SR Policy (alt to bsid)
1097 :param table_id: is the VRF where to install the FIB entry for the BSID
1098 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1099 :param mask_width: is the mask for L3 traffic type
1100 :param sw_if_index: is the incoming interface for L2 traffic
1101 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1104 self.papi.sr_steering_add_del,
1106 'bsid_addr': bsid_addr,
1107 'sr_policy_index': sr_policy_index,
1108 'table_id': table_id,
1109 'prefix_addr': prefix_addr,
1110 'mask_width': mask_width,
1111 'sw_if_index': sw_if_index,
1112 'traffic_type': traffic_type
1115 def acl_add_replace(self, acl_index, r, tag='',
1117 """Add/replace an ACL
1118 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1119 :param acl_rule r: ACL rules array.
1120 :param str tag: symbolic tag (description) for this ACL.
1121 :param int count: number of rules.
1123 return self.api(self.papi.acl_add_replace,
1124 {'acl_index': acl_index,
1128 expected_retval=expected_retval)
1130 def acl_del(self, acl_index, expected_retval=0):
1136 return self.api(self.papi.acl_del,
1137 {'acl_index': acl_index},
1138 expected_retval=expected_retval)
1140 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1142 return self.api(self.papi.acl_interface_set_acl_list,
1143 {'sw_if_index': sw_if_index,
1147 expected_retval=expected_retval)
1149 def acl_interface_set_etype_whitelist(self, sw_if_index,
1152 return self.api(self.papi.acl_interface_set_etype_whitelist,
1153 {'sw_if_index': sw_if_index,
1154 'count': len(whitelist),
1156 'whitelist': whitelist},
1157 expected_retval=expected_retval)
1159 def acl_interface_add_del(self,
1163 """ Add/Delete ACL to/from interface
1167 :param is_add: (Default value = 1)
1170 return self.api(self.papi.acl_interface_add_del,
1173 'sw_if_index': sw_if_index,
1174 'acl_index': acl_index})
1176 def acl_dump(self, acl_index, expected_retval=0):
1177 return self.api(self.papi.acl_dump,
1178 {'acl_index': acl_index},
1179 expected_retval=expected_retval)
1181 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1183 return self.api(self.papi.acl_interface_list_dump,
1184 {'sw_if_index': sw_if_index},
1185 expected_retval=expected_retval)
1187 def macip_acl_add(self, rules, tag=""):
1190 :param rules: list of rules for given acl
1194 return self.api(self.papi.macip_acl_add,
1196 'count': len(rules),
1199 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1202 :param rules: list of rules for given acl
1206 return self.api(self.papi.macip_acl_add_replace,
1207 {'acl_index': acl_index,
1209 'count': len(rules),
1212 def macip_acl_interface_add_del(self,
1216 """ Add MACIP acl to interface
1220 :param is_add: (Default value = 1)
1223 return self.api(self.papi.macip_acl_interface_add_del,
1225 'sw_if_index': sw_if_index,
1226 'acl_index': acl_index})
1228 def macip_acl_dump(self, acl_index=4294967295):
1229 """ Return MACIP acl dump
1233 self.papi.macip_acl_dump, {'acl_index': acl_index})
1235 def policer_add_del(self,
1246 conform_action_type=1,
1248 exceed_action_type=0,
1250 violate_action_type=0,
1252 return self.api(self.papi.policer_add_del,
1259 'rate_type': rate_type,
1260 'round_type': round_type,
1262 'color_aware': color_aware,
1263 'conform_action_type': conform_action_type,
1264 'conform_dscp': conform_dscp,
1265 'exceed_action_type': exceed_action_type,
1266 'exceed_dscp': exceed_dscp,
1267 'violate_action_type': violate_action_type,
1268 'violate_dscp': violate_dscp})
1270 def ip_punt_police(self,
1274 return self.api(self.papi.ip_punt_police,
1275 {'policer_index': policer_index,
1279 def ip_punt_redirect(self,
1284 return self.api(self.papi.ip_punt_redirect,
1285 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1286 'tx_sw_if_index': tx_sw_if_index,
1290 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1291 return self.api(self.papi.ip_punt_redirect_dump,
1292 {'sw_if_index': sw_if_index,
1293 'is_ipv6': is_ipv6})
1295 def bier_table_add_del(self,
1299 """ BIER Table add/del """
1301 self.papi.bier_table_add_del,
1302 {'bt_tbl_id': {"bt_set": bti.set_id,
1303 "bt_sub_domain": bti.sub_domain_id,
1304 "bt_hdr_len_id": bti.hdr_len_id},
1305 'bt_label': mpls_label,
1306 'bt_is_add': is_add})
1308 def bier_table_dump(self):
1309 return self.api(self.papi.bier_table_dump, {})
1311 def bier_route_add_del(self,
1317 """ BIER Route add/del """
1319 self.papi.bier_route_add_del,
1322 'br_tbl_id': {"bt_set": bti.set_id,
1323 "bt_sub_domain": bti.sub_domain_id,
1324 "bt_hdr_len_id": bti.hdr_len_id},
1326 'br_n_paths': len(paths),
1329 'br_is_add': is_add,
1330 'br_is_replace': is_replace
1333 def bier_route_dump(self, bti):
1335 self.papi.bier_route_dump,
1336 {'br_tbl_id': {"bt_set": bti.set_id,
1337 "bt_sub_domain": bti.sub_domain_id,
1338 "bt_hdr_len_id": bti.hdr_len_id}})
1340 def bier_imp_add(self,
1345 """ BIER Imposition Add """
1347 self.papi.bier_imp_add,
1348 {'bi_tbl_id': {"bt_set": bti.set_id,
1349 "bt_sub_domain": bti.sub_domain_id,
1350 "bt_hdr_len_id": bti.hdr_len_id},
1352 'bi_n_bytes': len(ibytes),
1353 'bi_bytes': ibytes})
1355 def bier_imp_del(self, bi_index):
1356 """ BIER Imposition del """
1358 self.papi.bier_imp_del,
1359 {'bi_index': bi_index})
1361 def bier_imp_dump(self):
1362 return self.api(self.papi.bier_imp_dump, {})
1364 def bier_disp_table_add_del(self,
1367 """ BIER Disposition Table add/del """
1369 self.papi.bier_disp_table_add_del,
1370 {'bdt_tbl_id': bdti,
1371 'bdt_is_add': is_add})
1373 def bier_disp_table_dump(self):
1374 return self.api(self.papi.bier_disp_table_dump, {})
1376 def bier_disp_entry_add_del(self,
1386 """ BIER Route add/del """
1388 while (len(lstack) < 16):
1391 self.papi.bier_disp_entry_add_del,
1392 {'bde_tbl_id': bdti,
1394 'bde_payload_proto': payload_proto,
1396 'bde_paths': [{'table_id': next_hop_tbl_id,
1397 'rpf_id': next_hop_rpf_id,
1399 'label_stack': lstack}],
1400 'bde_is_add': is_add})
1402 def bier_disp_entry_dump(self, bdti):
1404 self.papi.bier_disp_entry_dump,
1405 {'bde_tbl_id': bdti})
1407 def session_enable_disable(self, is_enabled):
1409 self.papi.session_enable_disable,
1410 {'is_enable': is_enabled})
1412 def ipsec_spd_add_del(self, spd_id, is_add=1):
1413 """ SPD add/del - Wrapper to add or del ipsec SPD
1414 Sample CLI : 'ipsec spd add 1'
1416 :param spd_id - SPD ID to be created in the vpp . mandatory
1417 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1419 :returns: reply from the API
1422 self.papi.ipsec_spd_add_del, {
1423 'spd_id': spd_id, 'is_add': is_add})
1425 def ipsec_spds_dump(self):
1426 return self.api(self.papi.ipsec_spds_dump, {})
1428 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1429 """ IPSEC interface SPD add/del - \
1430 Wrapper to associate/disassociate SPD to interface in VPP
1431 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1433 :param spd_id - SPD ID to associate with the interface . mandatory
1434 :param sw_if_index - Interface Index which needs to ipsec \
1435 association mandatory
1436 :param is_add - add(1) or del(0) association with interface \
1437 (Default 1 - add) . optional
1438 :returns: reply from the API
1441 self.papi.ipsec_interface_add_del_spd,
1442 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1444 def ipsec_spd_interface_dump(self, spd_index=None):
1445 return self.api(self.papi.ipsec_spd_interface_dump,
1446 {'spd_index': spd_index if spd_index else 0,
1447 'spd_index_valid': 1 if spd_index else 0})
1449 def ipsec_sad_entry_add_del(self,
1452 integrity_algorithm,
1457 tunnel_src_address='',
1458 tunnel_dst_address='',
1462 """ IPSEC SA add/del
1463 :param sad_id: security association ID
1464 :param spi: security param index of the SA in decimal
1465 :param integrity_algorithm:
1466 :param integrity_key:
1467 :param crypto_algorithm:
1469 :param protocol: AH(0) or ESP(1) protocol
1470 :param tunnel_src_address: tunnel mode outer src address
1471 :param tunnel_dst_address: tunnel mode outer dst address
1474 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1475 crypto and ipsec algorithms
1478 self.papi.ipsec_sad_entry_add_del,
1485 'tunnel_src': tunnel_src_address,
1486 'tunnel_dst': tunnel_dst_address,
1487 'protocol': protocol,
1488 'integrity_algorithm': integrity_algorithm,
1490 'length': len(integrity_key),
1491 'data': integrity_key,
1493 'crypto_algorithm': crypto_algorithm,
1495 'length': len(crypto_key),
1503 def ipsec_sa_dump(self, sa_id=None):
1504 return self.api(self.papi.ipsec_sa_dump,
1505 {'sa_id': sa_id if sa_id else 0xffffffff})
1507 def ipsec_spd_entry_add_del(self,
1510 local_address_start,
1512 remote_address_start,
1513 remote_address_stop,
1515 local_port_stop=65535,
1516 remote_port_start=0,
1517 remote_port_stop=65535,
1525 """ IPSEC policy SPD add/del -
1526 Wrapper to configure ipsec SPD policy entries in VPP
1527 :param spd_id: SPD ID for the policy
1528 :param local_address_start: local-ip-range start address
1529 :param local_address_stop : local-ip-range stop address
1530 :param remote_address_start: remote-ip-range start address
1531 :param remote_address_stop : remote-ip-range stop address
1532 :param local_port_start: (Default value = 0)
1533 :param local_port_stop: (Default value = 65535)
1534 :param remote_port_start: (Default value = 0)
1535 :param remote_port_stop: (Default value = 65535)
1536 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1537 :param sa_id: Security Association ID for mapping it to SPD
1538 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1540 :param priority: value for the spd action (Default value = 100)
1541 :param is_outbound: flag for inbound(0) or outbound(1)
1543 :param is_add: (Default value = 1)
1546 self.papi.ipsec_spd_entry_add_del,
1553 'local_address_start': local_address_start,
1554 'local_address_stop': local_address_stop,
1555 'remote_address_start': remote_address_start,
1556 'remote_address_stop': remote_address_stop,
1557 'local_port_start': local_port_start,
1558 'local_port_stop': local_port_stop,
1559 'remote_port_start': remote_port_start,
1560 'remote_port_stop': remote_port_stop,
1561 'protocol': protocol,
1563 'priority': priority,
1564 'is_outbound': is_outbound,
1568 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1569 return self.api(self.papi.ipsec_spd_dump,
1573 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1574 remote_spi, crypto_alg, local_crypto_key,
1575 remote_crypto_key, integ_alg, local_integ_key,
1576 remote_integ_key, is_add=1, esn=0, salt=0,
1577 anti_replay=1, renumber=0,
1578 udp_encap=0, show_instance=0xffffffff):
1580 self.papi.ipsec_tunnel_if_add_del,
1582 'local_ip': local_ip,
1583 'remote_ip': remote_ip,
1584 'local_spi': local_spi,
1585 'remote_spi': remote_spi,
1586 'crypto_alg': crypto_alg,
1587 'local_crypto_key_len': len(local_crypto_key),
1588 'local_crypto_key': local_crypto_key,
1589 'remote_crypto_key_len': len(remote_crypto_key),
1590 'remote_crypto_key': remote_crypto_key,
1591 'integ_alg': integ_alg,
1592 'local_integ_key_len': len(local_integ_key),
1593 'local_integ_key': local_integ_key,
1594 'remote_integ_key_len': len(remote_integ_key),
1595 'remote_integ_key': remote_integ_key,
1598 'anti_replay': anti_replay,
1599 'renumber': renumber,
1600 'show_instance': show_instance,
1601 'udp_encap': udp_encap,
1605 def ipsec_select_backend(self, protocol, index):
1606 return self.api(self.papi.ipsec_select_backend,
1607 {'protocol': protocol, 'index': index})
1609 def ipsec_backend_dump(self):
1610 return self.api(self.papi.ipsec_backend_dump, {})
1612 def app_namespace_add_del(self,
1616 sw_if_index=0xFFFFFFFF,
1619 self.papi.app_namespace_add_del,
1621 'sw_if_index': sw_if_index,
1622 'ip4_fib_id': ip4_fib_id,
1623 'ip6_fib_id': ip6_fib_id,
1624 'namespace_id': namespace_id,
1625 'namespace_id_len': len(namespace_id)})
1627 def punt_socket_register(self, reg, pathname,
1629 """ Register punt socket """
1630 return self.api(self.papi.punt_socket_register,
1631 {'header_version': header_version,
1633 'pathname': pathname})
1635 def punt_socket_deregister(self, reg):
1636 """ Unregister punt socket """
1637 return self.api(self.papi.punt_socket_deregister,
1640 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1642 """ GBP endpoint Add """
1643 return self.api(self.papi.gbp_endpoint_add,
1645 'sw_if_index': sw_if_index,
1656 def gbp_endpoint_del(self, handle):
1657 """ GBP endpoint Del """
1658 return self.api(self.papi.gbp_endpoint_del,
1661 def gbp_endpoint_dump(self):
1662 """ GBP endpoint Dump """
1663 return self.api(self.papi.gbp_endpoint_dump, {})
1665 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1666 rd, uplink_sw_if_index,
1668 """ GBP endpoint group Add """
1669 return self.api(self.papi.gbp_endpoint_group_add,
1672 'uplink_sw_if_index': uplink_sw_if_index,
1677 'retention': retention
1680 def gbp_endpoint_group_del(self, sclass):
1681 """ GBP endpoint group Del """
1682 return self.api(self.papi.gbp_endpoint_group_del,
1685 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1688 bm_flood_sw_if_index):
1689 """ GBP bridge-domain Add """
1690 return self.api(self.papi.gbp_bridge_domain_add,
1694 'bvi_sw_if_index': bvi_sw_if_index,
1695 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1696 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1701 def gbp_bridge_domain_del(self, bd_id):
1702 """ GBP bridge-domain Del """
1703 return self.api(self.papi.gbp_bridge_domain_del,
1706 def gbp_route_domain_add(self, rd_id,
1711 ip6_uu_sw_if_index):
1712 """ GBP route-domain Add """
1713 return self.api(self.papi.gbp_route_domain_add,
1717 'ip4_table_id': ip4_table_id,
1718 'ip6_table_id': ip6_table_id,
1719 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1720 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1724 def gbp_route_domain_del(self, rd_id):
1725 """ GBP route-domain Del """
1726 return self.api(self.papi.gbp_route_domain_del,
1729 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1730 """ GBP recirc Add/Del """
1731 return self.api(self.papi.gbp_recirc_add_del,
1735 'sw_if_index': sw_if_index,
1738 def gbp_recirc_dump(self):
1739 """ GBP recirc Dump """
1740 return self.api(self.papi.gbp_recirc_dump, {})
1742 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1743 """ GBP recirc Add/Del """
1744 return self.api(self.papi.gbp_ext_itf_add_del,
1747 'sw_if_index': sw_if_index,
1752 def gbp_ext_itf_dump(self):
1753 """ GBP recirc Dump """
1754 return self.api(self.papi.gbp_ext_itf_dump, {})
1756 def gbp_subnet_add_del(self, is_add, rd_id,
1758 sw_if_index=0xffffffff,
1760 """ GBP Subnet Add/Del """
1761 return self.api(self.papi.gbp_subnet_add_del,
1765 'sw_if_index': sw_if_index,
1770 def gbp_subnet_dump(self):
1771 """ GBP Subnet Dump """
1772 return self.api(self.papi.gbp_subnet_dump, {})
1774 def gbp_contract_dump(self):
1775 """ GBP contract Dump """
1776 return self.api(self.papi.gbp_contract_dump, {})
1778 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1779 """ GBP VXLAN tunnel add """
1780 return self.api(self.papi.gbp_vxlan_tunnel_add,
1785 'bd_rd_id': bd_rd_id,
1790 def gbp_vxlan_tunnel_del(self, vni):
1791 """ GBP VXLAN tunnel del """
1792 return self.api(self.papi.gbp_vxlan_tunnel_del,
1797 def gbp_vxlan_tunnel_dump(self):
1798 """ GBP VXLAN tunnel add/del """
1799 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1801 def igmp_enable_disable(self, sw_if_index, enable, host):
1802 """ Enable/disable IGMP on a given interface """
1803 return self.api(self.papi.igmp_enable_disable,
1806 'sw_if_index': sw_if_index})
1808 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1809 """ Add/del IGMP proxy device """
1810 return self.api(self.papi.igmp_proxy_device_add_del,
1811 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1814 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1815 """ Add/del interface to/from IGMP proxy device """
1816 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1817 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1820 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1821 """ Listen for new (S,G) on specified interface
1823 :param enable: add/del
1824 :param sw_if_index: interface sw index
1825 :param saddr: source ip4 addr
1826 :param gaddr: group ip4 addr
1828 return self.api(self.papi.igmp_listen,
1833 'sw_if_index': sw_if_index,
1834 'n_srcs': len(saddrs),
1840 def igmp_clear_interface(self, sw_if_index):
1841 """ Remove all (S,G)s from specified interface
1842 doesn't send IGMP report!
1845 self.papi.igmp_clear_interface, {
1846 'sw_if_index': sw_if_index})
1848 def want_igmp_events(self, enable=1):
1849 return self.api(self.papi.want_igmp_events, {'enable': enable,
1850 'pid': os.getpid()})
1859 interface_id=0xFFFFFFFF):
1862 :param lb: load balance
1863 :param numa_only: tx on local numa node for lacp mode
1864 :param use_custom_mac: use custom mac
1865 :param mac_address: mac address
1866 :param interface_id: custom interface ID
1869 self.papi.bond_create,
1872 'numa_only': numa_only,
1873 'use_custom_mac': use_custom_mac,
1874 'mac_address': mac_address,
1878 def pipe_delete(self, parent_sw_if_index):
1879 return self.api(self.papi.pipe_delete,
1880 {'parent_sw_if_index': parent_sw_if_index})
1882 def svs_table_add_del(self, af, table_id, is_add=1):
1883 return self.api(self.papi.svs_table_add_del,
1885 'table_id': table_id,
1890 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
1891 return self.api(self.papi.svs_route_add_del,
1893 'table_id': table_id,
1894 'source_table_id': src_table_id,
1899 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
1900 return self.api(self.papi.svs_enable_disable,
1903 'table_id': table_id,
1904 'sw_if_index': sw_if_index,
1905 'is_enable': is_enable,
1908 def feature_gso_enable_disable(self, sw_if_index, enable_disable=1):
1909 return self.api(self.papi.feature_gso_enable_disable,
1911 'sw_if_index': sw_if_index,
1912 'enable_disable': enable_disable,