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 VPPApiClient, 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 'bvi_create': {'user_instance': 4294967295, },
58 'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
59 'nbuckets': 2, 'memory_size': 2097152,
60 'next_table_index': 4294967295,
61 'miss_next_index': 4294967295, },
62 'dhcp6_client_enable_disable': {'enable': 1, },
63 'dhcp6_clients_enable_disable': {'enable': 1, },
64 'dhcp6_pd_client_enable_disable': {'enable': 1, },
65 'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
66 'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
67 'dhcp_proxy_config': {'is_add': 1, },
68 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
69 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
70 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
71 'decap_next_index': 4294967295, },
72 'gre_tunnel_add_del': {'instance': 4294967295, 'is_add': 1, },
73 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
74 'decap_next_index': 4294967295, },
75 'input_acl_set_interface': {'ip4_table_index': 4294967295,
76 'ip6_table_index': 4294967295,
77 'l2_table_index': 4294967295, },
78 'ip6_add_del_address_using_prefix': {'is_add': 1, },
79 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
80 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
81 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
82 'next_hop_id': 4294967295,
83 'classify_table_index': 4294967295, 'is_add': 1, },
84 'ip_mroute_add_del': {'is_add': 1, },
85 'ip_neighbor_add_del': {'is_add': 1, },
86 'ip_punt_police': {'is_add': 1, },
87 'ip_punt_redirect': {'is_add': 1, },
88 'ip_table_add_del': {'is_add': 1, },
89 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
90 'ipip_add_tunnel': {'is_ipv6': 1, 'instance': 4294967295, },
91 'ipsec_interface_add_del_spd': {'is_add': 1, },
92 'ipsec_sad_entry_add_del': {'is_add': 1, },
93 'ipsec_spd_add_del': {'is_add': 1, },
94 'ipsec_spd_dump': {'sa_id': 4294967295, },
95 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
96 'remote_port_stop': 65535, 'priority': 100,
99 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
100 'l2_emulation': {'enable': 1, },
101 'l2fib_add_del': {'is_add': 1, },
102 'lb_conf': {'sticky_buckets_per_core': 4294967295,
103 'flow_timeout': 4294967295},
104 'lisp_add_del_adjacency': {'is_add': 1, },
105 'lisp_add_del_local_eid': {'is_add': 1, },
106 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
107 'lisp_add_del_locator_set': {'is_add': 1, },
108 'lisp_add_del_remote_mapping': {'is_add': 1, },
109 'macip_acl_add_replace': {'acl_index': 4294967295, },
110 'macip_acl_dump': {'acl_index': 4294967295, },
111 'macip_acl_interface_add_del': {'is_add': 1, },
112 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
113 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
114 'mr_next_hop_weight': 1,
115 'mr_next_hop_via_label': 1048576,
117 'mr_classify_table_index': 4294967295, },
118 'mpls_table_add_del': {'is_add': 1, },
119 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
120 'next_hop_weight': 1,
121 'next_hop_via_label': 1048576,
123 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
124 'output_acl_set_interface': {'ip4_table_index': 4294967295,
125 'ip6_table_index': 4294967295,
126 'l2_table_index': 4294967295, },
127 'pppoe_add_del_session': {'is_add': 1, },
128 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
129 'proxy_arp_add_del': {'is_add': 1, },
130 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
131 'punt_socket_register': {'protocol': 17, 'header_version': 1,
133 'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, },
134 'punt_socket_dump': {'is_ip6': 1, },
135 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
137 'set_ipfix_exporter': {'collector_port': 4739, },
138 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
139 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
140 'svs_enable_disable': {'is_enable': 1, },
141 'svs_route_add_del': {'is_add': 1, },
142 'svs_table_add_del': {'is_add': 1, },
143 'sw_interface_add_del_address': {'is_add': 1, },
144 'sw_interface_dump': {'sw_if_index': 4294967295, },
145 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
146 'pref_lifetime': 4294967295, },
147 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
148 'sw_interface_set_l2_bridge': {'enable': 1, },
149 'sw_interface_set_mpls_enable': {'enable': 1, },
150 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
151 'sw_interface_set_unnumbered': {'is_add': 1, },
152 'sw_interface_span_enable_disable': {'state': 1, },
153 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
154 'decap_next_index': 4294967295,
155 'instance': 4294967295, },
156 'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
157 'instance': 4294967295, },
158 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
159 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
161 'want_bfd_events': {'enable_disable': 1, },
162 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
163 'want_dhcp6_reply_events': {'enable_disable': 1, },
164 'want_igmp_events': {'enable': 1, },
165 'want_interface_events': {'enable_disable': 1, },
166 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
167 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
168 'want_ip6_ra_events': {'enable_disable': 1, },
169 'want_l2_macs_events': {'enable_disable': 1, },
173 class CliFailedCommandError(Exception):
174 """ cli command failed."""
177 class CliSyntaxError(Exception):
178 """ cli command had a syntax error."""
181 class UnexpectedApiReturnValueError(Exception):
182 """ exception raised when the API return value is unexpected """
186 class VppPapiProvider(object):
187 """VPP-api provider using vpp-papi
189 @property hook: hook object providing before and after api/cli hooks
192 _zero, _negative = range(2)
194 def __init__(self, name, shm_prefix, test_class, read_timeout):
195 self.hook = Hook(test_class)
197 self.shm_prefix = shm_prefix
198 self.test_class = test_class
199 self._expect_api_retval = self._zero
200 self._expect_stack = []
202 # install_dir is a class attribute. We need to set it before
203 # calling the constructor.
204 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
208 if os.environ['SOCKET'] == '1':
213 self.vpp = VPPApiClient(logger=test_class.logger,
214 read_timeout=read_timeout,
215 use_socket=use_socket,
216 server_address=test_class.api_sock)
217 self._events = deque()
222 def assert_negative_api_retval(self):
223 """ Expect API failure - used with with, e.g.:
224 with self.vapi.assert_negative_api_retval():
225 self.vapi.<api call expected to fail>
227 self._expect_stack.append(self._expect_api_retval)
228 self._expect_api_retval = self._negative
231 def assert_zero_api_retval(self):
232 """ Expect API success - used with with, e.g.:
233 with self.vapi.assert_negative_api_retval():
234 self.vapi.<api call expected to succeed>
236 note: this is useful only inside another with block
237 as success is the default expected value
239 self._expect_stack.append(self._expect_api_retval)
240 self._expect_api_retval = self._zero
243 def __exit__(self, exc_type, exc_value, traceback):
244 self._expect_api_retval = self._expect_stack.pop()
246 def register_hook(self, hook):
247 """Replace hook registration with new hook
254 def collect_events(self):
255 """ Collect all events from the internal queue and clear the queue. """
257 self._events = deque()
260 def wait_for_event(self, timeout, name=None):
261 """ Wait for and return next event. """
263 self.test_class.logger.debug("Expecting event '%s' within %ss",
266 self.test_class.logger.debug("Expecting event within %ss",
269 self.test_class.logger.debug("Not waiting, event already queued")
270 limit = time.time() + timeout
271 while time.time() < limit:
273 e = self._events.popleft()
274 if name and type(e).__name__ != name:
276 "Unexpected event received: %s, expected: %s" %
277 (type(e).__name__, name))
278 self.test_class.logger.debug("Returning event %s:%s" %
281 self.test_class.sleep(0) # yield
282 raise Exception("Event did not occur within timeout")
284 def __call__(self, name, event):
285 """ Enqueue event in the internal event queue. """
286 # FIXME use the name instead of relying on type(e).__name__ ?
287 # FIXME #2 if this throws, it is eaten silently, Ole?
288 self.test_class.logger.debug("New event: %s: %s" % (name, event))
289 self._events.append(event)
291 def factory(self, name, apifn):
293 fields = apifn._func.msg.fields
295 # add positional and kw arguments
297 for i, o in enumerate(fields[3:]):
304 if name in defaultmapping:
305 for k, v in iteritems(defaultmapping[name]):
309 return self.api(apifn, d)
313 def __getattribute__(self, name):
315 method = super(VppPapiProvider, self).__getattribute__(name)
316 except AttributeError:
317 method = self.factory(name, getattr(self.papi, name))
318 # lazily load the method so we don't need to call factory
319 # again for this name.
320 setattr(self, name, method)
324 """Connect the API to VPP"""
325 self.vpp.connect(self.name, self.shm_prefix)
326 self.papi = self.vpp.api
327 self.vpp.register_event_callback(self)
329 def disconnect(self):
330 """Disconnect the API from VPP"""
331 self.vpp.disconnect()
333 def api(self, api_fn, api_args, expected_retval=0):
334 """ Call API function and check it's return value.
335 Call the appropriate hooks before and after the API call
337 :param api_fn: API function to call
338 :param api_args: tuple of API function arguments
339 :param expected_retval: Expected return value (Default value = 0)
340 :returns: reply from the API
343 self.hook.before_api(api_fn.__name__, api_args)
344 reply = api_fn(**api_args)
345 if self._expect_api_retval == self._negative:
346 if hasattr(reply, 'retval') and reply.retval >= 0:
347 msg = "API call passed unexpectedly: expected negative " \
348 "return value instead of %d in %s" % \
349 (reply.retval, moves.reprlib.repr(reply))
350 self.test_class.logger.info(msg)
351 raise UnexpectedApiReturnValueError(msg)
352 elif self._expect_api_retval == self._zero:
353 if hasattr(reply, 'retval') and reply.retval != expected_retval:
354 msg = "API call failed, expected %d return value instead " \
355 "of %d in %s" % (expected_retval, reply.retval,
356 moves.reprlib.repr(reply))
357 self.test_class.logger.info(msg)
358 raise UnexpectedApiReturnValueError(msg)
360 raise Exception("Internal error, unexpected value for "
361 "self._expect_api_retval %s" %
362 self._expect_api_retval)
363 self.hook.after_api(api_fn.__name__, api_args)
367 """ Execute a CLI, calling the before/after hooks appropriately.
369 :param cli: CLI to execute
373 self.hook.before_cli(cli)
375 r = self.papi.cli_inband(cmd=cli)
376 self.hook.after_cli(cli)
378 raise CliSyntaxError(r.reply)
380 raise CliFailedCommandError(r.reply)
381 if hasattr(r, 'reply'):
384 def ppcli(self, cli):
385 """ Helper method to print CLI command in case of info logging level.
387 :param cli: CLI to execute
390 return cli + "\n" + str(self.cli(cli))
392 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
393 return self.api(self.papi.want_ip4_arp_events,
394 {'enable_disable': enable_disable,
396 'pid': os.getpid(), })
398 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
399 return self.api(self.papi.want_ip6_nd_events,
400 {'enable_disable': enable_disable,
402 'pid': os.getpid(), })
404 def want_ip6_ra_events(self, enable_disable=1):
405 return self.api(self.papi.want_ip6_ra_events,
406 {'enable_disable': enable_disable,
407 'pid': os.getpid(), })
409 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
411 return self.api(self.papi.ip6nd_send_router_solicitation,
416 'sw_if_index': sw_if_index})
418 def want_interface_events(self, enable_disable=1):
419 return self.api(self.papi.want_interface_events,
420 {'enable_disable': enable_disable,
421 'pid': os.getpid(), })
423 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
424 max_macs_in_event=0, learn_limit=0):
425 return self.api(self.papi.want_l2_macs_events,
426 {'enable_disable': enable_disable,
427 'scan_delay': scan_delay,
428 'max_macs_in_event': max_macs_in_event,
429 'learn_limit': learn_limit,
430 'pid': os.getpid(), })
432 def want_dhcp6_reply_events(self, enable_disable=1):
433 return self.api(self.papi.want_dhcp6_reply_events,
434 {'enable_disable': enable_disable,
437 def want_dhcp6_pd_reply_events(self, enable_disable=1):
438 return self.api(self.papi.want_dhcp6_pd_reply_events,
439 {'enable_disable': enable_disable,
442 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
443 prefixes, server_index=0xFFFFFFFF,
444 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
446 return self.api(self.papi.dhcp6_pd_send_client_message,
447 {'sw_if_index': sw_if_index,
448 'server_index': server_index,
454 'msg_type': msg_type,
457 'n_prefixes': len(prefixes),
458 'prefixes': prefixes})
460 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
462 return self.api(self.papi.dhcp6_client_enable_disable,
463 {'sw_if_index': sw_if_index,
466 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
468 return self.api(self.papi.dhcp6_pd_client_enable_disable,
469 {'sw_if_index': sw_if_index,
470 'prefix_group': prefix_group,
473 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
474 prefix_length, prefix_group,
476 return self.api(self.papi.ip6_add_del_address_using_prefix,
477 {'sw_if_index': sw_if_index,
478 'prefix_group': prefix_group,
480 'prefix_length': prefix_length,
483 def sw_interface_set_mac_address(self, sw_if_index, mac):
484 return self.api(self.papi.sw_interface_set_mac_address,
485 {'sw_if_index': sw_if_index,
488 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
489 """Create p2p ethernet subinterface
491 :param sw_if_index: main (parent) interface
492 :param remote_mac: client (remote) mac address
496 self.papi.p2p_ethernet_add,
497 {'parent_if_index': sw_if_index,
498 'remote_mac': remote_mac,
499 'subif_id': subif_id})
501 def p2p_ethernet_del(self, sw_if_index, remote_mac):
502 """Delete p2p ethernet subinterface
504 :param sw_if_index: main (parent) interface
505 :param remote_mac: client (remote) mac address
509 self.papi.p2p_ethernet_del,
510 {'parent_if_index': sw_if_index,
511 'remote_mac': remote_mac})
513 def create_vlan_subif(self, sw_if_index, vlan):
520 return self.api(self.papi.create_vlan_subif,
521 {'sw_if_index': sw_if_index,
524 def create_loopback(self, mac=''):
527 :param mac: (Optional)
529 return self.api(self.papi.create_loopback,
530 {'mac_address': mac})
532 def ip_neighbor_add_del(self,
538 """ Add neighbor MAC to IPv4 or IPv6 address.
543 :param is_add: (Default value = 1)
544 :param flags: (Default value = 0/NONE)
547 self.papi.ip_neighbor_add_del,
551 'sw_if_index': sw_if_index,
553 'mac_address': mac_address,
554 'ip_address': ip_address
559 def proxy_arp_add_del(self,
564 """ Config Proxy Arp Range.
566 :param low_address: Start address in the rnage to Proxy for
567 :param hi_address: End address in the rnage to Proxy for
568 :param vrf_id: The VRF/table in which to proxy
572 self.papi.proxy_arp_add_del,
575 'table_id': table_id,
581 def proxy_arp_intfc_enable_disable(self,
584 """ Enable/Disable an interface for proxy ARP requests
586 :param sw_if_index: Interface
587 :param enable_disable: Enable/Disable
591 self.papi.proxy_arp_intfc_enable_disable,
592 {'sw_if_index': sw_if_index,
593 'enable_disable': is_enable
597 def gre_tunnel_add_del(self,
609 :param outer_fib_id: (Default value = 0)
610 :param tunnel_type: (Default value = 0)
611 :param instance: (Default value = 0xFFFFFFFF)
612 :param session_id: (Default value = 0)
613 :param is_add: (Default value = 1)
614 :param is_ipv6: (Default value = 0)
618 self.papi.gre_tunnel_add_del,
623 'instance': instance,
626 'outer_fib_id': outer_fib_id,
627 'session_id': session_id}
631 def udp_encap_add(self,
642 :param outer_fib_id: (Default value = 0)
646 self.papi.udp_encap_add,
651 'src_port': src_port,
652 'dst_port': dst_port,
657 def mpls_table_add_del(
664 :param is_add: (Default value = 1)
669 self.papi.mpls_table_add_del,
670 {'mt_table_id': table_id,
671 'mt_is_add': is_add})
673 def mpls_ip_bind_unbind(
685 self.papi.mpls_ip_bind_unbind,
686 {'mb_mpls_table_id': table_id,
688 'mb_ip_table_id': ip_table_id,
689 'mb_is_bind': is_bind,
691 'mb_address_length': dst_address_length,
692 'mb_address': dst_address})
694 def mpls_tunnel_add_del(
697 next_hop_proto_is_ip4,
699 next_hop_sw_if_index=0xFFFFFFFF,
702 next_hop_n_out_labels=0,
703 next_hop_out_label_stack=[],
704 next_hop_via_label=MPLS_LABEL_INVALID,
710 :param dst_address_length:
711 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
713 :param next_hop_address:
714 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
715 :param vrf_id: (Default value = 0)
716 :param lookup_in_vrf: (Default value = 0)
717 :param classify_table_index: (Default value = 0xFFFFFFFF)
718 :param is_add: (Default value = 1)
719 :param is_drop: (Default value = 0)
720 :param is_ipv6: (Default value = 0)
721 :param is_local: (Default value = 0)
722 :param is_classify: (Default value = 0)
723 :param is_multipath: (Default value = 0)
724 :param is_resolve_host: (Default value = 0)
725 :param is_resolve_attached: (Default value = 0)
726 :param next_hop_weight: (Default value = 1)
727 :param is_multicast: (Default value = 0)
731 self.papi.mpls_tunnel_add_del,
732 {'mt_sw_if_index': tun_sw_if_index,
734 'mt_l2_only': l2_only,
735 'mt_is_multicast': is_multicast,
736 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
737 'mt_next_hop_weight': next_hop_weight,
738 'mt_next_hop': next_hop_address,
739 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
740 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
741 'mt_next_hop_table_id': next_hop_table_id,
742 'mt_next_hop_via_label': next_hop_via_label,
743 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
745 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
746 detect_mult, local_addr, peer_addr, is_ipv6=0,
747 bfd_key_id=None, conf_key_id=None):
748 if bfd_key_id is None:
749 return self.api(self.papi.bfd_udp_add,
751 'sw_if_index': sw_if_index,
752 'desired_min_tx': desired_min_tx,
753 'required_min_rx': required_min_rx,
754 'local_addr': local_addr,
755 'peer_addr': peer_addr,
757 'detect_mult': detect_mult,
760 return self.api(self.papi.bfd_udp_add,
762 'sw_if_index': sw_if_index,
763 'desired_min_tx': desired_min_tx,
764 'required_min_rx': required_min_rx,
765 'local_addr': local_addr,
766 'peer_addr': peer_addr,
768 'detect_mult': detect_mult,
769 'is_authenticated': 1,
770 'bfd_key_id': bfd_key_id,
771 'conf_key_id': conf_key_id,
774 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
775 detect_mult, local_addr, peer_addr, is_ipv6=0):
776 return self.api(self.papi.bfd_udp_mod,
778 'sw_if_index': sw_if_index,
779 'desired_min_tx': desired_min_tx,
780 'required_min_rx': required_min_rx,
781 'local_addr': local_addr,
782 'peer_addr': peer_addr,
784 'detect_mult': detect_mult,
787 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
788 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
790 return self.api(self.papi.bfd_udp_auth_activate,
792 'sw_if_index': sw_if_index,
793 'local_addr': local_addr,
794 'peer_addr': peer_addr,
796 'is_delayed': 1 if is_delayed else 0,
797 'bfd_key_id': bfd_key_id,
798 'conf_key_id': conf_key_id,
801 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
802 peer_addr, is_ipv6=0):
803 return self.api(self.papi.bfd_udp_session_set_flags, {
804 'admin_up_down': admin_up_down,
805 'sw_if_index': sw_if_index,
806 'local_addr': local_addr,
807 'peer_addr': peer_addr,
811 def want_bfd_events(self, enable_disable=1):
812 return self.api(self.papi.want_bfd_events, {
813 'enable_disable': enable_disable,
817 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
818 return self.api(self.papi.bfd_auth_set_key, {
819 'conf_key_id': conf_key_id,
820 'auth_type': auth_type,
825 def classify_add_del_table(
830 table_index=0xFFFFFFFF,
834 next_table_index=0xFFFFFFFF,
835 miss_next_index=0xFFFFFFFF,
837 current_data_offset=0):
841 :param match_n_vectors: (Default value = 1)
842 :param table_index: (Default value = 0xFFFFFFFF)
843 :param nbuckets: (Default value = 2)
844 :param memory_size: (Default value = 2097152)
845 :param skip_n_vectors: (Default value = 0)
846 :param next_table_index: (Default value = 0xFFFFFFFF)
847 :param miss_next_index: (Default value = 0xFFFFFFFF)
848 :param current_data_flag: (Default value = 0)
849 :param current_data_offset: (Default value = 0)
852 mask_len = ((len(mask) - 1) / 16 + 1) * 16
853 mask = mask + '\0' * (mask_len - len(mask))
855 self.papi.classify_add_del_table,
857 'table_index': table_index,
858 'nbuckets': nbuckets,
859 'memory_size': memory_size,
860 'skip_n_vectors': skip_n_vectors,
861 'match_n_vectors': match_n_vectors,
862 'next_table_index': next_table_index,
863 'miss_next_index': miss_next_index,
864 'current_data_flag': current_data_flag,
865 'current_data_offset': current_data_offset,
866 'mask_len': mask_len,
869 def classify_add_del_session(
874 opaque_index=0xFFFFFFFF,
875 hit_next_index=0xFFFFFFFF,
883 :param opaque_index: (Default value = 0xFFFFFFFF)
884 :param hit_next_index: (Default value = 0xFFFFFFFF)
885 :param advance: (Default value = 0)
886 :param action: (Default value = 0)
887 :param metadata: (Default value = 0)
890 match_len = ((len(match) - 1) / 16 + 1) * 16
891 match = match + '\0' * (match_len - len(match))
893 self.papi.classify_add_del_session,
895 'table_index': table_index,
896 'hit_next_index': hit_next_index,
897 'opaque_index': opaque_index,
900 'metadata': metadata,
901 'match_len': match_len,
904 def input_acl_set_interface(
908 ip4_table_index=0xFFFFFFFF,
909 ip6_table_index=0xFFFFFFFF,
910 l2_table_index=0xFFFFFFFF):
914 :param ip4_table_index: (Default value = 0xFFFFFFFF)
915 :param ip6_table_index: (Default value = 0xFFFFFFFF)
916 :param l2_table_index: (Default value = 0xFFFFFFFF)
920 self.papi.input_acl_set_interface,
921 {'sw_if_index': sw_if_index,
922 'ip4_table_index': ip4_table_index,
923 'ip6_table_index': ip6_table_index,
924 'l2_table_index': l2_table_index,
927 def output_acl_set_interface(
931 ip4_table_index=0xFFFFFFFF,
932 ip6_table_index=0xFFFFFFFF,
933 l2_table_index=0xFFFFFFFF):
937 :param ip4_table_index: (Default value = 0xFFFFFFFF)
938 :param ip6_table_index: (Default value = 0xFFFFFFFF)
939 :param l2_table_index: (Default value = 0xFFFFFFFF)
943 self.papi.output_acl_set_interface,
944 {'sw_if_index': sw_if_index,
945 'ip4_table_index': ip4_table_index,
946 'ip6_table_index': ip6_table_index,
947 'l2_table_index': l2_table_index,
950 def set_ipfix_exporter(
960 self.papi.set_ipfix_exporter,
962 'collector_address': collector_address,
963 'collector_port': collector_port,
964 'src_address': src_address,
966 'path_mtu': path_mtu,
967 'template_interval': template_interval,
968 'udp_checksum': udp_checksum,
971 def dhcp_proxy_config(self,
979 self.papi.dhcp_proxy_config,
981 'rx_vrf_id': rx_table_id,
982 'server_vrf_id': server_table_id,
985 'dhcp_server': dhcp_server,
986 'dhcp_src_address': dhcp_src_address,
989 def dhcp_proxy_set_vss(self,
998 self.papi.dhcp_proxy_set_vss,
1001 'vss_type': vss_type,
1002 'vpn_ascii_id': vpn_ascii_id,
1004 'vpn_index': vpn_index,
1009 def dhcp_client_config(self,
1014 set_broadcast_flag=1,
1015 want_dhcp_events=0):
1017 self.papi.dhcp_client_config,
1021 'sw_if_index': sw_if_index,
1022 'hostname': hostname,
1024 'want_dhcp_event': want_dhcp_events,
1025 'set_broadcast_flag': set_broadcast_flag,
1029 def ip_mroute_add_del(self,
1035 next_hop_sw_if_index,
1045 IP Multicast Route add/del
1048 self.papi.ip_mroute_add_del,
1049 {'next_hop_sw_if_index': next_hop_sw_if_index,
1050 'entry_flags': e_flags,
1051 'itf_flags': i_flags,
1052 'table_id': table_id,
1056 'is_local': is_local,
1057 'bier_imp': bier_imp,
1058 'next_hop_afi': next_hop_afi,
1059 'grp_address_length': grp_address_length,
1060 'grp_address': grp_address,
1061 'src_address': src_address,
1062 'nh_address': next_hop_address})
1064 def lisp_enable_disable(self, is_enabled):
1066 self.papi.lisp_enable_disable,
1068 'is_en': is_enabled,
1071 def lisp_add_del_locator_set(self,
1075 self.papi.lisp_add_del_locator_set,
1078 'locator_set_name': ls_name
1081 def lisp_add_del_locator(self,
1088 self.papi.lisp_add_del_locator,
1091 'locator_set_name': ls_name,
1092 'sw_if_index': sw_if_index,
1093 'priority': priority,
1097 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1099 self.papi.lisp_locator_dump,
1101 'is_index_set': is_index_set,
1103 'ls_index': ls_index,
1106 def lisp_add_del_local_eid(self,
1116 self.papi.lisp_add_del_local_eid,
1118 'locator_set_name': ls_name,
1120 'eid_type': eid_type,
1122 'prefix_len': prefix_len,
1128 def lisp_eid_table_dump(self,
1136 self.papi.lisp_eid_table_dump,
1139 'prefix_length': prefix_length,
1141 'eid_type': eid_type,
1143 'filter': filter_opt,
1146 def lisp_add_del_remote_mapping(self,
1156 self.papi.lisp_add_del_remote_mapping,
1159 'eid_type': eid_type,
1161 'eid_len': eid_prefix_len,
1162 'rloc_num': rlocs_num,
1165 'is_src_dst': is_src_dst,
1168 def lisp_add_del_adjacency(self,
1177 self.papi.lisp_add_del_adjacency,
1181 'eid_type': eid_type,
1184 'leid_len': leid_len,
1185 'reid_len': reid_len,
1188 def gtpu_add_del_tunnel(
1194 mcast_sw_if_index=0xFFFFFFFF,
1196 decap_next_index=0xFFFFFFFF,
1200 :param is_add: (Default value = 1)
1201 :param is_ipv6: (Default value = 0)
1204 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1205 :param encap_vrf_id: (Default value = 0)
1206 :param decap_next_index: (Default value = 0xFFFFFFFF)
1207 :param teid: (Default value = 0)
1210 return self.api(self.papi.gtpu_add_del_tunnel,
1213 'src_address': src_addr,
1214 'dst_address': dst_addr,
1215 'mcast_sw_if_index': mcast_sw_if_index,
1216 'encap_vrf_id': encap_vrf_id,
1217 'decap_next_index': decap_next_index,
1220 def vxlan_gpe_add_del_tunnel(
1224 mcast_sw_if_index=0xFFFFFFFF,
1235 :param is_add: (Default value = 1)
1236 :param is_ipv6: (Default value = 0)
1237 :param encap_vrf_id: (Default value = 0)
1238 :param decap_vrf_id: (Default value = 0)
1239 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1240 :param protocol: (Default value = 3)
1241 :param vni: (Default value = 0)
1244 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1249 'mcast_sw_if_index': mcast_sw_if_index,
1250 'encap_vrf_id': encap_vrf_id,
1251 'decap_vrf_id': decap_vrf_id,
1252 'protocol': protocol,
1255 def vxlan_gbp_tunnel_add_del(
1259 mcast_sw_if_index=0xFFFFFFFF,
1265 instance=0xFFFFFFFF):
1270 :param is_add: (Default value = 1)
1271 :param is_ipv6: (Default value = 0)
1272 :param encap_table_id: (Default value = 0)
1273 :param decap_next_index: (Default value = 0xFFFFFFFF)
1274 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1275 :param vni: (Default value = 0)
1276 :param instance: (Default value = 0xFFFFFFFF)
1279 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
1284 'mcast_sw_if_index': mcast_sw_if_index,
1285 'encap_table_id': encap_table_id,
1287 'instance': instance,
1290 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1291 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1292 {'sw_if_index': sw_if_index,
1293 '_no_type_conversion': True})
1295 def pppoe_add_del_session(
1305 :param is_add: (Default value = 1)
1306 :param is_ipv6: (Default value = 0)
1308 :param session_id: (Default value = 0)
1310 :param decap_vrf_id: (Default value = 0)
1313 return self.api(self.papi.pppoe_add_del_session,
1316 'session_id': session_id,
1317 'client_ip': client_ip,
1318 'decap_vrf_id': decap_vrf_id,
1319 'client_mac': client_mac})
1321 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1322 return self.api(self.papi.sr_mpls_policy_add,
1326 'n_segments': len(segments),
1327 'segments': segments})
1329 def sr_mpls_policy_del(self, bsid):
1330 return self.api(self.papi.sr_mpls_policy_del,
1333 def sr_localsid_add_del(self,
1340 sw_if_index=0xFFFFFFFF,
1344 """ Add/del IPv6 SR local-SID.
1347 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1348 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1351 :param is_del: (Default value = 0)
1352 :param end_psp: (Default value = 0)
1353 :param sw_if_index: (Default value = 0xFFFFFFFF)
1354 :param vlan_index: (Default value = 0)
1355 :param fib_table: (Default value = 0)
1358 self.papi.sr_localsid_add_del,
1360 'localsid': localsid,
1362 'behavior': behavior,
1363 'sw_if_index': sw_if_index,
1364 'vlan_index': vlan_index,
1365 'fib_table': fib_table,
1366 'nh_addr4': nh_addr4,
1367 'nh_addr6': nh_addr6
1381 :param bsid_addr: bindingSID of the SR Policy
1382 :param weight: weight of the sid list. optional. (default: 1)
1383 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1385 :param type: type/behavior of the SR policy. (default or spray) \
1387 :param fib_table: VRF where to install the FIB entry for the BSID \
1389 :param n_segments: number of segments \
1391 :param segments: a vector of IPv6 address composing the segment list \
1395 self.papi.sr_policy_add,
1396 {'bsid_addr': bsid_addr,
1398 'is_encap': is_encap,
1400 'fib_table': fib_table,
1401 'n_segments': n_segments,
1402 'segments': segments
1411 :param bsid: bindingSID of the SR Policy
1412 :param sr_policy_index: index of the sr policy (default: 0)
1415 self.papi.sr_policy_del,
1416 {'bsid_addr': bsid_addr,
1417 'sr_policy_index': sr_policy_index
1420 def sr_steering_add_del(
1431 Steer traffic L2 and L3 traffic through a given SR policy
1433 :param is_del: delete or add
1434 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1435 :param sr_policy: is the index of the SR Policy (alt to bsid)
1436 :param table_id: is the VRF where to install the FIB entry for the BSID
1437 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1438 :param mask_width: is the mask for L3 traffic type
1439 :param sw_if_index: is the incoming interface for L2 traffic
1440 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1443 self.papi.sr_steering_add_del,
1445 'bsid_addr': bsid_addr,
1446 'sr_policy_index': sr_policy_index,
1447 'table_id': table_id,
1448 'prefix_addr': prefix_addr,
1449 'mask_width': mask_width,
1450 'sw_if_index': sw_if_index,
1451 'traffic_type': traffic_type
1454 def acl_add_replace(self, acl_index, r, tag='',
1456 """Add/replace an ACL
1457 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1458 :param acl_rule r: ACL rules array.
1459 :param str tag: symbolic tag (description) for this ACL.
1460 :param int count: number of rules.
1462 return self.api(self.papi.acl_add_replace,
1463 {'acl_index': acl_index,
1467 expected_retval=expected_retval)
1469 def acl_del(self, acl_index, expected_retval=0):
1475 return self.api(self.papi.acl_del,
1476 {'acl_index': acl_index},
1477 expected_retval=expected_retval)
1479 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1481 return self.api(self.papi.acl_interface_set_acl_list,
1482 {'sw_if_index': sw_if_index,
1486 expected_retval=expected_retval)
1488 def acl_interface_set_etype_whitelist(self, sw_if_index,
1491 return self.api(self.papi.acl_interface_set_etype_whitelist,
1492 {'sw_if_index': sw_if_index,
1493 'count': len(whitelist),
1495 'whitelist': whitelist},
1496 expected_retval=expected_retval)
1498 def acl_interface_add_del(self,
1502 """ Add/Delete ACL to/from interface
1506 :param is_add: (Default value = 1)
1509 return self.api(self.papi.acl_interface_add_del,
1512 'sw_if_index': sw_if_index,
1513 'acl_index': acl_index})
1515 def acl_dump(self, acl_index, expected_retval=0):
1516 return self.api(self.papi.acl_dump,
1517 {'acl_index': acl_index},
1518 expected_retval=expected_retval)
1520 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1522 return self.api(self.papi.acl_interface_list_dump,
1523 {'sw_if_index': sw_if_index},
1524 expected_retval=expected_retval)
1526 def macip_acl_add(self, rules, tag=""):
1529 :param rules: list of rules for given acl
1533 return self.api(self.papi.macip_acl_add,
1535 'count': len(rules),
1538 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1541 :param rules: list of rules for given acl
1545 return self.api(self.papi.macip_acl_add_replace,
1546 {'acl_index': acl_index,
1548 'count': len(rules),
1551 def macip_acl_interface_add_del(self,
1555 """ Add MACIP acl to interface
1559 :param is_add: (Default value = 1)
1562 return self.api(self.papi.macip_acl_interface_add_del,
1564 'sw_if_index': sw_if_index,
1565 'acl_index': acl_index})
1567 def macip_acl_dump(self, acl_index=4294967295):
1568 """ Return MACIP acl dump
1572 self.papi.macip_acl_dump, {'acl_index': acl_index})
1574 def policer_add_del(self,
1585 conform_action_type=1,
1587 exceed_action_type=0,
1589 violate_action_type=0,
1591 return self.api(self.papi.policer_add_del,
1598 'rate_type': rate_type,
1599 'round_type': round_type,
1601 'color_aware': color_aware,
1602 'conform_action_type': conform_action_type,
1603 'conform_dscp': conform_dscp,
1604 'exceed_action_type': exceed_action_type,
1605 'exceed_dscp': exceed_dscp,
1606 'violate_action_type': violate_action_type,
1607 'violate_dscp': violate_dscp})
1609 def ip_punt_police(self,
1613 return self.api(self.papi.ip_punt_police,
1614 {'policer_index': policer_index,
1618 def ip_punt_redirect(self,
1623 return self.api(self.papi.ip_punt_redirect,
1624 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1625 'tx_sw_if_index': tx_sw_if_index,
1629 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1630 return self.api(self.papi.ip_punt_redirect_dump,
1631 {'sw_if_index': sw_if_index,
1632 'is_ipv6': is_ipv6})
1634 def bier_table_add_del(self,
1638 """ BIER Table add/del """
1640 self.papi.bier_table_add_del,
1641 {'bt_tbl_id': {"bt_set": bti.set_id,
1642 "bt_sub_domain": bti.sub_domain_id,
1643 "bt_hdr_len_id": bti.hdr_len_id},
1644 'bt_label': mpls_label,
1645 'bt_is_add': is_add})
1647 def bier_table_dump(self):
1648 return self.api(self.papi.bier_table_dump, {})
1650 def bier_route_add_del(self,
1656 """ BIER Route add/del """
1658 self.papi.bier_route_add_del,
1659 {'br_tbl_id': {"bt_set": bti.set_id,
1660 "bt_sub_domain": bti.sub_domain_id,
1661 "bt_hdr_len_id": bti.hdr_len_id},
1663 'br_n_paths': len(paths),
1665 'br_is_add': is_add,
1666 'br_is_replace': is_replace})
1668 def bier_route_dump(self, bti):
1670 self.papi.bier_route_dump,
1671 {'br_tbl_id': {"bt_set": bti.set_id,
1672 "bt_sub_domain": bti.sub_domain_id,
1673 "bt_hdr_len_id": bti.hdr_len_id}})
1675 def bier_imp_add(self,
1680 """ BIER Imposition Add """
1682 self.papi.bier_imp_add,
1683 {'bi_tbl_id': {"bt_set": bti.set_id,
1684 "bt_sub_domain": bti.sub_domain_id,
1685 "bt_hdr_len_id": bti.hdr_len_id},
1687 'bi_n_bytes': len(ibytes),
1688 'bi_bytes': ibytes})
1690 def bier_imp_del(self, bi_index):
1691 """ BIER Imposition del """
1693 self.papi.bier_imp_del,
1694 {'bi_index': bi_index})
1696 def bier_imp_dump(self):
1697 return self.api(self.papi.bier_imp_dump, {})
1699 def bier_disp_table_add_del(self,
1702 """ BIER Disposition Table add/del """
1704 self.papi.bier_disp_table_add_del,
1705 {'bdt_tbl_id': bdti,
1706 'bdt_is_add': is_add})
1708 def bier_disp_table_dump(self):
1709 return self.api(self.papi.bier_disp_table_dump, {})
1711 def bier_disp_entry_add_del(self,
1721 """ BIER Route add/del """
1723 while (len(lstack) < 16):
1726 self.papi.bier_disp_entry_add_del,
1727 {'bde_tbl_id': bdti,
1729 'bde_payload_proto': payload_proto,
1731 'bde_paths': [{'next_hop': next_hop,
1732 'table_id': next_hop_tbl_id,
1733 'afi': next_hop_afi,
1734 'rpf_id': next_hop_rpf_id,
1736 'label_stack': lstack}],
1737 'bde_is_add': is_add})
1739 def bier_disp_entry_dump(self, bdti):
1741 self.papi.bier_disp_entry_dump,
1742 {'bde_tbl_id': bdti})
1744 def session_enable_disable(self, is_enabled):
1746 self.papi.session_enable_disable,
1747 {'is_enable': is_enabled})
1749 def ipsec_spd_add_del(self, spd_id, is_add=1):
1750 """ SPD add/del - Wrapper to add or del ipsec SPD
1751 Sample CLI : 'ipsec spd add 1'
1753 :param spd_id - SPD ID to be created in the vpp . mandatory
1754 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1756 :returns: reply from the API
1759 self.papi.ipsec_spd_add_del, {
1760 'spd_id': spd_id, 'is_add': is_add})
1762 def ipsec_spds_dump(self):
1763 return self.api(self.papi.ipsec_spds_dump, {})
1765 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1766 """ IPSEC interface SPD add/del - \
1767 Wrapper to associate/disassociate SPD to interface in VPP
1768 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1770 :param spd_id - SPD ID to associate with the interface . mandatory
1771 :param sw_if_index - Interface Index which needs to ipsec \
1772 association mandatory
1773 :param is_add - add(1) or del(0) association with interface \
1774 (Default 1 - add) . optional
1775 :returns: reply from the API
1778 self.papi.ipsec_interface_add_del_spd,
1779 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1781 def ipsec_spd_interface_dump(self, spd_index=None):
1782 return self.api(self.papi.ipsec_spd_interface_dump,
1783 {'spd_index': spd_index if spd_index else 0,
1784 'spd_index_valid': 1 if spd_index else 0})
1786 def ipsec_sad_entry_add_del(self,
1789 integrity_algorithm,
1794 tunnel_src_address='',
1795 tunnel_dst_address='',
1799 """ IPSEC SA add/del
1800 :param sad_id: security association ID
1801 :param spi: security param index of the SA in decimal
1802 :param integrity_algorithm:
1803 :param integrity_key:
1804 :param crypto_algorithm:
1806 :param protocol: AH(0) or ESP(1) protocol
1807 :param tunnel_src_address: tunnel mode outer src address
1808 :param tunnel_dst_address: tunnel mode outer dst address
1811 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1812 crypto and ipsec algorithms
1815 self.papi.ipsec_sad_entry_add_del,
1822 'tunnel_src': tunnel_src_address,
1823 'tunnel_dst': tunnel_dst_address,
1824 'protocol': protocol,
1825 'integrity_algorithm': integrity_algorithm,
1827 'length': len(integrity_key),
1828 'data': integrity_key,
1830 'crypto_algorithm': crypto_algorithm,
1832 'length': len(crypto_key),
1840 def ipsec_sa_dump(self, sa_id=None):
1841 return self.api(self.papi.ipsec_sa_dump,
1842 {'sa_id': sa_id if sa_id else 0xffffffff})
1844 def ipsec_spd_entry_add_del(self,
1847 local_address_start,
1849 remote_address_start,
1850 remote_address_stop,
1852 local_port_stop=65535,
1853 remote_port_start=0,
1854 remote_port_stop=65535,
1862 """ IPSEC policy SPD add/del -
1863 Wrapper to configure ipsec SPD policy entries in VPP
1864 :param spd_id: SPD ID for the policy
1865 :param local_address_start: local-ip-range start address
1866 :param local_address_stop : local-ip-range stop address
1867 :param remote_address_start: remote-ip-range start address
1868 :param remote_address_stop : remote-ip-range stop address
1869 :param local_port_start: (Default value = 0)
1870 :param local_port_stop: (Default value = 65535)
1871 :param remote_port_start: (Default value = 0)
1872 :param remote_port_stop: (Default value = 65535)
1873 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1874 :param sa_id: Security Association ID for mapping it to SPD
1875 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1877 :param priority: value for the spd action (Default value = 100)
1878 :param is_outbound: flag for inbound(0) or outbound(1)
1880 :param is_add: (Default value = 1)
1883 self.papi.ipsec_spd_entry_add_del,
1890 'local_address_start': local_address_start,
1891 'local_address_stop': local_address_stop,
1892 'remote_address_start': remote_address_start,
1893 'remote_address_stop': remote_address_stop,
1894 'local_port_start': local_port_start,
1895 'local_port_stop': local_port_stop,
1896 'remote_port_start': remote_port_start,
1897 'remote_port_stop': remote_port_stop,
1898 'protocol': protocol,
1900 'priority': priority,
1901 'is_outbound': is_outbound,
1902 'is_ip_any': is_ip_any
1906 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1907 return self.api(self.papi.ipsec_spd_dump,
1911 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1912 remote_spi, crypto_alg, local_crypto_key,
1913 remote_crypto_key, integ_alg, local_integ_key,
1914 remote_integ_key, is_add=1, esn=0, salt=0,
1915 anti_replay=1, renumber=0, show_instance=0):
1917 self.papi.ipsec_tunnel_if_add_del,
1919 'local_ip': local_ip,
1920 'remote_ip': remote_ip,
1921 'local_spi': local_spi,
1922 'remote_spi': remote_spi,
1923 'crypto_alg': crypto_alg,
1924 'local_crypto_key_len': len(local_crypto_key),
1925 'local_crypto_key': local_crypto_key,
1926 'remote_crypto_key_len': len(remote_crypto_key),
1927 'remote_crypto_key': remote_crypto_key,
1928 'integ_alg': integ_alg,
1929 'local_integ_key_len': len(local_integ_key),
1930 'local_integ_key': local_integ_key,
1931 'remote_integ_key_len': len(remote_integ_key),
1932 'remote_integ_key': remote_integ_key,
1935 'anti_replay': anti_replay,
1936 'renumber': renumber,
1937 'show_instance': show_instance,
1941 def ipsec_gre_tunnel_add_del(self, local_ip, remote_ip,
1942 sa_out, sa_in, is_add=1):
1943 return self.api(self.papi.ipsec_gre_tunnel_add_del,
1949 'local_sa_id': sa_out,
1950 'remote_sa_id': sa_in
1954 def ipsec_select_backend(self, protocol, index):
1955 return self.api(self.papi.ipsec_select_backend,
1956 {'protocol': protocol, 'index': index})
1958 def ipsec_backend_dump(self):
1959 return self.api(self.papi.ipsec_backend_dump, {})
1961 def app_namespace_add_del(self,
1965 sw_if_index=0xFFFFFFFF,
1968 self.papi.app_namespace_add_del,
1970 'sw_if_index': sw_if_index,
1971 'ip4_fib_id': ip4_fib_id,
1972 'ip6_fib_id': ip6_fib_id,
1973 'namespace_id': namespace_id,
1974 'namespace_id_len': len(namespace_id)})
1976 def punt_socket_register(self, port, pathname, protocol=0x11,
1977 header_version=1, is_ip4=1):
1978 """ Register punt socket """
1979 return self.api(self.papi.punt_socket_register,
1980 {'header_version': header_version,
1981 'punt': {'ipv': is_ip4,
1982 'l4_protocol': protocol,
1984 'pathname': pathname})
1986 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
1987 """ Unregister punt socket """
1988 return self.api(self.papi.punt_socket_deregister,
1989 {'punt': {'ipv': is_ip4,
1990 'l4_protocol': protocol,
1993 def punt_socket_dump(self, is_ip6=1):
1994 """ Dump punt socket"""
1995 return self.api(self.papi.punt_socket_dump,
1996 {'is_ipv6': is_ip6})
1998 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
2000 """ GBP endpoint Add """
2001 return self.api(self.papi.gbp_endpoint_add,
2003 'sw_if_index': sw_if_index,
2014 def gbp_endpoint_del(self, handle):
2015 """ GBP endpoint Del """
2016 return self.api(self.papi.gbp_endpoint_del,
2019 def gbp_endpoint_dump(self):
2020 """ GBP endpoint Dump """
2021 return self.api(self.papi.gbp_endpoint_dump,
2022 {'_no_type_conversion': True})
2024 def gbp_endpoint_group_add(self, vnid, sclass, bd,
2025 rd, uplink_sw_if_index,
2027 """ GBP endpoint group Add """
2028 return self.api(self.papi.gbp_endpoint_group_add,
2031 'uplink_sw_if_index': uplink_sw_if_index,
2036 'retention': retention
2039 def gbp_endpoint_group_del(self, sclass):
2040 """ GBP endpoint group Del """
2041 return self.api(self.papi.gbp_endpoint_group_del,
2044 def gbp_bridge_domain_add(self, bd_id, flags,
2047 bm_flood_sw_if_index):
2048 """ GBP bridge-domain Add """
2049 return self.api(self.papi.gbp_bridge_domain_add,
2053 'bvi_sw_if_index': bvi_sw_if_index,
2054 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2055 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2059 def gbp_bridge_domain_del(self, bd_id):
2060 """ GBP bridge-domain Del """
2061 return self.api(self.papi.gbp_bridge_domain_del,
2064 def gbp_route_domain_add(self, rd_id,
2068 ip6_uu_sw_if_index):
2069 """ GBP route-domain Add """
2070 return self.api(self.papi.gbp_route_domain_add,
2073 'ip4_table_id': ip4_table_id,
2074 'ip6_table_id': ip6_table_id,
2075 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2076 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2080 def gbp_route_domain_del(self, rd_id):
2081 """ GBP route-domain Del """
2082 return self.api(self.papi.gbp_route_domain_del,
2085 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2086 """ GBP recirc Add/Del """
2087 return self.api(self.papi.gbp_recirc_add_del,
2091 'sw_if_index': sw_if_index,
2094 def gbp_recirc_dump(self):
2095 """ GBP recirc Dump """
2096 return self.api(self.papi.gbp_recirc_dump, {})
2098 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2099 """ GBP recirc Add/Del """
2100 return self.api(self.papi.gbp_ext_itf_add_del,
2103 'sw_if_index': sw_if_index,
2107 def gbp_ext_itf_dump(self):
2108 """ GBP recirc Dump """
2109 return self.api(self.papi.gbp_ext_itf_dump, {})
2111 def gbp_subnet_add_del(self, is_add, rd_id,
2113 sw_if_index=0xffffffff,
2115 """ GBP Subnet Add/Del """
2116 return self.api(self.papi.gbp_subnet_add_del,
2120 'sw_if_index': sw_if_index,
2125 def gbp_subnet_dump(self):
2126 """ GBP Subnet Dump """
2127 return self.api(self.papi.gbp_subnet_dump,
2128 {'_no_type_conversion': True})
2130 def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2131 rules, allowed_ethertypes):
2132 """ GBP contract Add/Del """
2133 return self.api(self.papi.gbp_contract_add_del,
2136 'acl_index': acl_index,
2139 'n_rules': len(rules),
2141 'n_ether_types': len(allowed_ethertypes),
2142 'allowed_ethertypes': allowed_ethertypes}})
2144 def gbp_contract_dump(self):
2145 """ GBP contract Dump """
2146 return self.api(self.papi.gbp_contract_dump, {})
2148 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2149 """ GBP VXLAN tunnel add """
2150 return self.api(self.papi.gbp_vxlan_tunnel_add,
2155 'bd_rd_id': bd_rd_id,
2160 def gbp_vxlan_tunnel_del(self, vni):
2161 """ GBP VXLAN tunnel del """
2162 return self.api(self.papi.gbp_vxlan_tunnel_del,
2167 def gbp_vxlan_tunnel_dump(self):
2168 """ GBP VXLAN tunnel add/del """
2169 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2171 def qos_egress_map_update(self, id, outputs):
2172 """ QOS egress map update """
2173 return self.api(self.papi.qos_egress_map_update,
2177 def qos_egress_map_delete(self, id):
2178 """ QOS egress map delete """
2179 return self.api(self.papi.qos_egress_map_delete,
2182 def qos_mark_enable_disable(self, sw_if_index,
2186 """ QOS Mark Enable/Disable """
2187 return self.api(self.papi.qos_mark_enable_disable,
2189 'sw_if_index': sw_if_index,
2190 'output_source': output_source,
2193 def igmp_enable_disable(self, sw_if_index, enable, host):
2194 """ Enable/disable IGMP on a given interface """
2195 return self.api(self.papi.igmp_enable_disable,
2198 'sw_if_index': sw_if_index})
2200 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2201 """ Add/del IGMP proxy device """
2202 return self.api(self.papi.igmp_proxy_device_add_del,
2203 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2206 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2207 """ Add/del interface to/from IGMP proxy device """
2208 return self.api(self.papi.igmp_proxy_device_add_del_interface,
2209 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2212 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2213 """ Listen for new (S,G) on specified interface
2215 :param enable: add/del
2216 :param sw_if_index: interface sw index
2217 :param saddr: source ip4 addr
2218 :param gaddr: group ip4 addr
2220 return self.api(self.papi.igmp_listen,
2225 'sw_if_index': sw_if_index,
2226 'n_srcs': len(saddrs),
2232 def igmp_clear_interface(self, sw_if_index):
2233 """ Remove all (S,G)s from specified interface
2234 doesn't send IGMP report!
2237 self.papi.igmp_clear_interface, {
2238 'sw_if_index': sw_if_index})
2240 def want_igmp_events(self, enable=1):
2241 return self.api(self.papi.want_igmp_events, {'enable': enable,
2242 'pid': os.getpid()})
2250 interface_id=0xFFFFFFFF):
2253 :param lb: load balance
2254 :param use_custom_mac: use custom mac
2255 :param mac_address: mac address
2256 :param interface_id: custom interface ID
2259 self.papi.bond_create,
2262 'use_custom_mac': use_custom_mac,
2263 'mac_address': mac_address,
2267 def pipe_delete(self, parent_sw_if_index):
2268 return self.api(self.papi.pipe_delete,
2269 {'parent_sw_if_index': parent_sw_if_index})
2283 return self.api(self.papi.memif_create,
2286 'rx_queues': rx_queues,
2287 'tx_queues': tx_queues,
2289 'socket_id': socket_id,
2291 'ring_size': ring_size,
2292 'buffer_size': buffer_size,
2293 'hw_addr': hw_addr})
2295 def svs_table_add_del(self, af, table_id, is_add=1):
2296 return self.api(self.papi.svs_table_add_del,
2298 'table_id': table_id,
2303 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2304 return self.api(self.papi.svs_route_add_del,
2306 'table_id': table_id,
2307 'source_table_id': src_table_id,
2312 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2313 return self.api(self.papi.svs_enable_disable,
2316 'table_id': table_id,
2317 'sw_if_index': sw_if_index,
2318 'is_enable': is_enable,