1 # NB NB NB NB NB NB NB NB NB NB NB
3 # NOTE: The API binary wrappers in this file are in the process of being
4 # deprecated. DO NOT ADD NEW WRAPPERS HERE. Call the functions using
5 # named arguments directly instead.
10 from collections import deque
12 from six import moves, iteritems
13 from vpp_papi import VPPApiClient, mac_pton
15 from vpp_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID
19 # Dictionary keyed on message name to override default values for
23 'map_add_domain': {'mtu': 1280},
24 'syslog_set_sender': {'collector_port': 514,
26 'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
27 'acl_interface_list_dump': {'sw_if_index': 4294967295, },
28 'app_namespace_add_del': {'sw_if_index': 4294967295, },
29 'bd_ip_mac_add_del': {'is_add': 1, },
30 'bfd_udp_add': {'is_authenticated': False, 'bfd_key_id': None,
32 'bfd_udp_auth_activate': {'bfd_key_id': None, 'conf_key_id': None,
34 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
36 'bier_disp_table_add_del': {'is_add': 1, },
37 'bier_imp_add': {'is_add': 1, },
38 'bier_route_add_del': {'is_add': 1, },
39 'bier_table_add_del': {'is_add': 1, },
40 'bond_create': {'mac_address': '', 'id': 0xFFFFFFFF},
41 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
42 'learn': 1, 'is_add': 1, },
43 'bvi_create': {'user_instance': 4294967295, },
45 'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
46 'nbuckets': 2, 'memory_size': 2097152,
47 'next_table_index': 4294967295,
48 'miss_next_index': 4294967295, },
49 'dhcp6_client_enable_disable': {'enable': 1, },
50 'dhcp6_clients_enable_disable': {'enable': 1, },
51 'dhcp6_pd_client_enable_disable': {'enable': 1, },
52 'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
53 'dhcp6_pd_send_client_message': {'server_index': 0xFFFFFFFF, 'mrc': 1},
54 'dhcp_client_config': {'is_add': 1, 'client': {'set_broadcast_flag': 1}, },
55 'dhcp_proxy_config': {'is_add': 1, },
56 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
57 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
58 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
59 'decap_next_index': 4294967295, },
60 'gre_tunnel_add_del': {'instance': 4294967295, 'is_add': 1, },
61 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
62 'decap_next_index': 4294967295, },
63 'input_acl_set_interface': {'ip4_table_index': 4294967295,
64 'ip6_table_index': 4294967295,
65 'l2_table_index': 4294967295, },
66 'ip6_add_del_address_using_prefix': {'is_add': 1, },
67 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
68 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
69 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
70 'classify_table_index': 4294967295, 'is_add': 1, },
71 'ip_mroute_add_del': {'is_add': 1, },
72 'ip_neighbor_add_del': {'is_add': 1, },
73 'ip_punt_police': {'is_add': 1, },
74 'ip_punt_redirect': {'is_add': 1, },
75 'ip_route_add_del': {'is_add': 1, },
76 'ip_table_add_del': {'is_add': 1, },
77 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
78 'ipsec_interface_add_del_spd': {'is_add': 1, },
79 'ipsec_sad_entry_add_del': {'is_add': 1, },
80 'ipsec_spd_add_del': {'is_add': 1, },
81 'ipsec_spd_dump': {'sa_id': 4294967295, },
82 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
83 'remote_port_stop': 65535, 'priority': 100,
86 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
87 'l2_emulation': {'enable': 1, },
88 'l2fib_add_del': {'is_add': 1, },
89 'lb_conf': {'sticky_buckets_per_core': 4294967295,
90 'flow_timeout': 4294967295},
91 'lisp_add_del_adjacency': {'is_add': 1, },
92 'lisp_add_del_local_eid': {'is_add': 1, },
93 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
94 'lisp_add_del_locator_set': {'is_add': 1, },
95 'lisp_add_del_remote_mapping': {'is_add': 1, },
96 'macip_acl_add_replace': {'acl_index': 4294967295, },
97 'macip_acl_dump': {'acl_index': 4294967295, },
98 'macip_acl_interface_add_del': {'is_add': 1, },
99 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
100 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
101 'mr_next_hop_weight': 1,
102 'mr_next_hop_via_label': 1048576,
104 'mr_classify_table_index': 4294967295, },
105 'mpls_table_add_del': {'is_add': 1, },
106 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
107 'next_hop_weight': 1,
108 'next_hop_via_label': 1048576,
110 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
111 'output_acl_set_interface': {'ip4_table_index': 4294967295,
112 'ip6_table_index': 4294967295,
113 'l2_table_index': 4294967295, },
114 'pppoe_add_del_session': {'is_add': 1, },
115 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
116 'proxy_arp_add_del': {'is_add': 1, },
117 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
118 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
120 'set_ipfix_exporter': {'collector_port': 4739, },
121 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
122 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
123 'svs_enable_disable': {'is_enable': 1, },
124 'svs_route_add_del': {'is_add': 1, },
125 'svs_table_add_del': {'is_add': 1, },
126 'sw_interface_add_del_address': {'is_add': 1, },
127 'sw_interface_dump': {'sw_if_index': 4294967295, },
128 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
129 'pref_lifetime': 4294967295, },
130 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
131 'sw_interface_set_l2_bridge': {'enable': 1, },
132 'sw_interface_set_mpls_enable': {'enable': 1, },
133 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
134 'sw_interface_set_unnumbered': {'is_add': 1, },
135 'sw_interface_span_enable_disable': {'state': 1, },
136 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
137 'decap_next_index': 4294967295,
138 'instance': 4294967295, },
139 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
140 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
142 'want_bfd_events': {'enable_disable': 1, },
143 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
144 'want_dhcp6_reply_events': {'enable_disable': 1, },
145 'want_igmp_events': {'enable': 1, },
146 'want_interface_events': {'enable_disable': 1, },
147 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
148 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
149 'want_ip6_ra_events': {'enable_disable': 1, },
150 'want_l2_macs_events': {'enable_disable': 1, },
151 'want_dhcp6_reply_events': {'enable_disable': 1, 'pid': os.getpid(), },
152 'want_dhcp6_pd_reply_events': {'enable_disable': 1, 'pid': os.getpid(), },
156 class CliFailedCommandError(Exception):
157 """ cli command failed."""
160 class CliSyntaxError(Exception):
161 """ cli command had a syntax error."""
164 class UnexpectedApiReturnValueError(Exception):
165 """ exception raised when the API return value is unexpected """
169 class VppPapiProvider(object):
170 """VPP-api provider using vpp-papi
172 @property hook: hook object providing before and after api/cli hooks
175 _zero, _negative = range(2)
177 def __init__(self, name, shm_prefix, test_class, read_timeout):
178 self.hook = Hook(test_class)
180 self.shm_prefix = shm_prefix
181 self.test_class = test_class
182 self._expect_api_retval = self._zero
183 self._expect_stack = []
185 # install_dir is a class attribute. We need to set it before
186 # calling the constructor.
187 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
191 if os.environ['SOCKET'] == '1':
196 self.vpp = VPPApiClient(logger=test_class.logger,
197 read_timeout=read_timeout,
198 use_socket=use_socket,
199 server_address=test_class.api_sock)
200 self._events = deque()
205 def assert_negative_api_retval(self):
206 """ Expect API failure - used with with, e.g.:
207 with self.vapi.assert_negative_api_retval():
208 self.vapi.<api call expected to fail>
210 self._expect_stack.append(self._expect_api_retval)
211 self._expect_api_retval = self._negative
214 def assert_zero_api_retval(self):
215 """ Expect API success - used with with, e.g.:
216 with self.vapi.assert_negative_api_retval():
217 self.vapi.<api call expected to succeed>
219 note: this is useful only inside another with block
220 as success is the default expected value
222 self._expect_stack.append(self._expect_api_retval)
223 self._expect_api_retval = self._zero
226 def __exit__(self, exc_type, exc_value, traceback):
227 self._expect_api_retval = self._expect_stack.pop()
229 def register_hook(self, hook):
230 """Replace hook registration with new hook
237 def collect_events(self):
238 """ Collect all events from the internal queue and clear the queue. """
240 self._events = deque()
243 def wait_for_event(self, timeout, name=None):
244 """ Wait for and return next event. """
246 self.test_class.logger.debug("Expecting event '%s' within %ss",
249 self.test_class.logger.debug("Expecting event within %ss",
252 self.test_class.logger.debug("Not waiting, event already queued")
253 limit = time.time() + timeout
254 while time.time() < limit:
256 e = self._events.popleft()
257 if name and type(e).__name__ != name:
259 "Unexpected event received: %s, expected: %s" %
260 (type(e).__name__, name))
261 self.test_class.logger.debug("Returning event %s:%s" %
264 self.test_class.sleep(0) # yield
265 raise Exception("Event did not occur within timeout")
267 def __call__(self, name, event):
268 """ Enqueue event in the internal event queue. """
269 # FIXME use the name instead of relying on type(e).__name__ ?
270 # FIXME #2 if this throws, it is eaten silently, Ole?
271 self.test_class.logger.debug("New event: %s: %s" % (name, event))
272 self._events.append(event)
274 def factory(self, name, apifn):
276 fields = apifn._func.msg.fields
278 # add positional and kw arguments
280 for i, o in enumerate(fields[3:]):
283 except BaseException:
287 if name in defaultmapping:
288 for k, v in iteritems(defaultmapping[name]):
292 return self.api(apifn, d)
296 def __getattribute__(self, name):
298 method = super(VppPapiProvider, self).__getattribute__(name)
299 except AttributeError:
300 method = self.factory(name, getattr(self.papi, name))
301 # lazily load the method so we don't need to call factory
302 # again for this name.
303 setattr(self, name, method)
307 """Connect the API to VPP"""
308 self.vpp.connect(self.name, self.shm_prefix)
309 self.papi = self.vpp.api
310 self.vpp.register_event_callback(self)
312 def disconnect(self):
313 """Disconnect the API from VPP"""
314 self.vpp.disconnect()
316 def api(self, api_fn, api_args, expected_retval=0):
317 """ Call API function and check it's return value.
318 Call the appropriate hooks before and after the API call
320 :param api_fn: API function to call
321 :param api_args: tuple of API function arguments
322 :param expected_retval: Expected return value (Default value = 0)
323 :returns: reply from the API
326 self.hook.before_api(api_fn.__name__, api_args)
327 reply = api_fn(**api_args)
328 if self._expect_api_retval == self._negative:
329 if hasattr(reply, 'retval') and reply.retval >= 0:
330 msg = "API call passed unexpectedly: expected negative " \
331 "return value instead of %d in %s" % \
332 (reply.retval, moves.reprlib.repr(reply))
333 self.test_class.logger.info(msg)
334 raise UnexpectedApiReturnValueError(msg)
335 elif self._expect_api_retval == self._zero:
336 if hasattr(reply, 'retval') and reply.retval != expected_retval:
337 msg = "API call failed, expected %d return value instead " \
338 "of %d in %s" % (expected_retval, reply.retval,
340 self.test_class.logger.info(msg)
341 raise UnexpectedApiReturnValueError(msg)
343 raise Exception("Internal error, unexpected value for "
344 "self._expect_api_retval %s" %
345 self._expect_api_retval)
346 self.hook.after_api(api_fn.__name__, api_args)
350 """ Execute a CLI, calling the before/after hooks appropriately.
352 :param cli: CLI to execute
356 self.hook.before_cli(cli)
358 r = self.papi.cli_inband(cmd=cli)
359 self.hook.after_cli(cli)
361 raise CliSyntaxError(r.reply)
363 raise CliFailedCommandError(r.reply)
364 if hasattr(r, 'reply'):
367 def ppcli(self, cli):
368 """ Helper method to print CLI command in case of info logging level.
370 :param cli: CLI to execute
373 return cli + "\n" + str(self.cli(cli))
375 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
376 return self.api(self.papi.want_ip4_arp_events,
377 {'enable_disable': enable_disable,
379 'pid': os.getpid(), })
381 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
382 return self.api(self.papi.want_ip6_nd_events,
383 {'enable_disable': enable_disable,
385 'pid': os.getpid(), })
387 def want_ip6_ra_events(self, enable_disable=1):
388 return self.api(self.papi.want_ip6_ra_events,
389 {'enable_disable': enable_disable,
390 'pid': os.getpid(), })
392 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
394 return self.api(self.papi.ip6nd_send_router_solicitation,
399 'sw_if_index': sw_if_index})
401 def want_interface_events(self, enable_disable=1):
402 return self.api(self.papi.want_interface_events,
403 {'enable_disable': enable_disable,
404 'pid': os.getpid(), })
406 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
407 max_macs_in_event=0, learn_limit=0):
408 return self.api(self.papi.want_l2_macs_events,
409 {'enable_disable': enable_disable,
410 'scan_delay': scan_delay,
411 'max_macs_in_event': max_macs_in_event,
412 'learn_limit': learn_limit,
413 'pid': os.getpid(), })
415 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
416 prefix_length, prefix_group,
418 return self.api(self.papi.ip6_add_del_address_using_prefix,
419 {'sw_if_index': sw_if_index,
420 'prefix_group': prefix_group,
422 'prefix_length': prefix_length,
425 def sw_interface_set_mac_address(self, sw_if_index, mac):
426 return self.api(self.papi.sw_interface_set_mac_address,
427 {'sw_if_index': sw_if_index,
430 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
431 """Create p2p ethernet subinterface
433 :param sw_if_index: main (parent) interface
434 :param remote_mac: client (remote) mac address
438 self.papi.p2p_ethernet_add,
439 {'parent_if_index': sw_if_index,
440 'remote_mac': remote_mac,
441 'subif_id': subif_id})
443 def p2p_ethernet_del(self, sw_if_index, remote_mac):
444 """Delete p2p ethernet subinterface
446 :param sw_if_index: main (parent) interface
447 :param remote_mac: client (remote) mac address
451 self.papi.p2p_ethernet_del,
452 {'parent_if_index': sw_if_index,
453 'remote_mac': remote_mac})
455 def create_vlan_subif(self, sw_if_index, vlan):
462 return self.api(self.papi.create_vlan_subif,
463 {'sw_if_index': sw_if_index,
466 def create_loopback(self, mac=''):
469 :param mac: (Optional)
471 return self.api(self.papi.create_loopback,
472 {'mac_address': mac})
474 def ip_table_add_del(self,
481 :param is_add: (Default value = 1)
482 :param is_ipv6: (Default value = 0)
487 self.papi.ip_table_add_del,
490 'table_id': table_id,
495 def ip_table_dump(self):
496 return self.api(self.papi.ip_table_dump, {})
498 def ip_route_dump(self, table_id, is_ip6=False):
499 return self.api(self.papi.ip_route_dump,
501 'table_id': table_id,
505 def ip_neighbor_add_del(self,
511 """ Add neighbor MAC to IPv4 or IPv6 address.
516 :param is_add: (Default value = 1)
517 :param flags: (Default value = 0/NONE)
520 self.papi.ip_neighbor_add_del,
524 'sw_if_index': sw_if_index,
526 'mac_address': mac_address,
527 'ip_address': ip_address
532 def proxy_arp_add_del(self,
537 """ Config Proxy Arp Range.
539 :param low_address: Start address in the rnage to Proxy for
540 :param hi_address: End address in the rnage to Proxy for
541 :param vrf_id: The VRF/table in which to proxy
545 self.papi.proxy_arp_add_del,
548 'table_id': table_id,
554 def proxy_arp_intfc_enable_disable(self,
557 """ Enable/Disable an interface for proxy ARP requests
559 :param sw_if_index: Interface
560 :param enable_disable: Enable/Disable
564 self.papi.proxy_arp_intfc_enable_disable,
565 {'sw_if_index': sw_if_index,
566 'enable_disable': is_enable
570 def gre_tunnel_add_del(self,
582 :param outer_fib_id: (Default value = 0)
583 :param tunnel_type: (Default value = 0)
584 :param instance: (Default value = 0xFFFFFFFF)
585 :param session_id: (Default value = 0)
586 :param is_add: (Default value = 1)
587 :param is_ipv6: (Default value = 0)
591 self.papi.gre_tunnel_add_del,
596 'instance': instance,
599 'outer_fib_id': outer_fib_id,
600 'session_id': session_id}
604 def udp_encap_add(self,
615 :param outer_fib_id: (Default value = 0)
619 self.papi.udp_encap_add,
624 'src_port': src_port,
625 'dst_port': dst_port,
630 def udp_encap_del(self, id):
631 return self.api(self.papi.udp_encap_del, {'id': id})
633 def udp_encap_dump(self):
634 return self.api(self.papi.udp_encap_dump, {})
636 def want_udp_encap_stats(self, enable=1):
637 return self.api(self.papi.want_udp_encap_stats,
641 def mpls_route_dump(self, table_id):
642 return self.api(self.papi.mpls_route_dump,
644 'mt_table_id': table_id
647 def mpls_table_dump(self):
648 return self.api(self.papi.mpls_table_dump, {})
650 def mpls_table_add_del(
657 :param is_add: (Default value = 1)
662 self.papi.mpls_table_add_del,
665 'mt_table_id': table_id,
667 'mt_is_add': is_add})
669 def mpls_route_add_del(self,
678 """ MPLS Route add/del """
680 self.papi.mpls_route_add_del,
683 'mr_table_id': table_id,
686 'mr_eos_proto': eos_proto,
687 'mr_is_multicast': is_multicast,
688 'mr_n_paths': len(paths),
692 'mr_is_multipath': is_multipath})
694 def mpls_ip_bind_unbind(
704 self.papi.mpls_ip_bind_unbind,
705 {'mb_mpls_table_id': table_id,
707 'mb_ip_table_id': ip_table_id,
708 'mb_is_bind': is_bind,
709 'mb_prefix': prefix})
711 def mpls_tunnel_add_del(
721 self.papi.mpls_tunnel_add_del,
722 {'mt_is_add': is_add,
725 'mt_sw_if_index': tun_sw_if_index,
726 'mt_l2_only': l2_only,
727 'mt_is_multicast': is_multicast,
728 'mt_n_paths': len(paths),
732 def classify_add_del_table(
737 table_index=0xFFFFFFFF,
741 next_table_index=0xFFFFFFFF,
742 miss_next_index=0xFFFFFFFF,
744 current_data_offset=0):
748 :param match_n_vectors: (Default value = 1)
749 :param table_index: (Default value = 0xFFFFFFFF)
750 :param nbuckets: (Default value = 2)
751 :param memory_size: (Default value = 2097152)
752 :param skip_n_vectors: (Default value = 0)
753 :param next_table_index: (Default value = 0xFFFFFFFF)
754 :param miss_next_index: (Default value = 0xFFFFFFFF)
755 :param current_data_flag: (Default value = 0)
756 :param current_data_offset: (Default value = 0)
759 mask_len = ((len(mask) - 1) / 16 + 1) * 16
760 mask = mask + '\0' * (mask_len - len(mask))
762 self.papi.classify_add_del_table,
764 'table_index': table_index,
765 'nbuckets': nbuckets,
766 'memory_size': memory_size,
767 'skip_n_vectors': skip_n_vectors,
768 'match_n_vectors': match_n_vectors,
769 'next_table_index': next_table_index,
770 'miss_next_index': miss_next_index,
771 'current_data_flag': current_data_flag,
772 'current_data_offset': current_data_offset,
773 'mask_len': mask_len,
776 def classify_add_del_session(
781 opaque_index=0xFFFFFFFF,
782 hit_next_index=0xFFFFFFFF,
790 :param opaque_index: (Default value = 0xFFFFFFFF)
791 :param hit_next_index: (Default value = 0xFFFFFFFF)
792 :param advance: (Default value = 0)
793 :param action: (Default value = 0)
794 :param metadata: (Default value = 0)
797 match_len = ((len(match) - 1) / 16 + 1) * 16
798 match = match + '\0' * (match_len - len(match))
800 self.papi.classify_add_del_session,
802 'table_index': table_index,
803 'hit_next_index': hit_next_index,
804 'opaque_index': opaque_index,
807 'metadata': metadata,
808 'match_len': match_len,
811 def input_acl_set_interface(
815 ip4_table_index=0xFFFFFFFF,
816 ip6_table_index=0xFFFFFFFF,
817 l2_table_index=0xFFFFFFFF):
821 :param ip4_table_index: (Default value = 0xFFFFFFFF)
822 :param ip6_table_index: (Default value = 0xFFFFFFFF)
823 :param l2_table_index: (Default value = 0xFFFFFFFF)
827 self.papi.input_acl_set_interface,
828 {'sw_if_index': sw_if_index,
829 'ip4_table_index': ip4_table_index,
830 'ip6_table_index': ip6_table_index,
831 'l2_table_index': l2_table_index,
834 def output_acl_set_interface(
838 ip4_table_index=0xFFFFFFFF,
839 ip6_table_index=0xFFFFFFFF,
840 l2_table_index=0xFFFFFFFF):
844 :param ip4_table_index: (Default value = 0xFFFFFFFF)
845 :param ip6_table_index: (Default value = 0xFFFFFFFF)
846 :param l2_table_index: (Default value = 0xFFFFFFFF)
850 self.papi.output_acl_set_interface,
851 {'sw_if_index': sw_if_index,
852 'ip4_table_index': ip4_table_index,
853 'ip6_table_index': ip6_table_index,
854 'l2_table_index': l2_table_index,
857 def set_ipfix_exporter(
867 self.papi.set_ipfix_exporter,
869 'collector_address': collector_address,
870 'collector_port': collector_port,
871 'src_address': src_address,
873 'path_mtu': path_mtu,
874 'template_interval': template_interval,
875 'udp_checksum': udp_checksum,
878 def ip_mroute_add_del(self,
887 IP Multicast Route add/del
890 self.papi.ip_mroute_add_del,
893 'is_multipath': is_multipath,
895 'table_id': table_id,
896 'entry_flags': e_flags,
899 'n_paths': len(paths),
904 def mfib_signal_dump(self):
905 return self.api(self.papi.mfib_signal_dump, {})
907 def ip_mroute_dump(self, table_id, is_ip6=False):
908 return self.api(self.papi.ip_mroute_dump,
910 'table_id': table_id,
914 def lisp_enable_disable(self, is_enabled):
916 self.papi.lisp_enable_disable,
921 def lisp_add_del_locator_set(self,
925 self.papi.lisp_add_del_locator_set,
928 'locator_set_name': ls_name
931 def lisp_add_del_locator(self,
938 self.papi.lisp_add_del_locator,
941 'locator_set_name': ls_name,
942 'sw_if_index': sw_if_index,
943 'priority': priority,
947 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
949 self.papi.lisp_locator_dump,
951 'is_index_set': is_index_set,
953 'ls_index': ls_index,
956 def lisp_add_del_local_eid(self,
966 self.papi.lisp_add_del_local_eid,
968 'locator_set_name': ls_name,
970 'eid_type': eid_type,
972 'prefix_len': prefix_len,
978 def lisp_eid_table_dump(self,
986 self.papi.lisp_eid_table_dump,
989 'prefix_length': prefix_length,
991 'eid_type': eid_type,
993 'filter': filter_opt,
996 def lisp_add_del_remote_mapping(self,
1006 self.papi.lisp_add_del_remote_mapping,
1009 'eid_type': eid_type,
1011 'eid_len': eid_prefix_len,
1012 'rloc_num': rlocs_num,
1015 'is_src_dst': is_src_dst,
1018 def lisp_add_del_adjacency(self,
1027 self.papi.lisp_add_del_adjacency,
1031 'eid_type': eid_type,
1034 'leid_len': leid_len,
1035 'reid_len': reid_len,
1038 def gtpu_add_del_tunnel(
1044 mcast_sw_if_index=0xFFFFFFFF,
1046 decap_next_index=0xFFFFFFFF,
1050 :param is_add: (Default value = 1)
1051 :param is_ipv6: (Default value = 0)
1054 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1055 :param encap_vrf_id: (Default value = 0)
1056 :param decap_next_index: (Default value = 0xFFFFFFFF)
1057 :param teid: (Default value = 0)
1060 return self.api(self.papi.gtpu_add_del_tunnel,
1063 'src_address': src_addr,
1064 'dst_address': dst_addr,
1065 'mcast_sw_if_index': mcast_sw_if_index,
1066 'encap_vrf_id': encap_vrf_id,
1067 'decap_next_index': decap_next_index,
1070 def vxlan_gpe_add_del_tunnel(
1074 mcast_sw_if_index=0xFFFFFFFF,
1085 :param is_add: (Default value = 1)
1086 :param is_ipv6: (Default value = 0)
1087 :param encap_vrf_id: (Default value = 0)
1088 :param decap_vrf_id: (Default value = 0)
1089 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1090 :param protocol: (Default value = 3)
1091 :param vni: (Default value = 0)
1094 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1099 'mcast_sw_if_index': mcast_sw_if_index,
1100 'encap_vrf_id': encap_vrf_id,
1101 'decap_vrf_id': decap_vrf_id,
1102 'protocol': protocol,
1105 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1106 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1107 {'sw_if_index': sw_if_index,
1108 '_no_type_conversion': True})
1110 def pppoe_add_del_session(
1120 :param is_add: (Default value = 1)
1121 :param is_ipv6: (Default value = 0)
1123 :param session_id: (Default value = 0)
1125 :param decap_vrf_id: (Default value = 0)
1128 return self.api(self.papi.pppoe_add_del_session,
1131 'session_id': session_id,
1132 'client_ip': client_ip,
1133 'decap_vrf_id': decap_vrf_id,
1134 'client_mac': client_mac})
1136 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1137 return self.api(self.papi.sr_mpls_policy_add,
1141 'n_segments': len(segments),
1142 'segments': segments})
1144 def sr_mpls_policy_del(self, bsid):
1145 return self.api(self.papi.sr_mpls_policy_del,
1148 def sr_localsid_add_del(self,
1155 sw_if_index=0xFFFFFFFF,
1159 """ Add/del IPv6 SR local-SID.
1162 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1163 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1166 :param is_del: (Default value = 0)
1167 :param end_psp: (Default value = 0)
1168 :param sw_if_index: (Default value = 0xFFFFFFFF)
1169 :param vlan_index: (Default value = 0)
1170 :param fib_table: (Default value = 0)
1173 self.papi.sr_localsid_add_del,
1175 'localsid': localsid,
1177 'behavior': behavior,
1178 'sw_if_index': sw_if_index,
1179 'vlan_index': vlan_index,
1180 'fib_table': fib_table,
1181 'nh_addr4': nh_addr4,
1182 'nh_addr6': nh_addr6
1196 :param bsid_addr: bindingSID of the SR Policy
1197 :param weight: weight of the sid list. optional. (default: 1)
1198 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1200 :param type: type/behavior of the SR policy. (default or spray) \
1202 :param fib_table: VRF where to install the FIB entry for the BSID \
1204 :param n_segments: number of segments \
1206 :param segments: a vector of IPv6 address composing the segment list \
1210 self.papi.sr_policy_add,
1211 {'bsid_addr': bsid_addr,
1213 'is_encap': is_encap,
1215 'fib_table': fib_table,
1216 'n_segments': n_segments,
1217 'segments': segments
1226 :param bsid: bindingSID of the SR Policy
1227 :param sr_policy_index: index of the sr policy (default: 0)
1230 self.papi.sr_policy_del,
1231 {'bsid_addr': bsid_addr,
1232 'sr_policy_index': sr_policy_index
1235 def sr_steering_add_del(
1246 Steer traffic L2 and L3 traffic through a given SR policy
1248 :param is_del: delete or add
1249 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1250 :param sr_policy: is the index of the SR Policy (alt to bsid)
1251 :param table_id: is the VRF where to install the FIB entry for the BSID
1252 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1253 :param mask_width: is the mask for L3 traffic type
1254 :param sw_if_index: is the incoming interface for L2 traffic
1255 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1258 self.papi.sr_steering_add_del,
1260 'bsid_addr': bsid_addr,
1261 'sr_policy_index': sr_policy_index,
1262 'table_id': table_id,
1263 'prefix_addr': prefix_addr,
1264 'mask_width': mask_width,
1265 'sw_if_index': sw_if_index,
1266 'traffic_type': traffic_type
1269 def acl_add_replace(self, acl_index, r, tag='',
1271 """Add/replace an ACL
1272 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1273 :param acl_rule r: ACL rules array.
1274 :param str tag: symbolic tag (description) for this ACL.
1275 :param int count: number of rules.
1277 return self.api(self.papi.acl_add_replace,
1278 {'acl_index': acl_index,
1282 expected_retval=expected_retval)
1284 def acl_del(self, acl_index, expected_retval=0):
1290 return self.api(self.papi.acl_del,
1291 {'acl_index': acl_index},
1292 expected_retval=expected_retval)
1294 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1296 return self.api(self.papi.acl_interface_set_acl_list,
1297 {'sw_if_index': sw_if_index,
1301 expected_retval=expected_retval)
1303 def acl_interface_set_etype_whitelist(self, sw_if_index,
1306 return self.api(self.papi.acl_interface_set_etype_whitelist,
1307 {'sw_if_index': sw_if_index,
1308 'count': len(whitelist),
1310 'whitelist': whitelist},
1311 expected_retval=expected_retval)
1313 def acl_interface_add_del(self,
1317 """ Add/Delete ACL to/from interface
1321 :param is_add: (Default value = 1)
1324 return self.api(self.papi.acl_interface_add_del,
1327 'sw_if_index': sw_if_index,
1328 'acl_index': acl_index})
1330 def acl_dump(self, acl_index, expected_retval=0):
1331 return self.api(self.papi.acl_dump,
1332 {'acl_index': acl_index},
1333 expected_retval=expected_retval)
1335 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1337 return self.api(self.papi.acl_interface_list_dump,
1338 {'sw_if_index': sw_if_index},
1339 expected_retval=expected_retval)
1341 def macip_acl_add(self, rules, tag=""):
1344 :param rules: list of rules for given acl
1348 return self.api(self.papi.macip_acl_add,
1350 'count': len(rules),
1353 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1356 :param rules: list of rules for given acl
1360 return self.api(self.papi.macip_acl_add_replace,
1361 {'acl_index': acl_index,
1363 'count': len(rules),
1366 def macip_acl_interface_add_del(self,
1370 """ Add MACIP acl to interface
1374 :param is_add: (Default value = 1)
1377 return self.api(self.papi.macip_acl_interface_add_del,
1379 'sw_if_index': sw_if_index,
1380 'acl_index': acl_index})
1382 def macip_acl_dump(self, acl_index=4294967295):
1383 """ Return MACIP acl dump
1387 self.papi.macip_acl_dump, {'acl_index': acl_index})
1389 def policer_add_del(self,
1400 conform_action_type=1,
1402 exceed_action_type=0,
1404 violate_action_type=0,
1406 return self.api(self.papi.policer_add_del,
1413 'rate_type': rate_type,
1414 'round_type': round_type,
1416 'color_aware': color_aware,
1417 'conform_action_type': conform_action_type,
1418 'conform_dscp': conform_dscp,
1419 'exceed_action_type': exceed_action_type,
1420 'exceed_dscp': exceed_dscp,
1421 'violate_action_type': violate_action_type,
1422 'violate_dscp': violate_dscp})
1424 def ip_punt_police(self,
1428 return self.api(self.papi.ip_punt_police,
1429 {'policer_index': policer_index,
1433 def ip_punt_redirect(self,
1438 return self.api(self.papi.ip_punt_redirect,
1439 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1440 'tx_sw_if_index': tx_sw_if_index,
1444 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1445 return self.api(self.papi.ip_punt_redirect_dump,
1446 {'sw_if_index': sw_if_index,
1447 'is_ipv6': is_ipv6})
1449 def bier_table_add_del(self,
1453 """ BIER Table add/del """
1455 self.papi.bier_table_add_del,
1456 {'bt_tbl_id': {"bt_set": bti.set_id,
1457 "bt_sub_domain": bti.sub_domain_id,
1458 "bt_hdr_len_id": bti.hdr_len_id},
1459 'bt_label': mpls_label,
1460 'bt_is_add': is_add})
1462 def bier_table_dump(self):
1463 return self.api(self.papi.bier_table_dump, {})
1465 def bier_route_add_del(self,
1471 """ BIER Route add/del """
1473 self.papi.bier_route_add_del,
1476 'br_tbl_id': {"bt_set": bti.set_id,
1477 "bt_sub_domain": bti.sub_domain_id,
1478 "bt_hdr_len_id": bti.hdr_len_id},
1480 'br_n_paths': len(paths),
1483 'br_is_add': is_add,
1484 'br_is_replace': is_replace
1487 def bier_route_dump(self, bti):
1489 self.papi.bier_route_dump,
1490 {'br_tbl_id': {"bt_set": bti.set_id,
1491 "bt_sub_domain": bti.sub_domain_id,
1492 "bt_hdr_len_id": bti.hdr_len_id}})
1494 def bier_imp_add(self,
1499 """ BIER Imposition Add """
1501 self.papi.bier_imp_add,
1502 {'bi_tbl_id': {"bt_set": bti.set_id,
1503 "bt_sub_domain": bti.sub_domain_id,
1504 "bt_hdr_len_id": bti.hdr_len_id},
1506 'bi_n_bytes': len(ibytes),
1507 'bi_bytes': ibytes})
1509 def bier_imp_del(self, bi_index):
1510 """ BIER Imposition del """
1512 self.papi.bier_imp_del,
1513 {'bi_index': bi_index})
1515 def bier_imp_dump(self):
1516 return self.api(self.papi.bier_imp_dump, {})
1518 def bier_disp_table_add_del(self,
1521 """ BIER Disposition Table add/del """
1523 self.papi.bier_disp_table_add_del,
1524 {'bdt_tbl_id': bdti,
1525 'bdt_is_add': is_add})
1527 def bier_disp_table_dump(self):
1528 return self.api(self.papi.bier_disp_table_dump, {})
1530 def bier_disp_entry_add_del(self,
1540 """ BIER Route add/del """
1542 while (len(lstack) < 16):
1545 self.papi.bier_disp_entry_add_del,
1546 {'bde_tbl_id': bdti,
1548 'bde_payload_proto': payload_proto,
1550 'bde_paths': [{'table_id': next_hop_tbl_id,
1551 'rpf_id': next_hop_rpf_id,
1553 'label_stack': lstack}],
1554 'bde_is_add': is_add})
1556 def bier_disp_entry_dump(self, bdti):
1558 self.papi.bier_disp_entry_dump,
1559 {'bde_tbl_id': bdti})
1561 def session_enable_disable(self, is_enabled):
1563 self.papi.session_enable_disable,
1564 {'is_enable': is_enabled})
1566 def ipsec_spd_add_del(self, spd_id, is_add=1):
1567 """ SPD add/del - Wrapper to add or del ipsec SPD
1568 Sample CLI : 'ipsec spd add 1'
1570 :param spd_id - SPD ID to be created in the vpp . mandatory
1571 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1573 :returns: reply from the API
1576 self.papi.ipsec_spd_add_del, {
1577 'spd_id': spd_id, 'is_add': is_add})
1579 def ipsec_spds_dump(self):
1580 return self.api(self.papi.ipsec_spds_dump, {})
1582 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1583 """ IPSEC interface SPD add/del - \
1584 Wrapper to associate/disassociate SPD to interface in VPP
1585 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1587 :param spd_id - SPD ID to associate with the interface . mandatory
1588 :param sw_if_index - Interface Index which needs to ipsec \
1589 association mandatory
1590 :param is_add - add(1) or del(0) association with interface \
1591 (Default 1 - add) . optional
1592 :returns: reply from the API
1595 self.papi.ipsec_interface_add_del_spd,
1596 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1598 def ipsec_spd_interface_dump(self, spd_index=None):
1599 return self.api(self.papi.ipsec_spd_interface_dump,
1600 {'spd_index': spd_index if spd_index else 0,
1601 'spd_index_valid': 1 if spd_index else 0})
1603 def ipsec_sad_entry_add_del(self,
1606 integrity_algorithm,
1611 tunnel_src_address='',
1612 tunnel_dst_address='',
1616 """ IPSEC SA add/del
1617 :param sad_id: security association ID
1618 :param spi: security param index of the SA in decimal
1619 :param integrity_algorithm:
1620 :param integrity_key:
1621 :param crypto_algorithm:
1623 :param protocol: AH(0) or ESP(1) protocol
1624 :param tunnel_src_address: tunnel mode outer src address
1625 :param tunnel_dst_address: tunnel mode outer dst address
1628 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1629 crypto and ipsec algorithms
1632 self.papi.ipsec_sad_entry_add_del,
1639 'tunnel_src': tunnel_src_address,
1640 'tunnel_dst': tunnel_dst_address,
1641 'protocol': protocol,
1642 'integrity_algorithm': integrity_algorithm,
1644 'length': len(integrity_key),
1645 'data': integrity_key,
1647 'crypto_algorithm': crypto_algorithm,
1649 'length': len(crypto_key),
1657 def ipsec_sa_dump(self, sa_id=None):
1658 return self.api(self.papi.ipsec_sa_dump,
1659 {'sa_id': sa_id if sa_id else 0xffffffff})
1661 def ipsec_spd_entry_add_del(self,
1664 local_address_start,
1666 remote_address_start,
1667 remote_address_stop,
1669 local_port_stop=65535,
1670 remote_port_start=0,
1671 remote_port_stop=65535,
1679 """ IPSEC policy SPD add/del -
1680 Wrapper to configure ipsec SPD policy entries in VPP
1681 :param spd_id: SPD ID for the policy
1682 :param local_address_start: local-ip-range start address
1683 :param local_address_stop : local-ip-range stop address
1684 :param remote_address_start: remote-ip-range start address
1685 :param remote_address_stop : remote-ip-range stop address
1686 :param local_port_start: (Default value = 0)
1687 :param local_port_stop: (Default value = 65535)
1688 :param remote_port_start: (Default value = 0)
1689 :param remote_port_stop: (Default value = 65535)
1690 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1691 :param sa_id: Security Association ID for mapping it to SPD
1692 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1694 :param priority: value for the spd action (Default value = 100)
1695 :param is_outbound: flag for inbound(0) or outbound(1)
1697 :param is_add: (Default value = 1)
1700 self.papi.ipsec_spd_entry_add_del,
1707 'local_address_start': local_address_start,
1708 'local_address_stop': local_address_stop,
1709 'remote_address_start': remote_address_start,
1710 'remote_address_stop': remote_address_stop,
1711 'local_port_start': local_port_start,
1712 'local_port_stop': local_port_stop,
1713 'remote_port_start': remote_port_start,
1714 'remote_port_stop': remote_port_stop,
1715 'protocol': protocol,
1717 'priority': priority,
1718 'is_outbound': is_outbound,
1722 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1723 return self.api(self.papi.ipsec_spd_dump,
1727 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1728 remote_spi, crypto_alg, local_crypto_key,
1729 remote_crypto_key, integ_alg, local_integ_key,
1730 remote_integ_key, is_add=1, esn=0, salt=0,
1731 anti_replay=1, renumber=0,
1732 udp_encap=0, show_instance=0):
1734 self.papi.ipsec_tunnel_if_add_del,
1736 'local_ip': local_ip,
1737 'remote_ip': remote_ip,
1738 'local_spi': local_spi,
1739 'remote_spi': remote_spi,
1740 'crypto_alg': crypto_alg,
1741 'local_crypto_key_len': len(local_crypto_key),
1742 'local_crypto_key': local_crypto_key,
1743 'remote_crypto_key_len': len(remote_crypto_key),
1744 'remote_crypto_key': remote_crypto_key,
1745 'integ_alg': integ_alg,
1746 'local_integ_key_len': len(local_integ_key),
1747 'local_integ_key': local_integ_key,
1748 'remote_integ_key_len': len(remote_integ_key),
1749 'remote_integ_key': remote_integ_key,
1752 'anti_replay': anti_replay,
1753 'renumber': renumber,
1754 'show_instance': show_instance,
1755 'udp_encap': udp_encap,
1759 def ipsec_select_backend(self, protocol, index):
1760 return self.api(self.papi.ipsec_select_backend,
1761 {'protocol': protocol, 'index': index})
1763 def ipsec_backend_dump(self):
1764 return self.api(self.papi.ipsec_backend_dump, {})
1766 def app_namespace_add_del(self,
1770 sw_if_index=0xFFFFFFFF,
1773 self.papi.app_namespace_add_del,
1775 'sw_if_index': sw_if_index,
1776 'ip4_fib_id': ip4_fib_id,
1777 'ip6_fib_id': ip6_fib_id,
1778 'namespace_id': namespace_id,
1779 'namespace_id_len': len(namespace_id)})
1781 def punt_socket_register(self, reg, pathname,
1783 """ Register punt socket """
1784 return self.api(self.papi.punt_socket_register,
1785 {'header_version': header_version,
1787 'pathname': pathname})
1789 def punt_socket_deregister(self, reg):
1790 """ Unregister punt socket """
1791 return self.api(self.papi.punt_socket_deregister,
1794 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1796 """ GBP endpoint Add """
1797 return self.api(self.papi.gbp_endpoint_add,
1799 'sw_if_index': sw_if_index,
1810 def gbp_endpoint_del(self, handle):
1811 """ GBP endpoint Del """
1812 return self.api(self.papi.gbp_endpoint_del,
1815 def gbp_endpoint_dump(self):
1816 """ GBP endpoint Dump """
1817 return self.api(self.papi.gbp_endpoint_dump,
1818 {'_no_type_conversion': True})
1820 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1821 rd, uplink_sw_if_index,
1823 """ GBP endpoint group Add """
1824 return self.api(self.papi.gbp_endpoint_group_add,
1827 'uplink_sw_if_index': uplink_sw_if_index,
1832 'retention': retention
1835 def gbp_endpoint_group_del(self, sclass):
1836 """ GBP endpoint group Del """
1837 return self.api(self.papi.gbp_endpoint_group_del,
1840 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1843 bm_flood_sw_if_index):
1844 """ GBP bridge-domain Add """
1845 return self.api(self.papi.gbp_bridge_domain_add,
1849 'bvi_sw_if_index': bvi_sw_if_index,
1850 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1851 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1856 def gbp_bridge_domain_del(self, bd_id):
1857 """ GBP bridge-domain Del """
1858 return self.api(self.papi.gbp_bridge_domain_del,
1861 def gbp_route_domain_add(self, rd_id,
1866 ip6_uu_sw_if_index):
1867 """ GBP route-domain Add """
1868 return self.api(self.papi.gbp_route_domain_add,
1872 'ip4_table_id': ip4_table_id,
1873 'ip6_table_id': ip6_table_id,
1874 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1875 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1879 def gbp_route_domain_del(self, rd_id):
1880 """ GBP route-domain Del """
1881 return self.api(self.papi.gbp_route_domain_del,
1884 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1885 """ GBP recirc Add/Del """
1886 return self.api(self.papi.gbp_recirc_add_del,
1890 'sw_if_index': sw_if_index,
1893 def gbp_recirc_dump(self):
1894 """ GBP recirc Dump """
1895 return self.api(self.papi.gbp_recirc_dump, {})
1897 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1898 """ GBP recirc Add/Del """
1899 return self.api(self.papi.gbp_ext_itf_add_del,
1902 'sw_if_index': sw_if_index,
1907 def gbp_ext_itf_dump(self):
1908 """ GBP recirc Dump """
1909 return self.api(self.papi.gbp_ext_itf_dump, {})
1911 def gbp_subnet_add_del(self, is_add, rd_id,
1913 sw_if_index=0xffffffff,
1915 """ GBP Subnet Add/Del """
1916 return self.api(self.papi.gbp_subnet_add_del,
1920 'sw_if_index': sw_if_index,
1925 def gbp_subnet_dump(self):
1926 """ GBP Subnet Dump """
1927 return self.api(self.papi.gbp_subnet_dump,
1928 {'_no_type_conversion': True})
1930 def gbp_contract_dump(self):
1931 """ GBP contract Dump """
1932 return self.api(self.papi.gbp_contract_dump, {})
1934 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1935 """ GBP VXLAN tunnel add """
1936 return self.api(self.papi.gbp_vxlan_tunnel_add,
1941 'bd_rd_id': bd_rd_id,
1946 def gbp_vxlan_tunnel_del(self, vni):
1947 """ GBP VXLAN tunnel del """
1948 return self.api(self.papi.gbp_vxlan_tunnel_del,
1953 def gbp_vxlan_tunnel_dump(self):
1954 """ GBP VXLAN tunnel add/del """
1955 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1957 def igmp_enable_disable(self, sw_if_index, enable, host):
1958 """ Enable/disable IGMP on a given interface """
1959 return self.api(self.papi.igmp_enable_disable,
1962 'sw_if_index': sw_if_index})
1964 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1965 """ Add/del IGMP proxy device """
1966 return self.api(self.papi.igmp_proxy_device_add_del,
1967 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1970 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1971 """ Add/del interface to/from IGMP proxy device """
1972 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1973 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1976 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1977 """ Listen for new (S,G) on specified interface
1979 :param enable: add/del
1980 :param sw_if_index: interface sw index
1981 :param saddr: source ip4 addr
1982 :param gaddr: group ip4 addr
1984 return self.api(self.papi.igmp_listen,
1989 'sw_if_index': sw_if_index,
1990 'n_srcs': len(saddrs),
1996 def igmp_clear_interface(self, sw_if_index):
1997 """ Remove all (S,G)s from specified interface
1998 doesn't send IGMP report!
2001 self.papi.igmp_clear_interface, {
2002 'sw_if_index': sw_if_index})
2004 def want_igmp_events(self, enable=1):
2005 return self.api(self.papi.want_igmp_events, {'enable': enable,
2006 'pid': os.getpid()})
2015 interface_id=0xFFFFFFFF):
2018 :param lb: load balance
2019 :param numa_only: tx on local numa node for lacp mode
2020 :param use_custom_mac: use custom mac
2021 :param mac_address: mac address
2022 :param interface_id: custom interface ID
2025 self.papi.bond_create,
2028 'numa_only': numa_only,
2029 'use_custom_mac': use_custom_mac,
2030 'mac_address': mac_address,
2034 def pipe_delete(self, parent_sw_if_index):
2035 return self.api(self.papi.pipe_delete,
2036 {'parent_sw_if_index': parent_sw_if_index})
2038 def svs_table_add_del(self, af, table_id, is_add=1):
2039 return self.api(self.papi.svs_table_add_del,
2041 'table_id': table_id,
2046 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2047 return self.api(self.papi.svs_route_add_del,
2049 'table_id': table_id,
2050 'source_table_id': src_table_id,
2055 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2056 return self.api(self.papi.svs_enable_disable,
2059 'table_id': table_id,
2060 'sw_if_index': sw_if_index,
2061 'is_enable': is_enable,