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 'input_acl_set_interface': {'ip4_table_index': 4294967295,
49 'ip6_table_index': 4294967295,
50 'l2_table_index': 4294967295, },
51 'ip6_add_del_address_using_prefix': {'is_add': 1, },
52 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
53 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
54 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
55 'classify_table_index': 4294967295, 'is_add': 1, },
56 'ip_mroute_add_del': {'is_add': 1, },
57 'ip_neighbor_add_del': {'is_add': 1, },
58 'ip_punt_police': {'is_add': 1, },
59 'ip_punt_redirect': {'is_add': 1, },
60 'ip_route_add_del': {'is_add': 1, },
61 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
62 'ipsec_interface_add_del_spd': {'is_add': 1, },
63 'ipsec_sad_entry_add_del': {'is_add': 1, },
64 'ipsec_spd_add_del': {'is_add': 1, },
65 'ipsec_spd_dump': {'sa_id': 4294967295, },
66 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
67 'remote_port_stop': 65535, 'priority': 100,
70 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
71 'l2_emulation': {'enable': 1, },
72 'l2fib_add_del': {'is_add': 1, },
73 'lb_conf': {'sticky_buckets_per_core': 4294967295,
74 'flow_timeout': 4294967295},
75 'lisp_add_del_adjacency': {'is_add': 1, },
76 'lisp_add_del_local_eid': {'is_add': 1, },
77 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
78 'lisp_add_del_locator_set': {'is_add': 1, },
79 'lisp_add_del_remote_mapping': {'is_add': 1, },
80 'macip_acl_add_replace': {'acl_index': 4294967295, },
81 'macip_acl_dump': {'acl_index': 4294967295, },
82 'macip_acl_interface_add_del': {'is_add': 1, },
83 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
84 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
85 'mr_next_hop_weight': 1,
86 'mr_next_hop_via_label': 1048576,
88 'mr_classify_table_index': 4294967295, },
89 'mpls_table_add_del': {'is_add': 1, },
90 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
92 'next_hop_via_label': 1048576,
94 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
95 'output_acl_set_interface': {'ip4_table_index': 4294967295,
96 'ip6_table_index': 4294967295,
97 'l2_table_index': 4294967295, },
98 'pppoe_add_del_session': {'is_add': 1, },
99 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
100 'proxy_arp_add_del': {'is_add': 1, },
101 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
102 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
104 'set_ipfix_exporter': {'collector_port': 4739, },
105 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
106 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
107 'svs_enable_disable': {'is_enable': 1, },
108 'svs_route_add_del': {'is_add': 1, },
109 'svs_table_add_del': {'is_add': 1, },
110 'sw_interface_add_del_address': {'is_add': 1, },
111 'sw_interface_dump': {'sw_if_index': 4294967295, },
112 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
113 'pref_lifetime': 4294967295, },
114 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
115 'sw_interface_set_l2_bridge': {'enable': 1, },
116 'sw_interface_set_mpls_enable': {'enable': 1, },
117 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
118 'sw_interface_set_unnumbered': {'is_add': 1, },
119 'sw_interface_span_enable_disable': {'state': 1, },
120 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
121 'decap_next_index': 4294967295,
122 'instance': 4294967295, },
123 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
124 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
126 'want_bfd_events': {'enable_disable': 1, },
127 'want_igmp_events': {'enable': 1, },
128 'want_interface_events': {'enable_disable': 1, },
129 'want_l2_macs_events': {'enable_disable': 1, },
133 class CliFailedCommandError(Exception):
134 """ cli command failed."""
137 class CliSyntaxError(Exception):
138 """ cli command had a syntax error."""
141 class UnexpectedApiReturnValueError(Exception):
142 """ exception raised when the API return value is unexpected """
146 class VppPapiProvider(object):
147 """VPP-api provider using vpp-papi
149 @property hook: hook object providing before and after api/cli hooks
152 _zero, _negative = range(2)
154 def __init__(self, name, shm_prefix, test_class, read_timeout):
155 self.hook = Hook(test_class)
157 self.shm_prefix = shm_prefix
158 self.test_class = test_class
159 self._expect_api_retval = self._zero
160 self._expect_stack = []
162 # install_dir is a class attribute. We need to set it before
163 # calling the constructor.
164 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
168 if os.environ['SOCKET'] == '1':
173 self.vpp = VPPApiClient(logger=test_class.logger,
174 read_timeout=read_timeout,
175 use_socket=use_socket,
176 server_address=test_class.api_sock)
177 self._events = deque()
182 def assert_negative_api_retval(self):
183 """ Expect API failure - used with with, e.g.:
184 with self.vapi.assert_negative_api_retval():
185 self.vapi.<api call expected to fail>
187 self._expect_stack.append(self._expect_api_retval)
188 self._expect_api_retval = self._negative
191 def assert_zero_api_retval(self):
192 """ Expect API success - used with with, e.g.:
193 with self.vapi.assert_negative_api_retval():
194 self.vapi.<api call expected to succeed>
196 note: this is useful only inside another with block
197 as success is the default expected value
199 self._expect_stack.append(self._expect_api_retval)
200 self._expect_api_retval = self._zero
203 def __exit__(self, exc_type, exc_value, traceback):
204 self._expect_api_retval = self._expect_stack.pop()
206 def register_hook(self, hook):
207 """Replace hook registration with new hook
214 def collect_events(self):
215 """ Collect all events from the internal queue and clear the queue. """
217 self._events = deque()
220 def wait_for_event(self, timeout, name=None):
221 """ Wait for and return next event. """
223 self.test_class.logger.debug("Expecting event '%s' within %ss",
226 self.test_class.logger.debug("Expecting event within %ss",
229 self.test_class.logger.debug("Not waiting, event already queued")
230 limit = time.time() + timeout
231 while time.time() < limit:
233 e = self._events.popleft()
234 if name and type(e).__name__ != name:
236 "Unexpected event received: %s, expected: %s" %
237 (type(e).__name__, name))
238 self.test_class.logger.debug("Returning event %s:%s" %
241 self.test_class.sleep(0) # yield
242 raise Exception("Event did not occur within timeout")
244 def __call__(self, name, event):
245 """ Enqueue event in the internal event queue. """
246 # FIXME use the name instead of relying on type(e).__name__ ?
247 # FIXME #2 if this throws, it is eaten silently, Ole?
248 self.test_class.logger.debug("New event: %s: %s" % (name, event))
249 self._events.append(event)
251 def factory(self, name, apifn):
253 fields = apifn._func.msg.fields
255 # add positional and kw arguments
257 for i, o in enumerate(fields[3:]):
260 except BaseException:
264 if name in defaultmapping:
265 for k, v in iteritems(defaultmapping[name]):
269 return self.api(apifn, d)
273 def __getattribute__(self, name):
275 method = super(VppPapiProvider, self).__getattribute__(name)
276 except AttributeError:
277 method = self.factory(name, getattr(self.papi, name))
278 # lazily load the method so we don't need to call factory
279 # again for this name.
280 setattr(self, name, method)
284 """Connect the API to VPP"""
285 self.vpp.connect(self.name, self.shm_prefix)
286 self.papi = self.vpp.api
287 self.vpp.register_event_callback(self)
289 def disconnect(self):
290 """Disconnect the API from VPP"""
291 self.vpp.disconnect()
293 def api(self, api_fn, api_args, expected_retval=0):
294 """ Call API function and check it's return value.
295 Call the appropriate hooks before and after the API call
297 :param api_fn: API function to call
298 :param api_args: tuple of API function arguments
299 :param expected_retval: Expected return value (Default value = 0)
300 :returns: reply from the API
303 self.hook.before_api(api_fn.__name__, api_args)
304 reply = api_fn(**api_args)
305 if self._expect_api_retval == self._negative:
306 if hasattr(reply, 'retval') and reply.retval >= 0:
307 msg = "API call passed unexpectedly: expected negative " \
308 "return value instead of %d in %s" % \
309 (reply.retval, moves.reprlib.repr(reply))
310 self.test_class.logger.info(msg)
311 raise UnexpectedApiReturnValueError(msg)
312 elif self._expect_api_retval == self._zero:
313 if hasattr(reply, 'retval') and reply.retval != expected_retval:
314 msg = "API call failed, expected %d return value instead " \
315 "of %d in %s" % (expected_retval, reply.retval,
317 self.test_class.logger.info(msg)
318 raise UnexpectedApiReturnValueError(msg)
320 raise Exception("Internal error, unexpected value for "
321 "self._expect_api_retval %s" %
322 self._expect_api_retval)
323 self.hook.after_api(api_fn.__name__, api_args)
326 def cli_return_response(self, cli):
327 """ Execute a CLI, calling the before/after hooks appropriately.
328 Return the reply without examining it
330 :param cli: CLI to execute
331 :returns: response object
334 self.hook.before_cli(cli)
336 r = self.papi.cli_inband(cmd=cli)
337 self.hook.after_cli(cli)
341 """ Execute a CLI, calling the before/after hooks appropriately.
343 :param cli: CLI to execute
347 r = self.cli_return_response(cli)
349 raise CliSyntaxError(r.reply)
351 raise CliFailedCommandError(r.reply)
352 if hasattr(r, 'reply'):
355 def ppcli(self, cli):
356 """ Helper method to print CLI command in case of info logging level.
358 :param cli: CLI to execute
361 return cli + "\n" + self.cli(cli)
363 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
365 return self.api(self.papi.ip6nd_send_router_solicitation,
370 'sw_if_index': sw_if_index})
372 def want_interface_events(self, enable_disable=1):
373 return self.api(self.papi.want_interface_events,
374 {'enable_disable': enable_disable,
375 'pid': os.getpid(), })
377 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
378 max_macs_in_event=0, learn_limit=0):
379 return self.api(self.papi.want_l2_macs_events,
380 {'enable_disable': enable_disable,
381 'scan_delay': scan_delay,
382 'max_macs_in_event': max_macs_in_event,
383 'learn_limit': learn_limit,
384 'pid': os.getpid(), })
386 def sw_interface_set_mac_address(self, sw_if_index, mac):
387 return self.api(self.papi.sw_interface_set_mac_address,
388 {'sw_if_index': sw_if_index,
391 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
392 """Create p2p ethernet subinterface
394 :param sw_if_index: main (parent) interface
395 :param remote_mac: client (remote) mac address
399 self.papi.p2p_ethernet_add,
400 {'parent_if_index': sw_if_index,
401 'remote_mac': remote_mac,
402 'subif_id': subif_id})
404 def p2p_ethernet_del(self, sw_if_index, remote_mac):
405 """Delete p2p ethernet subinterface
407 :param sw_if_index: main (parent) interface
408 :param remote_mac: client (remote) mac address
412 self.papi.p2p_ethernet_del,
413 {'parent_if_index': sw_if_index,
414 'remote_mac': remote_mac})
416 def create_vlan_subif(self, sw_if_index, vlan):
423 return self.api(self.papi.create_vlan_subif,
424 {'sw_if_index': sw_if_index,
427 def create_loopback(self, mac=''):
430 :param mac: (Optional)
432 return self.api(self.papi.create_loopback,
433 {'mac_address': mac})
435 def ip_route_dump(self, table_id, is_ip6=False):
436 return self.api(self.papi.ip_route_dump,
438 'table_id': table_id,
442 def ip_neighbor_add_del(self,
448 """ Add neighbor MAC to IPv4 or IPv6 address.
453 :param is_add: (Default value = 1)
454 :param flags: (Default value = 0/NONE)
457 self.papi.ip_neighbor_add_del,
461 'sw_if_index': sw_if_index,
463 'mac_address': mac_address,
464 'ip_address': ip_address
469 def proxy_arp_add_del(self,
474 """ Config Proxy Arp Range.
476 :param low_address: Start address in the rnage to Proxy for
477 :param hi_address: End address in the rnage to Proxy for
478 :param vrf_id: The VRF/table in which to proxy
482 self.papi.proxy_arp_add_del,
485 'table_id': table_id,
491 def proxy_arp_intfc_enable_disable(self,
494 """ Enable/Disable an interface for proxy ARP requests
496 :param sw_if_index: Interface
497 :param enable_disable: Enable/Disable
501 self.papi.proxy_arp_intfc_enable_disable,
502 {'sw_if_index': sw_if_index,
507 def udp_encap_add(self,
518 :param outer_fib_id: (Default value = 0)
522 self.papi.udp_encap_add,
527 'src_port': src_port,
528 'dst_port': dst_port,
533 def udp_encap_del(self, id):
534 return self.api(self.papi.udp_encap_del, {'id': id})
536 def udp_encap_dump(self):
537 return self.api(self.papi.udp_encap_dump, {})
539 def want_udp_encap_stats(self, enable=1):
540 return self.api(self.papi.want_udp_encap_stats,
544 def mpls_route_dump(self, table_id):
545 return self.api(self.papi.mpls_route_dump,
547 'mt_table_id': table_id
550 def mpls_table_dump(self):
551 return self.api(self.papi.mpls_table_dump, {})
553 def mpls_table_add_del(
560 :param is_add: (Default value = 1)
565 self.papi.mpls_table_add_del,
568 'mt_table_id': table_id,
570 'mt_is_add': is_add})
572 def mpls_route_add_del(self,
581 """ MPLS Route add/del """
583 self.papi.mpls_route_add_del,
586 'mr_table_id': table_id,
589 'mr_eos_proto': eos_proto,
590 'mr_is_multicast': is_multicast,
591 'mr_n_paths': len(paths),
595 'mr_is_multipath': is_multipath})
597 def mpls_ip_bind_unbind(
607 self.papi.mpls_ip_bind_unbind,
608 {'mb_mpls_table_id': table_id,
610 'mb_ip_table_id': ip_table_id,
611 'mb_is_bind': is_bind,
612 'mb_prefix': prefix})
614 def mpls_tunnel_add_del(
624 self.papi.mpls_tunnel_add_del,
625 {'mt_is_add': is_add,
628 'mt_sw_if_index': tun_sw_if_index,
629 'mt_l2_only': l2_only,
630 'mt_is_multicast': is_multicast,
631 'mt_n_paths': len(paths),
635 def input_acl_set_interface(
639 ip4_table_index=0xFFFFFFFF,
640 ip6_table_index=0xFFFFFFFF,
641 l2_table_index=0xFFFFFFFF):
645 :param ip4_table_index: (Default value = 0xFFFFFFFF)
646 :param ip6_table_index: (Default value = 0xFFFFFFFF)
647 :param l2_table_index: (Default value = 0xFFFFFFFF)
651 self.papi.input_acl_set_interface,
652 {'sw_if_index': sw_if_index,
653 'ip4_table_index': ip4_table_index,
654 'ip6_table_index': ip6_table_index,
655 'l2_table_index': l2_table_index,
658 def output_acl_set_interface(
662 ip4_table_index=0xFFFFFFFF,
663 ip6_table_index=0xFFFFFFFF,
664 l2_table_index=0xFFFFFFFF):
668 :param ip4_table_index: (Default value = 0xFFFFFFFF)
669 :param ip6_table_index: (Default value = 0xFFFFFFFF)
670 :param l2_table_index: (Default value = 0xFFFFFFFF)
674 self.papi.output_acl_set_interface,
675 {'sw_if_index': sw_if_index,
676 'ip4_table_index': ip4_table_index,
677 'ip6_table_index': ip6_table_index,
678 'l2_table_index': l2_table_index,
681 def set_ipfix_exporter(
691 self.papi.set_ipfix_exporter,
693 'collector_address': collector_address,
694 'collector_port': collector_port,
695 'src_address': src_address,
697 'path_mtu': path_mtu,
698 'template_interval': template_interval,
699 'udp_checksum': udp_checksum,
702 def ip_mroute_add_del(self,
711 IP Multicast Route add/del
714 self.papi.ip_mroute_add_del,
717 'is_multipath': is_multipath,
719 'table_id': table_id,
720 'entry_flags': e_flags,
723 'n_paths': len(paths),
728 def mfib_signal_dump(self):
729 return self.api(self.papi.mfib_signal_dump, {})
731 def ip_mroute_dump(self, table_id, is_ip6=False):
732 return self.api(self.papi.ip_mroute_dump,
734 'table_id': table_id,
738 def lisp_enable_disable(self, is_enabled):
740 self.papi.lisp_enable_disable,
745 def lisp_add_del_locator_set(self,
749 self.papi.lisp_add_del_locator_set,
752 'locator_set_name': ls_name
755 def lisp_add_del_locator(self,
762 self.papi.lisp_add_del_locator,
765 'locator_set_name': ls_name,
766 'sw_if_index': sw_if_index,
767 'priority': priority,
771 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
773 self.papi.lisp_locator_dump,
775 'is_index_set': is_index_set,
777 'ls_index': ls_index,
780 def lisp_add_del_local_eid(self,
790 self.papi.lisp_add_del_local_eid,
792 'locator_set_name': ls_name,
794 'eid_type': eid_type,
796 'prefix_len': prefix_len,
802 def lisp_eid_table_dump(self,
810 self.papi.lisp_eid_table_dump,
813 'prefix_length': prefix_length,
815 'eid_type': eid_type,
817 'filter': filter_opt,
820 def lisp_add_del_remote_mapping(self,
830 self.papi.lisp_add_del_remote_mapping,
833 'eid_type': eid_type,
835 'eid_len': eid_prefix_len,
836 'rloc_num': rlocs_num,
839 'is_src_dst': is_src_dst,
842 def lisp_add_del_adjacency(self,
851 self.papi.lisp_add_del_adjacency,
855 'eid_type': eid_type,
858 'leid_len': leid_len,
859 'reid_len': reid_len,
862 def vxlan_gpe_add_del_tunnel(
866 mcast_sw_if_index=0xFFFFFFFF,
877 :param is_add: (Default value = 1)
878 :param is_ipv6: (Default value = 0)
879 :param encap_vrf_id: (Default value = 0)
880 :param decap_vrf_id: (Default value = 0)
881 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
882 :param protocol: (Default value = 3)
883 :param vni: (Default value = 0)
886 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
891 'mcast_sw_if_index': mcast_sw_if_index,
892 'encap_vrf_id': encap_vrf_id,
893 'decap_vrf_id': decap_vrf_id,
894 'protocol': protocol,
897 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
898 return self.api(self.papi.vxlan_gbp_tunnel_dump,
899 {'sw_if_index': sw_if_index})
901 def pppoe_add_del_session(
910 :param is_add: (Default value = 1)
911 :param is_ipv6: (Default value = 0)
913 :param session_id: (Default value = 0)
915 :param decap_vrf_id: (Default value = 0)
918 return self.api(self.papi.pppoe_add_del_session,
920 'session_id': session_id,
921 'client_ip': client_ip,
922 'decap_vrf_id': decap_vrf_id,
923 'client_mac': client_mac})
925 def sr_mpls_policy_add(self, bsid, weight, type, segments):
926 return self.api(self.papi.sr_mpls_policy_add,
930 'n_segments': len(segments),
931 'segments': segments})
933 def sr_mpls_policy_del(self, bsid):
934 return self.api(self.papi.sr_mpls_policy_del,
937 def sr_localsid_add_del(self,
944 sw_if_index=0xFFFFFFFF,
948 """ Add/del IPv6 SR local-SID.
951 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
952 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
955 :param is_del: (Default value = 0)
956 :param end_psp: (Default value = 0)
957 :param sw_if_index: (Default value = 0xFFFFFFFF)
958 :param vlan_index: (Default value = 0)
959 :param fib_table: (Default value = 0)
962 self.papi.sr_localsid_add_del,
964 'localsid': localsid,
966 'behavior': behavior,
967 'sw_if_index': sw_if_index,
968 'vlan_index': vlan_index,
969 'fib_table': fib_table,
970 'nh_addr4': nh_addr4,
985 :param bsid_addr: bindingSID of the SR Policy
986 :param weight: weight of the sid list. optional. (default: 1)
987 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
989 :param type: type/behavior of the SR policy. (default or spray) \
991 :param fib_table: VRF where to install the FIB entry for the BSID \
993 :param n_segments: number of segments \
995 :param segments: a vector of IPv6 address composing the segment list \
999 self.papi.sr_policy_add,
1000 {'bsid_addr': bsid_addr,
1002 'is_encap': is_encap,
1004 'fib_table': fib_table,
1005 'n_segments': n_segments,
1006 'segments': segments
1015 :param bsid: bindingSID of the SR Policy
1016 :param sr_policy_index: index of the sr policy (default: 0)
1019 self.papi.sr_policy_del,
1020 {'bsid_addr': bsid_addr,
1021 'sr_policy_index': sr_policy_index
1024 def sr_steering_add_del(
1035 Steer traffic L2 and L3 traffic through a given SR policy
1037 :param is_del: delete or add
1038 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1039 :param sr_policy: is the index of the SR Policy (alt to bsid)
1040 :param table_id: is the VRF where to install the FIB entry for the BSID
1041 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1042 :param mask_width: is the mask for L3 traffic type
1043 :param sw_if_index: is the incoming interface for L2 traffic
1044 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1047 self.papi.sr_steering_add_del,
1049 'bsid_addr': bsid_addr,
1050 'sr_policy_index': sr_policy_index,
1051 'table_id': table_id,
1052 'prefix_addr': prefix_addr,
1053 'mask_width': mask_width,
1054 'sw_if_index': sw_if_index,
1055 'traffic_type': traffic_type
1058 def acl_add_replace(self, acl_index, r, tag='',
1060 """Add/replace an ACL
1061 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1062 :param acl_rule r: ACL rules array.
1063 :param str tag: symbolic tag (description) for this ACL.
1064 :param int count: number of rules.
1066 return self.api(self.papi.acl_add_replace,
1067 {'acl_index': acl_index,
1071 expected_retval=expected_retval)
1073 def acl_del(self, acl_index, expected_retval=0):
1079 return self.api(self.papi.acl_del,
1080 {'acl_index': acl_index},
1081 expected_retval=expected_retval)
1083 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1085 return self.api(self.papi.acl_interface_set_acl_list,
1086 {'sw_if_index': sw_if_index,
1090 expected_retval=expected_retval)
1092 def acl_interface_set_etype_whitelist(self, sw_if_index,
1095 return self.api(self.papi.acl_interface_set_etype_whitelist,
1096 {'sw_if_index': sw_if_index,
1097 'count': len(whitelist),
1099 'whitelist': whitelist},
1100 expected_retval=expected_retval)
1102 def acl_interface_add_del(self,
1106 """ Add/Delete ACL to/from interface
1110 :param is_add: (Default value = 1)
1113 return self.api(self.papi.acl_interface_add_del,
1116 'sw_if_index': sw_if_index,
1117 'acl_index': acl_index})
1119 def acl_dump(self, acl_index, expected_retval=0):
1120 return self.api(self.papi.acl_dump,
1121 {'acl_index': acl_index},
1122 expected_retval=expected_retval)
1124 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1126 return self.api(self.papi.acl_interface_list_dump,
1127 {'sw_if_index': sw_if_index},
1128 expected_retval=expected_retval)
1130 def macip_acl_add(self, rules, tag=""):
1133 :param rules: list of rules for given acl
1137 return self.api(self.papi.macip_acl_add,
1139 'count': len(rules),
1142 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1145 :param rules: list of rules for given acl
1149 return self.api(self.papi.macip_acl_add_replace,
1150 {'acl_index': acl_index,
1152 'count': len(rules),
1155 def macip_acl_interface_add_del(self,
1159 """ Add MACIP acl to interface
1163 :param is_add: (Default value = 1)
1166 return self.api(self.papi.macip_acl_interface_add_del,
1168 'sw_if_index': sw_if_index,
1169 'acl_index': acl_index})
1171 def macip_acl_dump(self, acl_index=4294967295):
1172 """ Return MACIP acl dump
1176 self.papi.macip_acl_dump, {'acl_index': acl_index})
1178 def policer_add_del(self,
1189 conform_action_type=1,
1191 exceed_action_type=0,
1193 violate_action_type=0,
1195 return self.api(self.papi.policer_add_del,
1202 'rate_type': rate_type,
1203 'round_type': round_type,
1205 'color_aware': color_aware,
1206 'conform_action_type': conform_action_type,
1207 'conform_dscp': conform_dscp,
1208 'exceed_action_type': exceed_action_type,
1209 'exceed_dscp': exceed_dscp,
1210 'violate_action_type': violate_action_type,
1211 'violate_dscp': violate_dscp})
1213 def ip_punt_police(self,
1217 return self.api(self.papi.ip_punt_police,
1218 {'policer_index': policer_index,
1222 def ip_punt_redirect(self,
1227 return self.api(self.papi.ip_punt_redirect,
1228 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1229 'tx_sw_if_index': tx_sw_if_index,
1233 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1234 return self.api(self.papi.ip_punt_redirect_dump,
1235 {'sw_if_index': sw_if_index,
1236 'is_ipv6': is_ipv6})
1238 def bier_table_add_del(self,
1242 """ BIER Table add/del """
1244 self.papi.bier_table_add_del,
1245 {'bt_tbl_id': {"bt_set": bti.set_id,
1246 "bt_sub_domain": bti.sub_domain_id,
1247 "bt_hdr_len_id": bti.hdr_len_id},
1248 'bt_label': mpls_label,
1249 'bt_is_add': is_add})
1251 def bier_table_dump(self):
1252 return self.api(self.papi.bier_table_dump, {})
1254 def bier_route_add_del(self,
1260 """ BIER Route add/del """
1262 self.papi.bier_route_add_del,
1265 'br_tbl_id': {"bt_set": bti.set_id,
1266 "bt_sub_domain": bti.sub_domain_id,
1267 "bt_hdr_len_id": bti.hdr_len_id},
1269 'br_n_paths': len(paths),
1272 'br_is_add': is_add,
1273 'br_is_replace': is_replace
1276 def bier_route_dump(self, bti):
1278 self.papi.bier_route_dump,
1279 {'br_tbl_id': {"bt_set": bti.set_id,
1280 "bt_sub_domain": bti.sub_domain_id,
1281 "bt_hdr_len_id": bti.hdr_len_id}})
1283 def bier_imp_add(self,
1288 """ BIER Imposition Add """
1290 self.papi.bier_imp_add,
1291 {'bi_tbl_id': {"bt_set": bti.set_id,
1292 "bt_sub_domain": bti.sub_domain_id,
1293 "bt_hdr_len_id": bti.hdr_len_id},
1295 'bi_n_bytes': len(ibytes),
1296 'bi_bytes': ibytes})
1298 def bier_imp_del(self, bi_index):
1299 """ BIER Imposition del """
1301 self.papi.bier_imp_del,
1302 {'bi_index': bi_index})
1304 def bier_imp_dump(self):
1305 return self.api(self.papi.bier_imp_dump, {})
1307 def bier_disp_table_add_del(self,
1310 """ BIER Disposition Table add/del """
1312 self.papi.bier_disp_table_add_del,
1313 {'bdt_tbl_id': bdti,
1314 'bdt_is_add': is_add})
1316 def bier_disp_table_dump(self):
1317 return self.api(self.papi.bier_disp_table_dump, {})
1319 def bier_disp_entry_add_del(self,
1329 """ BIER Route add/del """
1331 while (len(lstack) < 16):
1334 self.papi.bier_disp_entry_add_del,
1335 {'bde_tbl_id': bdti,
1337 'bde_payload_proto': payload_proto,
1339 'bde_paths': [{'table_id': next_hop_tbl_id,
1340 'rpf_id': next_hop_rpf_id,
1342 'label_stack': lstack}],
1343 'bde_is_add': is_add})
1345 def bier_disp_entry_dump(self, bdti):
1347 self.papi.bier_disp_entry_dump,
1348 {'bde_tbl_id': bdti})
1350 def session_enable_disable(self, is_enabled):
1352 self.papi.session_enable_disable,
1353 {'is_enable': is_enabled})
1355 def ipsec_spd_add_del(self, spd_id, is_add=1):
1356 """ SPD add/del - Wrapper to add or del ipsec SPD
1357 Sample CLI : 'ipsec spd add 1'
1359 :param spd_id - SPD ID to be created in the vpp . mandatory
1360 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1362 :returns: reply from the API
1365 self.papi.ipsec_spd_add_del, {
1366 'spd_id': spd_id, 'is_add': is_add})
1368 def ipsec_spds_dump(self):
1369 return self.api(self.papi.ipsec_spds_dump, {})
1371 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1372 """ IPSEC interface SPD add/del - \
1373 Wrapper to associate/disassociate SPD to interface in VPP
1374 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1376 :param spd_id - SPD ID to associate with the interface . mandatory
1377 :param sw_if_index - Interface Index which needs to ipsec \
1378 association mandatory
1379 :param is_add - add(1) or del(0) association with interface \
1380 (Default 1 - add) . optional
1381 :returns: reply from the API
1384 self.papi.ipsec_interface_add_del_spd,
1385 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1387 def ipsec_spd_interface_dump(self, spd_index=None):
1388 return self.api(self.papi.ipsec_spd_interface_dump,
1389 {'spd_index': spd_index if spd_index else 0,
1390 'spd_index_valid': 1 if spd_index else 0})
1392 def ipsec_sad_entry_add_del(self,
1395 integrity_algorithm,
1400 tunnel_src_address='',
1401 tunnel_dst_address='',
1405 """ IPSEC SA add/del
1406 :param sad_id: security association ID
1407 :param spi: security param index of the SA in decimal
1408 :param integrity_algorithm:
1409 :param integrity_key:
1410 :param crypto_algorithm:
1412 :param protocol: AH(0) or ESP(1) protocol
1413 :param tunnel_src_address: tunnel mode outer src address
1414 :param tunnel_dst_address: tunnel mode outer dst address
1417 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1418 crypto and ipsec algorithms
1421 self.papi.ipsec_sad_entry_add_del,
1428 'tunnel_src': tunnel_src_address,
1429 'tunnel_dst': tunnel_dst_address,
1430 'protocol': protocol,
1431 'integrity_algorithm': integrity_algorithm,
1433 'length': len(integrity_key),
1434 'data': integrity_key,
1436 'crypto_algorithm': crypto_algorithm,
1438 'length': len(crypto_key),
1446 def ipsec_sa_dump(self, sa_id=None):
1447 return self.api(self.papi.ipsec_sa_dump,
1448 {'sa_id': sa_id if sa_id else 0xffffffff})
1450 def ipsec_spd_entry_add_del(self,
1453 local_address_start,
1455 remote_address_start,
1456 remote_address_stop,
1458 local_port_stop=65535,
1459 remote_port_start=0,
1460 remote_port_stop=65535,
1468 """ IPSEC policy SPD add/del -
1469 Wrapper to configure ipsec SPD policy entries in VPP
1470 :param spd_id: SPD ID for the policy
1471 :param local_address_start: local-ip-range start address
1472 :param local_address_stop : local-ip-range stop address
1473 :param remote_address_start: remote-ip-range start address
1474 :param remote_address_stop : remote-ip-range stop address
1475 :param local_port_start: (Default value = 0)
1476 :param local_port_stop: (Default value = 65535)
1477 :param remote_port_start: (Default value = 0)
1478 :param remote_port_stop: (Default value = 65535)
1479 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1480 :param sa_id: Security Association ID for mapping it to SPD
1481 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1483 :param priority: value for the spd action (Default value = 100)
1484 :param is_outbound: flag for inbound(0) or outbound(1)
1486 :param is_add: (Default value = 1)
1489 self.papi.ipsec_spd_entry_add_del,
1496 'local_address_start': local_address_start,
1497 'local_address_stop': local_address_stop,
1498 'remote_address_start': remote_address_start,
1499 'remote_address_stop': remote_address_stop,
1500 'local_port_start': local_port_start,
1501 'local_port_stop': local_port_stop,
1502 'remote_port_start': remote_port_start,
1503 'remote_port_stop': remote_port_stop,
1504 'protocol': protocol,
1506 'priority': priority,
1507 'is_outbound': is_outbound,
1511 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1512 return self.api(self.papi.ipsec_spd_dump,
1516 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1517 remote_spi, crypto_alg, local_crypto_key,
1518 remote_crypto_key, integ_alg, local_integ_key,
1519 remote_integ_key, is_add=1, esn=0, salt=0,
1520 anti_replay=1, renumber=0,
1521 udp_encap=0, show_instance=0xffffffff):
1523 self.papi.ipsec_tunnel_if_add_del,
1525 'local_ip': local_ip,
1526 'remote_ip': remote_ip,
1527 'local_spi': local_spi,
1528 'remote_spi': remote_spi,
1529 'crypto_alg': crypto_alg,
1530 'local_crypto_key_len': len(local_crypto_key),
1531 'local_crypto_key': local_crypto_key,
1532 'remote_crypto_key_len': len(remote_crypto_key),
1533 'remote_crypto_key': remote_crypto_key,
1534 'integ_alg': integ_alg,
1535 'local_integ_key_len': len(local_integ_key),
1536 'local_integ_key': local_integ_key,
1537 'remote_integ_key_len': len(remote_integ_key),
1538 'remote_integ_key': remote_integ_key,
1541 'anti_replay': anti_replay,
1542 'renumber': renumber,
1543 'show_instance': show_instance,
1544 'udp_encap': udp_encap,
1548 def ipsec_select_backend(self, protocol, index):
1549 return self.api(self.papi.ipsec_select_backend,
1550 {'protocol': protocol, 'index': index})
1552 def ipsec_backend_dump(self):
1553 return self.api(self.papi.ipsec_backend_dump, {})
1555 def app_namespace_add_del(self,
1559 sw_if_index=0xFFFFFFFF,
1562 self.papi.app_namespace_add_del,
1564 'sw_if_index': sw_if_index,
1565 'ip4_fib_id': ip4_fib_id,
1566 'ip6_fib_id': ip6_fib_id,
1567 'namespace_id': namespace_id,
1568 'namespace_id_len': len(namespace_id)})
1570 def punt_socket_register(self, reg, pathname,
1572 """ Register punt socket """
1573 return self.api(self.papi.punt_socket_register,
1574 {'header_version': header_version,
1576 'pathname': pathname})
1578 def punt_socket_deregister(self, reg):
1579 """ Unregister punt socket """
1580 return self.api(self.papi.punt_socket_deregister,
1583 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1585 """ GBP endpoint Add """
1586 return self.api(self.papi.gbp_endpoint_add,
1588 'sw_if_index': sw_if_index,
1599 def gbp_endpoint_del(self, handle):
1600 """ GBP endpoint Del """
1601 return self.api(self.papi.gbp_endpoint_del,
1604 def gbp_endpoint_dump(self):
1605 """ GBP endpoint Dump """
1606 return self.api(self.papi.gbp_endpoint_dump, {})
1608 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1609 rd, uplink_sw_if_index,
1611 """ GBP endpoint group Add """
1612 return self.api(self.papi.gbp_endpoint_group_add,
1615 'uplink_sw_if_index': uplink_sw_if_index,
1620 'retention': retention
1623 def gbp_endpoint_group_del(self, sclass):
1624 """ GBP endpoint group Del """
1625 return self.api(self.papi.gbp_endpoint_group_del,
1628 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1631 bm_flood_sw_if_index):
1632 """ GBP bridge-domain Add """
1633 return self.api(self.papi.gbp_bridge_domain_add,
1637 'bvi_sw_if_index': bvi_sw_if_index,
1638 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1639 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1644 def gbp_bridge_domain_del(self, bd_id):
1645 """ GBP bridge-domain Del """
1646 return self.api(self.papi.gbp_bridge_domain_del,
1649 def gbp_route_domain_add(self, rd_id,
1654 ip6_uu_sw_if_index):
1655 """ GBP route-domain Add """
1656 return self.api(self.papi.gbp_route_domain_add,
1660 'ip4_table_id': ip4_table_id,
1661 'ip6_table_id': ip6_table_id,
1662 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1663 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1667 def gbp_route_domain_del(self, rd_id):
1668 """ GBP route-domain Del """
1669 return self.api(self.papi.gbp_route_domain_del,
1672 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1673 """ GBP recirc Add/Del """
1674 return self.api(self.papi.gbp_recirc_add_del,
1678 'sw_if_index': sw_if_index,
1681 def gbp_recirc_dump(self):
1682 """ GBP recirc Dump """
1683 return self.api(self.papi.gbp_recirc_dump, {})
1685 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1686 """ GBP recirc Add/Del """
1687 return self.api(self.papi.gbp_ext_itf_add_del,
1690 'sw_if_index': sw_if_index,
1695 def gbp_ext_itf_dump(self):
1696 """ GBP recirc Dump """
1697 return self.api(self.papi.gbp_ext_itf_dump, {})
1699 def gbp_subnet_add_del(self, is_add, rd_id,
1701 sw_if_index=0xffffffff,
1703 """ GBP Subnet Add/Del """
1704 return self.api(self.papi.gbp_subnet_add_del,
1708 'sw_if_index': sw_if_index,
1713 def gbp_subnet_dump(self):
1714 """ GBP Subnet Dump """
1715 return self.api(self.papi.gbp_subnet_dump, {})
1717 def gbp_contract_dump(self):
1718 """ GBP contract Dump """
1719 return self.api(self.papi.gbp_contract_dump, {})
1721 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1722 """ GBP VXLAN tunnel add """
1723 return self.api(self.papi.gbp_vxlan_tunnel_add,
1728 'bd_rd_id': bd_rd_id,
1733 def gbp_vxlan_tunnel_del(self, vni):
1734 """ GBP VXLAN tunnel del """
1735 return self.api(self.papi.gbp_vxlan_tunnel_del,
1740 def gbp_vxlan_tunnel_dump(self):
1741 """ GBP VXLAN tunnel add/del """
1742 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1744 def igmp_enable_disable(self, sw_if_index, enable, host):
1745 """ Enable/disable IGMP on a given interface """
1746 return self.api(self.papi.igmp_enable_disable,
1749 'sw_if_index': sw_if_index})
1751 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1752 """ Add/del IGMP proxy device """
1753 return self.api(self.papi.igmp_proxy_device_add_del,
1754 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1757 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1758 """ Add/del interface to/from IGMP proxy device """
1759 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1760 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1763 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1764 """ Listen for new (S,G) on specified interface
1766 :param enable: add/del
1767 :param sw_if_index: interface sw index
1768 :param saddr: source ip4 addr
1769 :param gaddr: group ip4 addr
1771 return self.api(self.papi.igmp_listen,
1776 'sw_if_index': sw_if_index,
1777 'n_srcs': len(saddrs),
1783 def igmp_clear_interface(self, sw_if_index):
1784 """ Remove all (S,G)s from specified interface
1785 doesn't send IGMP report!
1788 self.papi.igmp_clear_interface, {
1789 'sw_if_index': sw_if_index})
1791 def want_igmp_events(self, enable=1):
1792 return self.api(self.papi.want_igmp_events, {'enable': enable,
1793 'pid': os.getpid()})
1802 interface_id=0xFFFFFFFF):
1805 :param lb: load balance
1806 :param numa_only: tx on local numa node for lacp mode
1807 :param use_custom_mac: use custom mac
1808 :param mac_address: mac address
1809 :param interface_id: custom interface ID
1812 self.papi.bond_create,
1815 'numa_only': numa_only,
1816 'use_custom_mac': use_custom_mac,
1817 'mac_address': mac_address,
1821 def pipe_delete(self, parent_sw_if_index):
1822 return self.api(self.papi.pipe_delete,
1823 {'parent_sw_if_index': parent_sw_if_index})
1825 def svs_table_add_del(self, af, table_id, is_add=1):
1826 return self.api(self.papi.svs_table_add_del,
1828 'table_id': table_id,
1833 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
1834 return self.api(self.papi.svs_route_add_del,
1836 'table_id': table_id,
1837 'source_table_id': src_table_id,
1842 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
1843 return self.api(self.papi.svs_enable_disable,
1846 'table_id': table_id,
1847 'sw_if_index': sw_if_index,
1848 'is_enable': is_enable,
1851 def feature_gso_enable_disable(self, sw_if_index, enable_disable=1):
1852 return self.api(self.papi.feature_gso_enable_disable,
1854 'sw_if_index': sw_if_index,
1855 'enable_disable': enable_disable,