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_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID
25 class SYSLOG_SEVERITY:
37 # Dictionary keyed on message name to override default values for
41 'map_add_domain': {'mtu': 1280},
42 'syslog_set_sender': {'collector_port': 514,
44 'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
45 'acl_interface_list_dump': {'sw_if_index': 4294967295, },
46 'app_namespace_add_del': {'sw_if_index': 4294967295, },
47 'bd_ip_mac_add_del': {'is_add': 1, },
48 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
50 'bier_disp_table_add_del': {'is_add': 1, },
51 'bier_imp_add': {'is_add': 1, },
52 'bier_route_add_del': {'is_add': 1, },
53 'bier_table_add_del': {'is_add': 1, },
54 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
55 'learn': 1, 'is_add': 1, },
56 'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
57 'nbuckets': 2, 'memory_size': 2097152,
58 'next_table_index': 4294967295,
59 'miss_next_index': 4294967295, },
60 'dhcp6_client_enable_disable': {'enable': 1, },
61 'dhcp6_clients_enable_disable': {'enable': 1, },
62 'dhcp6_pd_client_enable_disable': {'enable': 1, },
63 'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
64 'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
65 'dhcp_proxy_config': {'is_add': 1, },
66 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
67 'dslite_add_del_pool_addr_range': {'is_add': 1, },
68 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
69 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
70 'decap_next_index': 4294967295, },
71 'gre_add_del_tunnel': {'instance': 4294967295, 'is_add': 1, },
72 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
73 'decap_next_index': 4294967295, },
74 'input_acl_set_interface': {'ip4_table_index': 4294967295,
75 'ip6_table_index': 4294967295,
76 'l2_table_index': 4294967295, },
77 'ip6_add_del_address_using_prefix': {'is_add': 1, },
78 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
79 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
80 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
81 'next_hop_id': 4294967295,
82 'classify_table_index': 4294967295, 'is_add': 1, },
83 'ip_mroute_add_del': {'is_add': 1, },
84 'ip_neighbor_add_del': {'is_add': 1, },
85 'ip_punt_police': {'is_add': 1, },
86 'ip_punt_redirect': {'is_add': 1, },
87 'ip_table_add_del': {'is_add': 1, },
88 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
89 'ipip_add_tunnel': {'is_ipv6': 1, 'instance': 4294967295, },
90 'ipsec_interface_add_del_spd': {'is_add': 1, },
91 'ipsec_sad_entry_add_del': {'is_add': 1, },
92 'ipsec_spd_add_del': {'is_add': 1, },
93 'ipsec_spd_dump': {'sa_id': 4294967295, },
94 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
95 'remote_port_stop': 65535, 'priority': 100,
98 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
99 'l2_emulation': {'enable': 1, },
100 'l2fib_add_del': {'is_add': 1, },
101 'lb_conf': {'sticky_buckets_per_core': 4294967295,
102 'flow_timeout': 4294967295},
103 'lisp_add_del_adjacency': {'is_add': 1, },
104 'lisp_add_del_local_eid': {'is_add': 1, },
105 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
106 'lisp_add_del_locator_set': {'is_add': 1, },
107 'lisp_add_del_remote_mapping': {'is_add': 1, },
108 'macip_acl_add_replace': {'acl_index': 4294967295, },
109 'macip_acl_dump': {'acl_index': 4294967295, },
110 'macip_acl_interface_add_del': {'is_add': 1, },
111 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
112 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
113 'mr_next_hop_weight': 1,
114 'mr_next_hop_via_label': 1048576,
116 'mr_classify_table_index': 4294967295, },
117 'mpls_table_add_del': {'is_add': 1, },
118 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
119 'next_hop_weight': 1,
120 'next_hop_via_label': 1048576,
122 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
123 'nat44_add_del_address_range': {'is_add': 1, 'vrf_id': 4294967295, },
124 'nat44_add_del_identity_mapping': {'ip': b'0', 'sw_if_index': 4294967295,
125 'addr_only': 1, 'is_add': 1, },
126 'nat44_add_del_interface_addr': {'is_add': 1, },
127 'nat44_add_del_lb_static_mapping': {'is_add': 1, },
128 'nat44_add_del_static_mapping': {'external_sw_if_index': 4294967295,
129 'addr_only': 1, 'is_add': 1, },
130 'nat44_del_session': {'is_in': 1, },
131 'nat44_interface_add_del_feature': {'is_inside': 1, 'is_add': 1, },
132 'nat44_interface_add_del_output_feature': {'is_inside': 1, 'is_add': 1, },
133 'nat44_lb_static_mapping_add_del_local': {'is_add': 1, },
134 'nat64_add_del_interface': {'is_inside': 1, 'is_add': 1, },
135 'nat64_add_del_interface_addr': {'is_add': 1, },
136 'nat64_add_del_pool_addr_range': {'vrf_id': 4294967295, 'is_add': 1, },
137 'nat64_add_del_prefix': {'is_add': 1, },
138 'nat64_add_del_static_bib': {'is_add': 1, },
139 'nat64_bib_dump': {'protocol': 255, },
140 'nat64_st_dump': {'protocol': 255, },
141 'nat66_add_del_interface': {'is_inside': 1, 'is_add': 1, },
142 'nat66_add_del_static_mapping': {'is_add': 1, },
143 'nat_det_add_del_map': {'is_add': 1, },
144 'nat_ha_resync': {'want_resync_event': 1, },
145 'nat_ha_set_failover': {'refresh': 10, },
146 'nat_ha_set_listener': {'path_mtu': 512, },
147 'nat_ipfix_enable_disable': {'domain_id': 1, 'src_port': 4739,
149 'nat_set_mss_clamping': {'mss_value': 1500, },
150 'nat_set_reass': {'timeout': 2, 'max_reass': 1024, 'max_frag': 5, },
151 'nat_set_timeouts': {'udp': 300, 'tcp_established': 7440,
152 'tcp_transitory': 240, 'icmp': 60, },
153 'output_acl_set_interface': {'ip4_table_index': 4294967295,
154 'ip6_table_index': 4294967295,
155 'l2_table_index': 4294967295, },
156 'pppoe_add_del_session': {'is_add': 1, },
157 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
158 'proxy_arp_add_del': {'is_add': 1, },
159 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
160 'punt_socket_register': {'protocol': 17, 'header_version': 1,
162 'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, },
163 'punt_socket_dump': {'is_ip6': 1, },
164 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
166 'set_ipfix_exporter': {'collector_port': 4739, },
167 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
168 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
169 'svs_enable_disable': {'is_enable': 1, },
170 'svs_route_add_del': {'is_add': 1, },
171 'svs_table_add_del': {'is_add': 1, },
172 'sw_interface_add_del_address': {'is_add': 1, },
173 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
174 'pref_lifetime': 4294967295, },
175 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
176 'sw_interface_set_l2_bridge': {'enable': 1, },
177 'sw_interface_set_mpls_enable': {'enable': 1, },
178 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
179 'sw_interface_set_unnumbered': {'is_add': 1, },
180 'sw_interface_span_enable_disable': {'state': 1, },
181 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
182 'decap_next_index': 4294967295,
183 'instance': 4294967295, },
184 'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
185 'instance': 4294967295, },
186 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
187 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
189 'want_bfd_events': {'enable_disable': 1, },
190 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
191 'want_dhcp6_reply_events': {'enable_disable': 1, },
192 'want_igmp_events': {'enable': 1, },
193 'want_interface_events': {'enable_disable': 1, },
194 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
195 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
196 'want_ip6_ra_events': {'enable_disable': 1, },
197 'want_l2_macs_events': {'enable_disable': 1, },
201 class UnexpectedApiReturnValueError(Exception):
202 """ exception raised when the API return value is unexpected """
206 class VppPapiProvider(object):
207 """VPP-api provider using vpp-papi
209 @property hook: hook object providing before and after api/cli hooks
212 _zero, _negative = range(2)
214 def __init__(self, name, shm_prefix, test_class, read_timeout):
215 self.hook = Hook(test_class)
217 self.shm_prefix = shm_prefix
218 self.test_class = test_class
219 self._expect_api_retval = self._zero
220 self._expect_stack = []
222 install_dir = os.getenv('VPP_INSTALL_PATH')
224 # Vapi requires 'VPP_API_DIR', not set when run from Makefile.
225 if 'VPP_API_DIR' not in os.environ:
226 os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH')
228 self.vpp = VPP(logger=test_class.logger,
229 read_timeout=read_timeout)
230 self._events = deque()
235 def assert_negative_api_retval(self):
236 """ Expect API failure - used with with, e.g.:
237 with self.vapi.assert_negative_api_retval():
238 self.vapi.<api call expected to fail>
240 self._expect_stack.append(self._expect_api_retval)
241 self._expect_api_retval = self._negative
244 def assert_zero_api_retval(self):
245 """ Expect API success - used with with, e.g.:
246 with self.vapi.assert_negative_api_retval():
247 self.vapi.<api call expected to succeed>
249 note: this is useful only inside another with block
250 as success is the default expected value
252 self._expect_stack.append(self._expect_api_retval)
253 self._expect_api_retval = self._zero
256 def __exit__(self, exc_type, exc_value, traceback):
257 self._expect_api_retval = self._expect_stack.pop()
259 def register_hook(self, hook):
260 """Replace hook registration with new hook
267 def collect_events(self):
268 """ Collect all events from the internal queue and clear the queue. """
270 self._events = deque()
273 def wait_for_event(self, timeout, name=None):
274 """ Wait for and return next event. """
276 self.test_class.logger.debug("Expecting event '%s' within %ss",
279 self.test_class.logger.debug("Expecting event within %ss",
282 self.test_class.logger.debug("Not waiting, event already queued")
283 limit = time.time() + timeout
284 while time.time() < limit:
286 e = self._events.popleft()
287 if name and type(e).__name__ != name:
289 "Unexpected event received: %s, expected: %s" %
290 (type(e).__name__, name))
291 self.test_class.logger.debug("Returning event %s:%s" %
294 self.test_class.sleep(0) # yield
295 raise Exception("Event did not occur within timeout")
297 def __call__(self, name, event):
298 """ Enqueue event in the internal event queue. """
299 # FIXME use the name instead of relying on type(e).__name__ ?
300 # FIXME #2 if this throws, it is eaten silently, Ole?
301 self.test_class.logger.debug("New event: %s: %s" % (name, event))
302 self._events.append(event)
304 def factory(self, name, apifn):
306 fields = apifn._func.msg.fields
308 # add positional and kw arguments
310 for i, o in enumerate(fields[3:]):
317 if name in defaultmapping:
318 for k, v in iteritems(defaultmapping[name]):
322 return self.api(apifn, d)
326 def __getattribute__(self, name):
328 method = super(VppPapiProvider, self).__getattribute__(name)
329 except AttributeError:
330 method = self.factory(name, getattr(self.papi, name))
331 # lazily load the method so we don't need to call factory
332 # again for this name.
333 setattr(self, name, method)
337 """Connect the API to VPP"""
338 self.vpp.connect(self.name, self.shm_prefix)
339 self.papi = self.vpp.api
340 self.vpp.register_event_callback(self)
342 def disconnect(self):
343 """Disconnect the API from VPP"""
344 self.vpp.disconnect()
346 def api(self, api_fn, api_args, expected_retval=0):
347 """ Call API function and check it's return value.
348 Call the appropriate hooks before and after the API call
350 :param api_fn: API function to call
351 :param api_args: tuple of API function arguments
352 :param expected_retval: Expected return value (Default value = 0)
353 :returns: reply from the API
356 self.hook.before_api(api_fn.__name__, api_args)
357 reply = api_fn(**api_args)
358 if self._expect_api_retval == self._negative:
359 if hasattr(reply, 'retval') and reply.retval >= 0:
360 msg = "API call passed unexpectedly: expected negative " \
361 "return value instead of %d in %s" % \
362 (reply.retval, moves.reprlib.repr(reply))
363 self.test_class.logger.info(msg)
364 raise UnexpectedApiReturnValueError(msg)
365 elif self._expect_api_retval == self._zero:
366 if hasattr(reply, 'retval') and reply.retval != expected_retval:
367 msg = "API call failed, expected %d return value instead " \
368 "of %d in %s" % (expected_retval, reply.retval,
369 moves.reprlib.repr(reply))
370 self.test_class.logger.info(msg)
371 raise UnexpectedApiReturnValueError(msg)
373 raise Exception("Internal error, unexpected value for "
374 "self._expect_api_retval %s" %
375 self._expect_api_retval)
376 self.hook.after_api(api_fn.__name__, api_args)
380 """ Execute a CLI, calling the before/after hooks appropriately.
382 :param cli: CLI to execute
386 self.hook.before_cli(cli)
388 r = self.papi.cli_inband(cmd=cli)
389 self.hook.after_cli(cli)
390 if hasattr(r, 'reply'):
393 def ppcli(self, cli):
394 """ Helper method to print CLI command in case of info logging level.
396 :param cli: CLI to execute
399 return cli + "\n" + str(self.cli(cli))
401 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
402 return self.api(self.papi.want_ip4_arp_events,
403 {'enable_disable': enable_disable,
405 'pid': os.getpid(), })
407 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
408 return self.api(self.papi.want_ip6_nd_events,
409 {'enable_disable': enable_disable,
411 'pid': os.getpid(), })
413 def want_ip6_ra_events(self, enable_disable=1):
414 return self.api(self.papi.want_ip6_ra_events,
415 {'enable_disable': enable_disable,
416 'pid': os.getpid(), })
418 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
420 return self.api(self.papi.ip6nd_send_router_solicitation,
425 'sw_if_index': sw_if_index})
427 def want_interface_events(self, enable_disable=1):
428 return self.api(self.papi.want_interface_events,
429 {'enable_disable': enable_disable,
430 'pid': os.getpid(), })
432 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
433 max_macs_in_event=0, learn_limit=0):
434 return self.api(self.papi.want_l2_macs_events,
435 {'enable_disable': enable_disable,
436 'scan_delay': scan_delay,
437 'max_macs_in_event': max_macs_in_event,
438 'learn_limit': learn_limit,
439 'pid': os.getpid(), })
441 def want_dhcp6_reply_events(self, enable_disable=1):
442 return self.api(self.papi.want_dhcp6_reply_events,
443 {'enable_disable': enable_disable,
446 def want_dhcp6_pd_reply_events(self, enable_disable=1):
447 return self.api(self.papi.want_dhcp6_pd_reply_events,
448 {'enable_disable': enable_disable,
451 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
452 prefixes, server_index=0xFFFFFFFF,
453 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
455 return self.api(self.papi.dhcp6_pd_send_client_message,
456 {'sw_if_index': sw_if_index,
457 'server_index': server_index,
463 'msg_type': msg_type,
466 'n_prefixes': len(prefixes),
467 'prefixes': prefixes})
469 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
471 return self.api(self.papi.dhcp6_client_enable_disable,
472 {'sw_if_index': sw_if_index,
475 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
477 return self.api(self.papi.dhcp6_pd_client_enable_disable,
478 {'sw_if_index': sw_if_index,
479 'prefix_group': prefix_group,
482 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
483 prefix_length, prefix_group,
485 return self.api(self.papi.ip6_add_del_address_using_prefix,
486 {'sw_if_index': sw_if_index,
487 'prefix_group': prefix_group,
489 'prefix_length': prefix_length,
492 def sw_interface_set_mac_address(self, sw_if_index, mac):
493 return self.api(self.papi.sw_interface_set_mac_address,
494 {'sw_if_index': sw_if_index,
497 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
498 """Create p2p ethernet subinterface
500 :param sw_if_index: main (parent) interface
501 :param remote_mac: client (remote) mac address
505 self.papi.p2p_ethernet_add,
506 {'parent_if_index': sw_if_index,
507 'remote_mac': remote_mac,
508 'subif_id': subif_id})
510 def p2p_ethernet_del(self, sw_if_index, remote_mac):
511 """Delete p2p ethernet subinterface
513 :param sw_if_index: main (parent) interface
514 :param remote_mac: client (remote) mac address
518 self.papi.p2p_ethernet_del,
519 {'parent_if_index': sw_if_index,
520 'remote_mac': remote_mac})
522 def create_vlan_subif(self, sw_if_index, vlan):
529 return self.api(self.papi.create_vlan_subif,
530 {'sw_if_index': sw_if_index,
533 def create_loopback(self, mac=''):
536 :param mac: (Optional)
538 return self.api(self.papi.create_loopback,
539 {'mac_address': mac})
541 def ip_neighbor_add_del(self,
547 """ Add neighbor MAC to IPv4 or IPv6 address.
552 :param is_add: (Default value = 1)
553 :param flags: (Default value = 0/NONE)
556 self.papi.ip_neighbor_add_del,
560 'sw_if_index': sw_if_index,
562 'mac_address': mac_address,
563 'ip_address': ip_address
568 def proxy_arp_add_del(self,
573 """ Config Proxy Arp Range.
575 :param low_address: Start address in the rnage to Proxy for
576 :param hi_address: End address in the rnage to Proxy for
577 :param vrf_id: The VRF/table in which to proxy
581 self.papi.proxy_arp_add_del,
584 'table_id': table_id,
590 def proxy_arp_intfc_enable_disable(self,
593 """ Enable/Disable an interface for proxy ARP requests
595 :param sw_if_index: Interface
596 :param enable_disable: Enable/Disable
600 self.papi.proxy_arp_intfc_enable_disable,
601 {'sw_if_index': sw_if_index,
602 'enable_disable': is_enable
606 def gre_add_del_tunnel(self,
619 :param outer_fib_id: (Default value = 0)
620 :param tunnel_type: (Default value = 0)
621 :param instance: (Default value = 0xFFFFFFFF)
622 :param session_id: (Default value = 0)
623 :param is_add: (Default value = 1)
624 :param is_ipv6: (Default value = 0)
628 self.papi.gre_add_del_tunnel,
631 'tunnel_type': tunnel_type,
632 'instance': instance,
633 'src_address': src_address,
634 'dst_address': dst_address,
635 'outer_fib_id': outer_fib_id,
636 'session_id': session_id}
639 def udp_encap_add(self,
650 :param outer_fib_id: (Default value = 0)
654 self.papi.udp_encap_add,
659 'src_port': src_port,
660 'dst_port': dst_port,
665 def mpls_table_add_del(
672 :param is_add: (Default value = 1)
677 self.papi.mpls_table_add_del,
678 {'mt_table_id': table_id,
679 'mt_is_add': is_add})
681 def mpls_ip_bind_unbind(
693 self.papi.mpls_ip_bind_unbind,
694 {'mb_mpls_table_id': table_id,
696 'mb_ip_table_id': ip_table_id,
697 'mb_is_bind': is_bind,
699 'mb_address_length': dst_address_length,
700 'mb_address': dst_address})
702 def mpls_tunnel_add_del(
705 next_hop_proto_is_ip4,
707 next_hop_sw_if_index=0xFFFFFFFF,
710 next_hop_n_out_labels=0,
711 next_hop_out_label_stack=[],
712 next_hop_via_label=MPLS_LABEL_INVALID,
718 :param dst_address_length:
719 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
721 :param next_hop_address:
722 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
723 :param vrf_id: (Default value = 0)
724 :param lookup_in_vrf: (Default value = 0)
725 :param classify_table_index: (Default value = 0xFFFFFFFF)
726 :param is_add: (Default value = 1)
727 :param is_drop: (Default value = 0)
728 :param is_ipv6: (Default value = 0)
729 :param is_local: (Default value = 0)
730 :param is_classify: (Default value = 0)
731 :param is_multipath: (Default value = 0)
732 :param is_resolve_host: (Default value = 0)
733 :param is_resolve_attached: (Default value = 0)
734 :param next_hop_weight: (Default value = 1)
735 :param is_multicast: (Default value = 0)
739 self.papi.mpls_tunnel_add_del,
740 {'mt_sw_if_index': tun_sw_if_index,
742 'mt_l2_only': l2_only,
743 'mt_is_multicast': is_multicast,
744 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
745 'mt_next_hop_weight': next_hop_weight,
746 'mt_next_hop': next_hop_address,
747 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
748 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
749 'mt_next_hop_table_id': next_hop_table_id,
750 'mt_next_hop_via_label': next_hop_via_label,
751 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
753 def nat44_interface_add_del_feature(
758 """Enable/disable NAT44 feature on the interface
760 :param sw_if_index: Software index of the interface
761 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
762 :param is_add: 1 if add, 0 if delete (Default value = 1)
765 self.papi.nat44_interface_add_del_feature,
767 'is_inside': is_inside,
768 'sw_if_index': sw_if_index})
770 def nat44_interface_add_del_output_feature(
775 """Enable/disable NAT44 output feature on the interface
777 :param sw_if_index: Software index of the interface
778 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
779 :param is_add: 1 if add, 0 if delete (Default value = 1)
782 self.papi.nat44_interface_add_del_output_feature,
784 'is_inside': is_inside,
785 'sw_if_index': sw_if_index})
787 def nat44_add_del_static_mapping(
791 external_sw_if_index=0xFFFFFFFF,
802 """Add/delete NAT44 static mapping
804 :param local_ip: Local IP address
805 :param external_ip: External IP address
806 :param external_sw_if_index: External interface instead of IP address
807 :param local_port: Local port number (Default value = 0)
808 :param external_port: External port number (Default value = 0)
809 :param addr_only: 1 if address only mapping, 0 if address and port
810 :param vrf_id: VRF ID
811 :param protocol: IP protocol (Default value = 0)
812 :param twice_nat: 1 if translate external host address and port
813 :param self_twice_nat: 1 if translate external host address and port
814 whenever external host address equals
815 local address of internal host
816 :param out2in_only: if 1 rule is matching only out2in direction
817 :param tag: Opaque string tag
818 :param is_add: 1 if add, 0 if delete (Default value = 1)
821 self.papi.nat44_add_del_static_mapping,
823 'addr_only': addr_only,
824 'local_ip_address': local_ip,
825 'external_ip_address': external_ip,
826 'local_port': local_port,
827 'external_port': external_port,
828 'external_sw_if_index': external_sw_if_index,
830 'protocol': protocol,
831 'twice_nat': twice_nat,
832 'self_twice_nat': self_twice_nat,
833 'out2in_only': out2in_only,
836 def nat44_add_del_identity_mapping(
839 sw_if_index=0xFFFFFFFF,
846 """Add/delete NAT44 identity mapping
848 :param ip: IP address (Default value = 0)
849 :param sw_if_index: Interface instead of IP address
850 :param port: Port number (Default value = 0)
851 :param addr_only: 1 if address only mapping, 0 if address and port
852 :param vrf_id: VRF ID
853 :param protocol: IP protocol (Default value = 0)
854 :param tag: Opaque string tag
855 :param is_add: 1 if add, 0 if delete (Default value = 1)
858 self.papi.nat44_add_del_identity_mapping,
860 'addr_only': addr_only,
863 'sw_if_index': sw_if_index,
866 'protocol': protocol})
868 def nat44_add_del_address_range(
875 """Add/del NAT44 address range
877 :param first_ip_address: First IP address
878 :param last_ip_address: Last IP address
879 :param vrf_id: VRF id for the address range
880 :param twice_nat: twice NAT address for extenral hosts
881 :param is_add: 1 if add, 0 if delete (Default value = 1)
884 self.papi.nat44_add_del_address_range,
885 {'first_ip_address': first_ip_address,
886 'last_ip_address': last_ip_address,
888 'twice_nat': twice_nat,
891 def nat44_add_del_interface_addr(
896 """Add/del NAT44 address from interface
898 :param sw_if_index: Software index of the interface
899 :param twice_nat: twice NAT address for external hosts
900 :param is_add: 1 if add, 0 if delete (Default value = 1)
903 self.papi.nat44_add_del_interface_addr,
905 'sw_if_index': sw_if_index,
906 'twice_nat': twice_nat})
908 def nat44_add_del_lb_static_mapping(
921 """Add/delete NAT44 load balancing static mapping
923 :param twice_nat: 1 if translate external host address and port
924 :param tag: Opaque string tag
925 :param affinity: if 0 disabled, otherwise client IP affinity timeout
926 :param is_add - 1 if add, 0 if delete
929 self.papi.nat44_add_del_lb_static_mapping,
931 'external_addr': external_addr,
932 'external_port': external_port,
933 'protocol': protocol,
934 'twice_nat': twice_nat,
935 'self_twice_nat': self_twice_nat,
936 'out2in_only': out2in_only,
938 'affinity': affinity,
939 'local_num': local_num,
942 def nat44_lb_static_mapping_add_del_local(
952 """Add/delete NAT44 load-balancing static mapping rule backend
954 :param external_addr: external IPv4 address of the service
955 :param external_port: external L4 port number of the service
956 :param local_addr: IPv4 address of the internal node
957 :param local_port: L4 port number of the internal node
958 :param protocol: IP protocol number
959 :param probability: probability of the internal node
960 :param vrf_id: VRF id of the internal node
961 :param is_add: 1 if add, 0 if delete
964 self.papi.nat44_lb_static_mapping_add_del_local,
966 'external_addr': external_addr,
967 'external_port': external_port,
971 'probability': probability,
973 'protocol': protocol})
975 def nat44_del_session(
982 ext_host_address=None,
984 """Delete NAT44 session
986 :param addr: IPv4 address
987 :param por: port number
988 :param protocol: IP protocol number
989 :param vrf_id: VRF ID
990 :param is_in: 1 if inside network address and port pair, 0 if outside
991 :param ext_host_address: external host IPv4 address
992 :param ext_host_port: external host port
994 if ext_host_address is None:
996 self.papi.nat44_del_session,
999 'protocol': protocol,
1004 self.papi.nat44_del_session,
1007 'protocol': protocol,
1010 'ext_host_valid': 1,
1011 'ext_host_address': ext_host_address,
1012 'ext_host_port': ext_host_port})
1014 def nat44_forwarding_enable_disable(
1017 """Enable/disable forwarding for NAT44
1019 :param enable: 1 for enable, 0 for disable
1022 self.papi.nat44_forwarding_enable_disable,
1025 def nat_det_add_del_map(
1032 """Add/delete deterministic NAT mapping
1034 :param is_add - 1 if add, 0 if delete
1035 :param in_addr - inside IP address
1036 :param in_plen - inside IP address prefix length
1037 :param out_addr - outside IP address
1038 :param out_plen - outside IP address prefix length
1041 self.papi.nat_det_add_del_map,
1046 'out_addr': out_addr,
1047 'out_plen': out_plen})
1049 def nat_det_forward(
1052 """Get outside address and port range from inside address
1054 :param in_addr - inside IP address
1057 self.papi.nat_det_forward,
1058 {'in_addr': in_addr,
1061 def nat_det_reverse(
1065 """Get inside address from outside address and port
1067 :param out_addr - outside IP address
1068 :param out_port - outside port
1071 self.papi.nat_det_reverse,
1072 {'out_addr': out_addr,
1073 'out_port': out_port})
1075 def nat_det_map_dump(self):
1076 """Dump deterministic NAT mappings
1078 :return: Dictionary of deterministic NAT mappings
1080 return self.api(self.papi.nat_det_map_dump, {})
1082 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1083 """Set TCP MSS rewriting configuration
1085 :param enable: disable(0)/enable(1) MSS rewriting feature
1086 :param mss_value: MSS value to be used for MSS rewriting
1089 self.papi.nat_set_mss_clamping,
1090 {'enable': enable, 'mss_value': mss_value})
1092 def nat_det_close_session_in(
1098 """Close deterministic NAT session using inside address and port
1100 :param in_addr - inside IP address
1101 :param in_port - inside port
1102 :param ext_addr - external host IP address
1103 :param ext_port - external host port
1106 self.papi.nat_det_close_session_in,
1107 {'in_addr': in_addr,
1109 'ext_addr': ext_addr,
1110 'ext_port': ext_port,
1113 def nat_det_session_dump(
1116 """Dump deterministic NAT sessions belonging to a user
1118 :param user_addr - inside IP address of the user
1119 :return: Dictionary of deterministic NAT sessions
1122 self.papi.nat_det_session_dump,
1124 'user_addr': user_addr})
1126 def nat64_add_del_interface(
1131 """Enable/disable NAT64 feature on the interface
1132 :param sw_if_index: Index of the interface
1133 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1134 :param is_add: 1 if add, 0 if delete (Default value = 1)
1137 self.papi.nat64_add_del_interface,
1138 {'sw_if_index': sw_if_index,
1139 'is_inside': is_inside,
1142 def nat64_add_del_static_bib(
1151 """Add/delete S-NAT static BIB entry
1153 :param in_ip: Inside IPv6 address
1154 :param out_ip: Outside IPv4 address
1155 :param in_port: Inside port number
1156 :param out_port: Outside port number
1157 :param protocol: IP protocol
1158 :param vrf_id: VRF ID (Default value = 0)
1159 :param is_add: 1 if add, 0 if delete (Default value = 1)
1162 self.papi.nat64_add_del_static_bib,
1171 def nat64_bib_dump(self, protocol=255):
1174 :param protocol: IP protocol (Default value = 255, all BIBs)
1175 :returns: Dictionary of NAT64 BIB entries
1177 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1179 def nat64_st_dump(self, protocol=255):
1180 """Dump NAT64 session table
1182 :param protocol: IP protocol (Default value = 255, all STs)
1183 :returns: Dictionary of NAT64 session table entries
1185 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1187 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1188 """Add/del NAT64 prefix
1190 :param prefix: NAT64 prefix
1191 :param plen: NAT64 prefix length
1192 :param vrf_id: VRF id of tenant (Default 0)
1193 :param is_add: 1 if add, 0 if delete (Default value = 1)
1196 self.papi.nat64_add_del_prefix,
1202 def nat64_add_del_interface_addr(
1206 """Add/del NAT64 address from interface
1208 :param sw_if_index: Software index of the interface
1209 :param is_add: 1 if add, 0 if delete (Default value = 1)
1211 return self.api(self.papi.nat64_add_del_interface_addr,
1212 {'is_add': is_add, 'sw_if_index': sw_if_index})
1214 def dslite_set_aftr_addr(self, ip6, ip4):
1215 """Set DS-Lite AFTR addresses
1217 :param ip4: IPv4 address
1218 :param ip6: IPv6 address
1221 self.papi.dslite_set_aftr_addr,
1225 def dslite_set_b4_addr(self, ip6, ip4):
1226 """Set DS-Lite B4 IPv6 address
1228 :param ip4: IPv4 address
1229 :param ip6: IPv6 address
1232 self.papi.dslite_set_b4_addr,
1236 def nat66_add_del_interface(
1241 """Enable/disable NAT66 feature on the interface
1242 :param sw_if_index: Index of the interface
1243 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1244 :param is_add: 1 if add, 0 if delete (Default value = 1)
1247 self.papi.nat66_add_del_interface,
1248 {'sw_if_index': sw_if_index,
1249 'is_inside': is_inside,
1252 def nat66_add_del_static_mapping(
1258 """Add/delete NAT66 static mapping
1260 :param in_ip: Inside IPv6 address
1261 :param out_ip: Outside IPv6 address
1262 :param vrf_id: VRF ID (Default value = 0)
1263 :param is_add: 1 if add, 0 if delete (Default value = 1)
1266 self.papi.nat66_add_del_static_mapping,
1267 {'local_ip_address': in_ip,
1268 'external_ip_address': out_ip,
1272 def nat_ha_set_listener(self, addr, port, path_mtu=512):
1273 """Set HA listener (local settings)
1275 :param addr: local IP4 address
1276 :param port: local UDP port number
1277 :param path_mtu: path MTU (Default value = 512)
1279 return self.api(self.papi.nat_ha_set_listener,
1280 {'ip_address': addr,
1282 'path_mtu': path_mtu})
1284 def nat_ha_get_listener(self):
1285 """Get HA listener/local configuration"""
1286 return self.api(self.papi.nat_ha_get_listener, {})
1288 def nat_ha_set_failover(self, addr, port, refresh=10):
1289 """Set HA failover (remote settings)
1291 :param addr: failover IP4 address
1292 :param port: failover UDP port number
1293 :param refresh: number of seconds after which to send session refresh
1295 return self.api(self.papi.nat_ha_set_failover,
1296 {'ip_address': addr,
1298 'session_refresh_interval': refresh})
1300 def nat_ha_resync(self, want_resync_event=1):
1301 """Resync HA (resend existing sessions to new failover)
1302 :param want_resync_event: if non-zero resync completed event sent
1304 return self.api(self.papi.nat_ha_resync,
1305 {'want_resync_event': want_resync_event,
1306 'pid': os.getpid()})
1308 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1309 detect_mult, local_addr, peer_addr, is_ipv6=0,
1310 bfd_key_id=None, conf_key_id=None):
1311 if bfd_key_id is None:
1312 return self.api(self.papi.bfd_udp_add,
1314 'sw_if_index': sw_if_index,
1315 'desired_min_tx': desired_min_tx,
1316 'required_min_rx': required_min_rx,
1317 'local_addr': local_addr,
1318 'peer_addr': peer_addr,
1320 'detect_mult': detect_mult,
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,
1332 'is_authenticated': 1,
1333 'bfd_key_id': bfd_key_id,
1334 'conf_key_id': conf_key_id,
1337 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1338 detect_mult, local_addr, peer_addr, is_ipv6=0):
1339 return self.api(self.papi.bfd_udp_mod,
1341 'sw_if_index': sw_if_index,
1342 'desired_min_tx': desired_min_tx,
1343 'required_min_rx': required_min_rx,
1344 'local_addr': local_addr,
1345 'peer_addr': peer_addr,
1347 'detect_mult': detect_mult,
1350 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1351 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1353 return self.api(self.papi.bfd_udp_auth_activate,
1355 'sw_if_index': sw_if_index,
1356 'local_addr': local_addr,
1357 'peer_addr': peer_addr,
1359 'is_delayed': 1 if is_delayed else 0,
1360 'bfd_key_id': bfd_key_id,
1361 'conf_key_id': conf_key_id,
1364 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1365 peer_addr, is_ipv6=0):
1366 return self.api(self.papi.bfd_udp_session_set_flags, {
1367 'admin_up_down': admin_up_down,
1368 'sw_if_index': sw_if_index,
1369 'local_addr': local_addr,
1370 'peer_addr': peer_addr,
1374 def want_bfd_events(self, enable_disable=1):
1375 return self.api(self.papi.want_bfd_events, {
1376 'enable_disable': enable_disable,
1380 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1381 return self.api(self.papi.bfd_auth_set_key, {
1382 'conf_key_id': conf_key_id,
1383 'auth_type': auth_type,
1385 'key_len': len(key),
1388 def classify_add_del_table(
1393 table_index=0xFFFFFFFF,
1395 memory_size=2097152,
1397 next_table_index=0xFFFFFFFF,
1398 miss_next_index=0xFFFFFFFF,
1399 current_data_flag=0,
1400 current_data_offset=0):
1404 :param match_n_vectors: (Default value = 1)
1405 :param table_index: (Default value = 0xFFFFFFFF)
1406 :param nbuckets: (Default value = 2)
1407 :param memory_size: (Default value = 2097152)
1408 :param skip_n_vectors: (Default value = 0)
1409 :param next_table_index: (Default value = 0xFFFFFFFF)
1410 :param miss_next_index: (Default value = 0xFFFFFFFF)
1411 :param current_data_flag: (Default value = 0)
1412 :param current_data_offset: (Default value = 0)
1415 mask_len = ((len(mask) - 1) / 16 + 1) * 16
1416 mask = mask + '\0' * (mask_len - len(mask))
1418 self.papi.classify_add_del_table,
1420 'table_index': table_index,
1421 'nbuckets': nbuckets,
1422 'memory_size': memory_size,
1423 'skip_n_vectors': skip_n_vectors,
1424 'match_n_vectors': match_n_vectors,
1425 'next_table_index': next_table_index,
1426 'miss_next_index': miss_next_index,
1427 'current_data_flag': current_data_flag,
1428 'current_data_offset': current_data_offset,
1429 'mask_len': mask_len,
1432 def classify_add_del_session(
1437 opaque_index=0xFFFFFFFF,
1438 hit_next_index=0xFFFFFFFF,
1446 :param opaque_index: (Default value = 0xFFFFFFFF)
1447 :param hit_next_index: (Default value = 0xFFFFFFFF)
1448 :param advance: (Default value = 0)
1449 :param action: (Default value = 0)
1450 :param metadata: (Default value = 0)
1453 match_len = ((len(match) - 1) / 16 + 1) * 16
1454 match = match + '\0' * (match_len - len(match))
1456 self.papi.classify_add_del_session,
1458 'table_index': table_index,
1459 'hit_next_index': hit_next_index,
1460 'opaque_index': opaque_index,
1463 'metadata': metadata,
1464 'match_len': match_len,
1467 def input_acl_set_interface(
1471 ip4_table_index=0xFFFFFFFF,
1472 ip6_table_index=0xFFFFFFFF,
1473 l2_table_index=0xFFFFFFFF):
1477 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1478 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1479 :param l2_table_index: (Default value = 0xFFFFFFFF)
1483 self.papi.input_acl_set_interface,
1484 {'sw_if_index': sw_if_index,
1485 'ip4_table_index': ip4_table_index,
1486 'ip6_table_index': ip6_table_index,
1487 'l2_table_index': l2_table_index,
1490 def output_acl_set_interface(
1494 ip4_table_index=0xFFFFFFFF,
1495 ip6_table_index=0xFFFFFFFF,
1496 l2_table_index=0xFFFFFFFF):
1500 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1501 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1502 :param l2_table_index: (Default value = 0xFFFFFFFF)
1506 self.papi.output_acl_set_interface,
1507 {'sw_if_index': sw_if_index,
1508 'ip4_table_index': ip4_table_index,
1509 'ip6_table_index': ip6_table_index,
1510 'l2_table_index': l2_table_index,
1513 def set_ipfix_exporter(
1520 collector_port=4739,
1523 self.papi.set_ipfix_exporter,
1525 'collector_address': collector_address,
1526 'collector_port': collector_port,
1527 'src_address': src_address,
1529 'path_mtu': path_mtu,
1530 'template_interval': template_interval,
1531 'udp_checksum': udp_checksum,
1534 def dhcp_proxy_config(self,
1542 self.papi.dhcp_proxy_config,
1544 'rx_vrf_id': rx_table_id,
1545 'server_vrf_id': server_table_id,
1548 'dhcp_server': dhcp_server,
1549 'dhcp_src_address': dhcp_src_address,
1552 def dhcp_proxy_set_vss(self,
1561 self.papi.dhcp_proxy_set_vss,
1564 'vss_type': vss_type,
1565 'vpn_ascii_id': vpn_ascii_id,
1567 'vpn_index': vpn_index,
1572 def dhcp_client_config(self,
1577 set_broadcast_flag=1,
1578 want_dhcp_events=0):
1580 self.papi.dhcp_client_config,
1584 'sw_if_index': sw_if_index,
1585 'hostname': hostname,
1587 'want_dhcp_event': want_dhcp_events,
1588 'set_broadcast_flag': set_broadcast_flag,
1592 def ip_mroute_add_del(self,
1598 next_hop_sw_if_index,
1608 IP Multicast Route add/del
1611 self.papi.ip_mroute_add_del,
1612 {'next_hop_sw_if_index': next_hop_sw_if_index,
1613 'entry_flags': e_flags,
1614 'itf_flags': i_flags,
1615 'table_id': table_id,
1619 'is_local': is_local,
1620 'bier_imp': bier_imp,
1621 'next_hop_afi': next_hop_afi,
1622 'grp_address_length': grp_address_length,
1623 'grp_address': grp_address,
1624 'src_address': src_address,
1625 'nh_address': next_hop_address})
1627 def lisp_enable_disable(self, is_enabled):
1629 self.papi.lisp_enable_disable,
1631 'is_en': is_enabled,
1634 def lisp_add_del_locator_set(self,
1638 self.papi.lisp_add_del_locator_set,
1641 'locator_set_name': ls_name
1644 def lisp_add_del_locator(self,
1651 self.papi.lisp_add_del_locator,
1654 'locator_set_name': ls_name,
1655 'sw_if_index': sw_if_index,
1656 'priority': priority,
1660 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1662 self.papi.lisp_locator_dump,
1664 'is_index_set': is_index_set,
1666 'ls_index': ls_index,
1669 def lisp_add_del_local_eid(self,
1679 self.papi.lisp_add_del_local_eid,
1681 'locator_set_name': ls_name,
1683 'eid_type': eid_type,
1685 'prefix_len': prefix_len,
1691 def lisp_eid_table_dump(self,
1699 self.papi.lisp_eid_table_dump,
1702 'prefix_length': prefix_length,
1704 'eid_type': eid_type,
1706 'filter': filter_opt,
1709 def lisp_add_del_remote_mapping(self,
1719 self.papi.lisp_add_del_remote_mapping,
1722 'eid_type': eid_type,
1724 'eid_len': eid_prefix_len,
1725 'rloc_num': rlocs_num,
1728 'is_src_dst': is_src_dst,
1731 def lisp_add_del_adjacency(self,
1740 self.papi.lisp_add_del_adjacency,
1744 'eid_type': eid_type,
1747 'leid_len': leid_len,
1748 'reid_len': reid_len,
1751 def gtpu_add_del_tunnel(
1757 mcast_sw_if_index=0xFFFFFFFF,
1759 decap_next_index=0xFFFFFFFF,
1763 :param is_add: (Default value = 1)
1764 :param is_ipv6: (Default value = 0)
1767 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1768 :param encap_vrf_id: (Default value = 0)
1769 :param decap_next_index: (Default value = 0xFFFFFFFF)
1770 :param teid: (Default value = 0)
1773 return self.api(self.papi.gtpu_add_del_tunnel,
1776 'src_address': src_addr,
1777 'dst_address': dst_addr,
1778 'mcast_sw_if_index': mcast_sw_if_index,
1779 'encap_vrf_id': encap_vrf_id,
1780 'decap_next_index': decap_next_index,
1783 def vxlan_gpe_add_del_tunnel(
1787 mcast_sw_if_index=0xFFFFFFFF,
1798 :param is_add: (Default value = 1)
1799 :param is_ipv6: (Default value = 0)
1800 :param encap_vrf_id: (Default value = 0)
1801 :param decap_vrf_id: (Default value = 0)
1802 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1803 :param protocol: (Default value = 3)
1804 :param vni: (Default value = 0)
1807 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1812 'mcast_sw_if_index': mcast_sw_if_index,
1813 'encap_vrf_id': encap_vrf_id,
1814 'decap_vrf_id': decap_vrf_id,
1815 'protocol': protocol,
1818 def vxlan_gbp_tunnel_add_del(
1822 mcast_sw_if_index=0xFFFFFFFF,
1828 instance=0xFFFFFFFF):
1833 :param is_add: (Default value = 1)
1834 :param is_ipv6: (Default value = 0)
1835 :param encap_table_id: (Default value = 0)
1836 :param decap_next_index: (Default value = 0xFFFFFFFF)
1837 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1838 :param vni: (Default value = 0)
1839 :param instance: (Default value = 0xFFFFFFFF)
1842 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
1847 'mcast_sw_if_index': mcast_sw_if_index,
1848 'encap_table_id': encap_table_id,
1850 'instance': instance,
1853 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1854 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1855 {'sw_if_index': sw_if_index,
1856 '_no_type_conversion': True})
1858 def pppoe_add_del_session(
1868 :param is_add: (Default value = 1)
1869 :param is_ipv6: (Default value = 0)
1871 :param session_id: (Default value = 0)
1873 :param decap_vrf_id: (Default value = 0)
1876 return self.api(self.papi.pppoe_add_del_session,
1879 'session_id': session_id,
1880 'client_ip': client_ip,
1881 'decap_vrf_id': decap_vrf_id,
1882 'client_mac': client_mac})
1884 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1885 return self.api(self.papi.sr_mpls_policy_add,
1889 'n_segments': len(segments),
1890 'segments': segments})
1892 def sr_mpls_policy_del(self, bsid):
1893 return self.api(self.papi.sr_mpls_policy_del,
1896 def sr_localsid_add_del(self,
1903 sw_if_index=0xFFFFFFFF,
1907 """ Add/del IPv6 SR local-SID.
1910 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1911 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1914 :param is_del: (Default value = 0)
1915 :param end_psp: (Default value = 0)
1916 :param sw_if_index: (Default value = 0xFFFFFFFF)
1917 :param vlan_index: (Default value = 0)
1918 :param fib_table: (Default value = 0)
1921 self.papi.sr_localsid_add_del,
1923 'localsid': localsid,
1925 'behavior': behavior,
1926 'sw_if_index': sw_if_index,
1927 'vlan_index': vlan_index,
1928 'fib_table': fib_table,
1929 'nh_addr4': nh_addr4,
1930 'nh_addr6': nh_addr6
1944 :param bsid_addr: bindingSID of the SR Policy
1945 :param weight: weight of the sid list. optional. (default: 1)
1946 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1948 :param type: type/behavior of the SR policy. (default or spray) \
1950 :param fib_table: VRF where to install the FIB entry for the BSID \
1952 :param n_segments: number of segments \
1954 :param segments: a vector of IPv6 address composing the segment list \
1958 self.papi.sr_policy_add,
1959 {'bsid_addr': bsid_addr,
1961 'is_encap': is_encap,
1963 'fib_table': fib_table,
1964 'n_segments': n_segments,
1965 'segments': segments
1974 :param bsid: bindingSID of the SR Policy
1975 :param sr_policy_index: index of the sr policy (default: 0)
1978 self.papi.sr_policy_del,
1979 {'bsid_addr': bsid_addr,
1980 'sr_policy_index': sr_policy_index
1983 def sr_steering_add_del(
1994 Steer traffic L2 and L3 traffic through a given SR policy
1996 :param is_del: delete or add
1997 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1998 :param sr_policy: is the index of the SR Policy (alt to bsid)
1999 :param table_id: is the VRF where to install the FIB entry for the BSID
2000 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2001 :param mask_width: is the mask for L3 traffic type
2002 :param sw_if_index: is the incoming interface for L2 traffic
2003 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2006 self.papi.sr_steering_add_del,
2008 'bsid_addr': bsid_addr,
2009 'sr_policy_index': sr_policy_index,
2010 'table_id': table_id,
2011 'prefix_addr': prefix_addr,
2012 'mask_width': mask_width,
2013 'sw_if_index': sw_if_index,
2014 'traffic_type': traffic_type
2017 def acl_add_replace(self, acl_index, r, tag='',
2019 """Add/replace an ACL
2020 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2021 :param acl_rule r: ACL rules array.
2022 :param str tag: symbolic tag (description) for this ACL.
2023 :param int count: number of rules.
2025 return self.api(self.papi.acl_add_replace,
2026 {'acl_index': acl_index,
2030 expected_retval=expected_retval)
2032 def acl_del(self, acl_index, expected_retval=0):
2038 return self.api(self.papi.acl_del,
2039 {'acl_index': acl_index},
2040 expected_retval=expected_retval)
2042 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2044 return self.api(self.papi.acl_interface_set_acl_list,
2045 {'sw_if_index': sw_if_index,
2049 expected_retval=expected_retval)
2051 def acl_interface_set_etype_whitelist(self, sw_if_index,
2054 return self.api(self.papi.acl_interface_set_etype_whitelist,
2055 {'sw_if_index': sw_if_index,
2056 'count': len(whitelist),
2058 'whitelist': whitelist},
2059 expected_retval=expected_retval)
2061 def acl_interface_add_del(self,
2065 """ Add/Delete ACL to/from interface
2069 :param is_add: (Default value = 1)
2072 return self.api(self.papi.acl_interface_add_del,
2075 'sw_if_index': sw_if_index,
2076 'acl_index': acl_index})
2078 def acl_dump(self, acl_index, expected_retval=0):
2079 return self.api(self.papi.acl_dump,
2080 {'acl_index': acl_index},
2081 expected_retval=expected_retval)
2083 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2085 return self.api(self.papi.acl_interface_list_dump,
2086 {'sw_if_index': sw_if_index},
2087 expected_retval=expected_retval)
2089 def macip_acl_add(self, rules, tag=""):
2092 :param rules: list of rules for given acl
2096 return self.api(self.papi.macip_acl_add,
2098 'count': len(rules),
2101 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2104 :param rules: list of rules for given acl
2108 return self.api(self.papi.macip_acl_add_replace,
2109 {'acl_index': acl_index,
2111 'count': len(rules),
2114 def macip_acl_interface_add_del(self,
2118 """ Add MACIP acl to interface
2122 :param is_add: (Default value = 1)
2125 return self.api(self.papi.macip_acl_interface_add_del,
2127 'sw_if_index': sw_if_index,
2128 'acl_index': acl_index})
2130 def macip_acl_dump(self, acl_index=4294967295):
2131 """ Return MACIP acl dump
2135 self.papi.macip_acl_dump, {'acl_index': acl_index})
2137 def policer_add_del(self,
2148 conform_action_type=1,
2150 exceed_action_type=0,
2152 violate_action_type=0,
2154 return self.api(self.papi.policer_add_del,
2161 'rate_type': rate_type,
2162 'round_type': round_type,
2164 'color_aware': color_aware,
2165 'conform_action_type': conform_action_type,
2166 'conform_dscp': conform_dscp,
2167 'exceed_action_type': exceed_action_type,
2168 'exceed_dscp': exceed_dscp,
2169 'violate_action_type': violate_action_type,
2170 'violate_dscp': violate_dscp})
2172 def ip_punt_police(self,
2176 return self.api(self.papi.ip_punt_police,
2177 {'policer_index': policer_index,
2181 def ip_punt_redirect(self,
2186 return self.api(self.papi.ip_punt_redirect,
2187 {'punt': {'rx_sw_if_index': rx_sw_if_index,
2188 'tx_sw_if_index': tx_sw_if_index,
2192 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
2193 return self.api(self.papi.ip_punt_redirect_dump,
2194 {'sw_if_index': sw_if_index,
2195 'is_ipv6': is_ipv6})
2197 def bier_table_add_del(self,
2201 """ BIER Table add/del """
2203 self.papi.bier_table_add_del,
2204 {'bt_tbl_id': {"bt_set": bti.set_id,
2205 "bt_sub_domain": bti.sub_domain_id,
2206 "bt_hdr_len_id": bti.hdr_len_id},
2207 'bt_label': mpls_label,
2208 'bt_is_add': is_add})
2210 def bier_table_dump(self):
2211 return self.api(self.papi.bier_table_dump, {})
2213 def bier_route_add_del(self,
2219 """ BIER Route add/del """
2221 self.papi.bier_route_add_del,
2222 {'br_tbl_id': {"bt_set": bti.set_id,
2223 "bt_sub_domain": bti.sub_domain_id,
2224 "bt_hdr_len_id": bti.hdr_len_id},
2226 'br_n_paths': len(paths),
2228 'br_is_add': is_add,
2229 'br_is_replace': is_replace})
2231 def bier_route_dump(self, bti):
2233 self.papi.bier_route_dump,
2234 {'br_tbl_id': {"bt_set": bti.set_id,
2235 "bt_sub_domain": bti.sub_domain_id,
2236 "bt_hdr_len_id": bti.hdr_len_id}})
2238 def bier_imp_add(self,
2243 """ BIER Imposition Add """
2245 self.papi.bier_imp_add,
2246 {'bi_tbl_id': {"bt_set": bti.set_id,
2247 "bt_sub_domain": bti.sub_domain_id,
2248 "bt_hdr_len_id": bti.hdr_len_id},
2250 'bi_n_bytes': len(ibytes),
2251 'bi_bytes': ibytes})
2253 def bier_imp_del(self, bi_index):
2254 """ BIER Imposition del """
2256 self.papi.bier_imp_del,
2257 {'bi_index': bi_index})
2259 def bier_imp_dump(self):
2260 return self.api(self.papi.bier_imp_dump, {})
2262 def bier_disp_table_add_del(self,
2265 """ BIER Disposition Table add/del """
2267 self.papi.bier_disp_table_add_del,
2268 {'bdt_tbl_id': bdti,
2269 'bdt_is_add': is_add})
2271 def bier_disp_table_dump(self):
2272 return self.api(self.papi.bier_disp_table_dump, {})
2274 def bier_disp_entry_add_del(self,
2284 """ BIER Route add/del """
2286 while (len(lstack) < 16):
2289 self.papi.bier_disp_entry_add_del,
2290 {'bde_tbl_id': bdti,
2292 'bde_payload_proto': payload_proto,
2294 'bde_paths': [{'next_hop': next_hop,
2295 'table_id': next_hop_tbl_id,
2296 'afi': next_hop_afi,
2297 'rpf_id': next_hop_rpf_id,
2299 'label_stack': lstack}],
2300 'bde_is_add': is_add})
2302 def bier_disp_entry_dump(self, bdti):
2304 self.papi.bier_disp_entry_dump,
2305 {'bde_tbl_id': bdti})
2307 def session_enable_disable(self, is_enabled):
2309 self.papi.session_enable_disable,
2310 {'is_enable': is_enabled})
2312 def ipsec_spd_add_del(self, spd_id, is_add=1):
2313 """ SPD add/del - Wrapper to add or del ipsec SPD
2314 Sample CLI : 'ipsec spd add 1'
2316 :param spd_id - SPD ID to be created in the vpp . mandatory
2317 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2319 :returns: reply from the API
2322 self.papi.ipsec_spd_add_del, {
2323 'spd_id': spd_id, 'is_add': is_add})
2325 def ipsec_spds_dump(self):
2326 return self.api(self.papi.ipsec_spds_dump, {})
2328 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2329 """ IPSEC interface SPD add/del - \
2330 Wrapper to associate/disassociate SPD to interface in VPP
2331 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2333 :param spd_id - SPD ID to associate with the interface . mandatory
2334 :param sw_if_index - Interface Index which needs to ipsec \
2335 association mandatory
2336 :param is_add - add(1) or del(0) association with interface \
2337 (Default 1 - add) . optional
2338 :returns: reply from the API
2341 self.papi.ipsec_interface_add_del_spd,
2342 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
2344 def ipsec_spd_interface_dump(self, spd_index=None):
2345 return self.api(self.papi.ipsec_spd_interface_dump,
2346 {'spd_index': spd_index if spd_index else 0,
2347 'spd_index_valid': 1 if spd_index else 0})
2349 def ipsec_sad_entry_add_del(self,
2352 integrity_algorithm,
2357 tunnel_src_address='',
2358 tunnel_dst_address='',
2361 """ IPSEC SA add/del
2362 :param sad_id: security association ID
2363 :param spi: security param index of the SA in decimal
2364 :param integrity_algorithm:
2365 :param integrity_key:
2366 :param crypto_algorithm:
2368 :param protocol: AH(0) or ESP(1) protocol
2369 :param tunnel_src_address: tunnel mode outer src address
2370 :param tunnel_dst_address: tunnel mode outer dst address
2373 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
2374 crypto and ipsec algorithms
2377 self.papi.ipsec_sad_entry_add_del,
2384 'tunnel_src': tunnel_src_address,
2385 'tunnel_dst': tunnel_dst_address,
2386 'protocol': protocol,
2387 'integrity_algorithm': integrity_algorithm,
2389 'length': len(integrity_key),
2390 'data': integrity_key,
2392 'crypto_algorithm': crypto_algorithm,
2394 'length': len(crypto_key),
2401 def ipsec_sa_dump(self, sa_id=None):
2402 return self.api(self.papi.ipsec_sa_dump,
2403 {'sa_id': sa_id if sa_id else 0xffffffff})
2405 def ipsec_spd_entry_add_del(self,
2408 local_address_start,
2410 remote_address_start,
2411 remote_address_stop,
2413 local_port_stop=65535,
2414 remote_port_start=0,
2415 remote_port_stop=65535,
2423 """ IPSEC policy SPD add/del -
2424 Wrapper to configure ipsec SPD policy entries in VPP
2425 :param spd_id: SPD ID for the policy
2426 :param local_address_start: local-ip-range start address
2427 :param local_address_stop : local-ip-range stop address
2428 :param remote_address_start: remote-ip-range start address
2429 :param remote_address_stop : remote-ip-range stop address
2430 :param local_port_start: (Default value = 0)
2431 :param local_port_stop: (Default value = 65535)
2432 :param remote_port_start: (Default value = 0)
2433 :param remote_port_stop: (Default value = 65535)
2434 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
2435 :param sa_id: Security Association ID for mapping it to SPD
2436 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
2438 :param priority: value for the spd action (Default value = 100)
2439 :param is_outbound: flag for inbound(0) or outbound(1)
2441 :param is_add: (Default value = 1)
2444 self.papi.ipsec_spd_entry_add_del,
2451 'local_address_start': local_address_start,
2452 'local_address_stop': local_address_stop,
2453 'remote_address_start': remote_address_start,
2454 'remote_address_stop': remote_address_stop,
2455 'local_port_start': local_port_start,
2456 'local_port_stop': local_port_stop,
2457 'remote_port_start': remote_port_start,
2458 'remote_port_stop': remote_port_stop,
2459 'protocol': protocol,
2461 'priority': priority,
2462 'is_outbound': is_outbound,
2463 'is_ip_any': is_ip_any
2467 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
2468 return self.api(self.papi.ipsec_spd_dump,
2472 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
2473 remote_spi, crypto_alg, local_crypto_key,
2474 remote_crypto_key, integ_alg, local_integ_key,
2475 remote_integ_key, is_add=1, esn=0,
2476 anti_replay=1, renumber=0, show_instance=0):
2478 self.papi.ipsec_tunnel_if_add_del,
2480 'local_ip': local_ip,
2481 'remote_ip': remote_ip,
2482 'local_spi': local_spi,
2483 'remote_spi': remote_spi,
2484 'crypto_alg': crypto_alg,
2485 'local_crypto_key_len': len(local_crypto_key),
2486 'local_crypto_key': local_crypto_key,
2487 'remote_crypto_key_len': len(remote_crypto_key),
2488 'remote_crypto_key': remote_crypto_key,
2489 'integ_alg': integ_alg,
2490 'local_integ_key_len': len(local_integ_key),
2491 'local_integ_key': local_integ_key,
2492 'remote_integ_key_len': len(remote_integ_key),
2493 'remote_integ_key': remote_integ_key,
2496 'anti_replay': anti_replay,
2497 'renumber': renumber,
2498 'show_instance': show_instance
2501 def ipsec_gre_tunnel_add_del(self, local_ip, remote_ip,
2502 sa_out, sa_in, is_add=1):
2503 return self.api(self.papi.ipsec_gre_tunnel_add_del,
2509 'local_sa_id': sa_out,
2510 'remote_sa_id': sa_in
2514 def ipsec_select_backend(self, protocol, index):
2515 return self.api(self.papi.ipsec_select_backend,
2516 {'protocol': protocol, 'index': index})
2518 def ipsec_backend_dump(self):
2519 return self.api(self.papi.ipsec_backend_dump, {})
2521 def app_namespace_add_del(self,
2525 sw_if_index=0xFFFFFFFF,
2528 self.papi.app_namespace_add_del,
2530 'sw_if_index': sw_if_index,
2531 'ip4_fib_id': ip4_fib_id,
2532 'ip6_fib_id': ip6_fib_id,
2533 'namespace_id': namespace_id,
2534 'namespace_id_len': len(namespace_id)})
2536 def punt_socket_register(self, port, pathname, protocol=0x11,
2537 header_version=1, is_ip4=1):
2538 """ Register punt socket """
2539 return self.api(self.papi.punt_socket_register,
2540 {'header_version': header_version,
2541 'punt': {'ipv': is_ip4,
2542 'l4_protocol': protocol,
2544 'pathname': pathname})
2546 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
2547 """ Unregister punt socket """
2548 return self.api(self.papi.punt_socket_deregister,
2549 {'punt': {'ipv': is_ip4,
2550 'l4_protocol': protocol,
2553 def punt_socket_dump(self, is_ip6=1):
2554 """ Dump punt socket"""
2555 return self.api(self.papi.punt_socket_dump,
2556 {'is_ipv6': is_ip6})
2558 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
2560 """ GBP endpoint Add """
2561 return self.api(self.papi.gbp_endpoint_add,
2563 'sw_if_index': sw_if_index,
2574 def gbp_endpoint_del(self, handle):
2575 """ GBP endpoint Del """
2576 return self.api(self.papi.gbp_endpoint_del,
2579 def gbp_endpoint_dump(self):
2580 """ GBP endpoint Dump """
2581 return self.api(self.papi.gbp_endpoint_dump,
2582 {'_no_type_conversion': True})
2584 def gbp_endpoint_group_add(self, vnid, sclass, bd,
2585 rd, uplink_sw_if_index,
2587 """ GBP endpoint group Add """
2588 return self.api(self.papi.gbp_endpoint_group_add,
2591 'uplink_sw_if_index': uplink_sw_if_index,
2596 'retention': retention
2599 def gbp_endpoint_group_del(self, sclass):
2600 """ GBP endpoint group Del """
2601 return self.api(self.papi.gbp_endpoint_group_del,
2604 def gbp_bridge_domain_add(self, bd_id, flags,
2607 bm_flood_sw_if_index):
2608 """ GBP bridge-domain Add """
2609 return self.api(self.papi.gbp_bridge_domain_add,
2613 'bvi_sw_if_index': bvi_sw_if_index,
2614 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2615 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2619 def gbp_bridge_domain_del(self, bd_id):
2620 """ GBP bridge-domain Del """
2621 return self.api(self.papi.gbp_bridge_domain_del,
2624 def gbp_route_domain_add(self, rd_id,
2628 ip6_uu_sw_if_index):
2629 """ GBP route-domain Add """
2630 return self.api(self.papi.gbp_route_domain_add,
2633 'ip4_table_id': ip4_table_id,
2634 'ip6_table_id': ip6_table_id,
2635 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2636 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2640 def gbp_route_domain_del(self, rd_id):
2641 """ GBP route-domain Del """
2642 return self.api(self.papi.gbp_route_domain_del,
2645 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2646 """ GBP recirc Add/Del """
2647 return self.api(self.papi.gbp_recirc_add_del,
2651 'sw_if_index': sw_if_index,
2654 def gbp_recirc_dump(self):
2655 """ GBP recirc Dump """
2656 return self.api(self.papi.gbp_recirc_dump, {})
2658 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2659 """ GBP recirc Add/Del """
2660 return self.api(self.papi.gbp_ext_itf_add_del,
2663 'sw_if_index': sw_if_index,
2667 def gbp_ext_itf_dump(self):
2668 """ GBP recirc Dump """
2669 return self.api(self.papi.gbp_ext_itf_dump, {})
2671 def gbp_subnet_add_del(self, is_add, rd_id,
2673 sw_if_index=0xffffffff,
2675 """ GBP Subnet Add/Del """
2676 return self.api(self.papi.gbp_subnet_add_del,
2680 'sw_if_index': sw_if_index,
2685 def gbp_subnet_dump(self):
2686 """ GBP Subnet Dump """
2687 return self.api(self.papi.gbp_subnet_dump,
2688 {'_no_type_conversion': True})
2690 def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2691 rules, allowed_ethertypes):
2692 """ GBP contract Add/Del """
2693 return self.api(self.papi.gbp_contract_add_del,
2696 'acl_index': acl_index,
2699 'n_rules': len(rules),
2701 'n_ether_types': len(allowed_ethertypes),
2702 'allowed_ethertypes': allowed_ethertypes}})
2704 def gbp_contract_dump(self):
2705 """ GBP contract Dump """
2706 return self.api(self.papi.gbp_contract_dump, {})
2708 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2709 """ GBP VXLAN tunnel add """
2710 return self.api(self.papi.gbp_vxlan_tunnel_add,
2715 'bd_rd_id': bd_rd_id,
2720 def gbp_vxlan_tunnel_del(self, vni):
2721 """ GBP VXLAN tunnel del """
2722 return self.api(self.papi.gbp_vxlan_tunnel_del,
2727 def gbp_vxlan_tunnel_dump(self):
2728 """ GBP VXLAN tunnel add/del """
2729 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2731 def qos_egress_map_update(self, id, outputs):
2732 """ QOS egress map update """
2733 return self.api(self.papi.qos_egress_map_update,
2737 def qos_egress_map_delete(self, id):
2738 """ QOS egress map delete """
2739 return self.api(self.papi.qos_egress_map_delete,
2742 def qos_mark_enable_disable(self, sw_if_index,
2746 """ QOS Mark Enable/Disable """
2747 return self.api(self.papi.qos_mark_enable_disable,
2749 'sw_if_index': sw_if_index,
2750 'output_source': output_source,
2753 def igmp_enable_disable(self, sw_if_index, enable, host):
2754 """ Enable/disable IGMP on a given interface """
2755 return self.api(self.papi.igmp_enable_disable,
2758 'sw_if_index': sw_if_index})
2760 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2761 """ Add/del IGMP proxy device """
2762 return self.api(self.papi.igmp_proxy_device_add_del,
2763 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2766 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2767 """ Add/del interface to/from IGMP proxy device """
2768 return self.api(self.papi.igmp_proxy_device_add_del_interface,
2769 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2772 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2773 """ Listen for new (S,G) on specified interface
2775 :param enable: add/del
2776 :param sw_if_index: interface sw index
2777 :param saddr: source ip4 addr
2778 :param gaddr: group ip4 addr
2780 return self.api(self.papi.igmp_listen,
2785 'sw_if_index': sw_if_index,
2786 'n_srcs': len(saddrs),
2792 def igmp_clear_interface(self, sw_if_index):
2793 """ Remove all (S,G)s from specified interface
2794 doesn't send IGMP report!
2797 self.papi.igmp_clear_interface, {
2798 'sw_if_index': sw_if_index})
2800 def want_igmp_events(self, enable=1):
2801 return self.api(self.papi.want_igmp_events, {'enable': enable,
2802 'pid': os.getpid()})
2810 interface_id=0xFFFFFFFF):
2813 :param lb: load balance
2814 :param use_custom_mac: use custom mac
2815 :param mac_address: mac address
2816 :param interface_id: custom interface ID
2819 self.papi.bond_create,
2822 'use_custom_mac': use_custom_mac,
2823 'mac_address': mac_address,
2827 def pipe_delete(self, parent_sw_if_index):
2828 return self.api(self.papi.pipe_delete,
2829 {'parent_sw_if_index': parent_sw_if_index})
2843 return self.api(self.papi.memif_create,
2846 'rx_queues': rx_queues,
2847 'tx_queues': tx_queues,
2849 'socket_id': socket_id,
2851 'ring_size': ring_size,
2852 'buffer_size': buffer_size,
2853 'hw_addr': hw_addr})
2855 def svs_table_add_del(self, af, table_id, is_add=1):
2856 return self.api(self.papi.svs_table_add_del,
2858 'table_id': table_id,
2863 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2864 return self.api(self.papi.svs_route_add_del,
2866 'table_id': table_id,
2867 'source_table_id': src_table_id,
2872 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2873 return self.api(self.papi.svs_enable_disable,
2876 'table_id': table_id,
2877 'sw_if_index': sw_if_index,
2878 'is_enable': is_enable,