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 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
32 'bier_disp_table_add_del': {'is_add': 1, },
33 'bier_imp_add': {'is_add': 1, },
34 'bier_route_add_del': {'is_add': 1, },
35 'bier_table_add_del': {'is_add': 1, },
36 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
37 'learn': 1, 'is_add': 1, },
38 'bvi_create': {'user_instance': 4294967295, },
40 'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
41 'nbuckets': 2, 'memory_size': 2097152,
42 'next_table_index': 4294967295,
43 'miss_next_index': 4294967295, },
44 'dhcp6_client_enable_disable': {'enable': 1, },
45 'dhcp6_clients_enable_disable': {'enable': 1, },
46 'dhcp6_pd_client_enable_disable': {'enable': 1, },
47 'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
48 'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
49 'dhcp_proxy_config': {'is_add': 1, },
50 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
51 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
52 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
53 'decap_next_index': 4294967295, },
54 'gre_tunnel_add_del': {'instance': 4294967295, 'is_add': 1, },
55 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
56 'decap_next_index': 4294967295, },
57 'input_acl_set_interface': {'ip4_table_index': 4294967295,
58 'ip6_table_index': 4294967295,
59 'l2_table_index': 4294967295, },
60 'ip6_add_del_address_using_prefix': {'is_add': 1, },
61 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
62 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
63 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
64 'next_hop_id': 4294967295,
65 'classify_table_index': 4294967295, 'is_add': 1, },
66 'ip_mroute_add_del': {'is_add': 1, },
67 'ip_neighbor_add_del': {'is_add': 1, },
68 'ip_punt_police': {'is_add': 1, },
69 'ip_punt_redirect': {'is_add': 1, },
70 'ip_route_add_del': {'is_add': 1, },
71 'ip_table_add_del': {'is_add': 1, },
72 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
73 'ipsec_interface_add_del_spd': {'is_add': 1, },
74 'ipsec_sad_entry_add_del': {'is_add': 1, },
75 'ipsec_spd_add_del': {'is_add': 1, },
76 'ipsec_spd_dump': {'sa_id': 4294967295, },
77 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
78 'remote_port_stop': 65535, 'priority': 100,
81 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
82 'l2_emulation': {'enable': 1, },
83 'l2fib_add_del': {'is_add': 1, },
84 'lb_conf': {'sticky_buckets_per_core': 4294967295,
85 'flow_timeout': 4294967295},
86 'lisp_add_del_adjacency': {'is_add': 1, },
87 'lisp_add_del_local_eid': {'is_add': 1, },
88 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
89 'lisp_add_del_locator_set': {'is_add': 1, },
90 'lisp_add_del_remote_mapping': {'is_add': 1, },
91 'macip_acl_add_replace': {'acl_index': 4294967295, },
92 'macip_acl_dump': {'acl_index': 4294967295, },
93 'macip_acl_interface_add_del': {'is_add': 1, },
94 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
95 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
96 'mr_next_hop_weight': 1,
97 'mr_next_hop_via_label': 1048576,
99 'mr_classify_table_index': 4294967295, },
100 'mpls_table_add_del': {'is_add': 1, },
101 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
102 'next_hop_weight': 1,
103 'next_hop_via_label': 1048576,
105 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
106 'output_acl_set_interface': {'ip4_table_index': 4294967295,
107 'ip6_table_index': 4294967295,
108 'l2_table_index': 4294967295, },
109 'pppoe_add_del_session': {'is_add': 1, },
110 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
111 'proxy_arp_add_del': {'is_add': 1, },
112 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
113 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
115 'set_ipfix_exporter': {'collector_port': 4739, },
116 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
117 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
118 'svs_enable_disable': {'is_enable': 1, },
119 'svs_route_add_del': {'is_add': 1, },
120 'svs_table_add_del': {'is_add': 1, },
121 'sw_interface_add_del_address': {'is_add': 1, },
122 'sw_interface_dump': {'sw_if_index': 4294967295, },
123 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
124 'pref_lifetime': 4294967295, },
125 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
126 'sw_interface_set_l2_bridge': {'enable': 1, },
127 'sw_interface_set_mpls_enable': {'enable': 1, },
128 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
129 'sw_interface_set_unnumbered': {'is_add': 1, },
130 'sw_interface_span_enable_disable': {'state': 1, },
131 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
132 'decap_next_index': 4294967295,
133 'instance': 4294967295, },
134 'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
135 'instance': 4294967295, },
136 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
137 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
139 'want_bfd_events': {'enable_disable': 1, },
140 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
141 'want_dhcp6_reply_events': {'enable_disable': 1, },
142 'want_igmp_events': {'enable': 1, },
143 'want_interface_events': {'enable_disable': 1, },
144 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
145 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
146 'want_ip6_ra_events': {'enable_disable': 1, },
147 'want_l2_macs_events': {'enable_disable': 1, },
151 class CliFailedCommandError(Exception):
152 """ cli command failed."""
155 class CliSyntaxError(Exception):
156 """ cli command had a syntax error."""
159 class UnexpectedApiReturnValueError(Exception):
160 """ exception raised when the API return value is unexpected """
164 class VppPapiProvider(object):
165 """VPP-api provider using vpp-papi
167 @property hook: hook object providing before and after api/cli hooks
170 _zero, _negative = range(2)
172 def __init__(self, name, shm_prefix, test_class, read_timeout):
173 self.hook = Hook(test_class)
175 self.shm_prefix = shm_prefix
176 self.test_class = test_class
177 self._expect_api_retval = self._zero
178 self._expect_stack = []
180 # install_dir is a class attribute. We need to set it before
181 # calling the constructor.
182 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
186 if os.environ['SOCKET'] == '1':
191 self.vpp = VPPApiClient(logger=test_class.logger,
192 read_timeout=read_timeout,
193 use_socket=use_socket,
194 server_address=test_class.api_sock)
195 self._events = deque()
200 def assert_negative_api_retval(self):
201 """ Expect API failure - used with with, e.g.:
202 with self.vapi.assert_negative_api_retval():
203 self.vapi.<api call expected to fail>
205 self._expect_stack.append(self._expect_api_retval)
206 self._expect_api_retval = self._negative
209 def assert_zero_api_retval(self):
210 """ Expect API success - used with with, e.g.:
211 with self.vapi.assert_negative_api_retval():
212 self.vapi.<api call expected to succeed>
214 note: this is useful only inside another with block
215 as success is the default expected value
217 self._expect_stack.append(self._expect_api_retval)
218 self._expect_api_retval = self._zero
221 def __exit__(self, exc_type, exc_value, traceback):
222 self._expect_api_retval = self._expect_stack.pop()
224 def register_hook(self, hook):
225 """Replace hook registration with new hook
232 def collect_events(self):
233 """ Collect all events from the internal queue and clear the queue. """
235 self._events = deque()
238 def wait_for_event(self, timeout, name=None):
239 """ Wait for and return next event. """
241 self.test_class.logger.debug("Expecting event '%s' within %ss",
244 self.test_class.logger.debug("Expecting event within %ss",
247 self.test_class.logger.debug("Not waiting, event already queued")
248 limit = time.time() + timeout
249 while time.time() < limit:
251 e = self._events.popleft()
252 if name and type(e).__name__ != name:
254 "Unexpected event received: %s, expected: %s" %
255 (type(e).__name__, name))
256 self.test_class.logger.debug("Returning event %s:%s" %
259 self.test_class.sleep(0) # yield
260 raise Exception("Event did not occur within timeout")
262 def __call__(self, name, event):
263 """ Enqueue event in the internal event queue. """
264 # FIXME use the name instead of relying on type(e).__name__ ?
265 # FIXME #2 if this throws, it is eaten silently, Ole?
266 self.test_class.logger.debug("New event: %s: %s" % (name, event))
267 self._events.append(event)
269 def factory(self, name, apifn):
271 fields = apifn._func.msg.fields
273 # add positional and kw arguments
275 for i, o in enumerate(fields[3:]):
282 if name in defaultmapping:
283 for k, v in iteritems(defaultmapping[name]):
287 return self.api(apifn, d)
291 def __getattribute__(self, name):
293 method = super(VppPapiProvider, self).__getattribute__(name)
294 except AttributeError:
295 method = self.factory(name, getattr(self.papi, name))
296 # lazily load the method so we don't need to call factory
297 # again for this name.
298 setattr(self, name, method)
302 """Connect the API to VPP"""
303 self.vpp.connect(self.name, self.shm_prefix)
304 self.papi = self.vpp.api
305 self.vpp.register_event_callback(self)
307 def disconnect(self):
308 """Disconnect the API from VPP"""
309 self.vpp.disconnect()
311 def api(self, api_fn, api_args, expected_retval=0):
312 """ Call API function and check it's return value.
313 Call the appropriate hooks before and after the API call
315 :param api_fn: API function to call
316 :param api_args: tuple of API function arguments
317 :param expected_retval: Expected return value (Default value = 0)
318 :returns: reply from the API
321 self.hook.before_api(api_fn.__name__, api_args)
322 reply = api_fn(**api_args)
323 if self._expect_api_retval == self._negative:
324 if hasattr(reply, 'retval') and reply.retval >= 0:
325 msg = "API call passed unexpectedly: expected negative " \
326 "return value instead of %d in %s" % \
327 (reply.retval, moves.reprlib.repr(reply))
328 self.test_class.logger.info(msg)
329 raise UnexpectedApiReturnValueError(msg)
330 elif self._expect_api_retval == self._zero:
331 if hasattr(reply, 'retval') and reply.retval != expected_retval:
332 msg = "API call failed, expected %d return value instead " \
333 "of %d in %s" % (expected_retval, reply.retval,
334 moves.reprlib.repr(reply))
335 self.test_class.logger.info(msg)
336 raise UnexpectedApiReturnValueError(msg)
338 raise Exception("Internal error, unexpected value for "
339 "self._expect_api_retval %s" %
340 self._expect_api_retval)
341 self.hook.after_api(api_fn.__name__, api_args)
345 """ Execute a CLI, calling the before/after hooks appropriately.
347 :param cli: CLI to execute
351 self.hook.before_cli(cli)
353 r = self.papi.cli_inband(cmd=cli)
354 self.hook.after_cli(cli)
356 raise CliSyntaxError(r.reply)
358 raise CliFailedCommandError(r.reply)
359 if hasattr(r, 'reply'):
362 def ppcli(self, cli):
363 """ Helper method to print CLI command in case of info logging level.
365 :param cli: CLI to execute
368 return cli + "\n" + str(self.cli(cli))
370 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
371 return self.api(self.papi.want_ip4_arp_events,
372 {'enable_disable': enable_disable,
374 'pid': os.getpid(), })
376 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
377 return self.api(self.papi.want_ip6_nd_events,
378 {'enable_disable': enable_disable,
380 'pid': os.getpid(), })
382 def want_ip6_ra_events(self, enable_disable=1):
383 return self.api(self.papi.want_ip6_ra_events,
384 {'enable_disable': enable_disable,
385 'pid': os.getpid(), })
387 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
389 return self.api(self.papi.ip6nd_send_router_solicitation,
394 'sw_if_index': sw_if_index})
396 def want_interface_events(self, enable_disable=1):
397 return self.api(self.papi.want_interface_events,
398 {'enable_disable': enable_disable,
399 'pid': os.getpid(), })
401 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
402 max_macs_in_event=0, learn_limit=0):
403 return self.api(self.papi.want_l2_macs_events,
404 {'enable_disable': enable_disable,
405 'scan_delay': scan_delay,
406 'max_macs_in_event': max_macs_in_event,
407 'learn_limit': learn_limit,
408 'pid': os.getpid(), })
410 def want_dhcp6_reply_events(self, enable_disable=1):
411 return self.api(self.papi.want_dhcp6_reply_events,
412 {'enable_disable': enable_disable,
415 def want_dhcp6_pd_reply_events(self, enable_disable=1):
416 return self.api(self.papi.want_dhcp6_pd_reply_events,
417 {'enable_disable': enable_disable,
420 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
421 prefixes, server_index=0xFFFFFFFF,
422 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
424 return self.api(self.papi.dhcp6_pd_send_client_message,
425 {'sw_if_index': sw_if_index,
426 'server_index': server_index,
432 'msg_type': msg_type,
435 'n_prefixes': len(prefixes),
436 'prefixes': prefixes})
438 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
440 return self.api(self.papi.dhcp6_client_enable_disable,
441 {'sw_if_index': sw_if_index,
444 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
446 return self.api(self.papi.dhcp6_pd_client_enable_disable,
447 {'sw_if_index': sw_if_index,
448 'prefix_group': prefix_group,
451 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
452 prefix_length, prefix_group,
454 return self.api(self.papi.ip6_add_del_address_using_prefix,
455 {'sw_if_index': sw_if_index,
456 'prefix_group': prefix_group,
458 'prefix_length': prefix_length,
461 def sw_interface_set_mac_address(self, sw_if_index, mac):
462 return self.api(self.papi.sw_interface_set_mac_address,
463 {'sw_if_index': sw_if_index,
466 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
467 """Create p2p ethernet subinterface
469 :param sw_if_index: main (parent) interface
470 :param remote_mac: client (remote) mac address
474 self.papi.p2p_ethernet_add,
475 {'parent_if_index': sw_if_index,
476 'remote_mac': remote_mac,
477 'subif_id': subif_id})
479 def p2p_ethernet_del(self, sw_if_index, remote_mac):
480 """Delete p2p ethernet subinterface
482 :param sw_if_index: main (parent) interface
483 :param remote_mac: client (remote) mac address
487 self.papi.p2p_ethernet_del,
488 {'parent_if_index': sw_if_index,
489 'remote_mac': remote_mac})
491 def create_vlan_subif(self, sw_if_index, vlan):
498 return self.api(self.papi.create_vlan_subif,
499 {'sw_if_index': sw_if_index,
502 def create_loopback(self, mac=''):
505 :param mac: (Optional)
507 return self.api(self.papi.create_loopback,
508 {'mac_address': mac})
510 def ip_table_add_del(self,
517 :param is_add: (Default value = 1)
518 :param is_ipv6: (Default value = 0)
523 self.papi.ip_table_add_del,
526 'table_id': table_id,
531 def ip_table_dump(self):
532 return self.api(self.papi.ip_table_dump, {})
534 def ip_route_dump(self, table_id, is_ip6=False):
535 return self.api(self.papi.ip_route_dump,
537 'table_id': table_id,
541 def ip_neighbor_add_del(self,
547 """ Add neighbor MAC to IPv4 or IPv6 address.
552 :param is_add: (Default value = 1)
553 :param flags: (Default value = 0/NONE)
556 self.papi.ip_neighbor_add_del,
560 'sw_if_index': sw_if_index,
562 'mac_address': mac_address,
563 'ip_address': ip_address
568 def proxy_arp_add_del(self,
573 """ Config Proxy Arp Range.
575 :param low_address: Start address in the rnage to Proxy for
576 :param hi_address: End address in the rnage to Proxy for
577 :param vrf_id: The VRF/table in which to proxy
581 self.papi.proxy_arp_add_del,
584 'table_id': table_id,
590 def proxy_arp_intfc_enable_disable(self,
593 """ Enable/Disable an interface for proxy ARP requests
595 :param sw_if_index: Interface
596 :param enable_disable: Enable/Disable
600 self.papi.proxy_arp_intfc_enable_disable,
601 {'sw_if_index': sw_if_index,
602 'enable_disable': is_enable
606 def gre_tunnel_add_del(self,
618 :param outer_fib_id: (Default value = 0)
619 :param tunnel_type: (Default value = 0)
620 :param instance: (Default value = 0xFFFFFFFF)
621 :param session_id: (Default value = 0)
622 :param is_add: (Default value = 1)
623 :param is_ipv6: (Default value = 0)
627 self.papi.gre_tunnel_add_del,
632 'instance': instance,
635 'outer_fib_id': outer_fib_id,
636 'session_id': session_id}
640 def udp_encap_add(self,
651 :param outer_fib_id: (Default value = 0)
655 self.papi.udp_encap_add,
660 'src_port': src_port,
661 'dst_port': dst_port,
666 def udp_encap_del(self, id):
667 return self.api(self.papi.udp_encap_del, {'id': id})
669 def udp_encap_dump(self):
670 return self.api(self.papi.udp_encap_dump, {})
672 def want_udp_encap_stats(self, enable=1):
673 return self.api(self.papi.want_udp_encap_stats,
677 def mpls_route_dump(self, table_id):
678 return self.api(self.papi.mpls_route_dump,
680 'mt_table_id': table_id
683 def mpls_table_dump(self):
684 return self.api(self.papi.mpls_table_dump, {})
686 def mpls_table_add_del(
693 :param is_add: (Default value = 1)
698 self.papi.mpls_table_add_del,
701 'mt_table_id': table_id,
703 'mt_is_add': is_add})
705 def mpls_route_add_del(self,
714 """ MPLS Route add/del """
716 self.papi.mpls_route_add_del,
719 'mr_table_id': table_id,
722 'mr_eos_proto': eos_proto,
723 'mr_is_multicast': is_multicast,
724 'mr_n_paths': len(paths),
728 'mr_is_multipath': is_multipath})
730 def mpls_ip_bind_unbind(
740 self.papi.mpls_ip_bind_unbind,
741 {'mb_mpls_table_id': table_id,
743 'mb_ip_table_id': ip_table_id,
744 'mb_is_bind': is_bind,
745 'mb_prefix': prefix})
747 def mpls_tunnel_add_del(
757 self.papi.mpls_tunnel_add_del,
758 {'mt_is_add': is_add,
761 'mt_sw_if_index': tun_sw_if_index,
762 'mt_l2_only': l2_only,
763 'mt_is_multicast': is_multicast,
764 'mt_n_paths': len(paths),
768 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
769 detect_mult, local_addr, peer_addr, is_ipv6=0,
770 bfd_key_id=None, conf_key_id=None):
771 if bfd_key_id is None:
772 return self.api(self.papi.bfd_udp_add,
774 'sw_if_index': sw_if_index,
775 'desired_min_tx': desired_min_tx,
776 'required_min_rx': required_min_rx,
777 'local_addr': local_addr,
778 'peer_addr': peer_addr,
780 'detect_mult': detect_mult,
783 return self.api(self.papi.bfd_udp_add,
785 'sw_if_index': sw_if_index,
786 'desired_min_tx': desired_min_tx,
787 'required_min_rx': required_min_rx,
788 'local_addr': local_addr,
789 'peer_addr': peer_addr,
791 'detect_mult': detect_mult,
792 'is_authenticated': 1,
793 'bfd_key_id': bfd_key_id,
794 'conf_key_id': conf_key_id,
797 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
798 detect_mult, local_addr, peer_addr, is_ipv6=0):
799 return self.api(self.papi.bfd_udp_mod,
801 'sw_if_index': sw_if_index,
802 'desired_min_tx': desired_min_tx,
803 'required_min_rx': required_min_rx,
804 'local_addr': local_addr,
805 'peer_addr': peer_addr,
807 'detect_mult': detect_mult,
810 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
811 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
813 return self.api(self.papi.bfd_udp_auth_activate,
815 'sw_if_index': sw_if_index,
816 'local_addr': local_addr,
817 'peer_addr': peer_addr,
819 'is_delayed': 1 if is_delayed else 0,
820 'bfd_key_id': bfd_key_id,
821 'conf_key_id': conf_key_id,
824 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
825 peer_addr, is_ipv6=0):
826 return self.api(self.papi.bfd_udp_session_set_flags, {
827 'admin_up_down': admin_up_down,
828 'sw_if_index': sw_if_index,
829 'local_addr': local_addr,
830 'peer_addr': peer_addr,
834 def want_bfd_events(self, enable_disable=1):
835 return self.api(self.papi.want_bfd_events, {
836 'enable_disable': enable_disable,
840 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
841 return self.api(self.papi.bfd_auth_set_key, {
842 'conf_key_id': conf_key_id,
843 'auth_type': auth_type,
848 def classify_add_del_table(
853 table_index=0xFFFFFFFF,
857 next_table_index=0xFFFFFFFF,
858 miss_next_index=0xFFFFFFFF,
860 current_data_offset=0):
864 :param match_n_vectors: (Default value = 1)
865 :param table_index: (Default value = 0xFFFFFFFF)
866 :param nbuckets: (Default value = 2)
867 :param memory_size: (Default value = 2097152)
868 :param skip_n_vectors: (Default value = 0)
869 :param next_table_index: (Default value = 0xFFFFFFFF)
870 :param miss_next_index: (Default value = 0xFFFFFFFF)
871 :param current_data_flag: (Default value = 0)
872 :param current_data_offset: (Default value = 0)
875 mask_len = ((len(mask) - 1) / 16 + 1) * 16
876 mask = mask + '\0' * (mask_len - len(mask))
878 self.papi.classify_add_del_table,
880 'table_index': table_index,
881 'nbuckets': nbuckets,
882 'memory_size': memory_size,
883 'skip_n_vectors': skip_n_vectors,
884 'match_n_vectors': match_n_vectors,
885 'next_table_index': next_table_index,
886 'miss_next_index': miss_next_index,
887 'current_data_flag': current_data_flag,
888 'current_data_offset': current_data_offset,
889 'mask_len': mask_len,
892 def classify_add_del_session(
897 opaque_index=0xFFFFFFFF,
898 hit_next_index=0xFFFFFFFF,
906 :param opaque_index: (Default value = 0xFFFFFFFF)
907 :param hit_next_index: (Default value = 0xFFFFFFFF)
908 :param advance: (Default value = 0)
909 :param action: (Default value = 0)
910 :param metadata: (Default value = 0)
913 match_len = ((len(match) - 1) / 16 + 1) * 16
914 match = match + '\0' * (match_len - len(match))
916 self.papi.classify_add_del_session,
918 'table_index': table_index,
919 'hit_next_index': hit_next_index,
920 'opaque_index': opaque_index,
923 'metadata': metadata,
924 'match_len': match_len,
927 def input_acl_set_interface(
931 ip4_table_index=0xFFFFFFFF,
932 ip6_table_index=0xFFFFFFFF,
933 l2_table_index=0xFFFFFFFF):
937 :param ip4_table_index: (Default value = 0xFFFFFFFF)
938 :param ip6_table_index: (Default value = 0xFFFFFFFF)
939 :param l2_table_index: (Default value = 0xFFFFFFFF)
943 self.papi.input_acl_set_interface,
944 {'sw_if_index': sw_if_index,
945 'ip4_table_index': ip4_table_index,
946 'ip6_table_index': ip6_table_index,
947 'l2_table_index': l2_table_index,
950 def output_acl_set_interface(
954 ip4_table_index=0xFFFFFFFF,
955 ip6_table_index=0xFFFFFFFF,
956 l2_table_index=0xFFFFFFFF):
960 :param ip4_table_index: (Default value = 0xFFFFFFFF)
961 :param ip6_table_index: (Default value = 0xFFFFFFFF)
962 :param l2_table_index: (Default value = 0xFFFFFFFF)
966 self.papi.output_acl_set_interface,
967 {'sw_if_index': sw_if_index,
968 'ip4_table_index': ip4_table_index,
969 'ip6_table_index': ip6_table_index,
970 'l2_table_index': l2_table_index,
973 def set_ipfix_exporter(
983 self.papi.set_ipfix_exporter,
985 'collector_address': collector_address,
986 'collector_port': collector_port,
987 'src_address': src_address,
989 'path_mtu': path_mtu,
990 'template_interval': template_interval,
991 'udp_checksum': udp_checksum,
994 def dhcp_proxy_config(self,
1002 self.papi.dhcp_proxy_config,
1004 'rx_vrf_id': rx_table_id,
1005 'server_vrf_id': server_table_id,
1008 'dhcp_server': dhcp_server,
1009 'dhcp_src_address': dhcp_src_address,
1012 def dhcp_proxy_set_vss(self,
1021 self.papi.dhcp_proxy_set_vss,
1024 'vss_type': vss_type,
1025 'vpn_ascii_id': vpn_ascii_id,
1027 'vpn_index': vpn_index,
1032 def dhcp_client_config(self,
1037 set_broadcast_flag=1,
1038 want_dhcp_events=0):
1040 self.papi.dhcp_client_config,
1044 'sw_if_index': sw_if_index,
1045 'hostname': hostname,
1047 'want_dhcp_event': want_dhcp_events,
1048 'set_broadcast_flag': set_broadcast_flag,
1052 def ip_mroute_add_del(self,
1061 IP Multicast Route add/del
1064 self.papi.ip_mroute_add_del,
1067 'is_multipath': is_multipath,
1069 'table_id': table_id,
1070 'entry_flags': e_flags,
1073 'n_paths': len(paths),
1078 def mfib_signal_dump(self):
1079 return self.api(self.papi.mfib_signal_dump, {})
1081 def ip_mroute_dump(self, table_id, is_ip6=False):
1082 return self.api(self.papi.ip_mroute_dump,
1084 'table_id': table_id,
1088 def lisp_enable_disable(self, is_enabled):
1090 self.papi.lisp_enable_disable,
1092 'is_en': is_enabled,
1095 def lisp_add_del_locator_set(self,
1099 self.papi.lisp_add_del_locator_set,
1102 'locator_set_name': ls_name
1105 def lisp_add_del_locator(self,
1112 self.papi.lisp_add_del_locator,
1115 'locator_set_name': ls_name,
1116 'sw_if_index': sw_if_index,
1117 'priority': priority,
1121 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1123 self.papi.lisp_locator_dump,
1125 'is_index_set': is_index_set,
1127 'ls_index': ls_index,
1130 def lisp_add_del_local_eid(self,
1140 self.papi.lisp_add_del_local_eid,
1142 'locator_set_name': ls_name,
1144 'eid_type': eid_type,
1146 'prefix_len': prefix_len,
1152 def lisp_eid_table_dump(self,
1160 self.papi.lisp_eid_table_dump,
1163 'prefix_length': prefix_length,
1165 'eid_type': eid_type,
1167 'filter': filter_opt,
1170 def lisp_add_del_remote_mapping(self,
1180 self.papi.lisp_add_del_remote_mapping,
1183 'eid_type': eid_type,
1185 'eid_len': eid_prefix_len,
1186 'rloc_num': rlocs_num,
1189 'is_src_dst': is_src_dst,
1192 def lisp_add_del_adjacency(self,
1201 self.papi.lisp_add_del_adjacency,
1205 'eid_type': eid_type,
1208 'leid_len': leid_len,
1209 'reid_len': reid_len,
1212 def gtpu_add_del_tunnel(
1218 mcast_sw_if_index=0xFFFFFFFF,
1220 decap_next_index=0xFFFFFFFF,
1224 :param is_add: (Default value = 1)
1225 :param is_ipv6: (Default value = 0)
1228 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1229 :param encap_vrf_id: (Default value = 0)
1230 :param decap_next_index: (Default value = 0xFFFFFFFF)
1231 :param teid: (Default value = 0)
1234 return self.api(self.papi.gtpu_add_del_tunnel,
1237 'src_address': src_addr,
1238 'dst_address': dst_addr,
1239 'mcast_sw_if_index': mcast_sw_if_index,
1240 'encap_vrf_id': encap_vrf_id,
1241 'decap_next_index': decap_next_index,
1244 def vxlan_gpe_add_del_tunnel(
1248 mcast_sw_if_index=0xFFFFFFFF,
1259 :param is_add: (Default value = 1)
1260 :param is_ipv6: (Default value = 0)
1261 :param encap_vrf_id: (Default value = 0)
1262 :param decap_vrf_id: (Default value = 0)
1263 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1264 :param protocol: (Default value = 3)
1265 :param vni: (Default value = 0)
1268 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1273 'mcast_sw_if_index': mcast_sw_if_index,
1274 'encap_vrf_id': encap_vrf_id,
1275 'decap_vrf_id': decap_vrf_id,
1276 'protocol': protocol,
1279 def vxlan_gbp_tunnel_add_del(
1283 mcast_sw_if_index=0xFFFFFFFF,
1289 instance=0xFFFFFFFF):
1294 :param is_add: (Default value = 1)
1295 :param is_ipv6: (Default value = 0)
1296 :param encap_table_id: (Default value = 0)
1297 :param decap_next_index: (Default value = 0xFFFFFFFF)
1298 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1299 :param vni: (Default value = 0)
1300 :param instance: (Default value = 0xFFFFFFFF)
1303 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
1308 'mcast_sw_if_index': mcast_sw_if_index,
1309 'encap_table_id': encap_table_id,
1311 'instance': instance,
1314 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1315 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1316 {'sw_if_index': sw_if_index,
1317 '_no_type_conversion': True})
1319 def pppoe_add_del_session(
1329 :param is_add: (Default value = 1)
1330 :param is_ipv6: (Default value = 0)
1332 :param session_id: (Default value = 0)
1334 :param decap_vrf_id: (Default value = 0)
1337 return self.api(self.papi.pppoe_add_del_session,
1340 'session_id': session_id,
1341 'client_ip': client_ip,
1342 'decap_vrf_id': decap_vrf_id,
1343 'client_mac': client_mac})
1345 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1346 return self.api(self.papi.sr_mpls_policy_add,
1350 'n_segments': len(segments),
1351 'segments': segments})
1353 def sr_mpls_policy_del(self, bsid):
1354 return self.api(self.papi.sr_mpls_policy_del,
1357 def sr_localsid_add_del(self,
1364 sw_if_index=0xFFFFFFFF,
1368 """ Add/del IPv6 SR local-SID.
1371 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1372 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1375 :param is_del: (Default value = 0)
1376 :param end_psp: (Default value = 0)
1377 :param sw_if_index: (Default value = 0xFFFFFFFF)
1378 :param vlan_index: (Default value = 0)
1379 :param fib_table: (Default value = 0)
1382 self.papi.sr_localsid_add_del,
1384 'localsid': localsid,
1386 'behavior': behavior,
1387 'sw_if_index': sw_if_index,
1388 'vlan_index': vlan_index,
1389 'fib_table': fib_table,
1390 'nh_addr4': nh_addr4,
1391 'nh_addr6': nh_addr6
1405 :param bsid_addr: bindingSID of the SR Policy
1406 :param weight: weight of the sid list. optional. (default: 1)
1407 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1409 :param type: type/behavior of the SR policy. (default or spray) \
1411 :param fib_table: VRF where to install the FIB entry for the BSID \
1413 :param n_segments: number of segments \
1415 :param segments: a vector of IPv6 address composing the segment list \
1419 self.papi.sr_policy_add,
1420 {'bsid_addr': bsid_addr,
1422 'is_encap': is_encap,
1424 'fib_table': fib_table,
1425 'n_segments': n_segments,
1426 'segments': segments
1435 :param bsid: bindingSID of the SR Policy
1436 :param sr_policy_index: index of the sr policy (default: 0)
1439 self.papi.sr_policy_del,
1440 {'bsid_addr': bsid_addr,
1441 'sr_policy_index': sr_policy_index
1444 def sr_steering_add_del(
1455 Steer traffic L2 and L3 traffic through a given SR policy
1457 :param is_del: delete or add
1458 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1459 :param sr_policy: is the index of the SR Policy (alt to bsid)
1460 :param table_id: is the VRF where to install the FIB entry for the BSID
1461 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1462 :param mask_width: is the mask for L3 traffic type
1463 :param sw_if_index: is the incoming interface for L2 traffic
1464 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1467 self.papi.sr_steering_add_del,
1469 'bsid_addr': bsid_addr,
1470 'sr_policy_index': sr_policy_index,
1471 'table_id': table_id,
1472 'prefix_addr': prefix_addr,
1473 'mask_width': mask_width,
1474 'sw_if_index': sw_if_index,
1475 'traffic_type': traffic_type
1478 def acl_add_replace(self, acl_index, r, tag='',
1480 """Add/replace an ACL
1481 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1482 :param acl_rule r: ACL rules array.
1483 :param str tag: symbolic tag (description) for this ACL.
1484 :param int count: number of rules.
1486 return self.api(self.papi.acl_add_replace,
1487 {'acl_index': acl_index,
1491 expected_retval=expected_retval)
1493 def acl_del(self, acl_index, expected_retval=0):
1499 return self.api(self.papi.acl_del,
1500 {'acl_index': acl_index},
1501 expected_retval=expected_retval)
1503 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1505 return self.api(self.papi.acl_interface_set_acl_list,
1506 {'sw_if_index': sw_if_index,
1510 expected_retval=expected_retval)
1512 def acl_interface_set_etype_whitelist(self, sw_if_index,
1515 return self.api(self.papi.acl_interface_set_etype_whitelist,
1516 {'sw_if_index': sw_if_index,
1517 'count': len(whitelist),
1519 'whitelist': whitelist},
1520 expected_retval=expected_retval)
1522 def acl_interface_add_del(self,
1526 """ Add/Delete ACL to/from interface
1530 :param is_add: (Default value = 1)
1533 return self.api(self.papi.acl_interface_add_del,
1536 'sw_if_index': sw_if_index,
1537 'acl_index': acl_index})
1539 def acl_dump(self, acl_index, expected_retval=0):
1540 return self.api(self.papi.acl_dump,
1541 {'acl_index': acl_index},
1542 expected_retval=expected_retval)
1544 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1546 return self.api(self.papi.acl_interface_list_dump,
1547 {'sw_if_index': sw_if_index},
1548 expected_retval=expected_retval)
1550 def macip_acl_add(self, rules, tag=""):
1553 :param rules: list of rules for given acl
1557 return self.api(self.papi.macip_acl_add,
1559 'count': len(rules),
1562 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1565 :param rules: list of rules for given acl
1569 return self.api(self.papi.macip_acl_add_replace,
1570 {'acl_index': acl_index,
1572 'count': len(rules),
1575 def macip_acl_interface_add_del(self,
1579 """ Add MACIP acl to interface
1583 :param is_add: (Default value = 1)
1586 return self.api(self.papi.macip_acl_interface_add_del,
1588 'sw_if_index': sw_if_index,
1589 'acl_index': acl_index})
1591 def macip_acl_dump(self, acl_index=4294967295):
1592 """ Return MACIP acl dump
1596 self.papi.macip_acl_dump, {'acl_index': acl_index})
1598 def policer_add_del(self,
1609 conform_action_type=1,
1611 exceed_action_type=0,
1613 violate_action_type=0,
1615 return self.api(self.papi.policer_add_del,
1622 'rate_type': rate_type,
1623 'round_type': round_type,
1625 'color_aware': color_aware,
1626 'conform_action_type': conform_action_type,
1627 'conform_dscp': conform_dscp,
1628 'exceed_action_type': exceed_action_type,
1629 'exceed_dscp': exceed_dscp,
1630 'violate_action_type': violate_action_type,
1631 'violate_dscp': violate_dscp})
1633 def ip_punt_police(self,
1637 return self.api(self.papi.ip_punt_police,
1638 {'policer_index': policer_index,
1642 def ip_punt_redirect(self,
1647 return self.api(self.papi.ip_punt_redirect,
1648 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1649 'tx_sw_if_index': tx_sw_if_index,
1653 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1654 return self.api(self.papi.ip_punt_redirect_dump,
1655 {'sw_if_index': sw_if_index,
1656 'is_ipv6': is_ipv6})
1658 def bier_table_add_del(self,
1662 """ BIER Table add/del """
1664 self.papi.bier_table_add_del,
1665 {'bt_tbl_id': {"bt_set": bti.set_id,
1666 "bt_sub_domain": bti.sub_domain_id,
1667 "bt_hdr_len_id": bti.hdr_len_id},
1668 'bt_label': mpls_label,
1669 'bt_is_add': is_add})
1671 def bier_table_dump(self):
1672 return self.api(self.papi.bier_table_dump, {})
1674 def bier_route_add_del(self,
1680 """ BIER Route add/del """
1682 self.papi.bier_route_add_del,
1685 'br_tbl_id': {"bt_set": bti.set_id,
1686 "bt_sub_domain": bti.sub_domain_id,
1687 "bt_hdr_len_id": bti.hdr_len_id},
1689 'br_n_paths': len(paths),
1692 'br_is_add': is_add,
1693 'br_is_replace': is_replace
1696 def bier_route_dump(self, bti):
1698 self.papi.bier_route_dump,
1699 {'br_tbl_id': {"bt_set": bti.set_id,
1700 "bt_sub_domain": bti.sub_domain_id,
1701 "bt_hdr_len_id": bti.hdr_len_id}})
1703 def bier_imp_add(self,
1708 """ BIER Imposition Add """
1710 self.papi.bier_imp_add,
1711 {'bi_tbl_id': {"bt_set": bti.set_id,
1712 "bt_sub_domain": bti.sub_domain_id,
1713 "bt_hdr_len_id": bti.hdr_len_id},
1715 'bi_n_bytes': len(ibytes),
1716 'bi_bytes': ibytes})
1718 def bier_imp_del(self, bi_index):
1719 """ BIER Imposition del """
1721 self.papi.bier_imp_del,
1722 {'bi_index': bi_index})
1724 def bier_imp_dump(self):
1725 return self.api(self.papi.bier_imp_dump, {})
1727 def bier_disp_table_add_del(self,
1730 """ BIER Disposition Table add/del """
1732 self.papi.bier_disp_table_add_del,
1733 {'bdt_tbl_id': bdti,
1734 'bdt_is_add': is_add})
1736 def bier_disp_table_dump(self):
1737 return self.api(self.papi.bier_disp_table_dump, {})
1739 def bier_disp_entry_add_del(self,
1749 """ BIER Route add/del """
1751 while (len(lstack) < 16):
1754 self.papi.bier_disp_entry_add_del,
1755 {'bde_tbl_id': bdti,
1757 'bde_payload_proto': payload_proto,
1759 'bde_paths': [{'next_hop': next_hop,
1760 'table_id': next_hop_tbl_id,
1761 'afi': next_hop_afi,
1762 'rpf_id': next_hop_rpf_id,
1764 'label_stack': lstack}],
1765 'bde_is_add': is_add})
1767 def bier_disp_entry_dump(self, bdti):
1769 self.papi.bier_disp_entry_dump,
1770 {'bde_tbl_id': bdti})
1772 def session_enable_disable(self, is_enabled):
1774 self.papi.session_enable_disable,
1775 {'is_enable': is_enabled})
1777 def ipsec_spd_add_del(self, spd_id, is_add=1):
1778 """ SPD add/del - Wrapper to add or del ipsec SPD
1779 Sample CLI : 'ipsec spd add 1'
1781 :param spd_id - SPD ID to be created in the vpp . mandatory
1782 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1784 :returns: reply from the API
1787 self.papi.ipsec_spd_add_del, {
1788 'spd_id': spd_id, 'is_add': is_add})
1790 def ipsec_spds_dump(self):
1791 return self.api(self.papi.ipsec_spds_dump, {})
1793 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1794 """ IPSEC interface SPD add/del - \
1795 Wrapper to associate/disassociate SPD to interface in VPP
1796 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1798 :param spd_id - SPD ID to associate with the interface . mandatory
1799 :param sw_if_index - Interface Index which needs to ipsec \
1800 association mandatory
1801 :param is_add - add(1) or del(0) association with interface \
1802 (Default 1 - add) . optional
1803 :returns: reply from the API
1806 self.papi.ipsec_interface_add_del_spd,
1807 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1809 def ipsec_spd_interface_dump(self, spd_index=None):
1810 return self.api(self.papi.ipsec_spd_interface_dump,
1811 {'spd_index': spd_index if spd_index else 0,
1812 'spd_index_valid': 1 if spd_index else 0})
1814 def ipsec_sad_entry_add_del(self,
1817 integrity_algorithm,
1822 tunnel_src_address='',
1823 tunnel_dst_address='',
1827 """ IPSEC SA add/del
1828 :param sad_id: security association ID
1829 :param spi: security param index of the SA in decimal
1830 :param integrity_algorithm:
1831 :param integrity_key:
1832 :param crypto_algorithm:
1834 :param protocol: AH(0) or ESP(1) protocol
1835 :param tunnel_src_address: tunnel mode outer src address
1836 :param tunnel_dst_address: tunnel mode outer dst address
1839 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1840 crypto and ipsec algorithms
1843 self.papi.ipsec_sad_entry_add_del,
1850 'tunnel_src': tunnel_src_address,
1851 'tunnel_dst': tunnel_dst_address,
1852 'protocol': protocol,
1853 'integrity_algorithm': integrity_algorithm,
1855 'length': len(integrity_key),
1856 'data': integrity_key,
1858 'crypto_algorithm': crypto_algorithm,
1860 'length': len(crypto_key),
1868 def ipsec_sa_dump(self, sa_id=None):
1869 return self.api(self.papi.ipsec_sa_dump,
1870 {'sa_id': sa_id if sa_id else 0xffffffff})
1872 def ipsec_spd_entry_add_del(self,
1875 local_address_start,
1877 remote_address_start,
1878 remote_address_stop,
1880 local_port_stop=65535,
1881 remote_port_start=0,
1882 remote_port_stop=65535,
1890 """ IPSEC policy SPD add/del -
1891 Wrapper to configure ipsec SPD policy entries in VPP
1892 :param spd_id: SPD ID for the policy
1893 :param local_address_start: local-ip-range start address
1894 :param local_address_stop : local-ip-range stop address
1895 :param remote_address_start: remote-ip-range start address
1896 :param remote_address_stop : remote-ip-range stop address
1897 :param local_port_start: (Default value = 0)
1898 :param local_port_stop: (Default value = 65535)
1899 :param remote_port_start: (Default value = 0)
1900 :param remote_port_stop: (Default value = 65535)
1901 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1902 :param sa_id: Security Association ID for mapping it to SPD
1903 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1905 :param priority: value for the spd action (Default value = 100)
1906 :param is_outbound: flag for inbound(0) or outbound(1)
1908 :param is_add: (Default value = 1)
1911 self.papi.ipsec_spd_entry_add_del,
1918 'local_address_start': local_address_start,
1919 'local_address_stop': local_address_stop,
1920 'remote_address_start': remote_address_start,
1921 'remote_address_stop': remote_address_stop,
1922 'local_port_start': local_port_start,
1923 'local_port_stop': local_port_stop,
1924 'remote_port_start': remote_port_start,
1925 'remote_port_stop': remote_port_stop,
1926 'protocol': protocol,
1928 'priority': priority,
1929 'is_outbound': is_outbound,
1930 'is_ip_any': is_ip_any
1934 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1935 return self.api(self.papi.ipsec_spd_dump,
1939 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1940 remote_spi, crypto_alg, local_crypto_key,
1941 remote_crypto_key, integ_alg, local_integ_key,
1942 remote_integ_key, is_add=1, esn=0, salt=0,
1943 anti_replay=1, renumber=0,
1944 udp_encap=0, show_instance=0):
1946 self.papi.ipsec_tunnel_if_add_del,
1948 'local_ip': local_ip,
1949 'remote_ip': remote_ip,
1950 'local_spi': local_spi,
1951 'remote_spi': remote_spi,
1952 'crypto_alg': crypto_alg,
1953 'local_crypto_key_len': len(local_crypto_key),
1954 'local_crypto_key': local_crypto_key,
1955 'remote_crypto_key_len': len(remote_crypto_key),
1956 'remote_crypto_key': remote_crypto_key,
1957 'integ_alg': integ_alg,
1958 'local_integ_key_len': len(local_integ_key),
1959 'local_integ_key': local_integ_key,
1960 'remote_integ_key_len': len(remote_integ_key),
1961 'remote_integ_key': remote_integ_key,
1964 'anti_replay': anti_replay,
1965 'renumber': renumber,
1966 'show_instance': show_instance,
1967 'udp_encap': udp_encap,
1971 def ipsec_select_backend(self, protocol, index):
1972 return self.api(self.papi.ipsec_select_backend,
1973 {'protocol': protocol, 'index': index})
1975 def ipsec_backend_dump(self):
1976 return self.api(self.papi.ipsec_backend_dump, {})
1978 def app_namespace_add_del(self,
1982 sw_if_index=0xFFFFFFFF,
1985 self.papi.app_namespace_add_del,
1987 'sw_if_index': sw_if_index,
1988 'ip4_fib_id': ip4_fib_id,
1989 'ip6_fib_id': ip6_fib_id,
1990 'namespace_id': namespace_id,
1991 'namespace_id_len': len(namespace_id)})
1993 def punt_socket_register(self, reg, pathname,
1995 """ Register punt socket """
1996 return self.api(self.papi.punt_socket_register,
1997 {'header_version': header_version,
1999 'pathname': pathname})
2001 def punt_socket_deregister(self, reg):
2002 """ Unregister punt socket """
2003 return self.api(self.papi.punt_socket_deregister,
2006 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
2008 """ GBP endpoint Add """
2009 return self.api(self.papi.gbp_endpoint_add,
2011 'sw_if_index': sw_if_index,
2022 def gbp_endpoint_del(self, handle):
2023 """ GBP endpoint Del """
2024 return self.api(self.papi.gbp_endpoint_del,
2027 def gbp_endpoint_dump(self):
2028 """ GBP endpoint Dump """
2029 return self.api(self.papi.gbp_endpoint_dump,
2030 {'_no_type_conversion': True})
2032 def gbp_endpoint_group_add(self, vnid, sclass, bd,
2033 rd, uplink_sw_if_index,
2035 """ GBP endpoint group Add """
2036 return self.api(self.papi.gbp_endpoint_group_add,
2039 'uplink_sw_if_index': uplink_sw_if_index,
2044 'retention': retention
2047 def gbp_endpoint_group_del(self, sclass):
2048 """ GBP endpoint group Del """
2049 return self.api(self.papi.gbp_endpoint_group_del,
2052 def gbp_bridge_domain_add(self, bd_id, flags,
2055 bm_flood_sw_if_index):
2056 """ GBP bridge-domain Add """
2057 return self.api(self.papi.gbp_bridge_domain_add,
2061 'bvi_sw_if_index': bvi_sw_if_index,
2062 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2063 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2067 def gbp_bridge_domain_del(self, bd_id):
2068 """ GBP bridge-domain Del """
2069 return self.api(self.papi.gbp_bridge_domain_del,
2072 def gbp_route_domain_add(self, rd_id,
2076 ip6_uu_sw_if_index):
2077 """ GBP route-domain Add """
2078 return self.api(self.papi.gbp_route_domain_add,
2081 'ip4_table_id': ip4_table_id,
2082 'ip6_table_id': ip6_table_id,
2083 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2084 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2088 def gbp_route_domain_del(self, rd_id):
2089 """ GBP route-domain Del """
2090 return self.api(self.papi.gbp_route_domain_del,
2093 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2094 """ GBP recirc Add/Del """
2095 return self.api(self.papi.gbp_recirc_add_del,
2099 'sw_if_index': sw_if_index,
2102 def gbp_recirc_dump(self):
2103 """ GBP recirc Dump """
2104 return self.api(self.papi.gbp_recirc_dump, {})
2106 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2107 """ GBP recirc Add/Del """
2108 return self.api(self.papi.gbp_ext_itf_add_del,
2111 'sw_if_index': sw_if_index,
2115 def gbp_ext_itf_dump(self):
2116 """ GBP recirc Dump """
2117 return self.api(self.papi.gbp_ext_itf_dump, {})
2119 def gbp_subnet_add_del(self, is_add, rd_id,
2121 sw_if_index=0xffffffff,
2123 """ GBP Subnet Add/Del """
2124 return self.api(self.papi.gbp_subnet_add_del,
2128 'sw_if_index': sw_if_index,
2133 def gbp_subnet_dump(self):
2134 """ GBP Subnet Dump """
2135 return self.api(self.papi.gbp_subnet_dump,
2136 {'_no_type_conversion': True})
2138 def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2139 rules, allowed_ethertypes):
2140 """ GBP contract Add/Del """
2141 return self.api(self.papi.gbp_contract_add_del,
2144 'acl_index': acl_index,
2147 'n_rules': len(rules),
2149 'n_ether_types': len(allowed_ethertypes),
2150 'allowed_ethertypes': allowed_ethertypes}})
2152 def gbp_contract_dump(self):
2153 """ GBP contract Dump """
2154 return self.api(self.papi.gbp_contract_dump, {})
2156 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2157 """ GBP VXLAN tunnel add """
2158 return self.api(self.papi.gbp_vxlan_tunnel_add,
2163 'bd_rd_id': bd_rd_id,
2168 def gbp_vxlan_tunnel_del(self, vni):
2169 """ GBP VXLAN tunnel del """
2170 return self.api(self.papi.gbp_vxlan_tunnel_del,
2175 def gbp_vxlan_tunnel_dump(self):
2176 """ GBP VXLAN tunnel add/del """
2177 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2179 def qos_egress_map_update(self, id, outputs):
2180 """ QOS egress map update """
2181 return self.api(self.papi.qos_egress_map_update,
2185 def qos_egress_map_delete(self, id):
2186 """ QOS egress map delete """
2187 return self.api(self.papi.qos_egress_map_delete,
2190 def qos_mark_enable_disable(self, sw_if_index,
2194 """ QOS Mark Enable/Disable """
2195 return self.api(self.papi.qos_mark_enable_disable,
2197 'sw_if_index': sw_if_index,
2198 'output_source': output_source,
2201 def igmp_enable_disable(self, sw_if_index, enable, host):
2202 """ Enable/disable IGMP on a given interface """
2203 return self.api(self.papi.igmp_enable_disable,
2206 'sw_if_index': sw_if_index})
2208 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2209 """ Add/del IGMP proxy device """
2210 return self.api(self.papi.igmp_proxy_device_add_del,
2211 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2214 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2215 """ Add/del interface to/from IGMP proxy device """
2216 return self.api(self.papi.igmp_proxy_device_add_del_interface,
2217 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2220 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2221 """ Listen for new (S,G) on specified interface
2223 :param enable: add/del
2224 :param sw_if_index: interface sw index
2225 :param saddr: source ip4 addr
2226 :param gaddr: group ip4 addr
2228 return self.api(self.papi.igmp_listen,
2233 'sw_if_index': sw_if_index,
2234 'n_srcs': len(saddrs),
2240 def igmp_clear_interface(self, sw_if_index):
2241 """ Remove all (S,G)s from specified interface
2242 doesn't send IGMP report!
2245 self.papi.igmp_clear_interface, {
2246 'sw_if_index': sw_if_index})
2248 def want_igmp_events(self, enable=1):
2249 return self.api(self.papi.want_igmp_events, {'enable': enable,
2250 'pid': os.getpid()})
2258 interface_id=0xFFFFFFFF):
2261 :param lb: load balance
2262 :param use_custom_mac: use custom mac
2263 :param mac_address: mac address
2264 :param interface_id: custom interface ID
2267 self.papi.bond_create,
2270 'use_custom_mac': use_custom_mac,
2271 'mac_address': mac_address,
2275 def pipe_delete(self, parent_sw_if_index):
2276 return self.api(self.papi.pipe_delete,
2277 {'parent_sw_if_index': parent_sw_if_index})
2279 def svs_table_add_del(self, af, table_id, is_add=1):
2280 return self.api(self.papi.svs_table_add_del,
2282 'table_id': table_id,
2287 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2288 return self.api(self.papi.svs_route_add_del,
2290 'table_id': table_id,
2291 'source_table_id': src_table_id,
2296 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2297 return self.api(self.papi.svs_enable_disable,
2300 'table_id': table_id,
2301 'sw_if_index': sw_if_index,
2302 'is_enable': is_enable,