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_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')
229 self.vpp = VPP(logger=test_class.logger,
230 read_timeout=read_timeout)
231 self._events = deque()
236 def assert_negative_api_retval(self):
237 """ Expect API failure - used with with, e.g.:
238 with self.vapi.assert_negative_api_retval():
239 self.vapi.<api call expected to fail>
241 self._expect_stack.append(self._expect_api_retval)
242 self._expect_api_retval = self._negative
245 def assert_zero_api_retval(self):
246 """ Expect API success - used with with, e.g.:
247 with self.vapi.assert_negative_api_retval():
248 self.vapi.<api call expected to succeed>
250 note: this is useful only inside another with block
251 as success is the default expected value
253 self._expect_stack.append(self._expect_api_retval)
254 self._expect_api_retval = self._zero
257 def __exit__(self, exc_type, exc_value, traceback):
258 self._expect_api_retval = self._expect_stack.pop()
260 def register_hook(self, hook):
261 """Replace hook registration with new hook
268 def collect_events(self):
269 """ Collect all events from the internal queue and clear the queue. """
271 self._events = deque()
274 def wait_for_event(self, timeout, name=None):
275 """ Wait for and return next event. """
277 self.test_class.logger.debug("Expecting event '%s' within %ss",
280 self.test_class.logger.debug("Expecting event within %ss",
283 self.test_class.logger.debug("Not waiting, event already queued")
284 limit = time.time() + timeout
285 while time.time() < limit:
287 e = self._events.popleft()
288 if name and type(e).__name__ != name:
290 "Unexpected event received: %s, expected: %s" %
291 (type(e).__name__, name))
292 self.test_class.logger.debug("Returning event %s:%s" %
295 self.test_class.sleep(0) # yield
296 raise Exception("Event did not occur within timeout")
298 def __call__(self, name, event):
299 """ Enqueue event in the internal event queue. """
300 # FIXME use the name instead of relying on type(e).__name__ ?
301 # FIXME #2 if this throws, it is eaten silently, Ole?
302 self.test_class.logger.debug("New event: %s: %s" % (name, event))
303 self._events.append(event)
305 def factory(self, name, apifn):
307 fields = apifn._func.msg.fields
309 # add positional and kw arguments
311 for i, o in enumerate(fields[3:]):
318 if name in defaultmapping:
319 for k, v in iteritems(defaultmapping[name]):
323 return self.api(apifn, d)
327 def __getattribute__(self, name):
329 method = super(VppPapiProvider, self).__getattribute__(name)
330 except AttributeError:
331 method = self.factory(name, getattr(self.papi, name))
332 # lazily load the method so we don't need to call factory
333 # again for this name.
334 setattr(self, name, method)
338 """Connect the API to VPP"""
339 self.vpp.connect(self.name, self.shm_prefix)
340 self.papi = self.vpp.api
341 self.vpp.register_event_callback(self)
343 def disconnect(self):
344 """Disconnect the API from VPP"""
345 self.vpp.disconnect()
347 def api(self, api_fn, api_args, expected_retval=0):
348 """ Call API function and check it's return value.
349 Call the appropriate hooks before and after the API call
351 :param api_fn: API function to call
352 :param api_args: tuple of API function arguments
353 :param expected_retval: Expected return value (Default value = 0)
354 :returns: reply from the API
357 self.hook.before_api(api_fn.__name__, api_args)
358 reply = api_fn(**api_args)
359 if self._expect_api_retval == self._negative:
360 if hasattr(reply, 'retval') and reply.retval >= 0:
361 msg = "API call passed unexpectedly: expected negative " \
362 "return value instead of %d in %s" % \
363 (reply.retval, moves.reprlib.repr(reply))
364 self.test_class.logger.info(msg)
365 raise UnexpectedApiReturnValueError(msg)
366 elif self._expect_api_retval == self._zero:
367 if hasattr(reply, 'retval') and reply.retval != expected_retval:
368 msg = "API call failed, expected %d return value instead " \
369 "of %d in %s" % (expected_retval, reply.retval,
370 moves.reprlib.repr(reply))
371 self.test_class.logger.info(msg)
372 raise UnexpectedApiReturnValueError(msg)
374 raise Exception("Internal error, unexpected value for "
375 "self._expect_api_retval %s" %
376 self._expect_api_retval)
377 self.hook.after_api(api_fn.__name__, api_args)
381 """ Execute a CLI, calling the before/after hooks appropriately.
383 :param cli: CLI to execute
387 self.hook.before_cli(cli)
389 r = self.papi.cli_inband(cmd=cli)
390 self.hook.after_cli(cli)
391 if hasattr(r, 'reply'):
394 def ppcli(self, cli):
395 """ Helper method to print CLI command in case of info logging level.
397 :param cli: CLI to execute
400 return cli + "\n" + str(self.cli(cli))
402 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
403 return self.api(self.papi.want_ip4_arp_events,
404 {'enable_disable': enable_disable,
406 'pid': os.getpid(), })
408 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
409 return self.api(self.papi.want_ip6_nd_events,
410 {'enable_disable': enable_disable,
412 'pid': os.getpid(), })
414 def want_ip6_ra_events(self, enable_disable=1):
415 return self.api(self.papi.want_ip6_ra_events,
416 {'enable_disable': enable_disable,
417 'pid': os.getpid(), })
419 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
421 return self.api(self.papi.ip6nd_send_router_solicitation,
426 'sw_if_index': sw_if_index})
428 def want_interface_events(self, enable_disable=1):
429 return self.api(self.papi.want_interface_events,
430 {'enable_disable': enable_disable,
431 'pid': os.getpid(), })
433 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
434 max_macs_in_event=0, learn_limit=0):
435 return self.api(self.papi.want_l2_macs_events,
436 {'enable_disable': enable_disable,
437 'scan_delay': scan_delay,
438 'max_macs_in_event': max_macs_in_event,
439 'learn_limit': learn_limit,
440 'pid': os.getpid(), })
442 def want_dhcp6_reply_events(self, enable_disable=1):
443 return self.api(self.papi.want_dhcp6_reply_events,
444 {'enable_disable': enable_disable,
447 def want_dhcp6_pd_reply_events(self, enable_disable=1):
448 return self.api(self.papi.want_dhcp6_pd_reply_events,
449 {'enable_disable': enable_disable,
452 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
453 prefixes, server_index=0xFFFFFFFF,
454 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
456 return self.api(self.papi.dhcp6_pd_send_client_message,
457 {'sw_if_index': sw_if_index,
458 'server_index': server_index,
464 'msg_type': msg_type,
467 'n_prefixes': len(prefixes),
468 'prefixes': prefixes})
470 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
472 return self.api(self.papi.dhcp6_client_enable_disable,
473 {'sw_if_index': sw_if_index,
476 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
478 return self.api(self.papi.dhcp6_pd_client_enable_disable,
479 {'sw_if_index': sw_if_index,
480 'prefix_group': prefix_group,
483 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
484 prefix_length, prefix_group,
486 return self.api(self.papi.ip6_add_del_address_using_prefix,
487 {'sw_if_index': sw_if_index,
488 'prefix_group': prefix_group,
490 'prefix_length': prefix_length,
493 def sw_interface_set_mac_address(self, sw_if_index, mac):
494 return self.api(self.papi.sw_interface_set_mac_address,
495 {'sw_if_index': sw_if_index,
498 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
499 """Create p2p ethernet subinterface
501 :param sw_if_index: main (parent) interface
502 :param remote_mac: client (remote) mac address
506 self.papi.p2p_ethernet_add,
507 {'parent_if_index': sw_if_index,
508 'remote_mac': remote_mac,
509 'subif_id': subif_id})
511 def p2p_ethernet_del(self, sw_if_index, remote_mac):
512 """Delete p2p ethernet subinterface
514 :param sw_if_index: main (parent) interface
515 :param remote_mac: client (remote) mac address
519 self.papi.p2p_ethernet_del,
520 {'parent_if_index': sw_if_index,
521 'remote_mac': remote_mac})
523 def create_vlan_subif(self, sw_if_index, vlan):
530 return self.api(self.papi.create_vlan_subif,
531 {'sw_if_index': sw_if_index,
534 def create_loopback(self, mac=''):
537 :param mac: (Optional)
539 return self.api(self.papi.create_loopback,
540 {'mac_address': mac})
542 def ip_neighbor_add_del(self,
548 """ Add neighbor MAC to IPv4 or IPv6 address.
553 :param is_add: (Default value = 1)
554 :param flags: (Default value = 0/NONE)
557 self.papi.ip_neighbor_add_del,
561 'sw_if_index': sw_if_index,
563 'mac_address': mac_address,
564 'ip_address': ip_address
569 def proxy_arp_add_del(self,
574 """ Config Proxy Arp Range.
576 :param low_address: Start address in the rnage to Proxy for
577 :param hi_address: End address in the rnage to Proxy for
578 :param vrf_id: The VRF/table in which to proxy
582 self.papi.proxy_arp_add_del,
585 'table_id': table_id,
591 def proxy_arp_intfc_enable_disable(self,
594 """ Enable/Disable an interface for proxy ARP requests
596 :param sw_if_index: Interface
597 :param enable_disable: Enable/Disable
601 self.papi.proxy_arp_intfc_enable_disable,
602 {'sw_if_index': sw_if_index,
603 'enable_disable': is_enable
607 def gre_add_del_tunnel(self,
620 :param outer_fib_id: (Default value = 0)
621 :param tunnel_type: (Default value = 0)
622 :param instance: (Default value = 0xFFFFFFFF)
623 :param session_id: (Default value = 0)
624 :param is_add: (Default value = 1)
625 :param is_ipv6: (Default value = 0)
629 self.papi.gre_add_del_tunnel,
632 'tunnel_type': tunnel_type,
633 'instance': instance,
634 'src_address': src_address,
635 'dst_address': dst_address,
636 'outer_fib_id': outer_fib_id,
637 'session_id': session_id}
640 def udp_encap_add(self,
651 :param outer_fib_id: (Default value = 0)
655 self.papi.udp_encap_add,
660 'src_port': src_port,
661 'dst_port': dst_port,
666 def mpls_table_add_del(
673 :param is_add: (Default value = 1)
678 self.papi.mpls_table_add_del,
679 {'mt_table_id': table_id,
680 'mt_is_add': is_add})
682 def mpls_ip_bind_unbind(
694 self.papi.mpls_ip_bind_unbind,
695 {'mb_mpls_table_id': table_id,
697 'mb_ip_table_id': ip_table_id,
698 'mb_is_bind': is_bind,
700 'mb_address_length': dst_address_length,
701 'mb_address': dst_address})
703 def mpls_tunnel_add_del(
706 next_hop_proto_is_ip4,
708 next_hop_sw_if_index=0xFFFFFFFF,
711 next_hop_n_out_labels=0,
712 next_hop_out_label_stack=[],
713 next_hop_via_label=MPLS_LABEL_INVALID,
719 :param dst_address_length:
720 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
722 :param next_hop_address:
723 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
724 :param vrf_id: (Default value = 0)
725 :param lookup_in_vrf: (Default value = 0)
726 :param classify_table_index: (Default value = 0xFFFFFFFF)
727 :param is_add: (Default value = 1)
728 :param is_drop: (Default value = 0)
729 :param is_ipv6: (Default value = 0)
730 :param is_local: (Default value = 0)
731 :param is_classify: (Default value = 0)
732 :param is_multipath: (Default value = 0)
733 :param is_resolve_host: (Default value = 0)
734 :param is_resolve_attached: (Default value = 0)
735 :param next_hop_weight: (Default value = 1)
736 :param is_multicast: (Default value = 0)
740 self.papi.mpls_tunnel_add_del,
741 {'mt_sw_if_index': tun_sw_if_index,
743 'mt_l2_only': l2_only,
744 'mt_is_multicast': is_multicast,
745 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
746 'mt_next_hop_weight': next_hop_weight,
747 'mt_next_hop': next_hop_address,
748 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
749 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
750 'mt_next_hop_table_id': next_hop_table_id,
751 'mt_next_hop_via_label': next_hop_via_label,
752 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
754 def nat44_interface_add_del_feature(
759 """Enable/disable NAT44 feature on the interface
761 :param sw_if_index: Software index of the interface
762 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
763 :param is_add: 1 if add, 0 if delete (Default value = 1)
766 self.papi.nat44_interface_add_del_feature,
768 'is_inside': is_inside,
769 'sw_if_index': sw_if_index})
771 def nat44_interface_add_del_output_feature(
776 """Enable/disable NAT44 output feature on the interface
778 :param sw_if_index: Software index of the interface
779 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
780 :param is_add: 1 if add, 0 if delete (Default value = 1)
783 self.papi.nat44_interface_add_del_output_feature,
785 'is_inside': is_inside,
786 'sw_if_index': sw_if_index})
788 def nat44_add_del_static_mapping(
792 external_sw_if_index=0xFFFFFFFF,
803 """Add/delete NAT44 static mapping
805 :param local_ip: Local IP address
806 :param external_ip: External IP address
807 :param external_sw_if_index: External interface instead of IP address
808 :param local_port: Local port number (Default value = 0)
809 :param external_port: External port number (Default value = 0)
810 :param addr_only: 1 if address only mapping, 0 if address and port
811 :param vrf_id: VRF ID
812 :param protocol: IP protocol (Default value = 0)
813 :param twice_nat: 1 if translate external host address and port
814 :param self_twice_nat: 1 if translate external host address and port
815 whenever external host address equals
816 local address of internal host
817 :param out2in_only: if 1 rule is matching only out2in direction
818 :param tag: Opaque string tag
819 :param is_add: 1 if add, 0 if delete (Default value = 1)
822 self.papi.nat44_add_del_static_mapping,
824 'addr_only': addr_only,
825 'local_ip_address': local_ip,
826 'external_ip_address': external_ip,
827 'local_port': local_port,
828 'external_port': external_port,
829 'external_sw_if_index': external_sw_if_index,
831 'protocol': protocol,
832 'twice_nat': twice_nat,
833 'self_twice_nat': self_twice_nat,
834 'out2in_only': out2in_only,
837 def nat44_add_del_identity_mapping(
840 sw_if_index=0xFFFFFFFF,
847 """Add/delete NAT44 identity mapping
849 :param ip: IP address (Default value = 0)
850 :param sw_if_index: Interface instead of IP address
851 :param port: Port number (Default value = 0)
852 :param addr_only: 1 if address only mapping, 0 if address and port
853 :param vrf_id: VRF ID
854 :param protocol: IP protocol (Default value = 0)
855 :param tag: Opaque string tag
856 :param is_add: 1 if add, 0 if delete (Default value = 1)
859 self.papi.nat44_add_del_identity_mapping,
861 'addr_only': addr_only,
864 'sw_if_index': sw_if_index,
867 'protocol': protocol})
869 def nat44_add_del_address_range(
876 """Add/del NAT44 address range
878 :param first_ip_address: First IP address
879 :param last_ip_address: Last IP address
880 :param vrf_id: VRF id for the address range
881 :param twice_nat: twice NAT address for extenral hosts
882 :param is_add: 1 if add, 0 if delete (Default value = 1)
885 self.papi.nat44_add_del_address_range,
886 {'first_ip_address': first_ip_address,
887 'last_ip_address': last_ip_address,
889 'twice_nat': twice_nat,
892 def nat44_add_del_interface_addr(
897 """Add/del NAT44 address from interface
899 :param sw_if_index: Software index of the interface
900 :param twice_nat: twice NAT address for external hosts
901 :param is_add: 1 if add, 0 if delete (Default value = 1)
904 self.papi.nat44_add_del_interface_addr,
906 'sw_if_index': sw_if_index,
907 'twice_nat': twice_nat})
909 def nat44_add_del_lb_static_mapping(
922 """Add/delete NAT44 load balancing static mapping
924 :param twice_nat: 1 if translate external host address and port
925 :param tag: Opaque string tag
926 :param affinity: if 0 disabled, otherwise client IP affinity timeout
927 :param is_add - 1 if add, 0 if delete
930 self.papi.nat44_add_del_lb_static_mapping,
932 'external_addr': external_addr,
933 'external_port': external_port,
934 'protocol': protocol,
935 'twice_nat': twice_nat,
936 'self_twice_nat': self_twice_nat,
937 'out2in_only': out2in_only,
939 'affinity': affinity,
940 'local_num': local_num,
943 def nat44_lb_static_mapping_add_del_local(
953 """Add/delete NAT44 load-balancing static mapping rule backend
955 :param external_addr: external IPv4 address of the service
956 :param external_port: external L4 port number of the service
957 :param local_addr: IPv4 address of the internal node
958 :param local_port: L4 port number of the internal node
959 :param protocol: IP protocol number
960 :param probability: probability of the internal node
961 :param vrf_id: VRF id of the internal node
962 :param is_add: 1 if add, 0 if delete
965 self.papi.nat44_lb_static_mapping_add_del_local,
967 'external_addr': external_addr,
968 'external_port': external_port,
972 'probability': probability,
974 'protocol': protocol})
976 def nat44_del_session(
983 ext_host_address=None,
985 """Delete NAT44 session
987 :param addr: IPv4 address
988 :param por: port number
989 :param protocol: IP protocol number
990 :param vrf_id: VRF ID
991 :param is_in: 1 if inside network address and port pair, 0 if outside
992 :param ext_host_address: external host IPv4 address
993 :param ext_host_port: external host port
995 if ext_host_address is None:
997 self.papi.nat44_del_session,
1000 'protocol': protocol,
1005 self.papi.nat44_del_session,
1008 'protocol': protocol,
1011 'ext_host_valid': 1,
1012 'ext_host_address': ext_host_address,
1013 'ext_host_port': ext_host_port})
1015 def nat44_forwarding_enable_disable(
1018 """Enable/disable forwarding for NAT44
1020 :param enable: 1 for enable, 0 for disable
1023 self.papi.nat44_forwarding_enable_disable,
1026 def nat_det_add_del_map(
1033 """Add/delete deterministic NAT mapping
1035 :param is_add - 1 if add, 0 if delete
1036 :param in_addr - inside IP address
1037 :param in_plen - inside IP address prefix length
1038 :param out_addr - outside IP address
1039 :param out_plen - outside IP address prefix length
1042 self.papi.nat_det_add_del_map,
1047 'out_addr': out_addr,
1048 'out_plen': out_plen})
1050 def nat_det_forward(
1053 """Get outside address and port range from inside address
1055 :param in_addr - inside IP address
1058 self.papi.nat_det_forward,
1059 {'in_addr': in_addr,
1062 def nat_det_reverse(
1066 """Get inside address from outside address and port
1068 :param out_addr - outside IP address
1069 :param out_port - outside port
1072 self.papi.nat_det_reverse,
1073 {'out_addr': out_addr,
1074 'out_port': out_port})
1076 def nat_det_map_dump(self):
1077 """Dump deterministic NAT mappings
1079 :return: Dictionary of deterministic NAT mappings
1081 return self.api(self.papi.nat_det_map_dump, {})
1083 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1084 """Set TCP MSS rewriting configuration
1086 :param enable: disable(0)/enable(1) MSS rewriting feature
1087 :param mss_value: MSS value to be used for MSS rewriting
1090 self.papi.nat_set_mss_clamping,
1091 {'enable': enable, 'mss_value': mss_value})
1093 def nat_det_close_session_in(
1099 """Close deterministic NAT session using inside address and port
1101 :param in_addr - inside IP address
1102 :param in_port - inside port
1103 :param ext_addr - external host IP address
1104 :param ext_port - external host port
1107 self.papi.nat_det_close_session_in,
1108 {'in_addr': in_addr,
1110 'ext_addr': ext_addr,
1111 'ext_port': ext_port,
1114 def nat_det_session_dump(
1117 """Dump deterministic NAT sessions belonging to a user
1119 :param user_addr - inside IP address of the user
1120 :return: Dictionary of deterministic NAT sessions
1123 self.papi.nat_det_session_dump,
1125 'user_addr': user_addr})
1127 def nat64_add_del_interface(
1132 """Enable/disable NAT64 feature on the interface
1133 :param sw_if_index: Index of the interface
1134 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1135 :param is_add: 1 if add, 0 if delete (Default value = 1)
1138 self.papi.nat64_add_del_interface,
1139 {'sw_if_index': sw_if_index,
1140 'is_inside': is_inside,
1143 def nat64_add_del_static_bib(
1152 """Add/delete S-NAT static BIB entry
1154 :param in_ip: Inside IPv6 address
1155 :param out_ip: Outside IPv4 address
1156 :param in_port: Inside port number
1157 :param out_port: Outside port number
1158 :param protocol: IP protocol
1159 :param vrf_id: VRF ID (Default value = 0)
1160 :param is_add: 1 if add, 0 if delete (Default value = 1)
1163 self.papi.nat64_add_del_static_bib,
1172 def nat64_bib_dump(self, protocol=255):
1175 :param protocol: IP protocol (Default value = 255, all BIBs)
1176 :returns: Dictionary of NAT64 BIB entries
1178 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1180 def nat64_st_dump(self, protocol=255):
1181 """Dump NAT64 session table
1183 :param protocol: IP protocol (Default value = 255, all STs)
1184 :returns: Dictionary of NAT64 session table entries
1186 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1188 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1189 """Add/del NAT64 prefix
1191 :param prefix: NAT64 prefix
1192 :param plen: NAT64 prefix length
1193 :param vrf_id: VRF id of tenant (Default 0)
1194 :param is_add: 1 if add, 0 if delete (Default value = 1)
1197 self.papi.nat64_add_del_prefix,
1203 def nat64_add_del_interface_addr(
1207 """Add/del NAT64 address from interface
1209 :param sw_if_index: Software index of the interface
1210 :param is_add: 1 if add, 0 if delete (Default value = 1)
1212 return self.api(self.papi.nat64_add_del_interface_addr,
1213 {'is_add': is_add, 'sw_if_index': sw_if_index})
1215 def dslite_set_aftr_addr(self, ip6, ip4):
1216 """Set DS-Lite AFTR addresses
1218 :param ip4: IPv4 address
1219 :param ip6: IPv6 address
1222 self.papi.dslite_set_aftr_addr,
1226 def dslite_set_b4_addr(self, ip6, ip4):
1227 """Set DS-Lite B4 IPv6 address
1229 :param ip4: IPv4 address
1230 :param ip6: IPv6 address
1233 self.papi.dslite_set_b4_addr,
1237 def nat66_add_del_interface(
1242 """Enable/disable NAT66 feature on the interface
1243 :param sw_if_index: Index of the interface
1244 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1245 :param is_add: 1 if add, 0 if delete (Default value = 1)
1248 self.papi.nat66_add_del_interface,
1249 {'sw_if_index': sw_if_index,
1250 'is_inside': is_inside,
1253 def nat66_add_del_static_mapping(
1259 """Add/delete NAT66 static mapping
1261 :param in_ip: Inside IPv6 address
1262 :param out_ip: Outside IPv6 address
1263 :param vrf_id: VRF ID (Default value = 0)
1264 :param is_add: 1 if add, 0 if delete (Default value = 1)
1267 self.papi.nat66_add_del_static_mapping,
1268 {'local_ip_address': in_ip,
1269 'external_ip_address': out_ip,
1273 def nat_ha_set_listener(self, addr, port, path_mtu=512):
1274 """Set HA listener (local settings)
1276 :param addr: local IP4 address
1277 :param port: local UDP port number
1278 :param path_mtu: path MTU (Default value = 512)
1280 return self.api(self.papi.nat_ha_set_listener,
1281 {'ip_address': addr,
1283 'path_mtu': path_mtu})
1285 def nat_ha_get_listener(self):
1286 """Get HA listener/local configuration"""
1287 return self.api(self.papi.nat_ha_get_listener, {})
1289 def nat_ha_set_failover(self, addr, port, refresh=10):
1290 """Set HA failover (remote settings)
1292 :param addr: failover IP4 address
1293 :param port: failover UDP port number
1294 :param refresh: number of seconds after which to send session refresh
1296 return self.api(self.papi.nat_ha_set_failover,
1297 {'ip_address': addr,
1299 'session_refresh_interval': refresh})
1301 def nat_ha_resync(self, want_resync_event=1):
1302 """Resync HA (resend existing sessions to new failover)
1303 :param want_resync_event: if non-zero resync completed event sent
1305 return self.api(self.papi.nat_ha_resync,
1306 {'want_resync_event': want_resync_event,
1307 'pid': os.getpid()})
1309 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1310 detect_mult, local_addr, peer_addr, is_ipv6=0,
1311 bfd_key_id=None, conf_key_id=None):
1312 if bfd_key_id is None:
1313 return self.api(self.papi.bfd_udp_add,
1315 'sw_if_index': sw_if_index,
1316 'desired_min_tx': desired_min_tx,
1317 'required_min_rx': required_min_rx,
1318 'local_addr': local_addr,
1319 'peer_addr': peer_addr,
1321 'detect_mult': detect_mult,
1324 return self.api(self.papi.bfd_udp_add,
1326 'sw_if_index': sw_if_index,
1327 'desired_min_tx': desired_min_tx,
1328 'required_min_rx': required_min_rx,
1329 'local_addr': local_addr,
1330 'peer_addr': peer_addr,
1332 'detect_mult': detect_mult,
1333 'is_authenticated': 1,
1334 'bfd_key_id': bfd_key_id,
1335 'conf_key_id': conf_key_id,
1338 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1339 detect_mult, local_addr, peer_addr, is_ipv6=0):
1340 return self.api(self.papi.bfd_udp_mod,
1342 'sw_if_index': sw_if_index,
1343 'desired_min_tx': desired_min_tx,
1344 'required_min_rx': required_min_rx,
1345 'local_addr': local_addr,
1346 'peer_addr': peer_addr,
1348 'detect_mult': detect_mult,
1351 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1352 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1354 return self.api(self.papi.bfd_udp_auth_activate,
1356 'sw_if_index': sw_if_index,
1357 'local_addr': local_addr,
1358 'peer_addr': peer_addr,
1360 'is_delayed': 1 if is_delayed else 0,
1361 'bfd_key_id': bfd_key_id,
1362 'conf_key_id': conf_key_id,
1365 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1366 peer_addr, is_ipv6=0):
1367 return self.api(self.papi.bfd_udp_session_set_flags, {
1368 'admin_up_down': admin_up_down,
1369 'sw_if_index': sw_if_index,
1370 'local_addr': local_addr,
1371 'peer_addr': peer_addr,
1375 def want_bfd_events(self, enable_disable=1):
1376 return self.api(self.papi.want_bfd_events, {
1377 'enable_disable': enable_disable,
1381 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1382 return self.api(self.papi.bfd_auth_set_key, {
1383 'conf_key_id': conf_key_id,
1384 'auth_type': auth_type,
1386 'key_len': len(key),
1389 def classify_add_del_table(
1394 table_index=0xFFFFFFFF,
1396 memory_size=2097152,
1398 next_table_index=0xFFFFFFFF,
1399 miss_next_index=0xFFFFFFFF,
1400 current_data_flag=0,
1401 current_data_offset=0):
1405 :param match_n_vectors: (Default value = 1)
1406 :param table_index: (Default value = 0xFFFFFFFF)
1407 :param nbuckets: (Default value = 2)
1408 :param memory_size: (Default value = 2097152)
1409 :param skip_n_vectors: (Default value = 0)
1410 :param next_table_index: (Default value = 0xFFFFFFFF)
1411 :param miss_next_index: (Default value = 0xFFFFFFFF)
1412 :param current_data_flag: (Default value = 0)
1413 :param current_data_offset: (Default value = 0)
1416 mask_len = ((len(mask) - 1) / 16 + 1) * 16
1417 mask = mask + '\0' * (mask_len - len(mask))
1419 self.papi.classify_add_del_table,
1421 'table_index': table_index,
1422 'nbuckets': nbuckets,
1423 'memory_size': memory_size,
1424 'skip_n_vectors': skip_n_vectors,
1425 'match_n_vectors': match_n_vectors,
1426 'next_table_index': next_table_index,
1427 'miss_next_index': miss_next_index,
1428 'current_data_flag': current_data_flag,
1429 'current_data_offset': current_data_offset,
1430 'mask_len': mask_len,
1433 def classify_add_del_session(
1438 opaque_index=0xFFFFFFFF,
1439 hit_next_index=0xFFFFFFFF,
1447 :param opaque_index: (Default value = 0xFFFFFFFF)
1448 :param hit_next_index: (Default value = 0xFFFFFFFF)
1449 :param advance: (Default value = 0)
1450 :param action: (Default value = 0)
1451 :param metadata: (Default value = 0)
1454 match_len = ((len(match) - 1) / 16 + 1) * 16
1455 match = match + '\0' * (match_len - len(match))
1457 self.papi.classify_add_del_session,
1459 'table_index': table_index,
1460 'hit_next_index': hit_next_index,
1461 'opaque_index': opaque_index,
1464 'metadata': metadata,
1465 'match_len': match_len,
1468 def input_acl_set_interface(
1472 ip4_table_index=0xFFFFFFFF,
1473 ip6_table_index=0xFFFFFFFF,
1474 l2_table_index=0xFFFFFFFF):
1478 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1479 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1480 :param l2_table_index: (Default value = 0xFFFFFFFF)
1484 self.papi.input_acl_set_interface,
1485 {'sw_if_index': sw_if_index,
1486 'ip4_table_index': ip4_table_index,
1487 'ip6_table_index': ip6_table_index,
1488 'l2_table_index': l2_table_index,
1491 def output_acl_set_interface(
1495 ip4_table_index=0xFFFFFFFF,
1496 ip6_table_index=0xFFFFFFFF,
1497 l2_table_index=0xFFFFFFFF):
1501 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1502 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1503 :param l2_table_index: (Default value = 0xFFFFFFFF)
1507 self.papi.output_acl_set_interface,
1508 {'sw_if_index': sw_if_index,
1509 'ip4_table_index': ip4_table_index,
1510 'ip6_table_index': ip6_table_index,
1511 'l2_table_index': l2_table_index,
1514 def set_ipfix_exporter(
1521 collector_port=4739,
1524 self.papi.set_ipfix_exporter,
1526 'collector_address': collector_address,
1527 'collector_port': collector_port,
1528 'src_address': src_address,
1530 'path_mtu': path_mtu,
1531 'template_interval': template_interval,
1532 'udp_checksum': udp_checksum,
1535 def dhcp_proxy_config(self,
1543 self.papi.dhcp_proxy_config,
1545 'rx_vrf_id': rx_table_id,
1546 'server_vrf_id': server_table_id,
1549 'dhcp_server': dhcp_server,
1550 'dhcp_src_address': dhcp_src_address,
1553 def dhcp_proxy_set_vss(self,
1562 self.papi.dhcp_proxy_set_vss,
1565 'vss_type': vss_type,
1566 'vpn_ascii_id': vpn_ascii_id,
1568 'vpn_index': vpn_index,
1573 def dhcp_client_config(self,
1578 set_broadcast_flag=1,
1579 want_dhcp_events=0):
1581 self.papi.dhcp_client_config,
1585 'sw_if_index': sw_if_index,
1586 'hostname': hostname,
1588 'want_dhcp_event': want_dhcp_events,
1589 'set_broadcast_flag': set_broadcast_flag,
1593 def ip_mroute_add_del(self,
1599 next_hop_sw_if_index,
1609 IP Multicast Route add/del
1612 self.papi.ip_mroute_add_del,
1613 {'next_hop_sw_if_index': next_hop_sw_if_index,
1614 'entry_flags': e_flags,
1615 'itf_flags': i_flags,
1616 'table_id': table_id,
1620 'is_local': is_local,
1621 'bier_imp': bier_imp,
1622 'next_hop_afi': next_hop_afi,
1623 'grp_address_length': grp_address_length,
1624 'grp_address': grp_address,
1625 'src_address': src_address,
1626 'nh_address': next_hop_address})
1628 def lisp_enable_disable(self, is_enabled):
1630 self.papi.lisp_enable_disable,
1632 'is_en': is_enabled,
1635 def lisp_add_del_locator_set(self,
1639 self.papi.lisp_add_del_locator_set,
1642 'locator_set_name': ls_name
1645 def lisp_add_del_locator(self,
1652 self.papi.lisp_add_del_locator,
1655 'locator_set_name': ls_name,
1656 'sw_if_index': sw_if_index,
1657 'priority': priority,
1661 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1663 self.papi.lisp_locator_dump,
1665 'is_index_set': is_index_set,
1667 'ls_index': ls_index,
1670 def lisp_add_del_local_eid(self,
1680 self.papi.lisp_add_del_local_eid,
1682 'locator_set_name': ls_name,
1684 'eid_type': eid_type,
1686 'prefix_len': prefix_len,
1692 def lisp_eid_table_dump(self,
1700 self.papi.lisp_eid_table_dump,
1703 'prefix_length': prefix_length,
1705 'eid_type': eid_type,
1707 'filter': filter_opt,
1710 def lisp_add_del_remote_mapping(self,
1720 self.papi.lisp_add_del_remote_mapping,
1723 'eid_type': eid_type,
1725 'eid_len': eid_prefix_len,
1726 'rloc_num': rlocs_num,
1729 'is_src_dst': is_src_dst,
1732 def lisp_add_del_adjacency(self,
1741 self.papi.lisp_add_del_adjacency,
1745 'eid_type': eid_type,
1748 'leid_len': leid_len,
1749 'reid_len': reid_len,
1752 def gtpu_add_del_tunnel(
1758 mcast_sw_if_index=0xFFFFFFFF,
1760 decap_next_index=0xFFFFFFFF,
1764 :param is_add: (Default value = 1)
1765 :param is_ipv6: (Default value = 0)
1768 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1769 :param encap_vrf_id: (Default value = 0)
1770 :param decap_next_index: (Default value = 0xFFFFFFFF)
1771 :param teid: (Default value = 0)
1774 return self.api(self.papi.gtpu_add_del_tunnel,
1777 'src_address': src_addr,
1778 'dst_address': dst_addr,
1779 'mcast_sw_if_index': mcast_sw_if_index,
1780 'encap_vrf_id': encap_vrf_id,
1781 'decap_next_index': decap_next_index,
1784 def vxlan_gpe_add_del_tunnel(
1788 mcast_sw_if_index=0xFFFFFFFF,
1799 :param is_add: (Default value = 1)
1800 :param is_ipv6: (Default value = 0)
1801 :param encap_vrf_id: (Default value = 0)
1802 :param decap_vrf_id: (Default value = 0)
1803 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1804 :param protocol: (Default value = 3)
1805 :param vni: (Default value = 0)
1808 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1813 'mcast_sw_if_index': mcast_sw_if_index,
1814 'encap_vrf_id': encap_vrf_id,
1815 'decap_vrf_id': decap_vrf_id,
1816 'protocol': protocol,
1819 def vxlan_gbp_tunnel_add_del(
1823 mcast_sw_if_index=0xFFFFFFFF,
1829 instance=0xFFFFFFFF):
1834 :param is_add: (Default value = 1)
1835 :param is_ipv6: (Default value = 0)
1836 :param encap_table_id: (Default value = 0)
1837 :param decap_next_index: (Default value = 0xFFFFFFFF)
1838 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1839 :param vni: (Default value = 0)
1840 :param instance: (Default value = 0xFFFFFFFF)
1843 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
1848 'mcast_sw_if_index': mcast_sw_if_index,
1849 'encap_table_id': encap_table_id,
1851 'instance': instance,
1854 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1855 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1856 {'sw_if_index': sw_if_index,
1857 '_no_type_conversion': True})
1859 def pppoe_add_del_session(
1869 :param is_add: (Default value = 1)
1870 :param is_ipv6: (Default value = 0)
1872 :param session_id: (Default value = 0)
1874 :param decap_vrf_id: (Default value = 0)
1877 return self.api(self.papi.pppoe_add_del_session,
1880 'session_id': session_id,
1881 'client_ip': client_ip,
1882 'decap_vrf_id': decap_vrf_id,
1883 'client_mac': client_mac})
1885 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1886 return self.api(self.papi.sr_mpls_policy_add,
1890 'n_segments': len(segments),
1891 'segments': segments})
1893 def sr_mpls_policy_del(self, bsid):
1894 return self.api(self.papi.sr_mpls_policy_del,
1897 def sr_localsid_add_del(self,
1904 sw_if_index=0xFFFFFFFF,
1908 """ Add/del IPv6 SR local-SID.
1911 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1912 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1915 :param is_del: (Default value = 0)
1916 :param end_psp: (Default value = 0)
1917 :param sw_if_index: (Default value = 0xFFFFFFFF)
1918 :param vlan_index: (Default value = 0)
1919 :param fib_table: (Default value = 0)
1922 self.papi.sr_localsid_add_del,
1924 'localsid': localsid,
1926 'behavior': behavior,
1927 'sw_if_index': sw_if_index,
1928 'vlan_index': vlan_index,
1929 'fib_table': fib_table,
1930 'nh_addr4': nh_addr4,
1931 'nh_addr6': nh_addr6
1945 :param bsid_addr: bindingSID of the SR Policy
1946 :param weight: weight of the sid list. optional. (default: 1)
1947 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1949 :param type: type/behavior of the SR policy. (default or spray) \
1951 :param fib_table: VRF where to install the FIB entry for the BSID \
1953 :param n_segments: number of segments \
1955 :param segments: a vector of IPv6 address composing the segment list \
1959 self.papi.sr_policy_add,
1960 {'bsid_addr': bsid_addr,
1962 'is_encap': is_encap,
1964 'fib_table': fib_table,
1965 'n_segments': n_segments,
1966 'segments': segments
1975 :param bsid: bindingSID of the SR Policy
1976 :param sr_policy_index: index of the sr policy (default: 0)
1979 self.papi.sr_policy_del,
1980 {'bsid_addr': bsid_addr,
1981 'sr_policy_index': sr_policy_index
1984 def sr_steering_add_del(
1995 Steer traffic L2 and L3 traffic through a given SR policy
1997 :param is_del: delete or add
1998 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1999 :param sr_policy: is the index of the SR Policy (alt to bsid)
2000 :param table_id: is the VRF where to install the FIB entry for the BSID
2001 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2002 :param mask_width: is the mask for L3 traffic type
2003 :param sw_if_index: is the incoming interface for L2 traffic
2004 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2007 self.papi.sr_steering_add_del,
2009 'bsid_addr': bsid_addr,
2010 'sr_policy_index': sr_policy_index,
2011 'table_id': table_id,
2012 'prefix_addr': prefix_addr,
2013 'mask_width': mask_width,
2014 'sw_if_index': sw_if_index,
2015 'traffic_type': traffic_type
2018 def acl_add_replace(self, acl_index, r, tag='',
2020 """Add/replace an ACL
2021 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2022 :param acl_rule r: ACL rules array.
2023 :param str tag: symbolic tag (description) for this ACL.
2024 :param int count: number of rules.
2026 return self.api(self.papi.acl_add_replace,
2027 {'acl_index': acl_index,
2031 expected_retval=expected_retval)
2033 def acl_del(self, acl_index, expected_retval=0):
2039 return self.api(self.papi.acl_del,
2040 {'acl_index': acl_index},
2041 expected_retval=expected_retval)
2043 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2045 return self.api(self.papi.acl_interface_set_acl_list,
2046 {'sw_if_index': sw_if_index,
2050 expected_retval=expected_retval)
2052 def acl_interface_set_etype_whitelist(self, sw_if_index,
2055 return self.api(self.papi.acl_interface_set_etype_whitelist,
2056 {'sw_if_index': sw_if_index,
2057 'count': len(whitelist),
2059 'whitelist': whitelist},
2060 expected_retval=expected_retval)
2062 def acl_interface_add_del(self,
2066 """ Add/Delete ACL to/from interface
2070 :param is_add: (Default value = 1)
2073 return self.api(self.papi.acl_interface_add_del,
2076 'sw_if_index': sw_if_index,
2077 'acl_index': acl_index})
2079 def acl_dump(self, acl_index, expected_retval=0):
2080 return self.api(self.papi.acl_dump,
2081 {'acl_index': acl_index},
2082 expected_retval=expected_retval)
2084 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2086 return self.api(self.papi.acl_interface_list_dump,
2087 {'sw_if_index': sw_if_index},
2088 expected_retval=expected_retval)
2090 def macip_acl_add(self, rules, tag=""):
2093 :param rules: list of rules for given acl
2097 return self.api(self.papi.macip_acl_add,
2099 'count': len(rules),
2102 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2105 :param rules: list of rules for given acl
2109 return self.api(self.papi.macip_acl_add_replace,
2110 {'acl_index': acl_index,
2112 'count': len(rules),
2115 def macip_acl_interface_add_del(self,
2119 """ Add MACIP acl to interface
2123 :param is_add: (Default value = 1)
2126 return self.api(self.papi.macip_acl_interface_add_del,
2128 'sw_if_index': sw_if_index,
2129 'acl_index': acl_index})
2131 def macip_acl_dump(self, acl_index=4294967295):
2132 """ Return MACIP acl dump
2136 self.papi.macip_acl_dump, {'acl_index': acl_index})
2138 def policer_add_del(self,
2149 conform_action_type=1,
2151 exceed_action_type=0,
2153 violate_action_type=0,
2155 return self.api(self.papi.policer_add_del,
2162 'rate_type': rate_type,
2163 'round_type': round_type,
2165 'color_aware': color_aware,
2166 'conform_action_type': conform_action_type,
2167 'conform_dscp': conform_dscp,
2168 'exceed_action_type': exceed_action_type,
2169 'exceed_dscp': exceed_dscp,
2170 'violate_action_type': violate_action_type,
2171 'violate_dscp': violate_dscp})
2173 def ip_punt_police(self,
2177 return self.api(self.papi.ip_punt_police,
2178 {'policer_index': policer_index,
2182 def ip_punt_redirect(self,
2187 return self.api(self.papi.ip_punt_redirect,
2188 {'punt': {'rx_sw_if_index': rx_sw_if_index,
2189 'tx_sw_if_index': tx_sw_if_index,
2193 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
2194 return self.api(self.papi.ip_punt_redirect_dump,
2195 {'sw_if_index': sw_if_index,
2196 'is_ipv6': is_ipv6})
2198 def bier_table_add_del(self,
2202 """ BIER Table add/del """
2204 self.papi.bier_table_add_del,
2205 {'bt_tbl_id': {"bt_set": bti.set_id,
2206 "bt_sub_domain": bti.sub_domain_id,
2207 "bt_hdr_len_id": bti.hdr_len_id},
2208 'bt_label': mpls_label,
2209 'bt_is_add': is_add})
2211 def bier_table_dump(self):
2212 return self.api(self.papi.bier_table_dump, {})
2214 def bier_route_add_del(self,
2220 """ BIER Route add/del """
2222 self.papi.bier_route_add_del,
2223 {'br_tbl_id': {"bt_set": bti.set_id,
2224 "bt_sub_domain": bti.sub_domain_id,
2225 "bt_hdr_len_id": bti.hdr_len_id},
2227 'br_n_paths': len(paths),
2229 'br_is_add': is_add,
2230 'br_is_replace': is_replace})
2232 def bier_route_dump(self, bti):
2234 self.papi.bier_route_dump,
2235 {'br_tbl_id': {"bt_set": bti.set_id,
2236 "bt_sub_domain": bti.sub_domain_id,
2237 "bt_hdr_len_id": bti.hdr_len_id}})
2239 def bier_imp_add(self,
2244 """ BIER Imposition Add """
2246 self.papi.bier_imp_add,
2247 {'bi_tbl_id': {"bt_set": bti.set_id,
2248 "bt_sub_domain": bti.sub_domain_id,
2249 "bt_hdr_len_id": bti.hdr_len_id},
2251 'bi_n_bytes': len(ibytes),
2252 'bi_bytes': ibytes})
2254 def bier_imp_del(self, bi_index):
2255 """ BIER Imposition del """
2257 self.papi.bier_imp_del,
2258 {'bi_index': bi_index})
2260 def bier_imp_dump(self):
2261 return self.api(self.papi.bier_imp_dump, {})
2263 def bier_disp_table_add_del(self,
2266 """ BIER Disposition Table add/del """
2268 self.papi.bier_disp_table_add_del,
2269 {'bdt_tbl_id': bdti,
2270 'bdt_is_add': is_add})
2272 def bier_disp_table_dump(self):
2273 return self.api(self.papi.bier_disp_table_dump, {})
2275 def bier_disp_entry_add_del(self,
2285 """ BIER Route add/del """
2287 while (len(lstack) < 16):
2290 self.papi.bier_disp_entry_add_del,
2291 {'bde_tbl_id': bdti,
2293 'bde_payload_proto': payload_proto,
2295 'bde_paths': [{'next_hop': next_hop,
2296 'table_id': next_hop_tbl_id,
2297 'afi': next_hop_afi,
2298 'rpf_id': next_hop_rpf_id,
2300 'label_stack': lstack}],
2301 'bde_is_add': is_add})
2303 def bier_disp_entry_dump(self, bdti):
2305 self.papi.bier_disp_entry_dump,
2306 {'bde_tbl_id': bdti})
2308 def session_enable_disable(self, is_enabled):
2310 self.papi.session_enable_disable,
2311 {'is_enable': is_enabled})
2313 def ipsec_spd_add_del(self, spd_id, is_add=1):
2314 """ SPD add/del - Wrapper to add or del ipsec SPD
2315 Sample CLI : 'ipsec spd add 1'
2317 :param spd_id - SPD ID to be created in the vpp . mandatory
2318 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2320 :returns: reply from the API
2323 self.papi.ipsec_spd_add_del, {
2324 'spd_id': spd_id, 'is_add': is_add})
2326 def ipsec_spds_dump(self):
2327 return self.api(self.papi.ipsec_spds_dump, {})
2329 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2330 """ IPSEC interface SPD add/del - \
2331 Wrapper to associate/disassociate SPD to interface in VPP
2332 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2334 :param spd_id - SPD ID to associate with the interface . mandatory
2335 :param sw_if_index - Interface Index which needs to ipsec \
2336 association mandatory
2337 :param is_add - add(1) or del(0) association with interface \
2338 (Default 1 - add) . optional
2339 :returns: reply from the API
2342 self.papi.ipsec_interface_add_del_spd,
2343 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
2345 def ipsec_spd_interface_dump(self, spd_index=None):
2346 return self.api(self.papi.ipsec_spd_interface_dump,
2347 {'spd_index': spd_index if spd_index else 0,
2348 'spd_index_valid': 1 if spd_index else 0})
2350 def ipsec_sad_entry_add_del(self,
2353 integrity_algorithm,
2358 tunnel_src_address='',
2359 tunnel_dst_address='',
2363 """ IPSEC SA add/del
2364 :param sad_id: security association ID
2365 :param spi: security param index of the SA in decimal
2366 :param integrity_algorithm:
2367 :param integrity_key:
2368 :param crypto_algorithm:
2370 :param protocol: AH(0) or ESP(1) protocol
2371 :param tunnel_src_address: tunnel mode outer src address
2372 :param tunnel_dst_address: tunnel mode outer dst address
2375 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
2376 crypto and ipsec algorithms
2379 self.papi.ipsec_sad_entry_add_del,
2386 'tunnel_src': tunnel_src_address,
2387 'tunnel_dst': tunnel_dst_address,
2388 'protocol': protocol,
2389 'integrity_algorithm': integrity_algorithm,
2391 'length': len(integrity_key),
2392 'data': integrity_key,
2394 'crypto_algorithm': crypto_algorithm,
2396 'length': len(crypto_key),
2404 def ipsec_sa_dump(self, sa_id=None):
2405 return self.api(self.papi.ipsec_sa_dump,
2406 {'sa_id': sa_id if sa_id else 0xffffffff})
2408 def ipsec_spd_entry_add_del(self,
2411 local_address_start,
2413 remote_address_start,
2414 remote_address_stop,
2416 local_port_stop=65535,
2417 remote_port_start=0,
2418 remote_port_stop=65535,
2426 """ IPSEC policy SPD add/del -
2427 Wrapper to configure ipsec SPD policy entries in VPP
2428 :param spd_id: SPD ID for the policy
2429 :param local_address_start: local-ip-range start address
2430 :param local_address_stop : local-ip-range stop address
2431 :param remote_address_start: remote-ip-range start address
2432 :param remote_address_stop : remote-ip-range stop address
2433 :param local_port_start: (Default value = 0)
2434 :param local_port_stop: (Default value = 65535)
2435 :param remote_port_start: (Default value = 0)
2436 :param remote_port_stop: (Default value = 65535)
2437 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
2438 :param sa_id: Security Association ID for mapping it to SPD
2439 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
2441 :param priority: value for the spd action (Default value = 100)
2442 :param is_outbound: flag for inbound(0) or outbound(1)
2444 :param is_add: (Default value = 1)
2447 self.papi.ipsec_spd_entry_add_del,
2454 'local_address_start': local_address_start,
2455 'local_address_stop': local_address_stop,
2456 'remote_address_start': remote_address_start,
2457 'remote_address_stop': remote_address_stop,
2458 'local_port_start': local_port_start,
2459 'local_port_stop': local_port_stop,
2460 'remote_port_start': remote_port_start,
2461 'remote_port_stop': remote_port_stop,
2462 'protocol': protocol,
2464 'priority': priority,
2465 'is_outbound': is_outbound,
2466 'is_ip_any': is_ip_any
2470 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
2471 return self.api(self.papi.ipsec_spd_dump,
2475 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
2476 remote_spi, crypto_alg, local_crypto_key,
2477 remote_crypto_key, integ_alg, local_integ_key,
2478 remote_integ_key, is_add=1, esn=0, salt=0,
2479 anti_replay=1, renumber=0, show_instance=0):
2481 self.papi.ipsec_tunnel_if_add_del,
2483 'local_ip': local_ip,
2484 'remote_ip': remote_ip,
2485 'local_spi': local_spi,
2486 'remote_spi': remote_spi,
2487 'crypto_alg': crypto_alg,
2488 'local_crypto_key_len': len(local_crypto_key),
2489 'local_crypto_key': local_crypto_key,
2490 'remote_crypto_key_len': len(remote_crypto_key),
2491 'remote_crypto_key': remote_crypto_key,
2492 'integ_alg': integ_alg,
2493 'local_integ_key_len': len(local_integ_key),
2494 'local_integ_key': local_integ_key,
2495 'remote_integ_key_len': len(remote_integ_key),
2496 'remote_integ_key': remote_integ_key,
2499 'anti_replay': anti_replay,
2500 'renumber': renumber,
2501 'show_instance': show_instance,
2505 def ipsec_gre_tunnel_add_del(self, local_ip, remote_ip,
2506 sa_out, sa_in, is_add=1):
2507 return self.api(self.papi.ipsec_gre_tunnel_add_del,
2513 'local_sa_id': sa_out,
2514 'remote_sa_id': sa_in
2518 def ipsec_select_backend(self, protocol, index):
2519 return self.api(self.papi.ipsec_select_backend,
2520 {'protocol': protocol, 'index': index})
2522 def ipsec_backend_dump(self):
2523 return self.api(self.papi.ipsec_backend_dump, {})
2525 def app_namespace_add_del(self,
2529 sw_if_index=0xFFFFFFFF,
2532 self.papi.app_namespace_add_del,
2534 'sw_if_index': sw_if_index,
2535 'ip4_fib_id': ip4_fib_id,
2536 'ip6_fib_id': ip6_fib_id,
2537 'namespace_id': namespace_id,
2538 'namespace_id_len': len(namespace_id)})
2540 def punt_socket_register(self, port, pathname, protocol=0x11,
2541 header_version=1, is_ip4=1):
2542 """ Register punt socket """
2543 return self.api(self.papi.punt_socket_register,
2544 {'header_version': header_version,
2545 'punt': {'ipv': is_ip4,
2546 'l4_protocol': protocol,
2548 'pathname': pathname})
2550 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
2551 """ Unregister punt socket """
2552 return self.api(self.papi.punt_socket_deregister,
2553 {'punt': {'ipv': is_ip4,
2554 'l4_protocol': protocol,
2557 def punt_socket_dump(self, is_ip6=1):
2558 """ Dump punt socket"""
2559 return self.api(self.papi.punt_socket_dump,
2560 {'is_ipv6': is_ip6})
2562 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
2564 """ GBP endpoint Add """
2565 return self.api(self.papi.gbp_endpoint_add,
2567 'sw_if_index': sw_if_index,
2578 def gbp_endpoint_del(self, handle):
2579 """ GBP endpoint Del """
2580 return self.api(self.papi.gbp_endpoint_del,
2583 def gbp_endpoint_dump(self):
2584 """ GBP endpoint Dump """
2585 return self.api(self.papi.gbp_endpoint_dump,
2586 {'_no_type_conversion': True})
2588 def gbp_endpoint_group_add(self, vnid, sclass, bd,
2589 rd, uplink_sw_if_index,
2591 """ GBP endpoint group Add """
2592 return self.api(self.papi.gbp_endpoint_group_add,
2595 'uplink_sw_if_index': uplink_sw_if_index,
2600 'retention': retention
2603 def gbp_endpoint_group_del(self, sclass):
2604 """ GBP endpoint group Del """
2605 return self.api(self.papi.gbp_endpoint_group_del,
2608 def gbp_bridge_domain_add(self, bd_id, flags,
2611 bm_flood_sw_if_index):
2612 """ GBP bridge-domain Add """
2613 return self.api(self.papi.gbp_bridge_domain_add,
2617 'bvi_sw_if_index': bvi_sw_if_index,
2618 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2619 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2623 def gbp_bridge_domain_del(self, bd_id):
2624 """ GBP bridge-domain Del """
2625 return self.api(self.papi.gbp_bridge_domain_del,
2628 def gbp_route_domain_add(self, rd_id,
2632 ip6_uu_sw_if_index):
2633 """ GBP route-domain Add """
2634 return self.api(self.papi.gbp_route_domain_add,
2637 'ip4_table_id': ip4_table_id,
2638 'ip6_table_id': ip6_table_id,
2639 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2640 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2644 def gbp_route_domain_del(self, rd_id):
2645 """ GBP route-domain Del """
2646 return self.api(self.papi.gbp_route_domain_del,
2649 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2650 """ GBP recirc Add/Del """
2651 return self.api(self.papi.gbp_recirc_add_del,
2655 'sw_if_index': sw_if_index,
2658 def gbp_recirc_dump(self):
2659 """ GBP recirc Dump """
2660 return self.api(self.papi.gbp_recirc_dump, {})
2662 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2663 """ GBP recirc Add/Del """
2664 return self.api(self.papi.gbp_ext_itf_add_del,
2667 'sw_if_index': sw_if_index,
2671 def gbp_ext_itf_dump(self):
2672 """ GBP recirc Dump """
2673 return self.api(self.papi.gbp_ext_itf_dump, {})
2675 def gbp_subnet_add_del(self, is_add, rd_id,
2677 sw_if_index=0xffffffff,
2679 """ GBP Subnet Add/Del """
2680 return self.api(self.papi.gbp_subnet_add_del,
2684 'sw_if_index': sw_if_index,
2689 def gbp_subnet_dump(self):
2690 """ GBP Subnet Dump """
2691 return self.api(self.papi.gbp_subnet_dump,
2692 {'_no_type_conversion': True})
2694 def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2695 rules, allowed_ethertypes):
2696 """ GBP contract Add/Del """
2697 return self.api(self.papi.gbp_contract_add_del,
2700 'acl_index': acl_index,
2703 'n_rules': len(rules),
2705 'n_ether_types': len(allowed_ethertypes),
2706 'allowed_ethertypes': allowed_ethertypes}})
2708 def gbp_contract_dump(self):
2709 """ GBP contract Dump """
2710 return self.api(self.papi.gbp_contract_dump, {})
2712 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2713 """ GBP VXLAN tunnel add """
2714 return self.api(self.papi.gbp_vxlan_tunnel_add,
2719 'bd_rd_id': bd_rd_id,
2724 def gbp_vxlan_tunnel_del(self, vni):
2725 """ GBP VXLAN tunnel del """
2726 return self.api(self.papi.gbp_vxlan_tunnel_del,
2731 def gbp_vxlan_tunnel_dump(self):
2732 """ GBP VXLAN tunnel add/del """
2733 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2735 def qos_egress_map_update(self, id, outputs):
2736 """ QOS egress map update """
2737 return self.api(self.papi.qos_egress_map_update,
2741 def qos_egress_map_delete(self, id):
2742 """ QOS egress map delete """
2743 return self.api(self.papi.qos_egress_map_delete,
2746 def qos_mark_enable_disable(self, sw_if_index,
2750 """ QOS Mark Enable/Disable """
2751 return self.api(self.papi.qos_mark_enable_disable,
2753 'sw_if_index': sw_if_index,
2754 'output_source': output_source,
2757 def igmp_enable_disable(self, sw_if_index, enable, host):
2758 """ Enable/disable IGMP on a given interface """
2759 return self.api(self.papi.igmp_enable_disable,
2762 'sw_if_index': sw_if_index})
2764 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2765 """ Add/del IGMP proxy device """
2766 return self.api(self.papi.igmp_proxy_device_add_del,
2767 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2770 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2771 """ Add/del interface to/from IGMP proxy device """
2772 return self.api(self.papi.igmp_proxy_device_add_del_interface,
2773 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2776 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2777 """ Listen for new (S,G) on specified interface
2779 :param enable: add/del
2780 :param sw_if_index: interface sw index
2781 :param saddr: source ip4 addr
2782 :param gaddr: group ip4 addr
2784 return self.api(self.papi.igmp_listen,
2789 'sw_if_index': sw_if_index,
2790 'n_srcs': len(saddrs),
2796 def igmp_clear_interface(self, sw_if_index):
2797 """ Remove all (S,G)s from specified interface
2798 doesn't send IGMP report!
2801 self.papi.igmp_clear_interface, {
2802 'sw_if_index': sw_if_index})
2804 def want_igmp_events(self, enable=1):
2805 return self.api(self.papi.want_igmp_events, {'enable': enable,
2806 'pid': os.getpid()})
2814 interface_id=0xFFFFFFFF):
2817 :param lb: load balance
2818 :param use_custom_mac: use custom mac
2819 :param mac_address: mac address
2820 :param interface_id: custom interface ID
2823 self.papi.bond_create,
2826 'use_custom_mac': use_custom_mac,
2827 'mac_address': mac_address,
2831 def pipe_delete(self, parent_sw_if_index):
2832 return self.api(self.papi.pipe_delete,
2833 {'parent_sw_if_index': parent_sw_if_index})
2847 return self.api(self.papi.memif_create,
2850 'rx_queues': rx_queues,
2851 'tx_queues': tx_queues,
2853 'socket_id': socket_id,
2855 'ring_size': ring_size,
2856 'buffer_size': buffer_size,
2857 'hw_addr': hw_addr})
2859 def svs_table_add_del(self, af, table_id, is_add=1):
2860 return self.api(self.papi.svs_table_add_del,
2862 'table_id': table_id,
2867 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2868 return self.api(self.papi.svs_route_add_del,
2870 'table_id': table_id,
2871 'source_table_id': src_table_id,
2876 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2877 return self.api(self.papi.svs_enable_disable,
2880 'table_id': table_id,
2881 'sw_if_index': sw_if_index,
2882 'is_enable': is_enable,