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 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
41 'learn': 1, 'is_add': 1, },
42 'bvi_create': {'user_instance': 4294967295, },
44 'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
45 'nbuckets': 2, 'memory_size': 2097152,
46 'next_table_index': 4294967295,
47 'miss_next_index': 4294967295, },
48 'dhcp6_client_enable_disable': {'enable': 1, },
49 'dhcp6_clients_enable_disable': {'enable': 1, },
50 'dhcp6_pd_client_enable_disable': {'enable': 1, },
51 'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
52 'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
53 'dhcp_proxy_config': {'is_add': 1, },
54 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
55 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
56 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
57 'decap_next_index': 4294967295, },
58 'gre_tunnel_add_del': {'instance': 4294967295, 'is_add': 1, },
59 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
60 'decap_next_index': 4294967295, },
61 'input_acl_set_interface': {'ip4_table_index': 4294967295,
62 'ip6_table_index': 4294967295,
63 'l2_table_index': 4294967295, },
64 'ip6_add_del_address_using_prefix': {'is_add': 1, },
65 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
66 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
67 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
68 'classify_table_index': 4294967295, 'is_add': 1, },
69 'ip_mroute_add_del': {'is_add': 1, },
70 'ip_neighbor_add_del': {'is_add': 1, },
71 'ip_punt_police': {'is_add': 1, },
72 'ip_punt_redirect': {'is_add': 1, },
73 'ip_route_add_del': {'is_add': 1, },
74 'ip_table_add_del': {'is_add': 1, },
75 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
76 'ipsec_interface_add_del_spd': {'is_add': 1, },
77 'ipsec_sad_entry_add_del': {'is_add': 1, },
78 'ipsec_spd_add_del': {'is_add': 1, },
79 'ipsec_spd_dump': {'sa_id': 4294967295, },
80 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
81 'remote_port_stop': 65535, 'priority': 100,
84 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
85 'l2_emulation': {'enable': 1, },
86 'l2fib_add_del': {'is_add': 1, },
87 'lb_conf': {'sticky_buckets_per_core': 4294967295,
88 'flow_timeout': 4294967295},
89 'lisp_add_del_adjacency': {'is_add': 1, },
90 'lisp_add_del_local_eid': {'is_add': 1, },
91 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
92 'lisp_add_del_locator_set': {'is_add': 1, },
93 'lisp_add_del_remote_mapping': {'is_add': 1, },
94 'macip_acl_add_replace': {'acl_index': 4294967295, },
95 'macip_acl_dump': {'acl_index': 4294967295, },
96 'macip_acl_interface_add_del': {'is_add': 1, },
97 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
98 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
99 'mr_next_hop_weight': 1,
100 'mr_next_hop_via_label': 1048576,
102 'mr_classify_table_index': 4294967295, },
103 'mpls_table_add_del': {'is_add': 1, },
104 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
105 'next_hop_weight': 1,
106 'next_hop_via_label': 1048576,
108 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
109 'output_acl_set_interface': {'ip4_table_index': 4294967295,
110 'ip6_table_index': 4294967295,
111 'l2_table_index': 4294967295, },
112 'pppoe_add_del_session': {'is_add': 1, },
113 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
114 'proxy_arp_add_del': {'is_add': 1, },
115 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
116 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
118 'set_ipfix_exporter': {'collector_port': 4739, },
119 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
120 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
121 'svs_enable_disable': {'is_enable': 1, },
122 'svs_route_add_del': {'is_add': 1, },
123 'svs_table_add_del': {'is_add': 1, },
124 'sw_interface_add_del_address': {'is_add': 1, },
125 'sw_interface_dump': {'sw_if_index': 4294967295, },
126 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
127 'pref_lifetime': 4294967295, },
128 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
129 'sw_interface_set_l2_bridge': {'enable': 1, },
130 'sw_interface_set_mpls_enable': {'enable': 1, },
131 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
132 'sw_interface_set_unnumbered': {'is_add': 1, },
133 'sw_interface_span_enable_disable': {'state': 1, },
134 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
135 'decap_next_index': 4294967295,
136 'instance': 4294967295, },
137 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
138 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
140 'want_bfd_events': {'enable_disable': 1, },
141 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
142 'want_dhcp6_reply_events': {'enable_disable': 1, },
143 'want_igmp_events': {'enable': 1, },
144 'want_interface_events': {'enable_disable': 1, },
145 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
146 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
147 'want_ip6_ra_events': {'enable_disable': 1, },
148 'want_l2_macs_events': {'enable_disable': 1, },
152 class CliFailedCommandError(Exception):
153 """ cli command failed."""
156 class CliSyntaxError(Exception):
157 """ cli command had a syntax error."""
160 class UnexpectedApiReturnValueError(Exception):
161 """ exception raised when the API return value is unexpected """
165 class VppPapiProvider(object):
166 """VPP-api provider using vpp-papi
168 @property hook: hook object providing before and after api/cli hooks
171 _zero, _negative = range(2)
173 def __init__(self, name, shm_prefix, test_class, read_timeout):
174 self.hook = Hook(test_class)
176 self.shm_prefix = shm_prefix
177 self.test_class = test_class
178 self._expect_api_retval = self._zero
179 self._expect_stack = []
181 # install_dir is a class attribute. We need to set it before
182 # calling the constructor.
183 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
187 if os.environ['SOCKET'] == '1':
192 self.vpp = VPPApiClient(logger=test_class.logger,
193 read_timeout=read_timeout,
194 use_socket=use_socket,
195 server_address=test_class.api_sock)
196 self._events = deque()
201 def assert_negative_api_retval(self):
202 """ Expect API failure - used with with, e.g.:
203 with self.vapi.assert_negative_api_retval():
204 self.vapi.<api call expected to fail>
206 self._expect_stack.append(self._expect_api_retval)
207 self._expect_api_retval = self._negative
210 def assert_zero_api_retval(self):
211 """ Expect API success - used with with, e.g.:
212 with self.vapi.assert_negative_api_retval():
213 self.vapi.<api call expected to succeed>
215 note: this is useful only inside another with block
216 as success is the default expected value
218 self._expect_stack.append(self._expect_api_retval)
219 self._expect_api_retval = self._zero
222 def __exit__(self, exc_type, exc_value, traceback):
223 self._expect_api_retval = self._expect_stack.pop()
225 def register_hook(self, hook):
226 """Replace hook registration with new hook
233 def collect_events(self):
234 """ Collect all events from the internal queue and clear the queue. """
236 self._events = deque()
239 def wait_for_event(self, timeout, name=None):
240 """ Wait for and return next event. """
242 self.test_class.logger.debug("Expecting event '%s' within %ss",
245 self.test_class.logger.debug("Expecting event within %ss",
248 self.test_class.logger.debug("Not waiting, event already queued")
249 limit = time.time() + timeout
250 while time.time() < limit:
252 e = self._events.popleft()
253 if name and type(e).__name__ != name:
255 "Unexpected event received: %s, expected: %s" %
256 (type(e).__name__, name))
257 self.test_class.logger.debug("Returning event %s:%s" %
260 self.test_class.sleep(0) # yield
261 raise Exception("Event did not occur within timeout")
263 def __call__(self, name, event):
264 """ Enqueue event in the internal event queue. """
265 # FIXME use the name instead of relying on type(e).__name__ ?
266 # FIXME #2 if this throws, it is eaten silently, Ole?
267 self.test_class.logger.debug("New event: %s: %s" % (name, event))
268 self._events.append(event)
270 def factory(self, name, apifn):
272 fields = apifn._func.msg.fields
274 # add positional and kw arguments
276 for i, o in enumerate(fields[3:]):
279 except BaseException:
283 if name in defaultmapping:
284 for k, v in iteritems(defaultmapping[name]):
288 return self.api(apifn, d)
292 def __getattribute__(self, name):
294 method = super(VppPapiProvider, self).__getattribute__(name)
295 except AttributeError:
296 method = self.factory(name, getattr(self.papi, name))
297 # lazily load the method so we don't need to call factory
298 # again for this name.
299 setattr(self, name, method)
303 """Connect the API to VPP"""
304 self.vpp.connect(self.name, self.shm_prefix)
305 self.papi = self.vpp.api
306 self.vpp.register_event_callback(self)
308 def disconnect(self):
309 """Disconnect the API from VPP"""
310 self.vpp.disconnect()
312 def api(self, api_fn, api_args, expected_retval=0):
313 """ Call API function and check it's return value.
314 Call the appropriate hooks before and after the API call
316 :param api_fn: API function to call
317 :param api_args: tuple of API function arguments
318 :param expected_retval: Expected return value (Default value = 0)
319 :returns: reply from the API
322 self.hook.before_api(api_fn.__name__, api_args)
323 reply = api_fn(**api_args)
324 if self._expect_api_retval == self._negative:
325 if hasattr(reply, 'retval') and reply.retval >= 0:
326 msg = "API call passed unexpectedly: expected negative " \
327 "return value instead of %d in %s" % \
328 (reply.retval, moves.reprlib.repr(reply))
329 self.test_class.logger.info(msg)
330 raise UnexpectedApiReturnValueError(msg)
331 elif self._expect_api_retval == self._zero:
332 if hasattr(reply, 'retval') and reply.retval != expected_retval:
333 msg = "API call failed, expected %d return value instead " \
334 "of %d in %s" % (expected_retval, reply.retval,
336 self.test_class.logger.info(msg)
337 raise UnexpectedApiReturnValueError(msg)
339 raise Exception("Internal error, unexpected value for "
340 "self._expect_api_retval %s" %
341 self._expect_api_retval)
342 self.hook.after_api(api_fn.__name__, api_args)
346 """ Execute a CLI, calling the before/after hooks appropriately.
348 :param cli: CLI to execute
352 self.hook.before_cli(cli)
354 r = self.papi.cli_inband(cmd=cli)
355 self.hook.after_cli(cli)
357 raise CliSyntaxError(r.reply)
359 raise CliFailedCommandError(r.reply)
360 if hasattr(r, 'reply'):
363 def ppcli(self, cli):
364 """ Helper method to print CLI command in case of info logging level.
366 :param cli: CLI to execute
369 return cli + "\n" + str(self.cli(cli))
371 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
372 return self.api(self.papi.want_ip4_arp_events,
373 {'enable_disable': enable_disable,
375 'pid': os.getpid(), })
377 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
378 return self.api(self.papi.want_ip6_nd_events,
379 {'enable_disable': enable_disable,
381 'pid': os.getpid(), })
383 def want_ip6_ra_events(self, enable_disable=1):
384 return self.api(self.papi.want_ip6_ra_events,
385 {'enable_disable': enable_disable,
386 'pid': os.getpid(), })
388 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
390 return self.api(self.papi.ip6nd_send_router_solicitation,
395 'sw_if_index': sw_if_index})
397 def want_interface_events(self, enable_disable=1):
398 return self.api(self.papi.want_interface_events,
399 {'enable_disable': enable_disable,
400 'pid': os.getpid(), })
402 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
403 max_macs_in_event=0, learn_limit=0):
404 return self.api(self.papi.want_l2_macs_events,
405 {'enable_disable': enable_disable,
406 'scan_delay': scan_delay,
407 'max_macs_in_event': max_macs_in_event,
408 'learn_limit': learn_limit,
409 'pid': os.getpid(), })
411 def want_dhcp6_reply_events(self, enable_disable=1):
412 return self.api(self.papi.want_dhcp6_reply_events,
413 {'enable_disable': enable_disable,
416 def want_dhcp6_pd_reply_events(self, enable_disable=1):
417 return self.api(self.papi.want_dhcp6_pd_reply_events,
418 {'enable_disable': enable_disable,
421 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
422 prefixes, server_index=0xFFFFFFFF,
423 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
425 return self.api(self.papi.dhcp6_pd_send_client_message,
426 {'sw_if_index': sw_if_index,
427 'server_index': server_index,
433 'msg_type': msg_type,
436 'n_prefixes': len(prefixes),
437 'prefixes': prefixes})
439 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
441 return self.api(self.papi.dhcp6_client_enable_disable,
442 {'sw_if_index': sw_if_index,
445 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
447 return self.api(self.papi.dhcp6_pd_client_enable_disable,
448 {'sw_if_index': sw_if_index,
449 'prefix_group': prefix_group,
452 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
453 prefix_length, prefix_group,
455 return self.api(self.papi.ip6_add_del_address_using_prefix,
456 {'sw_if_index': sw_if_index,
457 'prefix_group': prefix_group,
459 'prefix_length': prefix_length,
462 def sw_interface_set_mac_address(self, sw_if_index, mac):
463 return self.api(self.papi.sw_interface_set_mac_address,
464 {'sw_if_index': sw_if_index,
467 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
468 """Create p2p ethernet subinterface
470 :param sw_if_index: main (parent) interface
471 :param remote_mac: client (remote) mac address
475 self.papi.p2p_ethernet_add,
476 {'parent_if_index': sw_if_index,
477 'remote_mac': remote_mac,
478 'subif_id': subif_id})
480 def p2p_ethernet_del(self, sw_if_index, remote_mac):
481 """Delete p2p ethernet subinterface
483 :param sw_if_index: main (parent) interface
484 :param remote_mac: client (remote) mac address
488 self.papi.p2p_ethernet_del,
489 {'parent_if_index': sw_if_index,
490 'remote_mac': remote_mac})
492 def create_vlan_subif(self, sw_if_index, vlan):
499 return self.api(self.papi.create_vlan_subif,
500 {'sw_if_index': sw_if_index,
503 def create_loopback(self, mac=''):
506 :param mac: (Optional)
508 return self.api(self.papi.create_loopback,
509 {'mac_address': mac})
511 def ip_table_add_del(self,
518 :param is_add: (Default value = 1)
519 :param is_ipv6: (Default value = 0)
524 self.papi.ip_table_add_del,
527 'table_id': table_id,
532 def ip_table_dump(self):
533 return self.api(self.papi.ip_table_dump, {})
535 def ip_route_dump(self, table_id, is_ip6=False):
536 return self.api(self.papi.ip_route_dump,
538 'table_id': table_id,
542 def ip_neighbor_add_del(self,
548 """ Add neighbor MAC to IPv4 or IPv6 address.
553 :param is_add: (Default value = 1)
554 :param flags: (Default value = 0/NONE)
557 self.papi.ip_neighbor_add_del,
561 'sw_if_index': sw_if_index,
563 'mac_address': mac_address,
564 'ip_address': ip_address
569 def proxy_arp_add_del(self,
574 """ Config Proxy Arp Range.
576 :param low_address: Start address in the rnage to Proxy for
577 :param hi_address: End address in the rnage to Proxy for
578 :param vrf_id: The VRF/table in which to proxy
582 self.papi.proxy_arp_add_del,
585 'table_id': table_id,
591 def proxy_arp_intfc_enable_disable(self,
594 """ Enable/Disable an interface for proxy ARP requests
596 :param sw_if_index: Interface
597 :param enable_disable: Enable/Disable
601 self.papi.proxy_arp_intfc_enable_disable,
602 {'sw_if_index': sw_if_index,
603 'enable_disable': is_enable
607 def gre_tunnel_add_del(self,
619 :param outer_fib_id: (Default value = 0)
620 :param tunnel_type: (Default value = 0)
621 :param instance: (Default value = 0xFFFFFFFF)
622 :param session_id: (Default value = 0)
623 :param is_add: (Default value = 1)
624 :param is_ipv6: (Default value = 0)
628 self.papi.gre_tunnel_add_del,
633 'instance': instance,
636 'outer_fib_id': outer_fib_id,
637 'session_id': session_id}
641 def udp_encap_add(self,
652 :param outer_fib_id: (Default value = 0)
656 self.papi.udp_encap_add,
661 'src_port': src_port,
662 'dst_port': dst_port,
667 def udp_encap_del(self, id):
668 return self.api(self.papi.udp_encap_del, {'id': id})
670 def udp_encap_dump(self):
671 return self.api(self.papi.udp_encap_dump, {})
673 def want_udp_encap_stats(self, enable=1):
674 return self.api(self.papi.want_udp_encap_stats,
678 def mpls_route_dump(self, table_id):
679 return self.api(self.papi.mpls_route_dump,
681 'mt_table_id': table_id
684 def mpls_table_dump(self):
685 return self.api(self.papi.mpls_table_dump, {})
687 def mpls_table_add_del(
694 :param is_add: (Default value = 1)
699 self.papi.mpls_table_add_del,
702 'mt_table_id': table_id,
704 'mt_is_add': is_add})
706 def mpls_route_add_del(self,
715 """ MPLS Route add/del """
717 self.papi.mpls_route_add_del,
720 'mr_table_id': table_id,
723 'mr_eos_proto': eos_proto,
724 'mr_is_multicast': is_multicast,
725 'mr_n_paths': len(paths),
729 'mr_is_multipath': is_multipath})
731 def mpls_ip_bind_unbind(
741 self.papi.mpls_ip_bind_unbind,
742 {'mb_mpls_table_id': table_id,
744 'mb_ip_table_id': ip_table_id,
745 'mb_is_bind': is_bind,
746 'mb_prefix': prefix})
748 def mpls_tunnel_add_del(
758 self.papi.mpls_tunnel_add_del,
759 {'mt_is_add': is_add,
762 'mt_sw_if_index': tun_sw_if_index,
763 'mt_l2_only': l2_only,
764 'mt_is_multicast': is_multicast,
765 'mt_n_paths': len(paths),
769 def classify_add_del_table(
774 table_index=0xFFFFFFFF,
778 next_table_index=0xFFFFFFFF,
779 miss_next_index=0xFFFFFFFF,
781 current_data_offset=0):
785 :param match_n_vectors: (Default value = 1)
786 :param table_index: (Default value = 0xFFFFFFFF)
787 :param nbuckets: (Default value = 2)
788 :param memory_size: (Default value = 2097152)
789 :param skip_n_vectors: (Default value = 0)
790 :param next_table_index: (Default value = 0xFFFFFFFF)
791 :param miss_next_index: (Default value = 0xFFFFFFFF)
792 :param current_data_flag: (Default value = 0)
793 :param current_data_offset: (Default value = 0)
796 mask_len = ((len(mask) - 1) / 16 + 1) * 16
797 mask = mask + '\0' * (mask_len - len(mask))
799 self.papi.classify_add_del_table,
801 'table_index': table_index,
802 'nbuckets': nbuckets,
803 'memory_size': memory_size,
804 'skip_n_vectors': skip_n_vectors,
805 'match_n_vectors': match_n_vectors,
806 'next_table_index': next_table_index,
807 'miss_next_index': miss_next_index,
808 'current_data_flag': current_data_flag,
809 'current_data_offset': current_data_offset,
810 'mask_len': mask_len,
813 def classify_add_del_session(
818 opaque_index=0xFFFFFFFF,
819 hit_next_index=0xFFFFFFFF,
827 :param opaque_index: (Default value = 0xFFFFFFFF)
828 :param hit_next_index: (Default value = 0xFFFFFFFF)
829 :param advance: (Default value = 0)
830 :param action: (Default value = 0)
831 :param metadata: (Default value = 0)
834 match_len = ((len(match) - 1) / 16 + 1) * 16
835 match = match + '\0' * (match_len - len(match))
837 self.papi.classify_add_del_session,
839 'table_index': table_index,
840 'hit_next_index': hit_next_index,
841 'opaque_index': opaque_index,
844 'metadata': metadata,
845 'match_len': match_len,
848 def input_acl_set_interface(
852 ip4_table_index=0xFFFFFFFF,
853 ip6_table_index=0xFFFFFFFF,
854 l2_table_index=0xFFFFFFFF):
858 :param ip4_table_index: (Default value = 0xFFFFFFFF)
859 :param ip6_table_index: (Default value = 0xFFFFFFFF)
860 :param l2_table_index: (Default value = 0xFFFFFFFF)
864 self.papi.input_acl_set_interface,
865 {'sw_if_index': sw_if_index,
866 'ip4_table_index': ip4_table_index,
867 'ip6_table_index': ip6_table_index,
868 'l2_table_index': l2_table_index,
871 def output_acl_set_interface(
875 ip4_table_index=0xFFFFFFFF,
876 ip6_table_index=0xFFFFFFFF,
877 l2_table_index=0xFFFFFFFF):
881 :param ip4_table_index: (Default value = 0xFFFFFFFF)
882 :param ip6_table_index: (Default value = 0xFFFFFFFF)
883 :param l2_table_index: (Default value = 0xFFFFFFFF)
887 self.papi.output_acl_set_interface,
888 {'sw_if_index': sw_if_index,
889 'ip4_table_index': ip4_table_index,
890 'ip6_table_index': ip6_table_index,
891 'l2_table_index': l2_table_index,
894 def set_ipfix_exporter(
904 self.papi.set_ipfix_exporter,
906 'collector_address': collector_address,
907 'collector_port': collector_port,
908 'src_address': src_address,
910 'path_mtu': path_mtu,
911 'template_interval': template_interval,
912 'udp_checksum': udp_checksum,
915 def dhcp_proxy_config(self,
923 self.papi.dhcp_proxy_config,
925 'rx_vrf_id': rx_table_id,
926 'server_vrf_id': server_table_id,
929 'dhcp_server': dhcp_server,
930 'dhcp_src_address': dhcp_src_address,
933 def dhcp_proxy_set_vss(self,
942 self.papi.dhcp_proxy_set_vss,
945 'vss_type': vss_type,
946 'vpn_ascii_id': vpn_ascii_id,
948 'vpn_index': vpn_index,
953 def dhcp_client_config(self,
958 set_broadcast_flag=1,
962 self.papi.dhcp_client_config,
966 'sw_if_index': sw_if_index,
967 'hostname': hostname,
969 'want_dhcp_event': want_dhcp_events,
970 'set_broadcast_flag': set_broadcast_flag,
975 def ip_mroute_add_del(self,
984 IP Multicast Route add/del
987 self.papi.ip_mroute_add_del,
990 'is_multipath': is_multipath,
992 'table_id': table_id,
993 'entry_flags': e_flags,
996 'n_paths': len(paths),
1001 def mfib_signal_dump(self):
1002 return self.api(self.papi.mfib_signal_dump, {})
1004 def ip_mroute_dump(self, table_id, is_ip6=False):
1005 return self.api(self.papi.ip_mroute_dump,
1007 'table_id': table_id,
1011 def lisp_enable_disable(self, is_enabled):
1013 self.papi.lisp_enable_disable,
1015 'is_en': is_enabled,
1018 def lisp_add_del_locator_set(self,
1022 self.papi.lisp_add_del_locator_set,
1025 'locator_set_name': ls_name
1028 def lisp_add_del_locator(self,
1035 self.papi.lisp_add_del_locator,
1038 'locator_set_name': ls_name,
1039 'sw_if_index': sw_if_index,
1040 'priority': priority,
1044 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1046 self.papi.lisp_locator_dump,
1048 'is_index_set': is_index_set,
1050 'ls_index': ls_index,
1053 def lisp_add_del_local_eid(self,
1063 self.papi.lisp_add_del_local_eid,
1065 'locator_set_name': ls_name,
1067 'eid_type': eid_type,
1069 'prefix_len': prefix_len,
1075 def lisp_eid_table_dump(self,
1083 self.papi.lisp_eid_table_dump,
1086 'prefix_length': prefix_length,
1088 'eid_type': eid_type,
1090 'filter': filter_opt,
1093 def lisp_add_del_remote_mapping(self,
1103 self.papi.lisp_add_del_remote_mapping,
1106 'eid_type': eid_type,
1108 'eid_len': eid_prefix_len,
1109 'rloc_num': rlocs_num,
1112 'is_src_dst': is_src_dst,
1115 def lisp_add_del_adjacency(self,
1124 self.papi.lisp_add_del_adjacency,
1128 'eid_type': eid_type,
1131 'leid_len': leid_len,
1132 'reid_len': reid_len,
1135 def gtpu_add_del_tunnel(
1141 mcast_sw_if_index=0xFFFFFFFF,
1143 decap_next_index=0xFFFFFFFF,
1147 :param is_add: (Default value = 1)
1148 :param is_ipv6: (Default value = 0)
1151 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1152 :param encap_vrf_id: (Default value = 0)
1153 :param decap_next_index: (Default value = 0xFFFFFFFF)
1154 :param teid: (Default value = 0)
1157 return self.api(self.papi.gtpu_add_del_tunnel,
1160 'src_address': src_addr,
1161 'dst_address': dst_addr,
1162 'mcast_sw_if_index': mcast_sw_if_index,
1163 'encap_vrf_id': encap_vrf_id,
1164 'decap_next_index': decap_next_index,
1167 def vxlan_gpe_add_del_tunnel(
1171 mcast_sw_if_index=0xFFFFFFFF,
1182 :param is_add: (Default value = 1)
1183 :param is_ipv6: (Default value = 0)
1184 :param encap_vrf_id: (Default value = 0)
1185 :param decap_vrf_id: (Default value = 0)
1186 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1187 :param protocol: (Default value = 3)
1188 :param vni: (Default value = 0)
1191 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1196 'mcast_sw_if_index': mcast_sw_if_index,
1197 'encap_vrf_id': encap_vrf_id,
1198 'decap_vrf_id': decap_vrf_id,
1199 'protocol': protocol,
1202 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1203 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1204 {'sw_if_index': sw_if_index,
1205 '_no_type_conversion': True})
1207 def pppoe_add_del_session(
1217 :param is_add: (Default value = 1)
1218 :param is_ipv6: (Default value = 0)
1220 :param session_id: (Default value = 0)
1222 :param decap_vrf_id: (Default value = 0)
1225 return self.api(self.papi.pppoe_add_del_session,
1228 'session_id': session_id,
1229 'client_ip': client_ip,
1230 'decap_vrf_id': decap_vrf_id,
1231 'client_mac': client_mac})
1233 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1234 return self.api(self.papi.sr_mpls_policy_add,
1238 'n_segments': len(segments),
1239 'segments': segments})
1241 def sr_mpls_policy_del(self, bsid):
1242 return self.api(self.papi.sr_mpls_policy_del,
1245 def sr_localsid_add_del(self,
1252 sw_if_index=0xFFFFFFFF,
1256 """ Add/del IPv6 SR local-SID.
1259 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1260 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1263 :param is_del: (Default value = 0)
1264 :param end_psp: (Default value = 0)
1265 :param sw_if_index: (Default value = 0xFFFFFFFF)
1266 :param vlan_index: (Default value = 0)
1267 :param fib_table: (Default value = 0)
1270 self.papi.sr_localsid_add_del,
1272 'localsid': localsid,
1274 'behavior': behavior,
1275 'sw_if_index': sw_if_index,
1276 'vlan_index': vlan_index,
1277 'fib_table': fib_table,
1278 'nh_addr4': nh_addr4,
1279 'nh_addr6': nh_addr6
1293 :param bsid_addr: bindingSID of the SR Policy
1294 :param weight: weight of the sid list. optional. (default: 1)
1295 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1297 :param type: type/behavior of the SR policy. (default or spray) \
1299 :param fib_table: VRF where to install the FIB entry for the BSID \
1301 :param n_segments: number of segments \
1303 :param segments: a vector of IPv6 address composing the segment list \
1307 self.papi.sr_policy_add,
1308 {'bsid_addr': bsid_addr,
1310 'is_encap': is_encap,
1312 'fib_table': fib_table,
1313 'n_segments': n_segments,
1314 'segments': segments
1323 :param bsid: bindingSID of the SR Policy
1324 :param sr_policy_index: index of the sr policy (default: 0)
1327 self.papi.sr_policy_del,
1328 {'bsid_addr': bsid_addr,
1329 'sr_policy_index': sr_policy_index
1332 def sr_steering_add_del(
1343 Steer traffic L2 and L3 traffic through a given SR policy
1345 :param is_del: delete or add
1346 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1347 :param sr_policy: is the index of the SR Policy (alt to bsid)
1348 :param table_id: is the VRF where to install the FIB entry for the BSID
1349 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1350 :param mask_width: is the mask for L3 traffic type
1351 :param sw_if_index: is the incoming interface for L2 traffic
1352 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1355 self.papi.sr_steering_add_del,
1357 'bsid_addr': bsid_addr,
1358 'sr_policy_index': sr_policy_index,
1359 'table_id': table_id,
1360 'prefix_addr': prefix_addr,
1361 'mask_width': mask_width,
1362 'sw_if_index': sw_if_index,
1363 'traffic_type': traffic_type
1366 def acl_add_replace(self, acl_index, r, tag='',
1368 """Add/replace an ACL
1369 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1370 :param acl_rule r: ACL rules array.
1371 :param str tag: symbolic tag (description) for this ACL.
1372 :param int count: number of rules.
1374 return self.api(self.papi.acl_add_replace,
1375 {'acl_index': acl_index,
1379 expected_retval=expected_retval)
1381 def acl_del(self, acl_index, expected_retval=0):
1387 return self.api(self.papi.acl_del,
1388 {'acl_index': acl_index},
1389 expected_retval=expected_retval)
1391 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1393 return self.api(self.papi.acl_interface_set_acl_list,
1394 {'sw_if_index': sw_if_index,
1398 expected_retval=expected_retval)
1400 def acl_interface_set_etype_whitelist(self, sw_if_index,
1403 return self.api(self.papi.acl_interface_set_etype_whitelist,
1404 {'sw_if_index': sw_if_index,
1405 'count': len(whitelist),
1407 'whitelist': whitelist},
1408 expected_retval=expected_retval)
1410 def acl_interface_add_del(self,
1414 """ Add/Delete ACL to/from interface
1418 :param is_add: (Default value = 1)
1421 return self.api(self.papi.acl_interface_add_del,
1424 'sw_if_index': sw_if_index,
1425 'acl_index': acl_index})
1427 def acl_dump(self, acl_index, expected_retval=0):
1428 return self.api(self.papi.acl_dump,
1429 {'acl_index': acl_index},
1430 expected_retval=expected_retval)
1432 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1434 return self.api(self.papi.acl_interface_list_dump,
1435 {'sw_if_index': sw_if_index},
1436 expected_retval=expected_retval)
1438 def macip_acl_add(self, rules, tag=""):
1441 :param rules: list of rules for given acl
1445 return self.api(self.papi.macip_acl_add,
1447 'count': len(rules),
1450 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1453 :param rules: list of rules for given acl
1457 return self.api(self.papi.macip_acl_add_replace,
1458 {'acl_index': acl_index,
1460 'count': len(rules),
1463 def macip_acl_interface_add_del(self,
1467 """ Add MACIP acl to interface
1471 :param is_add: (Default value = 1)
1474 return self.api(self.papi.macip_acl_interface_add_del,
1476 'sw_if_index': sw_if_index,
1477 'acl_index': acl_index})
1479 def macip_acl_dump(self, acl_index=4294967295):
1480 """ Return MACIP acl dump
1484 self.papi.macip_acl_dump, {'acl_index': acl_index})
1486 def policer_add_del(self,
1497 conform_action_type=1,
1499 exceed_action_type=0,
1501 violate_action_type=0,
1503 return self.api(self.papi.policer_add_del,
1510 'rate_type': rate_type,
1511 'round_type': round_type,
1513 'color_aware': color_aware,
1514 'conform_action_type': conform_action_type,
1515 'conform_dscp': conform_dscp,
1516 'exceed_action_type': exceed_action_type,
1517 'exceed_dscp': exceed_dscp,
1518 'violate_action_type': violate_action_type,
1519 'violate_dscp': violate_dscp})
1521 def ip_punt_police(self,
1525 return self.api(self.papi.ip_punt_police,
1526 {'policer_index': policer_index,
1530 def ip_punt_redirect(self,
1535 return self.api(self.papi.ip_punt_redirect,
1536 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1537 'tx_sw_if_index': tx_sw_if_index,
1541 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1542 return self.api(self.papi.ip_punt_redirect_dump,
1543 {'sw_if_index': sw_if_index,
1544 'is_ipv6': is_ipv6})
1546 def bier_table_add_del(self,
1550 """ BIER Table add/del """
1552 self.papi.bier_table_add_del,
1553 {'bt_tbl_id': {"bt_set": bti.set_id,
1554 "bt_sub_domain": bti.sub_domain_id,
1555 "bt_hdr_len_id": bti.hdr_len_id},
1556 'bt_label': mpls_label,
1557 'bt_is_add': is_add})
1559 def bier_table_dump(self):
1560 return self.api(self.papi.bier_table_dump, {})
1562 def bier_route_add_del(self,
1568 """ BIER Route add/del """
1570 self.papi.bier_route_add_del,
1573 'br_tbl_id': {"bt_set": bti.set_id,
1574 "bt_sub_domain": bti.sub_domain_id,
1575 "bt_hdr_len_id": bti.hdr_len_id},
1577 'br_n_paths': len(paths),
1580 'br_is_add': is_add,
1581 'br_is_replace': is_replace
1584 def bier_route_dump(self, bti):
1586 self.papi.bier_route_dump,
1587 {'br_tbl_id': {"bt_set": bti.set_id,
1588 "bt_sub_domain": bti.sub_domain_id,
1589 "bt_hdr_len_id": bti.hdr_len_id}})
1591 def bier_imp_add(self,
1596 """ BIER Imposition Add """
1598 self.papi.bier_imp_add,
1599 {'bi_tbl_id': {"bt_set": bti.set_id,
1600 "bt_sub_domain": bti.sub_domain_id,
1601 "bt_hdr_len_id": bti.hdr_len_id},
1603 'bi_n_bytes': len(ibytes),
1604 'bi_bytes': ibytes})
1606 def bier_imp_del(self, bi_index):
1607 """ BIER Imposition del """
1609 self.papi.bier_imp_del,
1610 {'bi_index': bi_index})
1612 def bier_imp_dump(self):
1613 return self.api(self.papi.bier_imp_dump, {})
1615 def bier_disp_table_add_del(self,
1618 """ BIER Disposition Table add/del """
1620 self.papi.bier_disp_table_add_del,
1621 {'bdt_tbl_id': bdti,
1622 'bdt_is_add': is_add})
1624 def bier_disp_table_dump(self):
1625 return self.api(self.papi.bier_disp_table_dump, {})
1627 def bier_disp_entry_add_del(self,
1637 """ BIER Route add/del """
1639 while (len(lstack) < 16):
1642 self.papi.bier_disp_entry_add_del,
1643 {'bde_tbl_id': bdti,
1645 'bde_payload_proto': payload_proto,
1647 'bde_paths': [{'table_id': next_hop_tbl_id,
1648 'rpf_id': next_hop_rpf_id,
1650 'label_stack': lstack}],
1651 'bde_is_add': is_add})
1653 def bier_disp_entry_dump(self, bdti):
1655 self.papi.bier_disp_entry_dump,
1656 {'bde_tbl_id': bdti})
1658 def session_enable_disable(self, is_enabled):
1660 self.papi.session_enable_disable,
1661 {'is_enable': is_enabled})
1663 def ipsec_spd_add_del(self, spd_id, is_add=1):
1664 """ SPD add/del - Wrapper to add or del ipsec SPD
1665 Sample CLI : 'ipsec spd add 1'
1667 :param spd_id - SPD ID to be created in the vpp . mandatory
1668 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1670 :returns: reply from the API
1673 self.papi.ipsec_spd_add_del, {
1674 'spd_id': spd_id, 'is_add': is_add})
1676 def ipsec_spds_dump(self):
1677 return self.api(self.papi.ipsec_spds_dump, {})
1679 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1680 """ IPSEC interface SPD add/del - \
1681 Wrapper to associate/disassociate SPD to interface in VPP
1682 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1684 :param spd_id - SPD ID to associate with the interface . mandatory
1685 :param sw_if_index - Interface Index which needs to ipsec \
1686 association mandatory
1687 :param is_add - add(1) or del(0) association with interface \
1688 (Default 1 - add) . optional
1689 :returns: reply from the API
1692 self.papi.ipsec_interface_add_del_spd,
1693 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1695 def ipsec_spd_interface_dump(self, spd_index=None):
1696 return self.api(self.papi.ipsec_spd_interface_dump,
1697 {'spd_index': spd_index if spd_index else 0,
1698 'spd_index_valid': 1 if spd_index else 0})
1700 def ipsec_sad_entry_add_del(self,
1703 integrity_algorithm,
1708 tunnel_src_address='',
1709 tunnel_dst_address='',
1713 """ IPSEC SA add/del
1714 :param sad_id: security association ID
1715 :param spi: security param index of the SA in decimal
1716 :param integrity_algorithm:
1717 :param integrity_key:
1718 :param crypto_algorithm:
1720 :param protocol: AH(0) or ESP(1) protocol
1721 :param tunnel_src_address: tunnel mode outer src address
1722 :param tunnel_dst_address: tunnel mode outer dst address
1725 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1726 crypto and ipsec algorithms
1729 self.papi.ipsec_sad_entry_add_del,
1736 'tunnel_src': tunnel_src_address,
1737 'tunnel_dst': tunnel_dst_address,
1738 'protocol': protocol,
1739 'integrity_algorithm': integrity_algorithm,
1741 'length': len(integrity_key),
1742 'data': integrity_key,
1744 'crypto_algorithm': crypto_algorithm,
1746 'length': len(crypto_key),
1754 def ipsec_sa_dump(self, sa_id=None):
1755 return self.api(self.papi.ipsec_sa_dump,
1756 {'sa_id': sa_id if sa_id else 0xffffffff})
1758 def ipsec_spd_entry_add_del(self,
1761 local_address_start,
1763 remote_address_start,
1764 remote_address_stop,
1766 local_port_stop=65535,
1767 remote_port_start=0,
1768 remote_port_stop=65535,
1776 """ IPSEC policy SPD add/del -
1777 Wrapper to configure ipsec SPD policy entries in VPP
1778 :param spd_id: SPD ID for the policy
1779 :param local_address_start: local-ip-range start address
1780 :param local_address_stop : local-ip-range stop address
1781 :param remote_address_start: remote-ip-range start address
1782 :param remote_address_stop : remote-ip-range stop address
1783 :param local_port_start: (Default value = 0)
1784 :param local_port_stop: (Default value = 65535)
1785 :param remote_port_start: (Default value = 0)
1786 :param remote_port_stop: (Default value = 65535)
1787 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1788 :param sa_id: Security Association ID for mapping it to SPD
1789 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1791 :param priority: value for the spd action (Default value = 100)
1792 :param is_outbound: flag for inbound(0) or outbound(1)
1794 :param is_add: (Default value = 1)
1797 self.papi.ipsec_spd_entry_add_del,
1804 'local_address_start': local_address_start,
1805 'local_address_stop': local_address_stop,
1806 'remote_address_start': remote_address_start,
1807 'remote_address_stop': remote_address_stop,
1808 'local_port_start': local_port_start,
1809 'local_port_stop': local_port_stop,
1810 'remote_port_start': remote_port_start,
1811 'remote_port_stop': remote_port_stop,
1812 'protocol': protocol,
1814 'priority': priority,
1815 'is_outbound': is_outbound,
1819 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1820 return self.api(self.papi.ipsec_spd_dump,
1824 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1825 remote_spi, crypto_alg, local_crypto_key,
1826 remote_crypto_key, integ_alg, local_integ_key,
1827 remote_integ_key, is_add=1, esn=0, salt=0,
1828 anti_replay=1, renumber=0,
1829 udp_encap=0, show_instance=0):
1831 self.papi.ipsec_tunnel_if_add_del,
1833 'local_ip': local_ip,
1834 'remote_ip': remote_ip,
1835 'local_spi': local_spi,
1836 'remote_spi': remote_spi,
1837 'crypto_alg': crypto_alg,
1838 'local_crypto_key_len': len(local_crypto_key),
1839 'local_crypto_key': local_crypto_key,
1840 'remote_crypto_key_len': len(remote_crypto_key),
1841 'remote_crypto_key': remote_crypto_key,
1842 'integ_alg': integ_alg,
1843 'local_integ_key_len': len(local_integ_key),
1844 'local_integ_key': local_integ_key,
1845 'remote_integ_key_len': len(remote_integ_key),
1846 'remote_integ_key': remote_integ_key,
1849 'anti_replay': anti_replay,
1850 'renumber': renumber,
1851 'show_instance': show_instance,
1852 'udp_encap': udp_encap,
1856 def ipsec_select_backend(self, protocol, index):
1857 return self.api(self.papi.ipsec_select_backend,
1858 {'protocol': protocol, 'index': index})
1860 def ipsec_backend_dump(self):
1861 return self.api(self.papi.ipsec_backend_dump, {})
1863 def app_namespace_add_del(self,
1867 sw_if_index=0xFFFFFFFF,
1870 self.papi.app_namespace_add_del,
1872 'sw_if_index': sw_if_index,
1873 'ip4_fib_id': ip4_fib_id,
1874 'ip6_fib_id': ip6_fib_id,
1875 'namespace_id': namespace_id,
1876 'namespace_id_len': len(namespace_id)})
1878 def punt_socket_register(self, reg, pathname,
1880 """ Register punt socket """
1881 return self.api(self.papi.punt_socket_register,
1882 {'header_version': header_version,
1884 'pathname': pathname})
1886 def punt_socket_deregister(self, reg):
1887 """ Unregister punt socket """
1888 return self.api(self.papi.punt_socket_deregister,
1891 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1893 """ GBP endpoint Add """
1894 return self.api(self.papi.gbp_endpoint_add,
1896 'sw_if_index': sw_if_index,
1907 def gbp_endpoint_del(self, handle):
1908 """ GBP endpoint Del """
1909 return self.api(self.papi.gbp_endpoint_del,
1912 def gbp_endpoint_dump(self):
1913 """ GBP endpoint Dump """
1914 return self.api(self.papi.gbp_endpoint_dump,
1915 {'_no_type_conversion': True})
1917 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1918 rd, uplink_sw_if_index,
1920 """ GBP endpoint group Add """
1921 return self.api(self.papi.gbp_endpoint_group_add,
1924 'uplink_sw_if_index': uplink_sw_if_index,
1929 'retention': retention
1932 def gbp_endpoint_group_del(self, sclass):
1933 """ GBP endpoint group Del """
1934 return self.api(self.papi.gbp_endpoint_group_del,
1937 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1940 bm_flood_sw_if_index):
1941 """ GBP bridge-domain Add """
1942 return self.api(self.papi.gbp_bridge_domain_add,
1946 'bvi_sw_if_index': bvi_sw_if_index,
1947 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1948 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1953 def gbp_bridge_domain_del(self, bd_id):
1954 """ GBP bridge-domain Del """
1955 return self.api(self.papi.gbp_bridge_domain_del,
1958 def gbp_route_domain_add(self, rd_id,
1963 ip6_uu_sw_if_index):
1964 """ GBP route-domain Add """
1965 return self.api(self.papi.gbp_route_domain_add,
1969 'ip4_table_id': ip4_table_id,
1970 'ip6_table_id': ip6_table_id,
1971 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1972 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1976 def gbp_route_domain_del(self, rd_id):
1977 """ GBP route-domain Del """
1978 return self.api(self.papi.gbp_route_domain_del,
1981 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1982 """ GBP recirc Add/Del """
1983 return self.api(self.papi.gbp_recirc_add_del,
1987 'sw_if_index': sw_if_index,
1990 def gbp_recirc_dump(self):
1991 """ GBP recirc Dump """
1992 return self.api(self.papi.gbp_recirc_dump, {})
1994 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1995 """ GBP recirc Add/Del """
1996 return self.api(self.papi.gbp_ext_itf_add_del,
1999 'sw_if_index': sw_if_index,
2004 def gbp_ext_itf_dump(self):
2005 """ GBP recirc Dump """
2006 return self.api(self.papi.gbp_ext_itf_dump, {})
2008 def gbp_subnet_add_del(self, is_add, rd_id,
2010 sw_if_index=0xffffffff,
2012 """ GBP Subnet Add/Del """
2013 return self.api(self.papi.gbp_subnet_add_del,
2017 'sw_if_index': sw_if_index,
2022 def gbp_subnet_dump(self):
2023 """ GBP Subnet Dump """
2024 return self.api(self.papi.gbp_subnet_dump,
2025 {'_no_type_conversion': True})
2027 def gbp_contract_dump(self):
2028 """ GBP contract Dump """
2029 return self.api(self.papi.gbp_contract_dump, {})
2031 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2032 """ GBP VXLAN tunnel add """
2033 return self.api(self.papi.gbp_vxlan_tunnel_add,
2038 'bd_rd_id': bd_rd_id,
2043 def gbp_vxlan_tunnel_del(self, vni):
2044 """ GBP VXLAN tunnel del """
2045 return self.api(self.papi.gbp_vxlan_tunnel_del,
2050 def gbp_vxlan_tunnel_dump(self):
2051 """ GBP VXLAN tunnel add/del """
2052 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2054 def igmp_enable_disable(self, sw_if_index, enable, host):
2055 """ Enable/disable IGMP on a given interface """
2056 return self.api(self.papi.igmp_enable_disable,
2059 'sw_if_index': sw_if_index})
2061 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2062 """ Add/del IGMP proxy device """
2063 return self.api(self.papi.igmp_proxy_device_add_del,
2064 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2067 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2068 """ Add/del interface to/from IGMP proxy device """
2069 return self.api(self.papi.igmp_proxy_device_add_del_interface,
2070 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2073 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2074 """ Listen for new (S,G) on specified interface
2076 :param enable: add/del
2077 :param sw_if_index: interface sw index
2078 :param saddr: source ip4 addr
2079 :param gaddr: group ip4 addr
2081 return self.api(self.papi.igmp_listen,
2086 'sw_if_index': sw_if_index,
2087 'n_srcs': len(saddrs),
2093 def igmp_clear_interface(self, sw_if_index):
2094 """ Remove all (S,G)s from specified interface
2095 doesn't send IGMP report!
2098 self.papi.igmp_clear_interface, {
2099 'sw_if_index': sw_if_index})
2101 def want_igmp_events(self, enable=1):
2102 return self.api(self.papi.want_igmp_events, {'enable': enable,
2103 'pid': os.getpid()})
2112 interface_id=0xFFFFFFFF):
2115 :param lb: load balance
2116 :param numa_only: tx on local numa node for lacp mode
2117 :param use_custom_mac: use custom mac
2118 :param mac_address: mac address
2119 :param interface_id: custom interface ID
2122 self.papi.bond_create,
2125 'numa_only': numa_only,
2126 'use_custom_mac': use_custom_mac,
2127 'mac_address': mac_address,
2131 def pipe_delete(self, parent_sw_if_index):
2132 return self.api(self.papi.pipe_delete,
2133 {'parent_sw_if_index': parent_sw_if_index})
2135 def svs_table_add_del(self, af, table_id, is_add=1):
2136 return self.api(self.papi.svs_table_add_del,
2138 'table_id': table_id,
2143 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2144 return self.api(self.papi.svs_route_add_del,
2146 'table_id': table_id,
2147 'source_table_id': src_table_id,
2152 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2153 return self.api(self.papi.svs_enable_disable,
2156 'table_id': table_id,
2157 'sw_if_index': sw_if_index,
2158 'is_enable': is_enable,