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,
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,
130 'nat44_interface_add_del_feature': {'is_add': 1, },
131 'nat44_interface_add_del_output_feature': {'is_add': 1, },
132 'nat44_lb_static_mapping_add_del_local': {'is_add': 1, },
133 'nat64_add_del_interface': {'is_add': 1, },
134 'nat64_add_del_interface_addr': {'is_add': 1, },
135 'nat64_add_del_pool_addr_range': {'vrf_id': 4294967295, 'is_add': 1, },
136 'nat64_add_del_prefix': {'is_add': 1, },
137 'nat64_add_del_static_bib': {'is_add': 1, },
138 'nat64_bib_dump': {'protocol': 255, },
139 'nat64_st_dump': {'protocol': 255, },
140 'nat66_add_del_interface': {'is_add': 1, },
141 'nat66_add_del_static_mapping': {'is_add': 1, },
142 'nat_det_add_del_map': {'is_add': 1, },
143 'nat_ha_resync': {'want_resync_event': 1, },
144 'nat_ha_set_failover': {'refresh': 10, },
145 'nat_ha_set_listener': {'path_mtu': 512, },
146 'nat_ipfix_enable_disable': {'domain_id': 1, 'src_port': 4739,
148 'nat_set_mss_clamping': {'mss_value': 1500, },
149 'nat_set_reass': {'timeout': 2, 'max_reass': 1024, 'max_frag': 5, },
150 'nat_set_timeouts': {'udp': 300, 'tcp_established': 7440,
151 'tcp_transitory': 240, 'icmp': 60, },
152 'output_acl_set_interface': {'ip4_table_index': 4294967295,
153 'ip6_table_index': 4294967295,
154 'l2_table_index': 4294967295, },
155 'pppoe_add_del_session': {'is_add': 1, },
156 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
157 'proxy_arp_add_del': {'is_add': 1, },
158 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
159 'punt_socket_register': {'protocol': 17, 'header_version': 1,
161 'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, },
162 'punt_socket_dump': {'is_ip6': 1, },
163 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
165 'set_ipfix_exporter': {'collector_port': 4739, },
166 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
167 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
168 'svs_enable_disable': {'is_enable': 1, },
169 'svs_route_add_del': {'is_add': 1, },
170 'svs_table_add_del': {'is_add': 1, },
171 'sw_interface_add_del_address': {'is_add': 1, },
172 'sw_interface_dump': {'sw_if_index': 4294967295, },
173 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
174 'pref_lifetime': 4294967295, },
175 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
176 'sw_interface_set_l2_bridge': {'enable': 1, },
177 'sw_interface_set_mpls_enable': {'enable': 1, },
178 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
179 'sw_interface_set_unnumbered': {'is_add': 1, },
180 'sw_interface_span_enable_disable': {'state': 1, },
181 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
182 'decap_next_index': 4294967295,
183 'instance': 4294967295, },
184 'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
185 'instance': 4294967295, },
186 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
187 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
189 'want_bfd_events': {'enable_disable': 1, },
190 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
191 'want_dhcp6_reply_events': {'enable_disable': 1, },
192 'want_igmp_events': {'enable': 1, },
193 'want_interface_events': {'enable_disable': 1, },
194 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
195 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
196 'want_ip6_ra_events': {'enable_disable': 1, },
197 'want_l2_macs_events': {'enable_disable': 1, },
201 class UnexpectedApiReturnValueError(Exception):
202 """ exception raised when the API return value is unexpected """
206 class VppPapiProvider(object):
207 """VPP-api provider using vpp-papi
209 @property hook: hook object providing before and after api/cli hooks
212 _zero, _negative = range(2)
214 def __init__(self, name, shm_prefix, test_class, read_timeout):
215 self.hook = Hook(test_class)
217 self.shm_prefix = shm_prefix
218 self.test_class = test_class
219 self._expect_api_retval = self._zero
220 self._expect_stack = []
222 install_dir = os.getenv('VPP_INSTALL_PATH')
224 # Vapi requires 'VPP_API_DIR', not set when run from Makefile.
225 if 'VPP_API_DIR' not in os.environ:
226 os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH')
230 if os.environ['SOCKET'] == '1':
234 self.vpp = VPP(logger=test_class.logger,
235 read_timeout=read_timeout,
236 use_socket=use_socket,
237 server_address=test_class.api_sock)
238 self._events = deque()
243 def assert_negative_api_retval(self):
244 """ Expect API failure - used with with, e.g.:
245 with self.vapi.assert_negative_api_retval():
246 self.vapi.<api call expected to fail>
248 self._expect_stack.append(self._expect_api_retval)
249 self._expect_api_retval = self._negative
252 def assert_zero_api_retval(self):
253 """ Expect API success - used with with, e.g.:
254 with self.vapi.assert_negative_api_retval():
255 self.vapi.<api call expected to succeed>
257 note: this is useful only inside another with block
258 as success is the default expected value
260 self._expect_stack.append(self._expect_api_retval)
261 self._expect_api_retval = self._zero
264 def __exit__(self, exc_type, exc_value, traceback):
265 self._expect_api_retval = self._expect_stack.pop()
267 def register_hook(self, hook):
268 """Replace hook registration with new hook
275 def collect_events(self):
276 """ Collect all events from the internal queue and clear the queue. """
278 self._events = deque()
281 def wait_for_event(self, timeout, name=None):
282 """ Wait for and return next event. """
284 self.test_class.logger.debug("Expecting event '%s' within %ss",
287 self.test_class.logger.debug("Expecting event within %ss",
290 self.test_class.logger.debug("Not waiting, event already queued")
291 limit = time.time() + timeout
292 while time.time() < limit:
294 e = self._events.popleft()
295 if name and type(e).__name__ != name:
297 "Unexpected event received: %s, expected: %s" %
298 (type(e).__name__, name))
299 self.test_class.logger.debug("Returning event %s:%s" %
302 self.test_class.sleep(0) # yield
303 raise Exception("Event did not occur within timeout")
305 def __call__(self, name, event):
306 """ Enqueue event in the internal event queue. """
307 # FIXME use the name instead of relying on type(e).__name__ ?
308 # FIXME #2 if this throws, it is eaten silently, Ole?
309 self.test_class.logger.debug("New event: %s: %s" % (name, event))
310 self._events.append(event)
312 def factory(self, name, apifn):
314 fields = apifn._func.msg.fields
316 # add positional and kw arguments
318 for i, o in enumerate(fields[3:]):
325 if name in defaultmapping:
326 for k, v in iteritems(defaultmapping[name]):
330 return self.api(apifn, d)
334 def __getattribute__(self, name):
336 method = super(VppPapiProvider, self).__getattribute__(name)
337 except AttributeError:
338 method = self.factory(name, getattr(self.papi, name))
339 # lazily load the method so we don't need to call factory
340 # again for this name.
341 setattr(self, name, method)
345 """Connect the API to VPP"""
346 self.vpp.connect(self.name, self.shm_prefix)
347 self.papi = self.vpp.api
348 self.vpp.register_event_callback(self)
350 def disconnect(self):
351 """Disconnect the API from VPP"""
352 self.vpp.disconnect()
354 def api(self, api_fn, api_args, expected_retval=0):
355 """ Call API function and check it's return value.
356 Call the appropriate hooks before and after the API call
358 :param api_fn: API function to call
359 :param api_args: tuple of API function arguments
360 :param expected_retval: Expected return value (Default value = 0)
361 :returns: reply from the API
364 self.hook.before_api(api_fn.__name__, api_args)
365 reply = api_fn(**api_args)
366 if self._expect_api_retval == self._negative:
367 if hasattr(reply, 'retval') and reply.retval >= 0:
368 msg = "API call passed unexpectedly: expected negative " \
369 "return value instead of %d in %s" % \
370 (reply.retval, moves.reprlib.repr(reply))
371 self.test_class.logger.info(msg)
372 raise UnexpectedApiReturnValueError(msg)
373 elif self._expect_api_retval == self._zero:
374 if hasattr(reply, 'retval') and reply.retval != expected_retval:
375 msg = "API call failed, expected %d return value instead " \
376 "of %d in %s" % (expected_retval, reply.retval,
377 moves.reprlib.repr(reply))
378 self.test_class.logger.info(msg)
379 raise UnexpectedApiReturnValueError(msg)
381 raise Exception("Internal error, unexpected value for "
382 "self._expect_api_retval %s" %
383 self._expect_api_retval)
384 self.hook.after_api(api_fn.__name__, api_args)
388 """ Execute a CLI, calling the before/after hooks appropriately.
390 :param cli: CLI to execute
394 self.hook.before_cli(cli)
396 r = self.papi.cli_inband(cmd=cli)
397 self.hook.after_cli(cli)
398 if hasattr(r, 'reply'):
401 def ppcli(self, cli):
402 """ Helper method to print CLI command in case of info logging level.
404 :param cli: CLI to execute
407 return cli + "\n" + str(self.cli(cli))
409 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
410 return self.api(self.papi.want_ip4_arp_events,
411 {'enable_disable': enable_disable,
413 'pid': os.getpid(), })
415 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
416 return self.api(self.papi.want_ip6_nd_events,
417 {'enable_disable': enable_disable,
419 'pid': os.getpid(), })
421 def want_ip6_ra_events(self, enable_disable=1):
422 return self.api(self.papi.want_ip6_ra_events,
423 {'enable_disable': enable_disable,
424 'pid': os.getpid(), })
426 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
428 return self.api(self.papi.ip6nd_send_router_solicitation,
433 'sw_if_index': sw_if_index})
435 def want_interface_events(self, enable_disable=1):
436 return self.api(self.papi.want_interface_events,
437 {'enable_disable': enable_disable,
438 'pid': os.getpid(), })
440 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
441 max_macs_in_event=0, learn_limit=0):
442 return self.api(self.papi.want_l2_macs_events,
443 {'enable_disable': enable_disable,
444 'scan_delay': scan_delay,
445 'max_macs_in_event': max_macs_in_event,
446 'learn_limit': learn_limit,
447 'pid': os.getpid(), })
449 def want_dhcp6_reply_events(self, enable_disable=1):
450 return self.api(self.papi.want_dhcp6_reply_events,
451 {'enable_disable': enable_disable,
454 def want_dhcp6_pd_reply_events(self, enable_disable=1):
455 return self.api(self.papi.want_dhcp6_pd_reply_events,
456 {'enable_disable': enable_disable,
459 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
460 prefixes, server_index=0xFFFFFFFF,
461 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
463 return self.api(self.papi.dhcp6_pd_send_client_message,
464 {'sw_if_index': sw_if_index,
465 'server_index': server_index,
471 'msg_type': msg_type,
474 'n_prefixes': len(prefixes),
475 'prefixes': prefixes})
477 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
479 return self.api(self.papi.dhcp6_client_enable_disable,
480 {'sw_if_index': sw_if_index,
483 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
485 return self.api(self.papi.dhcp6_pd_client_enable_disable,
486 {'sw_if_index': sw_if_index,
487 'prefix_group': prefix_group,
490 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
491 prefix_length, prefix_group,
493 return self.api(self.papi.ip6_add_del_address_using_prefix,
494 {'sw_if_index': sw_if_index,
495 'prefix_group': prefix_group,
497 'prefix_length': prefix_length,
500 def sw_interface_set_mac_address(self, sw_if_index, mac):
501 return self.api(self.papi.sw_interface_set_mac_address,
502 {'sw_if_index': sw_if_index,
505 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
506 """Create p2p ethernet subinterface
508 :param sw_if_index: main (parent) interface
509 :param remote_mac: client (remote) mac address
513 self.papi.p2p_ethernet_add,
514 {'parent_if_index': sw_if_index,
515 'remote_mac': remote_mac,
516 'subif_id': subif_id})
518 def p2p_ethernet_del(self, sw_if_index, remote_mac):
519 """Delete p2p ethernet subinterface
521 :param sw_if_index: main (parent) interface
522 :param remote_mac: client (remote) mac address
526 self.papi.p2p_ethernet_del,
527 {'parent_if_index': sw_if_index,
528 'remote_mac': remote_mac})
530 def create_vlan_subif(self, sw_if_index, vlan):
537 return self.api(self.papi.create_vlan_subif,
538 {'sw_if_index': sw_if_index,
541 def create_loopback(self, mac=''):
544 :param mac: (Optional)
546 return self.api(self.papi.create_loopback,
547 {'mac_address': mac})
549 def ip_neighbor_add_del(self,
555 """ Add neighbor MAC to IPv4 or IPv6 address.
560 :param is_add: (Default value = 1)
561 :param flags: (Default value = 0/NONE)
564 self.papi.ip_neighbor_add_del,
568 'sw_if_index': sw_if_index,
570 'mac_address': mac_address,
571 'ip_address': ip_address
576 def proxy_arp_add_del(self,
581 """ Config Proxy Arp Range.
583 :param low_address: Start address in the rnage to Proxy for
584 :param hi_address: End address in the rnage to Proxy for
585 :param vrf_id: The VRF/table in which to proxy
589 self.papi.proxy_arp_add_del,
592 'table_id': table_id,
598 def proxy_arp_intfc_enable_disable(self,
601 """ Enable/Disable an interface for proxy ARP requests
603 :param sw_if_index: Interface
604 :param enable_disable: Enable/Disable
608 self.papi.proxy_arp_intfc_enable_disable,
609 {'sw_if_index': sw_if_index,
610 'enable_disable': is_enable
614 def gre_tunnel_add_del(self,
626 :param outer_fib_id: (Default value = 0)
627 :param tunnel_type: (Default value = 0)
628 :param instance: (Default value = 0xFFFFFFFF)
629 :param session_id: (Default value = 0)
630 :param is_add: (Default value = 1)
631 :param is_ipv6: (Default value = 0)
635 self.papi.gre_tunnel_add_del,
640 'instance': instance,
643 'outer_fib_id': outer_fib_id,
644 'session_id': session_id}
648 def udp_encap_add(self,
659 :param outer_fib_id: (Default value = 0)
663 self.papi.udp_encap_add,
668 'src_port': src_port,
669 'dst_port': dst_port,
674 def mpls_table_add_del(
681 :param is_add: (Default value = 1)
686 self.papi.mpls_table_add_del,
687 {'mt_table_id': table_id,
688 'mt_is_add': is_add})
690 def mpls_ip_bind_unbind(
702 self.papi.mpls_ip_bind_unbind,
703 {'mb_mpls_table_id': table_id,
705 'mb_ip_table_id': ip_table_id,
706 'mb_is_bind': is_bind,
708 'mb_address_length': dst_address_length,
709 'mb_address': dst_address})
711 def mpls_tunnel_add_del(
714 next_hop_proto_is_ip4,
716 next_hop_sw_if_index=0xFFFFFFFF,
719 next_hop_n_out_labels=0,
720 next_hop_out_label_stack=[],
721 next_hop_via_label=MPLS_LABEL_INVALID,
727 :param dst_address_length:
728 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
730 :param next_hop_address:
731 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
732 :param vrf_id: (Default value = 0)
733 :param lookup_in_vrf: (Default value = 0)
734 :param classify_table_index: (Default value = 0xFFFFFFFF)
735 :param is_add: (Default value = 1)
736 :param is_drop: (Default value = 0)
737 :param is_ipv6: (Default value = 0)
738 :param is_local: (Default value = 0)
739 :param is_classify: (Default value = 0)
740 :param is_multipath: (Default value = 0)
741 :param is_resolve_host: (Default value = 0)
742 :param is_resolve_attached: (Default value = 0)
743 :param next_hop_weight: (Default value = 1)
744 :param is_multicast: (Default value = 0)
748 self.papi.mpls_tunnel_add_del,
749 {'mt_sw_if_index': tun_sw_if_index,
751 'mt_l2_only': l2_only,
752 'mt_is_multicast': is_multicast,
753 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
754 'mt_next_hop_weight': next_hop_weight,
755 'mt_next_hop': next_hop_address,
756 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
757 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
758 'mt_next_hop_table_id': next_hop_table_id,
759 'mt_next_hop_via_label': next_hop_via_label,
760 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
762 def nat44_interface_add_del_feature(
767 """Enable/disable NAT44 feature on the interface
769 :param sw_if_index: Software index of the interface
770 :param is_add: 1 if add, 0 if delete (Default value = 1)
771 :param flags: NAT_IS_INSIDE if inside else outside
774 self.papi.nat44_interface_add_del_feature,
777 'sw_if_index': sw_if_index})
779 def nat44_interface_add_del_output_feature(
784 """Enable/disable NAT44 output feature on the interface
786 :param sw_if_index: Software index of the interface
787 :param is_add: 1 if add, 0 if delete (Default value = 1)
788 :param flags: NAT_IS_INSIDE if inside else outside
791 self.papi.nat44_interface_add_del_output_feature,
794 'sw_if_index': sw_if_index})
796 def nat44_add_del_static_mapping(
800 external_sw_if_index=0xFFFFFFFF,
808 """Add/delete NAT44 static mapping
810 :param local_ip: Local IP address
811 :param external_ip: External IP address
812 :param external_sw_if_index: External interface instead of IP address
813 :param local_port: Local port number (Default value = 0)
814 :param external_port: External port number (Default value = 0)
815 :param vrf_id: VRF ID
816 :param protocol: IP protocol (Default value = 0)
817 :param flags: NAT configuration flags
818 :param is_add: 1 if add, 0 if delete (Default value = 1)
819 :param tag: Opaque string tag
822 self.papi.nat44_add_del_static_mapping,
825 'local_ip_address': local_ip,
826 'external_ip_address': external_ip,
827 'protocol': protocol,
828 'local_port': local_port,
829 'external_port': external_port,
830 'external_sw_if_index': external_sw_if_index,
834 def nat44_add_del_identity_mapping(
837 sw_if_index=0xFFFFFFFF,
844 """Add/delete NAT44 identity mapping
846 :param ip: IP address (Default value = 0)
847 :param sw_if_index: Interface instead of IP address
848 :param port: Port number (Default value = 0)
849 :param flags: NAT configuration flags (NAT_IS_ADDR_ONLY)
850 :param vrf_id: VRF ID
851 :param protocol: IP protocol (Default value = 0)
852 :param tag: Opaque string tag
853 :param is_add: 1 if add, 0 if delete (Default value = 1)
856 self.papi.nat44_add_del_identity_mapping,
860 'protocol': protocol,
862 'sw_if_index': sw_if_index,
866 def nat44_add_del_address_range(
873 """Add/del NAT44 address range
875 :param first_ip_address: First IP address
876 :param last_ip_address: Last IP address
877 :param vrf_id: VRF id for the address range
878 :param is_add: 1 if add, 0 if delete (Default value = 1)
879 :param flags: NAT configuration flags (NAT_IS_TWICE_NAT)
882 self.papi.nat44_add_del_address_range,
883 {'first_ip_address': first_ip_address,
884 'last_ip_address': last_ip_address,
889 def nat44_add_del_interface_addr(
894 """Add/del NAT44 address from interface
896 :param sw_if_index: Software index of the interface
897 :param flags: NAT configuration flags (NAT_IS_TWICE_NAT)
898 :param is_add: 1 if add, 0 if delete (Default value = 1)
901 self.papi.nat44_add_del_interface_addr,
903 'sw_if_index': sw_if_index,
906 def nat44_add_del_lb_static_mapping(
917 """Add/delete NAT44 load balancing static mapping
919 :param tag: Opaque string tag
920 :param affinity: if 0 disabled, otherwise client IP affinity timeout
921 :param flags: NAT configuration flags (NAT_IS_TWICE_NAT)
922 :param is_add - 1 if add, 0 if delete
925 self.papi.nat44_add_del_lb_static_mapping,
928 'external_addr': external_addr,
929 'external_port': external_port,
930 'protocol': protocol,
931 'affinity': affinity,
932 'local_num': local_num,
936 def nat44_lb_static_mapping_add_del_local(
946 """Add/delete NAT44 load-balancing static mapping rule backend
948 :param external_addr: external IPv4 address of the service
949 :param external_port: external L4 port number of the service
950 :param local_addr: IPv4 address of the internal node
951 :param local_port: L4 port number of the internal node
952 :param protocol: IP protocol number
953 :param probability: probability of the internal node
954 :param vrf_id: VRF id of the internal node
955 :param is_add: 1 if add, 0 if delete
958 self.papi.nat44_lb_static_mapping_add_del_local,
960 'external_addr': external_addr,
961 'external_port': external_port,
965 'probability': probability,
967 'protocol': protocol})
969 def nat44_del_session(
976 ext_host_address=None,
978 """Delete NAT44 session
980 :param addr: IPv4 address
981 :param por: port number
982 :param protocol: IP protocol number
983 :param vrf_id: VRF ID
984 :param flags: NAT configuration flags (NAT_IS_INSIDE)
985 :param ext_host_address: external host IPv4 address
986 :param ext_host_port: external host port
989 self.papi.nat44_del_session,
991 'protocol': protocol,
995 'ext_host_address': ext_host_address,
996 'ext_host_port': ext_host_port})
998 def nat44_forwarding_enable_disable(
1001 """Enable/disable forwarding for NAT44
1003 :param enable: 1 for enable, 0 for disable
1006 self.papi.nat44_forwarding_enable_disable,
1009 def nat_det_map_dump(self):
1010 """Dump deterministic NAT mappings
1012 :return: Dictionary of deterministic NAT mappings
1014 return self.api(self.papi.nat_det_map_dump, {})
1016 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1017 """Set TCP MSS rewriting configuration
1019 :param enable: disable(0)/enable(1) MSS rewriting feature
1020 :param mss_value: MSS value to be used for MSS rewriting
1023 self.papi.nat_set_mss_clamping,
1024 {'enable': enable, 'mss_value': mss_value})
1026 def nat64_add_del_static_bib(
1035 """Add/delete S-NAT static BIB entry
1037 :param in_ip: Inside IPv6 address
1038 :param out_ip: Outside IPv4 address
1039 :param in_port: Inside port number
1040 :param out_port: Outside port number
1041 :param protocol: IP protocol
1042 :param vrf_id: VRF ID (Default value = 0)
1043 :param is_add: 1 if add, 0 if delete (Default value = 1)
1046 self.papi.nat64_add_del_static_bib,
1055 def nat64_bib_dump(self, protocol=255):
1058 :param protocol: IP protocol (Default value = 255, all BIBs)
1059 :returns: Dictionary of NAT64 BIB entries
1061 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1063 def nat64_st_dump(self, protocol=255):
1064 """Dump NAT64 session table
1066 :param protocol: IP protocol (Default value = 255, all STs)
1067 :returns: Dictionary of NAT64 session table entries
1069 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1071 def nat64_add_del_prefix(self, prefix, vrf_id=0, is_add=1):
1072 """Add/del NAT64 prefix
1074 :param prefix: NAT64 prefix
1075 :param vrf_id: VRF id of tenant (Default 0)
1076 :param is_add: 1 if add, 0 if delete (Default value = 1)
1079 self.papi.nat64_add_del_prefix,
1084 def nat64_add_del_interface_addr(
1088 """Add/del NAT64 address from interface
1090 :param sw_if_index: Software index of the interface
1091 :param is_add: 1 if add, 0 if delete (Default value = 1)
1093 return self.api(self.papi.nat64_add_del_interface_addr,
1094 {'is_add': is_add, 'sw_if_index': sw_if_index})
1096 def dslite_set_aftr_addr(self, ip6, ip4):
1097 """Set DS-Lite AFTR addresses
1099 :param ip4: IPv4 address
1100 :param ip6: IPv6 address
1103 self.papi.dslite_set_aftr_addr,
1107 def dslite_set_b4_addr(self, ip6, ip4):
1108 """Set DS-Lite B4 IPv6 address
1110 :param ip4: IPv4 address
1111 :param ip6: IPv6 address
1114 self.papi.dslite_set_b4_addr,
1118 def nat66_add_del_interface(
1123 """Enable/disable NAT66 feature on the interface
1125 :param sw_if_index: Index of the interface
1126 :param flags: NAT configuration flags (NAT_IS_INSIDE)
1127 :param is_add: 1 if add, 0 if delete (Default value = 1)
1130 self.papi.nat66_add_del_interface,
1133 'sw_if_index': sw_if_index})
1135 def nat66_add_del_static_mapping(
1141 """Add/delete NAT66 static mapping
1143 :param in_ip: Inside IPv6 address
1144 :param out_ip: Outside IPv6 address
1145 :param vrf_id: VRF ID (Default value = 0)
1146 :param is_add: 1 if add, 0 if delete (Default value = 1)
1149 self.papi.nat66_add_del_static_mapping,
1150 {'local_ip_address': in_ip,
1151 'external_ip_address': out_ip,
1155 def nat_ha_set_listener(self, addr, port, path_mtu=512):
1156 """Set HA listener (local settings)
1158 :param addr: local IP4 address
1159 :param port: local UDP port number
1160 :param path_mtu: path MTU (Default value = 512)
1162 return self.api(self.papi.nat_ha_set_listener,
1163 {'ip_address': addr,
1165 'path_mtu': path_mtu})
1167 def nat_ha_get_listener(self):
1168 """Get HA listener/local configuration"""
1169 return self.api(self.papi.nat_ha_get_listener, {})
1171 def nat_ha_set_failover(self, addr, port, refresh=10):
1172 """Set HA failover (remote settings)
1174 :param addr: failover IP4 address
1175 :param port: failover UDP port number
1176 :param refresh: number of seconds after which to send session refresh
1178 return self.api(self.papi.nat_ha_set_failover,
1179 {'ip_address': addr,
1181 'session_refresh_interval': refresh})
1183 def nat_ha_resync(self, want_resync_event=1):
1184 """Resync HA (resend existing sessions to new failover)
1185 :param want_resync_event: if non-zero resync completed event sent
1187 return self.api(self.papi.nat_ha_resync,
1188 {'want_resync_event': want_resync_event,
1189 'pid': os.getpid()})
1191 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1192 detect_mult, local_addr, peer_addr, is_ipv6=0,
1193 bfd_key_id=None, conf_key_id=None):
1194 if bfd_key_id is None:
1195 return self.api(self.papi.bfd_udp_add,
1197 'sw_if_index': sw_if_index,
1198 'desired_min_tx': desired_min_tx,
1199 'required_min_rx': required_min_rx,
1200 'local_addr': local_addr,
1201 'peer_addr': peer_addr,
1203 'detect_mult': detect_mult,
1206 return self.api(self.papi.bfd_udp_add,
1208 'sw_if_index': sw_if_index,
1209 'desired_min_tx': desired_min_tx,
1210 'required_min_rx': required_min_rx,
1211 'local_addr': local_addr,
1212 'peer_addr': peer_addr,
1214 'detect_mult': detect_mult,
1215 'is_authenticated': 1,
1216 'bfd_key_id': bfd_key_id,
1217 'conf_key_id': conf_key_id,
1220 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1221 detect_mult, local_addr, peer_addr, is_ipv6=0):
1222 return self.api(self.papi.bfd_udp_mod,
1224 'sw_if_index': sw_if_index,
1225 'desired_min_tx': desired_min_tx,
1226 'required_min_rx': required_min_rx,
1227 'local_addr': local_addr,
1228 'peer_addr': peer_addr,
1230 'detect_mult': detect_mult,
1233 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1234 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1236 return self.api(self.papi.bfd_udp_auth_activate,
1238 'sw_if_index': sw_if_index,
1239 'local_addr': local_addr,
1240 'peer_addr': peer_addr,
1242 'is_delayed': 1 if is_delayed else 0,
1243 'bfd_key_id': bfd_key_id,
1244 'conf_key_id': conf_key_id,
1247 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1248 peer_addr, is_ipv6=0):
1249 return self.api(self.papi.bfd_udp_session_set_flags, {
1250 'admin_up_down': admin_up_down,
1251 'sw_if_index': sw_if_index,
1252 'local_addr': local_addr,
1253 'peer_addr': peer_addr,
1257 def want_bfd_events(self, enable_disable=1):
1258 return self.api(self.papi.want_bfd_events, {
1259 'enable_disable': enable_disable,
1263 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1264 return self.api(self.papi.bfd_auth_set_key, {
1265 'conf_key_id': conf_key_id,
1266 'auth_type': auth_type,
1268 'key_len': len(key),
1271 def classify_add_del_table(
1276 table_index=0xFFFFFFFF,
1278 memory_size=2097152,
1280 next_table_index=0xFFFFFFFF,
1281 miss_next_index=0xFFFFFFFF,
1282 current_data_flag=0,
1283 current_data_offset=0):
1287 :param match_n_vectors: (Default value = 1)
1288 :param table_index: (Default value = 0xFFFFFFFF)
1289 :param nbuckets: (Default value = 2)
1290 :param memory_size: (Default value = 2097152)
1291 :param skip_n_vectors: (Default value = 0)
1292 :param next_table_index: (Default value = 0xFFFFFFFF)
1293 :param miss_next_index: (Default value = 0xFFFFFFFF)
1294 :param current_data_flag: (Default value = 0)
1295 :param current_data_offset: (Default value = 0)
1298 mask_len = ((len(mask) - 1) / 16 + 1) * 16
1299 mask = mask + '\0' * (mask_len - len(mask))
1301 self.papi.classify_add_del_table,
1303 'table_index': table_index,
1304 'nbuckets': nbuckets,
1305 'memory_size': memory_size,
1306 'skip_n_vectors': skip_n_vectors,
1307 'match_n_vectors': match_n_vectors,
1308 'next_table_index': next_table_index,
1309 'miss_next_index': miss_next_index,
1310 'current_data_flag': current_data_flag,
1311 'current_data_offset': current_data_offset,
1312 'mask_len': mask_len,
1315 def classify_add_del_session(
1320 opaque_index=0xFFFFFFFF,
1321 hit_next_index=0xFFFFFFFF,
1329 :param opaque_index: (Default value = 0xFFFFFFFF)
1330 :param hit_next_index: (Default value = 0xFFFFFFFF)
1331 :param advance: (Default value = 0)
1332 :param action: (Default value = 0)
1333 :param metadata: (Default value = 0)
1336 match_len = ((len(match) - 1) / 16 + 1) * 16
1337 match = match + '\0' * (match_len - len(match))
1339 self.papi.classify_add_del_session,
1341 'table_index': table_index,
1342 'hit_next_index': hit_next_index,
1343 'opaque_index': opaque_index,
1346 'metadata': metadata,
1347 'match_len': match_len,
1350 def input_acl_set_interface(
1354 ip4_table_index=0xFFFFFFFF,
1355 ip6_table_index=0xFFFFFFFF,
1356 l2_table_index=0xFFFFFFFF):
1360 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1361 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1362 :param l2_table_index: (Default value = 0xFFFFFFFF)
1366 self.papi.input_acl_set_interface,
1367 {'sw_if_index': sw_if_index,
1368 'ip4_table_index': ip4_table_index,
1369 'ip6_table_index': ip6_table_index,
1370 'l2_table_index': l2_table_index,
1373 def output_acl_set_interface(
1377 ip4_table_index=0xFFFFFFFF,
1378 ip6_table_index=0xFFFFFFFF,
1379 l2_table_index=0xFFFFFFFF):
1383 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1384 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1385 :param l2_table_index: (Default value = 0xFFFFFFFF)
1389 self.papi.output_acl_set_interface,
1390 {'sw_if_index': sw_if_index,
1391 'ip4_table_index': ip4_table_index,
1392 'ip6_table_index': ip6_table_index,
1393 'l2_table_index': l2_table_index,
1396 def set_ipfix_exporter(
1403 collector_port=4739,
1406 self.papi.set_ipfix_exporter,
1408 'collector_address': collector_address,
1409 'collector_port': collector_port,
1410 'src_address': src_address,
1412 'path_mtu': path_mtu,
1413 'template_interval': template_interval,
1414 'udp_checksum': udp_checksum,
1417 def dhcp_proxy_config(self,
1425 self.papi.dhcp_proxy_config,
1427 'rx_vrf_id': rx_table_id,
1428 'server_vrf_id': server_table_id,
1431 'dhcp_server': dhcp_server,
1432 'dhcp_src_address': dhcp_src_address,
1435 def dhcp_proxy_set_vss(self,
1444 self.papi.dhcp_proxy_set_vss,
1447 'vss_type': vss_type,
1448 'vpn_ascii_id': vpn_ascii_id,
1450 'vpn_index': vpn_index,
1455 def dhcp_client_config(self,
1460 set_broadcast_flag=1,
1461 want_dhcp_events=0):
1463 self.papi.dhcp_client_config,
1467 'sw_if_index': sw_if_index,
1468 'hostname': hostname,
1470 'want_dhcp_event': want_dhcp_events,
1471 'set_broadcast_flag': set_broadcast_flag,
1475 def ip_mroute_add_del(self,
1481 next_hop_sw_if_index,
1491 IP Multicast Route add/del
1494 self.papi.ip_mroute_add_del,
1495 {'next_hop_sw_if_index': next_hop_sw_if_index,
1496 'entry_flags': e_flags,
1497 'itf_flags': i_flags,
1498 'table_id': table_id,
1502 'is_local': is_local,
1503 'bier_imp': bier_imp,
1504 'next_hop_afi': next_hop_afi,
1505 'grp_address_length': grp_address_length,
1506 'grp_address': grp_address,
1507 'src_address': src_address,
1508 'nh_address': next_hop_address})
1510 def lisp_enable_disable(self, is_enabled):
1512 self.papi.lisp_enable_disable,
1514 'is_en': is_enabled,
1517 def lisp_add_del_locator_set(self,
1521 self.papi.lisp_add_del_locator_set,
1524 'locator_set_name': ls_name
1527 def lisp_add_del_locator(self,
1534 self.papi.lisp_add_del_locator,
1537 'locator_set_name': ls_name,
1538 'sw_if_index': sw_if_index,
1539 'priority': priority,
1543 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1545 self.papi.lisp_locator_dump,
1547 'is_index_set': is_index_set,
1549 'ls_index': ls_index,
1552 def lisp_add_del_local_eid(self,
1562 self.papi.lisp_add_del_local_eid,
1564 'locator_set_name': ls_name,
1566 'eid_type': eid_type,
1568 'prefix_len': prefix_len,
1574 def lisp_eid_table_dump(self,
1582 self.papi.lisp_eid_table_dump,
1585 'prefix_length': prefix_length,
1587 'eid_type': eid_type,
1589 'filter': filter_opt,
1592 def lisp_add_del_remote_mapping(self,
1602 self.papi.lisp_add_del_remote_mapping,
1605 'eid_type': eid_type,
1607 'eid_len': eid_prefix_len,
1608 'rloc_num': rlocs_num,
1611 'is_src_dst': is_src_dst,
1614 def lisp_add_del_adjacency(self,
1623 self.papi.lisp_add_del_adjacency,
1627 'eid_type': eid_type,
1630 'leid_len': leid_len,
1631 'reid_len': reid_len,
1634 def gtpu_add_del_tunnel(
1640 mcast_sw_if_index=0xFFFFFFFF,
1642 decap_next_index=0xFFFFFFFF,
1646 :param is_add: (Default value = 1)
1647 :param is_ipv6: (Default value = 0)
1650 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1651 :param encap_vrf_id: (Default value = 0)
1652 :param decap_next_index: (Default value = 0xFFFFFFFF)
1653 :param teid: (Default value = 0)
1656 return self.api(self.papi.gtpu_add_del_tunnel,
1659 'src_address': src_addr,
1660 'dst_address': dst_addr,
1661 'mcast_sw_if_index': mcast_sw_if_index,
1662 'encap_vrf_id': encap_vrf_id,
1663 'decap_next_index': decap_next_index,
1666 def vxlan_gpe_add_del_tunnel(
1670 mcast_sw_if_index=0xFFFFFFFF,
1681 :param is_add: (Default value = 1)
1682 :param is_ipv6: (Default value = 0)
1683 :param encap_vrf_id: (Default value = 0)
1684 :param decap_vrf_id: (Default value = 0)
1685 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1686 :param protocol: (Default value = 3)
1687 :param vni: (Default value = 0)
1690 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1695 'mcast_sw_if_index': mcast_sw_if_index,
1696 'encap_vrf_id': encap_vrf_id,
1697 'decap_vrf_id': decap_vrf_id,
1698 'protocol': protocol,
1701 def vxlan_gbp_tunnel_add_del(
1705 mcast_sw_if_index=0xFFFFFFFF,
1711 instance=0xFFFFFFFF):
1716 :param is_add: (Default value = 1)
1717 :param is_ipv6: (Default value = 0)
1718 :param encap_table_id: (Default value = 0)
1719 :param decap_next_index: (Default value = 0xFFFFFFFF)
1720 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1721 :param vni: (Default value = 0)
1722 :param instance: (Default value = 0xFFFFFFFF)
1725 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
1730 'mcast_sw_if_index': mcast_sw_if_index,
1731 'encap_table_id': encap_table_id,
1733 'instance': instance,
1736 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1737 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1738 {'sw_if_index': sw_if_index,
1739 '_no_type_conversion': True})
1741 def pppoe_add_del_session(
1751 :param is_add: (Default value = 1)
1752 :param is_ipv6: (Default value = 0)
1754 :param session_id: (Default value = 0)
1756 :param decap_vrf_id: (Default value = 0)
1759 return self.api(self.papi.pppoe_add_del_session,
1762 'session_id': session_id,
1763 'client_ip': client_ip,
1764 'decap_vrf_id': decap_vrf_id,
1765 'client_mac': client_mac})
1767 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1768 return self.api(self.papi.sr_mpls_policy_add,
1772 'n_segments': len(segments),
1773 'segments': segments})
1775 def sr_mpls_policy_del(self, bsid):
1776 return self.api(self.papi.sr_mpls_policy_del,
1779 def sr_localsid_add_del(self,
1786 sw_if_index=0xFFFFFFFF,
1790 """ Add/del IPv6 SR local-SID.
1793 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1794 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1797 :param is_del: (Default value = 0)
1798 :param end_psp: (Default value = 0)
1799 :param sw_if_index: (Default value = 0xFFFFFFFF)
1800 :param vlan_index: (Default value = 0)
1801 :param fib_table: (Default value = 0)
1804 self.papi.sr_localsid_add_del,
1806 'localsid': localsid,
1808 'behavior': behavior,
1809 'sw_if_index': sw_if_index,
1810 'vlan_index': vlan_index,
1811 'fib_table': fib_table,
1812 'nh_addr4': nh_addr4,
1813 'nh_addr6': nh_addr6
1827 :param bsid_addr: bindingSID of the SR Policy
1828 :param weight: weight of the sid list. optional. (default: 1)
1829 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1831 :param type: type/behavior of the SR policy. (default or spray) \
1833 :param fib_table: VRF where to install the FIB entry for the BSID \
1835 :param n_segments: number of segments \
1837 :param segments: a vector of IPv6 address composing the segment list \
1841 self.papi.sr_policy_add,
1842 {'bsid_addr': bsid_addr,
1844 'is_encap': is_encap,
1846 'fib_table': fib_table,
1847 'n_segments': n_segments,
1848 'segments': segments
1857 :param bsid: bindingSID of the SR Policy
1858 :param sr_policy_index: index of the sr policy (default: 0)
1861 self.papi.sr_policy_del,
1862 {'bsid_addr': bsid_addr,
1863 'sr_policy_index': sr_policy_index
1866 def sr_steering_add_del(
1877 Steer traffic L2 and L3 traffic through a given SR policy
1879 :param is_del: delete or add
1880 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1881 :param sr_policy: is the index of the SR Policy (alt to bsid)
1882 :param table_id: is the VRF where to install the FIB entry for the BSID
1883 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1884 :param mask_width: is the mask for L3 traffic type
1885 :param sw_if_index: is the incoming interface for L2 traffic
1886 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1889 self.papi.sr_steering_add_del,
1891 'bsid_addr': bsid_addr,
1892 'sr_policy_index': sr_policy_index,
1893 'table_id': table_id,
1894 'prefix_addr': prefix_addr,
1895 'mask_width': mask_width,
1896 'sw_if_index': sw_if_index,
1897 'traffic_type': traffic_type
1900 def acl_add_replace(self, acl_index, r, tag='',
1902 """Add/replace an ACL
1903 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1904 :param acl_rule r: ACL rules array.
1905 :param str tag: symbolic tag (description) for this ACL.
1906 :param int count: number of rules.
1908 return self.api(self.papi.acl_add_replace,
1909 {'acl_index': acl_index,
1913 expected_retval=expected_retval)
1915 def acl_del(self, acl_index, expected_retval=0):
1921 return self.api(self.papi.acl_del,
1922 {'acl_index': acl_index},
1923 expected_retval=expected_retval)
1925 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1927 return self.api(self.papi.acl_interface_set_acl_list,
1928 {'sw_if_index': sw_if_index,
1932 expected_retval=expected_retval)
1934 def acl_interface_set_etype_whitelist(self, sw_if_index,
1937 return self.api(self.papi.acl_interface_set_etype_whitelist,
1938 {'sw_if_index': sw_if_index,
1939 'count': len(whitelist),
1941 'whitelist': whitelist},
1942 expected_retval=expected_retval)
1944 def acl_interface_add_del(self,
1948 """ Add/Delete ACL to/from interface
1952 :param is_add: (Default value = 1)
1955 return self.api(self.papi.acl_interface_add_del,
1958 'sw_if_index': sw_if_index,
1959 'acl_index': acl_index})
1961 def acl_dump(self, acl_index, expected_retval=0):
1962 return self.api(self.papi.acl_dump,
1963 {'acl_index': acl_index},
1964 expected_retval=expected_retval)
1966 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1968 return self.api(self.papi.acl_interface_list_dump,
1969 {'sw_if_index': sw_if_index},
1970 expected_retval=expected_retval)
1972 def macip_acl_add(self, rules, tag=""):
1975 :param rules: list of rules for given acl
1979 return self.api(self.papi.macip_acl_add,
1981 'count': len(rules),
1984 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1987 :param rules: list of rules for given acl
1991 return self.api(self.papi.macip_acl_add_replace,
1992 {'acl_index': acl_index,
1994 'count': len(rules),
1997 def macip_acl_interface_add_del(self,
2001 """ Add MACIP acl to interface
2005 :param is_add: (Default value = 1)
2008 return self.api(self.papi.macip_acl_interface_add_del,
2010 'sw_if_index': sw_if_index,
2011 'acl_index': acl_index})
2013 def macip_acl_dump(self, acl_index=4294967295):
2014 """ Return MACIP acl dump
2018 self.papi.macip_acl_dump, {'acl_index': acl_index})
2020 def policer_add_del(self,
2031 conform_action_type=1,
2033 exceed_action_type=0,
2035 violate_action_type=0,
2037 return self.api(self.papi.policer_add_del,
2044 'rate_type': rate_type,
2045 'round_type': round_type,
2047 'color_aware': color_aware,
2048 'conform_action_type': conform_action_type,
2049 'conform_dscp': conform_dscp,
2050 'exceed_action_type': exceed_action_type,
2051 'exceed_dscp': exceed_dscp,
2052 'violate_action_type': violate_action_type,
2053 'violate_dscp': violate_dscp})
2055 def ip_punt_police(self,
2059 return self.api(self.papi.ip_punt_police,
2060 {'policer_index': policer_index,
2064 def ip_punt_redirect(self,
2069 return self.api(self.papi.ip_punt_redirect,
2070 {'punt': {'rx_sw_if_index': rx_sw_if_index,
2071 'tx_sw_if_index': tx_sw_if_index,
2075 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
2076 return self.api(self.papi.ip_punt_redirect_dump,
2077 {'sw_if_index': sw_if_index,
2078 'is_ipv6': is_ipv6})
2080 def bier_table_add_del(self,
2084 """ BIER Table add/del """
2086 self.papi.bier_table_add_del,
2087 {'bt_tbl_id': {"bt_set": bti.set_id,
2088 "bt_sub_domain": bti.sub_domain_id,
2089 "bt_hdr_len_id": bti.hdr_len_id},
2090 'bt_label': mpls_label,
2091 'bt_is_add': is_add})
2093 def bier_table_dump(self):
2094 return self.api(self.papi.bier_table_dump, {})
2096 def bier_route_add_del(self,
2102 """ BIER Route add/del """
2104 self.papi.bier_route_add_del,
2105 {'br_tbl_id': {"bt_set": bti.set_id,
2106 "bt_sub_domain": bti.sub_domain_id,
2107 "bt_hdr_len_id": bti.hdr_len_id},
2109 'br_n_paths': len(paths),
2111 'br_is_add': is_add,
2112 'br_is_replace': is_replace})
2114 def bier_route_dump(self, bti):
2116 self.papi.bier_route_dump,
2117 {'br_tbl_id': {"bt_set": bti.set_id,
2118 "bt_sub_domain": bti.sub_domain_id,
2119 "bt_hdr_len_id": bti.hdr_len_id}})
2121 def bier_imp_add(self,
2126 """ BIER Imposition Add """
2128 self.papi.bier_imp_add,
2129 {'bi_tbl_id': {"bt_set": bti.set_id,
2130 "bt_sub_domain": bti.sub_domain_id,
2131 "bt_hdr_len_id": bti.hdr_len_id},
2133 'bi_n_bytes': len(ibytes),
2134 'bi_bytes': ibytes})
2136 def bier_imp_del(self, bi_index):
2137 """ BIER Imposition del """
2139 self.papi.bier_imp_del,
2140 {'bi_index': bi_index})
2142 def bier_imp_dump(self):
2143 return self.api(self.papi.bier_imp_dump, {})
2145 def bier_disp_table_add_del(self,
2148 """ BIER Disposition Table add/del """
2150 self.papi.bier_disp_table_add_del,
2151 {'bdt_tbl_id': bdti,
2152 'bdt_is_add': is_add})
2154 def bier_disp_table_dump(self):
2155 return self.api(self.papi.bier_disp_table_dump, {})
2157 def bier_disp_entry_add_del(self,
2167 """ BIER Route add/del """
2169 while (len(lstack) < 16):
2172 self.papi.bier_disp_entry_add_del,
2173 {'bde_tbl_id': bdti,
2175 'bde_payload_proto': payload_proto,
2177 'bde_paths': [{'next_hop': next_hop,
2178 'table_id': next_hop_tbl_id,
2179 'afi': next_hop_afi,
2180 'rpf_id': next_hop_rpf_id,
2182 'label_stack': lstack}],
2183 'bde_is_add': is_add})
2185 def bier_disp_entry_dump(self, bdti):
2187 self.papi.bier_disp_entry_dump,
2188 {'bde_tbl_id': bdti})
2190 def session_enable_disable(self, is_enabled):
2192 self.papi.session_enable_disable,
2193 {'is_enable': is_enabled})
2195 def ipsec_spd_add_del(self, spd_id, is_add=1):
2196 """ SPD add/del - Wrapper to add or del ipsec SPD
2197 Sample CLI : 'ipsec spd add 1'
2199 :param spd_id - SPD ID to be created in the vpp . mandatory
2200 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2202 :returns: reply from the API
2205 self.papi.ipsec_spd_add_del, {
2206 'spd_id': spd_id, 'is_add': is_add})
2208 def ipsec_spds_dump(self):
2209 return self.api(self.papi.ipsec_spds_dump, {})
2211 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2212 """ IPSEC interface SPD add/del - \
2213 Wrapper to associate/disassociate SPD to interface in VPP
2214 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2216 :param spd_id - SPD ID to associate with the interface . mandatory
2217 :param sw_if_index - Interface Index which needs to ipsec \
2218 association mandatory
2219 :param is_add - add(1) or del(0) association with interface \
2220 (Default 1 - add) . optional
2221 :returns: reply from the API
2224 self.papi.ipsec_interface_add_del_spd,
2225 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
2227 def ipsec_spd_interface_dump(self, spd_index=None):
2228 return self.api(self.papi.ipsec_spd_interface_dump,
2229 {'spd_index': spd_index if spd_index else 0,
2230 'spd_index_valid': 1 if spd_index else 0})
2232 def ipsec_sad_entry_add_del(self,
2235 integrity_algorithm,
2240 tunnel_src_address='',
2241 tunnel_dst_address='',
2245 """ IPSEC SA add/del
2246 :param sad_id: security association ID
2247 :param spi: security param index of the SA in decimal
2248 :param integrity_algorithm:
2249 :param integrity_key:
2250 :param crypto_algorithm:
2252 :param protocol: AH(0) or ESP(1) protocol
2253 :param tunnel_src_address: tunnel mode outer src address
2254 :param tunnel_dst_address: tunnel mode outer dst address
2257 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
2258 crypto and ipsec algorithms
2261 self.papi.ipsec_sad_entry_add_del,
2268 'tunnel_src': tunnel_src_address,
2269 'tunnel_dst': tunnel_dst_address,
2270 'protocol': protocol,
2271 'integrity_algorithm': integrity_algorithm,
2273 'length': len(integrity_key),
2274 'data': integrity_key,
2276 'crypto_algorithm': crypto_algorithm,
2278 'length': len(crypto_key),
2286 def ipsec_sa_dump(self, sa_id=None):
2287 return self.api(self.papi.ipsec_sa_dump,
2288 {'sa_id': sa_id if sa_id else 0xffffffff})
2290 def ipsec_spd_entry_add_del(self,
2293 local_address_start,
2295 remote_address_start,
2296 remote_address_stop,
2298 local_port_stop=65535,
2299 remote_port_start=0,
2300 remote_port_stop=65535,
2308 """ IPSEC policy SPD add/del -
2309 Wrapper to configure ipsec SPD policy entries in VPP
2310 :param spd_id: SPD ID for the policy
2311 :param local_address_start: local-ip-range start address
2312 :param local_address_stop : local-ip-range stop address
2313 :param remote_address_start: remote-ip-range start address
2314 :param remote_address_stop : remote-ip-range stop address
2315 :param local_port_start: (Default value = 0)
2316 :param local_port_stop: (Default value = 65535)
2317 :param remote_port_start: (Default value = 0)
2318 :param remote_port_stop: (Default value = 65535)
2319 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
2320 :param sa_id: Security Association ID for mapping it to SPD
2321 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
2323 :param priority: value for the spd action (Default value = 100)
2324 :param is_outbound: flag for inbound(0) or outbound(1)
2326 :param is_add: (Default value = 1)
2329 self.papi.ipsec_spd_entry_add_del,
2336 'local_address_start': local_address_start,
2337 'local_address_stop': local_address_stop,
2338 'remote_address_start': remote_address_start,
2339 'remote_address_stop': remote_address_stop,
2340 'local_port_start': local_port_start,
2341 'local_port_stop': local_port_stop,
2342 'remote_port_start': remote_port_start,
2343 'remote_port_stop': remote_port_stop,
2344 'protocol': protocol,
2346 'priority': priority,
2347 'is_outbound': is_outbound,
2348 'is_ip_any': is_ip_any
2352 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
2353 return self.api(self.papi.ipsec_spd_dump,
2357 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
2358 remote_spi, crypto_alg, local_crypto_key,
2359 remote_crypto_key, integ_alg, local_integ_key,
2360 remote_integ_key, is_add=1, esn=0, salt=0,
2361 anti_replay=1, renumber=0, show_instance=0):
2363 self.papi.ipsec_tunnel_if_add_del,
2365 'local_ip': local_ip,
2366 'remote_ip': remote_ip,
2367 'local_spi': local_spi,
2368 'remote_spi': remote_spi,
2369 'crypto_alg': crypto_alg,
2370 'local_crypto_key_len': len(local_crypto_key),
2371 'local_crypto_key': local_crypto_key,
2372 'remote_crypto_key_len': len(remote_crypto_key),
2373 'remote_crypto_key': remote_crypto_key,
2374 'integ_alg': integ_alg,
2375 'local_integ_key_len': len(local_integ_key),
2376 'local_integ_key': local_integ_key,
2377 'remote_integ_key_len': len(remote_integ_key),
2378 'remote_integ_key': remote_integ_key,
2381 'anti_replay': anti_replay,
2382 'renumber': renumber,
2383 'show_instance': show_instance,
2387 def ipsec_gre_tunnel_add_del(self, local_ip, remote_ip,
2388 sa_out, sa_in, is_add=1):
2389 return self.api(self.papi.ipsec_gre_tunnel_add_del,
2395 'local_sa_id': sa_out,
2396 'remote_sa_id': sa_in
2400 def ipsec_select_backend(self, protocol, index):
2401 return self.api(self.papi.ipsec_select_backend,
2402 {'protocol': protocol, 'index': index})
2404 def ipsec_backend_dump(self):
2405 return self.api(self.papi.ipsec_backend_dump, {})
2407 def app_namespace_add_del(self,
2411 sw_if_index=0xFFFFFFFF,
2414 self.papi.app_namespace_add_del,
2416 'sw_if_index': sw_if_index,
2417 'ip4_fib_id': ip4_fib_id,
2418 'ip6_fib_id': ip6_fib_id,
2419 'namespace_id': namespace_id,
2420 'namespace_id_len': len(namespace_id)})
2422 def punt_socket_register(self, port, pathname, protocol=0x11,
2423 header_version=1, is_ip4=1):
2424 """ Register punt socket """
2425 return self.api(self.papi.punt_socket_register,
2426 {'header_version': header_version,
2427 'punt': {'ipv': is_ip4,
2428 'l4_protocol': protocol,
2430 'pathname': pathname})
2432 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
2433 """ Unregister punt socket """
2434 return self.api(self.papi.punt_socket_deregister,
2435 {'punt': {'ipv': is_ip4,
2436 'l4_protocol': protocol,
2439 def punt_socket_dump(self, is_ip6=1):
2440 """ Dump punt socket"""
2441 return self.api(self.papi.punt_socket_dump,
2442 {'is_ipv6': is_ip6})
2444 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
2446 """ GBP endpoint Add """
2447 return self.api(self.papi.gbp_endpoint_add,
2449 'sw_if_index': sw_if_index,
2460 def gbp_endpoint_del(self, handle):
2461 """ GBP endpoint Del """
2462 return self.api(self.papi.gbp_endpoint_del,
2465 def gbp_endpoint_dump(self):
2466 """ GBP endpoint Dump """
2467 return self.api(self.papi.gbp_endpoint_dump,
2468 {'_no_type_conversion': True})
2470 def gbp_endpoint_group_add(self, vnid, sclass, bd,
2471 rd, uplink_sw_if_index,
2473 """ GBP endpoint group Add """
2474 return self.api(self.papi.gbp_endpoint_group_add,
2477 'uplink_sw_if_index': uplink_sw_if_index,
2482 'retention': retention
2485 def gbp_endpoint_group_del(self, sclass):
2486 """ GBP endpoint group Del """
2487 return self.api(self.papi.gbp_endpoint_group_del,
2490 def gbp_bridge_domain_add(self, bd_id, flags,
2493 bm_flood_sw_if_index):
2494 """ GBP bridge-domain Add """
2495 return self.api(self.papi.gbp_bridge_domain_add,
2499 'bvi_sw_if_index': bvi_sw_if_index,
2500 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2501 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2505 def gbp_bridge_domain_del(self, bd_id):
2506 """ GBP bridge-domain Del """
2507 return self.api(self.papi.gbp_bridge_domain_del,
2510 def gbp_route_domain_add(self, rd_id,
2514 ip6_uu_sw_if_index):
2515 """ GBP route-domain Add """
2516 return self.api(self.papi.gbp_route_domain_add,
2519 'ip4_table_id': ip4_table_id,
2520 'ip6_table_id': ip6_table_id,
2521 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2522 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2526 def gbp_route_domain_del(self, rd_id):
2527 """ GBP route-domain Del """
2528 return self.api(self.papi.gbp_route_domain_del,
2531 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2532 """ GBP recirc Add/Del """
2533 return self.api(self.papi.gbp_recirc_add_del,
2537 'sw_if_index': sw_if_index,
2540 def gbp_recirc_dump(self):
2541 """ GBP recirc Dump """
2542 return self.api(self.papi.gbp_recirc_dump, {})
2544 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2545 """ GBP recirc Add/Del """
2546 return self.api(self.papi.gbp_ext_itf_add_del,
2549 'sw_if_index': sw_if_index,
2553 def gbp_ext_itf_dump(self):
2554 """ GBP recirc Dump """
2555 return self.api(self.papi.gbp_ext_itf_dump, {})
2557 def gbp_subnet_add_del(self, is_add, rd_id,
2559 sw_if_index=0xffffffff,
2561 """ GBP Subnet Add/Del """
2562 return self.api(self.papi.gbp_subnet_add_del,
2566 'sw_if_index': sw_if_index,
2571 def gbp_subnet_dump(self):
2572 """ GBP Subnet Dump """
2573 return self.api(self.papi.gbp_subnet_dump,
2574 {'_no_type_conversion': True})
2576 def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2577 rules, allowed_ethertypes):
2578 """ GBP contract Add/Del """
2579 return self.api(self.papi.gbp_contract_add_del,
2582 'acl_index': acl_index,
2585 'n_rules': len(rules),
2587 'n_ether_types': len(allowed_ethertypes),
2588 'allowed_ethertypes': allowed_ethertypes}})
2590 def gbp_contract_dump(self):
2591 """ GBP contract Dump """
2592 return self.api(self.papi.gbp_contract_dump, {})
2594 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2595 """ GBP VXLAN tunnel add """
2596 return self.api(self.papi.gbp_vxlan_tunnel_add,
2601 'bd_rd_id': bd_rd_id,
2606 def gbp_vxlan_tunnel_del(self, vni):
2607 """ GBP VXLAN tunnel del """
2608 return self.api(self.papi.gbp_vxlan_tunnel_del,
2613 def gbp_vxlan_tunnel_dump(self):
2614 """ GBP VXLAN tunnel add/del """
2615 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2617 def qos_egress_map_update(self, id, outputs):
2618 """ QOS egress map update """
2619 return self.api(self.papi.qos_egress_map_update,
2623 def qos_egress_map_delete(self, id):
2624 """ QOS egress map delete """
2625 return self.api(self.papi.qos_egress_map_delete,
2628 def qos_mark_enable_disable(self, sw_if_index,
2632 """ QOS Mark Enable/Disable """
2633 return self.api(self.papi.qos_mark_enable_disable,
2635 'sw_if_index': sw_if_index,
2636 'output_source': output_source,
2639 def igmp_enable_disable(self, sw_if_index, enable, host):
2640 """ Enable/disable IGMP on a given interface """
2641 return self.api(self.papi.igmp_enable_disable,
2644 'sw_if_index': sw_if_index})
2646 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2647 """ Add/del IGMP proxy device """
2648 return self.api(self.papi.igmp_proxy_device_add_del,
2649 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2652 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2653 """ Add/del interface to/from IGMP proxy device """
2654 return self.api(self.papi.igmp_proxy_device_add_del_interface,
2655 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2658 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2659 """ Listen for new (S,G) on specified interface
2661 :param enable: add/del
2662 :param sw_if_index: interface sw index
2663 :param saddr: source ip4 addr
2664 :param gaddr: group ip4 addr
2666 return self.api(self.papi.igmp_listen,
2671 'sw_if_index': sw_if_index,
2672 'n_srcs': len(saddrs),
2678 def igmp_clear_interface(self, sw_if_index):
2679 """ Remove all (S,G)s from specified interface
2680 doesn't send IGMP report!
2683 self.papi.igmp_clear_interface, {
2684 'sw_if_index': sw_if_index})
2686 def want_igmp_events(self, enable=1):
2687 return self.api(self.papi.want_igmp_events, {'enable': enable,
2688 'pid': os.getpid()})
2696 interface_id=0xFFFFFFFF):
2699 :param lb: load balance
2700 :param use_custom_mac: use custom mac
2701 :param mac_address: mac address
2702 :param interface_id: custom interface ID
2705 self.papi.bond_create,
2708 'use_custom_mac': use_custom_mac,
2709 'mac_address': mac_address,
2713 def pipe_delete(self, parent_sw_if_index):
2714 return self.api(self.papi.pipe_delete,
2715 {'parent_sw_if_index': parent_sw_if_index})
2729 return self.api(self.papi.memif_create,
2732 'rx_queues': rx_queues,
2733 'tx_queues': tx_queues,
2735 'socket_id': socket_id,
2737 'ring_size': ring_size,
2738 'buffer_size': buffer_size,
2739 'hw_addr': hw_addr})
2741 def svs_table_add_del(self, af, table_id, is_add=1):
2742 return self.api(self.papi.svs_table_add_del,
2744 'table_id': table_id,
2749 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2750 return self.api(self.papi.svs_route_add_del,
2752 'table_id': table_id,
2753 'source_table_id': src_table_id,
2758 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2759 return self.api(self.papi.svs_enable_disable,
2762 'table_id': table_id,
2763 'sw_if_index': sw_if_index,
2764 'is_enable': is_enable,