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 set_ip_flow_hash(self,
289 return self.api(self.papi.set_ip_flow_hash,
299 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
300 return self.api(self.papi.ip6nd_proxy_add_del,
302 'sw_if_index': sw_if_index,
305 def ip6_sw_interface_ra_config(self, sw_if_index,
309 return self.api(self.papi.sw_interface_ip6nd_ra_config,
310 {'sw_if_index': sw_if_index,
312 'suppress': suppress,
313 'send_unicast': send_unicast})
315 def ip6_sw_interface_ra_prefix(self,
325 val_lifetime=0xffffffff,
326 pref_lifetime=0xffffffff):
327 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
328 {'sw_if_index': sw_if_index,
330 'address_length': address_length,
331 'use_default': use_default,
332 'no_advertise': no_advertise,
333 'off_link': off_link,
334 'no_autoconfig': no_autoconfig,
335 'no_onlink': no_onlink,
337 'val_lifetime': val_lifetime,
338 'pref_lifetime': pref_lifetime})
340 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
342 Enable/Disable An interface for IPv6
344 return self.api(self.papi.sw_interface_ip6_enable_disable,
345 {'sw_if_index': sw_if_index,
348 def vxlan_add_del_tunnel(
352 mcast_sw_if_index=0xFFFFFFFF,
356 decap_next_index=0xFFFFFFFF,
362 :param is_add: (Default value = 1)
363 :param is_ipv6: (Default value = 0)
364 :param encap_vrf_id: (Default value = 0)
365 :param decap_next_index: (Default value = 0xFFFFFFFF)
366 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
367 :param vni: (Default value = 0)
370 return self.api(self.papi.vxlan_add_del_tunnel,
373 'src_address': src_addr,
374 'dst_address': dst_addr,
375 'mcast_sw_if_index': mcast_sw_if_index,
376 'encap_vrf_id': encap_vrf_id,
377 'decap_next_index': decap_next_index,
380 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
381 learn=1, arp_term=0, is_add=1):
382 """Create/delete bridge domain.
384 :param int bd_id: Bridge domain index.
385 :param int flood: Enable/disable bcast/mcast flooding in the BD.
387 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
389 :param int forward: Enable/disable forwarding on all interfaces in
390 the BD. (Default value = 1)
391 :param int learn: Enable/disable learning on all interfaces in the BD.
393 :param int arp_term: Enable/disable arp termination in the BD.
395 :param int is_add: Add or delete flag. (Default value = 1)
397 return self.api(self.papi.bridge_domain_add_del,
400 'uu_flood': uu_flood,
403 'arp_term': arp_term,
406 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
407 filter_mac=0, bvi_mac=0):
408 """Create/delete L2 FIB entry.
410 :param str mac: MAC address to create FIB entry for.
411 :param int bd_id: Bridge domain index.
412 :param int sw_if_index: Software interface index of the interface.
413 :param int is_add: Add or delete flag. (Default value = 1)
414 :param int static_mac: Set to 1 to create static MAC entry.
416 :param int filter_mac: Set to 1 to drop packet that's source or
417 destination MAC address contains defined MAC address.
419 :param int bvi_mac: Set to 1 to create entry that points to BVI
420 interface. (Default value = 0)
422 return self.api(self.papi.l2fib_add_del,
423 {'mac': self._convert_mac(mac),
425 'sw_if_index': sw_if_index,
427 'static_mac': static_mac,
428 'filter_mac': filter_mac,
431 def l2fib_flush_int(self, sw_if_index):
432 """Flush L2 FIB entries for sw_if_index.
434 :param int sw_if_index: Software interface index of the interface.
436 return self.api(self.papi.l2fib_flush_int,
437 {'sw_if_index': sw_if_index})
439 def l2fib_flush_bd(self, bd_id):
440 """Flush L2 FIB entries for bd_id.
442 :param int sw_if_index: Bridge Domain id.
444 return self.api(self.papi.l2fib_flush_bd,
447 def l2fib_flush_all(self):
450 return self.api(self.papi.l2fib_flush_all, {})
452 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
453 shg=0, bvi=0, enable=1):
454 """Add/remove interface to/from bridge domain.
456 :param int sw_if_index: Software interface index of the interface.
457 :param int bd_id: Bridge domain index.
458 :param int shg: Split-horizon group index. (Default value = 0)
459 :param int bvi: Set interface as a bridge group virtual interface.
461 :param int enable: Add or remove interface. (Default value = 1)
463 return self.api(self.papi.sw_interface_set_l2_bridge,
464 {'rx_sw_if_index': sw_if_index,
470 def bridge_flags(self, bd_id, is_set, feature_bitmap):
471 """Enable/disable required feature of the bridge domain with defined ID.
473 :param int bd_id: Bridge domain ID.
474 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
475 :param int feature_bitmap: Bitmap value of the feature to be set:
479 - uu-flood (1 << 3) or
482 return self.api(self.papi.bridge_flags,
485 'feature_bitmap': feature_bitmap})
487 def bridge_domain_dump(self, bd_id=0):
490 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
491 existing bridge domains returned)
492 :return: Dictionary of bridge domain(s) data.
494 return self.api(self.papi.bridge_domain_dump,
497 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
499 """Create or delete unidirectional cross-connect from Tx interface to
502 :param int rx_sw_if_index: Software interface index of Rx interface.
503 :param int tx_sw_if_index: Software interface index of Tx interface.
504 :param int enable: Create cross-connect if equal to 1, delete
505 cross-connect if equal to 0.
508 return self.api(self.papi.sw_interface_set_l2_xconnect,
509 {'rx_sw_if_index': rx_sw_if_index,
510 'tx_sw_if_index': tx_sw_if_index,
513 def sw_interface_set_l2_tag_rewrite(
520 """L2 interface vlan tag rewrite configure request
521 :param client_index - opaque cookie to identify the sender
522 :param context - sender context, to match reply w/ request
523 :param sw_if_index - interface the operation is applied to
524 :param vtr_op - Choose from l2_vtr_op_t enum values
525 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
526 :param tag1 - Needed for any push or translate vtr op
527 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
530 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
531 {'sw_if_index': sw_if_index,
537 def sw_interface_set_flags(self, sw_if_index, admin_up_down,
538 link_up_down=0, deleted=0):
541 :param admin_up_down:
543 :param link_up_down: (Default value = 0)
544 :param deleted: (Default value = 0)
547 return self.api(self.papi.sw_interface_set_flags,
548 {'sw_if_index': sw_if_index,
549 'admin_up_down': admin_up_down,
550 'link_up_down': link_up_down,
553 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
554 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
555 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
556 """Create subinterface
557 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
559 :param sub_id: param inner_vlan:
563 :param no_tags: (Default value = 0)
564 :param one_tag: (Default value = 0)
565 :param two_tags: (Default value = 0)
566 :param dot1ad: (Default value = 0)
567 :param exact_match: (Default value = 0)
568 :param default_sub: (Default value = 0)
569 :param outer_vlan_id_any: (Default value = 0)
570 :param inner_vlan_id_any: (Default value = 0)
574 self.papi.create_subif,
575 {'sw_if_index': sw_if_index,
579 'two_tags': two_tags,
581 'exact_match': exact_match,
582 'default_sub': default_sub,
583 'outer_vlan_id_any': outer_vlan_id_any,
584 'inner_vlan_id_any': inner_vlan_id_any,
585 'outer_vlan_id': outer_vlan,
586 'inner_vlan_id': inner_vlan})
588 def delete_subif(self, sw_if_index):
589 """Delete subinterface
593 return self.api(self.papi.delete_subif,
594 {'sw_if_index': sw_if_index})
596 def create_vlan_subif(self, sw_if_index, vlan):
603 return self.api(self.papi.create_vlan_subif,
604 {'sw_if_index': sw_if_index,
607 def create_loopback(self, mac=''):
610 :param mac: (Optional)
612 return self.api(self.papi.create_loopback,
613 {'mac_address': mac})
615 def delete_loopback(self, sw_if_index):
616 return self.api(self.papi.delete_loopback,
617 {'sw_if_index': sw_if_index, })
619 def ip_add_del_route(
624 next_hop_sw_if_index=0xFFFFFFFF,
628 next_hop_n_out_labels=0,
629 next_hop_out_label_stack=[],
630 next_hop_via_label=MPLS_LABEL_INVALID,
631 create_vrf_if_needed=0,
633 is_resolve_attached=0,
634 classify_table_index=0xFFFFFFFF,
646 :param dst_address_length:
647 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
649 :param next_hop_address:
650 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
651 :param vrf_id: (Default value = 0)
652 :param lookup_in_vrf: (Default value = 0)
653 :param classify_table_index: (Default value = 0xFFFFFFFF)
654 :param create_vrf_if_needed: (Default value = 0)
655 :param is_add: (Default value = 1)
656 :param is_drop: (Default value = 0)
657 :param is_ipv6: (Default value = 0)
658 :param is_local: (Default value = 0)
659 :param is_classify: (Default value = 0)
660 :param is_multipath: (Default value = 0)
661 :param is_resolve_host: (Default value = 0)
662 :param is_resolve_attached: (Default value = 0)
663 :param not_last: (Default value = 0)
664 :param next_hop_weight: (Default value = 1)
669 self.papi.ip_add_del_route,
670 {'next_hop_sw_if_index': next_hop_sw_if_index,
671 'table_id': table_id,
672 'classify_table_index': classify_table_index,
673 'next_hop_table_id': next_hop_table_id,
674 'create_vrf_if_needed': create_vrf_if_needed,
677 'is_unreach': is_unreach,
678 'is_prohibit': is_prohibit,
680 'is_local': is_local,
681 'is_classify': is_classify,
682 'is_multipath': is_multipath,
683 'is_resolve_host': is_resolve_host,
684 'is_resolve_attached': is_resolve_attached,
685 'not_last': not_last,
686 'next_hop_weight': next_hop_weight,
687 'dst_address_length': dst_address_length,
688 'dst_address': dst_address,
689 'next_hop_address': next_hop_address,
690 'next_hop_n_out_labels': next_hop_n_out_labels,
691 'next_hop_via_label': next_hop_via_label,
692 'next_hop_out_label_stack': next_hop_out_label_stack})
694 def ip_fib_dump(self):
695 return self.api(self.papi.ip_fib_dump, {})
697 def ip6_fib_dump(self):
698 return self.api(self.papi.ip6_fib_dump, {})
700 def ip_neighbor_add_del(self,
709 """ Add neighbor MAC to IPv4 or IPv6 address.
714 :param is_add: (Default value = 1)
715 :param is_ipv6: (Default value = 0)
716 :param is_static: (Default value = 0)
717 :param is_no_adj_fib: (Default value = 0)
721 self.papi.ip_neighbor_add_del,
722 {'sw_if_index': sw_if_index,
725 'is_static': is_static,
726 'is_no_adj_fib': is_no_adj_fib,
727 'mac_address': mac_address,
728 'dst_address': dst_address
732 def ip_neighbor_dump(self,
735 """ Return IP neighbor dump.
738 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
742 self.papi.ip_neighbor_dump,
744 'sw_if_index': sw_if_index
748 def proxy_arp_add_del(self,
753 """ Config Proxy Arp Range.
755 :param low_address: Start address in the rnage to Proxy for
756 :param hi_address: End address in the rnage to Proxy for
757 :param vrf_id: The VRF/table in which to proxy
761 self.papi.proxy_arp_add_del,
764 'low_address': low_address,
765 'hi_address': hi_address,
769 def proxy_arp_intfc_enable_disable(self,
772 """ Enable/Disable an interface for proxy ARP requests
774 :param sw_if_index: Interface
775 :param enable_disable: Enable/Disable
779 self.papi.proxy_arp_intfc_enable_disable,
780 {'sw_if_index': sw_if_index,
781 'enable_disable': is_enable
789 """ Reset VRF (remove all routes etc.) request.
791 :param int vrf_id: ID of the FIB table / VRF to reset.
792 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
806 """ Reset VRF (remove all routes etc.) request.
808 :param int vrf_id: ID of the FIB table / VRF to reset.
809 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
824 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
833 def sw_interface_span_enable_disable(
834 self, sw_if_index_from, sw_if_index_to, state=1):
837 :param sw_if_index_from:
838 :param sw_if_index_to:
841 return self.api(self.papi.sw_interface_span_enable_disable,
842 {'sw_if_index_from': sw_if_index_from,
843 'sw_if_index_to': sw_if_index_to,
846 def gre_tunnel_add_del(self,
857 :param outer_fib_id: (Default value = 0)
858 :param is_add: (Default value = 1)
859 :param is_ipv6: (Default value = 0)
860 :param is_teb: (Default value = 0)
864 self.papi.gre_add_del_tunnel,
868 'src_address': src_address,
869 'dst_address': dst_address,
870 'outer_fib_id': outer_fib_id}
873 def mpls_fib_dump(self):
874 return self.api(self.papi.mpls_fib_dump, {})
876 def mpls_route_add_del(
880 next_hop_proto_is_ip4,
882 next_hop_sw_if_index=0xFFFFFFFF,
886 next_hop_n_out_labels=0,
887 next_hop_out_label_stack=[],
888 next_hop_via_label=MPLS_LABEL_INVALID,
889 create_vrf_if_needed=0,
891 is_resolve_attached=0,
898 classify_table_index=0xFFFFFFFF,
903 :param dst_address_length:
904 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
906 :param next_hop_address:
907 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
908 :param vrf_id: (Default value = 0)
909 :param lookup_in_vrf: (Default value = 0)
910 :param classify_table_index: (Default value = 0xFFFFFFFF)
911 :param create_vrf_if_needed: (Default value = 0)
912 :param is_add: (Default value = 1)
913 :param is_drop: (Default value = 0)
914 :param is_ipv6: (Default value = 0)
915 :param is_local: (Default value = 0)
916 :param is_classify: (Default value = 0)
917 :param is_multipath: (Default value = 0)
918 :param is_multicast: (Default value = 0)
919 :param is_resolve_host: (Default value = 0)
920 :param is_resolve_attached: (Default value = 0)
921 :param not_last: (Default value = 0)
922 :param next_hop_weight: (Default value = 1)
927 self.papi.mpls_route_add_del,
930 'mr_table_id': table_id,
931 'mr_classify_table_index': classify_table_index,
932 'mr_create_table_if_needed': create_vrf_if_needed,
934 'mr_is_classify': is_classify,
935 'mr_is_multipath': is_multipath,
936 'mr_is_multicast': is_multicast,
937 'mr_is_resolve_host': is_resolve_host,
938 'mr_is_resolve_attached': is_resolve_attached,
939 'mr_is_interface_rx': is_interface_rx,
940 'mr_is_rpf_id': is_rpf_id,
941 'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
942 'mr_next_hop_weight': next_hop_weight,
943 'mr_next_hop': next_hop_address,
944 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
945 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
946 'mr_next_hop_table_id': next_hop_table_id,
947 'mr_next_hop_via_label': next_hop_via_label,
948 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
950 def mpls_ip_bind_unbind(
958 create_vrf_if_needed=0,
963 self.papi.mpls_ip_bind_unbind,
964 {'mb_mpls_table_id': table_id,
966 'mb_ip_table_id': ip_table_id,
967 'mb_create_table_if_needed': create_vrf_if_needed,
968 'mb_is_bind': is_bind,
970 'mb_address_length': dst_address_length,
971 'mb_address': dst_address})
973 def mpls_tunnel_add_del(
976 next_hop_proto_is_ip4,
978 next_hop_sw_if_index=0xFFFFFFFF,
981 next_hop_n_out_labels=0,
982 next_hop_out_label_stack=[],
983 next_hop_via_label=MPLS_LABEL_INVALID,
984 create_vrf_if_needed=0,
990 :param dst_address_length:
991 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
993 :param next_hop_address:
994 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
995 :param vrf_id: (Default value = 0)
996 :param lookup_in_vrf: (Default value = 0)
997 :param classify_table_index: (Default value = 0xFFFFFFFF)
998 :param create_vrf_if_needed: (Default value = 0)
999 :param is_add: (Default value = 1)
1000 :param is_drop: (Default value = 0)
1001 :param is_ipv6: (Default value = 0)
1002 :param is_local: (Default value = 0)
1003 :param is_classify: (Default value = 0)
1004 :param is_multipath: (Default value = 0)
1005 :param is_resolve_host: (Default value = 0)
1006 :param is_resolve_attached: (Default value = 0)
1007 :param next_hop_weight: (Default value = 1)
1008 :param is_multicast: (Default value = 0)
1012 self.papi.mpls_tunnel_add_del,
1013 {'mt_sw_if_index': tun_sw_if_index,
1014 'mt_is_add': is_add,
1015 'mt_l2_only': l2_only,
1016 'mt_is_multicast': is_multicast,
1017 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1018 'mt_next_hop_weight': next_hop_weight,
1019 'mt_next_hop': next_hop_address,
1020 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1021 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1022 'mt_next_hop_table_id': next_hop_table_id,
1023 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1025 def snat_interface_add_del_feature(
1030 """Enable/disable S-NAT feature on the interface
1032 :param sw_if_index: Software index of the interface
1033 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1034 :param is_add: 1 if add, 0 if delete (Default value = 1)
1037 self.papi.snat_interface_add_del_feature,
1039 'is_inside': is_inside,
1040 'sw_if_index': sw_if_index})
1042 def snat_add_static_mapping(
1046 external_sw_if_index=0xFFFFFFFF,
1054 """Add/delete S-NAT static mapping
1056 :param local_ip: Local IP address
1057 :param external_ip: External IP address
1058 :param external_sw_if_index: External interface instead of IP address
1059 :param local_port: Local port number (Default value = 0)
1060 :param external_port: External port number (Default value = 0)
1061 :param addr_only: 1 if address only mapping, 0 if address and port
1062 :param vrf_id: VRF ID
1063 :param protocol: IP protocol (Default value = 0)
1064 :param is_add: 1 if add, 0 if delete (Default value = 1)
1065 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1068 self.papi.snat_add_static_mapping,
1071 'addr_only': addr_only,
1072 'local_ip_address': local_ip,
1073 'external_ip_address': external_ip,
1074 'local_port': local_port,
1075 'external_port': external_port,
1076 'external_sw_if_index': external_sw_if_index,
1078 'protocol': protocol})
1080 def snat_add_address_range(
1087 """Add/del S-NAT address range
1089 :param first_ip_address: First IP address
1090 :param last_ip_address: Last IP address
1091 :param vrf_id: VRF id for the address range
1092 :param is_add: 1 if add, 0 if delete (Default value = 1)
1093 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1096 self.papi.snat_add_address_range,
1098 'first_ip_address': first_ip_address,
1099 'last_ip_address': last_ip_address,
1103 def snat_address_dump(self):
1104 """Dump S-NAT addresses
1105 :return: Dictionary of S-NAT addresses
1107 return self.api(self.papi.snat_address_dump, {})
1109 def snat_interface_dump(self):
1110 """Dump interfaces with S-NAT feature
1111 :return: Dictionary of interfaces with S-NAT feature
1113 return self.api(self.papi.snat_interface_dump, {})
1115 def snat_static_mapping_dump(self):
1116 """Dump S-NAT static mappings
1117 :return: Dictionary of S-NAT static mappings
1119 return self.api(self.papi.snat_static_mapping_dump, {})
1121 def snat_show_config(self):
1122 """Show S-NAT config
1123 :return: S-NAT config parameters
1125 return self.api(self.papi.snat_show_config, {})
1127 def snat_add_interface_addr(
1131 """Add/del S-NAT address from interface
1133 :param sw_if_index: Software index of the interface
1134 :param is_add: 1 if add, 0 if delete (Default value = 1)
1136 return self.api(self.papi.snat_add_del_interface_addr,
1137 {'is_add': is_add, 'sw_if_index': sw_if_index})
1139 def snat_interface_addr_dump(self):
1140 """Dump S-NAT addresses interfaces
1141 :return: Dictionary of S-NAT addresses interfaces
1143 return self.api(self.papi.snat_interface_addr_dump, {})
1150 """Enable/disable S-NAT IPFIX logging
1152 :param domain_id: Observation domain ID (Default value = 1)
1153 :param src_port: Source port number (Default value = 4739)
1154 :param enable: 1 if enable, 0 if disable (Default value = 1)
1157 self.papi.snat_ipfix_enable_disable,
1158 {'domain_id': domain_id,
1159 'src_port': src_port,
1162 def snat_user_session_dump(
1167 """Dump S-NAT user's sessions
1169 :param ip_address: ip adress of the user to be dumped
1170 :param cpu_index: cpu_index on which the user is
1171 :param vrf_id: VRF ID
1172 :return: Dictionary of S-NAT sessions
1175 self.papi.snat_user_session_dump,
1176 {'ip_address': ip_address,
1180 def snat_user_dump(self):
1183 :return: Dictionary of S-NAT users
1185 return self.api(self.papi.snat_user_dump, {})
1187 def snat_add_det_map(
1194 """Add/delete S-NAT deterministic mapping
1196 :param is_add - 1 if add, 0 if delete
1197 :param in_addr - inside IP address
1198 :param in_plen - inside IP address prefix length
1199 :param out_addr - outside IP address
1200 :param out_plen - outside IP address prefix length
1203 self.papi.snat_add_det_map,
1207 'out_addr': out_addr,
1208 'out_plen': out_plen})
1210 def snat_det_forward(
1213 """Get outside address and port range from inside address
1215 :param in_addr - inside IP address
1218 self.papi.snat_det_forward,
1219 {'in_addr': in_addr})
1221 def snat_det_reverse(
1225 """Get inside address from outside address and port
1227 :param out_addr - outside IP address
1228 :param out_port - outside port
1231 self.papi.snat_det_reverse,
1232 {'out_addr': out_addr,
1233 'out_port': out_port})
1235 def snat_det_map_dump(self):
1236 """Dump S-NAT deterministic mappings
1238 :return: Dictionary of S-NAT deterministic mappings
1240 return self.api(self.papi.snat_det_map_dump, {})
1242 def snat_det_set_timeouts(
1245 tcp_established=7440,
1248 """Set values of timeouts for deterministic NAT (in seconds)
1250 :param udp - UDP timeout (Default value = 300)
1251 :param tcp_established - TCP established timeout (Default value = 7440)
1252 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1253 :param icmp - ICMP timeout (Default value = 60)
1256 self.papi.snat_det_set_timeouts,
1258 'tcp_established': tcp_established,
1259 'tcp_transitory': tcp_transitory,
1262 def snat_det_get_timeouts(self):
1263 """Get values of timeouts for deterministic NAT
1265 :return: Timeouts for deterministic NAT (in seconds)
1267 return self.api(self.papi.snat_det_get_timeouts, {})
1269 def snat_det_close_session_out(
1276 """Close CGN session using outside address and port
1278 :param out_addr - outside IP address
1279 :param out_port - outside port
1280 :param ext_addr - external host IP address
1281 :param ext_port - external host port
1282 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1285 self.papi.snat_det_close_session_out,
1286 {'out_addr': out_addr,
1287 'out_port': out_port,
1288 'ext_addr': ext_addr,
1289 'ext_port': ext_port,
1292 def snat_det_close_session_in(
1299 """Close CGN session using inside address and port
1301 :param in_addr - inside IP address
1302 :param in_port - inside port
1303 :param ext_addr - external host IP address
1304 :param ext_port - external host port
1305 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1308 self.papi.snat_det_close_session_in,
1309 {'in_addr': in_addr,
1311 'ext_addr': ext_addr,
1312 'ext_port': ext_port,
1315 def snat_det_session_dump(
1319 """Dump S-NAT deterministic sessions belonging to a user
1321 :param user_addr - inside IP address of the user
1322 :param is_ip4: - 1 if address type is IPv4 (Default value = 1)
1323 :return: Dictionary of S-NAT deterministic sessions
1326 self.papi.snat_det_session_dump,
1328 'user_addr': user_addr})
1330 def control_ping(self):
1331 self.api(self.papi.control_ping)
1333 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1334 detect_mult, local_addr, peer_addr, is_ipv6=0,
1335 bfd_key_id=None, conf_key_id=None):
1336 if bfd_key_id is None:
1337 return self.api(self.papi.bfd_udp_add,
1339 'sw_if_index': sw_if_index,
1340 'desired_min_tx': desired_min_tx,
1341 'required_min_rx': required_min_rx,
1342 'local_addr': local_addr,
1343 'peer_addr': peer_addr,
1345 'detect_mult': detect_mult,
1348 return self.api(self.papi.bfd_udp_add,
1350 'sw_if_index': sw_if_index,
1351 'desired_min_tx': desired_min_tx,
1352 'required_min_rx': required_min_rx,
1353 'local_addr': local_addr,
1354 'peer_addr': peer_addr,
1356 'detect_mult': detect_mult,
1357 'is_authenticated': 1,
1358 'bfd_key_id': bfd_key_id,
1359 'conf_key_id': conf_key_id,
1362 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1363 detect_mult, local_addr, peer_addr, is_ipv6=0):
1364 return self.api(self.papi.bfd_udp_mod,
1366 'sw_if_index': sw_if_index,
1367 'desired_min_tx': desired_min_tx,
1368 'required_min_rx': required_min_rx,
1369 'local_addr': local_addr,
1370 'peer_addr': peer_addr,
1372 'detect_mult': detect_mult,
1375 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1376 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1378 return self.api(self.papi.bfd_udp_auth_activate,
1380 'sw_if_index': sw_if_index,
1381 'local_addr': local_addr,
1382 'peer_addr': peer_addr,
1384 'is_delayed': 1 if is_delayed else 0,
1385 'bfd_key_id': bfd_key_id,
1386 'conf_key_id': conf_key_id,
1389 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1390 is_ipv6=0, is_delayed=False):
1391 return self.api(self.papi.bfd_udp_auth_deactivate,
1393 'sw_if_index': sw_if_index,
1394 'local_addr': local_addr,
1395 'peer_addr': peer_addr,
1397 'is_delayed': 1 if is_delayed else 0,
1400 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1401 return self.api(self.papi.bfd_udp_del,
1403 'sw_if_index': sw_if_index,
1404 'local_addr': local_addr,
1405 'peer_addr': peer_addr,
1409 def bfd_udp_session_dump(self):
1410 return self.api(self.papi.bfd_udp_session_dump, {})
1412 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1413 peer_addr, is_ipv6=0):
1414 return self.api(self.papi.bfd_udp_session_set_flags, {
1415 'admin_up_down': admin_up_down,
1416 'sw_if_index': sw_if_index,
1417 'local_addr': local_addr,
1418 'peer_addr': peer_addr,
1422 def want_bfd_events(self, enable_disable=1):
1423 return self.api(self.papi.want_bfd_events, {
1424 'enable_disable': enable_disable,
1428 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1429 return self.api(self.papi.bfd_auth_set_key, {
1430 'conf_key_id': conf_key_id,
1431 'auth_type': auth_type,
1433 'key_len': len(key),
1436 def bfd_auth_del_key(self, conf_key_id):
1437 return self.api(self.papi.bfd_auth_del_key, {
1438 'conf_key_id': conf_key_id,
1441 def bfd_auth_keys_dump(self):
1442 return self.api(self.papi.bfd_auth_keys_dump, {})
1444 def bfd_udp_set_echo_source(self, sw_if_index):
1445 return self.api(self.papi.bfd_udp_set_echo_source,
1446 {'sw_if_index': sw_if_index})
1448 def bfd_udp_del_echo_source(self):
1449 return self.api(self.papi.bfd_udp_del_echo_source, {})
1451 def classify_add_del_table(
1456 table_index=0xFFFFFFFF,
1458 memory_size=2097152,
1460 next_table_index=0xFFFFFFFF,
1461 miss_next_index=0xFFFFFFFF,
1462 current_data_flag=0,
1463 current_data_offset=0):
1467 :param match_n_vectors: (Default value = 1)
1468 :param table_index: (Default value = 0xFFFFFFFF)
1469 :param nbuckets: (Default value = 2)
1470 :param memory_size: (Default value = 2097152)
1471 :param skip_n_vectors: (Default value = 0)
1472 :param next_table_index: (Default value = 0xFFFFFFFF)
1473 :param miss_next_index: (Default value = 0xFFFFFFFF)
1474 :param current_data_flag: (Default value = 0)
1475 :param current_data_offset: (Default value = 0)
1479 self.papi.classify_add_del_table,
1481 'table_index': table_index,
1482 'nbuckets': nbuckets,
1483 'memory_size': memory_size,
1484 'skip_n_vectors': skip_n_vectors,
1485 'match_n_vectors': match_n_vectors,
1486 'next_table_index': next_table_index,
1487 'miss_next_index': miss_next_index,
1488 'current_data_flag': current_data_flag,
1489 'current_data_offset': current_data_offset,
1492 def classify_add_del_session(
1497 opaque_index=0xFFFFFFFF,
1498 hit_next_index=0xFFFFFFFF,
1506 :param opaque_index: (Default value = 0xFFFFFFFF)
1507 :param hit_next_index: (Default value = 0xFFFFFFFF)
1508 :param advance: (Default value = 0)
1509 :param action: (Default value = 0)
1510 :param metadata: (Default value = 0)
1514 self.papi.classify_add_del_session,
1516 'table_index': table_index,
1517 'hit_next_index': hit_next_index,
1518 'opaque_index': opaque_index,
1521 'metadata': metadata,
1524 def input_acl_set_interface(
1528 ip4_table_index=0xFFFFFFFF,
1529 ip6_table_index=0xFFFFFFFF,
1530 l2_table_index=0xFFFFFFFF):
1534 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1535 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1536 :param l2_table_index: (Default value = 0xFFFFFFFF)
1540 self.papi.input_acl_set_interface,
1541 {'sw_if_index': sw_if_index,
1542 'ip4_table_index': ip4_table_index,
1543 'ip6_table_index': ip6_table_index,
1544 'l2_table_index': l2_table_index,
1547 def set_ipfix_exporter(
1554 collector_port=4739,
1557 self.papi.set_ipfix_exporter,
1559 'collector_address': collector_address,
1560 'collector_port': collector_port,
1561 'src_address': src_address,
1563 'path_mtu': path_mtu,
1564 'template_interval': template_interval,
1565 'udp_checksum': udp_checksum,
1568 def dhcp_proxy_config(self,
1576 self.papi.dhcp_proxy_config,
1578 'rx_vrf_id': rx_table_id,
1579 'server_vrf_id': server_table_id,
1582 'dhcp_server': dhcp_server,
1583 'dhcp_src_address': dhcp_src_address,
1586 def dhcp_proxy_set_vss(self,
1593 self.papi.dhcp_proxy_set_vss,
1602 def ip_mroute_add_del(self,
1607 next_hop_sw_if_index,
1611 create_vrf_if_needed=0,
1618 self.papi.ip_mroute_add_del,
1619 {'next_hop_sw_if_index': next_hop_sw_if_index,
1620 'entry_flags': e_flags,
1621 'itf_flags': i_flags,
1622 'table_id': table_id,
1624 'create_vrf_if_needed': create_vrf_if_needed,
1627 'is_local': is_local,
1628 'grp_address_length': grp_address_length,
1629 'grp_address': grp_address,
1630 'src_address': src_address})
1632 def mfib_signal_dump(self):
1633 return self.api(self.papi.mfib_signal_dump, {})
1635 def ip_mfib_dump(self):
1636 return self.api(self.papi.ip_mfib_dump, {})
1638 def lisp_enable_disable(self, is_enabled):
1640 self.papi.lisp_enable_disable,
1642 'is_en': is_enabled,
1645 def lisp_locator_set(self,
1649 self.papi.lisp_add_del_locator_set,
1652 'locator_set_name': ls_name
1655 def lisp_locator_set_dump(self):
1656 return self.api(self.papi.lisp_locator_set_dump, {})
1658 def lisp_locator(self,
1665 self.papi.lisp_add_del_locator,
1668 'locator_set_name': ls_name,
1669 'sw_if_index': sw_if_index,
1670 'priority': priority,
1674 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1676 self.papi.lisp_locator_dump,
1678 'is_index_set': is_index_set,
1680 'ls_index': ls_index,
1683 def lisp_local_mapping(self,
1693 self.papi.lisp_add_del_local_eid,
1695 'locator_set_name': ls_name,
1697 'eid_type': eid_type,
1699 'prefix_len': prefix_len,
1705 def lisp_eid_table_dump(self,
1713 self.papi.lisp_eid_table_dump,
1716 'prefix_length': prefix_length,
1718 'eid_type': eid_type,
1720 'filter': filter_opt,
1723 def lisp_remote_mapping(self,
1733 self.papi.lisp_add_del_remote_mapping,
1736 'eid_type': eid_type,
1738 'eid_len': eid_prefix_len,
1739 'rloc_num': rlocs_num,
1742 'is_src_dst': is_src_dst,
1745 def lisp_adjacency(self,
1754 self.papi.lisp_add_del_adjacency,
1758 'eid_type': eid_type,
1761 'leid_len': leid_len,
1762 'reid_len': reid_len,
1765 def lisp_adjacencies_get(self, vni=0):
1767 self.papi.lisp_adjacencies_get,
1772 def map_add_domain(self,
1785 self.papi.map_add_domain,
1787 'ip6_prefix': ip6_prefix,
1788 'ip6_prefix_len': ip6_prefix_len,
1789 'ip4_prefix': ip4_prefix,
1790 'ip4_prefix_len': ip4_prefix_len,
1792 'ip6_src_prefix_len': ip6_src_prefix_len,
1793 'ea_bits_len': ea_bits_len,
1794 'psid_offset': psid_offset,
1795 'psid_length': psid_length,
1796 'is_translation': is_translation,
1800 def gtpu_add_del_tunnel(
1806 mcast_sw_if_index=0xFFFFFFFF,
1808 decap_next_index=0xFFFFFFFF,
1812 :param is_add: (Default value = 1)
1813 :param is_ipv6: (Default value = 0)
1816 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1817 :param encap_vrf_id: (Default value = 0)
1818 :param decap_next_index: (Default value = 0xFFFFFFFF)
1819 :param teid: (Default value = 0)
1822 return self.api(self.papi.gtpu_add_del_tunnel,
1825 'src_address': src_addr,
1826 'dst_address': dst_addr,
1827 'mcast_sw_if_index': mcast_sw_if_index,
1828 'encap_vrf_id': encap_vrf_id,
1829 'decap_next_index': decap_next_index,
1832 def vxlan_gpe_add_del_tunnel(
1836 mcast_sw_if_index=0xFFFFFFFF,
1847 :param is_add: (Default value = 1)
1848 :param is_ipv6: (Default value = 0)
1849 :param encap_vrf_id: (Default value = 0)
1850 :param decap_vrf_id: (Default value = 0)
1851 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1852 :param protocol: (Default value = 3)
1853 :param vni: (Default value = 0)
1856 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1861 'mcast_sw_if_index': mcast_sw_if_index,
1862 'encap_vrf_id': encap_vrf_id,
1863 'decap_vrf_id': decap_vrf_id,
1864 'protocol': protocol,