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 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
50 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
51 'decap_next_index': 4294967295, },
52 'gre_tunnel_add_del': {'instance': 4294967295, 'is_add': 1, },
53 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
54 'decap_next_index': 4294967295, },
55 'input_acl_set_interface': {'ip4_table_index': 4294967295,
56 'ip6_table_index': 4294967295,
57 'l2_table_index': 4294967295, },
58 'ip6_add_del_address_using_prefix': {'is_add': 1, },
59 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
60 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
61 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
62 'classify_table_index': 4294967295, 'is_add': 1, },
63 'ip_mroute_add_del': {'is_add': 1, },
64 'ip_neighbor_add_del': {'is_add': 1, },
65 'ip_punt_police': {'is_add': 1, },
66 'ip_punt_redirect': {'is_add': 1, },
67 'ip_route_add_del': {'is_add': 1, },
68 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
69 'ipsec_interface_add_del_spd': {'is_add': 1, },
70 'ipsec_sad_entry_add_del': {'is_add': 1, },
71 'ipsec_spd_add_del': {'is_add': 1, },
72 'ipsec_spd_dump': {'sa_id': 4294967295, },
73 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
74 'remote_port_stop': 65535, 'priority': 100,
77 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
78 'l2_emulation': {'enable': 1, },
79 'l2fib_add_del': {'is_add': 1, },
80 'lb_conf': {'sticky_buckets_per_core': 4294967295,
81 'flow_timeout': 4294967295},
82 'lisp_add_del_adjacency': {'is_add': 1, },
83 'lisp_add_del_local_eid': {'is_add': 1, },
84 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
85 'lisp_add_del_locator_set': {'is_add': 1, },
86 'lisp_add_del_remote_mapping': {'is_add': 1, },
87 'macip_acl_add_replace': {'acl_index': 4294967295, },
88 'macip_acl_dump': {'acl_index': 4294967295, },
89 'macip_acl_interface_add_del': {'is_add': 1, },
90 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
91 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
92 'mr_next_hop_weight': 1,
93 'mr_next_hop_via_label': 1048576,
95 'mr_classify_table_index': 4294967295, },
96 'mpls_table_add_del': {'is_add': 1, },
97 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
99 'next_hop_via_label': 1048576,
101 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
102 'output_acl_set_interface': {'ip4_table_index': 4294967295,
103 'ip6_table_index': 4294967295,
104 'l2_table_index': 4294967295, },
105 'pppoe_add_del_session': {'is_add': 1, },
106 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
107 'proxy_arp_add_del': {'is_add': 1, },
108 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
109 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
111 'set_ipfix_exporter': {'collector_port': 4739, },
112 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
113 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
114 'svs_enable_disable': {'is_enable': 1, },
115 'svs_route_add_del': {'is_add': 1, },
116 'svs_table_add_del': {'is_add': 1, },
117 'sw_interface_add_del_address': {'is_add': 1, },
118 'sw_interface_dump': {'sw_if_index': 4294967295, },
119 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
120 'pref_lifetime': 4294967295, },
121 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
122 'sw_interface_set_l2_bridge': {'enable': 1, },
123 'sw_interface_set_mpls_enable': {'enable': 1, },
124 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
125 'sw_interface_set_unnumbered': {'is_add': 1, },
126 'sw_interface_span_enable_disable': {'state': 1, },
127 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
128 'decap_next_index': 4294967295,
129 'instance': 4294967295, },
130 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
131 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
133 'want_bfd_events': {'enable_disable': 1, },
134 'want_igmp_events': {'enable': 1, },
135 'want_interface_events': {'enable_disable': 1, },
136 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
137 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
138 'want_ip6_ra_events': {'enable_disable': 1, },
139 'want_l2_macs_events': {'enable_disable': 1, },
143 class CliFailedCommandError(Exception):
144 """ cli command failed."""
147 class CliSyntaxError(Exception):
148 """ cli command had a syntax error."""
151 class UnexpectedApiReturnValueError(Exception):
152 """ exception raised when the API return value is unexpected """
156 class VppPapiProvider(object):
157 """VPP-api provider using vpp-papi
159 @property hook: hook object providing before and after api/cli hooks
162 _zero, _negative = range(2)
164 def __init__(self, name, shm_prefix, test_class, read_timeout):
165 self.hook = Hook(test_class)
167 self.shm_prefix = shm_prefix
168 self.test_class = test_class
169 self._expect_api_retval = self._zero
170 self._expect_stack = []
172 # install_dir is a class attribute. We need to set it before
173 # calling the constructor.
174 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
178 if os.environ['SOCKET'] == '1':
183 self.vpp = VPPApiClient(logger=test_class.logger,
184 read_timeout=read_timeout,
185 use_socket=use_socket,
186 server_address=test_class.api_sock)
187 self._events = deque()
192 def assert_negative_api_retval(self):
193 """ Expect API failure - used with with, e.g.:
194 with self.vapi.assert_negative_api_retval():
195 self.vapi.<api call expected to fail>
197 self._expect_stack.append(self._expect_api_retval)
198 self._expect_api_retval = self._negative
201 def assert_zero_api_retval(self):
202 """ Expect API success - used with with, e.g.:
203 with self.vapi.assert_negative_api_retval():
204 self.vapi.<api call expected to succeed>
206 note: this is useful only inside another with block
207 as success is the default expected value
209 self._expect_stack.append(self._expect_api_retval)
210 self._expect_api_retval = self._zero
213 def __exit__(self, exc_type, exc_value, traceback):
214 self._expect_api_retval = self._expect_stack.pop()
216 def register_hook(self, hook):
217 """Replace hook registration with new hook
224 def collect_events(self):
225 """ Collect all events from the internal queue and clear the queue. """
227 self._events = deque()
230 def wait_for_event(self, timeout, name=None):
231 """ Wait for and return next event. """
233 self.test_class.logger.debug("Expecting event '%s' within %ss",
236 self.test_class.logger.debug("Expecting event within %ss",
239 self.test_class.logger.debug("Not waiting, event already queued")
240 limit = time.time() + timeout
241 while time.time() < limit:
243 e = self._events.popleft()
244 if name and type(e).__name__ != name:
246 "Unexpected event received: %s, expected: %s" %
247 (type(e).__name__, name))
248 self.test_class.logger.debug("Returning event %s:%s" %
251 self.test_class.sleep(0) # yield
252 raise Exception("Event did not occur within timeout")
254 def __call__(self, name, event):
255 """ Enqueue event in the internal event queue. """
256 # FIXME use the name instead of relying on type(e).__name__ ?
257 # FIXME #2 if this throws, it is eaten silently, Ole?
258 self.test_class.logger.debug("New event: %s: %s" % (name, event))
259 self._events.append(event)
261 def factory(self, name, apifn):
263 fields = apifn._func.msg.fields
265 # add positional and kw arguments
267 for i, o in enumerate(fields[3:]):
270 except BaseException:
274 if name in defaultmapping:
275 for k, v in iteritems(defaultmapping[name]):
279 return self.api(apifn, d)
283 def __getattribute__(self, name):
285 method = super(VppPapiProvider, self).__getattribute__(name)
286 except AttributeError:
287 method = self.factory(name, getattr(self.papi, name))
288 # lazily load the method so we don't need to call factory
289 # again for this name.
290 setattr(self, name, method)
294 """Connect the API to VPP"""
295 self.vpp.connect(self.name, self.shm_prefix)
296 self.papi = self.vpp.api
297 self.vpp.register_event_callback(self)
299 def disconnect(self):
300 """Disconnect the API from VPP"""
301 self.vpp.disconnect()
303 def api(self, api_fn, api_args, expected_retval=0):
304 """ Call API function and check it's return value.
305 Call the appropriate hooks before and after the API call
307 :param api_fn: API function to call
308 :param api_args: tuple of API function arguments
309 :param expected_retval: Expected return value (Default value = 0)
310 :returns: reply from the API
313 self.hook.before_api(api_fn.__name__, api_args)
314 reply = api_fn(**api_args)
315 if self._expect_api_retval == self._negative:
316 if hasattr(reply, 'retval') and reply.retval >= 0:
317 msg = "API call passed unexpectedly: expected negative " \
318 "return value instead of %d in %s" % \
319 (reply.retval, moves.reprlib.repr(reply))
320 self.test_class.logger.info(msg)
321 raise UnexpectedApiReturnValueError(msg)
322 elif self._expect_api_retval == self._zero:
323 if hasattr(reply, 'retval') and reply.retval != expected_retval:
324 msg = "API call failed, expected %d return value instead " \
325 "of %d in %s" % (expected_retval, reply.retval,
327 self.test_class.logger.info(msg)
328 raise UnexpectedApiReturnValueError(msg)
330 raise Exception("Internal error, unexpected value for "
331 "self._expect_api_retval %s" %
332 self._expect_api_retval)
333 self.hook.after_api(api_fn.__name__, api_args)
336 def cli_return_response(self, cli):
337 """ Execute a CLI, calling the before/after hooks appropriately.
338 Return the reply without examining it
340 :param cli: CLI to execute
341 :returns: response object
344 self.hook.before_cli(cli)
346 r = self.papi.cli_inband(cmd=cli)
347 self.hook.after_cli(cli)
351 """ Execute a CLI, calling the before/after hooks appropriately.
353 :param cli: CLI to execute
357 r = self.cli_return_response(cli)
359 raise CliSyntaxError(r.reply)
361 raise CliFailedCommandError(r.reply)
362 if hasattr(r, 'reply'):
365 def ppcli(self, cli):
366 """ Helper method to print CLI command in case of info logging level.
368 :param cli: CLI to execute
371 return cli + "\n" + self.cli(cli)
373 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
374 return self.api(self.papi.want_ip4_arp_events,
375 {'enable_disable': enable_disable,
377 'pid': os.getpid(), })
379 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
380 return self.api(self.papi.want_ip6_nd_events,
381 {'enable_disable': enable_disable,
383 'pid': os.getpid(), })
385 def want_ip6_ra_events(self, enable_disable=1):
386 return self.api(self.papi.want_ip6_ra_events,
387 {'enable_disable': enable_disable,
388 'pid': os.getpid(), })
390 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
392 return self.api(self.papi.ip6nd_send_router_solicitation,
397 'sw_if_index': sw_if_index})
399 def want_interface_events(self, enable_disable=1):
400 return self.api(self.papi.want_interface_events,
401 {'enable_disable': enable_disable,
402 'pid': os.getpid(), })
404 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
405 max_macs_in_event=0, learn_limit=0):
406 return self.api(self.papi.want_l2_macs_events,
407 {'enable_disable': enable_disable,
408 'scan_delay': scan_delay,
409 'max_macs_in_event': max_macs_in_event,
410 'learn_limit': learn_limit,
411 'pid': os.getpid(), })
413 def sw_interface_set_mac_address(self, sw_if_index, mac):
414 return self.api(self.papi.sw_interface_set_mac_address,
415 {'sw_if_index': sw_if_index,
418 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
419 """Create p2p ethernet subinterface
421 :param sw_if_index: main (parent) interface
422 :param remote_mac: client (remote) mac address
426 self.papi.p2p_ethernet_add,
427 {'parent_if_index': sw_if_index,
428 'remote_mac': remote_mac,
429 'subif_id': subif_id})
431 def p2p_ethernet_del(self, sw_if_index, remote_mac):
432 """Delete p2p ethernet subinterface
434 :param sw_if_index: main (parent) interface
435 :param remote_mac: client (remote) mac address
439 self.papi.p2p_ethernet_del,
440 {'parent_if_index': sw_if_index,
441 'remote_mac': remote_mac})
443 def create_vlan_subif(self, sw_if_index, vlan):
450 return self.api(self.papi.create_vlan_subif,
451 {'sw_if_index': sw_if_index,
454 def create_loopback(self, mac=''):
457 :param mac: (Optional)
459 return self.api(self.papi.create_loopback,
460 {'mac_address': mac})
462 def ip_route_dump(self, table_id, is_ip6=False):
463 return self.api(self.papi.ip_route_dump,
465 'table_id': table_id,
469 def ip_neighbor_add_del(self,
475 """ Add neighbor MAC to IPv4 or IPv6 address.
480 :param is_add: (Default value = 1)
481 :param flags: (Default value = 0/NONE)
484 self.papi.ip_neighbor_add_del,
488 'sw_if_index': sw_if_index,
490 'mac_address': mac_address,
491 'ip_address': ip_address
496 def proxy_arp_add_del(self,
501 """ Config Proxy Arp Range.
503 :param low_address: Start address in the rnage to Proxy for
504 :param hi_address: End address in the rnage to Proxy for
505 :param vrf_id: The VRF/table in which to proxy
509 self.papi.proxy_arp_add_del,
512 'table_id': table_id,
518 def proxy_arp_intfc_enable_disable(self,
521 """ Enable/Disable an interface for proxy ARP requests
523 :param sw_if_index: Interface
524 :param enable_disable: Enable/Disable
528 self.papi.proxy_arp_intfc_enable_disable,
529 {'sw_if_index': sw_if_index,
530 'enable_disable': is_enable
534 def gre_tunnel_add_del(self,
546 :param outer_fib_id: (Default value = 0)
547 :param tunnel_type: (Default value = 0)
548 :param instance: (Default value = 0xFFFFFFFF)
549 :param session_id: (Default value = 0)
550 :param is_add: (Default value = 1)
551 :param is_ipv6: (Default value = 0)
555 self.papi.gre_tunnel_add_del,
560 'instance': instance,
563 'outer_fib_id': outer_fib_id,
564 'session_id': session_id}
568 def udp_encap_add(self,
579 :param outer_fib_id: (Default value = 0)
583 self.papi.udp_encap_add,
588 'src_port': src_port,
589 'dst_port': dst_port,
594 def udp_encap_del(self, id):
595 return self.api(self.papi.udp_encap_del, {'id': id})
597 def udp_encap_dump(self):
598 return self.api(self.papi.udp_encap_dump, {})
600 def want_udp_encap_stats(self, enable=1):
601 return self.api(self.papi.want_udp_encap_stats,
605 def mpls_route_dump(self, table_id):
606 return self.api(self.papi.mpls_route_dump,
608 'mt_table_id': table_id
611 def mpls_table_dump(self):
612 return self.api(self.papi.mpls_table_dump, {})
614 def mpls_table_add_del(
621 :param is_add: (Default value = 1)
626 self.papi.mpls_table_add_del,
629 'mt_table_id': table_id,
631 'mt_is_add': is_add})
633 def mpls_route_add_del(self,
642 """ MPLS Route add/del """
644 self.papi.mpls_route_add_del,
647 'mr_table_id': table_id,
650 'mr_eos_proto': eos_proto,
651 'mr_is_multicast': is_multicast,
652 'mr_n_paths': len(paths),
656 'mr_is_multipath': is_multipath})
658 def mpls_ip_bind_unbind(
668 self.papi.mpls_ip_bind_unbind,
669 {'mb_mpls_table_id': table_id,
671 'mb_ip_table_id': ip_table_id,
672 'mb_is_bind': is_bind,
673 'mb_prefix': prefix})
675 def mpls_tunnel_add_del(
685 self.papi.mpls_tunnel_add_del,
686 {'mt_is_add': is_add,
689 'mt_sw_if_index': tun_sw_if_index,
690 'mt_l2_only': l2_only,
691 'mt_is_multicast': is_multicast,
692 'mt_n_paths': len(paths),
696 def classify_add_del_table(
701 table_index=0xFFFFFFFF,
705 next_table_index=0xFFFFFFFF,
706 miss_next_index=0xFFFFFFFF,
708 current_data_offset=0):
712 :param match_n_vectors: (Default value = 1)
713 :param table_index: (Default value = 0xFFFFFFFF)
714 :param nbuckets: (Default value = 2)
715 :param memory_size: (Default value = 2097152)
716 :param skip_n_vectors: (Default value = 0)
717 :param next_table_index: (Default value = 0xFFFFFFFF)
718 :param miss_next_index: (Default value = 0xFFFFFFFF)
719 :param current_data_flag: (Default value = 0)
720 :param current_data_offset: (Default value = 0)
722 mask_len = ((len(mask) - 1) // 16 + 1) * 16
723 mask = mask + b'\0' * (mask_len - len(mask))
725 self.papi.classify_add_del_table,
727 'table_index': table_index,
728 'nbuckets': nbuckets,
729 'memory_size': memory_size,
730 'skip_n_vectors': skip_n_vectors,
731 'match_n_vectors': match_n_vectors,
732 'next_table_index': next_table_index,
733 'miss_next_index': miss_next_index,
734 'current_data_flag': current_data_flag,
735 'current_data_offset': current_data_offset,
736 'mask_len': mask_len,
739 def classify_add_del_session(
744 opaque_index=0xFFFFFFFF,
745 hit_next_index=0xFFFFFFFF,
753 :param opaque_index: (Default value = 0xFFFFFFFF)
754 :param hit_next_index: (Default value = 0xFFFFFFFF)
755 :param advance: (Default value = 0)
756 :param action: (Default value = 0)
757 :param metadata: (Default value = 0)
760 match_len = ((len(match) - 1) // 16 + 1) * 16
761 match = match + b'\0' * (match_len - len(match))
763 self.papi.classify_add_del_session,
765 'table_index': table_index,
766 'hit_next_index': hit_next_index,
767 'opaque_index': opaque_index,
770 'metadata': metadata,
771 'match_len': match_len,
774 def input_acl_set_interface(
778 ip4_table_index=0xFFFFFFFF,
779 ip6_table_index=0xFFFFFFFF,
780 l2_table_index=0xFFFFFFFF):
784 :param ip4_table_index: (Default value = 0xFFFFFFFF)
785 :param ip6_table_index: (Default value = 0xFFFFFFFF)
786 :param l2_table_index: (Default value = 0xFFFFFFFF)
790 self.papi.input_acl_set_interface,
791 {'sw_if_index': sw_if_index,
792 'ip4_table_index': ip4_table_index,
793 'ip6_table_index': ip6_table_index,
794 'l2_table_index': l2_table_index,
797 def output_acl_set_interface(
801 ip4_table_index=0xFFFFFFFF,
802 ip6_table_index=0xFFFFFFFF,
803 l2_table_index=0xFFFFFFFF):
807 :param ip4_table_index: (Default value = 0xFFFFFFFF)
808 :param ip6_table_index: (Default value = 0xFFFFFFFF)
809 :param l2_table_index: (Default value = 0xFFFFFFFF)
813 self.papi.output_acl_set_interface,
814 {'sw_if_index': sw_if_index,
815 'ip4_table_index': ip4_table_index,
816 'ip6_table_index': ip6_table_index,
817 'l2_table_index': l2_table_index,
820 def set_ipfix_exporter(
830 self.papi.set_ipfix_exporter,
832 'collector_address': collector_address,
833 'collector_port': collector_port,
834 'src_address': src_address,
836 'path_mtu': path_mtu,
837 'template_interval': template_interval,
838 'udp_checksum': udp_checksum,
841 def ip_mroute_add_del(self,
850 IP Multicast Route add/del
853 self.papi.ip_mroute_add_del,
856 'is_multipath': is_multipath,
858 'table_id': table_id,
859 'entry_flags': e_flags,
862 'n_paths': len(paths),
867 def mfib_signal_dump(self):
868 return self.api(self.papi.mfib_signal_dump, {})
870 def ip_mroute_dump(self, table_id, is_ip6=False):
871 return self.api(self.papi.ip_mroute_dump,
873 'table_id': table_id,
877 def lisp_enable_disable(self, is_enabled):
879 self.papi.lisp_enable_disable,
884 def lisp_add_del_locator_set(self,
888 self.papi.lisp_add_del_locator_set,
891 'locator_set_name': ls_name
894 def lisp_add_del_locator(self,
901 self.papi.lisp_add_del_locator,
904 'locator_set_name': ls_name,
905 'sw_if_index': sw_if_index,
906 'priority': priority,
910 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
912 self.papi.lisp_locator_dump,
914 'is_index_set': is_index_set,
916 'ls_index': ls_index,
919 def lisp_add_del_local_eid(self,
929 self.papi.lisp_add_del_local_eid,
931 'locator_set_name': ls_name,
933 'eid_type': eid_type,
935 'prefix_len': prefix_len,
941 def lisp_eid_table_dump(self,
949 self.papi.lisp_eid_table_dump,
952 'prefix_length': prefix_length,
954 'eid_type': eid_type,
956 'filter': filter_opt,
959 def lisp_add_del_remote_mapping(self,
969 self.papi.lisp_add_del_remote_mapping,
972 'eid_type': eid_type,
974 'eid_len': eid_prefix_len,
975 'rloc_num': rlocs_num,
978 'is_src_dst': is_src_dst,
981 def lisp_add_del_adjacency(self,
990 self.papi.lisp_add_del_adjacency,
994 'eid_type': eid_type,
997 'leid_len': leid_len,
998 'reid_len': reid_len,
1001 def gtpu_add_del_tunnel(
1007 mcast_sw_if_index=0xFFFFFFFF,
1009 decap_next_index=0xFFFFFFFF,
1013 :param is_add: (Default value = 1)
1014 :param is_ipv6: (Default value = 0)
1017 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1018 :param encap_vrf_id: (Default value = 0)
1019 :param decap_next_index: (Default value = 0xFFFFFFFF)
1020 :param teid: (Default value = 0)
1023 return self.api(self.papi.gtpu_add_del_tunnel,
1026 'src_address': src_addr,
1027 'dst_address': dst_addr,
1028 'mcast_sw_if_index': mcast_sw_if_index,
1029 'encap_vrf_id': encap_vrf_id,
1030 'decap_next_index': decap_next_index,
1033 def vxlan_gpe_add_del_tunnel(
1037 mcast_sw_if_index=0xFFFFFFFF,
1048 :param is_add: (Default value = 1)
1049 :param is_ipv6: (Default value = 0)
1050 :param encap_vrf_id: (Default value = 0)
1051 :param decap_vrf_id: (Default value = 0)
1052 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1053 :param protocol: (Default value = 3)
1054 :param vni: (Default value = 0)
1057 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1062 'mcast_sw_if_index': mcast_sw_if_index,
1063 'encap_vrf_id': encap_vrf_id,
1064 'decap_vrf_id': decap_vrf_id,
1065 'protocol': protocol,
1068 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1069 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1070 {'sw_if_index': sw_if_index})
1072 def pppoe_add_del_session(
1082 :param is_add: (Default value = 1)
1083 :param is_ipv6: (Default value = 0)
1085 :param session_id: (Default value = 0)
1087 :param decap_vrf_id: (Default value = 0)
1090 return self.api(self.papi.pppoe_add_del_session,
1093 'session_id': session_id,
1094 'client_ip': client_ip,
1095 'decap_vrf_id': decap_vrf_id,
1096 'client_mac': client_mac})
1098 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1099 return self.api(self.papi.sr_mpls_policy_add,
1103 'n_segments': len(segments),
1104 'segments': segments})
1106 def sr_mpls_policy_del(self, bsid):
1107 return self.api(self.papi.sr_mpls_policy_del,
1110 def sr_localsid_add_del(self,
1117 sw_if_index=0xFFFFFFFF,
1121 """ Add/del IPv6 SR local-SID.
1124 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1125 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1128 :param is_del: (Default value = 0)
1129 :param end_psp: (Default value = 0)
1130 :param sw_if_index: (Default value = 0xFFFFFFFF)
1131 :param vlan_index: (Default value = 0)
1132 :param fib_table: (Default value = 0)
1135 self.papi.sr_localsid_add_del,
1137 'localsid': localsid,
1139 'behavior': behavior,
1140 'sw_if_index': sw_if_index,
1141 'vlan_index': vlan_index,
1142 'fib_table': fib_table,
1143 'nh_addr4': nh_addr4,
1144 'nh_addr6': nh_addr6
1158 :param bsid_addr: bindingSID of the SR Policy
1159 :param weight: weight of the sid list. optional. (default: 1)
1160 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1162 :param type: type/behavior of the SR policy. (default or spray) \
1164 :param fib_table: VRF where to install the FIB entry for the BSID \
1166 :param n_segments: number of segments \
1168 :param segments: a vector of IPv6 address composing the segment list \
1172 self.papi.sr_policy_add,
1173 {'bsid_addr': bsid_addr,
1175 'is_encap': is_encap,
1177 'fib_table': fib_table,
1178 'n_segments': n_segments,
1179 'segments': segments
1188 :param bsid: bindingSID of the SR Policy
1189 :param sr_policy_index: index of the sr policy (default: 0)
1192 self.papi.sr_policy_del,
1193 {'bsid_addr': bsid_addr,
1194 'sr_policy_index': sr_policy_index
1197 def sr_steering_add_del(
1208 Steer traffic L2 and L3 traffic through a given SR policy
1210 :param is_del: delete or add
1211 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1212 :param sr_policy: is the index of the SR Policy (alt to bsid)
1213 :param table_id: is the VRF where to install the FIB entry for the BSID
1214 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1215 :param mask_width: is the mask for L3 traffic type
1216 :param sw_if_index: is the incoming interface for L2 traffic
1217 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1220 self.papi.sr_steering_add_del,
1222 'bsid_addr': bsid_addr,
1223 'sr_policy_index': sr_policy_index,
1224 'table_id': table_id,
1225 'prefix_addr': prefix_addr,
1226 'mask_width': mask_width,
1227 'sw_if_index': sw_if_index,
1228 'traffic_type': traffic_type
1231 def acl_add_replace(self, acl_index, r, tag='',
1233 """Add/replace an ACL
1234 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1235 :param acl_rule r: ACL rules array.
1236 :param str tag: symbolic tag (description) for this ACL.
1237 :param int count: number of rules.
1239 return self.api(self.papi.acl_add_replace,
1240 {'acl_index': acl_index,
1244 expected_retval=expected_retval)
1246 def acl_del(self, acl_index, expected_retval=0):
1252 return self.api(self.papi.acl_del,
1253 {'acl_index': acl_index},
1254 expected_retval=expected_retval)
1256 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1258 return self.api(self.papi.acl_interface_set_acl_list,
1259 {'sw_if_index': sw_if_index,
1263 expected_retval=expected_retval)
1265 def acl_interface_set_etype_whitelist(self, sw_if_index,
1268 return self.api(self.papi.acl_interface_set_etype_whitelist,
1269 {'sw_if_index': sw_if_index,
1270 'count': len(whitelist),
1272 'whitelist': whitelist},
1273 expected_retval=expected_retval)
1275 def acl_interface_add_del(self,
1279 """ Add/Delete ACL to/from interface
1283 :param is_add: (Default value = 1)
1286 return self.api(self.papi.acl_interface_add_del,
1289 'sw_if_index': sw_if_index,
1290 'acl_index': acl_index})
1292 def acl_dump(self, acl_index, expected_retval=0):
1293 return self.api(self.papi.acl_dump,
1294 {'acl_index': acl_index},
1295 expected_retval=expected_retval)
1297 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1299 return self.api(self.papi.acl_interface_list_dump,
1300 {'sw_if_index': sw_if_index},
1301 expected_retval=expected_retval)
1303 def macip_acl_add(self, rules, tag=""):
1306 :param rules: list of rules for given acl
1310 return self.api(self.papi.macip_acl_add,
1312 'count': len(rules),
1315 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1318 :param rules: list of rules for given acl
1322 return self.api(self.papi.macip_acl_add_replace,
1323 {'acl_index': acl_index,
1325 'count': len(rules),
1328 def macip_acl_interface_add_del(self,
1332 """ Add MACIP acl to interface
1336 :param is_add: (Default value = 1)
1339 return self.api(self.papi.macip_acl_interface_add_del,
1341 'sw_if_index': sw_if_index,
1342 'acl_index': acl_index})
1344 def macip_acl_dump(self, acl_index=4294967295):
1345 """ Return MACIP acl dump
1349 self.papi.macip_acl_dump, {'acl_index': acl_index})
1351 def policer_add_del(self,
1362 conform_action_type=1,
1364 exceed_action_type=0,
1366 violate_action_type=0,
1368 return self.api(self.papi.policer_add_del,
1375 'rate_type': rate_type,
1376 'round_type': round_type,
1378 'color_aware': color_aware,
1379 'conform_action_type': conform_action_type,
1380 'conform_dscp': conform_dscp,
1381 'exceed_action_type': exceed_action_type,
1382 'exceed_dscp': exceed_dscp,
1383 'violate_action_type': violate_action_type,
1384 'violate_dscp': violate_dscp})
1386 def ip_punt_police(self,
1390 return self.api(self.papi.ip_punt_police,
1391 {'policer_index': policer_index,
1395 def ip_punt_redirect(self,
1400 return self.api(self.papi.ip_punt_redirect,
1401 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1402 'tx_sw_if_index': tx_sw_if_index,
1406 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1407 return self.api(self.papi.ip_punt_redirect_dump,
1408 {'sw_if_index': sw_if_index,
1409 'is_ipv6': is_ipv6})
1411 def bier_table_add_del(self,
1415 """ BIER Table add/del """
1417 self.papi.bier_table_add_del,
1418 {'bt_tbl_id': {"bt_set": bti.set_id,
1419 "bt_sub_domain": bti.sub_domain_id,
1420 "bt_hdr_len_id": bti.hdr_len_id},
1421 'bt_label': mpls_label,
1422 'bt_is_add': is_add})
1424 def bier_table_dump(self):
1425 return self.api(self.papi.bier_table_dump, {})
1427 def bier_route_add_del(self,
1433 """ BIER Route add/del """
1435 self.papi.bier_route_add_del,
1438 'br_tbl_id': {"bt_set": bti.set_id,
1439 "bt_sub_domain": bti.sub_domain_id,
1440 "bt_hdr_len_id": bti.hdr_len_id},
1442 'br_n_paths': len(paths),
1445 'br_is_add': is_add,
1446 'br_is_replace': is_replace
1449 def bier_route_dump(self, bti):
1451 self.papi.bier_route_dump,
1452 {'br_tbl_id': {"bt_set": bti.set_id,
1453 "bt_sub_domain": bti.sub_domain_id,
1454 "bt_hdr_len_id": bti.hdr_len_id}})
1456 def bier_imp_add(self,
1461 """ BIER Imposition Add """
1463 self.papi.bier_imp_add,
1464 {'bi_tbl_id': {"bt_set": bti.set_id,
1465 "bt_sub_domain": bti.sub_domain_id,
1466 "bt_hdr_len_id": bti.hdr_len_id},
1468 'bi_n_bytes': len(ibytes),
1469 'bi_bytes': ibytes})
1471 def bier_imp_del(self, bi_index):
1472 """ BIER Imposition del """
1474 self.papi.bier_imp_del,
1475 {'bi_index': bi_index})
1477 def bier_imp_dump(self):
1478 return self.api(self.papi.bier_imp_dump, {})
1480 def bier_disp_table_add_del(self,
1483 """ BIER Disposition Table add/del """
1485 self.papi.bier_disp_table_add_del,
1486 {'bdt_tbl_id': bdti,
1487 'bdt_is_add': is_add})
1489 def bier_disp_table_dump(self):
1490 return self.api(self.papi.bier_disp_table_dump, {})
1492 def bier_disp_entry_add_del(self,
1502 """ BIER Route add/del """
1504 while (len(lstack) < 16):
1507 self.papi.bier_disp_entry_add_del,
1508 {'bde_tbl_id': bdti,
1510 'bde_payload_proto': payload_proto,
1512 'bde_paths': [{'table_id': next_hop_tbl_id,
1513 'rpf_id': next_hop_rpf_id,
1515 'label_stack': lstack}],
1516 'bde_is_add': is_add})
1518 def bier_disp_entry_dump(self, bdti):
1520 self.papi.bier_disp_entry_dump,
1521 {'bde_tbl_id': bdti})
1523 def session_enable_disable(self, is_enabled):
1525 self.papi.session_enable_disable,
1526 {'is_enable': is_enabled})
1528 def ipsec_spd_add_del(self, spd_id, is_add=1):
1529 """ SPD add/del - Wrapper to add or del ipsec SPD
1530 Sample CLI : 'ipsec spd add 1'
1532 :param spd_id - SPD ID to be created in the vpp . mandatory
1533 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1535 :returns: reply from the API
1538 self.papi.ipsec_spd_add_del, {
1539 'spd_id': spd_id, 'is_add': is_add})
1541 def ipsec_spds_dump(self):
1542 return self.api(self.papi.ipsec_spds_dump, {})
1544 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1545 """ IPSEC interface SPD add/del - \
1546 Wrapper to associate/disassociate SPD to interface in VPP
1547 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1549 :param spd_id - SPD ID to associate with the interface . mandatory
1550 :param sw_if_index - Interface Index which needs to ipsec \
1551 association mandatory
1552 :param is_add - add(1) or del(0) association with interface \
1553 (Default 1 - add) . optional
1554 :returns: reply from the API
1557 self.papi.ipsec_interface_add_del_spd,
1558 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1560 def ipsec_spd_interface_dump(self, spd_index=None):
1561 return self.api(self.papi.ipsec_spd_interface_dump,
1562 {'spd_index': spd_index if spd_index else 0,
1563 'spd_index_valid': 1 if spd_index else 0})
1565 def ipsec_sad_entry_add_del(self,
1568 integrity_algorithm,
1573 tunnel_src_address='',
1574 tunnel_dst_address='',
1578 """ IPSEC SA add/del
1579 :param sad_id: security association ID
1580 :param spi: security param index of the SA in decimal
1581 :param integrity_algorithm:
1582 :param integrity_key:
1583 :param crypto_algorithm:
1585 :param protocol: AH(0) or ESP(1) protocol
1586 :param tunnel_src_address: tunnel mode outer src address
1587 :param tunnel_dst_address: tunnel mode outer dst address
1590 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1591 crypto and ipsec algorithms
1594 self.papi.ipsec_sad_entry_add_del,
1601 'tunnel_src': tunnel_src_address,
1602 'tunnel_dst': tunnel_dst_address,
1603 'protocol': protocol,
1604 'integrity_algorithm': integrity_algorithm,
1606 'length': len(integrity_key),
1607 'data': integrity_key,
1609 'crypto_algorithm': crypto_algorithm,
1611 'length': len(crypto_key),
1619 def ipsec_sa_dump(self, sa_id=None):
1620 return self.api(self.papi.ipsec_sa_dump,
1621 {'sa_id': sa_id if sa_id else 0xffffffff})
1623 def ipsec_spd_entry_add_del(self,
1626 local_address_start,
1628 remote_address_start,
1629 remote_address_stop,
1631 local_port_stop=65535,
1632 remote_port_start=0,
1633 remote_port_stop=65535,
1641 """ IPSEC policy SPD add/del -
1642 Wrapper to configure ipsec SPD policy entries in VPP
1643 :param spd_id: SPD ID for the policy
1644 :param local_address_start: local-ip-range start address
1645 :param local_address_stop : local-ip-range stop address
1646 :param remote_address_start: remote-ip-range start address
1647 :param remote_address_stop : remote-ip-range stop address
1648 :param local_port_start: (Default value = 0)
1649 :param local_port_stop: (Default value = 65535)
1650 :param remote_port_start: (Default value = 0)
1651 :param remote_port_stop: (Default value = 65535)
1652 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1653 :param sa_id: Security Association ID for mapping it to SPD
1654 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1656 :param priority: value for the spd action (Default value = 100)
1657 :param is_outbound: flag for inbound(0) or outbound(1)
1659 :param is_add: (Default value = 1)
1662 self.papi.ipsec_spd_entry_add_del,
1669 'local_address_start': local_address_start,
1670 'local_address_stop': local_address_stop,
1671 'remote_address_start': remote_address_start,
1672 'remote_address_stop': remote_address_stop,
1673 'local_port_start': local_port_start,
1674 'local_port_stop': local_port_stop,
1675 'remote_port_start': remote_port_start,
1676 'remote_port_stop': remote_port_stop,
1677 'protocol': protocol,
1679 'priority': priority,
1680 'is_outbound': is_outbound,
1684 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1685 return self.api(self.papi.ipsec_spd_dump,
1689 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1690 remote_spi, crypto_alg, local_crypto_key,
1691 remote_crypto_key, integ_alg, local_integ_key,
1692 remote_integ_key, is_add=1, esn=0, salt=0,
1693 anti_replay=1, renumber=0,
1694 udp_encap=0, show_instance=0xffffffff):
1696 self.papi.ipsec_tunnel_if_add_del,
1698 'local_ip': local_ip,
1699 'remote_ip': remote_ip,
1700 'local_spi': local_spi,
1701 'remote_spi': remote_spi,
1702 'crypto_alg': crypto_alg,
1703 'local_crypto_key_len': len(local_crypto_key),
1704 'local_crypto_key': local_crypto_key,
1705 'remote_crypto_key_len': len(remote_crypto_key),
1706 'remote_crypto_key': remote_crypto_key,
1707 'integ_alg': integ_alg,
1708 'local_integ_key_len': len(local_integ_key),
1709 'local_integ_key': local_integ_key,
1710 'remote_integ_key_len': len(remote_integ_key),
1711 'remote_integ_key': remote_integ_key,
1714 'anti_replay': anti_replay,
1715 'renumber': renumber,
1716 'show_instance': show_instance,
1717 'udp_encap': udp_encap,
1721 def ipsec_select_backend(self, protocol, index):
1722 return self.api(self.papi.ipsec_select_backend,
1723 {'protocol': protocol, 'index': index})
1725 def ipsec_backend_dump(self):
1726 return self.api(self.papi.ipsec_backend_dump, {})
1728 def app_namespace_add_del(self,
1732 sw_if_index=0xFFFFFFFF,
1735 self.papi.app_namespace_add_del,
1737 'sw_if_index': sw_if_index,
1738 'ip4_fib_id': ip4_fib_id,
1739 'ip6_fib_id': ip6_fib_id,
1740 'namespace_id': namespace_id,
1741 'namespace_id_len': len(namespace_id)})
1743 def punt_socket_register(self, reg, pathname,
1745 """ Register punt socket """
1746 return self.api(self.papi.punt_socket_register,
1747 {'header_version': header_version,
1749 'pathname': pathname})
1751 def punt_socket_deregister(self, reg):
1752 """ Unregister punt socket """
1753 return self.api(self.papi.punt_socket_deregister,
1756 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1758 """ GBP endpoint Add """
1759 return self.api(self.papi.gbp_endpoint_add,
1761 'sw_if_index': sw_if_index,
1772 def gbp_endpoint_del(self, handle):
1773 """ GBP endpoint Del """
1774 return self.api(self.papi.gbp_endpoint_del,
1777 def gbp_endpoint_dump(self):
1778 """ GBP endpoint Dump """
1779 return self.api(self.papi.gbp_endpoint_dump, {})
1781 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1782 rd, uplink_sw_if_index,
1784 """ GBP endpoint group Add """
1785 return self.api(self.papi.gbp_endpoint_group_add,
1788 'uplink_sw_if_index': uplink_sw_if_index,
1793 'retention': retention
1796 def gbp_endpoint_group_del(self, sclass):
1797 """ GBP endpoint group Del """
1798 return self.api(self.papi.gbp_endpoint_group_del,
1801 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1804 bm_flood_sw_if_index):
1805 """ GBP bridge-domain Add """
1806 return self.api(self.papi.gbp_bridge_domain_add,
1810 'bvi_sw_if_index': bvi_sw_if_index,
1811 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1812 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1817 def gbp_bridge_domain_del(self, bd_id):
1818 """ GBP bridge-domain Del """
1819 return self.api(self.papi.gbp_bridge_domain_del,
1822 def gbp_route_domain_add(self, rd_id,
1827 ip6_uu_sw_if_index):
1828 """ GBP route-domain Add """
1829 return self.api(self.papi.gbp_route_domain_add,
1833 'ip4_table_id': ip4_table_id,
1834 'ip6_table_id': ip6_table_id,
1835 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1836 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1840 def gbp_route_domain_del(self, rd_id):
1841 """ GBP route-domain Del """
1842 return self.api(self.papi.gbp_route_domain_del,
1845 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1846 """ GBP recirc Add/Del """
1847 return self.api(self.papi.gbp_recirc_add_del,
1851 'sw_if_index': sw_if_index,
1854 def gbp_recirc_dump(self):
1855 """ GBP recirc Dump """
1856 return self.api(self.papi.gbp_recirc_dump, {})
1858 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1859 """ GBP recirc Add/Del """
1860 return self.api(self.papi.gbp_ext_itf_add_del,
1863 'sw_if_index': sw_if_index,
1868 def gbp_ext_itf_dump(self):
1869 """ GBP recirc Dump """
1870 return self.api(self.papi.gbp_ext_itf_dump, {})
1872 def gbp_subnet_add_del(self, is_add, rd_id,
1874 sw_if_index=0xffffffff,
1876 """ GBP Subnet Add/Del """
1877 return self.api(self.papi.gbp_subnet_add_del,
1881 'sw_if_index': sw_if_index,
1886 def gbp_subnet_dump(self):
1887 """ GBP Subnet Dump """
1888 return self.api(self.papi.gbp_subnet_dump, {})
1890 def gbp_contract_dump(self):
1891 """ GBP contract Dump """
1892 return self.api(self.papi.gbp_contract_dump, {})
1894 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1895 """ GBP VXLAN tunnel add """
1896 return self.api(self.papi.gbp_vxlan_tunnel_add,
1901 'bd_rd_id': bd_rd_id,
1906 def gbp_vxlan_tunnel_del(self, vni):
1907 """ GBP VXLAN tunnel del """
1908 return self.api(self.papi.gbp_vxlan_tunnel_del,
1913 def gbp_vxlan_tunnel_dump(self):
1914 """ GBP VXLAN tunnel add/del """
1915 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1917 def igmp_enable_disable(self, sw_if_index, enable, host):
1918 """ Enable/disable IGMP on a given interface """
1919 return self.api(self.papi.igmp_enable_disable,
1922 'sw_if_index': sw_if_index})
1924 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1925 """ Add/del IGMP proxy device """
1926 return self.api(self.papi.igmp_proxy_device_add_del,
1927 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1930 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1931 """ Add/del interface to/from IGMP proxy device """
1932 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1933 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1936 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1937 """ Listen for new (S,G) on specified interface
1939 :param enable: add/del
1940 :param sw_if_index: interface sw index
1941 :param saddr: source ip4 addr
1942 :param gaddr: group ip4 addr
1944 return self.api(self.papi.igmp_listen,
1949 'sw_if_index': sw_if_index,
1950 'n_srcs': len(saddrs),
1956 def igmp_clear_interface(self, sw_if_index):
1957 """ Remove all (S,G)s from specified interface
1958 doesn't send IGMP report!
1961 self.papi.igmp_clear_interface, {
1962 'sw_if_index': sw_if_index})
1964 def want_igmp_events(self, enable=1):
1965 return self.api(self.papi.want_igmp_events, {'enable': enable,
1966 'pid': os.getpid()})
1975 interface_id=0xFFFFFFFF):
1978 :param lb: load balance
1979 :param numa_only: tx on local numa node for lacp mode
1980 :param use_custom_mac: use custom mac
1981 :param mac_address: mac address
1982 :param interface_id: custom interface ID
1985 self.papi.bond_create,
1988 'numa_only': numa_only,
1989 'use_custom_mac': use_custom_mac,
1990 'mac_address': mac_address,
1994 def pipe_delete(self, parent_sw_if_index):
1995 return self.api(self.papi.pipe_delete,
1996 {'parent_sw_if_index': parent_sw_if_index})
1998 def svs_table_add_del(self, af, table_id, is_add=1):
1999 return self.api(self.papi.svs_table_add_del,
2001 'table_id': table_id,
2006 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2007 return self.api(self.papi.svs_route_add_del,
2009 'table_id': table_id,
2010 'source_table_id': src_table_id,
2015 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2016 return self.api(self.papi.svs_enable_disable,
2019 'table_id': table_id,
2020 'sw_if_index': sw_if_index,
2021 'is_enable': is_enable,
2024 def feature_gso_enable_disable(self, sw_if_index, enable_disable=1):
2025 return self.api(self.papi.feature_gso_enable_disable,
2027 'sw_if_index': sw_if_index,
2028 'enable_disable': enable_disable,