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_tunnel_add_del': {'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_dump': {'sw_if_index': 4294967295, },
174 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
175 'pref_lifetime': 4294967295, },
176 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
177 'sw_interface_set_l2_bridge': {'enable': 1, },
178 'sw_interface_set_mpls_enable': {'enable': 1, },
179 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
180 'sw_interface_set_unnumbered': {'is_add': 1, },
181 'sw_interface_span_enable_disable': {'state': 1, },
182 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
183 'decap_next_index': 4294967295,
184 'instance': 4294967295, },
185 'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
186 'instance': 4294967295, },
187 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
188 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
190 'want_bfd_events': {'enable_disable': 1, },
191 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
192 'want_dhcp6_reply_events': {'enable_disable': 1, },
193 'want_igmp_events': {'enable': 1, },
194 'want_interface_events': {'enable_disable': 1, },
195 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
196 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
197 'want_ip6_ra_events': {'enable_disable': 1, },
198 'want_l2_macs_events': {'enable_disable': 1, },
202 class UnexpectedApiReturnValueError(Exception):
203 """ exception raised when the API return value is unexpected """
207 class VppPapiProvider(object):
208 """VPP-api provider using vpp-papi
210 @property hook: hook object providing before and after api/cli hooks
213 _zero, _negative = range(2)
215 def __init__(self, name, shm_prefix, test_class, read_timeout):
216 self.hook = Hook(test_class)
218 self.shm_prefix = shm_prefix
219 self.test_class = test_class
220 self._expect_api_retval = self._zero
221 self._expect_stack = []
223 install_dir = os.getenv('VPP_INSTALL_PATH')
225 # Vapi requires 'VPP_API_DIR', not set when run from Makefile.
226 if 'VPP_API_DIR' not in os.environ:
227 os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH')
231 if os.environ['SOCKET'] == '1':
235 self.vpp = VPP(logger=test_class.logger,
236 read_timeout=read_timeout,
237 use_socket=use_socket,
238 server_address=test_class.api_sock)
239 self._events = deque()
244 def assert_negative_api_retval(self):
245 """ Expect API failure - used with with, e.g.:
246 with self.vapi.assert_negative_api_retval():
247 self.vapi.<api call expected to fail>
249 self._expect_stack.append(self._expect_api_retval)
250 self._expect_api_retval = self._negative
253 def assert_zero_api_retval(self):
254 """ Expect API success - used with with, e.g.:
255 with self.vapi.assert_negative_api_retval():
256 self.vapi.<api call expected to succeed>
258 note: this is useful only inside another with block
259 as success is the default expected value
261 self._expect_stack.append(self._expect_api_retval)
262 self._expect_api_retval = self._zero
265 def __exit__(self, exc_type, exc_value, traceback):
266 self._expect_api_retval = self._expect_stack.pop()
268 def register_hook(self, hook):
269 """Replace hook registration with new hook
276 def collect_events(self):
277 """ Collect all events from the internal queue and clear the queue. """
279 self._events = deque()
282 def wait_for_event(self, timeout, name=None):
283 """ Wait for and return next event. """
285 self.test_class.logger.debug("Expecting event '%s' within %ss",
288 self.test_class.logger.debug("Expecting event within %ss",
291 self.test_class.logger.debug("Not waiting, event already queued")
292 limit = time.time() + timeout
293 while time.time() < limit:
295 e = self._events.popleft()
296 if name and type(e).__name__ != name:
298 "Unexpected event received: %s, expected: %s" %
299 (type(e).__name__, name))
300 self.test_class.logger.debug("Returning event %s:%s" %
303 self.test_class.sleep(0) # yield
304 raise Exception("Event did not occur within timeout")
306 def __call__(self, name, event):
307 """ Enqueue event in the internal event queue. """
308 # FIXME use the name instead of relying on type(e).__name__ ?
309 # FIXME #2 if this throws, it is eaten silently, Ole?
310 self.test_class.logger.debug("New event: %s: %s" % (name, event))
311 self._events.append(event)
313 def factory(self, name, apifn):
315 fields = apifn._func.msg.fields
317 # add positional and kw arguments
319 for i, o in enumerate(fields[3:]):
326 if name in defaultmapping:
327 for k, v in iteritems(defaultmapping[name]):
331 return self.api(apifn, d)
335 def __getattribute__(self, name):
337 method = super(VppPapiProvider, self).__getattribute__(name)
338 except AttributeError:
339 method = self.factory(name, getattr(self.papi, name))
340 # lazily load the method so we don't need to call factory
341 # again for this name.
342 setattr(self, name, method)
346 """Connect the API to VPP"""
347 self.vpp.connect(self.name, self.shm_prefix)
348 self.papi = self.vpp.api
349 self.vpp.register_event_callback(self)
351 def disconnect(self):
352 """Disconnect the API from VPP"""
353 self.vpp.disconnect()
355 def api(self, api_fn, api_args, expected_retval=0):
356 """ Call API function and check it's return value.
357 Call the appropriate hooks before and after the API call
359 :param api_fn: API function to call
360 :param api_args: tuple of API function arguments
361 :param expected_retval: Expected return value (Default value = 0)
362 :returns: reply from the API
365 self.hook.before_api(api_fn.__name__, api_args)
366 reply = api_fn(**api_args)
367 if self._expect_api_retval == self._negative:
368 if hasattr(reply, 'retval') and reply.retval >= 0:
369 msg = "API call passed unexpectedly: expected negative " \
370 "return value instead of %d in %s" % \
371 (reply.retval, moves.reprlib.repr(reply))
372 self.test_class.logger.info(msg)
373 raise UnexpectedApiReturnValueError(msg)
374 elif self._expect_api_retval == self._zero:
375 if hasattr(reply, 'retval') and reply.retval != expected_retval:
376 msg = "API call failed, expected %d return value instead " \
377 "of %d in %s" % (expected_retval, reply.retval,
378 moves.reprlib.repr(reply))
379 self.test_class.logger.info(msg)
380 raise UnexpectedApiReturnValueError(msg)
382 raise Exception("Internal error, unexpected value for "
383 "self._expect_api_retval %s" %
384 self._expect_api_retval)
385 self.hook.after_api(api_fn.__name__, api_args)
389 """ Execute a CLI, calling the before/after hooks appropriately.
391 :param cli: CLI to execute
395 self.hook.before_cli(cli)
397 r = self.papi.cli_inband(cmd=cli)
398 self.hook.after_cli(cli)
399 if hasattr(r, 'reply'):
402 def ppcli(self, cli):
403 """ Helper method to print CLI command in case of info logging level.
405 :param cli: CLI to execute
408 return cli + "\n" + str(self.cli(cli))
410 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
411 return self.api(self.papi.want_ip4_arp_events,
412 {'enable_disable': enable_disable,
414 'pid': os.getpid(), })
416 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
417 return self.api(self.papi.want_ip6_nd_events,
418 {'enable_disable': enable_disable,
420 'pid': os.getpid(), })
422 def want_ip6_ra_events(self, enable_disable=1):
423 return self.api(self.papi.want_ip6_ra_events,
424 {'enable_disable': enable_disable,
425 'pid': os.getpid(), })
427 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
429 return self.api(self.papi.ip6nd_send_router_solicitation,
434 'sw_if_index': sw_if_index})
436 def want_interface_events(self, enable_disable=1):
437 return self.api(self.papi.want_interface_events,
438 {'enable_disable': enable_disable,
439 'pid': os.getpid(), })
441 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
442 max_macs_in_event=0, learn_limit=0):
443 return self.api(self.papi.want_l2_macs_events,
444 {'enable_disable': enable_disable,
445 'scan_delay': scan_delay,
446 'max_macs_in_event': max_macs_in_event,
447 'learn_limit': learn_limit,
448 'pid': os.getpid(), })
450 def want_dhcp6_reply_events(self, enable_disable=1):
451 return self.api(self.papi.want_dhcp6_reply_events,
452 {'enable_disable': enable_disable,
455 def want_dhcp6_pd_reply_events(self, enable_disable=1):
456 return self.api(self.papi.want_dhcp6_pd_reply_events,
457 {'enable_disable': enable_disable,
460 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
461 prefixes, server_index=0xFFFFFFFF,
462 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
464 return self.api(self.papi.dhcp6_pd_send_client_message,
465 {'sw_if_index': sw_if_index,
466 'server_index': server_index,
472 'msg_type': msg_type,
475 'n_prefixes': len(prefixes),
476 'prefixes': prefixes})
478 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
480 return self.api(self.papi.dhcp6_client_enable_disable,
481 {'sw_if_index': sw_if_index,
484 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
486 return self.api(self.papi.dhcp6_pd_client_enable_disable,
487 {'sw_if_index': sw_if_index,
488 'prefix_group': prefix_group,
491 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
492 prefix_length, prefix_group,
494 return self.api(self.papi.ip6_add_del_address_using_prefix,
495 {'sw_if_index': sw_if_index,
496 'prefix_group': prefix_group,
498 'prefix_length': prefix_length,
501 def sw_interface_set_mac_address(self, sw_if_index, mac):
502 return self.api(self.papi.sw_interface_set_mac_address,
503 {'sw_if_index': sw_if_index,
506 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
507 """Create p2p ethernet subinterface
509 :param sw_if_index: main (parent) interface
510 :param remote_mac: client (remote) mac address
514 self.papi.p2p_ethernet_add,
515 {'parent_if_index': sw_if_index,
516 'remote_mac': remote_mac,
517 'subif_id': subif_id})
519 def p2p_ethernet_del(self, sw_if_index, remote_mac):
520 """Delete p2p ethernet subinterface
522 :param sw_if_index: main (parent) interface
523 :param remote_mac: client (remote) mac address
527 self.papi.p2p_ethernet_del,
528 {'parent_if_index': sw_if_index,
529 'remote_mac': remote_mac})
531 def create_vlan_subif(self, sw_if_index, vlan):
538 return self.api(self.papi.create_vlan_subif,
539 {'sw_if_index': sw_if_index,
542 def create_loopback(self, mac=''):
545 :param mac: (Optional)
547 return self.api(self.papi.create_loopback,
548 {'mac_address': mac})
550 def ip_neighbor_add_del(self,
556 """ Add neighbor MAC to IPv4 or IPv6 address.
561 :param is_add: (Default value = 1)
562 :param flags: (Default value = 0/NONE)
565 self.papi.ip_neighbor_add_del,
569 'sw_if_index': sw_if_index,
571 'mac_address': mac_address,
572 'ip_address': ip_address
577 def proxy_arp_add_del(self,
582 """ Config Proxy Arp Range.
584 :param low_address: Start address in the rnage to Proxy for
585 :param hi_address: End address in the rnage to Proxy for
586 :param vrf_id: The VRF/table in which to proxy
590 self.papi.proxy_arp_add_del,
593 'table_id': table_id,
599 def proxy_arp_intfc_enable_disable(self,
602 """ Enable/Disable an interface for proxy ARP requests
604 :param sw_if_index: Interface
605 :param enable_disable: Enable/Disable
609 self.papi.proxy_arp_intfc_enable_disable,
610 {'sw_if_index': sw_if_index,
611 'enable_disable': is_enable
615 def gre_tunnel_add_del(self,
627 :param outer_fib_id: (Default value = 0)
628 :param tunnel_type: (Default value = 0)
629 :param instance: (Default value = 0xFFFFFFFF)
630 :param session_id: (Default value = 0)
631 :param is_add: (Default value = 1)
632 :param is_ipv6: (Default value = 0)
636 self.papi.gre_tunnel_add_del,
641 'instance': instance,
644 'outer_fib_id': outer_fib_id,
645 'session_id': session_id}
649 def udp_encap_add(self,
660 :param outer_fib_id: (Default value = 0)
664 self.papi.udp_encap_add,
669 'src_port': src_port,
670 'dst_port': dst_port,
675 def mpls_table_add_del(
682 :param is_add: (Default value = 1)
687 self.papi.mpls_table_add_del,
688 {'mt_table_id': table_id,
689 'mt_is_add': is_add})
691 def mpls_ip_bind_unbind(
703 self.papi.mpls_ip_bind_unbind,
704 {'mb_mpls_table_id': table_id,
706 'mb_ip_table_id': ip_table_id,
707 'mb_is_bind': is_bind,
709 'mb_address_length': dst_address_length,
710 'mb_address': dst_address})
712 def mpls_tunnel_add_del(
715 next_hop_proto_is_ip4,
717 next_hop_sw_if_index=0xFFFFFFFF,
720 next_hop_n_out_labels=0,
721 next_hop_out_label_stack=[],
722 next_hop_via_label=MPLS_LABEL_INVALID,
728 :param dst_address_length:
729 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
731 :param next_hop_address:
732 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
733 :param vrf_id: (Default value = 0)
734 :param lookup_in_vrf: (Default value = 0)
735 :param classify_table_index: (Default value = 0xFFFFFFFF)
736 :param is_add: (Default value = 1)
737 :param is_drop: (Default value = 0)
738 :param is_ipv6: (Default value = 0)
739 :param is_local: (Default value = 0)
740 :param is_classify: (Default value = 0)
741 :param is_multipath: (Default value = 0)
742 :param is_resolve_host: (Default value = 0)
743 :param is_resolve_attached: (Default value = 0)
744 :param next_hop_weight: (Default value = 1)
745 :param is_multicast: (Default value = 0)
749 self.papi.mpls_tunnel_add_del,
750 {'mt_sw_if_index': tun_sw_if_index,
752 'mt_l2_only': l2_only,
753 'mt_is_multicast': is_multicast,
754 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
755 'mt_next_hop_weight': next_hop_weight,
756 'mt_next_hop': next_hop_address,
757 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
758 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
759 'mt_next_hop_table_id': next_hop_table_id,
760 'mt_next_hop_via_label': next_hop_via_label,
761 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
763 def nat44_interface_add_del_feature(
768 """Enable/disable NAT44 feature on the interface
770 :param sw_if_index: Software index of the interface
771 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
772 :param is_add: 1 if add, 0 if delete (Default value = 1)
775 self.papi.nat44_interface_add_del_feature,
777 'is_inside': is_inside,
778 'sw_if_index': sw_if_index})
780 def nat44_interface_add_del_output_feature(
785 """Enable/disable NAT44 output feature on the interface
787 :param sw_if_index: Software index of the interface
788 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
789 :param is_add: 1 if add, 0 if delete (Default value = 1)
792 self.papi.nat44_interface_add_del_output_feature,
794 'is_inside': is_inside,
795 'sw_if_index': sw_if_index})
797 def nat44_add_del_static_mapping(
801 external_sw_if_index=0xFFFFFFFF,
812 """Add/delete NAT44 static mapping
814 :param local_ip: Local IP address
815 :param external_ip: External IP address
816 :param external_sw_if_index: External interface instead of IP address
817 :param local_port: Local port number (Default value = 0)
818 :param external_port: External port number (Default value = 0)
819 :param addr_only: 1 if address only mapping, 0 if address and port
820 :param vrf_id: VRF ID
821 :param protocol: IP protocol (Default value = 0)
822 :param twice_nat: 1 if translate external host address and port
823 :param self_twice_nat: 1 if translate external host address and port
824 whenever external host address equals
825 local address of internal host
826 :param out2in_only: if 1 rule is matching only out2in direction
827 :param tag: Opaque string tag
828 :param is_add: 1 if add, 0 if delete (Default value = 1)
831 self.papi.nat44_add_del_static_mapping,
833 'addr_only': addr_only,
834 'local_ip_address': local_ip,
835 'external_ip_address': external_ip,
836 'local_port': local_port,
837 'external_port': external_port,
838 'external_sw_if_index': external_sw_if_index,
840 'protocol': protocol,
841 'twice_nat': twice_nat,
842 'self_twice_nat': self_twice_nat,
843 'out2in_only': out2in_only,
846 def nat44_add_del_identity_mapping(
849 sw_if_index=0xFFFFFFFF,
856 """Add/delete NAT44 identity mapping
858 :param ip: IP address (Default value = 0)
859 :param sw_if_index: Interface instead of IP address
860 :param port: Port number (Default value = 0)
861 :param addr_only: 1 if address only mapping, 0 if address and port
862 :param vrf_id: VRF ID
863 :param protocol: IP protocol (Default value = 0)
864 :param tag: Opaque string tag
865 :param is_add: 1 if add, 0 if delete (Default value = 1)
868 self.papi.nat44_add_del_identity_mapping,
870 'addr_only': addr_only,
873 'sw_if_index': sw_if_index,
876 'protocol': protocol})
878 def nat44_add_del_address_range(
885 """Add/del NAT44 address range
887 :param first_ip_address: First IP address
888 :param last_ip_address: Last IP address
889 :param vrf_id: VRF id for the address range
890 :param twice_nat: twice NAT address for extenral hosts
891 :param is_add: 1 if add, 0 if delete (Default value = 1)
894 self.papi.nat44_add_del_address_range,
895 {'first_ip_address': first_ip_address,
896 'last_ip_address': last_ip_address,
898 'twice_nat': twice_nat,
901 def nat44_add_del_interface_addr(
906 """Add/del NAT44 address from interface
908 :param sw_if_index: Software index of the interface
909 :param twice_nat: twice NAT address for external hosts
910 :param is_add: 1 if add, 0 if delete (Default value = 1)
913 self.papi.nat44_add_del_interface_addr,
915 'sw_if_index': sw_if_index,
916 'twice_nat': twice_nat})
918 def nat44_add_del_lb_static_mapping(
931 """Add/delete NAT44 load balancing static mapping
933 :param twice_nat: 1 if translate external host address and port
934 :param tag: Opaque string tag
935 :param affinity: if 0 disabled, otherwise client IP affinity timeout
936 :param is_add - 1 if add, 0 if delete
939 self.papi.nat44_add_del_lb_static_mapping,
941 'external_addr': external_addr,
942 'external_port': external_port,
943 'protocol': protocol,
944 'twice_nat': twice_nat,
945 'self_twice_nat': self_twice_nat,
946 'out2in_only': out2in_only,
948 'affinity': affinity,
949 'local_num': local_num,
952 def nat44_lb_static_mapping_add_del_local(
962 """Add/delete NAT44 load-balancing static mapping rule backend
964 :param external_addr: external IPv4 address of the service
965 :param external_port: external L4 port number of the service
966 :param local_addr: IPv4 address of the internal node
967 :param local_port: L4 port number of the internal node
968 :param protocol: IP protocol number
969 :param probability: probability of the internal node
970 :param vrf_id: VRF id of the internal node
971 :param is_add: 1 if add, 0 if delete
974 self.papi.nat44_lb_static_mapping_add_del_local,
976 'external_addr': external_addr,
977 'external_port': external_port,
981 'probability': probability,
983 'protocol': protocol})
985 def nat44_del_session(
992 ext_host_address=None,
994 """Delete NAT44 session
996 :param addr: IPv4 address
997 :param por: port number
998 :param protocol: IP protocol number
999 :param vrf_id: VRF ID
1000 :param is_in: 1 if inside network address and port pair, 0 if outside
1001 :param ext_host_address: external host IPv4 address
1002 :param ext_host_port: external host port
1004 if ext_host_address is None:
1006 self.papi.nat44_del_session,
1009 'protocol': protocol,
1014 self.papi.nat44_del_session,
1017 'protocol': protocol,
1020 'ext_host_valid': 1,
1021 'ext_host_address': ext_host_address,
1022 'ext_host_port': ext_host_port})
1024 def nat44_forwarding_enable_disable(
1027 """Enable/disable forwarding for NAT44
1029 :param enable: 1 for enable, 0 for disable
1032 self.papi.nat44_forwarding_enable_disable,
1035 def nat_det_add_del_map(
1042 """Add/delete deterministic NAT mapping
1044 :param is_add - 1 if add, 0 if delete
1045 :param in_addr - inside IP address
1046 :param in_plen - inside IP address prefix length
1047 :param out_addr - outside IP address
1048 :param out_plen - outside IP address prefix length
1051 self.papi.nat_det_add_del_map,
1056 'out_addr': out_addr,
1057 'out_plen': out_plen})
1059 def nat_det_forward(
1062 """Get outside address and port range from inside address
1064 :param in_addr - inside IP address
1067 self.papi.nat_det_forward,
1068 {'in_addr': in_addr,
1071 def nat_det_reverse(
1075 """Get inside address from outside address and port
1077 :param out_addr - outside IP address
1078 :param out_port - outside port
1081 self.papi.nat_det_reverse,
1082 {'out_addr': out_addr,
1083 'out_port': out_port})
1085 def nat_det_map_dump(self):
1086 """Dump deterministic NAT mappings
1088 :return: Dictionary of deterministic NAT mappings
1090 return self.api(self.papi.nat_det_map_dump, {})
1092 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1093 """Set TCP MSS rewriting configuration
1095 :param enable: disable(0)/enable(1) MSS rewriting feature
1096 :param mss_value: MSS value to be used for MSS rewriting
1099 self.papi.nat_set_mss_clamping,
1100 {'enable': enable, 'mss_value': mss_value})
1102 def nat_det_close_session_in(
1108 """Close deterministic NAT session using inside address and port
1110 :param in_addr - inside IP address
1111 :param in_port - inside port
1112 :param ext_addr - external host IP address
1113 :param ext_port - external host port
1116 self.papi.nat_det_close_session_in,
1117 {'in_addr': in_addr,
1119 'ext_addr': ext_addr,
1120 'ext_port': ext_port,
1123 def nat_det_session_dump(
1126 """Dump deterministic NAT sessions belonging to a user
1128 :param user_addr - inside IP address of the user
1129 :return: Dictionary of deterministic NAT sessions
1132 self.papi.nat_det_session_dump,
1134 'user_addr': user_addr})
1136 def nat64_add_del_interface(
1141 """Enable/disable NAT64 feature on the interface
1142 :param sw_if_index: Index of the interface
1143 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1144 :param is_add: 1 if add, 0 if delete (Default value = 1)
1147 self.papi.nat64_add_del_interface,
1148 {'sw_if_index': sw_if_index,
1149 'is_inside': is_inside,
1152 def nat64_add_del_static_bib(
1161 """Add/delete S-NAT static BIB entry
1163 :param in_ip: Inside IPv6 address
1164 :param out_ip: Outside IPv4 address
1165 :param in_port: Inside port number
1166 :param out_port: Outside port number
1167 :param protocol: IP protocol
1168 :param vrf_id: VRF ID (Default value = 0)
1169 :param is_add: 1 if add, 0 if delete (Default value = 1)
1172 self.papi.nat64_add_del_static_bib,
1181 def nat64_bib_dump(self, protocol=255):
1184 :param protocol: IP protocol (Default value = 255, all BIBs)
1185 :returns: Dictionary of NAT64 BIB entries
1187 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1189 def nat64_st_dump(self, protocol=255):
1190 """Dump NAT64 session table
1192 :param protocol: IP protocol (Default value = 255, all STs)
1193 :returns: Dictionary of NAT64 session table entries
1195 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1197 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1198 """Add/del NAT64 prefix
1200 :param prefix: NAT64 prefix
1201 :param plen: NAT64 prefix length
1202 :param vrf_id: VRF id of tenant (Default 0)
1203 :param is_add: 1 if add, 0 if delete (Default value = 1)
1206 self.papi.nat64_add_del_prefix,
1212 def nat64_add_del_interface_addr(
1216 """Add/del NAT64 address from interface
1218 :param sw_if_index: Software index of the interface
1219 :param is_add: 1 if add, 0 if delete (Default value = 1)
1221 return self.api(self.papi.nat64_add_del_interface_addr,
1222 {'is_add': is_add, 'sw_if_index': sw_if_index})
1224 def dslite_set_aftr_addr(self, ip6, ip4):
1225 """Set DS-Lite AFTR addresses
1227 :param ip4: IPv4 address
1228 :param ip6: IPv6 address
1231 self.papi.dslite_set_aftr_addr,
1235 def dslite_set_b4_addr(self, ip6, ip4):
1236 """Set DS-Lite B4 IPv6 address
1238 :param ip4: IPv4 address
1239 :param ip6: IPv6 address
1242 self.papi.dslite_set_b4_addr,
1246 def nat66_add_del_interface(
1251 """Enable/disable NAT66 feature on the interface
1252 :param sw_if_index: Index of the interface
1253 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1254 :param is_add: 1 if add, 0 if delete (Default value = 1)
1257 self.papi.nat66_add_del_interface,
1258 {'sw_if_index': sw_if_index,
1259 'is_inside': is_inside,
1262 def nat66_add_del_static_mapping(
1268 """Add/delete NAT66 static mapping
1270 :param in_ip: Inside IPv6 address
1271 :param out_ip: Outside IPv6 address
1272 :param vrf_id: VRF ID (Default value = 0)
1273 :param is_add: 1 if add, 0 if delete (Default value = 1)
1276 self.papi.nat66_add_del_static_mapping,
1277 {'local_ip_address': in_ip,
1278 'external_ip_address': out_ip,
1282 def nat_ha_set_listener(self, addr, port, path_mtu=512):
1283 """Set HA listener (local settings)
1285 :param addr: local IP4 address
1286 :param port: local UDP port number
1287 :param path_mtu: path MTU (Default value = 512)
1289 return self.api(self.papi.nat_ha_set_listener,
1290 {'ip_address': addr,
1292 'path_mtu': path_mtu})
1294 def nat_ha_get_listener(self):
1295 """Get HA listener/local configuration"""
1296 return self.api(self.papi.nat_ha_get_listener, {})
1298 def nat_ha_set_failover(self, addr, port, refresh=10):
1299 """Set HA failover (remote settings)
1301 :param addr: failover IP4 address
1302 :param port: failover UDP port number
1303 :param refresh: number of seconds after which to send session refresh
1305 return self.api(self.papi.nat_ha_set_failover,
1306 {'ip_address': addr,
1308 'session_refresh_interval': refresh})
1310 def nat_ha_resync(self, want_resync_event=1):
1311 """Resync HA (resend existing sessions to new failover)
1312 :param want_resync_event: if non-zero resync completed event sent
1314 return self.api(self.papi.nat_ha_resync,
1315 {'want_resync_event': want_resync_event,
1316 'pid': os.getpid()})
1318 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1319 detect_mult, local_addr, peer_addr, is_ipv6=0,
1320 bfd_key_id=None, conf_key_id=None):
1321 if bfd_key_id is None:
1322 return self.api(self.papi.bfd_udp_add,
1324 'sw_if_index': sw_if_index,
1325 'desired_min_tx': desired_min_tx,
1326 'required_min_rx': required_min_rx,
1327 'local_addr': local_addr,
1328 'peer_addr': peer_addr,
1330 'detect_mult': detect_mult,
1333 return self.api(self.papi.bfd_udp_add,
1335 'sw_if_index': sw_if_index,
1336 'desired_min_tx': desired_min_tx,
1337 'required_min_rx': required_min_rx,
1338 'local_addr': local_addr,
1339 'peer_addr': peer_addr,
1341 'detect_mult': detect_mult,
1342 'is_authenticated': 1,
1343 'bfd_key_id': bfd_key_id,
1344 'conf_key_id': conf_key_id,
1347 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1348 detect_mult, local_addr, peer_addr, is_ipv6=0):
1349 return self.api(self.papi.bfd_udp_mod,
1351 'sw_if_index': sw_if_index,
1352 'desired_min_tx': desired_min_tx,
1353 'required_min_rx': required_min_rx,
1354 'local_addr': local_addr,
1355 'peer_addr': peer_addr,
1357 'detect_mult': detect_mult,
1360 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1361 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1363 return self.api(self.papi.bfd_udp_auth_activate,
1365 'sw_if_index': sw_if_index,
1366 'local_addr': local_addr,
1367 'peer_addr': peer_addr,
1369 'is_delayed': 1 if is_delayed else 0,
1370 'bfd_key_id': bfd_key_id,
1371 'conf_key_id': conf_key_id,
1374 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1375 peer_addr, is_ipv6=0):
1376 return self.api(self.papi.bfd_udp_session_set_flags, {
1377 'admin_up_down': admin_up_down,
1378 'sw_if_index': sw_if_index,
1379 'local_addr': local_addr,
1380 'peer_addr': peer_addr,
1384 def want_bfd_events(self, enable_disable=1):
1385 return self.api(self.papi.want_bfd_events, {
1386 'enable_disable': enable_disable,
1390 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1391 return self.api(self.papi.bfd_auth_set_key, {
1392 'conf_key_id': conf_key_id,
1393 'auth_type': auth_type,
1395 'key_len': len(key),
1398 def classify_add_del_table(
1403 table_index=0xFFFFFFFF,
1405 memory_size=2097152,
1407 next_table_index=0xFFFFFFFF,
1408 miss_next_index=0xFFFFFFFF,
1409 current_data_flag=0,
1410 current_data_offset=0):
1414 :param match_n_vectors: (Default value = 1)
1415 :param table_index: (Default value = 0xFFFFFFFF)
1416 :param nbuckets: (Default value = 2)
1417 :param memory_size: (Default value = 2097152)
1418 :param skip_n_vectors: (Default value = 0)
1419 :param next_table_index: (Default value = 0xFFFFFFFF)
1420 :param miss_next_index: (Default value = 0xFFFFFFFF)
1421 :param current_data_flag: (Default value = 0)
1422 :param current_data_offset: (Default value = 0)
1425 mask_len = ((len(mask) - 1) / 16 + 1) * 16
1426 mask = mask + '\0' * (mask_len - len(mask))
1428 self.papi.classify_add_del_table,
1430 'table_index': table_index,
1431 'nbuckets': nbuckets,
1432 'memory_size': memory_size,
1433 'skip_n_vectors': skip_n_vectors,
1434 'match_n_vectors': match_n_vectors,
1435 'next_table_index': next_table_index,
1436 'miss_next_index': miss_next_index,
1437 'current_data_flag': current_data_flag,
1438 'current_data_offset': current_data_offset,
1439 'mask_len': mask_len,
1442 def classify_add_del_session(
1447 opaque_index=0xFFFFFFFF,
1448 hit_next_index=0xFFFFFFFF,
1456 :param opaque_index: (Default value = 0xFFFFFFFF)
1457 :param hit_next_index: (Default value = 0xFFFFFFFF)
1458 :param advance: (Default value = 0)
1459 :param action: (Default value = 0)
1460 :param metadata: (Default value = 0)
1463 match_len = ((len(match) - 1) / 16 + 1) * 16
1464 match = match + '\0' * (match_len - len(match))
1466 self.papi.classify_add_del_session,
1468 'table_index': table_index,
1469 'hit_next_index': hit_next_index,
1470 'opaque_index': opaque_index,
1473 'metadata': metadata,
1474 'match_len': match_len,
1477 def input_acl_set_interface(
1481 ip4_table_index=0xFFFFFFFF,
1482 ip6_table_index=0xFFFFFFFF,
1483 l2_table_index=0xFFFFFFFF):
1487 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1488 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1489 :param l2_table_index: (Default value = 0xFFFFFFFF)
1493 self.papi.input_acl_set_interface,
1494 {'sw_if_index': sw_if_index,
1495 'ip4_table_index': ip4_table_index,
1496 'ip6_table_index': ip6_table_index,
1497 'l2_table_index': l2_table_index,
1500 def output_acl_set_interface(
1504 ip4_table_index=0xFFFFFFFF,
1505 ip6_table_index=0xFFFFFFFF,
1506 l2_table_index=0xFFFFFFFF):
1510 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1511 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1512 :param l2_table_index: (Default value = 0xFFFFFFFF)
1516 self.papi.output_acl_set_interface,
1517 {'sw_if_index': sw_if_index,
1518 'ip4_table_index': ip4_table_index,
1519 'ip6_table_index': ip6_table_index,
1520 'l2_table_index': l2_table_index,
1523 def set_ipfix_exporter(
1530 collector_port=4739,
1533 self.papi.set_ipfix_exporter,
1535 'collector_address': collector_address,
1536 'collector_port': collector_port,
1537 'src_address': src_address,
1539 'path_mtu': path_mtu,
1540 'template_interval': template_interval,
1541 'udp_checksum': udp_checksum,
1544 def dhcp_proxy_config(self,
1552 self.papi.dhcp_proxy_config,
1554 'rx_vrf_id': rx_table_id,
1555 'server_vrf_id': server_table_id,
1558 'dhcp_server': dhcp_server,
1559 'dhcp_src_address': dhcp_src_address,
1562 def dhcp_proxy_set_vss(self,
1571 self.papi.dhcp_proxy_set_vss,
1574 'vss_type': vss_type,
1575 'vpn_ascii_id': vpn_ascii_id,
1577 'vpn_index': vpn_index,
1582 def dhcp_client_config(self,
1587 set_broadcast_flag=1,
1588 want_dhcp_events=0):
1590 self.papi.dhcp_client_config,
1594 'sw_if_index': sw_if_index,
1595 'hostname': hostname,
1597 'want_dhcp_event': want_dhcp_events,
1598 'set_broadcast_flag': set_broadcast_flag,
1602 def ip_mroute_add_del(self,
1608 next_hop_sw_if_index,
1618 IP Multicast Route add/del
1621 self.papi.ip_mroute_add_del,
1622 {'next_hop_sw_if_index': next_hop_sw_if_index,
1623 'entry_flags': e_flags,
1624 'itf_flags': i_flags,
1625 'table_id': table_id,
1629 'is_local': is_local,
1630 'bier_imp': bier_imp,
1631 'next_hop_afi': next_hop_afi,
1632 'grp_address_length': grp_address_length,
1633 'grp_address': grp_address,
1634 'src_address': src_address,
1635 'nh_address': next_hop_address})
1637 def lisp_enable_disable(self, is_enabled):
1639 self.papi.lisp_enable_disable,
1641 'is_en': is_enabled,
1644 def lisp_add_del_locator_set(self,
1648 self.papi.lisp_add_del_locator_set,
1651 'locator_set_name': ls_name
1654 def lisp_add_del_locator(self,
1661 self.papi.lisp_add_del_locator,
1664 'locator_set_name': ls_name,
1665 'sw_if_index': sw_if_index,
1666 'priority': priority,
1670 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1672 self.papi.lisp_locator_dump,
1674 'is_index_set': is_index_set,
1676 'ls_index': ls_index,
1679 def lisp_add_del_local_eid(self,
1689 self.papi.lisp_add_del_local_eid,
1691 'locator_set_name': ls_name,
1693 'eid_type': eid_type,
1695 'prefix_len': prefix_len,
1701 def lisp_eid_table_dump(self,
1709 self.papi.lisp_eid_table_dump,
1712 'prefix_length': prefix_length,
1714 'eid_type': eid_type,
1716 'filter': filter_opt,
1719 def lisp_add_del_remote_mapping(self,
1729 self.papi.lisp_add_del_remote_mapping,
1732 'eid_type': eid_type,
1734 'eid_len': eid_prefix_len,
1735 'rloc_num': rlocs_num,
1738 'is_src_dst': is_src_dst,
1741 def lisp_add_del_adjacency(self,
1750 self.papi.lisp_add_del_adjacency,
1754 'eid_type': eid_type,
1757 'leid_len': leid_len,
1758 'reid_len': reid_len,
1761 def gtpu_add_del_tunnel(
1767 mcast_sw_if_index=0xFFFFFFFF,
1769 decap_next_index=0xFFFFFFFF,
1773 :param is_add: (Default value = 1)
1774 :param is_ipv6: (Default value = 0)
1777 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1778 :param encap_vrf_id: (Default value = 0)
1779 :param decap_next_index: (Default value = 0xFFFFFFFF)
1780 :param teid: (Default value = 0)
1783 return self.api(self.papi.gtpu_add_del_tunnel,
1786 'src_address': src_addr,
1787 'dst_address': dst_addr,
1788 'mcast_sw_if_index': mcast_sw_if_index,
1789 'encap_vrf_id': encap_vrf_id,
1790 'decap_next_index': decap_next_index,
1793 def vxlan_gpe_add_del_tunnel(
1797 mcast_sw_if_index=0xFFFFFFFF,
1808 :param is_add: (Default value = 1)
1809 :param is_ipv6: (Default value = 0)
1810 :param encap_vrf_id: (Default value = 0)
1811 :param decap_vrf_id: (Default value = 0)
1812 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1813 :param protocol: (Default value = 3)
1814 :param vni: (Default value = 0)
1817 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1822 'mcast_sw_if_index': mcast_sw_if_index,
1823 'encap_vrf_id': encap_vrf_id,
1824 'decap_vrf_id': decap_vrf_id,
1825 'protocol': protocol,
1828 def vxlan_gbp_tunnel_add_del(
1832 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,
1863 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1864 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1865 {'sw_if_index': sw_if_index,
1866 '_no_type_conversion': True})
1868 def pppoe_add_del_session(
1878 :param is_add: (Default value = 1)
1879 :param is_ipv6: (Default value = 0)
1881 :param session_id: (Default value = 0)
1883 :param decap_vrf_id: (Default value = 0)
1886 return self.api(self.papi.pppoe_add_del_session,
1889 'session_id': session_id,
1890 'client_ip': client_ip,
1891 'decap_vrf_id': decap_vrf_id,
1892 'client_mac': client_mac})
1894 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1895 return self.api(self.papi.sr_mpls_policy_add,
1899 'n_segments': len(segments),
1900 'segments': segments})
1902 def sr_mpls_policy_del(self, bsid):
1903 return self.api(self.papi.sr_mpls_policy_del,
1906 def sr_localsid_add_del(self,
1913 sw_if_index=0xFFFFFFFF,
1917 """ Add/del IPv6 SR local-SID.
1920 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1921 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1924 :param is_del: (Default value = 0)
1925 :param end_psp: (Default value = 0)
1926 :param sw_if_index: (Default value = 0xFFFFFFFF)
1927 :param vlan_index: (Default value = 0)
1928 :param fib_table: (Default value = 0)
1931 self.papi.sr_localsid_add_del,
1933 'localsid': localsid,
1935 'behavior': behavior,
1936 'sw_if_index': sw_if_index,
1937 'vlan_index': vlan_index,
1938 'fib_table': fib_table,
1939 'nh_addr4': nh_addr4,
1940 'nh_addr6': nh_addr6
1954 :param bsid_addr: bindingSID of the SR Policy
1955 :param weight: weight of the sid list. optional. (default: 1)
1956 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1958 :param type: type/behavior of the SR policy. (default or spray) \
1960 :param fib_table: VRF where to install the FIB entry for the BSID \
1962 :param n_segments: number of segments \
1964 :param segments: a vector of IPv6 address composing the segment list \
1968 self.papi.sr_policy_add,
1969 {'bsid_addr': bsid_addr,
1971 'is_encap': is_encap,
1973 'fib_table': fib_table,
1974 'n_segments': n_segments,
1975 'segments': segments
1984 :param bsid: bindingSID of the SR Policy
1985 :param sr_policy_index: index of the sr policy (default: 0)
1988 self.papi.sr_policy_del,
1989 {'bsid_addr': bsid_addr,
1990 'sr_policy_index': sr_policy_index
1993 def sr_steering_add_del(
2004 Steer traffic L2 and L3 traffic through a given SR policy
2006 :param is_del: delete or add
2007 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2008 :param sr_policy: is the index of the SR Policy (alt to bsid)
2009 :param table_id: is the VRF where to install the FIB entry for the BSID
2010 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2011 :param mask_width: is the mask for L3 traffic type
2012 :param sw_if_index: is the incoming interface for L2 traffic
2013 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2016 self.papi.sr_steering_add_del,
2018 'bsid_addr': bsid_addr,
2019 'sr_policy_index': sr_policy_index,
2020 'table_id': table_id,
2021 'prefix_addr': prefix_addr,
2022 'mask_width': mask_width,
2023 'sw_if_index': sw_if_index,
2024 'traffic_type': traffic_type
2027 def acl_add_replace(self, acl_index, r, tag='',
2029 """Add/replace an ACL
2030 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2031 :param acl_rule r: ACL rules array.
2032 :param str tag: symbolic tag (description) for this ACL.
2033 :param int count: number of rules.
2035 return self.api(self.papi.acl_add_replace,
2036 {'acl_index': acl_index,
2040 expected_retval=expected_retval)
2042 def acl_del(self, acl_index, expected_retval=0):
2048 return self.api(self.papi.acl_del,
2049 {'acl_index': acl_index},
2050 expected_retval=expected_retval)
2052 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2054 return self.api(self.papi.acl_interface_set_acl_list,
2055 {'sw_if_index': sw_if_index,
2059 expected_retval=expected_retval)
2061 def acl_interface_set_etype_whitelist(self, sw_if_index,
2064 return self.api(self.papi.acl_interface_set_etype_whitelist,
2065 {'sw_if_index': sw_if_index,
2066 'count': len(whitelist),
2068 'whitelist': whitelist},
2069 expected_retval=expected_retval)
2071 def acl_interface_add_del(self,
2075 """ Add/Delete ACL to/from interface
2079 :param is_add: (Default value = 1)
2082 return self.api(self.papi.acl_interface_add_del,
2085 'sw_if_index': sw_if_index,
2086 'acl_index': acl_index})
2088 def acl_dump(self, acl_index, expected_retval=0):
2089 return self.api(self.papi.acl_dump,
2090 {'acl_index': acl_index},
2091 expected_retval=expected_retval)
2093 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2095 return self.api(self.papi.acl_interface_list_dump,
2096 {'sw_if_index': sw_if_index},
2097 expected_retval=expected_retval)
2099 def macip_acl_add(self, rules, tag=""):
2102 :param rules: list of rules for given acl
2106 return self.api(self.papi.macip_acl_add,
2108 'count': len(rules),
2111 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2114 :param rules: list of rules for given acl
2118 return self.api(self.papi.macip_acl_add_replace,
2119 {'acl_index': acl_index,
2121 'count': len(rules),
2124 def macip_acl_interface_add_del(self,
2128 """ Add MACIP acl to interface
2132 :param is_add: (Default value = 1)
2135 return self.api(self.papi.macip_acl_interface_add_del,
2137 'sw_if_index': sw_if_index,
2138 'acl_index': acl_index})
2140 def macip_acl_dump(self, acl_index=4294967295):
2141 """ Return MACIP acl dump
2145 self.papi.macip_acl_dump, {'acl_index': acl_index})
2147 def policer_add_del(self,
2158 conform_action_type=1,
2160 exceed_action_type=0,
2162 violate_action_type=0,
2164 return self.api(self.papi.policer_add_del,
2171 'rate_type': rate_type,
2172 'round_type': round_type,
2174 'color_aware': color_aware,
2175 'conform_action_type': conform_action_type,
2176 'conform_dscp': conform_dscp,
2177 'exceed_action_type': exceed_action_type,
2178 'exceed_dscp': exceed_dscp,
2179 'violate_action_type': violate_action_type,
2180 'violate_dscp': violate_dscp})
2182 def ip_punt_police(self,
2186 return self.api(self.papi.ip_punt_police,
2187 {'policer_index': policer_index,
2191 def ip_punt_redirect(self,
2196 return self.api(self.papi.ip_punt_redirect,
2197 {'punt': {'rx_sw_if_index': rx_sw_if_index,
2198 'tx_sw_if_index': tx_sw_if_index,
2202 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
2203 return self.api(self.papi.ip_punt_redirect_dump,
2204 {'sw_if_index': sw_if_index,
2205 'is_ipv6': is_ipv6})
2207 def bier_table_add_del(self,
2211 """ BIER Table add/del """
2213 self.papi.bier_table_add_del,
2214 {'bt_tbl_id': {"bt_set": bti.set_id,
2215 "bt_sub_domain": bti.sub_domain_id,
2216 "bt_hdr_len_id": bti.hdr_len_id},
2217 'bt_label': mpls_label,
2218 'bt_is_add': is_add})
2220 def bier_table_dump(self):
2221 return self.api(self.papi.bier_table_dump, {})
2223 def bier_route_add_del(self,
2229 """ BIER Route add/del """
2231 self.papi.bier_route_add_del,
2232 {'br_tbl_id': {"bt_set": bti.set_id,
2233 "bt_sub_domain": bti.sub_domain_id,
2234 "bt_hdr_len_id": bti.hdr_len_id},
2236 'br_n_paths': len(paths),
2238 'br_is_add': is_add,
2239 'br_is_replace': is_replace})
2241 def bier_route_dump(self, bti):
2243 self.papi.bier_route_dump,
2244 {'br_tbl_id': {"bt_set": bti.set_id,
2245 "bt_sub_domain": bti.sub_domain_id,
2246 "bt_hdr_len_id": bti.hdr_len_id}})
2248 def bier_imp_add(self,
2253 """ BIER Imposition Add """
2255 self.papi.bier_imp_add,
2256 {'bi_tbl_id': {"bt_set": bti.set_id,
2257 "bt_sub_domain": bti.sub_domain_id,
2258 "bt_hdr_len_id": bti.hdr_len_id},
2260 'bi_n_bytes': len(ibytes),
2261 'bi_bytes': ibytes})
2263 def bier_imp_del(self, bi_index):
2264 """ BIER Imposition del """
2266 self.papi.bier_imp_del,
2267 {'bi_index': bi_index})
2269 def bier_imp_dump(self):
2270 return self.api(self.papi.bier_imp_dump, {})
2272 def bier_disp_table_add_del(self,
2275 """ BIER Disposition Table add/del """
2277 self.papi.bier_disp_table_add_del,
2278 {'bdt_tbl_id': bdti,
2279 'bdt_is_add': is_add})
2281 def bier_disp_table_dump(self):
2282 return self.api(self.papi.bier_disp_table_dump, {})
2284 def bier_disp_entry_add_del(self,
2294 """ BIER Route add/del """
2296 while (len(lstack) < 16):
2299 self.papi.bier_disp_entry_add_del,
2300 {'bde_tbl_id': bdti,
2302 'bde_payload_proto': payload_proto,
2304 'bde_paths': [{'next_hop': next_hop,
2305 'table_id': next_hop_tbl_id,
2306 'afi': next_hop_afi,
2307 'rpf_id': next_hop_rpf_id,
2309 'label_stack': lstack}],
2310 'bde_is_add': is_add})
2312 def bier_disp_entry_dump(self, bdti):
2314 self.papi.bier_disp_entry_dump,
2315 {'bde_tbl_id': bdti})
2317 def session_enable_disable(self, is_enabled):
2319 self.papi.session_enable_disable,
2320 {'is_enable': is_enabled})
2322 def ipsec_spd_add_del(self, spd_id, is_add=1):
2323 """ SPD add/del - Wrapper to add or del ipsec SPD
2324 Sample CLI : 'ipsec spd add 1'
2326 :param spd_id - SPD ID to be created in the vpp . mandatory
2327 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2329 :returns: reply from the API
2332 self.papi.ipsec_spd_add_del, {
2333 'spd_id': spd_id, 'is_add': is_add})
2335 def ipsec_spds_dump(self):
2336 return self.api(self.papi.ipsec_spds_dump, {})
2338 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2339 """ IPSEC interface SPD add/del - \
2340 Wrapper to associate/disassociate SPD to interface in VPP
2341 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2343 :param spd_id - SPD ID to associate with the interface . mandatory
2344 :param sw_if_index - Interface Index which needs to ipsec \
2345 association mandatory
2346 :param is_add - add(1) or del(0) association with interface \
2347 (Default 1 - add) . optional
2348 :returns: reply from the API
2351 self.papi.ipsec_interface_add_del_spd,
2352 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
2354 def ipsec_spd_interface_dump(self, spd_index=None):
2355 return self.api(self.papi.ipsec_spd_interface_dump,
2356 {'spd_index': spd_index if spd_index else 0,
2357 'spd_index_valid': 1 if spd_index else 0})
2359 def ipsec_sad_entry_add_del(self,
2362 integrity_algorithm,
2367 tunnel_src_address='',
2368 tunnel_dst_address='',
2372 """ IPSEC SA add/del
2373 :param sad_id: security association ID
2374 :param spi: security param index of the SA in decimal
2375 :param integrity_algorithm:
2376 :param integrity_key:
2377 :param crypto_algorithm:
2379 :param protocol: AH(0) or ESP(1) protocol
2380 :param tunnel_src_address: tunnel mode outer src address
2381 :param tunnel_dst_address: tunnel mode outer dst address
2384 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
2385 crypto and ipsec algorithms
2388 self.papi.ipsec_sad_entry_add_del,
2395 'tunnel_src': tunnel_src_address,
2396 'tunnel_dst': tunnel_dst_address,
2397 'protocol': protocol,
2398 'integrity_algorithm': integrity_algorithm,
2400 'length': len(integrity_key),
2401 'data': integrity_key,
2403 'crypto_algorithm': crypto_algorithm,
2405 'length': len(crypto_key),
2413 def ipsec_sa_dump(self, sa_id=None):
2414 return self.api(self.papi.ipsec_sa_dump,
2415 {'sa_id': sa_id if sa_id else 0xffffffff})
2417 def ipsec_spd_entry_add_del(self,
2420 local_address_start,
2422 remote_address_start,
2423 remote_address_stop,
2425 local_port_stop=65535,
2426 remote_port_start=0,
2427 remote_port_stop=65535,
2435 """ IPSEC policy SPD add/del -
2436 Wrapper to configure ipsec SPD policy entries in VPP
2437 :param spd_id: SPD ID for the policy
2438 :param local_address_start: local-ip-range start address
2439 :param local_address_stop : local-ip-range stop address
2440 :param remote_address_start: remote-ip-range start address
2441 :param remote_address_stop : remote-ip-range stop address
2442 :param local_port_start: (Default value = 0)
2443 :param local_port_stop: (Default value = 65535)
2444 :param remote_port_start: (Default value = 0)
2445 :param remote_port_stop: (Default value = 65535)
2446 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
2447 :param sa_id: Security Association ID for mapping it to SPD
2448 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
2450 :param priority: value for the spd action (Default value = 100)
2451 :param is_outbound: flag for inbound(0) or outbound(1)
2453 :param is_add: (Default value = 1)
2456 self.papi.ipsec_spd_entry_add_del,
2463 'local_address_start': local_address_start,
2464 'local_address_stop': local_address_stop,
2465 'remote_address_start': remote_address_start,
2466 'remote_address_stop': remote_address_stop,
2467 'local_port_start': local_port_start,
2468 'local_port_stop': local_port_stop,
2469 'remote_port_start': remote_port_start,
2470 'remote_port_stop': remote_port_stop,
2471 'protocol': protocol,
2473 'priority': priority,
2474 'is_outbound': is_outbound,
2475 'is_ip_any': is_ip_any
2479 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
2480 return self.api(self.papi.ipsec_spd_dump,
2484 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
2485 remote_spi, crypto_alg, local_crypto_key,
2486 remote_crypto_key, integ_alg, local_integ_key,
2487 remote_integ_key, is_add=1, esn=0, salt=0,
2488 anti_replay=1, renumber=0, show_instance=0):
2490 self.papi.ipsec_tunnel_if_add_del,
2492 'local_ip': local_ip,
2493 'remote_ip': remote_ip,
2494 'local_spi': local_spi,
2495 'remote_spi': remote_spi,
2496 'crypto_alg': crypto_alg,
2497 'local_crypto_key_len': len(local_crypto_key),
2498 'local_crypto_key': local_crypto_key,
2499 'remote_crypto_key_len': len(remote_crypto_key),
2500 'remote_crypto_key': remote_crypto_key,
2501 'integ_alg': integ_alg,
2502 'local_integ_key_len': len(local_integ_key),
2503 'local_integ_key': local_integ_key,
2504 'remote_integ_key_len': len(remote_integ_key),
2505 'remote_integ_key': remote_integ_key,
2508 'anti_replay': anti_replay,
2509 'renumber': renumber,
2510 'show_instance': show_instance,
2514 def ipsec_gre_tunnel_add_del(self, local_ip, remote_ip,
2515 sa_out, sa_in, is_add=1):
2516 return self.api(self.papi.ipsec_gre_tunnel_add_del,
2522 'local_sa_id': sa_out,
2523 'remote_sa_id': sa_in
2527 def ipsec_select_backend(self, protocol, index):
2528 return self.api(self.papi.ipsec_select_backend,
2529 {'protocol': protocol, 'index': index})
2531 def ipsec_backend_dump(self):
2532 return self.api(self.papi.ipsec_backend_dump, {})
2534 def app_namespace_add_del(self,
2538 sw_if_index=0xFFFFFFFF,
2541 self.papi.app_namespace_add_del,
2543 'sw_if_index': sw_if_index,
2544 'ip4_fib_id': ip4_fib_id,
2545 'ip6_fib_id': ip6_fib_id,
2546 'namespace_id': namespace_id,
2547 'namespace_id_len': len(namespace_id)})
2549 def punt_socket_register(self, port, pathname, protocol=0x11,
2550 header_version=1, is_ip4=1):
2551 """ Register punt socket """
2552 return self.api(self.papi.punt_socket_register,
2553 {'header_version': header_version,
2554 'punt': {'ipv': is_ip4,
2555 'l4_protocol': protocol,
2557 'pathname': pathname})
2559 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
2560 """ Unregister punt socket """
2561 return self.api(self.papi.punt_socket_deregister,
2562 {'punt': {'ipv': is_ip4,
2563 'l4_protocol': protocol,
2566 def punt_socket_dump(self, is_ip6=1):
2567 """ Dump punt socket"""
2568 return self.api(self.papi.punt_socket_dump,
2569 {'is_ipv6': is_ip6})
2571 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
2573 """ GBP endpoint Add """
2574 return self.api(self.papi.gbp_endpoint_add,
2576 'sw_if_index': sw_if_index,
2587 def gbp_endpoint_del(self, handle):
2588 """ GBP endpoint Del """
2589 return self.api(self.papi.gbp_endpoint_del,
2592 def gbp_endpoint_dump(self):
2593 """ GBP endpoint Dump """
2594 return self.api(self.papi.gbp_endpoint_dump,
2595 {'_no_type_conversion': True})
2597 def gbp_endpoint_group_add(self, vnid, sclass, bd,
2598 rd, uplink_sw_if_index,
2600 """ GBP endpoint group Add """
2601 return self.api(self.papi.gbp_endpoint_group_add,
2604 'uplink_sw_if_index': uplink_sw_if_index,
2609 'retention': retention
2612 def gbp_endpoint_group_del(self, sclass):
2613 """ GBP endpoint group Del """
2614 return self.api(self.papi.gbp_endpoint_group_del,
2617 def gbp_bridge_domain_add(self, bd_id, flags,
2620 bm_flood_sw_if_index):
2621 """ GBP bridge-domain Add """
2622 return self.api(self.papi.gbp_bridge_domain_add,
2626 'bvi_sw_if_index': bvi_sw_if_index,
2627 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2628 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2632 def gbp_bridge_domain_del(self, bd_id):
2633 """ GBP bridge-domain Del """
2634 return self.api(self.papi.gbp_bridge_domain_del,
2637 def gbp_route_domain_add(self, rd_id,
2641 ip6_uu_sw_if_index):
2642 """ GBP route-domain Add """
2643 return self.api(self.papi.gbp_route_domain_add,
2646 'ip4_table_id': ip4_table_id,
2647 'ip6_table_id': ip6_table_id,
2648 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2649 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2653 def gbp_route_domain_del(self, rd_id):
2654 """ GBP route-domain Del """
2655 return self.api(self.papi.gbp_route_domain_del,
2658 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2659 """ GBP recirc Add/Del """
2660 return self.api(self.papi.gbp_recirc_add_del,
2664 'sw_if_index': sw_if_index,
2667 def gbp_recirc_dump(self):
2668 """ GBP recirc Dump """
2669 return self.api(self.papi.gbp_recirc_dump, {})
2671 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2672 """ GBP recirc Add/Del """
2673 return self.api(self.papi.gbp_ext_itf_add_del,
2676 'sw_if_index': sw_if_index,
2680 def gbp_ext_itf_dump(self):
2681 """ GBP recirc Dump """
2682 return self.api(self.papi.gbp_ext_itf_dump, {})
2684 def gbp_subnet_add_del(self, is_add, rd_id,
2686 sw_if_index=0xffffffff,
2688 """ GBP Subnet Add/Del """
2689 return self.api(self.papi.gbp_subnet_add_del,
2693 'sw_if_index': sw_if_index,
2698 def gbp_subnet_dump(self):
2699 """ GBP Subnet Dump """
2700 return self.api(self.papi.gbp_subnet_dump,
2701 {'_no_type_conversion': True})
2703 def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2704 rules, allowed_ethertypes):
2705 """ GBP contract Add/Del """
2706 return self.api(self.papi.gbp_contract_add_del,
2709 'acl_index': acl_index,
2712 'n_rules': len(rules),
2714 'n_ether_types': len(allowed_ethertypes),
2715 'allowed_ethertypes': allowed_ethertypes}})
2717 def gbp_contract_dump(self):
2718 """ GBP contract Dump """
2719 return self.api(self.papi.gbp_contract_dump, {})
2721 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2722 """ GBP VXLAN tunnel add """
2723 return self.api(self.papi.gbp_vxlan_tunnel_add,
2728 'bd_rd_id': bd_rd_id,
2733 def gbp_vxlan_tunnel_del(self, vni):
2734 """ GBP VXLAN tunnel del """
2735 return self.api(self.papi.gbp_vxlan_tunnel_del,
2740 def gbp_vxlan_tunnel_dump(self):
2741 """ GBP VXLAN tunnel add/del """
2742 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2744 def qos_egress_map_update(self, id, outputs):
2745 """ QOS egress map update """
2746 return self.api(self.papi.qos_egress_map_update,
2750 def qos_egress_map_delete(self, id):
2751 """ QOS egress map delete """
2752 return self.api(self.papi.qos_egress_map_delete,
2755 def qos_mark_enable_disable(self, sw_if_index,
2759 """ QOS Mark Enable/Disable """
2760 return self.api(self.papi.qos_mark_enable_disable,
2762 'sw_if_index': sw_if_index,
2763 'output_source': output_source,
2766 def igmp_enable_disable(self, sw_if_index, enable, host):
2767 """ Enable/disable IGMP on a given interface """
2768 return self.api(self.papi.igmp_enable_disable,
2771 'sw_if_index': sw_if_index})
2773 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2774 """ Add/del IGMP proxy device """
2775 return self.api(self.papi.igmp_proxy_device_add_del,
2776 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2779 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2780 """ Add/del interface to/from IGMP proxy device """
2781 return self.api(self.papi.igmp_proxy_device_add_del_interface,
2782 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2785 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2786 """ Listen for new (S,G) on specified interface
2788 :param enable: add/del
2789 :param sw_if_index: interface sw index
2790 :param saddr: source ip4 addr
2791 :param gaddr: group ip4 addr
2793 return self.api(self.papi.igmp_listen,
2798 'sw_if_index': sw_if_index,
2799 'n_srcs': len(saddrs),
2805 def igmp_clear_interface(self, sw_if_index):
2806 """ Remove all (S,G)s from specified interface
2807 doesn't send IGMP report!
2810 self.papi.igmp_clear_interface, {
2811 'sw_if_index': sw_if_index})
2813 def want_igmp_events(self, enable=1):
2814 return self.api(self.papi.want_igmp_events, {'enable': enable,
2815 'pid': os.getpid()})
2823 interface_id=0xFFFFFFFF):
2826 :param lb: load balance
2827 :param use_custom_mac: use custom mac
2828 :param mac_address: mac address
2829 :param interface_id: custom interface ID
2832 self.papi.bond_create,
2835 'use_custom_mac': use_custom_mac,
2836 'mac_address': mac_address,
2840 def pipe_delete(self, parent_sw_if_index):
2841 return self.api(self.papi.pipe_delete,
2842 {'parent_sw_if_index': parent_sw_if_index})
2856 return self.api(self.papi.memif_create,
2859 'rx_queues': rx_queues,
2860 'tx_queues': tx_queues,
2862 'socket_id': socket_id,
2864 'ring_size': ring_size,
2865 'buffer_size': buffer_size,
2866 'hw_addr': hw_addr})
2868 def svs_table_add_del(self, af, table_id, is_add=1):
2869 return self.api(self.papi.svs_table_add_del,
2871 'table_id': table_id,
2876 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2877 return self.api(self.papi.svs_route_add_del,
2879 'table_id': table_id,
2880 'source_table_id': src_table_id,
2885 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2886 return self.api(self.papi.svs_enable_disable,
2889 'table_id': table_id,
2890 'sw_if_index': sw_if_index,
2891 'is_enable': is_enable,