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_table_add_del': {'is_add': 1, },
69 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
70 'ipsec_interface_add_del_spd': {'is_add': 1, },
71 'ipsec_sad_entry_add_del': {'is_add': 1, },
72 'ipsec_spd_add_del': {'is_add': 1, },
73 'ipsec_spd_dump': {'sa_id': 4294967295, },
74 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
75 'remote_port_stop': 65535, 'priority': 100,
78 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
79 'l2_emulation': {'enable': 1, },
80 'l2fib_add_del': {'is_add': 1, },
81 'lb_conf': {'sticky_buckets_per_core': 4294967295,
82 'flow_timeout': 4294967295},
83 'lisp_add_del_adjacency': {'is_add': 1, },
84 'lisp_add_del_local_eid': {'is_add': 1, },
85 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
86 'lisp_add_del_locator_set': {'is_add': 1, },
87 'lisp_add_del_remote_mapping': {'is_add': 1, },
88 'macip_acl_add_replace': {'acl_index': 4294967295, },
89 'macip_acl_dump': {'acl_index': 4294967295, },
90 'macip_acl_interface_add_del': {'is_add': 1, },
91 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
92 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
93 'mr_next_hop_weight': 1,
94 'mr_next_hop_via_label': 1048576,
96 'mr_classify_table_index': 4294967295, },
97 'mpls_table_add_del': {'is_add': 1, },
98 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
100 'next_hop_via_label': 1048576,
102 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
103 'output_acl_set_interface': {'ip4_table_index': 4294967295,
104 'ip6_table_index': 4294967295,
105 'l2_table_index': 4294967295, },
106 'pppoe_add_del_session': {'is_add': 1, },
107 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
108 'proxy_arp_add_del': {'is_add': 1, },
109 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
110 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
112 'set_ipfix_exporter': {'collector_port': 4739, },
113 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
114 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
115 'svs_enable_disable': {'is_enable': 1, },
116 'svs_route_add_del': {'is_add': 1, },
117 'svs_table_add_del': {'is_add': 1, },
118 'sw_interface_add_del_address': {'is_add': 1, },
119 'sw_interface_dump': {'sw_if_index': 4294967295, },
120 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
121 'pref_lifetime': 4294967295, },
122 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
123 'sw_interface_set_l2_bridge': {'enable': 1, },
124 'sw_interface_set_mpls_enable': {'enable': 1, },
125 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
126 'sw_interface_set_unnumbered': {'is_add': 1, },
127 'sw_interface_span_enable_disable': {'state': 1, },
128 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
129 'decap_next_index': 4294967295,
130 'instance': 4294967295, },
131 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
132 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
134 'want_bfd_events': {'enable_disable': 1, },
135 'want_igmp_events': {'enable': 1, },
136 'want_interface_events': {'enable_disable': 1, },
137 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
138 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
139 'want_ip6_ra_events': {'enable_disable': 1, },
140 'want_l2_macs_events': {'enable_disable': 1, },
144 class CliFailedCommandError(Exception):
145 """ cli command failed."""
148 class CliSyntaxError(Exception):
149 """ cli command had a syntax error."""
152 class UnexpectedApiReturnValueError(Exception):
153 """ exception raised when the API return value is unexpected """
157 class VppPapiProvider(object):
158 """VPP-api provider using vpp-papi
160 @property hook: hook object providing before and after api/cli hooks
163 _zero, _negative = range(2)
165 def __init__(self, name, shm_prefix, test_class, read_timeout):
166 self.hook = Hook(test_class)
168 self.shm_prefix = shm_prefix
169 self.test_class = test_class
170 self._expect_api_retval = self._zero
171 self._expect_stack = []
173 # install_dir is a class attribute. We need to set it before
174 # calling the constructor.
175 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
179 if os.environ['SOCKET'] == '1':
184 self.vpp = VPPApiClient(logger=test_class.logger,
185 read_timeout=read_timeout,
186 use_socket=use_socket,
187 server_address=test_class.api_sock)
188 self._events = deque()
193 def assert_negative_api_retval(self):
194 """ Expect API failure - used with with, e.g.:
195 with self.vapi.assert_negative_api_retval():
196 self.vapi.<api call expected to fail>
198 self._expect_stack.append(self._expect_api_retval)
199 self._expect_api_retval = self._negative
202 def assert_zero_api_retval(self):
203 """ Expect API success - used with with, e.g.:
204 with self.vapi.assert_negative_api_retval():
205 self.vapi.<api call expected to succeed>
207 note: this is useful only inside another with block
208 as success is the default expected value
210 self._expect_stack.append(self._expect_api_retval)
211 self._expect_api_retval = self._zero
214 def __exit__(self, exc_type, exc_value, traceback):
215 self._expect_api_retval = self._expect_stack.pop()
217 def register_hook(self, hook):
218 """Replace hook registration with new hook
225 def collect_events(self):
226 """ Collect all events from the internal queue and clear the queue. """
228 self._events = deque()
231 def wait_for_event(self, timeout, name=None):
232 """ Wait for and return next event. """
234 self.test_class.logger.debug("Expecting event '%s' within %ss",
237 self.test_class.logger.debug("Expecting event within %ss",
240 self.test_class.logger.debug("Not waiting, event already queued")
241 limit = time.time() + timeout
242 while time.time() < limit:
244 e = self._events.popleft()
245 if name and type(e).__name__ != name:
247 "Unexpected event received: %s, expected: %s" %
248 (type(e).__name__, name))
249 self.test_class.logger.debug("Returning event %s:%s" %
252 self.test_class.sleep(0) # yield
253 raise Exception("Event did not occur within timeout")
255 def __call__(self, name, event):
256 """ Enqueue event in the internal event queue. """
257 # FIXME use the name instead of relying on type(e).__name__ ?
258 # FIXME #2 if this throws, it is eaten silently, Ole?
259 self.test_class.logger.debug("New event: %s: %s" % (name, event))
260 self._events.append(event)
262 def factory(self, name, apifn):
264 fields = apifn._func.msg.fields
266 # add positional and kw arguments
268 for i, o in enumerate(fields[3:]):
271 except BaseException:
275 if name in defaultmapping:
276 for k, v in iteritems(defaultmapping[name]):
280 return self.api(apifn, d)
284 def __getattribute__(self, name):
286 method = super(VppPapiProvider, self).__getattribute__(name)
287 except AttributeError:
288 method = self.factory(name, getattr(self.papi, name))
289 # lazily load the method so we don't need to call factory
290 # again for this name.
291 setattr(self, name, method)
295 """Connect the API to VPP"""
296 self.vpp.connect(self.name, self.shm_prefix)
297 self.papi = self.vpp.api
298 self.vpp.register_event_callback(self)
300 def disconnect(self):
301 """Disconnect the API from VPP"""
302 self.vpp.disconnect()
304 def api(self, api_fn, api_args, expected_retval=0):
305 """ Call API function and check it's return value.
306 Call the appropriate hooks before and after the API call
308 :param api_fn: API function to call
309 :param api_args: tuple of API function arguments
310 :param expected_retval: Expected return value (Default value = 0)
311 :returns: reply from the API
314 self.hook.before_api(api_fn.__name__, api_args)
315 reply = api_fn(**api_args)
316 if self._expect_api_retval == self._negative:
317 if hasattr(reply, 'retval') and reply.retval >= 0:
318 msg = "API call passed unexpectedly: expected negative " \
319 "return value instead of %d in %s" % \
320 (reply.retval, moves.reprlib.repr(reply))
321 self.test_class.logger.info(msg)
322 raise UnexpectedApiReturnValueError(msg)
323 elif self._expect_api_retval == self._zero:
324 if hasattr(reply, 'retval') and reply.retval != expected_retval:
325 msg = "API call failed, expected %d return value instead " \
326 "of %d in %s" % (expected_retval, reply.retval,
328 self.test_class.logger.info(msg)
329 raise UnexpectedApiReturnValueError(msg)
331 raise Exception("Internal error, unexpected value for "
332 "self._expect_api_retval %s" %
333 self._expect_api_retval)
334 self.hook.after_api(api_fn.__name__, api_args)
337 def cli_return_response(self, cli):
338 """ Execute a CLI, calling the before/after hooks appropriately.
339 Return the reply without examining it
341 :param cli: CLI to execute
342 :returns: response object
345 self.hook.before_cli(cli)
347 r = self.papi.cli_inband(cmd=cli)
348 self.hook.after_cli(cli)
352 """ Execute a CLI, calling the before/after hooks appropriately.
354 :param cli: CLI to execute
358 r = self.cli_return_response(cli)
360 raise CliSyntaxError(r.reply)
362 raise CliFailedCommandError(r.reply)
363 if hasattr(r, 'reply'):
366 def ppcli(self, cli):
367 """ Helper method to print CLI command in case of info logging level.
369 :param cli: CLI to execute
372 return cli + "\n" + self.cli(cli).encode('ascii',
373 errors='backslashreplace')
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 sw_interface_set_mac_address(self, sw_if_index, mac):
416 return self.api(self.papi.sw_interface_set_mac_address,
417 {'sw_if_index': sw_if_index,
420 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
421 """Create p2p ethernet subinterface
423 :param sw_if_index: main (parent) interface
424 :param remote_mac: client (remote) mac address
428 self.papi.p2p_ethernet_add,
429 {'parent_if_index': sw_if_index,
430 'remote_mac': remote_mac,
431 'subif_id': subif_id})
433 def p2p_ethernet_del(self, sw_if_index, remote_mac):
434 """Delete p2p ethernet subinterface
436 :param sw_if_index: main (parent) interface
437 :param remote_mac: client (remote) mac address
441 self.papi.p2p_ethernet_del,
442 {'parent_if_index': sw_if_index,
443 'remote_mac': remote_mac})
445 def create_vlan_subif(self, sw_if_index, vlan):
452 return self.api(self.papi.create_vlan_subif,
453 {'sw_if_index': sw_if_index,
456 def create_loopback(self, mac=''):
459 :param mac: (Optional)
461 return self.api(self.papi.create_loopback,
462 {'mac_address': mac})
464 def ip_table_add_del(self,
471 :param is_add: (Default value = 1)
472 :param is_ipv6: (Default value = 0)
477 self.papi.ip_table_add_del,
480 'table_id': table_id,
485 def ip_table_dump(self):
486 return self.api(self.papi.ip_table_dump, {})
488 def ip_route_dump(self, table_id, is_ip6=False):
489 return self.api(self.papi.ip_route_dump,
491 'table_id': table_id,
495 def ip_neighbor_add_del(self,
501 """ Add neighbor MAC to IPv4 or IPv6 address.
506 :param is_add: (Default value = 1)
507 :param flags: (Default value = 0/NONE)
510 self.papi.ip_neighbor_add_del,
514 'sw_if_index': sw_if_index,
516 'mac_address': mac_address,
517 'ip_address': ip_address
522 def proxy_arp_add_del(self,
527 """ Config Proxy Arp Range.
529 :param low_address: Start address in the rnage to Proxy for
530 :param hi_address: End address in the rnage to Proxy for
531 :param vrf_id: The VRF/table in which to proxy
535 self.papi.proxy_arp_add_del,
538 'table_id': table_id,
544 def proxy_arp_intfc_enable_disable(self,
547 """ Enable/Disable an interface for proxy ARP requests
549 :param sw_if_index: Interface
550 :param enable_disable: Enable/Disable
554 self.papi.proxy_arp_intfc_enable_disable,
555 {'sw_if_index': sw_if_index,
556 'enable_disable': is_enable
560 def gre_tunnel_add_del(self,
572 :param outer_fib_id: (Default value = 0)
573 :param tunnel_type: (Default value = 0)
574 :param instance: (Default value = 0xFFFFFFFF)
575 :param session_id: (Default value = 0)
576 :param is_add: (Default value = 1)
577 :param is_ipv6: (Default value = 0)
581 self.papi.gre_tunnel_add_del,
586 'instance': instance,
589 'outer_fib_id': outer_fib_id,
590 'session_id': session_id}
594 def udp_encap_add(self,
605 :param outer_fib_id: (Default value = 0)
609 self.papi.udp_encap_add,
614 'src_port': src_port,
615 'dst_port': dst_port,
620 def udp_encap_del(self, id):
621 return self.api(self.papi.udp_encap_del, {'id': id})
623 def udp_encap_dump(self):
624 return self.api(self.papi.udp_encap_dump, {})
626 def want_udp_encap_stats(self, enable=1):
627 return self.api(self.papi.want_udp_encap_stats,
631 def mpls_route_dump(self, table_id):
632 return self.api(self.papi.mpls_route_dump,
634 'mt_table_id': table_id
637 def mpls_table_dump(self):
638 return self.api(self.papi.mpls_table_dump, {})
640 def mpls_table_add_del(
647 :param is_add: (Default value = 1)
652 self.papi.mpls_table_add_del,
655 'mt_table_id': table_id,
657 'mt_is_add': is_add})
659 def mpls_route_add_del(self,
668 """ MPLS Route add/del """
670 self.papi.mpls_route_add_del,
673 'mr_table_id': table_id,
676 'mr_eos_proto': eos_proto,
677 'mr_is_multicast': is_multicast,
678 'mr_n_paths': len(paths),
682 'mr_is_multipath': is_multipath})
684 def mpls_ip_bind_unbind(
694 self.papi.mpls_ip_bind_unbind,
695 {'mb_mpls_table_id': table_id,
697 'mb_ip_table_id': ip_table_id,
698 'mb_is_bind': is_bind,
699 'mb_prefix': prefix})
701 def mpls_tunnel_add_del(
711 self.papi.mpls_tunnel_add_del,
712 {'mt_is_add': is_add,
715 'mt_sw_if_index': tun_sw_if_index,
716 'mt_l2_only': l2_only,
717 'mt_is_multicast': is_multicast,
718 'mt_n_paths': len(paths),
722 def classify_add_del_table(
727 table_index=0xFFFFFFFF,
731 next_table_index=0xFFFFFFFF,
732 miss_next_index=0xFFFFFFFF,
734 current_data_offset=0):
738 :param match_n_vectors: (Default value = 1)
739 :param table_index: (Default value = 0xFFFFFFFF)
740 :param nbuckets: (Default value = 2)
741 :param memory_size: (Default value = 2097152)
742 :param skip_n_vectors: (Default value = 0)
743 :param next_table_index: (Default value = 0xFFFFFFFF)
744 :param miss_next_index: (Default value = 0xFFFFFFFF)
745 :param current_data_flag: (Default value = 0)
746 :param current_data_offset: (Default value = 0)
749 mask_len = ((len(mask) - 1) / 16 + 1) * 16
750 mask = mask + '\0' * (mask_len - len(mask))
752 self.papi.classify_add_del_table,
754 'table_index': table_index,
755 'nbuckets': nbuckets,
756 'memory_size': memory_size,
757 'skip_n_vectors': skip_n_vectors,
758 'match_n_vectors': match_n_vectors,
759 'next_table_index': next_table_index,
760 'miss_next_index': miss_next_index,
761 'current_data_flag': current_data_flag,
762 'current_data_offset': current_data_offset,
763 'mask_len': mask_len,
766 def classify_add_del_session(
771 opaque_index=0xFFFFFFFF,
772 hit_next_index=0xFFFFFFFF,
780 :param opaque_index: (Default value = 0xFFFFFFFF)
781 :param hit_next_index: (Default value = 0xFFFFFFFF)
782 :param advance: (Default value = 0)
783 :param action: (Default value = 0)
784 :param metadata: (Default value = 0)
787 match_len = ((len(match) - 1) / 16 + 1) * 16
788 match = match + '\0' * (match_len - len(match))
790 self.papi.classify_add_del_session,
792 'table_index': table_index,
793 'hit_next_index': hit_next_index,
794 'opaque_index': opaque_index,
797 'metadata': metadata,
798 'match_len': match_len,
801 def input_acl_set_interface(
805 ip4_table_index=0xFFFFFFFF,
806 ip6_table_index=0xFFFFFFFF,
807 l2_table_index=0xFFFFFFFF):
811 :param ip4_table_index: (Default value = 0xFFFFFFFF)
812 :param ip6_table_index: (Default value = 0xFFFFFFFF)
813 :param l2_table_index: (Default value = 0xFFFFFFFF)
817 self.papi.input_acl_set_interface,
818 {'sw_if_index': sw_if_index,
819 'ip4_table_index': ip4_table_index,
820 'ip6_table_index': ip6_table_index,
821 'l2_table_index': l2_table_index,
824 def output_acl_set_interface(
828 ip4_table_index=0xFFFFFFFF,
829 ip6_table_index=0xFFFFFFFF,
830 l2_table_index=0xFFFFFFFF):
834 :param ip4_table_index: (Default value = 0xFFFFFFFF)
835 :param ip6_table_index: (Default value = 0xFFFFFFFF)
836 :param l2_table_index: (Default value = 0xFFFFFFFF)
840 self.papi.output_acl_set_interface,
841 {'sw_if_index': sw_if_index,
842 'ip4_table_index': ip4_table_index,
843 'ip6_table_index': ip6_table_index,
844 'l2_table_index': l2_table_index,
847 def set_ipfix_exporter(
857 self.papi.set_ipfix_exporter,
859 'collector_address': collector_address,
860 'collector_port': collector_port,
861 'src_address': src_address,
863 'path_mtu': path_mtu,
864 'template_interval': template_interval,
865 'udp_checksum': udp_checksum,
868 def ip_mroute_add_del(self,
877 IP Multicast Route add/del
880 self.papi.ip_mroute_add_del,
883 'is_multipath': is_multipath,
885 'table_id': table_id,
886 'entry_flags': e_flags,
889 'n_paths': len(paths),
894 def mfib_signal_dump(self):
895 return self.api(self.papi.mfib_signal_dump, {})
897 def ip_mroute_dump(self, table_id, is_ip6=False):
898 return self.api(self.papi.ip_mroute_dump,
900 'table_id': table_id,
904 def lisp_enable_disable(self, is_enabled):
906 self.papi.lisp_enable_disable,
911 def lisp_add_del_locator_set(self,
915 self.papi.lisp_add_del_locator_set,
918 'locator_set_name': ls_name
921 def lisp_add_del_locator(self,
928 self.papi.lisp_add_del_locator,
931 'locator_set_name': ls_name,
932 'sw_if_index': sw_if_index,
933 'priority': priority,
937 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
939 self.papi.lisp_locator_dump,
941 'is_index_set': is_index_set,
943 'ls_index': ls_index,
946 def lisp_add_del_local_eid(self,
956 self.papi.lisp_add_del_local_eid,
958 'locator_set_name': ls_name,
960 'eid_type': eid_type,
962 'prefix_len': prefix_len,
968 def lisp_eid_table_dump(self,
976 self.papi.lisp_eid_table_dump,
979 'prefix_length': prefix_length,
981 'eid_type': eid_type,
983 'filter': filter_opt,
986 def lisp_add_del_remote_mapping(self,
996 self.papi.lisp_add_del_remote_mapping,
999 'eid_type': eid_type,
1001 'eid_len': eid_prefix_len,
1002 'rloc_num': rlocs_num,
1005 'is_src_dst': is_src_dst,
1008 def lisp_add_del_adjacency(self,
1017 self.papi.lisp_add_del_adjacency,
1021 'eid_type': eid_type,
1024 'leid_len': leid_len,
1025 'reid_len': reid_len,
1028 def gtpu_add_del_tunnel(
1034 mcast_sw_if_index=0xFFFFFFFF,
1036 decap_next_index=0xFFFFFFFF,
1040 :param is_add: (Default value = 1)
1041 :param is_ipv6: (Default value = 0)
1044 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1045 :param encap_vrf_id: (Default value = 0)
1046 :param decap_next_index: (Default value = 0xFFFFFFFF)
1047 :param teid: (Default value = 0)
1050 return self.api(self.papi.gtpu_add_del_tunnel,
1053 'src_address': src_addr,
1054 'dst_address': dst_addr,
1055 'mcast_sw_if_index': mcast_sw_if_index,
1056 'encap_vrf_id': encap_vrf_id,
1057 'decap_next_index': decap_next_index,
1060 def vxlan_gpe_add_del_tunnel(
1064 mcast_sw_if_index=0xFFFFFFFF,
1075 :param is_add: (Default value = 1)
1076 :param is_ipv6: (Default value = 0)
1077 :param encap_vrf_id: (Default value = 0)
1078 :param decap_vrf_id: (Default value = 0)
1079 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1080 :param protocol: (Default value = 3)
1081 :param vni: (Default value = 0)
1084 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1089 'mcast_sw_if_index': mcast_sw_if_index,
1090 'encap_vrf_id': encap_vrf_id,
1091 'decap_vrf_id': decap_vrf_id,
1092 'protocol': protocol,
1095 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1096 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1097 {'sw_if_index': sw_if_index,
1098 '_no_type_conversion': True})
1100 def pppoe_add_del_session(
1110 :param is_add: (Default value = 1)
1111 :param is_ipv6: (Default value = 0)
1113 :param session_id: (Default value = 0)
1115 :param decap_vrf_id: (Default value = 0)
1118 return self.api(self.papi.pppoe_add_del_session,
1121 'session_id': session_id,
1122 'client_ip': client_ip,
1123 'decap_vrf_id': decap_vrf_id,
1124 'client_mac': client_mac})
1126 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1127 return self.api(self.papi.sr_mpls_policy_add,
1131 'n_segments': len(segments),
1132 'segments': segments})
1134 def sr_mpls_policy_del(self, bsid):
1135 return self.api(self.papi.sr_mpls_policy_del,
1138 def sr_localsid_add_del(self,
1145 sw_if_index=0xFFFFFFFF,
1149 """ Add/del IPv6 SR local-SID.
1152 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1153 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1156 :param is_del: (Default value = 0)
1157 :param end_psp: (Default value = 0)
1158 :param sw_if_index: (Default value = 0xFFFFFFFF)
1159 :param vlan_index: (Default value = 0)
1160 :param fib_table: (Default value = 0)
1163 self.papi.sr_localsid_add_del,
1165 'localsid': localsid,
1167 'behavior': behavior,
1168 'sw_if_index': sw_if_index,
1169 'vlan_index': vlan_index,
1170 'fib_table': fib_table,
1171 'nh_addr4': nh_addr4,
1172 'nh_addr6': nh_addr6
1186 :param bsid_addr: bindingSID of the SR Policy
1187 :param weight: weight of the sid list. optional. (default: 1)
1188 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1190 :param type: type/behavior of the SR policy. (default or spray) \
1192 :param fib_table: VRF where to install the FIB entry for the BSID \
1194 :param n_segments: number of segments \
1196 :param segments: a vector of IPv6 address composing the segment list \
1200 self.papi.sr_policy_add,
1201 {'bsid_addr': bsid_addr,
1203 'is_encap': is_encap,
1205 'fib_table': fib_table,
1206 'n_segments': n_segments,
1207 'segments': segments
1216 :param bsid: bindingSID of the SR Policy
1217 :param sr_policy_index: index of the sr policy (default: 0)
1220 self.papi.sr_policy_del,
1221 {'bsid_addr': bsid_addr,
1222 'sr_policy_index': sr_policy_index
1225 def sr_steering_add_del(
1236 Steer traffic L2 and L3 traffic through a given SR policy
1238 :param is_del: delete or add
1239 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1240 :param sr_policy: is the index of the SR Policy (alt to bsid)
1241 :param table_id: is the VRF where to install the FIB entry for the BSID
1242 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1243 :param mask_width: is the mask for L3 traffic type
1244 :param sw_if_index: is the incoming interface for L2 traffic
1245 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1248 self.papi.sr_steering_add_del,
1250 'bsid_addr': bsid_addr,
1251 'sr_policy_index': sr_policy_index,
1252 'table_id': table_id,
1253 'prefix_addr': prefix_addr,
1254 'mask_width': mask_width,
1255 'sw_if_index': sw_if_index,
1256 'traffic_type': traffic_type
1259 def acl_add_replace(self, acl_index, r, tag='',
1261 """Add/replace an ACL
1262 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1263 :param acl_rule r: ACL rules array.
1264 :param str tag: symbolic tag (description) for this ACL.
1265 :param int count: number of rules.
1267 return self.api(self.papi.acl_add_replace,
1268 {'acl_index': acl_index,
1272 expected_retval=expected_retval)
1274 def acl_del(self, acl_index, expected_retval=0):
1280 return self.api(self.papi.acl_del,
1281 {'acl_index': acl_index},
1282 expected_retval=expected_retval)
1284 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1286 return self.api(self.papi.acl_interface_set_acl_list,
1287 {'sw_if_index': sw_if_index,
1291 expected_retval=expected_retval)
1293 def acl_interface_set_etype_whitelist(self, sw_if_index,
1296 return self.api(self.papi.acl_interface_set_etype_whitelist,
1297 {'sw_if_index': sw_if_index,
1298 'count': len(whitelist),
1300 'whitelist': whitelist},
1301 expected_retval=expected_retval)
1303 def acl_interface_add_del(self,
1307 """ Add/Delete ACL to/from interface
1311 :param is_add: (Default value = 1)
1314 return self.api(self.papi.acl_interface_add_del,
1317 'sw_if_index': sw_if_index,
1318 'acl_index': acl_index})
1320 def acl_dump(self, acl_index, expected_retval=0):
1321 return self.api(self.papi.acl_dump,
1322 {'acl_index': acl_index},
1323 expected_retval=expected_retval)
1325 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1327 return self.api(self.papi.acl_interface_list_dump,
1328 {'sw_if_index': sw_if_index},
1329 expected_retval=expected_retval)
1331 def macip_acl_add(self, rules, tag=""):
1334 :param rules: list of rules for given acl
1338 return self.api(self.papi.macip_acl_add,
1340 'count': len(rules),
1343 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1346 :param rules: list of rules for given acl
1350 return self.api(self.papi.macip_acl_add_replace,
1351 {'acl_index': acl_index,
1353 'count': len(rules),
1356 def macip_acl_interface_add_del(self,
1360 """ Add MACIP acl to interface
1364 :param is_add: (Default value = 1)
1367 return self.api(self.papi.macip_acl_interface_add_del,
1369 'sw_if_index': sw_if_index,
1370 'acl_index': acl_index})
1372 def macip_acl_dump(self, acl_index=4294967295):
1373 """ Return MACIP acl dump
1377 self.papi.macip_acl_dump, {'acl_index': acl_index})
1379 def policer_add_del(self,
1390 conform_action_type=1,
1392 exceed_action_type=0,
1394 violate_action_type=0,
1396 return self.api(self.papi.policer_add_del,
1403 'rate_type': rate_type,
1404 'round_type': round_type,
1406 'color_aware': color_aware,
1407 'conform_action_type': conform_action_type,
1408 'conform_dscp': conform_dscp,
1409 'exceed_action_type': exceed_action_type,
1410 'exceed_dscp': exceed_dscp,
1411 'violate_action_type': violate_action_type,
1412 'violate_dscp': violate_dscp})
1414 def ip_punt_police(self,
1418 return self.api(self.papi.ip_punt_police,
1419 {'policer_index': policer_index,
1423 def ip_punt_redirect(self,
1428 return self.api(self.papi.ip_punt_redirect,
1429 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1430 'tx_sw_if_index': tx_sw_if_index,
1434 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1435 return self.api(self.papi.ip_punt_redirect_dump,
1436 {'sw_if_index': sw_if_index,
1437 'is_ipv6': is_ipv6})
1439 def bier_table_add_del(self,
1443 """ BIER Table add/del """
1445 self.papi.bier_table_add_del,
1446 {'bt_tbl_id': {"bt_set": bti.set_id,
1447 "bt_sub_domain": bti.sub_domain_id,
1448 "bt_hdr_len_id": bti.hdr_len_id},
1449 'bt_label': mpls_label,
1450 'bt_is_add': is_add})
1452 def bier_table_dump(self):
1453 return self.api(self.papi.bier_table_dump, {})
1455 def bier_route_add_del(self,
1461 """ BIER Route add/del """
1463 self.papi.bier_route_add_del,
1466 'br_tbl_id': {"bt_set": bti.set_id,
1467 "bt_sub_domain": bti.sub_domain_id,
1468 "bt_hdr_len_id": bti.hdr_len_id},
1470 'br_n_paths': len(paths),
1473 'br_is_add': is_add,
1474 'br_is_replace': is_replace
1477 def bier_route_dump(self, bti):
1479 self.papi.bier_route_dump,
1480 {'br_tbl_id': {"bt_set": bti.set_id,
1481 "bt_sub_domain": bti.sub_domain_id,
1482 "bt_hdr_len_id": bti.hdr_len_id}})
1484 def bier_imp_add(self,
1489 """ BIER Imposition Add """
1491 self.papi.bier_imp_add,
1492 {'bi_tbl_id': {"bt_set": bti.set_id,
1493 "bt_sub_domain": bti.sub_domain_id,
1494 "bt_hdr_len_id": bti.hdr_len_id},
1496 'bi_n_bytes': len(ibytes),
1497 'bi_bytes': ibytes})
1499 def bier_imp_del(self, bi_index):
1500 """ BIER Imposition del """
1502 self.papi.bier_imp_del,
1503 {'bi_index': bi_index})
1505 def bier_imp_dump(self):
1506 return self.api(self.papi.bier_imp_dump, {})
1508 def bier_disp_table_add_del(self,
1511 """ BIER Disposition Table add/del """
1513 self.papi.bier_disp_table_add_del,
1514 {'bdt_tbl_id': bdti,
1515 'bdt_is_add': is_add})
1517 def bier_disp_table_dump(self):
1518 return self.api(self.papi.bier_disp_table_dump, {})
1520 def bier_disp_entry_add_del(self,
1530 """ BIER Route add/del """
1532 while (len(lstack) < 16):
1535 self.papi.bier_disp_entry_add_del,
1536 {'bde_tbl_id': bdti,
1538 'bde_payload_proto': payload_proto,
1540 'bde_paths': [{'table_id': next_hop_tbl_id,
1541 'rpf_id': next_hop_rpf_id,
1543 'label_stack': lstack}],
1544 'bde_is_add': is_add})
1546 def bier_disp_entry_dump(self, bdti):
1548 self.papi.bier_disp_entry_dump,
1549 {'bde_tbl_id': bdti})
1551 def session_enable_disable(self, is_enabled):
1553 self.papi.session_enable_disable,
1554 {'is_enable': is_enabled})
1556 def ipsec_spd_add_del(self, spd_id, is_add=1):
1557 """ SPD add/del - Wrapper to add or del ipsec SPD
1558 Sample CLI : 'ipsec spd add 1'
1560 :param spd_id - SPD ID to be created in the vpp . mandatory
1561 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1563 :returns: reply from the API
1566 self.papi.ipsec_spd_add_del, {
1567 'spd_id': spd_id, 'is_add': is_add})
1569 def ipsec_spds_dump(self):
1570 return self.api(self.papi.ipsec_spds_dump, {})
1572 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1573 """ IPSEC interface SPD add/del - \
1574 Wrapper to associate/disassociate SPD to interface in VPP
1575 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1577 :param spd_id - SPD ID to associate with the interface . mandatory
1578 :param sw_if_index - Interface Index which needs to ipsec \
1579 association mandatory
1580 :param is_add - add(1) or del(0) association with interface \
1581 (Default 1 - add) . optional
1582 :returns: reply from the API
1585 self.papi.ipsec_interface_add_del_spd,
1586 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1588 def ipsec_spd_interface_dump(self, spd_index=None):
1589 return self.api(self.papi.ipsec_spd_interface_dump,
1590 {'spd_index': spd_index if spd_index else 0,
1591 'spd_index_valid': 1 if spd_index else 0})
1593 def ipsec_sad_entry_add_del(self,
1596 integrity_algorithm,
1601 tunnel_src_address='',
1602 tunnel_dst_address='',
1606 """ IPSEC SA add/del
1607 :param sad_id: security association ID
1608 :param spi: security param index of the SA in decimal
1609 :param integrity_algorithm:
1610 :param integrity_key:
1611 :param crypto_algorithm:
1613 :param protocol: AH(0) or ESP(1) protocol
1614 :param tunnel_src_address: tunnel mode outer src address
1615 :param tunnel_dst_address: tunnel mode outer dst address
1618 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1619 crypto and ipsec algorithms
1622 self.papi.ipsec_sad_entry_add_del,
1629 'tunnel_src': tunnel_src_address,
1630 'tunnel_dst': tunnel_dst_address,
1631 'protocol': protocol,
1632 'integrity_algorithm': integrity_algorithm,
1634 'length': len(integrity_key),
1635 'data': integrity_key,
1637 'crypto_algorithm': crypto_algorithm,
1639 'length': len(crypto_key),
1647 def ipsec_sa_dump(self, sa_id=None):
1648 return self.api(self.papi.ipsec_sa_dump,
1649 {'sa_id': sa_id if sa_id else 0xffffffff})
1651 def ipsec_spd_entry_add_del(self,
1654 local_address_start,
1656 remote_address_start,
1657 remote_address_stop,
1659 local_port_stop=65535,
1660 remote_port_start=0,
1661 remote_port_stop=65535,
1669 """ IPSEC policy SPD add/del -
1670 Wrapper to configure ipsec SPD policy entries in VPP
1671 :param spd_id: SPD ID for the policy
1672 :param local_address_start: local-ip-range start address
1673 :param local_address_stop : local-ip-range stop address
1674 :param remote_address_start: remote-ip-range start address
1675 :param remote_address_stop : remote-ip-range stop address
1676 :param local_port_start: (Default value = 0)
1677 :param local_port_stop: (Default value = 65535)
1678 :param remote_port_start: (Default value = 0)
1679 :param remote_port_stop: (Default value = 65535)
1680 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1681 :param sa_id: Security Association ID for mapping it to SPD
1682 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1684 :param priority: value for the spd action (Default value = 100)
1685 :param is_outbound: flag for inbound(0) or outbound(1)
1687 :param is_add: (Default value = 1)
1690 self.papi.ipsec_spd_entry_add_del,
1697 'local_address_start': local_address_start,
1698 'local_address_stop': local_address_stop,
1699 'remote_address_start': remote_address_start,
1700 'remote_address_stop': remote_address_stop,
1701 'local_port_start': local_port_start,
1702 'local_port_stop': local_port_stop,
1703 'remote_port_start': remote_port_start,
1704 'remote_port_stop': remote_port_stop,
1705 'protocol': protocol,
1707 'priority': priority,
1708 'is_outbound': is_outbound,
1712 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1713 return self.api(self.papi.ipsec_spd_dump,
1717 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1718 remote_spi, crypto_alg, local_crypto_key,
1719 remote_crypto_key, integ_alg, local_integ_key,
1720 remote_integ_key, is_add=1, esn=0, salt=0,
1721 anti_replay=1, renumber=0,
1722 udp_encap=0, show_instance=0):
1724 self.papi.ipsec_tunnel_if_add_del,
1726 'local_ip': local_ip,
1727 'remote_ip': remote_ip,
1728 'local_spi': local_spi,
1729 'remote_spi': remote_spi,
1730 'crypto_alg': crypto_alg,
1731 'local_crypto_key_len': len(local_crypto_key),
1732 'local_crypto_key': local_crypto_key,
1733 'remote_crypto_key_len': len(remote_crypto_key),
1734 'remote_crypto_key': remote_crypto_key,
1735 'integ_alg': integ_alg,
1736 'local_integ_key_len': len(local_integ_key),
1737 'local_integ_key': local_integ_key,
1738 'remote_integ_key_len': len(remote_integ_key),
1739 'remote_integ_key': remote_integ_key,
1742 'anti_replay': anti_replay,
1743 'renumber': renumber,
1744 'show_instance': show_instance,
1745 'udp_encap': udp_encap,
1749 def ipsec_select_backend(self, protocol, index):
1750 return self.api(self.papi.ipsec_select_backend,
1751 {'protocol': protocol, 'index': index})
1753 def ipsec_backend_dump(self):
1754 return self.api(self.papi.ipsec_backend_dump, {})
1756 def app_namespace_add_del(self,
1760 sw_if_index=0xFFFFFFFF,
1763 self.papi.app_namespace_add_del,
1765 'sw_if_index': sw_if_index,
1766 'ip4_fib_id': ip4_fib_id,
1767 'ip6_fib_id': ip6_fib_id,
1768 'namespace_id': namespace_id,
1769 'namespace_id_len': len(namespace_id)})
1771 def punt_socket_register(self, reg, pathname,
1773 """ Register punt socket """
1774 return self.api(self.papi.punt_socket_register,
1775 {'header_version': header_version,
1777 'pathname': pathname})
1779 def punt_socket_deregister(self, reg):
1780 """ Unregister punt socket """
1781 return self.api(self.papi.punt_socket_deregister,
1784 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1786 """ GBP endpoint Add """
1787 return self.api(self.papi.gbp_endpoint_add,
1789 'sw_if_index': sw_if_index,
1800 def gbp_endpoint_del(self, handle):
1801 """ GBP endpoint Del """
1802 return self.api(self.papi.gbp_endpoint_del,
1805 def gbp_endpoint_dump(self):
1806 """ GBP endpoint Dump """
1807 return self.api(self.papi.gbp_endpoint_dump,
1808 {'_no_type_conversion': True})
1810 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1811 rd, uplink_sw_if_index,
1813 """ GBP endpoint group Add """
1814 return self.api(self.papi.gbp_endpoint_group_add,
1817 'uplink_sw_if_index': uplink_sw_if_index,
1822 'retention': retention
1825 def gbp_endpoint_group_del(self, sclass):
1826 """ GBP endpoint group Del """
1827 return self.api(self.papi.gbp_endpoint_group_del,
1830 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1833 bm_flood_sw_if_index):
1834 """ GBP bridge-domain Add """
1835 return self.api(self.papi.gbp_bridge_domain_add,
1839 'bvi_sw_if_index': bvi_sw_if_index,
1840 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1841 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1846 def gbp_bridge_domain_del(self, bd_id):
1847 """ GBP bridge-domain Del """
1848 return self.api(self.papi.gbp_bridge_domain_del,
1851 def gbp_route_domain_add(self, rd_id,
1856 ip6_uu_sw_if_index):
1857 """ GBP route-domain Add """
1858 return self.api(self.papi.gbp_route_domain_add,
1862 'ip4_table_id': ip4_table_id,
1863 'ip6_table_id': ip6_table_id,
1864 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1865 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1869 def gbp_route_domain_del(self, rd_id):
1870 """ GBP route-domain Del """
1871 return self.api(self.papi.gbp_route_domain_del,
1874 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1875 """ GBP recirc Add/Del """
1876 return self.api(self.papi.gbp_recirc_add_del,
1880 'sw_if_index': sw_if_index,
1883 def gbp_recirc_dump(self):
1884 """ GBP recirc Dump """
1885 return self.api(self.papi.gbp_recirc_dump, {})
1887 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1888 """ GBP recirc Add/Del """
1889 return self.api(self.papi.gbp_ext_itf_add_del,
1892 'sw_if_index': sw_if_index,
1897 def gbp_ext_itf_dump(self):
1898 """ GBP recirc Dump """
1899 return self.api(self.papi.gbp_ext_itf_dump, {})
1901 def gbp_subnet_add_del(self, is_add, rd_id,
1903 sw_if_index=0xffffffff,
1905 """ GBP Subnet Add/Del """
1906 return self.api(self.papi.gbp_subnet_add_del,
1910 'sw_if_index': sw_if_index,
1915 def gbp_subnet_dump(self):
1916 """ GBP Subnet Dump """
1917 return self.api(self.papi.gbp_subnet_dump,
1918 {'_no_type_conversion': True})
1920 def gbp_contract_dump(self):
1921 """ GBP contract Dump """
1922 return self.api(self.papi.gbp_contract_dump, {})
1924 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1925 """ GBP VXLAN tunnel add """
1926 return self.api(self.papi.gbp_vxlan_tunnel_add,
1931 'bd_rd_id': bd_rd_id,
1936 def gbp_vxlan_tunnel_del(self, vni):
1937 """ GBP VXLAN tunnel del """
1938 return self.api(self.papi.gbp_vxlan_tunnel_del,
1943 def gbp_vxlan_tunnel_dump(self):
1944 """ GBP VXLAN tunnel add/del """
1945 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1947 def igmp_enable_disable(self, sw_if_index, enable, host):
1948 """ Enable/disable IGMP on a given interface """
1949 return self.api(self.papi.igmp_enable_disable,
1952 'sw_if_index': sw_if_index})
1954 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1955 """ Add/del IGMP proxy device """
1956 return self.api(self.papi.igmp_proxy_device_add_del,
1957 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1960 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1961 """ Add/del interface to/from IGMP proxy device """
1962 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1963 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1966 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1967 """ Listen for new (S,G) on specified interface
1969 :param enable: add/del
1970 :param sw_if_index: interface sw index
1971 :param saddr: source ip4 addr
1972 :param gaddr: group ip4 addr
1974 return self.api(self.papi.igmp_listen,
1979 'sw_if_index': sw_if_index,
1980 'n_srcs': len(saddrs),
1986 def igmp_clear_interface(self, sw_if_index):
1987 """ Remove all (S,G)s from specified interface
1988 doesn't send IGMP report!
1991 self.papi.igmp_clear_interface, {
1992 'sw_if_index': sw_if_index})
1994 def want_igmp_events(self, enable=1):
1995 return self.api(self.papi.want_igmp_events, {'enable': enable,
1996 'pid': os.getpid()})
2005 interface_id=0xFFFFFFFF):
2008 :param lb: load balance
2009 :param numa_only: tx on local numa node for lacp mode
2010 :param use_custom_mac: use custom mac
2011 :param mac_address: mac address
2012 :param interface_id: custom interface ID
2015 self.papi.bond_create,
2018 'numa_only': numa_only,
2019 'use_custom_mac': use_custom_mac,
2020 'mac_address': mac_address,
2024 def pipe_delete(self, parent_sw_if_index):
2025 return self.api(self.papi.pipe_delete,
2026 {'parent_sw_if_index': parent_sw_if_index})
2028 def svs_table_add_del(self, af, table_id, is_add=1):
2029 return self.api(self.papi.svs_table_add_del,
2031 'table_id': table_id,
2036 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2037 return self.api(self.papi.svs_route_add_del,
2039 'table_id': table_id,
2040 'source_table_id': src_table_id,
2045 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2046 return self.api(self.papi.svs_enable_disable,
2049 'table_id': table_id,
2050 'sw_if_index': sw_if_index,
2051 'is_enable': is_enable,
2054 def feature_gso_enable_disable(self, sw_if_index, enable_disable=1):
2055 return self.api(self.papi.feature_gso_enable_disable,
2057 'sw_if_index': sw_if_index,
2058 'enable_disable': enable_disable,