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
25 class SYSLOG_SEVERITY:
37 # Dictionary keyed on message name to override default values for
41 'map_add_domain': {'mtu': 1280},
42 'syslog_set_sender': {'collector_port': 514,
44 'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
45 'acl_interface_list_dump': {'sw_if_index': 4294967295, },
46 'app_namespace_add_del': {'sw_if_index': 4294967295, },
47 'bd_ip_mac_add_del': {'is_add': 1, },
48 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
50 'bier_disp_table_add_del': {'is_add': 1, },
51 'bier_imp_add': {'is_add': 1, },
52 'bier_route_add_del': {'is_add': 1, },
53 'bier_table_add_del': {'is_add': 1, },
54 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
55 'learn': 1, 'is_add': 1, },
56 'bvi_create': {'user_instance': 4294967295, },
58 'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
59 'nbuckets': 2, 'memory_size': 2097152,
60 'next_table_index': 4294967295,
61 'miss_next_index': 4294967295, },
62 'dhcp6_client_enable_disable': {'enable': 1, },
63 'dhcp6_clients_enable_disable': {'enable': 1, },
64 'dhcp6_pd_client_enable_disable': {'enable': 1, },
65 'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
66 'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
67 'dhcp_proxy_config': {'is_add': 1, },
68 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
69 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
70 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
71 'decap_next_index': 4294967295, },
72 'gre_tunnel_add_del': {'instance': 4294967295, 'is_add': 1, },
73 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
74 'decap_next_index': 4294967295, },
75 'input_acl_set_interface': {'ip4_table_index': 4294967295,
76 'ip6_table_index': 4294967295,
77 'l2_table_index': 4294967295, },
78 'ip6_add_del_address_using_prefix': {'is_add': 1, },
79 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
80 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
81 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
82 'next_hop_id': 4294967295,
83 'classify_table_index': 4294967295, 'is_add': 1, },
84 'ip_mroute_add_del': {'is_add': 1, },
85 'ip_neighbor_add_del': {'is_add': 1, },
86 'ip_punt_police': {'is_add': 1, },
87 'ip_punt_redirect': {'is_add': 1, },
88 'ip_table_add_del': {'is_add': 1, },
89 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
90 'ipip_add_tunnel': {'is_ipv6': 1, 'instance': 4294967295, },
91 'ipsec_interface_add_del_spd': {'is_add': 1, },
92 'ipsec_sad_entry_add_del': {'is_add': 1, },
93 'ipsec_spd_add_del': {'is_add': 1, },
94 'ipsec_spd_dump': {'sa_id': 4294967295, },
95 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
96 'remote_port_stop': 65535, 'priority': 100,
99 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
100 'l2_emulation': {'enable': 1, },
101 'l2fib_add_del': {'is_add': 1, },
102 'lb_conf': {'sticky_buckets_per_core': 4294967295,
103 'flow_timeout': 4294967295},
104 'lisp_add_del_adjacency': {'is_add': 1, },
105 'lisp_add_del_local_eid': {'is_add': 1, },
106 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
107 'lisp_add_del_locator_set': {'is_add': 1, },
108 'lisp_add_del_remote_mapping': {'is_add': 1, },
109 'macip_acl_add_replace': {'acl_index': 4294967295, },
110 'macip_acl_dump': {'acl_index': 4294967295, },
111 'macip_acl_interface_add_del': {'is_add': 1, },
112 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
113 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
114 'mr_next_hop_weight': 1,
115 'mr_next_hop_via_label': 1048576,
117 'mr_classify_table_index': 4294967295, },
118 'mpls_table_add_del': {'is_add': 1, },
119 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
120 'next_hop_weight': 1,
121 'next_hop_via_label': 1048576,
123 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
124 'output_acl_set_interface': {'ip4_table_index': 4294967295,
125 'ip6_table_index': 4294967295,
126 'l2_table_index': 4294967295, },
127 'pppoe_add_del_session': {'is_add': 1, },
128 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
129 'proxy_arp_add_del': {'is_add': 1, },
130 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
131 'punt_socket_register': {'protocol': 17, 'header_version': 1,
133 'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, },
134 'punt_socket_dump': {'is_ip6': 1, },
135 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
137 'set_ipfix_exporter': {'collector_port': 4739, },
138 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
139 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
140 'svs_enable_disable': {'is_enable': 1, },
141 'svs_route_add_del': {'is_add': 1, },
142 'svs_table_add_del': {'is_add': 1, },
143 'sw_interface_add_del_address': {'is_add': 1, },
144 'sw_interface_dump': {'sw_if_index': 4294967295, },
145 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
146 'pref_lifetime': 4294967295, },
147 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
148 'sw_interface_set_l2_bridge': {'enable': 1, },
149 'sw_interface_set_mpls_enable': {'enable': 1, },
150 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
151 'sw_interface_set_unnumbered': {'is_add': 1, },
152 'sw_interface_span_enable_disable': {'state': 1, },
153 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
154 'decap_next_index': 4294967295,
155 'instance': 4294967295, },
156 'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
157 'instance': 4294967295, },
158 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
159 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
161 'want_bfd_events': {'enable_disable': 1, },
162 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
163 'want_dhcp6_reply_events': {'enable_disable': 1, },
164 'want_igmp_events': {'enable': 1, },
165 'want_interface_events': {'enable_disable': 1, },
166 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
167 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
168 'want_ip6_ra_events': {'enable_disable': 1, },
169 'want_l2_macs_events': {'enable_disable': 1, },
173 class UnexpectedApiReturnValueError(Exception):
174 """ exception raised when the API return value is unexpected """
178 class VppPapiProvider(object):
179 """VPP-api provider using vpp-papi
181 @property hook: hook object providing before and after api/cli hooks
184 _zero, _negative = range(2)
186 def __init__(self, name, shm_prefix, test_class, read_timeout):
187 self.hook = Hook(test_class)
189 self.shm_prefix = shm_prefix
190 self.test_class = test_class
191 self._expect_api_retval = self._zero
192 self._expect_stack = []
194 # install_dir is a class attribute. We need to set it before
195 # calling the constructor.
196 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
200 if os.environ['SOCKET'] == '1':
205 self.vpp = VPPApiClient(logger=test_class.logger,
206 read_timeout=read_timeout,
207 use_socket=use_socket,
208 server_address=test_class.api_sock)
209 self._events = deque()
214 def assert_negative_api_retval(self):
215 """ Expect API failure - used with with, e.g.:
216 with self.vapi.assert_negative_api_retval():
217 self.vapi.<api call expected to fail>
219 self._expect_stack.append(self._expect_api_retval)
220 self._expect_api_retval = self._negative
223 def assert_zero_api_retval(self):
224 """ Expect API success - used with with, e.g.:
225 with self.vapi.assert_negative_api_retval():
226 self.vapi.<api call expected to succeed>
228 note: this is useful only inside another with block
229 as success is the default expected value
231 self._expect_stack.append(self._expect_api_retval)
232 self._expect_api_retval = self._zero
235 def __exit__(self, exc_type, exc_value, traceback):
236 self._expect_api_retval = self._expect_stack.pop()
238 def register_hook(self, hook):
239 """Replace hook registration with new hook
246 def collect_events(self):
247 """ Collect all events from the internal queue and clear the queue. """
249 self._events = deque()
252 def wait_for_event(self, timeout, name=None):
253 """ Wait for and return next event. """
255 self.test_class.logger.debug("Expecting event '%s' within %ss",
258 self.test_class.logger.debug("Expecting event within %ss",
261 self.test_class.logger.debug("Not waiting, event already queued")
262 limit = time.time() + timeout
263 while time.time() < limit:
265 e = self._events.popleft()
266 if name and type(e).__name__ != name:
268 "Unexpected event received: %s, expected: %s" %
269 (type(e).__name__, name))
270 self.test_class.logger.debug("Returning event %s:%s" %
273 self.test_class.sleep(0) # yield
274 raise Exception("Event did not occur within timeout")
276 def __call__(self, name, event):
277 """ Enqueue event in the internal event queue. """
278 # FIXME use the name instead of relying on type(e).__name__ ?
279 # FIXME #2 if this throws, it is eaten silently, Ole?
280 self.test_class.logger.debug("New event: %s: %s" % (name, event))
281 self._events.append(event)
283 def factory(self, name, apifn):
285 fields = apifn._func.msg.fields
287 # add positional and kw arguments
289 for i, o in enumerate(fields[3:]):
296 if name in defaultmapping:
297 for k, v in iteritems(defaultmapping[name]):
301 return self.api(apifn, d)
305 def __getattribute__(self, name):
307 method = super(VppPapiProvider, self).__getattribute__(name)
308 except AttributeError:
309 method = self.factory(name, getattr(self.papi, name))
310 # lazily load the method so we don't need to call factory
311 # again for this name.
312 setattr(self, name, method)
316 """Connect the API to VPP"""
317 self.vpp.connect(self.name, self.shm_prefix)
318 self.papi = self.vpp.api
319 self.vpp.register_event_callback(self)
321 def disconnect(self):
322 """Disconnect the API from VPP"""
323 self.vpp.disconnect()
325 def api(self, api_fn, api_args, expected_retval=0):
326 """ Call API function and check it's return value.
327 Call the appropriate hooks before and after the API call
329 :param api_fn: API function to call
330 :param api_args: tuple of API function arguments
331 :param expected_retval: Expected return value (Default value = 0)
332 :returns: reply from the API
335 self.hook.before_api(api_fn.__name__, api_args)
336 reply = api_fn(**api_args)
337 if self._expect_api_retval == self._negative:
338 if hasattr(reply, 'retval') and reply.retval >= 0:
339 msg = "API call passed unexpectedly: expected negative " \
340 "return value instead of %d in %s" % \
341 (reply.retval, moves.reprlib.repr(reply))
342 self.test_class.logger.info(msg)
343 raise UnexpectedApiReturnValueError(msg)
344 elif self._expect_api_retval == self._zero:
345 if hasattr(reply, 'retval') and reply.retval != expected_retval:
346 msg = "API call failed, expected %d return value instead " \
347 "of %d in %s" % (expected_retval, reply.retval,
348 moves.reprlib.repr(reply))
349 self.test_class.logger.info(msg)
350 raise UnexpectedApiReturnValueError(msg)
352 raise Exception("Internal error, unexpected value for "
353 "self._expect_api_retval %s" %
354 self._expect_api_retval)
355 self.hook.after_api(api_fn.__name__, api_args)
359 """ Execute a CLI, calling the before/after hooks appropriately.
361 :param cli: CLI to execute
365 self.hook.before_cli(cli)
367 r = self.papi.cli_inband(cmd=cli)
368 self.hook.after_cli(cli)
369 if hasattr(r, 'reply'):
372 def ppcli(self, cli):
373 """ Helper method to print CLI command in case of info logging level.
375 :param cli: CLI to execute
378 return cli + "\n" + str(self.cli(cli))
380 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
381 return self.api(self.papi.want_ip4_arp_events,
382 {'enable_disable': enable_disable,
384 'pid': os.getpid(), })
386 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
387 return self.api(self.papi.want_ip6_nd_events,
388 {'enable_disable': enable_disable,
390 'pid': os.getpid(), })
392 def want_ip6_ra_events(self, enable_disable=1):
393 return self.api(self.papi.want_ip6_ra_events,
394 {'enable_disable': enable_disable,
395 'pid': os.getpid(), })
397 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
399 return self.api(self.papi.ip6nd_send_router_solicitation,
404 'sw_if_index': sw_if_index})
406 def want_interface_events(self, enable_disable=1):
407 return self.api(self.papi.want_interface_events,
408 {'enable_disable': enable_disable,
409 'pid': os.getpid(), })
411 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
412 max_macs_in_event=0, learn_limit=0):
413 return self.api(self.papi.want_l2_macs_events,
414 {'enable_disable': enable_disable,
415 'scan_delay': scan_delay,
416 'max_macs_in_event': max_macs_in_event,
417 'learn_limit': learn_limit,
418 'pid': os.getpid(), })
420 def want_dhcp6_reply_events(self, enable_disable=1):
421 return self.api(self.papi.want_dhcp6_reply_events,
422 {'enable_disable': enable_disable,
425 def want_dhcp6_pd_reply_events(self, enable_disable=1):
426 return self.api(self.papi.want_dhcp6_pd_reply_events,
427 {'enable_disable': enable_disable,
430 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
431 prefixes, server_index=0xFFFFFFFF,
432 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
434 return self.api(self.papi.dhcp6_pd_send_client_message,
435 {'sw_if_index': sw_if_index,
436 'server_index': server_index,
442 'msg_type': msg_type,
445 'n_prefixes': len(prefixes),
446 'prefixes': prefixes})
448 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
450 return self.api(self.papi.dhcp6_client_enable_disable,
451 {'sw_if_index': sw_if_index,
454 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
456 return self.api(self.papi.dhcp6_pd_client_enable_disable,
457 {'sw_if_index': sw_if_index,
458 'prefix_group': prefix_group,
461 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
462 prefix_length, prefix_group,
464 return self.api(self.papi.ip6_add_del_address_using_prefix,
465 {'sw_if_index': sw_if_index,
466 'prefix_group': prefix_group,
468 'prefix_length': prefix_length,
471 def sw_interface_set_mac_address(self, sw_if_index, mac):
472 return self.api(self.papi.sw_interface_set_mac_address,
473 {'sw_if_index': sw_if_index,
476 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
477 """Create p2p ethernet subinterface
479 :param sw_if_index: main (parent) interface
480 :param remote_mac: client (remote) mac address
484 self.papi.p2p_ethernet_add,
485 {'parent_if_index': sw_if_index,
486 'remote_mac': remote_mac,
487 'subif_id': subif_id})
489 def p2p_ethernet_del(self, sw_if_index, remote_mac):
490 """Delete p2p ethernet subinterface
492 :param sw_if_index: main (parent) interface
493 :param remote_mac: client (remote) mac address
497 self.papi.p2p_ethernet_del,
498 {'parent_if_index': sw_if_index,
499 'remote_mac': remote_mac})
501 def create_vlan_subif(self, sw_if_index, vlan):
508 return self.api(self.papi.create_vlan_subif,
509 {'sw_if_index': sw_if_index,
512 def create_loopback(self, mac=''):
515 :param mac: (Optional)
517 return self.api(self.papi.create_loopback,
518 {'mac_address': mac})
520 def ip_neighbor_add_del(self,
526 """ Add neighbor MAC to IPv4 or IPv6 address.
531 :param is_add: (Default value = 1)
532 :param flags: (Default value = 0/NONE)
535 self.papi.ip_neighbor_add_del,
539 'sw_if_index': sw_if_index,
541 'mac_address': mac_address,
542 'ip_address': ip_address
547 def proxy_arp_add_del(self,
552 """ Config Proxy Arp Range.
554 :param low_address: Start address in the rnage to Proxy for
555 :param hi_address: End address in the rnage to Proxy for
556 :param vrf_id: The VRF/table in which to proxy
560 self.papi.proxy_arp_add_del,
563 'table_id': table_id,
569 def proxy_arp_intfc_enable_disable(self,
572 """ Enable/Disable an interface for proxy ARP requests
574 :param sw_if_index: Interface
575 :param enable_disable: Enable/Disable
579 self.papi.proxy_arp_intfc_enable_disable,
580 {'sw_if_index': sw_if_index,
581 'enable_disable': is_enable
585 def gre_tunnel_add_del(self,
597 :param outer_fib_id: (Default value = 0)
598 :param tunnel_type: (Default value = 0)
599 :param instance: (Default value = 0xFFFFFFFF)
600 :param session_id: (Default value = 0)
601 :param is_add: (Default value = 1)
602 :param is_ipv6: (Default value = 0)
606 self.papi.gre_tunnel_add_del,
611 'instance': instance,
614 'outer_fib_id': outer_fib_id,
615 'session_id': session_id}
619 def udp_encap_add(self,
630 :param outer_fib_id: (Default value = 0)
634 self.papi.udp_encap_add,
639 'src_port': src_port,
640 'dst_port': dst_port,
645 def mpls_table_add_del(
652 :param is_add: (Default value = 1)
657 self.papi.mpls_table_add_del,
658 {'mt_table_id': table_id,
659 'mt_is_add': is_add})
661 def mpls_ip_bind_unbind(
673 self.papi.mpls_ip_bind_unbind,
674 {'mb_mpls_table_id': table_id,
676 'mb_ip_table_id': ip_table_id,
677 'mb_is_bind': is_bind,
679 'mb_address_length': dst_address_length,
680 'mb_address': dst_address})
682 def mpls_tunnel_add_del(
685 next_hop_proto_is_ip4,
687 next_hop_sw_if_index=0xFFFFFFFF,
690 next_hop_n_out_labels=0,
691 next_hop_out_label_stack=[],
692 next_hop_via_label=MPLS_LABEL_INVALID,
698 :param dst_address_length:
699 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
701 :param next_hop_address:
702 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
703 :param vrf_id: (Default value = 0)
704 :param lookup_in_vrf: (Default value = 0)
705 :param classify_table_index: (Default value = 0xFFFFFFFF)
706 :param is_add: (Default value = 1)
707 :param is_drop: (Default value = 0)
708 :param is_ipv6: (Default value = 0)
709 :param is_local: (Default value = 0)
710 :param is_classify: (Default value = 0)
711 :param is_multipath: (Default value = 0)
712 :param is_resolve_host: (Default value = 0)
713 :param is_resolve_attached: (Default value = 0)
714 :param next_hop_weight: (Default value = 1)
715 :param is_multicast: (Default value = 0)
719 self.papi.mpls_tunnel_add_del,
720 {'mt_sw_if_index': tun_sw_if_index,
722 'mt_l2_only': l2_only,
723 'mt_is_multicast': is_multicast,
724 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
725 'mt_next_hop_weight': next_hop_weight,
726 'mt_next_hop': next_hop_address,
727 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
728 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
729 'mt_next_hop_table_id': next_hop_table_id,
730 'mt_next_hop_via_label': next_hop_via_label,
731 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
733 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
734 detect_mult, local_addr, peer_addr, is_ipv6=0,
735 bfd_key_id=None, conf_key_id=None):
736 if bfd_key_id is None:
737 return self.api(self.papi.bfd_udp_add,
739 'sw_if_index': sw_if_index,
740 'desired_min_tx': desired_min_tx,
741 'required_min_rx': required_min_rx,
742 'local_addr': local_addr,
743 'peer_addr': peer_addr,
745 'detect_mult': detect_mult,
748 return self.api(self.papi.bfd_udp_add,
750 'sw_if_index': sw_if_index,
751 'desired_min_tx': desired_min_tx,
752 'required_min_rx': required_min_rx,
753 'local_addr': local_addr,
754 'peer_addr': peer_addr,
756 'detect_mult': detect_mult,
757 'is_authenticated': 1,
758 'bfd_key_id': bfd_key_id,
759 'conf_key_id': conf_key_id,
762 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
763 detect_mult, local_addr, peer_addr, is_ipv6=0):
764 return self.api(self.papi.bfd_udp_mod,
766 'sw_if_index': sw_if_index,
767 'desired_min_tx': desired_min_tx,
768 'required_min_rx': required_min_rx,
769 'local_addr': local_addr,
770 'peer_addr': peer_addr,
772 'detect_mult': detect_mult,
775 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
776 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
778 return self.api(self.papi.bfd_udp_auth_activate,
780 'sw_if_index': sw_if_index,
781 'local_addr': local_addr,
782 'peer_addr': peer_addr,
784 'is_delayed': 1 if is_delayed else 0,
785 'bfd_key_id': bfd_key_id,
786 'conf_key_id': conf_key_id,
789 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
790 peer_addr, is_ipv6=0):
791 return self.api(self.papi.bfd_udp_session_set_flags, {
792 'admin_up_down': admin_up_down,
793 'sw_if_index': sw_if_index,
794 'local_addr': local_addr,
795 'peer_addr': peer_addr,
799 def want_bfd_events(self, enable_disable=1):
800 return self.api(self.papi.want_bfd_events, {
801 'enable_disable': enable_disable,
805 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
806 return self.api(self.papi.bfd_auth_set_key, {
807 'conf_key_id': conf_key_id,
808 'auth_type': auth_type,
813 def classify_add_del_table(
818 table_index=0xFFFFFFFF,
822 next_table_index=0xFFFFFFFF,
823 miss_next_index=0xFFFFFFFF,
825 current_data_offset=0):
829 :param match_n_vectors: (Default value = 1)
830 :param table_index: (Default value = 0xFFFFFFFF)
831 :param nbuckets: (Default value = 2)
832 :param memory_size: (Default value = 2097152)
833 :param skip_n_vectors: (Default value = 0)
834 :param next_table_index: (Default value = 0xFFFFFFFF)
835 :param miss_next_index: (Default value = 0xFFFFFFFF)
836 :param current_data_flag: (Default value = 0)
837 :param current_data_offset: (Default value = 0)
840 mask_len = ((len(mask) - 1) / 16 + 1) * 16
841 mask = mask + '\0' * (mask_len - len(mask))
843 self.papi.classify_add_del_table,
845 'table_index': table_index,
846 'nbuckets': nbuckets,
847 'memory_size': memory_size,
848 'skip_n_vectors': skip_n_vectors,
849 'match_n_vectors': match_n_vectors,
850 'next_table_index': next_table_index,
851 'miss_next_index': miss_next_index,
852 'current_data_flag': current_data_flag,
853 'current_data_offset': current_data_offset,
854 'mask_len': mask_len,
857 def classify_add_del_session(
862 opaque_index=0xFFFFFFFF,
863 hit_next_index=0xFFFFFFFF,
871 :param opaque_index: (Default value = 0xFFFFFFFF)
872 :param hit_next_index: (Default value = 0xFFFFFFFF)
873 :param advance: (Default value = 0)
874 :param action: (Default value = 0)
875 :param metadata: (Default value = 0)
878 match_len = ((len(match) - 1) / 16 + 1) * 16
879 match = match + '\0' * (match_len - len(match))
881 self.papi.classify_add_del_session,
883 'table_index': table_index,
884 'hit_next_index': hit_next_index,
885 'opaque_index': opaque_index,
888 'metadata': metadata,
889 'match_len': match_len,
892 def input_acl_set_interface(
896 ip4_table_index=0xFFFFFFFF,
897 ip6_table_index=0xFFFFFFFF,
898 l2_table_index=0xFFFFFFFF):
902 :param ip4_table_index: (Default value = 0xFFFFFFFF)
903 :param ip6_table_index: (Default value = 0xFFFFFFFF)
904 :param l2_table_index: (Default value = 0xFFFFFFFF)
908 self.papi.input_acl_set_interface,
909 {'sw_if_index': sw_if_index,
910 'ip4_table_index': ip4_table_index,
911 'ip6_table_index': ip6_table_index,
912 'l2_table_index': l2_table_index,
915 def output_acl_set_interface(
919 ip4_table_index=0xFFFFFFFF,
920 ip6_table_index=0xFFFFFFFF,
921 l2_table_index=0xFFFFFFFF):
925 :param ip4_table_index: (Default value = 0xFFFFFFFF)
926 :param ip6_table_index: (Default value = 0xFFFFFFFF)
927 :param l2_table_index: (Default value = 0xFFFFFFFF)
931 self.papi.output_acl_set_interface,
932 {'sw_if_index': sw_if_index,
933 'ip4_table_index': ip4_table_index,
934 'ip6_table_index': ip6_table_index,
935 'l2_table_index': l2_table_index,
938 def set_ipfix_exporter(
948 self.papi.set_ipfix_exporter,
950 'collector_address': collector_address,
951 'collector_port': collector_port,
952 'src_address': src_address,
954 'path_mtu': path_mtu,
955 'template_interval': template_interval,
956 'udp_checksum': udp_checksum,
959 def dhcp_proxy_config(self,
967 self.papi.dhcp_proxy_config,
969 'rx_vrf_id': rx_table_id,
970 'server_vrf_id': server_table_id,
973 'dhcp_server': dhcp_server,
974 'dhcp_src_address': dhcp_src_address,
977 def dhcp_proxy_set_vss(self,
986 self.papi.dhcp_proxy_set_vss,
989 'vss_type': vss_type,
990 'vpn_ascii_id': vpn_ascii_id,
992 'vpn_index': vpn_index,
997 def dhcp_client_config(self,
1002 set_broadcast_flag=1,
1003 want_dhcp_events=0):
1005 self.papi.dhcp_client_config,
1009 'sw_if_index': sw_if_index,
1010 'hostname': hostname,
1012 'want_dhcp_event': want_dhcp_events,
1013 'set_broadcast_flag': set_broadcast_flag,
1017 def ip_mroute_add_del(self,
1023 next_hop_sw_if_index,
1033 IP Multicast Route add/del
1036 self.papi.ip_mroute_add_del,
1037 {'next_hop_sw_if_index': next_hop_sw_if_index,
1038 'entry_flags': e_flags,
1039 'itf_flags': i_flags,
1040 'table_id': table_id,
1044 'is_local': is_local,
1045 'bier_imp': bier_imp,
1046 'next_hop_afi': next_hop_afi,
1047 'grp_address_length': grp_address_length,
1048 'grp_address': grp_address,
1049 'src_address': src_address,
1050 'nh_address': next_hop_address})
1052 def lisp_enable_disable(self, is_enabled):
1054 self.papi.lisp_enable_disable,
1056 'is_en': is_enabled,
1059 def lisp_add_del_locator_set(self,
1063 self.papi.lisp_add_del_locator_set,
1066 'locator_set_name': ls_name
1069 def lisp_add_del_locator(self,
1076 self.papi.lisp_add_del_locator,
1079 'locator_set_name': ls_name,
1080 'sw_if_index': sw_if_index,
1081 'priority': priority,
1085 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1087 self.papi.lisp_locator_dump,
1089 'is_index_set': is_index_set,
1091 'ls_index': ls_index,
1094 def lisp_add_del_local_eid(self,
1104 self.papi.lisp_add_del_local_eid,
1106 'locator_set_name': ls_name,
1108 'eid_type': eid_type,
1110 'prefix_len': prefix_len,
1116 def lisp_eid_table_dump(self,
1124 self.papi.lisp_eid_table_dump,
1127 'prefix_length': prefix_length,
1129 'eid_type': eid_type,
1131 'filter': filter_opt,
1134 def lisp_add_del_remote_mapping(self,
1144 self.papi.lisp_add_del_remote_mapping,
1147 'eid_type': eid_type,
1149 'eid_len': eid_prefix_len,
1150 'rloc_num': rlocs_num,
1153 'is_src_dst': is_src_dst,
1156 def lisp_add_del_adjacency(self,
1165 self.papi.lisp_add_del_adjacency,
1169 'eid_type': eid_type,
1172 'leid_len': leid_len,
1173 'reid_len': reid_len,
1176 def gtpu_add_del_tunnel(
1182 mcast_sw_if_index=0xFFFFFFFF,
1184 decap_next_index=0xFFFFFFFF,
1188 :param is_add: (Default value = 1)
1189 :param is_ipv6: (Default value = 0)
1192 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1193 :param encap_vrf_id: (Default value = 0)
1194 :param decap_next_index: (Default value = 0xFFFFFFFF)
1195 :param teid: (Default value = 0)
1198 return self.api(self.papi.gtpu_add_del_tunnel,
1201 'src_address': src_addr,
1202 'dst_address': dst_addr,
1203 'mcast_sw_if_index': mcast_sw_if_index,
1204 'encap_vrf_id': encap_vrf_id,
1205 'decap_next_index': decap_next_index,
1208 def vxlan_gpe_add_del_tunnel(
1212 mcast_sw_if_index=0xFFFFFFFF,
1223 :param is_add: (Default value = 1)
1224 :param is_ipv6: (Default value = 0)
1225 :param encap_vrf_id: (Default value = 0)
1226 :param decap_vrf_id: (Default value = 0)
1227 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1228 :param protocol: (Default value = 3)
1229 :param vni: (Default value = 0)
1232 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1237 'mcast_sw_if_index': mcast_sw_if_index,
1238 'encap_vrf_id': encap_vrf_id,
1239 'decap_vrf_id': decap_vrf_id,
1240 'protocol': protocol,
1243 def vxlan_gbp_tunnel_add_del(
1247 mcast_sw_if_index=0xFFFFFFFF,
1253 instance=0xFFFFFFFF):
1258 :param is_add: (Default value = 1)
1259 :param is_ipv6: (Default value = 0)
1260 :param encap_table_id: (Default value = 0)
1261 :param decap_next_index: (Default value = 0xFFFFFFFF)
1262 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1263 :param vni: (Default value = 0)
1264 :param instance: (Default value = 0xFFFFFFFF)
1267 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
1272 'mcast_sw_if_index': mcast_sw_if_index,
1273 'encap_table_id': encap_table_id,
1275 'instance': instance,
1278 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1279 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1280 {'sw_if_index': sw_if_index,
1281 '_no_type_conversion': True})
1283 def pppoe_add_del_session(
1293 :param is_add: (Default value = 1)
1294 :param is_ipv6: (Default value = 0)
1296 :param session_id: (Default value = 0)
1298 :param decap_vrf_id: (Default value = 0)
1301 return self.api(self.papi.pppoe_add_del_session,
1304 'session_id': session_id,
1305 'client_ip': client_ip,
1306 'decap_vrf_id': decap_vrf_id,
1307 'client_mac': client_mac})
1309 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1310 return self.api(self.papi.sr_mpls_policy_add,
1314 'n_segments': len(segments),
1315 'segments': segments})
1317 def sr_mpls_policy_del(self, bsid):
1318 return self.api(self.papi.sr_mpls_policy_del,
1321 def sr_localsid_add_del(self,
1328 sw_if_index=0xFFFFFFFF,
1332 """ Add/del IPv6 SR local-SID.
1335 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1336 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1339 :param is_del: (Default value = 0)
1340 :param end_psp: (Default value = 0)
1341 :param sw_if_index: (Default value = 0xFFFFFFFF)
1342 :param vlan_index: (Default value = 0)
1343 :param fib_table: (Default value = 0)
1346 self.papi.sr_localsid_add_del,
1348 'localsid': localsid,
1350 'behavior': behavior,
1351 'sw_if_index': sw_if_index,
1352 'vlan_index': vlan_index,
1353 'fib_table': fib_table,
1354 'nh_addr4': nh_addr4,
1355 'nh_addr6': nh_addr6
1369 :param bsid_addr: bindingSID of the SR Policy
1370 :param weight: weight of the sid list. optional. (default: 1)
1371 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1373 :param type: type/behavior of the SR policy. (default or spray) \
1375 :param fib_table: VRF where to install the FIB entry for the BSID \
1377 :param n_segments: number of segments \
1379 :param segments: a vector of IPv6 address composing the segment list \
1383 self.papi.sr_policy_add,
1384 {'bsid_addr': bsid_addr,
1386 'is_encap': is_encap,
1388 'fib_table': fib_table,
1389 'n_segments': n_segments,
1390 'segments': segments
1399 :param bsid: bindingSID of the SR Policy
1400 :param sr_policy_index: index of the sr policy (default: 0)
1403 self.papi.sr_policy_del,
1404 {'bsid_addr': bsid_addr,
1405 'sr_policy_index': sr_policy_index
1408 def sr_steering_add_del(
1419 Steer traffic L2 and L3 traffic through a given SR policy
1421 :param is_del: delete or add
1422 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1423 :param sr_policy: is the index of the SR Policy (alt to bsid)
1424 :param table_id: is the VRF where to install the FIB entry for the BSID
1425 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1426 :param mask_width: is the mask for L3 traffic type
1427 :param sw_if_index: is the incoming interface for L2 traffic
1428 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1431 self.papi.sr_steering_add_del,
1433 'bsid_addr': bsid_addr,
1434 'sr_policy_index': sr_policy_index,
1435 'table_id': table_id,
1436 'prefix_addr': prefix_addr,
1437 'mask_width': mask_width,
1438 'sw_if_index': sw_if_index,
1439 'traffic_type': traffic_type
1442 def acl_add_replace(self, acl_index, r, tag='',
1444 """Add/replace an ACL
1445 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1446 :param acl_rule r: ACL rules array.
1447 :param str tag: symbolic tag (description) for this ACL.
1448 :param int count: number of rules.
1450 return self.api(self.papi.acl_add_replace,
1451 {'acl_index': acl_index,
1455 expected_retval=expected_retval)
1457 def acl_del(self, acl_index, expected_retval=0):
1463 return self.api(self.papi.acl_del,
1464 {'acl_index': acl_index},
1465 expected_retval=expected_retval)
1467 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1469 return self.api(self.papi.acl_interface_set_acl_list,
1470 {'sw_if_index': sw_if_index,
1474 expected_retval=expected_retval)
1476 def acl_interface_set_etype_whitelist(self, sw_if_index,
1479 return self.api(self.papi.acl_interface_set_etype_whitelist,
1480 {'sw_if_index': sw_if_index,
1481 'count': len(whitelist),
1483 'whitelist': whitelist},
1484 expected_retval=expected_retval)
1486 def acl_interface_add_del(self,
1490 """ Add/Delete ACL to/from interface
1494 :param is_add: (Default value = 1)
1497 return self.api(self.papi.acl_interface_add_del,
1500 'sw_if_index': sw_if_index,
1501 'acl_index': acl_index})
1503 def acl_dump(self, acl_index, expected_retval=0):
1504 return self.api(self.papi.acl_dump,
1505 {'acl_index': acl_index},
1506 expected_retval=expected_retval)
1508 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1510 return self.api(self.papi.acl_interface_list_dump,
1511 {'sw_if_index': sw_if_index},
1512 expected_retval=expected_retval)
1514 def macip_acl_add(self, rules, tag=""):
1517 :param rules: list of rules for given acl
1521 return self.api(self.papi.macip_acl_add,
1523 'count': len(rules),
1526 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1529 :param rules: list of rules for given acl
1533 return self.api(self.papi.macip_acl_add_replace,
1534 {'acl_index': acl_index,
1536 'count': len(rules),
1539 def macip_acl_interface_add_del(self,
1543 """ Add MACIP acl to interface
1547 :param is_add: (Default value = 1)
1550 return self.api(self.papi.macip_acl_interface_add_del,
1552 'sw_if_index': sw_if_index,
1553 'acl_index': acl_index})
1555 def macip_acl_dump(self, acl_index=4294967295):
1556 """ Return MACIP acl dump
1560 self.papi.macip_acl_dump, {'acl_index': acl_index})
1562 def policer_add_del(self,
1573 conform_action_type=1,
1575 exceed_action_type=0,
1577 violate_action_type=0,
1579 return self.api(self.papi.policer_add_del,
1586 'rate_type': rate_type,
1587 'round_type': round_type,
1589 'color_aware': color_aware,
1590 'conform_action_type': conform_action_type,
1591 'conform_dscp': conform_dscp,
1592 'exceed_action_type': exceed_action_type,
1593 'exceed_dscp': exceed_dscp,
1594 'violate_action_type': violate_action_type,
1595 'violate_dscp': violate_dscp})
1597 def ip_punt_police(self,
1601 return self.api(self.papi.ip_punt_police,
1602 {'policer_index': policer_index,
1606 def ip_punt_redirect(self,
1611 return self.api(self.papi.ip_punt_redirect,
1612 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1613 'tx_sw_if_index': tx_sw_if_index,
1617 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1618 return self.api(self.papi.ip_punt_redirect_dump,
1619 {'sw_if_index': sw_if_index,
1620 'is_ipv6': is_ipv6})
1622 def bier_table_add_del(self,
1626 """ BIER Table add/del """
1628 self.papi.bier_table_add_del,
1629 {'bt_tbl_id': {"bt_set": bti.set_id,
1630 "bt_sub_domain": bti.sub_domain_id,
1631 "bt_hdr_len_id": bti.hdr_len_id},
1632 'bt_label': mpls_label,
1633 'bt_is_add': is_add})
1635 def bier_table_dump(self):
1636 return self.api(self.papi.bier_table_dump, {})
1638 def bier_route_add_del(self,
1644 """ BIER Route add/del """
1646 self.papi.bier_route_add_del,
1647 {'br_tbl_id': {"bt_set": bti.set_id,
1648 "bt_sub_domain": bti.sub_domain_id,
1649 "bt_hdr_len_id": bti.hdr_len_id},
1651 'br_n_paths': len(paths),
1653 'br_is_add': is_add,
1654 'br_is_replace': is_replace})
1656 def bier_route_dump(self, bti):
1658 self.papi.bier_route_dump,
1659 {'br_tbl_id': {"bt_set": bti.set_id,
1660 "bt_sub_domain": bti.sub_domain_id,
1661 "bt_hdr_len_id": bti.hdr_len_id}})
1663 def bier_imp_add(self,
1668 """ BIER Imposition Add """
1670 self.papi.bier_imp_add,
1671 {'bi_tbl_id': {"bt_set": bti.set_id,
1672 "bt_sub_domain": bti.sub_domain_id,
1673 "bt_hdr_len_id": bti.hdr_len_id},
1675 'bi_n_bytes': len(ibytes),
1676 'bi_bytes': ibytes})
1678 def bier_imp_del(self, bi_index):
1679 """ BIER Imposition del """
1681 self.papi.bier_imp_del,
1682 {'bi_index': bi_index})
1684 def bier_imp_dump(self):
1685 return self.api(self.papi.bier_imp_dump, {})
1687 def bier_disp_table_add_del(self,
1690 """ BIER Disposition Table add/del """
1692 self.papi.bier_disp_table_add_del,
1693 {'bdt_tbl_id': bdti,
1694 'bdt_is_add': is_add})
1696 def bier_disp_table_dump(self):
1697 return self.api(self.papi.bier_disp_table_dump, {})
1699 def bier_disp_entry_add_del(self,
1709 """ BIER Route add/del """
1711 while (len(lstack) < 16):
1714 self.papi.bier_disp_entry_add_del,
1715 {'bde_tbl_id': bdti,
1717 'bde_payload_proto': payload_proto,
1719 'bde_paths': [{'next_hop': next_hop,
1720 'table_id': next_hop_tbl_id,
1721 'afi': next_hop_afi,
1722 'rpf_id': next_hop_rpf_id,
1724 'label_stack': lstack}],
1725 'bde_is_add': is_add})
1727 def bier_disp_entry_dump(self, bdti):
1729 self.papi.bier_disp_entry_dump,
1730 {'bde_tbl_id': bdti})
1732 def session_enable_disable(self, is_enabled):
1734 self.papi.session_enable_disable,
1735 {'is_enable': is_enabled})
1737 def ipsec_spd_add_del(self, spd_id, is_add=1):
1738 """ SPD add/del - Wrapper to add or del ipsec SPD
1739 Sample CLI : 'ipsec spd add 1'
1741 :param spd_id - SPD ID to be created in the vpp . mandatory
1742 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1744 :returns: reply from the API
1747 self.papi.ipsec_spd_add_del, {
1748 'spd_id': spd_id, 'is_add': is_add})
1750 def ipsec_spds_dump(self):
1751 return self.api(self.papi.ipsec_spds_dump, {})
1753 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1754 """ IPSEC interface SPD add/del - \
1755 Wrapper to associate/disassociate SPD to interface in VPP
1756 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1758 :param spd_id - SPD ID to associate with the interface . mandatory
1759 :param sw_if_index - Interface Index which needs to ipsec \
1760 association mandatory
1761 :param is_add - add(1) or del(0) association with interface \
1762 (Default 1 - add) . optional
1763 :returns: reply from the API
1766 self.papi.ipsec_interface_add_del_spd,
1767 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1769 def ipsec_spd_interface_dump(self, spd_index=None):
1770 return self.api(self.papi.ipsec_spd_interface_dump,
1771 {'spd_index': spd_index if spd_index else 0,
1772 'spd_index_valid': 1 if spd_index else 0})
1774 def ipsec_sad_entry_add_del(self,
1777 integrity_algorithm,
1782 tunnel_src_address='',
1783 tunnel_dst_address='',
1787 """ IPSEC SA add/del
1788 :param sad_id: security association ID
1789 :param spi: security param index of the SA in decimal
1790 :param integrity_algorithm:
1791 :param integrity_key:
1792 :param crypto_algorithm:
1794 :param protocol: AH(0) or ESP(1) protocol
1795 :param tunnel_src_address: tunnel mode outer src address
1796 :param tunnel_dst_address: tunnel mode outer dst address
1799 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1800 crypto and ipsec algorithms
1803 self.papi.ipsec_sad_entry_add_del,
1810 'tunnel_src': tunnel_src_address,
1811 'tunnel_dst': tunnel_dst_address,
1812 'protocol': protocol,
1813 'integrity_algorithm': integrity_algorithm,
1815 'length': len(integrity_key),
1816 'data': integrity_key,
1818 'crypto_algorithm': crypto_algorithm,
1820 'length': len(crypto_key),
1828 def ipsec_sa_dump(self, sa_id=None):
1829 return self.api(self.papi.ipsec_sa_dump,
1830 {'sa_id': sa_id if sa_id else 0xffffffff})
1832 def ipsec_spd_entry_add_del(self,
1835 local_address_start,
1837 remote_address_start,
1838 remote_address_stop,
1840 local_port_stop=65535,
1841 remote_port_start=0,
1842 remote_port_stop=65535,
1850 """ IPSEC policy SPD add/del -
1851 Wrapper to configure ipsec SPD policy entries in VPP
1852 :param spd_id: SPD ID for the policy
1853 :param local_address_start: local-ip-range start address
1854 :param local_address_stop : local-ip-range stop address
1855 :param remote_address_start: remote-ip-range start address
1856 :param remote_address_stop : remote-ip-range stop address
1857 :param local_port_start: (Default value = 0)
1858 :param local_port_stop: (Default value = 65535)
1859 :param remote_port_start: (Default value = 0)
1860 :param remote_port_stop: (Default value = 65535)
1861 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1862 :param sa_id: Security Association ID for mapping it to SPD
1863 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1865 :param priority: value for the spd action (Default value = 100)
1866 :param is_outbound: flag for inbound(0) or outbound(1)
1868 :param is_add: (Default value = 1)
1871 self.papi.ipsec_spd_entry_add_del,
1878 'local_address_start': local_address_start,
1879 'local_address_stop': local_address_stop,
1880 'remote_address_start': remote_address_start,
1881 'remote_address_stop': remote_address_stop,
1882 'local_port_start': local_port_start,
1883 'local_port_stop': local_port_stop,
1884 'remote_port_start': remote_port_start,
1885 'remote_port_stop': remote_port_stop,
1886 'protocol': protocol,
1888 'priority': priority,
1889 'is_outbound': is_outbound,
1890 'is_ip_any': is_ip_any
1894 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1895 return self.api(self.papi.ipsec_spd_dump,
1899 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1900 remote_spi, crypto_alg, local_crypto_key,
1901 remote_crypto_key, integ_alg, local_integ_key,
1902 remote_integ_key, is_add=1, esn=0, salt=0,
1903 anti_replay=1, renumber=0, show_instance=0):
1905 self.papi.ipsec_tunnel_if_add_del,
1907 'local_ip': local_ip,
1908 'remote_ip': remote_ip,
1909 'local_spi': local_spi,
1910 'remote_spi': remote_spi,
1911 'crypto_alg': crypto_alg,
1912 'local_crypto_key_len': len(local_crypto_key),
1913 'local_crypto_key': local_crypto_key,
1914 'remote_crypto_key_len': len(remote_crypto_key),
1915 'remote_crypto_key': remote_crypto_key,
1916 'integ_alg': integ_alg,
1917 'local_integ_key_len': len(local_integ_key),
1918 'local_integ_key': local_integ_key,
1919 'remote_integ_key_len': len(remote_integ_key),
1920 'remote_integ_key': remote_integ_key,
1923 'anti_replay': anti_replay,
1924 'renumber': renumber,
1925 'show_instance': show_instance,
1929 def ipsec_gre_tunnel_add_del(self, local_ip, remote_ip,
1930 sa_out, sa_in, is_add=1):
1931 return self.api(self.papi.ipsec_gre_tunnel_add_del,
1937 'local_sa_id': sa_out,
1938 'remote_sa_id': sa_in
1942 def ipsec_select_backend(self, protocol, index):
1943 return self.api(self.papi.ipsec_select_backend,
1944 {'protocol': protocol, 'index': index})
1946 def ipsec_backend_dump(self):
1947 return self.api(self.papi.ipsec_backend_dump, {})
1949 def app_namespace_add_del(self,
1953 sw_if_index=0xFFFFFFFF,
1956 self.papi.app_namespace_add_del,
1958 'sw_if_index': sw_if_index,
1959 'ip4_fib_id': ip4_fib_id,
1960 'ip6_fib_id': ip6_fib_id,
1961 'namespace_id': namespace_id,
1962 'namespace_id_len': len(namespace_id)})
1964 def punt_socket_register(self, port, pathname, protocol=0x11,
1965 header_version=1, is_ip4=1):
1966 """ Register punt socket """
1967 return self.api(self.papi.punt_socket_register,
1968 {'header_version': header_version,
1969 'punt': {'ipv': is_ip4,
1970 'l4_protocol': protocol,
1972 'pathname': pathname})
1974 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
1975 """ Unregister punt socket """
1976 return self.api(self.papi.punt_socket_deregister,
1977 {'punt': {'ipv': is_ip4,
1978 'l4_protocol': protocol,
1981 def punt_socket_dump(self, is_ip6=1):
1982 """ Dump punt socket"""
1983 return self.api(self.papi.punt_socket_dump,
1984 {'is_ipv6': is_ip6})
1986 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1988 """ GBP endpoint Add """
1989 return self.api(self.papi.gbp_endpoint_add,
1991 'sw_if_index': sw_if_index,
2002 def gbp_endpoint_del(self, handle):
2003 """ GBP endpoint Del """
2004 return self.api(self.papi.gbp_endpoint_del,
2007 def gbp_endpoint_dump(self):
2008 """ GBP endpoint Dump """
2009 return self.api(self.papi.gbp_endpoint_dump,
2010 {'_no_type_conversion': True})
2012 def gbp_endpoint_group_add(self, vnid, sclass, bd,
2013 rd, uplink_sw_if_index,
2015 """ GBP endpoint group Add """
2016 return self.api(self.papi.gbp_endpoint_group_add,
2019 'uplink_sw_if_index': uplink_sw_if_index,
2024 'retention': retention
2027 def gbp_endpoint_group_del(self, sclass):
2028 """ GBP endpoint group Del """
2029 return self.api(self.papi.gbp_endpoint_group_del,
2032 def gbp_bridge_domain_add(self, bd_id, flags,
2035 bm_flood_sw_if_index):
2036 """ GBP bridge-domain Add """
2037 return self.api(self.papi.gbp_bridge_domain_add,
2041 'bvi_sw_if_index': bvi_sw_if_index,
2042 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2043 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2047 def gbp_bridge_domain_del(self, bd_id):
2048 """ GBP bridge-domain Del """
2049 return self.api(self.papi.gbp_bridge_domain_del,
2052 def gbp_route_domain_add(self, rd_id,
2056 ip6_uu_sw_if_index):
2057 """ GBP route-domain Add """
2058 return self.api(self.papi.gbp_route_domain_add,
2061 'ip4_table_id': ip4_table_id,
2062 'ip6_table_id': ip6_table_id,
2063 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2064 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2068 def gbp_route_domain_del(self, rd_id):
2069 """ GBP route-domain Del """
2070 return self.api(self.papi.gbp_route_domain_del,
2073 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2074 """ GBP recirc Add/Del """
2075 return self.api(self.papi.gbp_recirc_add_del,
2079 'sw_if_index': sw_if_index,
2082 def gbp_recirc_dump(self):
2083 """ GBP recirc Dump """
2084 return self.api(self.papi.gbp_recirc_dump, {})
2086 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2087 """ GBP recirc Add/Del """
2088 return self.api(self.papi.gbp_ext_itf_add_del,
2091 'sw_if_index': sw_if_index,
2095 def gbp_ext_itf_dump(self):
2096 """ GBP recirc Dump """
2097 return self.api(self.papi.gbp_ext_itf_dump, {})
2099 def gbp_subnet_add_del(self, is_add, rd_id,
2101 sw_if_index=0xffffffff,
2103 """ GBP Subnet Add/Del """
2104 return self.api(self.papi.gbp_subnet_add_del,
2108 'sw_if_index': sw_if_index,
2113 def gbp_subnet_dump(self):
2114 """ GBP Subnet Dump """
2115 return self.api(self.papi.gbp_subnet_dump,
2116 {'_no_type_conversion': True})
2118 def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2119 rules, allowed_ethertypes):
2120 """ GBP contract Add/Del """
2121 return self.api(self.papi.gbp_contract_add_del,
2124 'acl_index': acl_index,
2127 'n_rules': len(rules),
2129 'n_ether_types': len(allowed_ethertypes),
2130 'allowed_ethertypes': allowed_ethertypes}})
2132 def gbp_contract_dump(self):
2133 """ GBP contract Dump """
2134 return self.api(self.papi.gbp_contract_dump, {})
2136 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2137 """ GBP VXLAN tunnel add """
2138 return self.api(self.papi.gbp_vxlan_tunnel_add,
2143 'bd_rd_id': bd_rd_id,
2148 def gbp_vxlan_tunnel_del(self, vni):
2149 """ GBP VXLAN tunnel del """
2150 return self.api(self.papi.gbp_vxlan_tunnel_del,
2155 def gbp_vxlan_tunnel_dump(self):
2156 """ GBP VXLAN tunnel add/del """
2157 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2159 def qos_egress_map_update(self, id, outputs):
2160 """ QOS egress map update """
2161 return self.api(self.papi.qos_egress_map_update,
2165 def qos_egress_map_delete(self, id):
2166 """ QOS egress map delete """
2167 return self.api(self.papi.qos_egress_map_delete,
2170 def qos_mark_enable_disable(self, sw_if_index,
2174 """ QOS Mark Enable/Disable """
2175 return self.api(self.papi.qos_mark_enable_disable,
2177 'sw_if_index': sw_if_index,
2178 'output_source': output_source,
2181 def igmp_enable_disable(self, sw_if_index, enable, host):
2182 """ Enable/disable IGMP on a given interface """
2183 return self.api(self.papi.igmp_enable_disable,
2186 'sw_if_index': sw_if_index})
2188 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2189 """ Add/del IGMP proxy device """
2190 return self.api(self.papi.igmp_proxy_device_add_del,
2191 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2194 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2195 """ Add/del interface to/from IGMP proxy device """
2196 return self.api(self.papi.igmp_proxy_device_add_del_interface,
2197 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2200 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2201 """ Listen for new (S,G) on specified interface
2203 :param enable: add/del
2204 :param sw_if_index: interface sw index
2205 :param saddr: source ip4 addr
2206 :param gaddr: group ip4 addr
2208 return self.api(self.papi.igmp_listen,
2213 'sw_if_index': sw_if_index,
2214 'n_srcs': len(saddrs),
2220 def igmp_clear_interface(self, sw_if_index):
2221 """ Remove all (S,G)s from specified interface
2222 doesn't send IGMP report!
2225 self.papi.igmp_clear_interface, {
2226 'sw_if_index': sw_if_index})
2228 def want_igmp_events(self, enable=1):
2229 return self.api(self.papi.want_igmp_events, {'enable': enable,
2230 'pid': os.getpid()})
2238 interface_id=0xFFFFFFFF):
2241 :param lb: load balance
2242 :param use_custom_mac: use custom mac
2243 :param mac_address: mac address
2244 :param interface_id: custom interface ID
2247 self.papi.bond_create,
2250 'use_custom_mac': use_custom_mac,
2251 'mac_address': mac_address,
2255 def pipe_delete(self, parent_sw_if_index):
2256 return self.api(self.papi.pipe_delete,
2257 {'parent_sw_if_index': parent_sw_if_index})
2271 return self.api(self.papi.memif_create,
2274 'rx_queues': rx_queues,
2275 'tx_queues': tx_queues,
2277 'socket_id': socket_id,
2279 'ring_size': ring_size,
2280 'buffer_size': buffer_size,
2281 'hw_addr': hw_addr})
2283 def svs_table_add_del(self, af, table_id, is_add=1):
2284 return self.api(self.papi.svs_table_add_del,
2286 'table_id': table_id,
2291 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2292 return self.api(self.papi.svs_route_add_del,
2294 'table_id': table_id,
2295 'source_table_id': src_table_id,
2300 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2301 return self.api(self.papi.svs_enable_disable,
2304 'table_id': table_id,
2305 'sw_if_index': sw_if_index,
2306 'is_enable': is_enable,