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 VPP, mac_pton
15 from vpp_l2 import L2_PORT_TYPE
16 from vpp_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID
38 class SYSLOG_SEVERITY:
50 # Dictionary keyed on message name to override default values for
54 'map_add_domain': {'mtu': 1280},
55 'syslog_set_sender': {'collector_port': 514,
57 'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
58 'acl_interface_list_dump': {'sw_if_index': 4294967295, },
59 'app_namespace_add_del': {'sw_if_index': 4294967295, },
60 'bd_ip_mac_add_del': {'is_add': 1, },
61 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
63 'bier_disp_table_add_del': {'is_add': 1, },
64 'bier_imp_add': {'is_add': 1, },
65 'bier_route_add_del': {'is_add': 1, },
66 'bier_table_add_del': {'is_add': 1, },
67 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
68 'learn': 1, 'is_add': 1, },
69 'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
70 'nbuckets': 2, 'memory_size': 2097152,
71 'next_table_index': 4294967295,
72 'miss_next_index': 4294967295, },
73 'dhcp6_client_enable_disable': {'enable': 1, },
74 'dhcp6_clients_enable_disable': {'enable': 1, },
75 'dhcp6_pd_client_enable_disable': {'enable': 1, },
76 'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
77 'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
78 'dhcp_proxy_config': {'is_add': 1, },
79 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
80 'dslite_add_del_pool_addr_range': {'is_add': 1, },
81 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
82 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
83 'decap_next_index': 4294967295, },
84 'gre_add_del_tunnel': {'instance': 4294967295, 'is_add': 1, },
85 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
86 'decap_next_index': 4294967295, },
87 'input_acl_set_interface': {'ip4_table_index': 4294967295,
88 'ip6_table_index': 4294967295,
89 'l2_table_index': 4294967295, },
90 'ip6_add_del_address_using_prefix': {'is_add': 1, },
91 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
92 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
93 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
94 'next_hop_id': 4294967295,
95 'classify_table_index': 4294967295, 'is_add': 1, },
96 'ip_mroute_add_del': {'is_add': 1, },
97 'ip_neighbor_add_del': {'is_add': 1, },
98 'ip_punt_police': {'is_add': 1, },
99 'ip_punt_redirect': {'is_add': 1, },
100 'ip_table_add_del': {'is_add': 1, },
101 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
102 'ipip_add_tunnel': {'is_ipv6': 1, 'instance': 4294967295, },
103 'ipsec_interface_add_del_spd': {'is_add': 1, },
104 'ipsec_sad_entry_add_del': {'is_add': 1, },
105 'ipsec_spd_add_del': {'is_add': 1, },
106 'ipsec_spd_dump': {'sa_id': 4294967295, },
107 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
108 'remote_port_stop': 65535, 'priority': 100,
111 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
112 'l2_emulation': {'enable': 1, },
113 'l2fib_add_del': {'is_add': 1, },
114 'lisp_add_del_adjacency': {'is_add': 1, },
115 'lisp_add_del_local_eid': {'is_add': 1, },
116 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
117 'lisp_add_del_locator_set': {'is_add': 1, },
118 'lisp_add_del_remote_mapping': {'is_add': 1, },
119 'macip_acl_add_replace': {'acl_index': 4294967295, },
120 'macip_acl_dump': {'acl_index': 4294967295, },
121 'macip_acl_interface_add_del': {'is_add': 1, },
122 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
123 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
124 'mr_next_hop_weight': 1,
125 'mr_next_hop_via_label': 1048576,
127 'mr_classify_table_index': 4294967295, },
128 'mpls_table_add_del': {'is_add': 1, },
129 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
130 'next_hop_weight': 1,
131 'next_hop_via_label': 1048576,
133 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
134 'nat44_add_del_address_range': {'is_add': 1, 'vrf_id': 4294967295, },
135 'nat44_add_del_identity_mapping': {'ip': b'0', 'sw_if_index': 4294967295,
136 'addr_only': 1, 'is_add': 1, },
137 'nat44_add_del_interface_addr': {'is_add': 1, },
138 'nat44_add_del_lb_static_mapping': {'is_add': 1, },
139 'nat44_add_del_static_mapping': {'external_sw_if_index': 4294967295,
140 'addr_only': 1, 'is_add': 1, },
141 'nat44_del_session': {'is_in': 1, },
142 'nat44_interface_add_del_feature': {'is_inside': 1, 'is_add': 1, },
143 'nat44_interface_add_del_output_feature': {'is_inside': 1, 'is_add': 1, },
144 'nat44_lb_static_mapping_add_del_local': {'is_add': 1, },
145 'nat64_add_del_interface': {'is_inside': 1, 'is_add': 1, },
146 'nat64_add_del_interface_addr': {'is_add': 1, },
147 'nat64_add_del_pool_addr_range': {'vrf_id': 4294967295, 'is_add': 1, },
148 'nat64_add_del_prefix': {'is_add': 1, },
149 'nat64_add_del_static_bib': {'is_add': 1, },
150 'nat64_bib_dump': {'protocol': 255, },
151 'nat64_st_dump': {'protocol': 255, },
152 'nat66_add_del_interface': {'is_inside': 1, 'is_add': 1, },
153 'nat66_add_del_static_mapping': {'is_add': 1, },
154 'nat_det_add_del_map': {'is_add': 1, },
155 'nat_ha_resync': {'want_resync_event': 1, },
156 'nat_ha_set_failover': {'refresh': 10, },
157 'nat_ha_set_listener': {'path_mtu': 512, },
158 'nat_ipfix_enable_disable': {'domain_id': 1, 'src_port': 4739,
160 'nat_set_mss_clamping': {'mss_value': 1500, },
161 'nat_set_reass': {'timeout': 2, 'max_reass': 1024, 'max_frag': 5, },
162 'nat_set_timeouts': {'udp': 300, 'tcp_established': 7440,
163 'tcp_transitory': 240, 'icmp': 60, },
164 'output_acl_set_interface': {'ip4_table_index': 4294967295,
165 'ip6_table_index': 4294967295,
166 'l2_table_index': 4294967295, },
167 'pppoe_add_del_session': {'is_add': 1, },
168 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
169 'proxy_arp_add_del': {'is_add': 1, },
170 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
171 'punt_socket_register': {'protocol': 17, 'header_version': 1,
173 'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, },
174 'punt_socket_dump': {'is_ip6': 1, },
175 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
177 'set_ipfix_exporter': {'collector_port': 4739, },
178 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
179 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
180 'svs_enable_disable': {'is_enable': 1, },
181 'svs_route_add_del': {'is_add': 1, },
182 'svs_table_add_del': {'is_add': 1, },
183 'sw_interface_add_del_address': {'is_add': 1, },
184 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
185 'pref_lifetime': 4294967295, },
186 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
187 'sw_interface_set_l2_bridge': {'enable': 1, },
188 'sw_interface_set_mpls_enable': {'enable': 1, },
189 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
190 'sw_interface_set_unnumbered': {'is_add': 1, },
191 'sw_interface_span_enable_disable': {'state': 1, },
192 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
193 'decap_next_index': 4294967295,
194 'instance': 4294967295, },
195 'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
196 'instance': 4294967295, },
197 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
198 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
200 'want_bfd_events': {'enable_disable': 1, },
201 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
202 'want_dhcp6_reply_events': {'enable_disable': 1, },
203 'want_igmp_events': {'enable': 1, },
204 'want_interface_events': {'enable_disable': 1, },
205 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
206 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
207 'want_ip6_ra_events': {'enable_disable': 1, },
208 'want_l2_macs_events': {'enable_disable': 1, },
212 class UnexpectedApiReturnValueError(Exception):
213 """ exception raised when the API return value is unexpected """
217 class VppPapiProvider(object):
218 """VPP-api provider using vpp-papi
220 @property hook: hook object providing before and after api/cli hooks
223 _zero, _negative = range(2)
225 def __init__(self, name, shm_prefix, test_class, read_timeout):
226 self.hook = Hook(test_class)
228 self.shm_prefix = shm_prefix
229 self.test_class = test_class
230 self._expect_api_retval = self._zero
231 self._expect_stack = []
233 install_dir = os.getenv('VPP_INSTALL_PATH')
235 # Vapi requires 'VPP_API_DIR', not set when run from Makefile.
236 if 'VPP_API_DIR' not in os.environ:
237 os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH')
239 self.vpp = VPP(logger=test_class.logger,
240 read_timeout=read_timeout)
241 self._events = deque()
246 def assert_negative_api_retval(self):
247 """ Expect API failure - used with with, e.g.:
248 with self.vapi.assert_negative_api_retval():
249 self.vapi.<api call expected to fail>
251 self._expect_stack.append(self._expect_api_retval)
252 self._expect_api_retval = self._negative
255 def assert_zero_api_retval(self):
256 """ Expect API success - used with with, e.g.:
257 with self.vapi.assert_negative_api_retval():
258 self.vapi.<api call expected to succeed>
260 note: this is useful only inside another with block
261 as success is the default expected value
263 self._expect_stack.append(self._expect_api_retval)
264 self._expect_api_retval = self._zero
267 def __exit__(self, exc_type, exc_value, traceback):
268 self._expect_api_retval = self._expect_stack.pop()
270 def register_hook(self, hook):
271 """Replace hook registration with new hook
278 def collect_events(self):
279 """ Collect all events from the internal queue and clear the queue. """
281 self._events = deque()
284 def wait_for_event(self, timeout, name=None):
285 """ Wait for and return next event. """
287 self.test_class.logger.debug("Expecting event '%s' within %ss",
290 self.test_class.logger.debug("Expecting event within %ss",
293 self.test_class.logger.debug("Not waiting, event already queued")
294 limit = time.time() + timeout
295 while time.time() < limit:
297 e = self._events.popleft()
298 if name and type(e).__name__ != name:
300 "Unexpected event received: %s, expected: %s" %
301 (type(e).__name__, name))
302 self.test_class.logger.debug("Returning event %s:%s" %
305 self.test_class.sleep(0) # yield
306 raise Exception("Event did not occur within timeout")
308 def __call__(self, name, event):
309 """ Enqueue event in the internal event queue. """
310 # FIXME use the name instead of relying on type(e).__name__ ?
311 # FIXME #2 if this throws, it is eaten silently, Ole?
312 self.test_class.logger.debug("New event: %s: %s" % (name, event))
313 self._events.append(event)
315 def factory(self, name, apifn):
317 fields = apifn._func.msg.fields
319 # add positional and kw arguments
321 for i, o in enumerate(fields[3:]):
328 if name in defaultmapping:
329 for k, v in iteritems(defaultmapping[name]):
333 return self.api(apifn, d)
337 def __getattribute__(self, name):
339 method = super(VppPapiProvider, self).__getattribute__(name)
340 except AttributeError:
341 method = self.factory(name, getattr(self.papi, name))
342 # lazily load the method so we don't need to call factory
343 # again for this name.
344 setattr(self, name, method)
348 """Connect the API to VPP"""
349 self.vpp.connect(self.name, self.shm_prefix)
350 self.papi = self.vpp.api
351 self.vpp.register_event_callback(self)
353 def disconnect(self):
354 """Disconnect the API from VPP"""
355 self.vpp.disconnect()
357 def api(self, api_fn, api_args, expected_retval=0):
358 """ Call API function and check it's return value.
359 Call the appropriate hooks before and after the API call
361 :param api_fn: API function to call
362 :param api_args: tuple of API function arguments
363 :param expected_retval: Expected return value (Default value = 0)
364 :returns: reply from the API
367 self.hook.before_api(api_fn.__name__, api_args)
368 reply = api_fn(**api_args)
369 if self._expect_api_retval == self._negative:
370 if hasattr(reply, 'retval') and reply.retval >= 0:
371 msg = "API call passed unexpectedly: expected negative " \
372 "return value instead of %d in %s" % \
373 (reply.retval, moves.reprlib.repr(reply))
374 self.test_class.logger.info(msg)
375 raise UnexpectedApiReturnValueError(msg)
376 elif self._expect_api_retval == self._zero:
377 if hasattr(reply, 'retval') and reply.retval != expected_retval:
378 msg = "API call failed, expected %d return value instead " \
379 "of %d in %s" % (expected_retval, reply.retval,
380 moves.reprlib.repr(reply))
381 self.test_class.logger.info(msg)
382 raise UnexpectedApiReturnValueError(msg)
384 raise Exception("Internal error, unexpected value for "
385 "self._expect_api_retval %s" %
386 self._expect_api_retval)
387 self.hook.after_api(api_fn.__name__, api_args)
391 """ Execute a CLI, calling the before/after hooks appropriately.
393 :param cli: CLI to execute
397 self.hook.before_cli(cli)
399 r = self.papi.cli_inband(cmd=cli)
400 self.hook.after_cli(cli)
401 if hasattr(r, 'reply'):
404 def ppcli(self, cli):
405 """ Helper method to print CLI command in case of info logging level.
407 :param cli: CLI to execute
410 return cli + "\n" + str(self.cli(cli))
412 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
413 return self.api(self.papi.want_ip4_arp_events,
414 {'enable_disable': enable_disable,
416 'pid': os.getpid(), })
418 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
419 return self.api(self.papi.want_ip6_nd_events,
420 {'enable_disable': enable_disable,
422 'pid': os.getpid(), })
424 def want_ip6_ra_events(self, enable_disable=1):
425 return self.api(self.papi.want_ip6_ra_events,
426 {'enable_disable': enable_disable,
427 'pid': os.getpid(), })
429 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
431 return self.api(self.papi.ip6nd_send_router_solicitation,
436 'sw_if_index': sw_if_index})
438 def want_interface_events(self, enable_disable=1):
439 return self.api(self.papi.want_interface_events,
440 {'enable_disable': enable_disable,
441 'pid': os.getpid(), })
443 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
444 max_macs_in_event=0, learn_limit=0):
445 return self.api(self.papi.want_l2_macs_events,
446 {'enable_disable': enable_disable,
447 'scan_delay': scan_delay,
448 'max_macs_in_event': max_macs_in_event,
449 'learn_limit': learn_limit,
450 'pid': os.getpid(), })
452 def want_dhcp6_reply_events(self, enable_disable=1):
453 return self.api(self.papi.want_dhcp6_reply_events,
454 {'enable_disable': enable_disable,
457 def want_dhcp6_pd_reply_events(self, enable_disable=1):
458 return self.api(self.papi.want_dhcp6_pd_reply_events,
459 {'enable_disable': enable_disable,
462 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
463 prefixes, server_index=0xFFFFFFFF,
464 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
466 return self.api(self.papi.dhcp6_pd_send_client_message,
467 {'sw_if_index': sw_if_index,
468 'server_index': server_index,
474 'msg_type': msg_type,
477 'n_prefixes': len(prefixes),
478 'prefixes': prefixes})
480 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
482 return self.api(self.papi.dhcp6_client_enable_disable,
483 {'sw_if_index': sw_if_index,
486 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
488 return self.api(self.papi.dhcp6_pd_client_enable_disable,
489 {'sw_if_index': sw_if_index,
490 'prefix_group': prefix_group,
493 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
494 prefix_length, prefix_group,
496 return self.api(self.papi.ip6_add_del_address_using_prefix,
497 {'sw_if_index': sw_if_index,
498 'prefix_group': prefix_group,
500 'prefix_length': prefix_length,
503 def sw_interface_set_mac_address(self, sw_if_index, mac):
504 return self.api(self.papi.sw_interface_set_mac_address,
505 {'sw_if_index': sw_if_index,
508 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
509 """Create p2p ethernet subinterface
511 :param sw_if_index: main (parent) interface
512 :param remote_mac: client (remote) mac address
516 self.papi.p2p_ethernet_add,
517 {'parent_if_index': sw_if_index,
518 'remote_mac': remote_mac,
519 'subif_id': subif_id})
521 def p2p_ethernet_del(self, sw_if_index, remote_mac):
522 """Delete p2p ethernet subinterface
524 :param sw_if_index: main (parent) interface
525 :param remote_mac: client (remote) mac address
529 self.papi.p2p_ethernet_del,
530 {'parent_if_index': sw_if_index,
531 'remote_mac': remote_mac})
533 def create_vlan_subif(self, sw_if_index, vlan):
540 return self.api(self.papi.create_vlan_subif,
541 {'sw_if_index': sw_if_index,
544 def create_loopback(self, mac=''):
547 :param mac: (Optional)
549 return self.api(self.papi.create_loopback,
550 {'mac_address': mac})
552 def ip_neighbor_add_del(self,
558 """ Add neighbor MAC to IPv4 or IPv6 address.
563 :param is_add: (Default value = 1)
564 :param flags: (Default value = 0/NONE)
567 self.papi.ip_neighbor_add_del,
571 'sw_if_index': sw_if_index,
573 'mac_address': mac_address,
574 'ip_address': ip_address
579 def proxy_arp_add_del(self,
584 """ Config Proxy Arp Range.
586 :param low_address: Start address in the rnage to Proxy for
587 :param hi_address: End address in the rnage to Proxy for
588 :param vrf_id: The VRF/table in which to proxy
592 self.papi.proxy_arp_add_del,
595 'table_id': table_id,
601 def proxy_arp_intfc_enable_disable(self,
604 """ Enable/Disable an interface for proxy ARP requests
606 :param sw_if_index: Interface
607 :param enable_disable: Enable/Disable
611 self.papi.proxy_arp_intfc_enable_disable,
612 {'sw_if_index': sw_if_index,
613 'enable_disable': is_enable
617 def gre_add_del_tunnel(self,
630 :param outer_fib_id: (Default value = 0)
631 :param tunnel_type: (Default value = 0)
632 :param instance: (Default value = 0xFFFFFFFF)
633 :param session_id: (Defalt value = 0)
634 :param is_add: (Default value = 1)
635 :param is_ipv6: (Default value = 0)
639 self.papi.gre_add_del_tunnel,
642 'tunnel_type': tunnel_type,
643 'instance': instance,
644 'src_address': src_address,
645 'dst_address': dst_address,
646 'outer_fib_id': outer_fib_id,
647 'session_id': session_id}
650 def udp_encap_add(self,
661 :param outer_fib_id: (Default value = 0)
665 self.papi.udp_encap_add,
670 'src_port': src_port,
671 'dst_port': dst_port,
676 def mpls_table_add_del(
683 :param is_add: (Default value = 1)
688 self.papi.mpls_table_add_del,
689 {'mt_table_id': table_id,
690 'mt_is_add': is_add})
692 def mpls_ip_bind_unbind(
704 self.papi.mpls_ip_bind_unbind,
705 {'mb_mpls_table_id': table_id,
707 'mb_ip_table_id': ip_table_id,
708 'mb_is_bind': is_bind,
710 'mb_address_length': dst_address_length,
711 'mb_address': dst_address})
713 def mpls_tunnel_add_del(
716 next_hop_proto_is_ip4,
718 next_hop_sw_if_index=0xFFFFFFFF,
721 next_hop_n_out_labels=0,
722 next_hop_out_label_stack=[],
723 next_hop_via_label=MPLS_LABEL_INVALID,
729 :param dst_address_length:
730 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
732 :param next_hop_address:
733 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
734 :param vrf_id: (Default value = 0)
735 :param lookup_in_vrf: (Default value = 0)
736 :param classify_table_index: (Default value = 0xFFFFFFFF)
737 :param is_add: (Default value = 1)
738 :param is_drop: (Default value = 0)
739 :param is_ipv6: (Default value = 0)
740 :param is_local: (Default value = 0)
741 :param is_classify: (Default value = 0)
742 :param is_multipath: (Default value = 0)
743 :param is_resolve_host: (Default value = 0)
744 :param is_resolve_attached: (Default value = 0)
745 :param next_hop_weight: (Default value = 1)
746 :param is_multicast: (Default value = 0)
750 self.papi.mpls_tunnel_add_del,
751 {'mt_sw_if_index': tun_sw_if_index,
753 'mt_l2_only': l2_only,
754 'mt_is_multicast': is_multicast,
755 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
756 'mt_next_hop_weight': next_hop_weight,
757 'mt_next_hop': next_hop_address,
758 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
759 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
760 'mt_next_hop_table_id': next_hop_table_id,
761 'mt_next_hop_via_label': next_hop_via_label,
762 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
764 def nat44_interface_add_del_feature(
769 """Enable/disable NAT44 feature on the interface
771 :param sw_if_index: Software index of the interface
772 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
773 :param is_add: 1 if add, 0 if delete (Default value = 1)
776 self.papi.nat44_interface_add_del_feature,
778 'is_inside': is_inside,
779 'sw_if_index': sw_if_index})
781 def nat44_interface_add_del_output_feature(
786 """Enable/disable NAT44 output feature on the interface
788 :param sw_if_index: Software index of the interface
789 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
790 :param is_add: 1 if add, 0 if delete (Default value = 1)
793 self.papi.nat44_interface_add_del_output_feature,
795 'is_inside': is_inside,
796 'sw_if_index': sw_if_index})
798 def nat44_add_del_static_mapping(
802 external_sw_if_index=0xFFFFFFFF,
813 """Add/delete NAT44 static mapping
815 :param local_ip: Local IP address
816 :param external_ip: External IP address
817 :param external_sw_if_index: External interface instead of IP address
818 :param local_port: Local port number (Default value = 0)
819 :param external_port: External port number (Default value = 0)
820 :param addr_only: 1 if address only mapping, 0 if address and port
821 :param vrf_id: VRF ID
822 :param protocol: IP protocol (Default value = 0)
823 :param twice_nat: 1 if translate external host address and port
824 :param self_twice_nat: 1 if translate external host address and port
825 whenever external host address equals
826 local address of internal host
827 :param out2in_only: if 1 rule is matching only out2in direction
828 :param tag: Opaque string tag
829 :param is_add: 1 if add, 0 if delete (Default value = 1)
832 self.papi.nat44_add_del_static_mapping,
834 'addr_only': addr_only,
835 'local_ip_address': local_ip,
836 'external_ip_address': external_ip,
837 'local_port': local_port,
838 'external_port': external_port,
839 'external_sw_if_index': external_sw_if_index,
841 'protocol': protocol,
842 'twice_nat': twice_nat,
843 'self_twice_nat': self_twice_nat,
844 'out2in_only': out2in_only,
847 def nat44_add_del_identity_mapping(
850 sw_if_index=0xFFFFFFFF,
857 """Add/delete NAT44 identity mapping
859 :param ip: IP address (Default value = 0)
860 :param sw_if_index: Interface instead of IP address
861 :param port: Port number (Default value = 0)
862 :param addr_only: 1 if address only mapping, 0 if address and port
863 :param vrf_id: VRF ID
864 :param protocol: IP protocol (Default value = 0)
865 :param tag: Opaque string tag
866 :param is_add: 1 if add, 0 if delete (Default value = 1)
869 self.papi.nat44_add_del_identity_mapping,
871 'addr_only': addr_only,
874 'sw_if_index': sw_if_index,
877 'protocol': protocol})
879 def nat44_add_del_address_range(
886 """Add/del NAT44 address range
888 :param first_ip_address: First IP address
889 :param last_ip_address: Last IP address
890 :param vrf_id: VRF id for the address range
891 :param twice_nat: twice NAT address for extenal hosts
892 :param is_add: 1 if add, 0 if delete (Default value = 1)
895 self.papi.nat44_add_del_address_range,
896 {'first_ip_address': first_ip_address,
897 'last_ip_address': last_ip_address,
899 'twice_nat': twice_nat,
902 def nat44_add_del_interface_addr(
907 """Add/del NAT44 address from interface
909 :param sw_if_index: Software index of the interface
910 :param twice_nat: twice NAT address for extenal hosts
911 :param is_add: 1 if add, 0 if delete (Default value = 1)
914 self.papi.nat44_add_del_interface_addr,
916 'sw_if_index': sw_if_index,
917 'twice_nat': twice_nat})
919 def nat44_add_del_lb_static_mapping(
932 """Add/delete NAT44 load balancing static mapping
934 :param twice_nat: 1 if translate external host address and port
935 :param tag: Opaque string tag
936 :param affinity: if 0 disabled, otherwise client IP affinity timeout
937 :param is_add - 1 if add, 0 if delete
940 self.papi.nat44_add_del_lb_static_mapping,
942 'external_addr': external_addr,
943 'external_port': external_port,
944 'protocol': protocol,
945 'twice_nat': twice_nat,
946 'self_twice_nat': self_twice_nat,
947 'out2in_only': out2in_only,
949 'affinity': affinity,
950 'local_num': local_num,
953 def nat44_lb_static_mapping_add_del_local(
963 """Add/delete NAT44 load-balancing static mapping rule backend
965 :param external_addr: external IPv4 address of the servic
966 :param external_port: external L4 port number of the service
967 :param local_addr: IPv4 address of the internal node
968 :param local_port: L4 port number of the internal node
969 :param protocol: IP protocol number
970 :param probability: probability of the internal node
971 :param vrf_id: VRF id of the internal node
972 :param is_add: 1 if add, 0 if delete
975 self.papi.nat44_lb_static_mapping_add_del_local,
977 'external_addr': external_addr,
978 'external_port': external_port,
982 'probability': probability,
984 'protocol': protocol})
986 def nat44_del_session(
993 ext_host_address=None,
995 """Delete NAT44 session
997 :param addr: IPv4 address
998 :param por: port number
999 :param protocol: IP protocol number
1000 :param vrf_id: VRF ID
1001 :param is_in: 1 if inside network addres and port pari, 0 if outside
1002 :param ext_host_address: external host IPv4 address
1003 :param ext_host_port: external host port
1005 if ext_host_address is None:
1007 self.papi.nat44_del_session,
1010 'protocol': protocol,
1015 self.papi.nat44_del_session,
1018 'protocol': protocol,
1021 'ext_host_valid': 1,
1022 'ext_host_address': ext_host_address,
1023 'ext_host_port': ext_host_port})
1025 def nat44_forwarding_enable_disable(
1028 """Enable/disable forwarding for NAT44
1030 :param enable: 1 for enable, 0 for disable
1033 self.papi.nat44_forwarding_enable_disable,
1036 def nat_det_add_del_map(
1043 """Add/delete deterministic NAT mapping
1045 :param is_add - 1 if add, 0 if delete
1046 :param in_addr - inside IP address
1047 :param in_plen - inside IP address prefix length
1048 :param out_addr - outside IP address
1049 :param out_plen - outside IP address prefix length
1052 self.papi.nat_det_add_del_map,
1057 'out_addr': out_addr,
1058 'out_plen': out_plen})
1060 def nat_det_forward(
1063 """Get outside address and port range from inside address
1065 :param in_addr - inside IP address
1068 self.papi.nat_det_forward,
1069 {'in_addr': in_addr,
1072 def nat_det_reverse(
1076 """Get inside address from outside address and port
1078 :param out_addr - outside IP address
1079 :param out_port - outside port
1082 self.papi.nat_det_reverse,
1083 {'out_addr': out_addr,
1084 'out_port': out_port})
1086 def nat_det_map_dump(self):
1087 """Dump deterministic NAT mappings
1089 :return: Dictionary of deterministic NAT mappings
1091 return self.api(self.papi.nat_det_map_dump, {})
1093 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1094 """Set TCP MSS rewriting configuration
1096 :param enable: disable(0)/enable(1) MSS rewriting feature
1097 :param mss_value: MSS value to be used for MSS rewriting
1100 self.papi.nat_set_mss_clamping,
1101 {'enable': enable, 'mss_value': mss_value})
1103 def nat_det_close_session_in(
1109 """Close deterministic NAT session using inside address and port
1111 :param in_addr - inside IP address
1112 :param in_port - inside port
1113 :param ext_addr - external host IP address
1114 :param ext_port - external host port
1117 self.papi.nat_det_close_session_in,
1118 {'in_addr': in_addr,
1120 'ext_addr': ext_addr,
1121 'ext_port': ext_port,
1124 def nat_det_session_dump(
1127 """Dump deterministic NAT sessions belonging to a user
1129 :param user_addr - inside IP address of the user
1130 :return: Dictionary of deterministic NAT sessions
1133 self.papi.nat_det_session_dump,
1135 'user_addr': user_addr})
1137 def nat64_add_del_interface(
1142 """Enable/disable NAT64 feature on the interface
1143 :param sw_if_index: Index of the interface
1144 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1145 :param is_add: 1 if add, 0 if delete (Default value = 1)
1148 self.papi.nat64_add_del_interface,
1149 {'sw_if_index': sw_if_index,
1150 'is_inside': is_inside,
1153 def nat64_add_del_static_bib(
1162 """Add/delete S-NAT static BIB entry
1164 :param in_ip: Inside IPv6 address
1165 :param out_ip: Outside IPv4 address
1166 :param in_port: Inside port number
1167 :param out_port: Outside port number
1168 :param protocol: IP protocol
1169 :param vrf_id: VRF ID (Default value = 0)
1170 :param is_add: 1 if add, 0 if delete (Default value = 1)
1173 self.papi.nat64_add_del_static_bib,
1182 def nat64_bib_dump(self, protocol=255):
1185 :param protocol: IP protocol (Default value = 255, all BIBs)
1186 :returns: Dictionary of NAT64 BIB entries
1188 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1190 def nat64_st_dump(self, protocol=255):
1191 """Dump NAT64 session table
1193 :param protocol: IP protocol (Default value = 255, all STs)
1194 :returns: Dictionary of NAT64 sesstion table entries
1196 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1198 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1199 """Add/del NAT64 prefix
1201 :param prefix: NAT64 prefix
1202 :param plen: NAT64 prefix length
1203 :param vrf_id: VRF id of tenant (Default 0)
1204 :param is_add: 1 if add, 0 if delete (Default value = 1)
1207 self.papi.nat64_add_del_prefix,
1213 def nat64_add_del_interface_addr(
1217 """Add/del NAT64 address from interface
1219 :param sw_if_index: Software index of the interface
1220 :param is_add: 1 if add, 0 if delete (Default value = 1)
1222 return self.api(self.papi.nat64_add_del_interface_addr,
1223 {'is_add': is_add, 'sw_if_index': sw_if_index})
1225 def dslite_set_aftr_addr(self, ip6, ip4):
1226 """Set DS-Lite AFTR addresses
1228 :param ip4: IPv4 address
1229 :param ip6: IPv6 address
1232 self.papi.dslite_set_aftr_addr,
1236 def dslite_set_b4_addr(self, ip6, ip4):
1237 """Set DS-Lite B4 IPv6 address
1239 :param ip4: IPv4 address
1240 :param ip6: IPv6 address
1243 self.papi.dslite_set_b4_addr,
1247 def nat66_add_del_interface(
1252 """Enable/disable NAT66 feature on the interface
1253 :param sw_if_index: Index of the interface
1254 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1255 :param is_add: 1 if add, 0 if delete (Default value = 1)
1258 self.papi.nat66_add_del_interface,
1259 {'sw_if_index': sw_if_index,
1260 'is_inside': is_inside,
1263 def nat66_add_del_static_mapping(
1269 """Add/delete NAT66 static mapping
1271 :param in_ip: Inside IPv6 address
1272 :param out_ip: Outside IPv6 address
1273 :param vrf_id: VRF ID (Default value = 0)
1274 :param is_add: 1 if add, 0 if delete (Default value = 1)
1277 self.papi.nat66_add_del_static_mapping,
1278 {'local_ip_address': in_ip,
1279 'external_ip_address': out_ip,
1283 def nat_ha_set_listener(self, addr, port, path_mtu=512):
1284 """Set HA listener (local settings)
1286 :param addr: local IP4 address
1287 :param port: local UDP port number
1288 :param path_mtu: path MTU (Default value = 512)
1290 return self.api(self.papi.nat_ha_set_listener,
1291 {'ip_address': addr,
1293 'path_mtu': path_mtu})
1295 def nat_ha_get_listener(self):
1296 """Get HA listener/local configuration"""
1297 return self.api(self.papi.nat_ha_get_listener, {})
1299 def nat_ha_set_failover(self, addr, port, refresh=10):
1300 """Set HA failover (remote settings)
1302 :param addr: failover IP4 address
1303 :param port: failvoer UDP port number
1304 :param refresh: number of seconds after which to send session refresh
1306 return self.api(self.papi.nat_ha_set_failover,
1307 {'ip_address': addr,
1309 'session_refresh_interval': refresh})
1311 def nat_ha_resync(self, want_resync_event=1):
1312 """Resync HA (resend existing sessions to new failover)
1313 :param want_resync_event: if non-zero resync completed event sent
1315 return self.api(self.papi.nat_ha_resync,
1316 {'want_resync_event': want_resync_event,
1317 'pid': os.getpid()})
1319 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1320 detect_mult, local_addr, peer_addr, is_ipv6=0,
1321 bfd_key_id=None, conf_key_id=None):
1322 if bfd_key_id is None:
1323 return self.api(self.papi.bfd_udp_add,
1325 'sw_if_index': sw_if_index,
1326 'desired_min_tx': desired_min_tx,
1327 'required_min_rx': required_min_rx,
1328 'local_addr': local_addr,
1329 'peer_addr': peer_addr,
1331 'detect_mult': detect_mult,
1334 return self.api(self.papi.bfd_udp_add,
1336 'sw_if_index': sw_if_index,
1337 'desired_min_tx': desired_min_tx,
1338 'required_min_rx': required_min_rx,
1339 'local_addr': local_addr,
1340 'peer_addr': peer_addr,
1342 'detect_mult': detect_mult,
1343 'is_authenticated': 1,
1344 'bfd_key_id': bfd_key_id,
1345 'conf_key_id': conf_key_id,
1348 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1349 detect_mult, local_addr, peer_addr, is_ipv6=0):
1350 return self.api(self.papi.bfd_udp_mod,
1352 'sw_if_index': sw_if_index,
1353 'desired_min_tx': desired_min_tx,
1354 'required_min_rx': required_min_rx,
1355 'local_addr': local_addr,
1356 'peer_addr': peer_addr,
1358 'detect_mult': detect_mult,
1361 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1362 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1364 return self.api(self.papi.bfd_udp_auth_activate,
1366 'sw_if_index': sw_if_index,
1367 'local_addr': local_addr,
1368 'peer_addr': peer_addr,
1370 'is_delayed': 1 if is_delayed else 0,
1371 'bfd_key_id': bfd_key_id,
1372 'conf_key_id': conf_key_id,
1375 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1376 peer_addr, is_ipv6=0):
1377 return self.api(self.papi.bfd_udp_session_set_flags, {
1378 'admin_up_down': admin_up_down,
1379 'sw_if_index': sw_if_index,
1380 'local_addr': local_addr,
1381 'peer_addr': peer_addr,
1385 def want_bfd_events(self, enable_disable=1):
1386 return self.api(self.papi.want_bfd_events, {
1387 'enable_disable': enable_disable,
1391 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1392 return self.api(self.papi.bfd_auth_set_key, {
1393 'conf_key_id': conf_key_id,
1394 'auth_type': auth_type,
1396 'key_len': len(key),
1399 def classify_add_del_table(
1404 table_index=0xFFFFFFFF,
1406 memory_size=2097152,
1408 next_table_index=0xFFFFFFFF,
1409 miss_next_index=0xFFFFFFFF,
1410 current_data_flag=0,
1411 current_data_offset=0):
1415 :param match_n_vectors: (Default value = 1)
1416 :param table_index: (Default value = 0xFFFFFFFF)
1417 :param nbuckets: (Default value = 2)
1418 :param memory_size: (Default value = 2097152)
1419 :param skip_n_vectors: (Default value = 0)
1420 :param next_table_index: (Default value = 0xFFFFFFFF)
1421 :param miss_next_index: (Default value = 0xFFFFFFFF)
1422 :param current_data_flag: (Default value = 0)
1423 :param current_data_offset: (Default value = 0)
1426 mask_len = ((len(mask) - 1) / 16 + 1) * 16
1427 mask = mask + '\0' * (mask_len - len(mask))
1429 self.papi.classify_add_del_table,
1431 'table_index': table_index,
1432 'nbuckets': nbuckets,
1433 'memory_size': memory_size,
1434 'skip_n_vectors': skip_n_vectors,
1435 'match_n_vectors': match_n_vectors,
1436 'next_table_index': next_table_index,
1437 'miss_next_index': miss_next_index,
1438 'current_data_flag': current_data_flag,
1439 'current_data_offset': current_data_offset,
1440 'mask_len': mask_len,
1443 def classify_add_del_session(
1448 opaque_index=0xFFFFFFFF,
1449 hit_next_index=0xFFFFFFFF,
1457 :param opaque_index: (Default value = 0xFFFFFFFF)
1458 :param hit_next_index: (Default value = 0xFFFFFFFF)
1459 :param advance: (Default value = 0)
1460 :param action: (Default value = 0)
1461 :param metadata: (Default value = 0)
1464 match_len = ((len(match) - 1) / 16 + 1) * 16
1465 match = match + '\0' * (match_len - len(match))
1467 self.papi.classify_add_del_session,
1469 'table_index': table_index,
1470 'hit_next_index': hit_next_index,
1471 'opaque_index': opaque_index,
1474 'metadata': metadata,
1475 'match_len': match_len,
1478 def input_acl_set_interface(
1482 ip4_table_index=0xFFFFFFFF,
1483 ip6_table_index=0xFFFFFFFF,
1484 l2_table_index=0xFFFFFFFF):
1488 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1489 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1490 :param l2_table_index: (Default value = 0xFFFFFFFF)
1494 self.papi.input_acl_set_interface,
1495 {'sw_if_index': sw_if_index,
1496 'ip4_table_index': ip4_table_index,
1497 'ip6_table_index': ip6_table_index,
1498 'l2_table_index': l2_table_index,
1501 def output_acl_set_interface(
1505 ip4_table_index=0xFFFFFFFF,
1506 ip6_table_index=0xFFFFFFFF,
1507 l2_table_index=0xFFFFFFFF):
1511 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1512 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1513 :param l2_table_index: (Default value = 0xFFFFFFFF)
1517 self.papi.output_acl_set_interface,
1518 {'sw_if_index': sw_if_index,
1519 'ip4_table_index': ip4_table_index,
1520 'ip6_table_index': ip6_table_index,
1521 'l2_table_index': l2_table_index,
1524 def set_ipfix_exporter(
1531 collector_port=4739,
1534 self.papi.set_ipfix_exporter,
1536 'collector_address': collector_address,
1537 'collector_port': collector_port,
1538 'src_address': src_address,
1540 'path_mtu': path_mtu,
1541 'template_interval': template_interval,
1542 'udp_checksum': udp_checksum,
1545 def dhcp_proxy_config(self,
1553 self.papi.dhcp_proxy_config,
1555 'rx_vrf_id': rx_table_id,
1556 'server_vrf_id': server_table_id,
1559 'dhcp_server': dhcp_server,
1560 'dhcp_src_address': dhcp_src_address,
1563 def dhcp_proxy_set_vss(self,
1572 self.papi.dhcp_proxy_set_vss,
1575 'vss_type': vss_type,
1576 'vpn_ascii_id': vpn_ascii_id,
1578 'vpn_index': vpn_index,
1583 def dhcp_client_config(self,
1588 set_broadcast_flag=1,
1589 want_dhcp_events=0):
1591 self.papi.dhcp_client_config,
1595 'sw_if_index': sw_if_index,
1596 'hostname': hostname,
1598 'want_dhcp_event': want_dhcp_events,
1599 'set_broadcast_flag': set_broadcast_flag,
1603 def ip_mroute_add_del(self,
1609 next_hop_sw_if_index,
1619 IP Multicast Route add/del
1622 self.papi.ip_mroute_add_del,
1623 {'next_hop_sw_if_index': next_hop_sw_if_index,
1624 'entry_flags': e_flags,
1625 'itf_flags': i_flags,
1626 'table_id': table_id,
1630 'is_local': is_local,
1631 'bier_imp': bier_imp,
1632 'next_hop_afi': next_hop_afi,
1633 'grp_address_length': grp_address_length,
1634 'grp_address': grp_address,
1635 'src_address': src_address,
1636 'nh_address': next_hop_address})
1638 def lisp_enable_disable(self, is_enabled):
1640 self.papi.lisp_enable_disable,
1642 'is_en': is_enabled,
1645 def lisp_add_del_locator_set(self,
1649 self.papi.lisp_add_del_locator_set,
1652 'locator_set_name': ls_name
1655 def lisp_add_del_locator(self,
1662 self.papi.lisp_add_del_locator,
1665 'locator_set_name': ls_name,
1666 'sw_if_index': sw_if_index,
1667 'priority': priority,
1671 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1673 self.papi.lisp_locator_dump,
1675 'is_index_set': is_index_set,
1677 'ls_index': ls_index,
1680 def lisp_add_del_local_eid(self,
1690 self.papi.lisp_add_del_local_eid,
1692 'locator_set_name': ls_name,
1694 'eid_type': eid_type,
1696 'prefix_len': prefix_len,
1702 def lisp_eid_table_dump(self,
1710 self.papi.lisp_eid_table_dump,
1713 'prefix_length': prefix_length,
1715 'eid_type': eid_type,
1717 'filter': filter_opt,
1720 def lisp_add_del_remote_mapping(self,
1730 self.papi.lisp_add_del_remote_mapping,
1733 'eid_type': eid_type,
1735 'eid_len': eid_prefix_len,
1736 'rloc_num': rlocs_num,
1739 'is_src_dst': is_src_dst,
1742 def lisp_add_del_adjacency(self,
1751 self.papi.lisp_add_del_adjacency,
1755 'eid_type': eid_type,
1758 'leid_len': leid_len,
1759 'reid_len': reid_len,
1762 def gtpu_add_del_tunnel(
1768 mcast_sw_if_index=0xFFFFFFFF,
1770 decap_next_index=0xFFFFFFFF,
1774 :param is_add: (Default value = 1)
1775 :param is_ipv6: (Default value = 0)
1778 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1779 :param encap_vrf_id: (Default value = 0)
1780 :param decap_next_index: (Default value = 0xFFFFFFFF)
1781 :param teid: (Default value = 0)
1784 return self.api(self.papi.gtpu_add_del_tunnel,
1787 'src_address': src_addr,
1788 'dst_address': dst_addr,
1789 'mcast_sw_if_index': mcast_sw_if_index,
1790 'encap_vrf_id': encap_vrf_id,
1791 'decap_next_index': decap_next_index,
1794 def vxlan_gpe_add_del_tunnel(
1798 mcast_sw_if_index=0xFFFFFFFF,
1809 :param is_add: (Default value = 1)
1810 :param is_ipv6: (Default value = 0)
1811 :param encap_vrf_id: (Default value = 0)
1812 :param decap_vrf_id: (Default value = 0)
1813 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1814 :param protocol: (Default value = 3)
1815 :param vni: (Default value = 0)
1818 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1823 'mcast_sw_if_index': mcast_sw_if_index,
1824 'encap_vrf_id': encap_vrf_id,
1825 'decap_vrf_id': decap_vrf_id,
1826 'protocol': protocol,
1829 def vxlan_gbp_tunnel_add_del(
1833 mcast_sw_if_index=0xFFFFFFFF,
1838 instance=0xFFFFFFFF):
1843 :param is_add: (Default value = 1)
1844 :param is_ipv6: (Default value = 0)
1845 :param encap_table_id: (Default value = 0)
1846 :param decap_next_index: (Default value = 0xFFFFFFFF)
1847 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1848 :param vni: (Default value = 0)
1849 :param instance: (Default value = 0xFFFFFFFF)
1852 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
1857 'mcast_sw_if_index': mcast_sw_if_index,
1858 'encap_table_id': encap_table_id,
1860 'instance': instance}})
1862 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1863 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1864 {'sw_if_index': sw_if_index,
1865 '_no_type_conversion': True})
1867 def pppoe_add_del_session(
1877 :param is_add: (Default value = 1)
1878 :param is_ipv6: (Default value = 0)
1880 :param session_id: (Default value = 0)
1882 :param decap_vrf_id: (Default value = 0)
1885 return self.api(self.papi.pppoe_add_del_session,
1888 'session_id': session_id,
1889 'client_ip': client_ip,
1890 'decap_vrf_id': decap_vrf_id,
1891 'client_mac': client_mac})
1893 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1894 return self.api(self.papi.sr_mpls_policy_add,
1898 'n_segments': len(segments),
1899 'segments': segments})
1901 def sr_mpls_policy_del(self, bsid):
1902 return self.api(self.papi.sr_mpls_policy_del,
1905 def sr_localsid_add_del(self,
1912 sw_if_index=0xFFFFFFFF,
1916 """ Add/del IPv6 SR local-SID.
1919 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1920 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1923 :param is_del: (Default value = 0)
1924 :param end_psp: (Default value = 0)
1925 :param sw_if_index: (Default value = 0xFFFFFFFF)
1926 :param vlan_index: (Default value = 0)
1927 :param fib_table: (Default value = 0)
1930 self.papi.sr_localsid_add_del,
1932 'localsid': localsid,
1934 'behavior': behavior,
1935 'sw_if_index': sw_if_index,
1936 'vlan_index': vlan_index,
1937 'fib_table': fib_table,
1938 'nh_addr4': nh_addr4,
1939 'nh_addr6': nh_addr6
1953 :param bsid_addr: bindingSID of the SR Policy
1954 :param weight: weight of the sid list. optional. (default: 1)
1955 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1957 :param type: type/behavior of the SR policy. (default or spray) \
1959 :param fib_table: VRF where to install the FIB entry for the BSID \
1961 :param n_segments: number of segments \
1963 :param segments: a vector of IPv6 address composing the segment list \
1967 self.papi.sr_policy_add,
1968 {'bsid_addr': bsid_addr,
1970 'is_encap': is_encap,
1972 'fib_table': fib_table,
1973 'n_segments': n_segments,
1974 'segments': segments
1983 :param bsid: bindingSID of the SR Policy
1984 :param sr_policy_index: index of the sr policy (default: 0)
1987 self.papi.sr_policy_del,
1988 {'bsid_addr': bsid_addr,
1989 'sr_policy_index': sr_policy_index
1992 def sr_steering_add_del(
2003 Steer traffic L2 and L3 traffic through a given SR policy
2005 :param is_del: delete or add
2006 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2007 :param sr_policy: is the index of the SR Policy (alt to bsid)
2008 :param table_id: is the VRF where to install the FIB entry for the BSID
2009 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2010 :param mask_width: is the mask for L3 traffic type
2011 :param sw_if_index: is the incoming interface for L2 traffic
2012 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2015 self.papi.sr_steering_add_del,
2017 'bsid_addr': bsid_addr,
2018 'sr_policy_index': sr_policy_index,
2019 'table_id': table_id,
2020 'prefix_addr': prefix_addr,
2021 'mask_width': mask_width,
2022 'sw_if_index': sw_if_index,
2023 'traffic_type': traffic_type
2026 def acl_add_replace(self, acl_index, r, tag='',
2028 """Add/replace an ACL
2029 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2030 :param acl_rule r: ACL rules array.
2031 :param str tag: symbolic tag (description) for this ACL.
2032 :param int count: number of rules.
2034 return self.api(self.papi.acl_add_replace,
2035 {'acl_index': acl_index,
2039 expected_retval=expected_retval)
2041 def acl_del(self, acl_index, expected_retval=0):
2047 return self.api(self.papi.acl_del,
2048 {'acl_index': acl_index},
2049 expected_retval=expected_retval)
2051 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2053 return self.api(self.papi.acl_interface_set_acl_list,
2054 {'sw_if_index': sw_if_index,
2058 expected_retval=expected_retval)
2060 def acl_interface_set_etype_whitelist(self, sw_if_index,
2063 return self.api(self.papi.acl_interface_set_etype_whitelist,
2064 {'sw_if_index': sw_if_index,
2065 'count': len(whitelist),
2067 'whitelist': whitelist},
2068 expected_retval=expected_retval)
2070 def acl_interface_add_del(self,
2074 """ Add/Delete ACL to/from interface
2078 :param is_add: (Default value = 1)
2081 return self.api(self.papi.acl_interface_add_del,
2084 'sw_if_index': sw_if_index,
2085 'acl_index': acl_index})
2087 def acl_dump(self, acl_index, expected_retval=0):
2088 return self.api(self.papi.acl_dump,
2089 {'acl_index': acl_index},
2090 expected_retval=expected_retval)
2092 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2094 return self.api(self.papi.acl_interface_list_dump,
2095 {'sw_if_index': sw_if_index},
2096 expected_retval=expected_retval)
2098 def macip_acl_add(self, rules, tag=""):
2101 :param rules: list of rules for given acl
2105 return self.api(self.papi.macip_acl_add,
2107 'count': len(rules),
2110 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2113 :param rules: list of rules for given acl
2117 return self.api(self.papi.macip_acl_add_replace,
2118 {'acl_index': acl_index,
2120 'count': len(rules),
2123 def macip_acl_interface_add_del(self,
2127 """ Add MACIP acl to interface
2131 :param is_add: (Default value = 1)
2134 return self.api(self.papi.macip_acl_interface_add_del,
2136 'sw_if_index': sw_if_index,
2137 'acl_index': acl_index})
2139 def macip_acl_dump(self, acl_index=4294967295):
2140 """ Return MACIP acl dump
2144 self.papi.macip_acl_dump, {'acl_index': acl_index})
2146 def policer_add_del(self,
2157 conform_action_type=1,
2159 exceed_action_type=0,
2161 violate_action_type=0,
2163 return self.api(self.papi.policer_add_del,
2170 'rate_type': rate_type,
2171 'round_type': round_type,
2173 'color_aware': color_aware,
2174 'conform_action_type': conform_action_type,
2175 'conform_dscp': conform_dscp,
2176 'exceed_action_type': exceed_action_type,
2177 'exceed_dscp': exceed_dscp,
2178 'violate_action_type': violate_action_type,
2179 'violate_dscp': violate_dscp})
2181 def ip_punt_police(self,
2185 return self.api(self.papi.ip_punt_police,
2186 {'policer_index': policer_index,
2190 def ip_punt_redirect(self,
2195 return self.api(self.papi.ip_punt_redirect,
2196 {'punt': {'rx_sw_if_index': rx_sw_if_index,
2197 'tx_sw_if_index': tx_sw_if_index,
2201 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
2202 return self.api(self.papi.ip_punt_redirect_dump,
2203 {'sw_if_index': sw_if_index,
2204 'is_ipv6': is_ipv6})
2206 def bier_table_add_del(self,
2210 """ BIER Table add/del """
2212 self.papi.bier_table_add_del,
2213 {'bt_tbl_id': {"bt_set": bti.set_id,
2214 "bt_sub_domain": bti.sub_domain_id,
2215 "bt_hdr_len_id": bti.hdr_len_id},
2216 'bt_label': mpls_label,
2217 'bt_is_add': is_add})
2219 def bier_table_dump(self):
2220 return self.api(self.papi.bier_table_dump, {})
2222 def bier_route_add_del(self,
2228 """ BIER Route add/del """
2230 self.papi.bier_route_add_del,
2231 {'br_tbl_id': {"bt_set": bti.set_id,
2232 "bt_sub_domain": bti.sub_domain_id,
2233 "bt_hdr_len_id": bti.hdr_len_id},
2235 'br_n_paths': len(paths),
2237 'br_is_add': is_add,
2238 'br_is_replace': is_replace})
2240 def bier_route_dump(self, bti):
2242 self.papi.bier_route_dump,
2243 {'br_tbl_id': {"bt_set": bti.set_id,
2244 "bt_sub_domain": bti.sub_domain_id,
2245 "bt_hdr_len_id": bti.hdr_len_id}})
2247 def bier_imp_add(self,
2252 """ BIER Imposition Add """
2254 self.papi.bier_imp_add,
2255 {'bi_tbl_id': {"bt_set": bti.set_id,
2256 "bt_sub_domain": bti.sub_domain_id,
2257 "bt_hdr_len_id": bti.hdr_len_id},
2259 'bi_n_bytes': len(ibytes),
2260 'bi_bytes': ibytes})
2262 def bier_imp_del(self, bi_index):
2263 """ BIER Imposition del """
2265 self.papi.bier_imp_del,
2266 {'bi_index': bi_index})
2268 def bier_imp_dump(self):
2269 return self.api(self.papi.bier_imp_dump, {})
2271 def bier_disp_table_add_del(self,
2274 """ BIER Disposition Table add/del """
2276 self.papi.bier_disp_table_add_del,
2277 {'bdt_tbl_id': bdti,
2278 'bdt_is_add': is_add})
2280 def bier_disp_table_dump(self):
2281 return self.api(self.papi.bier_disp_table_dump, {})
2283 def bier_disp_entry_add_del(self,
2293 """ BIER Route add/del """
2295 while (len(lstack) < 16):
2298 self.papi.bier_disp_entry_add_del,
2299 {'bde_tbl_id': bdti,
2301 'bde_payload_proto': payload_proto,
2303 'bde_paths': [{'next_hop': next_hop,
2304 'table_id': next_hop_tbl_id,
2305 'afi': next_hop_afi,
2306 'rpf_id': next_hop_rpf_id,
2308 'label_stack': lstack}],
2309 'bde_is_add': is_add})
2311 def bier_disp_entry_dump(self, bdti):
2313 self.papi.bier_disp_entry_dump,
2314 {'bde_tbl_id': bdti})
2316 def session_enable_disable(self, is_enabled):
2318 self.papi.session_enable_disable,
2319 {'is_enable': is_enabled})
2321 def ipsec_spd_add_del(self, spd_id, is_add=1):
2322 """ SPD add/del - Wrapper to add or del ipsec SPD
2323 Sample CLI : 'ipsec spd add 1'
2325 :param spd_id - SPD ID to be created in the vpp . mandatory
2326 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2328 :returns: reply from the API
2331 self.papi.ipsec_spd_add_del, {
2332 'spd_id': spd_id, 'is_add': is_add})
2334 def ipsec_spds_dump(self):
2335 return self.api(self.papi.ipsec_spds_dump, {})
2337 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2338 """ IPSEC interface SPD add/del - \
2339 Wrapper to associate/disassociate SPD to interface in VPP
2340 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2342 :param spd_id - SPD ID to associate with the interface . mandatory
2343 :param sw_if_index - Interface Index which needs to ipsec \
2344 association mandatory
2345 :param is_add - add(1) or del(0) association with interface \
2346 (Default 1 - add) . optional
2347 :returns: reply from the API
2350 self.papi.ipsec_interface_add_del_spd,
2351 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
2353 def ipsec_spd_interface_dump(self, spd_index=None):
2354 return self.api(self.papi.ipsec_spd_interface_dump,
2355 {'spd_index': spd_index if spd_index else 0,
2356 'spd_index_valid': 1 if spd_index else 0})
2358 def ipsec_sad_entry_add_del(self,
2361 integrity_algorithm,
2366 tunnel_src_address='',
2367 tunnel_dst_address='',
2370 """ IPSEC SA add/del
2371 :param sad_id: security association ID
2372 :param spi: security param index of the SA in decimal
2373 :param integrity_algorithm:
2374 :param integrity_key:
2375 :param crypto_algorithm:
2377 :param protocol: AH(0) or ESP(1) protocol
2378 :param tunnel_src_address: tunnel mode outer src address
2379 :param tunnel_dst_address: tunnel mode outer dst address
2382 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
2383 crypto and ipsec algorithms
2386 self.papi.ipsec_sad_entry_add_del,
2393 'tunnel_src': tunnel_src_address,
2394 'tunnel_dst': tunnel_dst_address,
2395 'protocol': protocol,
2396 'integrity_algorithm': integrity_algorithm,
2398 'length': len(integrity_key),
2399 'data': integrity_key,
2401 'crypto_algorithm': crypto_algorithm,
2403 'length': len(crypto_key),
2410 def ipsec_sa_dump(self, sa_id=None):
2411 return self.api(self.papi.ipsec_sa_dump,
2412 {'sa_id': sa_id if sa_id else 0xffffffff})
2414 def ipsec_spd_entry_add_del(self,
2417 local_address_start,
2419 remote_address_start,
2420 remote_address_stop,
2422 local_port_stop=65535,
2423 remote_port_start=0,
2424 remote_port_stop=65535,
2432 """ IPSEC policy SPD add/del -
2433 Wrapper to configure ipsec SPD policy entries in VPP
2434 :param spd_id: SPD ID for the policy
2435 :param local_address_start: local-ip-range start address
2436 :param local_address_stop : local-ip-range stop address
2437 :param remote_address_start: remote-ip-range start address
2438 :param remote_address_stop : remote-ip-range stop address
2439 :param local_port_start: (Default value = 0)
2440 :param local_port_stop: (Default value = 65535)
2441 :param remote_port_start: (Default value = 0)
2442 :param remote_port_stop: (Default value = 65535)
2443 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
2444 :param sa_id: Security Association ID for mapping it to SPD
2445 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
2447 :param priority: value for the spd action (Default value = 100)
2448 :param is_outbound: flag for inbound(0) or outbound(1)
2450 :param is_add: (Default value = 1)
2453 self.papi.ipsec_spd_entry_add_del,
2460 'local_address_start': local_address_start,
2461 'local_address_stop': local_address_stop,
2462 'remote_address_start': remote_address_start,
2463 'remote_address_stop': remote_address_stop,
2464 'local_port_start': local_port_start,
2465 'local_port_stop': local_port_stop,
2466 'remote_port_start': remote_port_start,
2467 'remote_port_stop': remote_port_stop,
2468 'protocol': protocol,
2470 'priority': priority,
2471 'is_outbound': is_outbound,
2472 'is_ip_any': is_ip_any
2476 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
2477 return self.api(self.papi.ipsec_spd_dump,
2481 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
2482 remote_spi, crypto_alg, local_crypto_key,
2483 remote_crypto_key, integ_alg, local_integ_key,
2484 remote_integ_key, is_add=1, esn=0,
2485 anti_replay=1, renumber=0, show_instance=0):
2487 self.papi.ipsec_tunnel_if_add_del,
2489 'local_ip': local_ip,
2490 'remote_ip': remote_ip,
2491 'local_spi': local_spi,
2492 'remote_spi': remote_spi,
2493 'crypto_alg': crypto_alg,
2494 'local_crypto_key_len': len(local_crypto_key),
2495 'local_crypto_key': local_crypto_key,
2496 'remote_crypto_key_len': len(remote_crypto_key),
2497 'remote_crypto_key': remote_crypto_key,
2498 'integ_alg': integ_alg,
2499 'local_integ_key_len': len(local_integ_key),
2500 'local_integ_key': local_integ_key,
2501 'remote_integ_key_len': len(remote_integ_key),
2502 'remote_integ_key': remote_integ_key,
2505 'anti_replay': anti_replay,
2506 'renumber': renumber,
2507 'show_instance': show_instance
2510 def ipsec_select_backend(self, protocol, index):
2511 return self.api(self.papi.ipsec_select_backend,
2512 {'protocol': protocol, 'index': index})
2514 def ipsec_backend_dump(self):
2515 return self.api(self.papi.ipsec_backend_dump, {})
2517 def app_namespace_add_del(self,
2521 sw_if_index=0xFFFFFFFF,
2524 self.papi.app_namespace_add_del,
2526 'sw_if_index': sw_if_index,
2527 'ip4_fib_id': ip4_fib_id,
2528 'ip6_fib_id': ip6_fib_id,
2529 'namespace_id': namespace_id,
2530 'namespace_id_len': len(namespace_id)})
2532 def punt_socket_register(self, port, pathname, protocol=0x11,
2533 header_version=1, is_ip4=1):
2534 """ Register punt socket """
2535 return self.api(self.papi.punt_socket_register,
2536 {'header_version': header_version,
2537 'punt': {'ipv': is_ip4,
2538 'l4_protocol': protocol,
2540 'pathname': pathname})
2542 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
2543 """ Unregister punt socket """
2544 return self.api(self.papi.punt_socket_deregister,
2545 {'punt': {'ipv': is_ip4,
2546 'l4_protocol': protocol,
2549 def punt_socket_dump(self, is_ip6=1):
2550 """ Dump punt socket"""
2551 return self.api(self.papi.punt_socket_dump,
2552 {'is_ipv6': is_ip6})
2554 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
2556 """ GBP endpoint Add """
2557 return self.api(self.papi.gbp_endpoint_add,
2559 'sw_if_index': sw_if_index,
2570 def gbp_endpoint_del(self, handle):
2571 """ GBP endpoint Del """
2572 return self.api(self.papi.gbp_endpoint_del,
2575 def gbp_endpoint_dump(self):
2576 """ GBP endpoint Dump """
2577 return self.api(self.papi.gbp_endpoint_dump,
2578 {'_no_type_conversion': True})
2580 def gbp_endpoint_group_add(self, vnid, sclass, bd,
2581 rd, uplink_sw_if_index,
2583 """ GBP endpoint group Add """
2584 return self.api(self.papi.gbp_endpoint_group_add,
2587 'uplink_sw_if_index': uplink_sw_if_index,
2592 'retention': retention
2595 def gbp_endpoint_group_del(self, sclass):
2596 """ GBP endpoint group Del """
2597 return self.api(self.papi.gbp_endpoint_group_del,
2600 def gbp_bridge_domain_add(self, bd_id, flags,
2603 bm_flood_sw_if_index):
2604 """ GBP bridge-domain Add """
2605 return self.api(self.papi.gbp_bridge_domain_add,
2609 'bvi_sw_if_index': bvi_sw_if_index,
2610 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2611 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2615 def gbp_bridge_domain_del(self, bd_id):
2616 """ GBP bridge-domain Del """
2617 return self.api(self.papi.gbp_bridge_domain_del,
2620 def gbp_route_domain_add(self, rd_id,
2624 ip6_uu_sw_if_index):
2625 """ GBP route-domain Add """
2626 return self.api(self.papi.gbp_route_domain_add,
2629 'ip4_table_id': ip4_table_id,
2630 'ip6_table_id': ip6_table_id,
2631 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2632 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2636 def gbp_route_domain_del(self, rd_id):
2637 """ GBP route-domain Del """
2638 return self.api(self.papi.gbp_route_domain_del,
2641 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2642 """ GBP recirc Add/Del """
2643 return self.api(self.papi.gbp_recirc_add_del,
2647 'sw_if_index': sw_if_index,
2650 def gbp_recirc_dump(self):
2651 """ GBP recirc Dump """
2652 return self.api(self.papi.gbp_recirc_dump, {})
2654 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2655 """ GBP recirc Add/Del """
2656 return self.api(self.papi.gbp_ext_itf_add_del,
2659 'sw_if_index': sw_if_index,
2663 def gbp_ext_itf_dump(self):
2664 """ GBP recirc Dump """
2665 return self.api(self.papi.gbp_ext_itf_dump, {})
2667 def gbp_subnet_add_del(self, is_add, rd_id,
2669 sw_if_index=0xffffffff,
2671 """ GBP Subnet Add/Del """
2672 return self.api(self.papi.gbp_subnet_add_del,
2676 'sw_if_index': sw_if_index,
2681 def gbp_subnet_dump(self):
2682 """ GBP Subnet Dump """
2683 return self.api(self.papi.gbp_subnet_dump,
2684 {'_no_type_conversion': True})
2686 def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2687 rules, allowed_ethertypes):
2688 """ GBP contract Add/Del """
2689 return self.api(self.papi.gbp_contract_add_del,
2692 'acl_index': acl_index,
2695 'n_rules': len(rules),
2697 'n_ether_types': len(allowed_ethertypes),
2698 'allowed_ethertypes': allowed_ethertypes}})
2700 def gbp_contract_dump(self):
2701 """ GBP contract Dump """
2702 return self.api(self.papi.gbp_contract_dump, {})
2704 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2705 """ GBP VXLAN tunnel add """
2706 return self.api(self.papi.gbp_vxlan_tunnel_add,
2711 'bd_rd_id': bd_rd_id,
2716 def gbp_vxlan_tunnel_del(self, vni):
2717 """ GBP VXLAN tunnel del """
2718 return self.api(self.papi.gbp_vxlan_tunnel_del,
2723 def gbp_vxlan_tunnel_dump(self):
2724 """ GBP VXLAN tunnel add/del """
2725 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2727 def qos_egress_map_update(self, id, outputs):
2728 """ QOS egress map update """
2729 return self.api(self.papi.qos_egress_map_update,
2733 def qos_egress_map_delete(self, id):
2734 """ QOS egress map delete """
2735 return self.api(self.papi.qos_egress_map_delete,
2738 def qos_mark_enable_disable(self, sw_if_index,
2742 """ QOS Mark Enable/Disable """
2743 return self.api(self.papi.qos_mark_enable_disable,
2745 'sw_if_index': sw_if_index,
2746 'output_source': output_source,
2749 def igmp_enable_disable(self, sw_if_index, enable, host):
2750 """ Enable/disable IGMP on a given interface """
2751 return self.api(self.papi.igmp_enable_disable,
2754 'sw_if_index': sw_if_index})
2756 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2757 """ Add/del IGMP proxy device """
2758 return self.api(self.papi.igmp_proxy_device_add_del,
2759 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2762 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2763 """ Add/del interface to/from IGMP proxy device """
2764 return self.api(self.papi.igmp_proxy_device_add_del_interface,
2765 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2768 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2769 """ Listen for new (S,G) on specified interface
2771 :param enable: add/del
2772 :param sw_if_index: interface sw index
2773 :param saddr: source ip4 addr
2774 :param gaddr: group ip4 addr
2776 return self.api(self.papi.igmp_listen,
2781 'sw_if_index': sw_if_index,
2782 'n_srcs': len(saddrs),
2788 def igmp_clear_interface(self, sw_if_index):
2789 """ Remove all (S,G)s from specified interface
2790 doesn't send IGMP report!
2793 self.papi.igmp_clear_interface, {
2794 'sw_if_index': sw_if_index})
2796 def want_igmp_events(self, enable=1):
2797 return self.api(self.papi.want_igmp_events, {'enable': enable,
2798 'pid': os.getpid()})
2806 interface_id=0xFFFFFFFF):
2809 :param lb: load balance
2810 :param use_custom_mac: use custom mac
2811 :param mac_address: mac address
2812 :param interface_id: custom interface ID
2815 self.papi.bond_create,
2818 'use_custom_mac': use_custom_mac,
2819 'mac_address': mac_address,
2823 def pipe_delete(self, parent_sw_if_index):
2824 return self.api(self.papi.pipe_delete,
2825 {'parent_sw_if_index': parent_sw_if_index})
2839 return self.api(self.papi.memif_create,
2842 'rx_queues': rx_queues,
2843 'tx_queues': tx_queues,
2845 'socket_id': socket_id,
2847 'ring_size': ring_size,
2848 'buffer_size': buffer_size,
2849 'hw_addr': hw_addr})
2851 def svs_table_add_del(self, af, table_id, is_add=1):
2852 return self.api(self.papi.svs_table_add_del,
2854 'table_id': table_id,
2859 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2860 return self.api(self.papi.svs_route_add_del,
2862 'table_id': table_id,
2863 'source_table_id': src_table_id,
2868 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2869 return self.api(self.papi.svs_enable_disable,
2872 'table_id': table_id,
2873 'sw_if_index': sw_if_index,
2874 'is_enable': is_enable,