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, 'pid': os.getpid(), },
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 sw_interface_set_mac_address(self, sw_if_index, mac):
378 return self.api(self.papi.sw_interface_set_mac_address,
379 {'sw_if_index': sw_if_index,
382 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
383 """Create p2p ethernet subinterface
385 :param sw_if_index: main (parent) interface
386 :param remote_mac: client (remote) mac address
390 self.papi.p2p_ethernet_add,
391 {'parent_if_index': sw_if_index,
392 'remote_mac': remote_mac,
393 'subif_id': subif_id})
395 def p2p_ethernet_del(self, sw_if_index, remote_mac):
396 """Delete p2p ethernet subinterface
398 :param sw_if_index: main (parent) interface
399 :param remote_mac: client (remote) mac address
403 self.papi.p2p_ethernet_del,
404 {'parent_if_index': sw_if_index,
405 'remote_mac': remote_mac})
407 def create_vlan_subif(self, sw_if_index, vlan):
414 return self.api(self.papi.create_vlan_subif,
415 {'sw_if_index': sw_if_index,
418 def create_loopback(self, mac=''):
421 :param mac: (Optional)
423 return self.api(self.papi.create_loopback,
424 {'mac_address': mac})
426 def ip_route_dump(self, table_id, is_ip6=False):
427 return self.api(self.papi.ip_route_dump,
429 'table_id': table_id,
433 def ip_neighbor_add_del(self,
439 """ Add neighbor MAC to IPv4 or IPv6 address.
444 :param is_add: (Default value = 1)
445 :param flags: (Default value = 0/NONE)
448 self.papi.ip_neighbor_add_del,
452 'sw_if_index': sw_if_index,
454 'mac_address': mac_address,
455 'ip_address': ip_address
460 def proxy_arp_add_del(self,
465 """ Config Proxy Arp Range.
467 :param low_address: Start address in the rnage to Proxy for
468 :param hi_address: End address in the rnage to Proxy for
469 :param vrf_id: The VRF/table in which to proxy
473 self.papi.proxy_arp_add_del,
476 'table_id': table_id,
482 def proxy_arp_intfc_enable_disable(self,
485 """ Enable/Disable an interface for proxy ARP requests
487 :param sw_if_index: Interface
488 :param enable_disable: Enable/Disable
492 self.papi.proxy_arp_intfc_enable_disable,
493 {'sw_if_index': sw_if_index,
498 def udp_encap_add(self,
509 :param outer_fib_id: (Default value = 0)
513 self.papi.udp_encap_add,
518 'src_port': src_port,
519 'dst_port': dst_port,
524 def udp_encap_del(self, id):
525 return self.api(self.papi.udp_encap_del, {'id': id})
527 def udp_encap_dump(self):
528 return self.api(self.papi.udp_encap_dump, {})
530 def want_udp_encap_stats(self, enable=1):
531 return self.api(self.papi.want_udp_encap_stats,
535 def mpls_route_dump(self, table_id):
536 return self.api(self.papi.mpls_route_dump,
538 'mt_table_id': table_id
541 def mpls_table_dump(self):
542 return self.api(self.papi.mpls_table_dump, {})
544 def mpls_table_add_del(
551 :param is_add: (Default value = 1)
556 self.papi.mpls_table_add_del,
559 'mt_table_id': table_id,
561 'mt_is_add': is_add})
563 def mpls_route_add_del(self,
572 """ MPLS Route add/del """
574 self.papi.mpls_route_add_del,
577 'mr_table_id': table_id,
580 'mr_eos_proto': eos_proto,
581 'mr_is_multicast': is_multicast,
582 'mr_n_paths': len(paths),
586 'mr_is_multipath': is_multipath})
588 def mpls_ip_bind_unbind(
598 self.papi.mpls_ip_bind_unbind,
599 {'mb_mpls_table_id': table_id,
601 'mb_ip_table_id': ip_table_id,
602 'mb_is_bind': is_bind,
603 'mb_prefix': prefix})
605 def mpls_tunnel_add_del(
615 self.papi.mpls_tunnel_add_del,
616 {'mt_is_add': is_add,
619 'mt_sw_if_index': tun_sw_if_index,
620 'mt_l2_only': l2_only,
621 'mt_is_multicast': is_multicast,
622 'mt_n_paths': len(paths),
626 def input_acl_set_interface(
630 ip4_table_index=0xFFFFFFFF,
631 ip6_table_index=0xFFFFFFFF,
632 l2_table_index=0xFFFFFFFF):
636 :param ip4_table_index: (Default value = 0xFFFFFFFF)
637 :param ip6_table_index: (Default value = 0xFFFFFFFF)
638 :param l2_table_index: (Default value = 0xFFFFFFFF)
642 self.papi.input_acl_set_interface,
643 {'sw_if_index': sw_if_index,
644 'ip4_table_index': ip4_table_index,
645 'ip6_table_index': ip6_table_index,
646 'l2_table_index': l2_table_index,
649 def output_acl_set_interface(
653 ip4_table_index=0xFFFFFFFF,
654 ip6_table_index=0xFFFFFFFF,
655 l2_table_index=0xFFFFFFFF):
659 :param ip4_table_index: (Default value = 0xFFFFFFFF)
660 :param ip6_table_index: (Default value = 0xFFFFFFFF)
661 :param l2_table_index: (Default value = 0xFFFFFFFF)
665 self.papi.output_acl_set_interface,
666 {'sw_if_index': sw_if_index,
667 'ip4_table_index': ip4_table_index,
668 'ip6_table_index': ip6_table_index,
669 'l2_table_index': l2_table_index,
672 def set_ipfix_exporter(
682 self.papi.set_ipfix_exporter,
684 'collector_address': collector_address,
685 'collector_port': collector_port,
686 'src_address': src_address,
688 'path_mtu': path_mtu,
689 'template_interval': template_interval,
690 'udp_checksum': udp_checksum,
693 def ip_mroute_add_del(self,
702 IP Multicast Route add/del
705 self.papi.ip_mroute_add_del,
708 'is_multipath': is_multipath,
710 'table_id': table_id,
711 'entry_flags': e_flags,
714 'n_paths': len(paths),
719 def mfib_signal_dump(self):
720 return self.api(self.papi.mfib_signal_dump, {})
722 def ip_mroute_dump(self, table_id, is_ip6=False):
723 return self.api(self.papi.ip_mroute_dump,
725 'table_id': table_id,
729 def lisp_enable_disable(self, is_enabled):
731 self.papi.lisp_enable_disable,
736 def lisp_add_del_locator_set(self,
740 self.papi.lisp_add_del_locator_set,
743 'locator_set_name': ls_name
746 def lisp_add_del_locator(self,
753 self.papi.lisp_add_del_locator,
756 'locator_set_name': ls_name,
757 'sw_if_index': sw_if_index,
758 'priority': priority,
762 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
764 self.papi.lisp_locator_dump,
766 'is_index_set': is_index_set,
768 'ls_index': ls_index,
771 def lisp_add_del_local_eid(self,
781 self.papi.lisp_add_del_local_eid,
783 'locator_set_name': ls_name,
785 'eid_type': eid_type,
787 'prefix_len': prefix_len,
793 def lisp_eid_table_dump(self,
801 self.papi.lisp_eid_table_dump,
804 'prefix_length': prefix_length,
806 'eid_type': eid_type,
808 'filter': filter_opt,
811 def lisp_add_del_remote_mapping(self,
821 self.papi.lisp_add_del_remote_mapping,
824 'eid_type': eid_type,
826 'eid_len': eid_prefix_len,
827 'rloc_num': rlocs_num,
830 'is_src_dst': is_src_dst,
833 def lisp_add_del_adjacency(self,
842 self.papi.lisp_add_del_adjacency,
846 'eid_type': eid_type,
849 'leid_len': leid_len,
850 'reid_len': reid_len,
853 def vxlan_gpe_add_del_tunnel(
857 mcast_sw_if_index=0xFFFFFFFF,
868 :param is_add: (Default value = 1)
869 :param is_ipv6: (Default value = 0)
870 :param encap_vrf_id: (Default value = 0)
871 :param decap_vrf_id: (Default value = 0)
872 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
873 :param protocol: (Default value = 3)
874 :param vni: (Default value = 0)
877 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
882 'mcast_sw_if_index': mcast_sw_if_index,
883 'encap_vrf_id': encap_vrf_id,
884 'decap_vrf_id': decap_vrf_id,
885 'protocol': protocol,
888 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
889 return self.api(self.papi.vxlan_gbp_tunnel_dump,
890 {'sw_if_index': sw_if_index})
892 def pppoe_add_del_session(
901 :param is_add: (Default value = 1)
902 :param is_ipv6: (Default value = 0)
904 :param session_id: (Default value = 0)
906 :param decap_vrf_id: (Default value = 0)
909 return self.api(self.papi.pppoe_add_del_session,
911 'session_id': session_id,
912 'client_ip': client_ip,
913 'decap_vrf_id': decap_vrf_id,
914 'client_mac': client_mac})
916 def sr_mpls_policy_add(self, bsid, weight, type, segments):
917 return self.api(self.papi.sr_mpls_policy_add,
921 'n_segments': len(segments),
922 'segments': segments})
924 def sr_mpls_policy_del(self, bsid):
925 return self.api(self.papi.sr_mpls_policy_del,
928 def sr_localsid_add_del(self,
935 sw_if_index=0xFFFFFFFF,
939 """ Add/del IPv6 SR local-SID.
942 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
943 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
946 :param is_del: (Default value = 0)
947 :param end_psp: (Default value = 0)
948 :param sw_if_index: (Default value = 0xFFFFFFFF)
949 :param vlan_index: (Default value = 0)
950 :param fib_table: (Default value = 0)
953 self.papi.sr_localsid_add_del,
955 'localsid': localsid,
957 'behavior': behavior,
958 'sw_if_index': sw_if_index,
959 'vlan_index': vlan_index,
960 'fib_table': fib_table,
961 'nh_addr4': nh_addr4,
976 :param bsid_addr: bindingSID of the SR Policy
977 :param weight: weight of the sid list. optional. (default: 1)
978 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
980 :param type: type/behavior of the SR policy. (default or spray) \
982 :param fib_table: VRF where to install the FIB entry for the BSID \
984 :param n_segments: number of segments \
986 :param segments: a vector of IPv6 address composing the segment list \
990 self.papi.sr_policy_add,
991 {'bsid_addr': bsid_addr,
993 'is_encap': is_encap,
995 'fib_table': fib_table,
996 'n_segments': n_segments,
1006 :param bsid: bindingSID of the SR Policy
1007 :param sr_policy_index: index of the sr policy (default: 0)
1010 self.papi.sr_policy_del,
1011 {'bsid_addr': bsid_addr,
1012 'sr_policy_index': sr_policy_index
1015 def sr_steering_add_del(
1026 Steer traffic L2 and L3 traffic through a given SR policy
1028 :param is_del: delete or add
1029 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1030 :param sr_policy: is the index of the SR Policy (alt to bsid)
1031 :param table_id: is the VRF where to install the FIB entry for the BSID
1032 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1033 :param mask_width: is the mask for L3 traffic type
1034 :param sw_if_index: is the incoming interface for L2 traffic
1035 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1038 self.papi.sr_steering_add_del,
1040 'bsid_addr': bsid_addr,
1041 'sr_policy_index': sr_policy_index,
1042 'table_id': table_id,
1043 'prefix_addr': prefix_addr,
1044 'mask_width': mask_width,
1045 'sw_if_index': sw_if_index,
1046 'traffic_type': traffic_type
1049 def acl_add_replace(self, acl_index, r, tag='',
1051 """Add/replace an ACL
1052 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1053 :param acl_rule r: ACL rules array.
1054 :param str tag: symbolic tag (description) for this ACL.
1055 :param int count: number of rules.
1057 return self.api(self.papi.acl_add_replace,
1058 {'acl_index': acl_index,
1062 expected_retval=expected_retval)
1064 def acl_del(self, acl_index, expected_retval=0):
1070 return self.api(self.papi.acl_del,
1071 {'acl_index': acl_index},
1072 expected_retval=expected_retval)
1074 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1076 return self.api(self.papi.acl_interface_set_acl_list,
1077 {'sw_if_index': sw_if_index,
1081 expected_retval=expected_retval)
1083 def acl_interface_set_etype_whitelist(self, sw_if_index,
1086 return self.api(self.papi.acl_interface_set_etype_whitelist,
1087 {'sw_if_index': sw_if_index,
1088 'count': len(whitelist),
1090 'whitelist': whitelist},
1091 expected_retval=expected_retval)
1093 def acl_interface_add_del(self,
1097 """ Add/Delete ACL to/from interface
1101 :param is_add: (Default value = 1)
1104 return self.api(self.papi.acl_interface_add_del,
1107 'sw_if_index': sw_if_index,
1108 'acl_index': acl_index})
1110 def acl_dump(self, acl_index, expected_retval=0):
1111 return self.api(self.papi.acl_dump,
1112 {'acl_index': acl_index},
1113 expected_retval=expected_retval)
1115 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1117 return self.api(self.papi.acl_interface_list_dump,
1118 {'sw_if_index': sw_if_index},
1119 expected_retval=expected_retval)
1121 def macip_acl_add(self, rules, tag=""):
1124 :param rules: list of rules for given acl
1128 return self.api(self.papi.macip_acl_add,
1130 'count': len(rules),
1133 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1136 :param rules: list of rules for given acl
1140 return self.api(self.papi.macip_acl_add_replace,
1141 {'acl_index': acl_index,
1143 'count': len(rules),
1146 def macip_acl_interface_add_del(self,
1150 """ Add MACIP acl to interface
1154 :param is_add: (Default value = 1)
1157 return self.api(self.papi.macip_acl_interface_add_del,
1159 'sw_if_index': sw_if_index,
1160 'acl_index': acl_index})
1162 def macip_acl_dump(self, acl_index=4294967295):
1163 """ Return MACIP acl dump
1167 self.papi.macip_acl_dump, {'acl_index': acl_index})
1169 def policer_add_del(self,
1180 conform_action_type=1,
1182 exceed_action_type=0,
1184 violate_action_type=0,
1186 return self.api(self.papi.policer_add_del,
1193 'rate_type': rate_type,
1194 'round_type': round_type,
1196 'color_aware': color_aware,
1197 'conform_action_type': conform_action_type,
1198 'conform_dscp': conform_dscp,
1199 'exceed_action_type': exceed_action_type,
1200 'exceed_dscp': exceed_dscp,
1201 'violate_action_type': violate_action_type,
1202 'violate_dscp': violate_dscp})
1204 def ip_punt_police(self,
1208 return self.api(self.papi.ip_punt_police,
1209 {'policer_index': policer_index,
1213 def ip_punt_redirect(self,
1218 return self.api(self.papi.ip_punt_redirect,
1219 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1220 'tx_sw_if_index': tx_sw_if_index,
1224 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1225 return self.api(self.papi.ip_punt_redirect_dump,
1226 {'sw_if_index': sw_if_index,
1227 'is_ipv6': is_ipv6})
1229 def bier_table_add_del(self,
1233 """ BIER Table add/del """
1235 self.papi.bier_table_add_del,
1236 {'bt_tbl_id': {"bt_set": bti.set_id,
1237 "bt_sub_domain": bti.sub_domain_id,
1238 "bt_hdr_len_id": bti.hdr_len_id},
1239 'bt_label': mpls_label,
1240 'bt_is_add': is_add})
1242 def bier_table_dump(self):
1243 return self.api(self.papi.bier_table_dump, {})
1245 def bier_route_add_del(self,
1251 """ BIER Route add/del """
1253 self.papi.bier_route_add_del,
1256 'br_tbl_id': {"bt_set": bti.set_id,
1257 "bt_sub_domain": bti.sub_domain_id,
1258 "bt_hdr_len_id": bti.hdr_len_id},
1260 'br_n_paths': len(paths),
1263 'br_is_add': is_add,
1264 'br_is_replace': is_replace
1267 def bier_route_dump(self, bti):
1269 self.papi.bier_route_dump,
1270 {'br_tbl_id': {"bt_set": bti.set_id,
1271 "bt_sub_domain": bti.sub_domain_id,
1272 "bt_hdr_len_id": bti.hdr_len_id}})
1274 def bier_imp_add(self,
1279 """ BIER Imposition Add """
1281 self.papi.bier_imp_add,
1282 {'bi_tbl_id': {"bt_set": bti.set_id,
1283 "bt_sub_domain": bti.sub_domain_id,
1284 "bt_hdr_len_id": bti.hdr_len_id},
1286 'bi_n_bytes': len(ibytes),
1287 'bi_bytes': ibytes})
1289 def bier_imp_del(self, bi_index):
1290 """ BIER Imposition del """
1292 self.papi.bier_imp_del,
1293 {'bi_index': bi_index})
1295 def bier_imp_dump(self):
1296 return self.api(self.papi.bier_imp_dump, {})
1298 def bier_disp_table_add_del(self,
1301 """ BIER Disposition Table add/del """
1303 self.papi.bier_disp_table_add_del,
1304 {'bdt_tbl_id': bdti,
1305 'bdt_is_add': is_add})
1307 def bier_disp_table_dump(self):
1308 return self.api(self.papi.bier_disp_table_dump, {})
1310 def bier_disp_entry_add_del(self,
1320 """ BIER Route add/del """
1322 while (len(lstack) < 16):
1325 self.papi.bier_disp_entry_add_del,
1326 {'bde_tbl_id': bdti,
1328 'bde_payload_proto': payload_proto,
1330 'bde_paths': [{'table_id': next_hop_tbl_id,
1331 'rpf_id': next_hop_rpf_id,
1333 'label_stack': lstack}],
1334 'bde_is_add': is_add})
1336 def bier_disp_entry_dump(self, bdti):
1338 self.papi.bier_disp_entry_dump,
1339 {'bde_tbl_id': bdti})
1341 def session_enable_disable(self, is_enabled):
1343 self.papi.session_enable_disable,
1344 {'is_enable': is_enabled})
1346 def ipsec_spd_add_del(self, spd_id, is_add=1):
1347 """ SPD add/del - Wrapper to add or del ipsec SPD
1348 Sample CLI : 'ipsec spd add 1'
1350 :param spd_id - SPD ID to be created in the vpp . mandatory
1351 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1353 :returns: reply from the API
1356 self.papi.ipsec_spd_add_del, {
1357 'spd_id': spd_id, 'is_add': is_add})
1359 def ipsec_spds_dump(self):
1360 return self.api(self.papi.ipsec_spds_dump, {})
1362 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1363 """ IPSEC interface SPD add/del - \
1364 Wrapper to associate/disassociate SPD to interface in VPP
1365 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1367 :param spd_id - SPD ID to associate with the interface . mandatory
1368 :param sw_if_index - Interface Index which needs to ipsec \
1369 association mandatory
1370 :param is_add - add(1) or del(0) association with interface \
1371 (Default 1 - add) . optional
1372 :returns: reply from the API
1375 self.papi.ipsec_interface_add_del_spd,
1376 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1378 def ipsec_spd_interface_dump(self, spd_index=None):
1379 return self.api(self.papi.ipsec_spd_interface_dump,
1380 {'spd_index': spd_index if spd_index else 0,
1381 'spd_index_valid': 1 if spd_index else 0})
1383 def ipsec_sad_entry_add_del(self,
1386 integrity_algorithm,
1391 tunnel_src_address='',
1392 tunnel_dst_address='',
1396 """ IPSEC SA add/del
1397 :param sad_id: security association ID
1398 :param spi: security param index of the SA in decimal
1399 :param integrity_algorithm:
1400 :param integrity_key:
1401 :param crypto_algorithm:
1403 :param protocol: AH(0) or ESP(1) protocol
1404 :param tunnel_src_address: tunnel mode outer src address
1405 :param tunnel_dst_address: tunnel mode outer dst address
1408 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1409 crypto and ipsec algorithms
1412 self.papi.ipsec_sad_entry_add_del,
1419 'tunnel_src': tunnel_src_address,
1420 'tunnel_dst': tunnel_dst_address,
1421 'protocol': protocol,
1422 'integrity_algorithm': integrity_algorithm,
1424 'length': len(integrity_key),
1425 'data': integrity_key,
1427 'crypto_algorithm': crypto_algorithm,
1429 'length': len(crypto_key),
1437 def ipsec_sa_dump(self, sa_id=None):
1438 return self.api(self.papi.ipsec_sa_dump,
1439 {'sa_id': sa_id if sa_id else 0xffffffff})
1441 def ipsec_spd_entry_add_del(self,
1444 local_address_start,
1446 remote_address_start,
1447 remote_address_stop,
1449 local_port_stop=65535,
1450 remote_port_start=0,
1451 remote_port_stop=65535,
1459 """ IPSEC policy SPD add/del -
1460 Wrapper to configure ipsec SPD policy entries in VPP
1461 :param spd_id: SPD ID for the policy
1462 :param local_address_start: local-ip-range start address
1463 :param local_address_stop : local-ip-range stop address
1464 :param remote_address_start: remote-ip-range start address
1465 :param remote_address_stop : remote-ip-range stop address
1466 :param local_port_start: (Default value = 0)
1467 :param local_port_stop: (Default value = 65535)
1468 :param remote_port_start: (Default value = 0)
1469 :param remote_port_stop: (Default value = 65535)
1470 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1471 :param sa_id: Security Association ID for mapping it to SPD
1472 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1474 :param priority: value for the spd action (Default value = 100)
1475 :param is_outbound: flag for inbound(0) or outbound(1)
1477 :param is_add: (Default value = 1)
1480 self.papi.ipsec_spd_entry_add_del,
1487 'local_address_start': local_address_start,
1488 'local_address_stop': local_address_stop,
1489 'remote_address_start': remote_address_start,
1490 'remote_address_stop': remote_address_stop,
1491 'local_port_start': local_port_start,
1492 'local_port_stop': local_port_stop,
1493 'remote_port_start': remote_port_start,
1494 'remote_port_stop': remote_port_stop,
1495 'protocol': protocol,
1497 'priority': priority,
1498 'is_outbound': is_outbound,
1502 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1503 return self.api(self.papi.ipsec_spd_dump,
1507 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1508 remote_spi, crypto_alg, local_crypto_key,
1509 remote_crypto_key, integ_alg, local_integ_key,
1510 remote_integ_key, is_add=1, esn=0, salt=0,
1511 anti_replay=1, renumber=0,
1512 udp_encap=0, show_instance=0xffffffff):
1514 self.papi.ipsec_tunnel_if_add_del,
1516 'local_ip': local_ip,
1517 'remote_ip': remote_ip,
1518 'local_spi': local_spi,
1519 'remote_spi': remote_spi,
1520 'crypto_alg': crypto_alg,
1521 'local_crypto_key_len': len(local_crypto_key),
1522 'local_crypto_key': local_crypto_key,
1523 'remote_crypto_key_len': len(remote_crypto_key),
1524 'remote_crypto_key': remote_crypto_key,
1525 'integ_alg': integ_alg,
1526 'local_integ_key_len': len(local_integ_key),
1527 'local_integ_key': local_integ_key,
1528 'remote_integ_key_len': len(remote_integ_key),
1529 'remote_integ_key': remote_integ_key,
1532 'anti_replay': anti_replay,
1533 'renumber': renumber,
1534 'show_instance': show_instance,
1535 'udp_encap': udp_encap,
1539 def ipsec_select_backend(self, protocol, index):
1540 return self.api(self.papi.ipsec_select_backend,
1541 {'protocol': protocol, 'index': index})
1543 def ipsec_backend_dump(self):
1544 return self.api(self.papi.ipsec_backend_dump, {})
1546 def app_namespace_add_del(self,
1550 sw_if_index=0xFFFFFFFF,
1553 self.papi.app_namespace_add_del,
1555 'sw_if_index': sw_if_index,
1556 'ip4_fib_id': ip4_fib_id,
1557 'ip6_fib_id': ip6_fib_id,
1558 'namespace_id': namespace_id})
1560 def punt_socket_register(self, reg, pathname,
1562 """ Register punt socket """
1563 return self.api(self.papi.punt_socket_register,
1564 {'header_version': header_version,
1566 'pathname': pathname})
1568 def punt_socket_deregister(self, reg):
1569 """ Unregister punt socket """
1570 return self.api(self.papi.punt_socket_deregister,
1573 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1575 """ GBP endpoint Add """
1576 return self.api(self.papi.gbp_endpoint_add,
1578 'sw_if_index': sw_if_index,
1589 def gbp_endpoint_del(self, handle):
1590 """ GBP endpoint Del """
1591 return self.api(self.papi.gbp_endpoint_del,
1594 def gbp_endpoint_dump(self):
1595 """ GBP endpoint Dump """
1596 return self.api(self.papi.gbp_endpoint_dump, {})
1598 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1599 rd, uplink_sw_if_index,
1601 """ GBP endpoint group Add """
1602 return self.api(self.papi.gbp_endpoint_group_add,
1605 'uplink_sw_if_index': uplink_sw_if_index,
1610 'retention': retention
1613 def gbp_endpoint_group_del(self, sclass):
1614 """ GBP endpoint group Del """
1615 return self.api(self.papi.gbp_endpoint_group_del,
1618 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1621 bm_flood_sw_if_index):
1622 """ GBP bridge-domain Add """
1623 return self.api(self.papi.gbp_bridge_domain_add,
1627 'bvi_sw_if_index': bvi_sw_if_index,
1628 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1629 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1634 def gbp_bridge_domain_del(self, bd_id):
1635 """ GBP bridge-domain Del """
1636 return self.api(self.papi.gbp_bridge_domain_del,
1639 def gbp_route_domain_add(self, rd_id,
1644 ip6_uu_sw_if_index):
1645 """ GBP route-domain Add """
1646 return self.api(self.papi.gbp_route_domain_add,
1650 'ip4_table_id': ip4_table_id,
1651 'ip6_table_id': ip6_table_id,
1652 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1653 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1657 def gbp_route_domain_del(self, rd_id):
1658 """ GBP route-domain Del """
1659 return self.api(self.papi.gbp_route_domain_del,
1662 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1663 """ GBP recirc Add/Del """
1664 return self.api(self.papi.gbp_recirc_add_del,
1668 'sw_if_index': sw_if_index,
1671 def gbp_recirc_dump(self):
1672 """ GBP recirc Dump """
1673 return self.api(self.papi.gbp_recirc_dump, {})
1675 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1676 """ GBP recirc Add/Del """
1677 return self.api(self.papi.gbp_ext_itf_add_del,
1680 'sw_if_index': sw_if_index,
1685 def gbp_ext_itf_dump(self):
1686 """ GBP recirc Dump """
1687 return self.api(self.papi.gbp_ext_itf_dump, {})
1689 def gbp_subnet_add_del(self, is_add, rd_id,
1691 sw_if_index=0xffffffff,
1693 """ GBP Subnet Add/Del """
1694 return self.api(self.papi.gbp_subnet_add_del,
1698 'sw_if_index': sw_if_index,
1703 def gbp_subnet_dump(self):
1704 """ GBP Subnet Dump """
1705 return self.api(self.papi.gbp_subnet_dump, {})
1707 def gbp_contract_dump(self):
1708 """ GBP contract Dump """
1709 return self.api(self.papi.gbp_contract_dump, {})
1711 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1712 """ GBP VXLAN tunnel add """
1713 return self.api(self.papi.gbp_vxlan_tunnel_add,
1718 'bd_rd_id': bd_rd_id,
1723 def gbp_vxlan_tunnel_del(self, vni):
1724 """ GBP VXLAN tunnel del """
1725 return self.api(self.papi.gbp_vxlan_tunnel_del,
1730 def gbp_vxlan_tunnel_dump(self):
1731 """ GBP VXLAN tunnel add/del """
1732 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1734 def igmp_enable_disable(self, sw_if_index, enable, host):
1735 """ Enable/disable IGMP on a given interface """
1736 return self.api(self.papi.igmp_enable_disable,
1739 'sw_if_index': sw_if_index})
1741 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1742 """ Add/del IGMP proxy device """
1743 return self.api(self.papi.igmp_proxy_device_add_del,
1744 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1747 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1748 """ Add/del interface to/from IGMP proxy device """
1749 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1750 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1753 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1754 """ Listen for new (S,G) on specified interface
1756 :param enable: add/del
1757 :param sw_if_index: interface sw index
1758 :param saddr: source ip4 addr
1759 :param gaddr: group ip4 addr
1761 return self.api(self.papi.igmp_listen,
1766 'sw_if_index': sw_if_index,
1767 'n_srcs': len(saddrs),
1773 def igmp_clear_interface(self, sw_if_index):
1774 """ Remove all (S,G)s from specified interface
1775 doesn't send IGMP report!
1778 self.papi.igmp_clear_interface, {
1779 'sw_if_index': sw_if_index})
1781 def want_igmp_events(self, enable=1):
1782 return self.api(self.papi.want_igmp_events, {'enable': enable,
1783 'pid': os.getpid()})
1792 interface_id=0xFFFFFFFF):
1795 :param lb: load balance
1796 :param numa_only: tx on local numa node for lacp mode
1797 :param use_custom_mac: use custom mac
1798 :param mac_address: mac address
1799 :param interface_id: custom interface ID
1802 self.papi.bond_create,
1805 'numa_only': numa_only,
1806 'use_custom_mac': use_custom_mac,
1807 'mac_address': mac_address,
1811 def pipe_delete(self, parent_sw_if_index):
1812 return self.api(self.papi.pipe_delete,
1813 {'parent_sw_if_index': parent_sw_if_index})
1815 def svs_table_add_del(self, af, table_id, is_add=1):
1816 return self.api(self.papi.svs_table_add_del,
1818 'table_id': table_id,
1823 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
1824 return self.api(self.papi.svs_route_add_del,
1826 'table_id': table_id,
1827 'source_table_id': src_table_id,
1832 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
1833 return self.api(self.papi.svs_enable_disable,
1836 'table_id': table_id,
1837 'sw_if_index': sw_if_index,
1838 'is_enable': is_enable,
1841 def feature_gso_enable_disable(self, sw_if_index, enable_disable=1):
1842 return self.api(self.papi.feature_gso_enable_disable,
1844 'sw_if_index': sw_if_index,
1845 'enable_disable': enable_disable,