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
19 # Dictionary keyed on message name to override default values for
23 'map_add_domain': {'mtu': 1280},
24 'syslog_set_sender': {'collector_port': 514,
26 'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
27 'acl_interface_list_dump': {'sw_if_index': 4294967295, },
28 'app_namespace_add_del': {'sw_if_index': 4294967295, },
29 'bd_ip_mac_add_del': {'is_add': 1, },
30 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
32 'bier_disp_table_add_del': {'is_add': 1, },
33 'bier_imp_add': {'is_add': 1, },
34 'bier_route_add_del': {'is_add': 1, },
35 'bier_table_add_del': {'is_add': 1, },
36 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
37 'learn': 1, 'is_add': 1, },
38 'bvi_create': {'user_instance': 4294967295, },
40 'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
41 'nbuckets': 2, 'memory_size': 2097152,
42 'next_table_index': 4294967295,
43 'miss_next_index': 4294967295, },
44 'dhcp6_client_enable_disable': {'enable': 1, },
45 'dhcp6_clients_enable_disable': {'enable': 1, },
46 'dhcp6_pd_client_enable_disable': {'enable': 1, },
47 'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
48 'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
49 'dhcp_proxy_config': {'is_add': 1, },
50 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
51 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
52 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
53 'decap_next_index': 4294967295, },
54 'gre_tunnel_add_del': {'instance': 4294967295, 'is_add': 1, },
55 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
56 'decap_next_index': 4294967295, },
57 'input_acl_set_interface': {'ip4_table_index': 4294967295,
58 'ip6_table_index': 4294967295,
59 'l2_table_index': 4294967295, },
60 'ip6_add_del_address_using_prefix': {'is_add': 1, },
61 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
62 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
63 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
64 'next_hop_id': 4294967295,
65 'classify_table_index': 4294967295, 'is_add': 1, },
66 'ip_mroute_add_del': {'is_add': 1, },
67 'ip_neighbor_add_del': {'is_add': 1, },
68 'ip_punt_police': {'is_add': 1, },
69 'ip_punt_redirect': {'is_add': 1, },
70 'ip_table_add_del': {'is_add': 1, },
71 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
72 'ipsec_interface_add_del_spd': {'is_add': 1, },
73 'ipsec_sad_entry_add_del': {'is_add': 1, },
74 'ipsec_spd_add_del': {'is_add': 1, },
75 'ipsec_spd_dump': {'sa_id': 4294967295, },
76 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
77 'remote_port_stop': 65535, 'priority': 100,
80 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
81 'l2_emulation': {'enable': 1, },
82 'l2fib_add_del': {'is_add': 1, },
83 'lb_conf': {'sticky_buckets_per_core': 4294967295,
84 'flow_timeout': 4294967295},
85 'lisp_add_del_adjacency': {'is_add': 1, },
86 'lisp_add_del_local_eid': {'is_add': 1, },
87 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
88 'lisp_add_del_locator_set': {'is_add': 1, },
89 'lisp_add_del_remote_mapping': {'is_add': 1, },
90 'macip_acl_add_replace': {'acl_index': 4294967295, },
91 'macip_acl_dump': {'acl_index': 4294967295, },
92 'macip_acl_interface_add_del': {'is_add': 1, },
93 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
94 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
95 'mr_next_hop_weight': 1,
96 'mr_next_hop_via_label': 1048576,
98 'mr_classify_table_index': 4294967295, },
99 'mpls_table_add_del': {'is_add': 1, },
100 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
101 'next_hop_weight': 1,
102 'next_hop_via_label': 1048576,
104 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
105 'output_acl_set_interface': {'ip4_table_index': 4294967295,
106 'ip6_table_index': 4294967295,
107 'l2_table_index': 4294967295, },
108 'pppoe_add_del_session': {'is_add': 1, },
109 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
110 'proxy_arp_add_del': {'is_add': 1, },
111 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
112 'punt_socket_register': {'protocol': 17, 'header_version': 1,
114 'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, },
115 'punt_socket_dump': {'is_ip6': 1, },
116 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
118 'set_ipfix_exporter': {'collector_port': 4739, },
119 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
120 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
121 'svs_enable_disable': {'is_enable': 1, },
122 'svs_route_add_del': {'is_add': 1, },
123 'svs_table_add_del': {'is_add': 1, },
124 'sw_interface_add_del_address': {'is_add': 1, },
125 'sw_interface_dump': {'sw_if_index': 4294967295, },
126 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
127 'pref_lifetime': 4294967295, },
128 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
129 'sw_interface_set_l2_bridge': {'enable': 1, },
130 'sw_interface_set_mpls_enable': {'enable': 1, },
131 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
132 'sw_interface_set_unnumbered': {'is_add': 1, },
133 'sw_interface_span_enable_disable': {'state': 1, },
134 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
135 'decap_next_index': 4294967295,
136 'instance': 4294967295, },
137 'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
138 'instance': 4294967295, },
139 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
140 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
142 'want_bfd_events': {'enable_disable': 1, },
143 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
144 'want_dhcp6_reply_events': {'enable_disable': 1, },
145 'want_igmp_events': {'enable': 1, },
146 'want_interface_events': {'enable_disable': 1, },
147 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
148 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
149 'want_ip6_ra_events': {'enable_disable': 1, },
150 'want_l2_macs_events': {'enable_disable': 1, },
154 class CliFailedCommandError(Exception):
155 """ cli command failed."""
158 class CliSyntaxError(Exception):
159 """ cli command had a syntax error."""
162 class UnexpectedApiReturnValueError(Exception):
163 """ exception raised when the API return value is unexpected """
167 class VppPapiProvider(object):
168 """VPP-api provider using vpp-papi
170 @property hook: hook object providing before and after api/cli hooks
173 _zero, _negative = range(2)
175 def __init__(self, name, shm_prefix, test_class, read_timeout):
176 self.hook = Hook(test_class)
178 self.shm_prefix = shm_prefix
179 self.test_class = test_class
180 self._expect_api_retval = self._zero
181 self._expect_stack = []
183 # install_dir is a class attribute. We need to set it before
184 # calling the constructor.
185 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
189 if os.environ['SOCKET'] == '1':
194 self.vpp = VPPApiClient(logger=test_class.logger,
195 read_timeout=read_timeout,
196 use_socket=use_socket,
197 server_address=test_class.api_sock)
198 self._events = deque()
203 def assert_negative_api_retval(self):
204 """ Expect API failure - used with with, e.g.:
205 with self.vapi.assert_negative_api_retval():
206 self.vapi.<api call expected to fail>
208 self._expect_stack.append(self._expect_api_retval)
209 self._expect_api_retval = self._negative
212 def assert_zero_api_retval(self):
213 """ Expect API success - used with with, e.g.:
214 with self.vapi.assert_negative_api_retval():
215 self.vapi.<api call expected to succeed>
217 note: this is useful only inside another with block
218 as success is the default expected value
220 self._expect_stack.append(self._expect_api_retval)
221 self._expect_api_retval = self._zero
224 def __exit__(self, exc_type, exc_value, traceback):
225 self._expect_api_retval = self._expect_stack.pop()
227 def register_hook(self, hook):
228 """Replace hook registration with new hook
235 def collect_events(self):
236 """ Collect all events from the internal queue and clear the queue. """
238 self._events = deque()
241 def wait_for_event(self, timeout, name=None):
242 """ Wait for and return next event. """
244 self.test_class.logger.debug("Expecting event '%s' within %ss",
247 self.test_class.logger.debug("Expecting event within %ss",
250 self.test_class.logger.debug("Not waiting, event already queued")
251 limit = time.time() + timeout
252 while time.time() < limit:
254 e = self._events.popleft()
255 if name and type(e).__name__ != name:
257 "Unexpected event received: %s, expected: %s" %
258 (type(e).__name__, name))
259 self.test_class.logger.debug("Returning event %s:%s" %
262 self.test_class.sleep(0) # yield
263 raise Exception("Event did not occur within timeout")
265 def __call__(self, name, event):
266 """ Enqueue event in the internal event queue. """
267 # FIXME use the name instead of relying on type(e).__name__ ?
268 # FIXME #2 if this throws, it is eaten silently, Ole?
269 self.test_class.logger.debug("New event: %s: %s" % (name, event))
270 self._events.append(event)
272 def factory(self, name, apifn):
274 fields = apifn._func.msg.fields
276 # add positional and kw arguments
278 for i, o in enumerate(fields[3:]):
285 if name in defaultmapping:
286 for k, v in iteritems(defaultmapping[name]):
290 return self.api(apifn, d)
294 def __getattribute__(self, name):
296 method = super(VppPapiProvider, self).__getattribute__(name)
297 except AttributeError:
298 method = self.factory(name, getattr(self.papi, name))
299 # lazily load the method so we don't need to call factory
300 # again for this name.
301 setattr(self, name, method)
305 """Connect the API to VPP"""
306 self.vpp.connect(self.name, self.shm_prefix)
307 self.papi = self.vpp.api
308 self.vpp.register_event_callback(self)
310 def disconnect(self):
311 """Disconnect the API from VPP"""
312 self.vpp.disconnect()
314 def api(self, api_fn, api_args, expected_retval=0):
315 """ Call API function and check it's return value.
316 Call the appropriate hooks before and after the API call
318 :param api_fn: API function to call
319 :param api_args: tuple of API function arguments
320 :param expected_retval: Expected return value (Default value = 0)
321 :returns: reply from the API
324 self.hook.before_api(api_fn.__name__, api_args)
325 reply = api_fn(**api_args)
326 if self._expect_api_retval == self._negative:
327 if hasattr(reply, 'retval') and reply.retval >= 0:
328 msg = "API call passed unexpectedly: expected negative " \
329 "return value instead of %d in %s" % \
330 (reply.retval, moves.reprlib.repr(reply))
331 self.test_class.logger.info(msg)
332 raise UnexpectedApiReturnValueError(msg)
333 elif self._expect_api_retval == self._zero:
334 if hasattr(reply, 'retval') and reply.retval != expected_retval:
335 msg = "API call failed, expected %d return value instead " \
336 "of %d in %s" % (expected_retval, reply.retval,
337 moves.reprlib.repr(reply))
338 self.test_class.logger.info(msg)
339 raise UnexpectedApiReturnValueError(msg)
341 raise Exception("Internal error, unexpected value for "
342 "self._expect_api_retval %s" %
343 self._expect_api_retval)
344 self.hook.after_api(api_fn.__name__, api_args)
348 """ Execute a CLI, calling the before/after hooks appropriately.
350 :param cli: CLI to execute
354 self.hook.before_cli(cli)
356 r = self.papi.cli_inband(cmd=cli)
357 self.hook.after_cli(cli)
359 raise CliSyntaxError(r.reply)
361 raise CliFailedCommandError(r.reply)
362 if hasattr(r, 'reply'):
365 def ppcli(self, cli):
366 """ Helper method to print CLI command in case of info logging level.
368 :param cli: CLI to execute
371 return cli + "\n" + str(self.cli(cli))
373 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
374 return self.api(self.papi.want_ip4_arp_events,
375 {'enable_disable': enable_disable,
377 'pid': os.getpid(), })
379 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
380 return self.api(self.papi.want_ip6_nd_events,
381 {'enable_disable': enable_disable,
383 'pid': os.getpid(), })
385 def want_ip6_ra_events(self, enable_disable=1):
386 return self.api(self.papi.want_ip6_ra_events,
387 {'enable_disable': enable_disable,
388 'pid': os.getpid(), })
390 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
392 return self.api(self.papi.ip6nd_send_router_solicitation,
397 'sw_if_index': sw_if_index})
399 def want_interface_events(self, enable_disable=1):
400 return self.api(self.papi.want_interface_events,
401 {'enable_disable': enable_disable,
402 'pid': os.getpid(), })
404 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
405 max_macs_in_event=0, learn_limit=0):
406 return self.api(self.papi.want_l2_macs_events,
407 {'enable_disable': enable_disable,
408 'scan_delay': scan_delay,
409 'max_macs_in_event': max_macs_in_event,
410 'learn_limit': learn_limit,
411 'pid': os.getpid(), })
413 def want_dhcp6_reply_events(self, enable_disable=1):
414 return self.api(self.papi.want_dhcp6_reply_events,
415 {'enable_disable': enable_disable,
418 def want_dhcp6_pd_reply_events(self, enable_disable=1):
419 return self.api(self.papi.want_dhcp6_pd_reply_events,
420 {'enable_disable': enable_disable,
423 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
424 prefixes, server_index=0xFFFFFFFF,
425 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
427 return self.api(self.papi.dhcp6_pd_send_client_message,
428 {'sw_if_index': sw_if_index,
429 'server_index': server_index,
435 'msg_type': msg_type,
438 'n_prefixes': len(prefixes),
439 'prefixes': prefixes})
441 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
443 return self.api(self.papi.dhcp6_client_enable_disable,
444 {'sw_if_index': sw_if_index,
447 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
449 return self.api(self.papi.dhcp6_pd_client_enable_disable,
450 {'sw_if_index': sw_if_index,
451 'prefix_group': prefix_group,
454 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
455 prefix_length, prefix_group,
457 return self.api(self.papi.ip6_add_del_address_using_prefix,
458 {'sw_if_index': sw_if_index,
459 'prefix_group': prefix_group,
461 'prefix_length': prefix_length,
464 def sw_interface_set_mac_address(self, sw_if_index, mac):
465 return self.api(self.papi.sw_interface_set_mac_address,
466 {'sw_if_index': sw_if_index,
469 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
470 """Create p2p ethernet subinterface
472 :param sw_if_index: main (parent) interface
473 :param remote_mac: client (remote) mac address
477 self.papi.p2p_ethernet_add,
478 {'parent_if_index': sw_if_index,
479 'remote_mac': remote_mac,
480 'subif_id': subif_id})
482 def p2p_ethernet_del(self, sw_if_index, remote_mac):
483 """Delete p2p ethernet subinterface
485 :param sw_if_index: main (parent) interface
486 :param remote_mac: client (remote) mac address
490 self.papi.p2p_ethernet_del,
491 {'parent_if_index': sw_if_index,
492 'remote_mac': remote_mac})
494 def create_vlan_subif(self, sw_if_index, vlan):
501 return self.api(self.papi.create_vlan_subif,
502 {'sw_if_index': sw_if_index,
505 def create_loopback(self, mac=''):
508 :param mac: (Optional)
510 return self.api(self.papi.create_loopback,
511 {'mac_address': mac})
513 def ip_neighbor_add_del(self,
519 """ Add neighbor MAC to IPv4 or IPv6 address.
524 :param is_add: (Default value = 1)
525 :param flags: (Default value = 0/NONE)
528 self.papi.ip_neighbor_add_del,
532 'sw_if_index': sw_if_index,
534 'mac_address': mac_address,
535 'ip_address': ip_address
540 def proxy_arp_add_del(self,
545 """ Config Proxy Arp Range.
547 :param low_address: Start address in the rnage to Proxy for
548 :param hi_address: End address in the rnage to Proxy for
549 :param vrf_id: The VRF/table in which to proxy
553 self.papi.proxy_arp_add_del,
556 'table_id': table_id,
562 def proxy_arp_intfc_enable_disable(self,
565 """ Enable/Disable an interface for proxy ARP requests
567 :param sw_if_index: Interface
568 :param enable_disable: Enable/Disable
572 self.papi.proxy_arp_intfc_enable_disable,
573 {'sw_if_index': sw_if_index,
574 'enable_disable': is_enable
578 def gre_tunnel_add_del(self,
590 :param outer_fib_id: (Default value = 0)
591 :param tunnel_type: (Default value = 0)
592 :param instance: (Default value = 0xFFFFFFFF)
593 :param session_id: (Default value = 0)
594 :param is_add: (Default value = 1)
595 :param is_ipv6: (Default value = 0)
599 self.papi.gre_tunnel_add_del,
604 'instance': instance,
607 'outer_fib_id': outer_fib_id,
608 'session_id': session_id}
612 def udp_encap_add(self,
623 :param outer_fib_id: (Default value = 0)
627 self.papi.udp_encap_add,
632 'src_port': src_port,
633 'dst_port': dst_port,
638 def mpls_table_add_del(
645 :param is_add: (Default value = 1)
650 self.papi.mpls_table_add_del,
651 {'mt_table_id': table_id,
652 'mt_is_add': is_add})
654 def mpls_ip_bind_unbind(
666 self.papi.mpls_ip_bind_unbind,
667 {'mb_mpls_table_id': table_id,
669 'mb_ip_table_id': ip_table_id,
670 'mb_is_bind': is_bind,
672 'mb_address_length': dst_address_length,
673 'mb_address': dst_address})
675 def mpls_tunnel_add_del(
678 next_hop_proto_is_ip4,
680 next_hop_sw_if_index=0xFFFFFFFF,
683 next_hop_n_out_labels=0,
684 next_hop_out_label_stack=[],
685 next_hop_via_label=MPLS_LABEL_INVALID,
691 :param dst_address_length:
692 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
694 :param next_hop_address:
695 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
696 :param vrf_id: (Default value = 0)
697 :param lookup_in_vrf: (Default value = 0)
698 :param classify_table_index: (Default value = 0xFFFFFFFF)
699 :param is_add: (Default value = 1)
700 :param is_drop: (Default value = 0)
701 :param is_ipv6: (Default value = 0)
702 :param is_local: (Default value = 0)
703 :param is_classify: (Default value = 0)
704 :param is_multipath: (Default value = 0)
705 :param is_resolve_host: (Default value = 0)
706 :param is_resolve_attached: (Default value = 0)
707 :param next_hop_weight: (Default value = 1)
708 :param is_multicast: (Default value = 0)
712 self.papi.mpls_tunnel_add_del,
713 {'mt_sw_if_index': tun_sw_if_index,
715 'mt_l2_only': l2_only,
716 'mt_is_multicast': is_multicast,
717 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
718 'mt_next_hop_weight': next_hop_weight,
719 'mt_next_hop': next_hop_address,
720 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
721 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
722 'mt_next_hop_table_id': next_hop_table_id,
723 'mt_next_hop_via_label': next_hop_via_label,
724 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
726 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
727 detect_mult, local_addr, peer_addr, is_ipv6=0,
728 bfd_key_id=None, conf_key_id=None):
729 if bfd_key_id is None:
730 return self.api(self.papi.bfd_udp_add,
732 'sw_if_index': sw_if_index,
733 'desired_min_tx': desired_min_tx,
734 'required_min_rx': required_min_rx,
735 'local_addr': local_addr,
736 'peer_addr': peer_addr,
738 'detect_mult': detect_mult,
741 return self.api(self.papi.bfd_udp_add,
743 'sw_if_index': sw_if_index,
744 'desired_min_tx': desired_min_tx,
745 'required_min_rx': required_min_rx,
746 'local_addr': local_addr,
747 'peer_addr': peer_addr,
749 'detect_mult': detect_mult,
750 'is_authenticated': 1,
751 'bfd_key_id': bfd_key_id,
752 'conf_key_id': conf_key_id,
755 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
756 detect_mult, local_addr, peer_addr, is_ipv6=0):
757 return self.api(self.papi.bfd_udp_mod,
759 'sw_if_index': sw_if_index,
760 'desired_min_tx': desired_min_tx,
761 'required_min_rx': required_min_rx,
762 'local_addr': local_addr,
763 'peer_addr': peer_addr,
765 'detect_mult': detect_mult,
768 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
769 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
771 return self.api(self.papi.bfd_udp_auth_activate,
773 'sw_if_index': sw_if_index,
774 'local_addr': local_addr,
775 'peer_addr': peer_addr,
777 'is_delayed': 1 if is_delayed else 0,
778 'bfd_key_id': bfd_key_id,
779 'conf_key_id': conf_key_id,
782 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
783 peer_addr, is_ipv6=0):
784 return self.api(self.papi.bfd_udp_session_set_flags, {
785 'admin_up_down': admin_up_down,
786 'sw_if_index': sw_if_index,
787 'local_addr': local_addr,
788 'peer_addr': peer_addr,
792 def want_bfd_events(self, enable_disable=1):
793 return self.api(self.papi.want_bfd_events, {
794 'enable_disable': enable_disable,
798 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
799 return self.api(self.papi.bfd_auth_set_key, {
800 'conf_key_id': conf_key_id,
801 'auth_type': auth_type,
806 def classify_add_del_table(
811 table_index=0xFFFFFFFF,
815 next_table_index=0xFFFFFFFF,
816 miss_next_index=0xFFFFFFFF,
818 current_data_offset=0):
822 :param match_n_vectors: (Default value = 1)
823 :param table_index: (Default value = 0xFFFFFFFF)
824 :param nbuckets: (Default value = 2)
825 :param memory_size: (Default value = 2097152)
826 :param skip_n_vectors: (Default value = 0)
827 :param next_table_index: (Default value = 0xFFFFFFFF)
828 :param miss_next_index: (Default value = 0xFFFFFFFF)
829 :param current_data_flag: (Default value = 0)
830 :param current_data_offset: (Default value = 0)
833 mask_len = ((len(mask) - 1) / 16 + 1) * 16
834 mask = mask + '\0' * (mask_len - len(mask))
836 self.papi.classify_add_del_table,
838 'table_index': table_index,
839 'nbuckets': nbuckets,
840 'memory_size': memory_size,
841 'skip_n_vectors': skip_n_vectors,
842 'match_n_vectors': match_n_vectors,
843 'next_table_index': next_table_index,
844 'miss_next_index': miss_next_index,
845 'current_data_flag': current_data_flag,
846 'current_data_offset': current_data_offset,
847 'mask_len': mask_len,
850 def classify_add_del_session(
855 opaque_index=0xFFFFFFFF,
856 hit_next_index=0xFFFFFFFF,
864 :param opaque_index: (Default value = 0xFFFFFFFF)
865 :param hit_next_index: (Default value = 0xFFFFFFFF)
866 :param advance: (Default value = 0)
867 :param action: (Default value = 0)
868 :param metadata: (Default value = 0)
871 match_len = ((len(match) - 1) / 16 + 1) * 16
872 match = match + '\0' * (match_len - len(match))
874 self.papi.classify_add_del_session,
876 'table_index': table_index,
877 'hit_next_index': hit_next_index,
878 'opaque_index': opaque_index,
881 'metadata': metadata,
882 'match_len': match_len,
885 def input_acl_set_interface(
889 ip4_table_index=0xFFFFFFFF,
890 ip6_table_index=0xFFFFFFFF,
891 l2_table_index=0xFFFFFFFF):
895 :param ip4_table_index: (Default value = 0xFFFFFFFF)
896 :param ip6_table_index: (Default value = 0xFFFFFFFF)
897 :param l2_table_index: (Default value = 0xFFFFFFFF)
901 self.papi.input_acl_set_interface,
902 {'sw_if_index': sw_if_index,
903 'ip4_table_index': ip4_table_index,
904 'ip6_table_index': ip6_table_index,
905 'l2_table_index': l2_table_index,
908 def output_acl_set_interface(
912 ip4_table_index=0xFFFFFFFF,
913 ip6_table_index=0xFFFFFFFF,
914 l2_table_index=0xFFFFFFFF):
918 :param ip4_table_index: (Default value = 0xFFFFFFFF)
919 :param ip6_table_index: (Default value = 0xFFFFFFFF)
920 :param l2_table_index: (Default value = 0xFFFFFFFF)
924 self.papi.output_acl_set_interface,
925 {'sw_if_index': sw_if_index,
926 'ip4_table_index': ip4_table_index,
927 'ip6_table_index': ip6_table_index,
928 'l2_table_index': l2_table_index,
931 def set_ipfix_exporter(
941 self.papi.set_ipfix_exporter,
943 'collector_address': collector_address,
944 'collector_port': collector_port,
945 'src_address': src_address,
947 'path_mtu': path_mtu,
948 'template_interval': template_interval,
949 'udp_checksum': udp_checksum,
952 def dhcp_proxy_config(self,
960 self.papi.dhcp_proxy_config,
962 'rx_vrf_id': rx_table_id,
963 'server_vrf_id': server_table_id,
966 'dhcp_server': dhcp_server,
967 'dhcp_src_address': dhcp_src_address,
970 def dhcp_proxy_set_vss(self,
979 self.papi.dhcp_proxy_set_vss,
982 'vss_type': vss_type,
983 'vpn_ascii_id': vpn_ascii_id,
985 'vpn_index': vpn_index,
990 def dhcp_client_config(self,
995 set_broadcast_flag=1,
998 self.papi.dhcp_client_config,
1002 'sw_if_index': sw_if_index,
1003 'hostname': hostname,
1005 'want_dhcp_event': want_dhcp_events,
1006 'set_broadcast_flag': set_broadcast_flag,
1010 def ip_mroute_add_del(self,
1016 next_hop_sw_if_index,
1026 IP Multicast Route add/del
1029 self.papi.ip_mroute_add_del,
1030 {'next_hop_sw_if_index': next_hop_sw_if_index,
1031 'entry_flags': e_flags,
1032 'itf_flags': i_flags,
1033 'table_id': table_id,
1037 'is_local': is_local,
1038 'bier_imp': bier_imp,
1039 'next_hop_afi': next_hop_afi,
1040 'grp_address_length': grp_address_length,
1041 'grp_address': grp_address,
1042 'src_address': src_address,
1043 'nh_address': next_hop_address})
1045 def lisp_enable_disable(self, is_enabled):
1047 self.papi.lisp_enable_disable,
1049 'is_en': is_enabled,
1052 def lisp_add_del_locator_set(self,
1056 self.papi.lisp_add_del_locator_set,
1059 'locator_set_name': ls_name
1062 def lisp_add_del_locator(self,
1069 self.papi.lisp_add_del_locator,
1072 'locator_set_name': ls_name,
1073 'sw_if_index': sw_if_index,
1074 'priority': priority,
1078 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1080 self.papi.lisp_locator_dump,
1082 'is_index_set': is_index_set,
1084 'ls_index': ls_index,
1087 def lisp_add_del_local_eid(self,
1097 self.papi.lisp_add_del_local_eid,
1099 'locator_set_name': ls_name,
1101 'eid_type': eid_type,
1103 'prefix_len': prefix_len,
1109 def lisp_eid_table_dump(self,
1117 self.papi.lisp_eid_table_dump,
1120 'prefix_length': prefix_length,
1122 'eid_type': eid_type,
1124 'filter': filter_opt,
1127 def lisp_add_del_remote_mapping(self,
1137 self.papi.lisp_add_del_remote_mapping,
1140 'eid_type': eid_type,
1142 'eid_len': eid_prefix_len,
1143 'rloc_num': rlocs_num,
1146 'is_src_dst': is_src_dst,
1149 def lisp_add_del_adjacency(self,
1158 self.papi.lisp_add_del_adjacency,
1162 'eid_type': eid_type,
1165 'leid_len': leid_len,
1166 'reid_len': reid_len,
1169 def gtpu_add_del_tunnel(
1175 mcast_sw_if_index=0xFFFFFFFF,
1177 decap_next_index=0xFFFFFFFF,
1181 :param is_add: (Default value = 1)
1182 :param is_ipv6: (Default value = 0)
1185 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1186 :param encap_vrf_id: (Default value = 0)
1187 :param decap_next_index: (Default value = 0xFFFFFFFF)
1188 :param teid: (Default value = 0)
1191 return self.api(self.papi.gtpu_add_del_tunnel,
1194 'src_address': src_addr,
1195 'dst_address': dst_addr,
1196 'mcast_sw_if_index': mcast_sw_if_index,
1197 'encap_vrf_id': encap_vrf_id,
1198 'decap_next_index': decap_next_index,
1201 def vxlan_gpe_add_del_tunnel(
1205 mcast_sw_if_index=0xFFFFFFFF,
1216 :param is_add: (Default value = 1)
1217 :param is_ipv6: (Default value = 0)
1218 :param encap_vrf_id: (Default value = 0)
1219 :param decap_vrf_id: (Default value = 0)
1220 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1221 :param protocol: (Default value = 3)
1222 :param vni: (Default value = 0)
1225 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1230 'mcast_sw_if_index': mcast_sw_if_index,
1231 'encap_vrf_id': encap_vrf_id,
1232 'decap_vrf_id': decap_vrf_id,
1233 'protocol': protocol,
1236 def vxlan_gbp_tunnel_add_del(
1240 mcast_sw_if_index=0xFFFFFFFF,
1246 instance=0xFFFFFFFF):
1251 :param is_add: (Default value = 1)
1252 :param is_ipv6: (Default value = 0)
1253 :param encap_table_id: (Default value = 0)
1254 :param decap_next_index: (Default value = 0xFFFFFFFF)
1255 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1256 :param vni: (Default value = 0)
1257 :param instance: (Default value = 0xFFFFFFFF)
1260 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
1265 'mcast_sw_if_index': mcast_sw_if_index,
1266 'encap_table_id': encap_table_id,
1268 'instance': instance,
1271 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1272 return self.api(self.papi.vxlan_gbp_tunnel_dump,
1273 {'sw_if_index': sw_if_index,
1274 '_no_type_conversion': True})
1276 def pppoe_add_del_session(
1286 :param is_add: (Default value = 1)
1287 :param is_ipv6: (Default value = 0)
1289 :param session_id: (Default value = 0)
1291 :param decap_vrf_id: (Default value = 0)
1294 return self.api(self.papi.pppoe_add_del_session,
1297 'session_id': session_id,
1298 'client_ip': client_ip,
1299 'decap_vrf_id': decap_vrf_id,
1300 'client_mac': client_mac})
1302 def sr_mpls_policy_add(self, bsid, weight, type, segments):
1303 return self.api(self.papi.sr_mpls_policy_add,
1307 'n_segments': len(segments),
1308 'segments': segments})
1310 def sr_mpls_policy_del(self, bsid):
1311 return self.api(self.papi.sr_mpls_policy_del,
1314 def sr_localsid_add_del(self,
1321 sw_if_index=0xFFFFFFFF,
1325 """ Add/del IPv6 SR local-SID.
1328 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1329 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1332 :param is_del: (Default value = 0)
1333 :param end_psp: (Default value = 0)
1334 :param sw_if_index: (Default value = 0xFFFFFFFF)
1335 :param vlan_index: (Default value = 0)
1336 :param fib_table: (Default value = 0)
1339 self.papi.sr_localsid_add_del,
1341 'localsid': localsid,
1343 'behavior': behavior,
1344 'sw_if_index': sw_if_index,
1345 'vlan_index': vlan_index,
1346 'fib_table': fib_table,
1347 'nh_addr4': nh_addr4,
1348 'nh_addr6': nh_addr6
1362 :param bsid_addr: bindingSID of the SR Policy
1363 :param weight: weight of the sid list. optional. (default: 1)
1364 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1366 :param type: type/behavior of the SR policy. (default or spray) \
1368 :param fib_table: VRF where to install the FIB entry for the BSID \
1370 :param n_segments: number of segments \
1372 :param segments: a vector of IPv6 address composing the segment list \
1376 self.papi.sr_policy_add,
1377 {'bsid_addr': bsid_addr,
1379 'is_encap': is_encap,
1381 'fib_table': fib_table,
1382 'n_segments': n_segments,
1383 'segments': segments
1392 :param bsid: bindingSID of the SR Policy
1393 :param sr_policy_index: index of the sr policy (default: 0)
1396 self.papi.sr_policy_del,
1397 {'bsid_addr': bsid_addr,
1398 'sr_policy_index': sr_policy_index
1401 def sr_steering_add_del(
1412 Steer traffic L2 and L3 traffic through a given SR policy
1414 :param is_del: delete or add
1415 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1416 :param sr_policy: is the index of the SR Policy (alt to bsid)
1417 :param table_id: is the VRF where to install the FIB entry for the BSID
1418 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1419 :param mask_width: is the mask for L3 traffic type
1420 :param sw_if_index: is the incoming interface for L2 traffic
1421 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1424 self.papi.sr_steering_add_del,
1426 'bsid_addr': bsid_addr,
1427 'sr_policy_index': sr_policy_index,
1428 'table_id': table_id,
1429 'prefix_addr': prefix_addr,
1430 'mask_width': mask_width,
1431 'sw_if_index': sw_if_index,
1432 'traffic_type': traffic_type
1435 def acl_add_replace(self, acl_index, r, tag='',
1437 """Add/replace an ACL
1438 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1439 :param acl_rule r: ACL rules array.
1440 :param str tag: symbolic tag (description) for this ACL.
1441 :param int count: number of rules.
1443 return self.api(self.papi.acl_add_replace,
1444 {'acl_index': acl_index,
1448 expected_retval=expected_retval)
1450 def acl_del(self, acl_index, expected_retval=0):
1456 return self.api(self.papi.acl_del,
1457 {'acl_index': acl_index},
1458 expected_retval=expected_retval)
1460 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1462 return self.api(self.papi.acl_interface_set_acl_list,
1463 {'sw_if_index': sw_if_index,
1467 expected_retval=expected_retval)
1469 def acl_interface_set_etype_whitelist(self, sw_if_index,
1472 return self.api(self.papi.acl_interface_set_etype_whitelist,
1473 {'sw_if_index': sw_if_index,
1474 'count': len(whitelist),
1476 'whitelist': whitelist},
1477 expected_retval=expected_retval)
1479 def acl_interface_add_del(self,
1483 """ Add/Delete ACL to/from interface
1487 :param is_add: (Default value = 1)
1490 return self.api(self.papi.acl_interface_add_del,
1493 'sw_if_index': sw_if_index,
1494 'acl_index': acl_index})
1496 def acl_dump(self, acl_index, expected_retval=0):
1497 return self.api(self.papi.acl_dump,
1498 {'acl_index': acl_index},
1499 expected_retval=expected_retval)
1501 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1503 return self.api(self.papi.acl_interface_list_dump,
1504 {'sw_if_index': sw_if_index},
1505 expected_retval=expected_retval)
1507 def macip_acl_add(self, rules, tag=""):
1510 :param rules: list of rules for given acl
1514 return self.api(self.papi.macip_acl_add,
1516 'count': len(rules),
1519 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1522 :param rules: list of rules for given acl
1526 return self.api(self.papi.macip_acl_add_replace,
1527 {'acl_index': acl_index,
1529 'count': len(rules),
1532 def macip_acl_interface_add_del(self,
1536 """ Add MACIP acl to interface
1540 :param is_add: (Default value = 1)
1543 return self.api(self.papi.macip_acl_interface_add_del,
1545 'sw_if_index': sw_if_index,
1546 'acl_index': acl_index})
1548 def macip_acl_dump(self, acl_index=4294967295):
1549 """ Return MACIP acl dump
1553 self.papi.macip_acl_dump, {'acl_index': acl_index})
1555 def policer_add_del(self,
1566 conform_action_type=1,
1568 exceed_action_type=0,
1570 violate_action_type=0,
1572 return self.api(self.papi.policer_add_del,
1579 'rate_type': rate_type,
1580 'round_type': round_type,
1582 'color_aware': color_aware,
1583 'conform_action_type': conform_action_type,
1584 'conform_dscp': conform_dscp,
1585 'exceed_action_type': exceed_action_type,
1586 'exceed_dscp': exceed_dscp,
1587 'violate_action_type': violate_action_type,
1588 'violate_dscp': violate_dscp})
1590 def ip_punt_police(self,
1594 return self.api(self.papi.ip_punt_police,
1595 {'policer_index': policer_index,
1599 def ip_punt_redirect(self,
1604 return self.api(self.papi.ip_punt_redirect,
1605 {'punt': {'rx_sw_if_index': rx_sw_if_index,
1606 'tx_sw_if_index': tx_sw_if_index,
1610 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1611 return self.api(self.papi.ip_punt_redirect_dump,
1612 {'sw_if_index': sw_if_index,
1613 'is_ipv6': is_ipv6})
1615 def bier_table_add_del(self,
1619 """ BIER Table add/del """
1621 self.papi.bier_table_add_del,
1622 {'bt_tbl_id': {"bt_set": bti.set_id,
1623 "bt_sub_domain": bti.sub_domain_id,
1624 "bt_hdr_len_id": bti.hdr_len_id},
1625 'bt_label': mpls_label,
1626 'bt_is_add': is_add})
1628 def bier_table_dump(self):
1629 return self.api(self.papi.bier_table_dump, {})
1631 def bier_route_add_del(self,
1637 """ BIER Route add/del """
1639 self.papi.bier_route_add_del,
1640 {'br_tbl_id': {"bt_set": bti.set_id,
1641 "bt_sub_domain": bti.sub_domain_id,
1642 "bt_hdr_len_id": bti.hdr_len_id},
1644 'br_n_paths': len(paths),
1646 'br_is_add': is_add,
1647 'br_is_replace': is_replace})
1649 def bier_route_dump(self, bti):
1651 self.papi.bier_route_dump,
1652 {'br_tbl_id': {"bt_set": bti.set_id,
1653 "bt_sub_domain": bti.sub_domain_id,
1654 "bt_hdr_len_id": bti.hdr_len_id}})
1656 def bier_imp_add(self,
1661 """ BIER Imposition Add """
1663 self.papi.bier_imp_add,
1664 {'bi_tbl_id': {"bt_set": bti.set_id,
1665 "bt_sub_domain": bti.sub_domain_id,
1666 "bt_hdr_len_id": bti.hdr_len_id},
1668 'bi_n_bytes': len(ibytes),
1669 'bi_bytes': ibytes})
1671 def bier_imp_del(self, bi_index):
1672 """ BIER Imposition del """
1674 self.papi.bier_imp_del,
1675 {'bi_index': bi_index})
1677 def bier_imp_dump(self):
1678 return self.api(self.papi.bier_imp_dump, {})
1680 def bier_disp_table_add_del(self,
1683 """ BIER Disposition Table add/del """
1685 self.papi.bier_disp_table_add_del,
1686 {'bdt_tbl_id': bdti,
1687 'bdt_is_add': is_add})
1689 def bier_disp_table_dump(self):
1690 return self.api(self.papi.bier_disp_table_dump, {})
1692 def bier_disp_entry_add_del(self,
1702 """ BIER Route add/del """
1704 while (len(lstack) < 16):
1707 self.papi.bier_disp_entry_add_del,
1708 {'bde_tbl_id': bdti,
1710 'bde_payload_proto': payload_proto,
1712 'bde_paths': [{'next_hop': next_hop,
1713 'table_id': next_hop_tbl_id,
1714 'afi': next_hop_afi,
1715 'rpf_id': next_hop_rpf_id,
1717 'label_stack': lstack}],
1718 'bde_is_add': is_add})
1720 def bier_disp_entry_dump(self, bdti):
1722 self.papi.bier_disp_entry_dump,
1723 {'bde_tbl_id': bdti})
1725 def session_enable_disable(self, is_enabled):
1727 self.papi.session_enable_disable,
1728 {'is_enable': is_enabled})
1730 def ipsec_spd_add_del(self, spd_id, is_add=1):
1731 """ SPD add/del - Wrapper to add or del ipsec SPD
1732 Sample CLI : 'ipsec spd add 1'
1734 :param spd_id - SPD ID to be created in the vpp . mandatory
1735 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1737 :returns: reply from the API
1740 self.papi.ipsec_spd_add_del, {
1741 'spd_id': spd_id, 'is_add': is_add})
1743 def ipsec_spds_dump(self):
1744 return self.api(self.papi.ipsec_spds_dump, {})
1746 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1747 """ IPSEC interface SPD add/del - \
1748 Wrapper to associate/disassociate SPD to interface in VPP
1749 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1751 :param spd_id - SPD ID to associate with the interface . mandatory
1752 :param sw_if_index - Interface Index which needs to ipsec \
1753 association mandatory
1754 :param is_add - add(1) or del(0) association with interface \
1755 (Default 1 - add) . optional
1756 :returns: reply from the API
1759 self.papi.ipsec_interface_add_del_spd,
1760 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1762 def ipsec_spd_interface_dump(self, spd_index=None):
1763 return self.api(self.papi.ipsec_spd_interface_dump,
1764 {'spd_index': spd_index if spd_index else 0,
1765 'spd_index_valid': 1 if spd_index else 0})
1767 def ipsec_sad_entry_add_del(self,
1770 integrity_algorithm,
1775 tunnel_src_address='',
1776 tunnel_dst_address='',
1780 """ IPSEC SA add/del
1781 :param sad_id: security association ID
1782 :param spi: security param index of the SA in decimal
1783 :param integrity_algorithm:
1784 :param integrity_key:
1785 :param crypto_algorithm:
1787 :param protocol: AH(0) or ESP(1) protocol
1788 :param tunnel_src_address: tunnel mode outer src address
1789 :param tunnel_dst_address: tunnel mode outer dst address
1792 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1793 crypto and ipsec algorithms
1796 self.papi.ipsec_sad_entry_add_del,
1803 'tunnel_src': tunnel_src_address,
1804 'tunnel_dst': tunnel_dst_address,
1805 'protocol': protocol,
1806 'integrity_algorithm': integrity_algorithm,
1808 'length': len(integrity_key),
1809 'data': integrity_key,
1811 'crypto_algorithm': crypto_algorithm,
1813 'length': len(crypto_key),
1821 def ipsec_sa_dump(self, sa_id=None):
1822 return self.api(self.papi.ipsec_sa_dump,
1823 {'sa_id': sa_id if sa_id else 0xffffffff})
1825 def ipsec_spd_entry_add_del(self,
1828 local_address_start,
1830 remote_address_start,
1831 remote_address_stop,
1833 local_port_stop=65535,
1834 remote_port_start=0,
1835 remote_port_stop=65535,
1843 """ IPSEC policy SPD add/del -
1844 Wrapper to configure ipsec SPD policy entries in VPP
1845 :param spd_id: SPD ID for the policy
1846 :param local_address_start: local-ip-range start address
1847 :param local_address_stop : local-ip-range stop address
1848 :param remote_address_start: remote-ip-range start address
1849 :param remote_address_stop : remote-ip-range stop address
1850 :param local_port_start: (Default value = 0)
1851 :param local_port_stop: (Default value = 65535)
1852 :param remote_port_start: (Default value = 0)
1853 :param remote_port_stop: (Default value = 65535)
1854 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1855 :param sa_id: Security Association ID for mapping it to SPD
1856 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1858 :param priority: value for the spd action (Default value = 100)
1859 :param is_outbound: flag for inbound(0) or outbound(1)
1861 :param is_add: (Default value = 1)
1864 self.papi.ipsec_spd_entry_add_del,
1871 'local_address_start': local_address_start,
1872 'local_address_stop': local_address_stop,
1873 'remote_address_start': remote_address_start,
1874 'remote_address_stop': remote_address_stop,
1875 'local_port_start': local_port_start,
1876 'local_port_stop': local_port_stop,
1877 'remote_port_start': remote_port_start,
1878 'remote_port_stop': remote_port_stop,
1879 'protocol': protocol,
1881 'priority': priority,
1882 'is_outbound': is_outbound,
1883 'is_ip_any': is_ip_any
1887 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1888 return self.api(self.papi.ipsec_spd_dump,
1892 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1893 remote_spi, crypto_alg, local_crypto_key,
1894 remote_crypto_key, integ_alg, local_integ_key,
1895 remote_integ_key, is_add=1, esn=0, salt=0,
1896 anti_replay=1, renumber=0, show_instance=0):
1898 self.papi.ipsec_tunnel_if_add_del,
1900 'local_ip': local_ip,
1901 'remote_ip': remote_ip,
1902 'local_spi': local_spi,
1903 'remote_spi': remote_spi,
1904 'crypto_alg': crypto_alg,
1905 'local_crypto_key_len': len(local_crypto_key),
1906 'local_crypto_key': local_crypto_key,
1907 'remote_crypto_key_len': len(remote_crypto_key),
1908 'remote_crypto_key': remote_crypto_key,
1909 'integ_alg': integ_alg,
1910 'local_integ_key_len': len(local_integ_key),
1911 'local_integ_key': local_integ_key,
1912 'remote_integ_key_len': len(remote_integ_key),
1913 'remote_integ_key': remote_integ_key,
1916 'anti_replay': anti_replay,
1917 'renumber': renumber,
1918 'show_instance': show_instance,
1922 def ipsec_gre_tunnel_add_del(self, local_ip, remote_ip,
1923 sa_out, sa_in, is_add=1):
1924 return self.api(self.papi.ipsec_gre_tunnel_add_del,
1930 'local_sa_id': sa_out,
1931 'remote_sa_id': sa_in
1935 def ipsec_select_backend(self, protocol, index):
1936 return self.api(self.papi.ipsec_select_backend,
1937 {'protocol': protocol, 'index': index})
1939 def ipsec_backend_dump(self):
1940 return self.api(self.papi.ipsec_backend_dump, {})
1942 def app_namespace_add_del(self,
1946 sw_if_index=0xFFFFFFFF,
1949 self.papi.app_namespace_add_del,
1951 'sw_if_index': sw_if_index,
1952 'ip4_fib_id': ip4_fib_id,
1953 'ip6_fib_id': ip6_fib_id,
1954 'namespace_id': namespace_id,
1955 'namespace_id_len': len(namespace_id)})
1957 def punt_socket_register(self, port, pathname, protocol=0x11,
1958 header_version=1, is_ip4=1):
1959 """ Register punt socket """
1960 return self.api(self.papi.punt_socket_register,
1961 {'header_version': header_version,
1962 'punt': {'ipv': is_ip4,
1963 'l4_protocol': protocol,
1965 'pathname': pathname})
1967 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
1968 """ Unregister punt socket """
1969 return self.api(self.papi.punt_socket_deregister,
1970 {'punt': {'ipv': is_ip4,
1971 'l4_protocol': protocol,
1974 def punt_socket_dump(self, is_ip6=1):
1975 """ Dump punt socket"""
1976 return self.api(self.papi.punt_socket_dump,
1977 {'is_ipv6': is_ip6})
1979 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1981 """ GBP endpoint Add """
1982 return self.api(self.papi.gbp_endpoint_add,
1984 'sw_if_index': sw_if_index,
1995 def gbp_endpoint_del(self, handle):
1996 """ GBP endpoint Del """
1997 return self.api(self.papi.gbp_endpoint_del,
2000 def gbp_endpoint_dump(self):
2001 """ GBP endpoint Dump """
2002 return self.api(self.papi.gbp_endpoint_dump,
2003 {'_no_type_conversion': True})
2005 def gbp_endpoint_group_add(self, vnid, sclass, bd,
2006 rd, uplink_sw_if_index,
2008 """ GBP endpoint group Add """
2009 return self.api(self.papi.gbp_endpoint_group_add,
2012 'uplink_sw_if_index': uplink_sw_if_index,
2017 'retention': retention
2020 def gbp_endpoint_group_del(self, sclass):
2021 """ GBP endpoint group Del """
2022 return self.api(self.papi.gbp_endpoint_group_del,
2025 def gbp_bridge_domain_add(self, bd_id, flags,
2028 bm_flood_sw_if_index):
2029 """ GBP bridge-domain Add """
2030 return self.api(self.papi.gbp_bridge_domain_add,
2034 'bvi_sw_if_index': bvi_sw_if_index,
2035 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2036 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2040 def gbp_bridge_domain_del(self, bd_id):
2041 """ GBP bridge-domain Del """
2042 return self.api(self.papi.gbp_bridge_domain_del,
2045 def gbp_route_domain_add(self, rd_id,
2049 ip6_uu_sw_if_index):
2050 """ GBP route-domain Add """
2051 return self.api(self.papi.gbp_route_domain_add,
2054 'ip4_table_id': ip4_table_id,
2055 'ip6_table_id': ip6_table_id,
2056 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2057 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2061 def gbp_route_domain_del(self, rd_id):
2062 """ GBP route-domain Del """
2063 return self.api(self.papi.gbp_route_domain_del,
2066 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2067 """ GBP recirc Add/Del """
2068 return self.api(self.papi.gbp_recirc_add_del,
2072 'sw_if_index': sw_if_index,
2075 def gbp_recirc_dump(self):
2076 """ GBP recirc Dump """
2077 return self.api(self.papi.gbp_recirc_dump, {})
2079 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2080 """ GBP recirc Add/Del """
2081 return self.api(self.papi.gbp_ext_itf_add_del,
2084 'sw_if_index': sw_if_index,
2088 def gbp_ext_itf_dump(self):
2089 """ GBP recirc Dump """
2090 return self.api(self.papi.gbp_ext_itf_dump, {})
2092 def gbp_subnet_add_del(self, is_add, rd_id,
2094 sw_if_index=0xffffffff,
2096 """ GBP Subnet Add/Del """
2097 return self.api(self.papi.gbp_subnet_add_del,
2101 'sw_if_index': sw_if_index,
2106 def gbp_subnet_dump(self):
2107 """ GBP Subnet Dump """
2108 return self.api(self.papi.gbp_subnet_dump,
2109 {'_no_type_conversion': True})
2111 def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2112 rules, allowed_ethertypes):
2113 """ GBP contract Add/Del """
2114 return self.api(self.papi.gbp_contract_add_del,
2117 'acl_index': acl_index,
2120 'n_rules': len(rules),
2122 'n_ether_types': len(allowed_ethertypes),
2123 'allowed_ethertypes': allowed_ethertypes}})
2125 def gbp_contract_dump(self):
2126 """ GBP contract Dump """
2127 return self.api(self.papi.gbp_contract_dump, {})
2129 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2130 """ GBP VXLAN tunnel add """
2131 return self.api(self.papi.gbp_vxlan_tunnel_add,
2136 'bd_rd_id': bd_rd_id,
2141 def gbp_vxlan_tunnel_del(self, vni):
2142 """ GBP VXLAN tunnel del """
2143 return self.api(self.papi.gbp_vxlan_tunnel_del,
2148 def gbp_vxlan_tunnel_dump(self):
2149 """ GBP VXLAN tunnel add/del """
2150 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2152 def qos_egress_map_update(self, id, outputs):
2153 """ QOS egress map update """
2154 return self.api(self.papi.qos_egress_map_update,
2158 def qos_egress_map_delete(self, id):
2159 """ QOS egress map delete """
2160 return self.api(self.papi.qos_egress_map_delete,
2163 def qos_mark_enable_disable(self, sw_if_index,
2167 """ QOS Mark Enable/Disable """
2168 return self.api(self.papi.qos_mark_enable_disable,
2170 'sw_if_index': sw_if_index,
2171 'output_source': output_source,
2174 def igmp_enable_disable(self, sw_if_index, enable, host):
2175 """ Enable/disable IGMP on a given interface """
2176 return self.api(self.papi.igmp_enable_disable,
2179 'sw_if_index': sw_if_index})
2181 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2182 """ Add/del IGMP proxy device """
2183 return self.api(self.papi.igmp_proxy_device_add_del,
2184 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2187 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2188 """ Add/del interface to/from IGMP proxy device """
2189 return self.api(self.papi.igmp_proxy_device_add_del_interface,
2190 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2193 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2194 """ Listen for new (S,G) on specified interface
2196 :param enable: add/del
2197 :param sw_if_index: interface sw index
2198 :param saddr: source ip4 addr
2199 :param gaddr: group ip4 addr
2201 return self.api(self.papi.igmp_listen,
2206 'sw_if_index': sw_if_index,
2207 'n_srcs': len(saddrs),
2213 def igmp_clear_interface(self, sw_if_index):
2214 """ Remove all (S,G)s from specified interface
2215 doesn't send IGMP report!
2218 self.papi.igmp_clear_interface, {
2219 'sw_if_index': sw_if_index})
2221 def want_igmp_events(self, enable=1):
2222 return self.api(self.papi.want_igmp_events, {'enable': enable,
2223 'pid': os.getpid()})
2231 interface_id=0xFFFFFFFF):
2234 :param lb: load balance
2235 :param use_custom_mac: use custom mac
2236 :param mac_address: mac address
2237 :param interface_id: custom interface ID
2240 self.papi.bond_create,
2243 'use_custom_mac': use_custom_mac,
2244 'mac_address': mac_address,
2248 def pipe_delete(self, parent_sw_if_index):
2249 return self.api(self.papi.pipe_delete,
2250 {'parent_sw_if_index': parent_sw_if_index})
2264 return self.api(self.papi.memif_create,
2267 'rx_queues': rx_queues,
2268 'tx_queues': tx_queues,
2270 'socket_id': socket_id,
2272 'ring_size': ring_size,
2273 'buffer_size': buffer_size,
2274 'hw_addr': hw_addr})
2276 def svs_table_add_del(self, af, table_id, is_add=1):
2277 return self.api(self.papi.svs_table_add_del,
2279 'table_id': table_id,
2284 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2285 return self.api(self.papi.svs_route_add_del,
2287 'table_id': table_id,
2288 'source_table_id': src_table_id,
2293 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2294 return self.api(self.papi.svs_enable_disable,
2297 'table_id': table_id,
2298 'sw_if_index': sw_if_index,
2299 'is_enable': is_enable,