5 from collections import deque
7 # Sphinx creates auto-generated documentation by importing the python source
8 # files and collecting the docstrings from them. The NO_VPP_PAPI flag allows
9 # the vpp_papi_provider.py file to be importable without having to build
10 # the whole vpp api if the user only wishes to generate the test documentation.
13 no_vpp_papi = os.getenv("NO_VPP_PAPI")
14 if no_vpp_papi == "1":
20 from vpp_papi import VPP
22 # from vnet/vnet/mpls/mpls_types.h
23 MPLS_IETF_MAX_LABEL = 0xfffff
24 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
31 class UnexpectedApiReturnValueError(Exception):
32 """ exception raised when the API return value is unexpected """
36 class VppPapiProvider(object):
37 """VPP-api provider using vpp-papi
39 @property hook: hook object providing before and after api/cli hooks
42 _zero, _negative = range(2)
44 def __init__(self, name, shm_prefix, test_class):
45 self.hook = Hook("vpp-papi-provider")
47 self.shm_prefix = shm_prefix
48 self.test_class = test_class
49 self._expect_api_retval = self._zero
50 self._expect_stack = []
53 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
54 for root, dirnames, filenames in os.walk(install_dir):
55 for filename in fnmatch.filter(filenames, '*.api.json'):
56 jsonfiles.append(os.path.join(root, filename))
58 self.vpp = VPP(jsonfiles, logger=test_class.logger)
59 self._events = deque()
64 def expect_negative_api_retval(self):
65 """ Expect API failure """
66 self._expect_stack.append(self._expect_api_retval)
67 self._expect_api_retval = self._negative
70 def expect_zero_api_retval(self):
71 """ Expect API success """
72 self._expect_stack.append(self._expect_api_retval)
73 self._expect_api_retval = self._zero
76 def __exit__(self, exc_type, exc_value, traceback):
77 self._expect_api_retval = self._expect_stack.pop()
79 def register_hook(self, hook):
80 """Replace hook registration with new hook
87 def collect_events(self):
88 """ Collect all events from the internal queue and clear the queue. """
90 self._events = deque()
93 def wait_for_event(self, timeout, name=None):
94 """ Wait for and return next event. """
96 self.test_class.logger.debug("Expecting event within %ss",
99 self.test_class.logger.debug("Expecting event '%s' within %ss",
102 self.test_class.logger.debug("Not waiting, event already queued")
103 limit = time.time() + timeout
104 while time.time() < limit:
106 e = self._events.popleft()
107 if name and type(e).__name__ != name:
109 "Unexpected event received: %s, expected: %s" %
110 (type(e).__name__, name))
111 self.test_class.logger.debug("Returning event %s:%s" %
114 time.sleep(0) # yield
115 raise Exception("Event did not occur within timeout")
117 def __call__(self, name, event):
118 """ Enqueue event in the internal event queue. """
119 # FIXME use the name instead of relying on type(e).__name__ ?
120 # FIXME #2 if this throws, it is eaten silently, Ole?
121 self.test_class.logger.debug("New event: %s: %s" % (name, event))
122 self._events.append(event)
125 """Connect the API to VPP"""
126 self.vpp.connect(self.name, self.shm_prefix)
127 self.papi = self.vpp.api
128 self.vpp.register_event_callback(self)
130 def disconnect(self):
131 """Disconnect the API from VPP"""
132 self.vpp.disconnect()
134 def api(self, api_fn, api_args, expected_retval=0):
135 """ Call API function and check it's return value.
136 Call the appropriate hooks before and after the API call
138 :param api_fn: API function to call
139 :param api_args: tuple of API function arguments
140 :param expected_retval: Expected return value (Default value = 0)
141 :returns: reply from the API
144 self.hook.before_api(api_fn.__name__, api_args)
145 reply = api_fn(**api_args)
146 if self._expect_api_retval == self._negative:
147 if hasattr(reply, 'retval') and reply.retval >= 0:
148 msg = "API call passed unexpectedly: expected negative "\
149 "return value instead of %d in %s" % \
150 (reply.retval, repr(reply))
151 self.test_class.logger.info(msg)
152 raise UnexpectedApiReturnValueError(msg)
153 elif self._expect_api_retval == self._zero:
154 if hasattr(reply, 'retval') and reply.retval != expected_retval:
155 msg = "API call failed, expected %d return value instead "\
156 "of %d in %s" % (expected_retval, reply.retval,
158 self.test_class.logger.info(msg)
159 raise UnexpectedApiReturnValueError(msg)
161 raise Exception("Internal error, unexpected value for "
162 "self._expect_api_retval %s" %
163 self._expect_api_retval)
164 self.hook.after_api(api_fn.__name__, api_args)
168 """ Execute a CLI, calling the before/after hooks appropriately.
170 :param cli: CLI to execute
174 self.hook.before_cli(cli)
176 r = self.papi.cli_inband(length=len(cli), cmd=cli)
177 self.hook.after_cli(cli)
178 if hasattr(r, 'reply'):
179 return r.reply.decode().rstrip('\x00')
181 def ppcli(self, cli):
182 """ Helper method to print CLI command in case of info logging level.
184 :param cli: CLI to execute
187 return cli + "\n" + str(self.cli(cli))
189 def _convert_mac(self, mac):
190 return int(mac.replace(":", ""), 16) << 16
192 def show_version(self):
194 return self.api(self.papi.show_version, {})
196 def pg_create_interface(self, pg_index):
202 return self.api(self.papi.pg_create_interface,
203 {"interface_id": pg_index})
205 def sw_interface_dump(self, filter=None):
208 :param filter: (Default value = None)
211 if filter is not None:
212 args = {"name_filter_valid": 1, "name_filter": filter}
215 return self.api(self.papi.sw_interface_dump, args)
217 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
218 """ Set the IPvX Table-id for the Interface
225 return self.api(self.papi.sw_interface_set_table,
226 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
229 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
230 is_ipv6=0, is_add=1, del_all=0):
233 :param addr: param is_ipv6: (Default value = 0)
236 :param is_ipv6: (Default value = 0)
237 :param is_add: (Default value = 1)
238 :param del_all: (Default value = 0)
241 return self.api(self.papi.sw_interface_add_del_address,
242 {'sw_if_index': sw_if_index,
246 'address_length': addr_len,
249 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
251 """ Set the Interface to be unnumbered
253 :param is_add: (Default value = 1)
254 :param sw_if_index - interface That will be unnumbered
255 :param ip_sw_if_index - interface with an IP addres
258 return self.api(self.papi.sw_interface_set_unnumbered,
259 {'sw_if_index': ip_sw_if_index,
260 'unnumbered_sw_if_index': sw_if_index,
263 def sw_interface_enable_disable_mpls(self, sw_if_index,
266 Enable/Disable MPLS on the interface
268 :param is_enable: (Default value = 1)
271 return self.api(self.papi.sw_interface_set_mpls_enable,
272 {'sw_if_index': sw_if_index,
273 'enable': is_enable})
275 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
276 return self.api(self.papi.sw_interface_ip6nd_ra_config,
277 {'sw_if_index': sw_if_index,
278 'suppress': suppress})
280 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
281 return self.api(self.papi.ip6nd_proxy_add_del,
283 'sw_if_index': sw_if_index,
286 def ip6_sw_interface_ra_config(self, sw_if_index,
290 return self.api(self.papi.sw_interface_ip6nd_ra_config,
291 {'sw_if_index': sw_if_index,
293 'suppress': suppress,
294 'send_unicast': send_unicast})
296 def ip6_sw_interface_ra_prefix(self,
306 val_lifetime=0xffffffff,
307 pref_lifetime=0xffffffff):
308 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
309 {'sw_if_index': sw_if_index,
311 'address_length': address_length,
312 'use_default': use_default,
313 'no_advertise': no_advertise,
314 'off_link': off_link,
315 'no_autoconfig': no_autoconfig,
316 'no_onlink': no_onlink,
318 'val_lifetime': val_lifetime,
319 'pref_lifetime': pref_lifetime})
321 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
323 Enable/Disable An interface for IPv6
325 return self.api(self.papi.sw_interface_ip6_enable_disable,
326 {'sw_if_index': sw_if_index,
329 def vxlan_add_del_tunnel(
333 mcast_sw_if_index=0xFFFFFFFF,
337 decap_next_index=0xFFFFFFFF,
343 :param is_add: (Default value = 1)
344 :param is_ipv6: (Default value = 0)
345 :param encap_vrf_id: (Default value = 0)
346 :param decap_next_index: (Default value = 0xFFFFFFFF)
347 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
348 :param vni: (Default value = 0)
351 return self.api(self.papi.vxlan_add_del_tunnel,
354 'src_address': src_addr,
355 'dst_address': dst_addr,
356 'mcast_sw_if_index': mcast_sw_if_index,
357 'encap_vrf_id': encap_vrf_id,
358 'decap_next_index': decap_next_index,
361 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
362 learn=1, arp_term=0, is_add=1):
363 """Create/delete bridge domain.
365 :param int bd_id: Bridge domain index.
366 :param int flood: Enable/disable bcast/mcast flooding in the BD.
368 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
370 :param int forward: Enable/disable forwarding on all interfaces in
371 the BD. (Default value = 1)
372 :param int learn: Enable/disable learning on all interfaces in the BD.
374 :param int arp_term: Enable/disable arp termination in the BD.
376 :param int is_add: Add or delete flag. (Default value = 1)
378 return self.api(self.papi.bridge_domain_add_del,
381 'uu_flood': uu_flood,
384 'arp_term': arp_term,
387 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
388 filter_mac=0, bvi_mac=0):
389 """Create/delete L2 FIB entry.
391 :param str mac: MAC address to create FIB entry for.
392 :param int bd_id: Bridge domain index.
393 :param int sw_if_index: Software interface index of the interface.
394 :param int is_add: Add or delete flag. (Default value = 1)
395 :param int static_mac: Set to 1 to create static MAC entry.
397 :param int filter_mac: Set to 1 to drop packet that's source or
398 destination MAC address contains defined MAC address.
400 :param int bvi_mac: Set to 1 to create entry that points to BVI
401 interface. (Default value = 0)
403 return self.api(self.papi.l2fib_add_del,
404 {'mac': self._convert_mac(mac),
406 'sw_if_index': sw_if_index,
408 'static_mac': static_mac,
409 'filter_mac': filter_mac,
412 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
413 shg=0, bvi=0, enable=1):
414 """Add/remove interface to/from bridge domain.
416 :param int sw_if_index: Software interface index of the interface.
417 :param int bd_id: Bridge domain index.
418 :param int shg: Split-horizon group index. (Default value = 0)
419 :param int bvi: Set interface as a bridge group virtual interface.
421 :param int enable: Add or remove interface. (Default value = 1)
423 return self.api(self.papi.sw_interface_set_l2_bridge,
424 {'rx_sw_if_index': sw_if_index,
430 def bridge_flags(self, bd_id, is_set, feature_bitmap):
431 """Enable/disable required feature of the bridge domain with defined ID.
433 :param int bd_id: Bridge domain ID.
434 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
435 :param int feature_bitmap: Bitmap value of the feature to be set:
439 - uu-flood (1 << 3) or
442 return self.api(self.papi.bridge_flags,
445 'feature_bitmap': feature_bitmap})
447 def bridge_domain_dump(self, bd_id=0):
450 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
451 existing bridge domains returned)
452 :return: Dictionary of bridge domain(s) data.
454 return self.api(self.papi.bridge_domain_dump,
457 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
459 """Create or delete unidirectional cross-connect from Tx interface to
462 :param int rx_sw_if_index: Software interface index of Rx interface.
463 :param int tx_sw_if_index: Software interface index of Tx interface.
464 :param int enable: Create cross-connect if equal to 1, delete
465 cross-connect if equal to 0.
468 return self.api(self.papi.sw_interface_set_l2_xconnect,
469 {'rx_sw_if_index': rx_sw_if_index,
470 'tx_sw_if_index': tx_sw_if_index,
473 def sw_interface_set_l2_tag_rewrite(
480 """L2 interface vlan tag rewrite configure request
481 :param client_index - opaque cookie to identify the sender
482 :param context - sender context, to match reply w/ request
483 :param sw_if_index - interface the operation is applied to
484 :param vtr_op - Choose from l2_vtr_op_t enum values
485 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
486 :param tag1 - Needed for any push or translate vtr op
487 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
490 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
491 {'sw_if_index': sw_if_index,
497 def sw_interface_set_flags(self, sw_if_index, admin_up_down,
498 link_up_down=0, deleted=0):
501 :param admin_up_down:
503 :param link_up_down: (Default value = 0)
504 :param deleted: (Default value = 0)
507 return self.api(self.papi.sw_interface_set_flags,
508 {'sw_if_index': sw_if_index,
509 'admin_up_down': admin_up_down,
510 'link_up_down': link_up_down,
513 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
514 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
515 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
516 """Create subinterface
517 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
519 :param sub_id: param inner_vlan:
523 :param no_tags: (Default value = 0)
524 :param one_tag: (Default value = 0)
525 :param two_tags: (Default value = 0)
526 :param dot1ad: (Default value = 0)
527 :param exact_match: (Default value = 0)
528 :param default_sub: (Default value = 0)
529 :param outer_vlan_id_any: (Default value = 0)
530 :param inner_vlan_id_any: (Default value = 0)
534 self.papi.create_subif,
535 {'sw_if_index': sw_if_index,
539 'two_tags': two_tags,
541 'exact_match': exact_match,
542 'default_sub': default_sub,
543 'outer_vlan_id_any': outer_vlan_id_any,
544 'inner_vlan_id_any': inner_vlan_id_any,
545 'outer_vlan_id': outer_vlan,
546 'inner_vlan_id': inner_vlan})
548 def delete_subif(self, sw_if_index):
549 """Delete subinterface
553 return self.api(self.papi.delete_subif,
554 {'sw_if_index': sw_if_index})
556 def create_vlan_subif(self, sw_if_index, vlan):
563 return self.api(self.papi.create_vlan_subif,
564 {'sw_if_index': sw_if_index,
567 def create_loopback(self, mac=''):
570 :param mac: (Optional)
572 return self.api(self.papi.create_loopback,
573 {'mac_address': mac})
575 def delete_loopback(self, sw_if_index):
576 return self.api(self.papi.delete_loopback,
577 {'sw_if_index': sw_if_index, })
579 def ip_add_del_route(
584 next_hop_sw_if_index=0xFFFFFFFF,
588 next_hop_n_out_labels=0,
589 next_hop_out_label_stack=[],
590 next_hop_via_label=MPLS_LABEL_INVALID,
591 create_vrf_if_needed=0,
593 is_resolve_attached=0,
594 classify_table_index=0xFFFFFFFF,
606 :param dst_address_length:
607 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
609 :param next_hop_address:
610 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
611 :param vrf_id: (Default value = 0)
612 :param lookup_in_vrf: (Default value = 0)
613 :param classify_table_index: (Default value = 0xFFFFFFFF)
614 :param create_vrf_if_needed: (Default value = 0)
615 :param is_add: (Default value = 1)
616 :param is_drop: (Default value = 0)
617 :param is_ipv6: (Default value = 0)
618 :param is_local: (Default value = 0)
619 :param is_classify: (Default value = 0)
620 :param is_multipath: (Default value = 0)
621 :param is_resolve_host: (Default value = 0)
622 :param is_resolve_attached: (Default value = 0)
623 :param not_last: (Default value = 0)
624 :param next_hop_weight: (Default value = 1)
629 self.papi.ip_add_del_route,
630 {'next_hop_sw_if_index': next_hop_sw_if_index,
631 'table_id': table_id,
632 'classify_table_index': classify_table_index,
633 'next_hop_table_id': next_hop_table_id,
634 'create_vrf_if_needed': create_vrf_if_needed,
637 'is_unreach': is_unreach,
638 'is_prohibit': is_prohibit,
640 'is_local': is_local,
641 'is_classify': is_classify,
642 'is_multipath': is_multipath,
643 'is_resolve_host': is_resolve_host,
644 'is_resolve_attached': is_resolve_attached,
645 'not_last': not_last,
646 'next_hop_weight': next_hop_weight,
647 'dst_address_length': dst_address_length,
648 'dst_address': dst_address,
649 'next_hop_address': next_hop_address,
650 'next_hop_n_out_labels': next_hop_n_out_labels,
651 'next_hop_via_label': next_hop_via_label,
652 'next_hop_out_label_stack': next_hop_out_label_stack})
654 def ip_fib_dump(self):
655 return self.api(self.papi.ip_fib_dump, {})
657 def ip6_fib_dump(self):
658 return self.api(self.papi.ip6_fib_dump, {})
660 def ip_neighbor_add_del(self,
669 """ Add neighbor MAC to IPv4 or IPv6 address.
674 :param is_add: (Default value = 1)
675 :param is_ipv6: (Default value = 0)
676 :param is_static: (Default value = 0)
677 :param is_no_adj_fib: (Default value = 0)
681 self.papi.ip_neighbor_add_del,
682 {'sw_if_index': sw_if_index,
685 'is_static': is_static,
686 'is_no_adj_fib': is_no_adj_fib,
687 'mac_address': mac_address,
688 'dst_address': dst_address
692 def ip_neighbor_dump(self,
695 """ Return IP neighbor dump.
698 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
702 self.papi.ip_neighbor_dump,
704 'sw_if_index': sw_if_index
708 def proxy_arp_add_del(self,
713 """ Config Proxy Arp Range.
715 :param low_address: Start address in the rnage to Proxy for
716 :param hi_address: End address in the rnage to Proxy for
717 :param vrf_id: The VRF/table in which to proxy
721 self.papi.proxy_arp_add_del,
724 'low_address': low_address,
725 'hi_address': hi_address,
729 def proxy_arp_intfc_enable_disable(self,
732 """ Enable/Disable an interface for proxy ARP requests
734 :param sw_if_index: Interface
735 :param enable_disable: Enable/Disable
739 self.papi.proxy_arp_intfc_enable_disable,
740 {'sw_if_index': sw_if_index,
741 'enable_disable': is_enable
749 """ Reset VRF (remove all routes etc.) request.
751 :param int vrf_id: ID of the FIB table / VRF to reset.
752 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
766 """ Reset VRF (remove all routes etc.) request.
768 :param int vrf_id: ID of the FIB table / VRF to reset.
769 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
784 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
793 def sw_interface_span_enable_disable(
794 self, sw_if_index_from, sw_if_index_to, state=1):
797 :param sw_if_index_from:
798 :param sw_if_index_to:
801 return self.api(self.papi.sw_interface_span_enable_disable,
802 {'sw_if_index_from': sw_if_index_from,
803 'sw_if_index_to': sw_if_index_to,
806 def gre_tunnel_add_del(self,
817 :param outer_fib_id: (Default value = 0)
818 :param is_add: (Default value = 1)
819 :param is_ipv6: (Default value = 0)
820 :param is_teb: (Default value = 0)
824 self.papi.gre_add_del_tunnel,
828 'src_address': src_address,
829 'dst_address': dst_address,
830 'outer_fib_id': outer_fib_id}
833 def mpls_fib_dump(self):
834 return self.api(self.papi.mpls_fib_dump, {})
836 def mpls_route_add_del(
840 next_hop_proto_is_ip4,
842 next_hop_sw_if_index=0xFFFFFFFF,
846 next_hop_n_out_labels=0,
847 next_hop_out_label_stack=[],
848 next_hop_via_label=MPLS_LABEL_INVALID,
849 create_vrf_if_needed=0,
851 is_resolve_attached=0,
858 classify_table_index=0xFFFFFFFF,
863 :param dst_address_length:
864 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
866 :param next_hop_address:
867 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
868 :param vrf_id: (Default value = 0)
869 :param lookup_in_vrf: (Default value = 0)
870 :param classify_table_index: (Default value = 0xFFFFFFFF)
871 :param create_vrf_if_needed: (Default value = 0)
872 :param is_add: (Default value = 1)
873 :param is_drop: (Default value = 0)
874 :param is_ipv6: (Default value = 0)
875 :param is_local: (Default value = 0)
876 :param is_classify: (Default value = 0)
877 :param is_multipath: (Default value = 0)
878 :param is_multicast: (Default value = 0)
879 :param is_resolve_host: (Default value = 0)
880 :param is_resolve_attached: (Default value = 0)
881 :param not_last: (Default value = 0)
882 :param next_hop_weight: (Default value = 1)
887 self.papi.mpls_route_add_del,
890 'mr_table_id': table_id,
891 'mr_classify_table_index': classify_table_index,
892 'mr_create_table_if_needed': create_vrf_if_needed,
894 'mr_is_classify': is_classify,
895 'mr_is_multipath': is_multipath,
896 'mr_is_multicast': is_multicast,
897 'mr_is_resolve_host': is_resolve_host,
898 'mr_is_resolve_attached': is_resolve_attached,
899 'mr_is_interface_rx': is_interface_rx,
900 'mr_is_rpf_id': is_rpf_id,
901 'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
902 'mr_next_hop_weight': next_hop_weight,
903 'mr_next_hop': next_hop_address,
904 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
905 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
906 'mr_next_hop_table_id': next_hop_table_id,
907 'mr_next_hop_via_label': next_hop_via_label,
908 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
910 def mpls_ip_bind_unbind(
918 create_vrf_if_needed=0,
923 self.papi.mpls_ip_bind_unbind,
924 {'mb_mpls_table_id': table_id,
926 'mb_ip_table_id': ip_table_id,
927 'mb_create_table_if_needed': create_vrf_if_needed,
928 'mb_is_bind': is_bind,
930 'mb_address_length': dst_address_length,
931 'mb_address': dst_address})
933 def mpls_tunnel_add_del(
936 next_hop_proto_is_ip4,
938 next_hop_sw_if_index=0xFFFFFFFF,
941 next_hop_n_out_labels=0,
942 next_hop_out_label_stack=[],
943 next_hop_via_label=MPLS_LABEL_INVALID,
944 create_vrf_if_needed=0,
950 :param dst_address_length:
951 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
953 :param next_hop_address:
954 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
955 :param vrf_id: (Default value = 0)
956 :param lookup_in_vrf: (Default value = 0)
957 :param classify_table_index: (Default value = 0xFFFFFFFF)
958 :param create_vrf_if_needed: (Default value = 0)
959 :param is_add: (Default value = 1)
960 :param is_drop: (Default value = 0)
961 :param is_ipv6: (Default value = 0)
962 :param is_local: (Default value = 0)
963 :param is_classify: (Default value = 0)
964 :param is_multipath: (Default value = 0)
965 :param is_resolve_host: (Default value = 0)
966 :param is_resolve_attached: (Default value = 0)
967 :param next_hop_weight: (Default value = 1)
968 :param is_multicast: (Default value = 0)
972 self.papi.mpls_tunnel_add_del,
973 {'mt_sw_if_index': tun_sw_if_index,
975 'mt_l2_only': l2_only,
976 'mt_is_multicast': is_multicast,
977 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
978 'mt_next_hop_weight': next_hop_weight,
979 'mt_next_hop': next_hop_address,
980 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
981 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
982 'mt_next_hop_table_id': next_hop_table_id,
983 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
985 def snat_interface_add_del_feature(
990 """Enable/disable S-NAT feature on the interface
992 :param sw_if_index: Software index of the interface
993 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
994 :param is_add: 1 if add, 0 if delete (Default value = 1)
997 self.papi.snat_interface_add_del_feature,
999 'is_inside': is_inside,
1000 'sw_if_index': sw_if_index})
1002 def snat_add_static_mapping(
1006 external_sw_if_index=0xFFFFFFFF,
1014 """Add/delete S-NAT static mapping
1016 :param local_ip: Local IP address
1017 :param external_ip: External IP address
1018 :param external_sw_if_index: External interface instead of IP address
1019 :param local_port: Local port number (Default value = 0)
1020 :param external_port: External port number (Default value = 0)
1021 :param addr_only: 1 if address only mapping, 0 if address and port
1022 :param vrf_id: VRF ID
1023 :param protocol: IP protocol (Default value = 0)
1024 :param is_add: 1 if add, 0 if delete (Default value = 1)
1025 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1028 self.papi.snat_add_static_mapping,
1031 'addr_only': addr_only,
1032 'local_ip_address': local_ip,
1033 'external_ip_address': external_ip,
1034 'local_port': local_port,
1035 'external_port': external_port,
1036 'external_sw_if_index': external_sw_if_index,
1038 'protocol': protocol})
1040 def snat_add_address_range(
1047 """Add/del S-NAT address range
1049 :param first_ip_address: First IP address
1050 :param last_ip_address: Last IP address
1051 :param vrf_id: VRF id for the address range
1052 :param is_add: 1 if add, 0 if delete (Default value = 1)
1053 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1056 self.papi.snat_add_address_range,
1058 'first_ip_address': first_ip_address,
1059 'last_ip_address': last_ip_address,
1063 def snat_address_dump(self):
1064 """Dump S-NAT addresses
1065 :return: Dictionary of S-NAT addresses
1067 return self.api(self.papi.snat_address_dump, {})
1069 def snat_interface_dump(self):
1070 """Dump interfaces with S-NAT feature
1071 :return: Dictionary of interfaces with S-NAT feature
1073 return self.api(self.papi.snat_interface_dump, {})
1075 def snat_static_mapping_dump(self):
1076 """Dump S-NAT static mappings
1077 :return: Dictionary of S-NAT static mappings
1079 return self.api(self.papi.snat_static_mapping_dump, {})
1081 def snat_show_config(self):
1082 """Show S-NAT config
1083 :return: S-NAT config parameters
1085 return self.api(self.papi.snat_show_config, {})
1087 def snat_add_interface_addr(
1091 """Add/del S-NAT address from interface
1093 :param sw_if_index: Software index of the interface
1094 :param is_add: 1 if add, 0 if delete (Default value = 1)
1096 return self.api(self.papi.snat_add_del_interface_addr,
1097 {'is_add': is_add, 'sw_if_index': sw_if_index})
1099 def snat_interface_addr_dump(self):
1100 """Dump S-NAT addresses interfaces
1101 :return: Dictionary of S-NAT addresses interfaces
1103 return self.api(self.papi.snat_interface_addr_dump, {})
1110 """Enable/disable S-NAT IPFIX logging
1112 :param domain_id: Observation domain ID (Default value = 1)
1113 :param src_port: Source port number (Default value = 4739)
1114 :param enable: 1 if enable, 0 if disable (Default value = 1)
1117 self.papi.snat_ipfix_enable_disable,
1118 {'domain_id': domain_id,
1119 'src_port': src_port,
1122 def snat_user_session_dump(
1127 """Dump S-NAT user's sessions
1129 :param ip_address: ip adress of the user to be dumped
1130 :param cpu_index: cpu_index on which the user is
1131 :param vrf_id: VRF ID
1132 :return: Dictionary of S-NAT sessions
1135 self.papi.snat_user_session_dump,
1136 {'ip_address': ip_address,
1140 def snat_user_dump(self):
1143 :return: Dictionary of S-NAT users
1145 return self.api(self.papi.snat_user_dump, {})
1147 def snat_add_det_map(
1154 """Add/delete S-NAT deterministic mapping
1156 :param is_add - 1 if add, 0 if delete
1157 :param in_addr - inside IP address
1158 :param in_plen - inside IP address prefix length
1159 :param out_addr - outside IP address
1160 :param out_plen - outside IP address prefix length
1163 self.papi.snat_add_det_map,
1167 'out_addr': out_addr,
1168 'out_plen': out_plen})
1170 def snat_det_forward(
1173 """Get outside address and port range from inside address
1175 :param in_addr - inside IP address
1178 self.papi.snat_det_forward,
1179 {'in_addr': in_addr})
1181 def snat_det_reverse(
1185 """Get inside address from outside address and port
1187 :param out_addr - outside IP address
1188 :param out_port - outside port
1191 self.papi.snat_det_reverse,
1192 {'out_addr': out_addr,
1193 'out_port': out_port})
1195 def snat_det_map_dump(self):
1196 """Dump S-NAT deterministic mappings
1198 :return: Dictionary of S-NAT deterministic mappings
1200 return self.api(self.papi.snat_det_map_dump, {})
1202 def snat_det_set_timeouts(
1205 tcp_established=7440,
1208 """Set values of timeouts for deterministic NAT (in seconds)
1210 :param udp - UDP timeout (Default value = 300)
1211 :param tcp_established - TCP established timeout (Default value = 7440)
1212 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1213 :param icmp - ICMP timeout (Default value = 60)
1216 self.papi.snat_det_set_timeouts,
1218 'tcp_established': tcp_established,
1219 'tcp_transitory': tcp_transitory,
1222 def snat_det_get_timeouts(self):
1223 """Get values of timeouts for deterministic NAT
1225 :return: Timeouts for deterministic NAT (in seconds)
1227 return self.api(self.papi.snat_det_get_timeouts, {})
1229 def control_ping(self):
1230 self.api(self.papi.control_ping)
1232 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1233 detect_mult, local_addr, peer_addr, is_ipv6=0,
1234 bfd_key_id=None, conf_key_id=None):
1235 if bfd_key_id is None:
1236 return self.api(self.papi.bfd_udp_add,
1238 'sw_if_index': sw_if_index,
1239 'desired_min_tx': desired_min_tx,
1240 'required_min_rx': required_min_rx,
1241 'local_addr': local_addr,
1242 'peer_addr': peer_addr,
1244 'detect_mult': detect_mult,
1247 return self.api(self.papi.bfd_udp_add,
1249 'sw_if_index': sw_if_index,
1250 'desired_min_tx': desired_min_tx,
1251 'required_min_rx': required_min_rx,
1252 'local_addr': local_addr,
1253 'peer_addr': peer_addr,
1255 'detect_mult': detect_mult,
1256 'is_authenticated': 1,
1257 'bfd_key_id': bfd_key_id,
1258 'conf_key_id': conf_key_id,
1261 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1262 detect_mult, local_addr, peer_addr, is_ipv6=0):
1263 return self.api(self.papi.bfd_udp_mod,
1265 'sw_if_index': sw_if_index,
1266 'desired_min_tx': desired_min_tx,
1267 'required_min_rx': required_min_rx,
1268 'local_addr': local_addr,
1269 'peer_addr': peer_addr,
1271 'detect_mult': detect_mult,
1274 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1275 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1277 return self.api(self.papi.bfd_udp_auth_activate,
1279 'sw_if_index': sw_if_index,
1280 'local_addr': local_addr,
1281 'peer_addr': peer_addr,
1283 'is_delayed': 1 if is_delayed else 0,
1284 'bfd_key_id': bfd_key_id,
1285 'conf_key_id': conf_key_id,
1288 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1289 is_ipv6=0, is_delayed=False):
1290 return self.api(self.papi.bfd_udp_auth_deactivate,
1292 'sw_if_index': sw_if_index,
1293 'local_addr': local_addr,
1294 'peer_addr': peer_addr,
1296 'is_delayed': 1 if is_delayed else 0,
1299 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1300 return self.api(self.papi.bfd_udp_del,
1302 'sw_if_index': sw_if_index,
1303 'local_addr': local_addr,
1304 'peer_addr': peer_addr,
1308 def bfd_udp_session_dump(self):
1309 return self.api(self.papi.bfd_udp_session_dump, {})
1311 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1312 peer_addr, is_ipv6=0):
1313 return self.api(self.papi.bfd_udp_session_set_flags, {
1314 'admin_up_down': admin_up_down,
1315 'sw_if_index': sw_if_index,
1316 'local_addr': local_addr,
1317 'peer_addr': peer_addr,
1321 def want_bfd_events(self, enable_disable=1):
1322 return self.api(self.papi.want_bfd_events, {
1323 'enable_disable': enable_disable,
1327 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1328 return self.api(self.papi.bfd_auth_set_key, {
1329 'conf_key_id': conf_key_id,
1330 'auth_type': auth_type,
1332 'key_len': len(key),
1335 def bfd_auth_del_key(self, conf_key_id):
1336 return self.api(self.papi.bfd_auth_del_key, {
1337 'conf_key_id': conf_key_id,
1340 def bfd_auth_keys_dump(self):
1341 return self.api(self.papi.bfd_auth_keys_dump, {})
1343 def bfd_udp_set_echo_source(self, sw_if_index):
1344 return self.api(self.papi.bfd_udp_set_echo_source,
1345 {'sw_if_index': sw_if_index})
1347 def bfd_udp_del_echo_source(self):
1348 return self.api(self.papi.bfd_udp_del_echo_source, {})
1350 def classify_add_del_table(
1355 table_index=0xFFFFFFFF,
1357 memory_size=2097152,
1359 next_table_index=0xFFFFFFFF,
1360 miss_next_index=0xFFFFFFFF,
1361 current_data_flag=0,
1362 current_data_offset=0):
1366 :param match_n_vectors: (Default value = 1)
1367 :param table_index: (Default value = 0xFFFFFFFF)
1368 :param nbuckets: (Default value = 2)
1369 :param memory_size: (Default value = 2097152)
1370 :param skip_n_vectors: (Default value = 0)
1371 :param next_table_index: (Default value = 0xFFFFFFFF)
1372 :param miss_next_index: (Default value = 0xFFFFFFFF)
1373 :param current_data_flag: (Default value = 0)
1374 :param current_data_offset: (Default value = 0)
1378 self.papi.classify_add_del_table,
1380 'table_index': table_index,
1381 'nbuckets': nbuckets,
1382 'memory_size': memory_size,
1383 'skip_n_vectors': skip_n_vectors,
1384 'match_n_vectors': match_n_vectors,
1385 'next_table_index': next_table_index,
1386 'miss_next_index': miss_next_index,
1387 'current_data_flag': current_data_flag,
1388 'current_data_offset': current_data_offset,
1391 def classify_add_del_session(
1396 opaque_index=0xFFFFFFFF,
1397 hit_next_index=0xFFFFFFFF,
1405 :param opaque_index: (Default value = 0xFFFFFFFF)
1406 :param hit_next_index: (Default value = 0xFFFFFFFF)
1407 :param advance: (Default value = 0)
1408 :param action: (Default value = 0)
1409 :param metadata: (Default value = 0)
1413 self.papi.classify_add_del_session,
1415 'table_index': table_index,
1416 'hit_next_index': hit_next_index,
1417 'opaque_index': opaque_index,
1420 'metadata': metadata,
1423 def input_acl_set_interface(
1427 ip4_table_index=0xFFFFFFFF,
1428 ip6_table_index=0xFFFFFFFF,
1429 l2_table_index=0xFFFFFFFF):
1433 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1434 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1435 :param l2_table_index: (Default value = 0xFFFFFFFF)
1439 self.papi.input_acl_set_interface,
1440 {'sw_if_index': sw_if_index,
1441 'ip4_table_index': ip4_table_index,
1442 'ip6_table_index': ip6_table_index,
1443 'l2_table_index': l2_table_index,
1446 def set_ipfix_exporter(
1453 collector_port=4739,
1456 self.papi.set_ipfix_exporter,
1458 'collector_address': collector_address,
1459 'collector_port': collector_port,
1460 'src_address': src_address,
1462 'path_mtu': path_mtu,
1463 'template_interval': template_interval,
1464 'udp_checksum': udp_checksum,
1467 def dhcp_proxy_config(self,
1475 self.papi.dhcp_proxy_config,
1477 'rx_vrf_id': rx_table_id,
1478 'server_vrf_id': server_table_id,
1481 'dhcp_server': dhcp_server,
1482 'dhcp_src_address': dhcp_src_address,
1485 def dhcp_proxy_set_vss(self,
1492 self.papi.dhcp_proxy_set_vss,
1501 def ip_mroute_add_del(self,
1506 next_hop_sw_if_index,
1510 create_vrf_if_needed=0,
1517 self.papi.ip_mroute_add_del,
1518 {'next_hop_sw_if_index': next_hop_sw_if_index,
1519 'entry_flags': e_flags,
1520 'itf_flags': i_flags,
1521 'table_id': table_id,
1523 'create_vrf_if_needed': create_vrf_if_needed,
1526 'is_local': is_local,
1527 'grp_address_length': grp_address_length,
1528 'grp_address': grp_address,
1529 'src_address': src_address})
1531 def mfib_signal_dump(self):
1532 return self.api(self.papi.mfib_signal_dump, {})
1534 def ip_mfib_dump(self):
1535 return self.api(self.papi.ip_mfib_dump, {})
1537 def lisp_enable_disable(self, is_enabled):
1539 self.papi.lisp_enable_disable,
1541 'is_en': is_enabled,
1544 def lisp_locator_set(self,
1548 self.papi.lisp_add_del_locator_set,
1551 'locator_set_name': ls_name
1554 def lisp_locator_set_dump(self):
1555 return self.api(self.papi.lisp_locator_set_dump, {})
1557 def lisp_locator(self,
1564 self.papi.lisp_add_del_locator,
1567 'locator_set_name': ls_name,
1568 'sw_if_index': sw_if_index,
1569 'priority': priority,
1573 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1575 self.papi.lisp_locator_dump,
1577 'is_index_set': is_index_set,
1579 'ls_index': ls_index,
1582 def lisp_local_mapping(self,
1592 self.papi.lisp_add_del_local_eid,
1594 'locator_set_name': ls_name,
1596 'eid_type': eid_type,
1598 'prefix_len': prefix_len,
1604 def lisp_eid_table_dump(self,
1612 self.papi.lisp_eid_table_dump,
1615 'prefix_length': prefix_length,
1617 'eid_type': eid_type,
1619 'filter': filter_opt,
1622 def lisp_remote_mapping(self,
1632 self.papi.lisp_add_del_remote_mapping,
1635 'eid_type': eid_type,
1637 'eid_len': eid_prefix_len,
1638 'rloc_num': rlocs_num,
1641 'is_src_dst': is_src_dst,
1644 def lisp_adjacency(self,
1653 self.papi.lisp_add_del_adjacency,
1657 'eid_type': eid_type,
1660 'leid_len': leid_len,
1661 'reid_len': reid_len,
1664 def lisp_adjacencies_get(self, vni=0):
1666 self.papi.lisp_adjacencies_get,
1671 def map_add_domain(self,
1684 self.papi.map_add_domain,
1686 'ip6_prefix': ip6_prefix,
1687 'ip6_prefix_len': ip6_prefix_len,
1688 'ip4_prefix': ip4_prefix,
1689 'ip4_prefix_len': ip4_prefix_len,
1691 'ip6_src_prefix_len': ip6_src_prefix_len,
1692 'ea_bits_len': ea_bits_len,
1693 'psid_offset': psid_offset,
1694 'psid_length': psid_length,
1695 'is_translation': is_translation,