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 zero return value instead "\
156 "of %d in %s" % (expected_retval, repr(reply))
157 self.test_class.logger.info(msg)
158 raise UnexpectedApiReturnValueError(msg)
160 raise Exception("Internal error, unexpected value for "
161 "self._expect_api_retval %s" %
162 self._expect_api_retval)
163 self.hook.after_api(api_fn.__name__, api_args)
167 """ Execute a CLI, calling the before/after hooks appropriately.
169 :param cli: CLI to execute
173 self.hook.before_cli(cli)
175 r = self.papi.cli_inband(length=len(cli), cmd=cli)
176 self.hook.after_cli(cli)
177 if hasattr(r, 'reply'):
178 return r.reply.decode().rstrip('\x00')
180 def ppcli(self, cli):
181 """ Helper method to print CLI command in case of info logging level.
183 :param cli: CLI to execute
186 return cli + "\n" + str(self.cli(cli))
188 def _convert_mac(self, mac):
189 return int(mac.replace(":", ""), 16) << 16
191 def show_version(self):
193 return self.api(self.papi.show_version, {})
195 def pg_create_interface(self, pg_index):
201 return self.api(self.papi.pg_create_interface,
202 {"interface_id": pg_index})
204 def sw_interface_dump(self, filter=None):
207 :param filter: (Default value = None)
210 if filter is not None:
211 args = {"name_filter_valid": 1, "name_filter": filter}
214 return self.api(self.papi.sw_interface_dump, args)
216 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
217 """ Set the IPvX Table-id for the Interface
224 return self.api(self.papi.sw_interface_set_table,
225 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
228 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
229 is_ipv6=0, is_add=1, del_all=0):
232 :param addr: param is_ipv6: (Default value = 0)
235 :param is_ipv6: (Default value = 0)
236 :param is_add: (Default value = 1)
237 :param del_all: (Default value = 0)
240 return self.api(self.papi.sw_interface_add_del_address,
241 {'sw_if_index': sw_if_index,
245 'address_length': addr_len,
248 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
250 """ Set the Interface to be unnumbered
252 :param is_add: (Default value = 1)
253 :param sw_if_index - interface That will be unnumbered
254 :param ip_sw_if_index - interface with an IP addres
257 return self.api(self.papi.sw_interface_set_unnumbered,
258 {'sw_if_index': ip_sw_if_index,
259 'unnumbered_sw_if_index': sw_if_index,
262 def sw_interface_enable_disable_mpls(self, sw_if_index,
265 Enable/Disable MPLS on the interface
267 :param is_enable: (Default value = 1)
270 return self.api(self.papi.sw_interface_set_mpls_enable,
271 {'sw_if_index': sw_if_index,
272 'enable': is_enable})
274 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
275 return self.api(self.papi.sw_interface_ip6nd_ra_config,
276 {'sw_if_index': sw_if_index,
277 'suppress': suppress})
279 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
280 return self.api(self.papi.ip6nd_proxy_add_del,
282 'sw_if_index': sw_if_index,
285 def ip6_sw_interface_ra_config(self, sw_if_index,
289 return self.api(self.papi.sw_interface_ip6nd_ra_config,
290 {'sw_if_index': sw_if_index,
292 'suppress': suppress,
293 'send_unicast': send_unicast})
295 def ip6_sw_interface_ra_prefix(self,
305 val_lifetime=0xffffffff,
306 pref_lifetime=0xffffffff):
307 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
308 {'sw_if_index': sw_if_index,
310 'address_length': address_length,
311 'use_default': use_default,
312 'no_advertise': no_advertise,
313 'off_link': off_link,
314 'no_autoconfig': no_autoconfig,
315 'no_onlink': no_onlink,
317 'val_lifetime': val_lifetime,
318 'pref_lifetime': pref_lifetime})
320 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
322 Enable/Disable An interface for IPv6
324 return self.api(self.papi.sw_interface_ip6_enable_disable,
325 {'sw_if_index': sw_if_index,
328 def vxlan_add_del_tunnel(
332 mcast_sw_if_index=0xFFFFFFFF,
336 decap_next_index=0xFFFFFFFF,
342 :param is_add: (Default value = 1)
343 :param is_ipv6: (Default value = 0)
344 :param encap_vrf_id: (Default value = 0)
345 :param decap_next_index: (Default value = 0xFFFFFFFF)
346 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
347 :param vni: (Default value = 0)
350 return self.api(self.papi.vxlan_add_del_tunnel,
353 'src_address': src_addr,
354 'dst_address': dst_addr,
355 'mcast_sw_if_index': mcast_sw_if_index,
356 'encap_vrf_id': encap_vrf_id,
357 'decap_next_index': decap_next_index,
360 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
361 learn=1, arp_term=0, is_add=1):
362 """Create/delete bridge domain.
364 :param int bd_id: Bridge domain index.
365 :param int flood: Enable/disable bcast/mcast flooding in the BD.
367 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
369 :param int forward: Enable/disable forwarding on all interfaces in
370 the BD. (Default value = 1)
371 :param int learn: Enable/disable learning on all interfaces in the BD.
373 :param int arp_term: Enable/disable arp termination in the BD.
375 :param int is_add: Add or delete flag. (Default value = 1)
377 return self.api(self.papi.bridge_domain_add_del,
380 'uu_flood': uu_flood,
383 'arp_term': arp_term,
386 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
387 filter_mac=0, bvi_mac=0):
388 """Create/delete L2 FIB entry.
390 :param str mac: MAC address to create FIB entry for.
391 :param int bd_id: Bridge domain index.
392 :param int sw_if_index: Software interface index of the interface.
393 :param int is_add: Add or delete flag. (Default value = 1)
394 :param int static_mac: Set to 1 to create static MAC entry.
396 :param int filter_mac: Set to 1 to drop packet that's source or
397 destination MAC address contains defined MAC address.
399 :param int bvi_mac: Set to 1 to create entry that points to BVI
400 interface. (Default value = 0)
402 return self.api(self.papi.l2fib_add_del,
403 {'mac': self._convert_mac(mac),
405 'sw_if_index': sw_if_index,
407 'static_mac': static_mac,
408 'filter_mac': filter_mac,
411 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
412 shg=0, bvi=0, enable=1):
413 """Add/remove interface to/from bridge domain.
415 :param int sw_if_index: Software interface index of the interface.
416 :param int bd_id: Bridge domain index.
417 :param int shg: Split-horizon group index. (Default value = 0)
418 :param int bvi: Set interface as a bridge group virtual interface.
420 :param int enable: Add or remove interface. (Default value = 1)
422 return self.api(self.papi.sw_interface_set_l2_bridge,
423 {'rx_sw_if_index': sw_if_index,
429 def bridge_flags(self, bd_id, is_set, feature_bitmap):
430 """Enable/disable required feature of the bridge domain with defined ID.
432 :param int bd_id: Bridge domain ID.
433 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
434 :param int feature_bitmap: Bitmap value of the feature to be set:
438 - uu-flood (1 << 3) or
441 return self.api(self.papi.bridge_flags,
444 'feature_bitmap': feature_bitmap})
446 def bridge_domain_dump(self, bd_id=0):
449 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
450 existing bridge domains returned)
451 :return: Dictionary of bridge domain(s) data.
453 return self.api(self.papi.bridge_domain_dump,
456 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
458 """Create or delete unidirectional cross-connect from Tx interface to
461 :param int rx_sw_if_index: Software interface index of Rx interface.
462 :param int tx_sw_if_index: Software interface index of Tx interface.
463 :param int enable: Create cross-connect if equal to 1, delete
464 cross-connect if equal to 0.
467 return self.api(self.papi.sw_interface_set_l2_xconnect,
468 {'rx_sw_if_index': rx_sw_if_index,
469 'tx_sw_if_index': tx_sw_if_index,
472 def sw_interface_set_l2_tag_rewrite(
479 """L2 interface vlan tag rewrite configure request
480 :param client_index - opaque cookie to identify the sender
481 :param context - sender context, to match reply w/ request
482 :param sw_if_index - interface the operation is applied to
483 :param vtr_op - Choose from l2_vtr_op_t enum values
484 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
485 :param tag1 - Needed for any push or translate vtr op
486 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
489 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
490 {'sw_if_index': sw_if_index,
496 def sw_interface_set_flags(self, sw_if_index, admin_up_down,
497 link_up_down=0, deleted=0):
500 :param admin_up_down:
502 :param link_up_down: (Default value = 0)
503 :param deleted: (Default value = 0)
506 return self.api(self.papi.sw_interface_set_flags,
507 {'sw_if_index': sw_if_index,
508 'admin_up_down': admin_up_down,
509 'link_up_down': link_up_down,
512 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
513 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
514 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
515 """Create subinterface
516 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
518 :param sub_id: param inner_vlan:
522 :param no_tags: (Default value = 0)
523 :param one_tag: (Default value = 0)
524 :param two_tags: (Default value = 0)
525 :param dot1ad: (Default value = 0)
526 :param exact_match: (Default value = 0)
527 :param default_sub: (Default value = 0)
528 :param outer_vlan_id_any: (Default value = 0)
529 :param inner_vlan_id_any: (Default value = 0)
533 self.papi.create_subif,
534 {'sw_if_index': sw_if_index,
538 'two_tags': two_tags,
540 'exact_match': exact_match,
541 'default_sub': default_sub,
542 'outer_vlan_id_any': outer_vlan_id_any,
543 'inner_vlan_id_any': inner_vlan_id_any,
544 'outer_vlan_id': outer_vlan,
545 'inner_vlan_id': inner_vlan})
547 def delete_subif(self, sw_if_index):
548 """Delete subinterface
552 return self.api(self.papi.delete_subif,
553 {'sw_if_index': sw_if_index})
555 def create_vlan_subif(self, sw_if_index, vlan):
562 return self.api(self.papi.create_vlan_subif,
563 {'sw_if_index': sw_if_index,
566 def create_loopback(self, mac=''):
569 :param mac: (Optional)
571 return self.api(self.papi.create_loopback,
572 {'mac_address': mac})
574 def delete_loopback(self, sw_if_index):
575 return self.api(self.papi.delete_loopback,
576 {'sw_if_index': sw_if_index, })
578 def ip_add_del_route(
583 next_hop_sw_if_index=0xFFFFFFFF,
587 next_hop_n_out_labels=0,
588 next_hop_out_label_stack=[],
589 next_hop_via_label=MPLS_LABEL_INVALID,
590 create_vrf_if_needed=0,
592 is_resolve_attached=0,
593 classify_table_index=0xFFFFFFFF,
605 :param dst_address_length:
606 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
608 :param next_hop_address:
609 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
610 :param vrf_id: (Default value = 0)
611 :param lookup_in_vrf: (Default value = 0)
612 :param classify_table_index: (Default value = 0xFFFFFFFF)
613 :param create_vrf_if_needed: (Default value = 0)
614 :param is_add: (Default value = 1)
615 :param is_drop: (Default value = 0)
616 :param is_ipv6: (Default value = 0)
617 :param is_local: (Default value = 0)
618 :param is_classify: (Default value = 0)
619 :param is_multipath: (Default value = 0)
620 :param is_resolve_host: (Default value = 0)
621 :param is_resolve_attached: (Default value = 0)
622 :param not_last: (Default value = 0)
623 :param next_hop_weight: (Default value = 1)
628 self.papi.ip_add_del_route,
629 {'next_hop_sw_if_index': next_hop_sw_if_index,
630 'table_id': table_id,
631 'classify_table_index': classify_table_index,
632 'next_hop_table_id': next_hop_table_id,
633 'create_vrf_if_needed': create_vrf_if_needed,
636 'is_unreach': is_unreach,
637 'is_prohibit': is_prohibit,
639 'is_local': is_local,
640 'is_classify': is_classify,
641 'is_multipath': is_multipath,
642 'is_resolve_host': is_resolve_host,
643 'is_resolve_attached': is_resolve_attached,
644 'not_last': not_last,
645 'next_hop_weight': next_hop_weight,
646 'dst_address_length': dst_address_length,
647 'dst_address': dst_address,
648 'next_hop_address': next_hop_address,
649 'next_hop_n_out_labels': next_hop_n_out_labels,
650 'next_hop_via_label': next_hop_via_label,
651 'next_hop_out_label_stack': next_hop_out_label_stack})
653 def ip_fib_dump(self):
654 return self.api(self.papi.ip_fib_dump, {})
656 def ip6_fib_dump(self):
657 return self.api(self.papi.ip6_fib_dump, {})
659 def ip_neighbor_add_del(self,
668 """ Add neighbor MAC to IPv4 or IPv6 address.
673 :param is_add: (Default value = 1)
674 :param is_ipv6: (Default value = 0)
675 :param is_static: (Default value = 0)
676 :param is_no_adj_fib: (Default value = 0)
680 self.papi.ip_neighbor_add_del,
681 {'sw_if_index': sw_if_index,
684 'is_static': is_static,
685 'is_no_adj_fib': is_no_adj_fib,
686 'mac_address': mac_address,
687 'dst_address': dst_address
691 def ip_neighbor_dump(self,
694 """ Return IP neighbor dump.
697 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
701 self.papi.ip_neighbor_dump,
703 'sw_if_index': sw_if_index
707 def proxy_arp_add_del(self,
712 """ Config Proxy Arp Range.
714 :param low_address: Start address in the rnage to Proxy for
715 :param hi_address: End address in the rnage to Proxy for
716 :param vrf_id: The VRF/table in which to proxy
720 self.papi.proxy_arp_add_del,
723 'low_address': low_address,
724 'hi_address': hi_address,
728 def proxy_arp_intfc_enable_disable(self,
731 """ Enable/Disable an interface for proxy ARP requests
733 :param sw_if_index: Interface
734 :param enable_disable: Enable/Disable
738 self.papi.proxy_arp_intfc_enable_disable,
739 {'sw_if_index': sw_if_index,
740 'enable_disable': is_enable
748 """ Reset VRF (remove all routes etc.) request.
750 :param int vrf_id: ID of the FIB table / VRF to reset.
751 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
765 """ Reset VRF (remove all routes etc.) request.
767 :param int vrf_id: ID of the FIB table / VRF to reset.
768 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
783 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
792 def sw_interface_span_enable_disable(
793 self, sw_if_index_from, sw_if_index_to, state=1):
796 :param sw_if_index_from:
797 :param sw_if_index_to:
800 return self.api(self.papi.sw_interface_span_enable_disable,
801 {'sw_if_index_from': sw_if_index_from,
802 'sw_if_index_to': sw_if_index_to,
805 def gre_tunnel_add_del(self,
816 :param outer_fib_id: (Default value = 0)
817 :param is_add: (Default value = 1)
818 :param is_ipv6: (Default value = 0)
819 :param is_teb: (Default value = 0)
823 self.papi.gre_add_del_tunnel,
827 'src_address': src_address,
828 'dst_address': dst_address,
829 'outer_fib_id': outer_fib_id}
832 def mpls_fib_dump(self):
833 return self.api(self.papi.mpls_fib_dump, {})
835 def mpls_route_add_del(
839 next_hop_proto_is_ip4,
841 next_hop_sw_if_index=0xFFFFFFFF,
845 next_hop_n_out_labels=0,
846 next_hop_out_label_stack=[],
847 next_hop_via_label=MPLS_LABEL_INVALID,
848 create_vrf_if_needed=0,
850 is_resolve_attached=0,
854 classify_table_index=0xFFFFFFFF,
859 :param dst_address_length:
860 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
862 :param next_hop_address:
863 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
864 :param vrf_id: (Default value = 0)
865 :param lookup_in_vrf: (Default value = 0)
866 :param classify_table_index: (Default value = 0xFFFFFFFF)
867 :param create_vrf_if_needed: (Default value = 0)
868 :param is_add: (Default value = 1)
869 :param is_drop: (Default value = 0)
870 :param is_ipv6: (Default value = 0)
871 :param is_local: (Default value = 0)
872 :param is_classify: (Default value = 0)
873 :param is_multipath: (Default value = 0)
874 :param is_resolve_host: (Default value = 0)
875 :param is_resolve_attached: (Default value = 0)
876 :param not_last: (Default value = 0)
877 :param next_hop_weight: (Default value = 1)
882 self.papi.mpls_route_add_del,
885 'mr_table_id': table_id,
886 'mr_classify_table_index': classify_table_index,
887 'mr_create_table_if_needed': create_vrf_if_needed,
889 'mr_is_classify': is_classify,
890 'mr_is_multipath': is_multipath,
891 'mr_is_resolve_host': is_resolve_host,
892 'mr_is_resolve_attached': is_resolve_attached,
893 'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
894 'mr_next_hop_weight': next_hop_weight,
895 'mr_next_hop': next_hop_address,
896 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
897 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
898 'mr_next_hop_table_id': next_hop_table_id,
899 'mr_next_hop_via_label': next_hop_via_label,
900 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
902 def mpls_ip_bind_unbind(
910 create_vrf_if_needed=0,
915 self.papi.mpls_ip_bind_unbind,
916 {'mb_mpls_table_id': table_id,
918 'mb_ip_table_id': ip_table_id,
919 'mb_create_table_if_needed': create_vrf_if_needed,
920 'mb_is_bind': is_bind,
922 'mb_address_length': dst_address_length,
923 'mb_address': dst_address})
925 def mpls_tunnel_add_del(
928 next_hop_proto_is_ip4,
930 next_hop_sw_if_index=0xFFFFFFFF,
933 next_hop_n_out_labels=0,
934 next_hop_out_label_stack=[],
935 next_hop_via_label=MPLS_LABEL_INVALID,
936 create_vrf_if_needed=0,
941 :param dst_address_length:
942 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
944 :param next_hop_address:
945 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
946 :param vrf_id: (Default value = 0)
947 :param lookup_in_vrf: (Default value = 0)
948 :param classify_table_index: (Default value = 0xFFFFFFFF)
949 :param create_vrf_if_needed: (Default value = 0)
950 :param is_add: (Default value = 1)
951 :param is_drop: (Default value = 0)
952 :param is_ipv6: (Default value = 0)
953 :param is_local: (Default value = 0)
954 :param is_classify: (Default value = 0)
955 :param is_multipath: (Default value = 0)
956 :param is_resolve_host: (Default value = 0)
957 :param is_resolve_attached: (Default value = 0)
958 :param not_last: (Default value = 0)
959 :param next_hop_weight: (Default value = 1)
963 self.papi.mpls_tunnel_add_del,
964 {'mt_sw_if_index': tun_sw_if_index,
966 'mt_l2_only': l2_only,
967 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
968 'mt_next_hop_weight': next_hop_weight,
969 'mt_next_hop': next_hop_address,
970 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
971 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
972 'mt_next_hop_table_id': next_hop_table_id,
973 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
975 def snat_interface_add_del_feature(
980 """Enable/disable S-NAT feature on the interface
982 :param sw_if_index: Software index of the interface
983 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
984 :param is_add: 1 if add, 0 if delete (Default value = 1)
987 self.papi.snat_interface_add_del_feature,
989 'is_inside': is_inside,
990 'sw_if_index': sw_if_index})
992 def snat_add_static_mapping(
996 external_sw_if_index=0xFFFFFFFF,
1004 """Add/delete S-NAT static mapping
1006 :param local_ip: Local IP address
1007 :param external_ip: External IP address
1008 :param external_sw_if_index: External interface instead of IP address
1009 :param local_port: Local port number (Default value = 0)
1010 :param external_port: External port number (Default value = 0)
1011 :param addr_only: 1 if address only mapping, 0 if address and port
1012 :param vrf_id: VRF ID
1013 :param protocol: IP protocol (Default value = 0)
1014 :param is_add: 1 if add, 0 if delete (Default value = 1)
1015 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1018 self.papi.snat_add_static_mapping,
1021 'addr_only': addr_only,
1022 'local_ip_address': local_ip,
1023 'external_ip_address': external_ip,
1024 'local_port': local_port,
1025 'external_port': external_port,
1026 'external_sw_if_index': external_sw_if_index,
1028 'protocol': protocol})
1030 def snat_add_address_range(
1037 """Add/del S-NAT address range
1039 :param first_ip_address: First IP address
1040 :param last_ip_address: Last IP address
1041 :param vrf_id: VRF id for the address range
1042 :param is_add: 1 if add, 0 if delete (Default value = 1)
1043 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1046 self.papi.snat_add_address_range,
1048 'first_ip_address': first_ip_address,
1049 'last_ip_address': last_ip_address,
1053 def snat_address_dump(self):
1054 """Dump S-NAT addresses
1055 :return: Dictionary of S-NAT addresses
1057 return self.api(self.papi.snat_address_dump, {})
1059 def snat_interface_dump(self):
1060 """Dump interfaces with S-NAT feature
1061 :return: Dictionary of interfaces with S-NAT feature
1063 return self.api(self.papi.snat_interface_dump, {})
1065 def snat_static_mapping_dump(self):
1066 """Dump S-NAT static mappings
1067 :return: Dictionary of S-NAT static mappings
1069 return self.api(self.papi.snat_static_mapping_dump, {})
1071 def snat_show_config(self):
1072 """Show S-NAT config
1073 :return: S-NAT config parameters
1075 return self.api(self.papi.snat_show_config, {})
1077 def snat_add_interface_addr(
1081 """Add/del S-NAT address from interface
1083 :param sw_if_index: Software index of the interface
1084 :param is_add: 1 if add, 0 if delete (Default value = 1)
1086 return self.api(self.papi.snat_add_del_interface_addr,
1087 {'is_add': is_add, 'sw_if_index': sw_if_index})
1089 def snat_interface_addr_dump(self):
1090 """Dump S-NAT addresses interfaces
1091 :return: Dictionary of S-NAT addresses interfaces
1093 return self.api(self.papi.snat_interface_addr_dump, {})
1100 """Enable/disable S-NAT IPFIX logging
1102 :param domain_id: Observation domain ID (Default value = 1)
1103 :param src_port: Source port number (Default value = 4739)
1104 :param enable: 1 if enable, 0 if disable (Default value = 1)
1107 self.papi.snat_ipfix_enable_disable,
1108 {'domain_id': domain_id,
1109 'src_port': src_port,
1112 def snat_user_session_dump(
1117 """Dump S-NAT user's sessions
1119 :param ip_address: ip adress of the user to be dumped
1120 :param cpu_index: cpu_index on which the user is
1121 :param vrf_id: VRF ID
1122 :return: Dictionary of S-NAT sessions
1125 self.papi.snat_user_session_dump,
1126 {'ip_address': ip_address,
1130 def snat_user_dump(self):
1133 :return: Dictionary of S-NAT users
1135 return self.api(self.papi.snat_user_dump, {})
1137 def snat_add_det_map(
1144 """Add/delete S-NAT deterministic mapping
1146 :param is_add - 1 if add, 0 if delete
1147 :param in_addr - inside IP address
1148 :param in_plen - inside IP address prefix length
1149 :param out_addr - outside IP address
1150 :param out_plen - outside IP address prefix length
1153 self.papi.snat_add_det_map,
1157 'out_addr': out_addr,
1158 'out_plen': out_plen})
1160 def snat_det_forward(
1163 """Get outside address and port range from inside address
1165 :param in_addr - inside IP address
1168 self.papi.snat_det_forward,
1169 {'in_addr': in_addr})
1171 def snat_det_reverse(
1175 """Get inside address from outside address and port
1177 :param out_addr - outside IP address
1178 :param out_port - outside port
1181 self.papi.snat_det_reverse,
1182 {'out_addr': out_addr,
1183 'out_port': out_port})
1185 def snat_det_map_dump(self):
1186 """Dump S-NAT deterministic mappings
1188 :return: Dictionary of S-NAT deterministic mappings
1190 return self.api(self.papi.snat_det_map_dump, {})
1192 def control_ping(self):
1193 self.api(self.papi.control_ping)
1195 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1196 detect_mult, local_addr, peer_addr, is_ipv6=0,
1197 bfd_key_id=None, conf_key_id=None):
1198 if bfd_key_id is None:
1199 return self.api(self.papi.bfd_udp_add,
1201 'sw_if_index': sw_if_index,
1202 'desired_min_tx': desired_min_tx,
1203 'required_min_rx': required_min_rx,
1204 'local_addr': local_addr,
1205 'peer_addr': peer_addr,
1207 'detect_mult': detect_mult,
1210 return self.api(self.papi.bfd_udp_add,
1212 'sw_if_index': sw_if_index,
1213 'desired_min_tx': desired_min_tx,
1214 'required_min_rx': required_min_rx,
1215 'local_addr': local_addr,
1216 'peer_addr': peer_addr,
1218 'detect_mult': detect_mult,
1219 'is_authenticated': 1,
1220 'bfd_key_id': bfd_key_id,
1221 'conf_key_id': conf_key_id,
1224 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1225 detect_mult, local_addr, peer_addr, is_ipv6=0):
1226 return self.api(self.papi.bfd_udp_mod,
1228 'sw_if_index': sw_if_index,
1229 'desired_min_tx': desired_min_tx,
1230 'required_min_rx': required_min_rx,
1231 'local_addr': local_addr,
1232 'peer_addr': peer_addr,
1234 'detect_mult': detect_mult,
1237 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1238 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1240 return self.api(self.papi.bfd_udp_auth_activate,
1242 'sw_if_index': sw_if_index,
1243 'local_addr': local_addr,
1244 'peer_addr': peer_addr,
1246 'is_delayed': 1 if is_delayed else 0,
1247 'bfd_key_id': bfd_key_id,
1248 'conf_key_id': conf_key_id,
1251 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1252 is_ipv6=0, is_delayed=False):
1253 return self.api(self.papi.bfd_udp_auth_deactivate,
1255 'sw_if_index': sw_if_index,
1256 'local_addr': local_addr,
1257 'peer_addr': peer_addr,
1259 'is_delayed': 1 if is_delayed else 0,
1262 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1263 return self.api(self.papi.bfd_udp_del,
1265 'sw_if_index': sw_if_index,
1266 'local_addr': local_addr,
1267 'peer_addr': peer_addr,
1271 def bfd_udp_session_dump(self):
1272 return self.api(self.papi.bfd_udp_session_dump, {})
1274 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1275 peer_addr, is_ipv6=0):
1276 return self.api(self.papi.bfd_udp_session_set_flags, {
1277 'admin_up_down': admin_up_down,
1278 'sw_if_index': sw_if_index,
1279 'local_addr': local_addr,
1280 'peer_addr': peer_addr,
1284 def want_bfd_events(self, enable_disable=1):
1285 return self.api(self.papi.want_bfd_events, {
1286 'enable_disable': enable_disable,
1290 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1291 return self.api(self.papi.bfd_auth_set_key, {
1292 'conf_key_id': conf_key_id,
1293 'auth_type': auth_type,
1295 'key_len': len(key),
1298 def bfd_auth_del_key(self, conf_key_id):
1299 return self.api(self.papi.bfd_auth_del_key, {
1300 'conf_key_id': conf_key_id,
1303 def bfd_auth_keys_dump(self):
1304 return self.api(self.papi.bfd_auth_keys_dump, {})
1306 def bfd_udp_set_echo_source(self, sw_if_index):
1307 return self.api(self.papi.bfd_udp_set_echo_source,
1308 {'sw_if_index': sw_if_index})
1310 def bfd_udp_del_echo_source(self):
1311 return self.api(self.papi.bfd_udp_del_echo_source, {})
1313 def classify_add_del_table(
1318 table_index=0xFFFFFFFF,
1320 memory_size=2097152,
1322 next_table_index=0xFFFFFFFF,
1323 miss_next_index=0xFFFFFFFF,
1324 current_data_flag=0,
1325 current_data_offset=0):
1329 :param match_n_vectors: (Default value = 1)
1330 :param table_index: (Default value = 0xFFFFFFFF)
1331 :param nbuckets: (Default value = 2)
1332 :param memory_size: (Default value = 2097152)
1333 :param skip_n_vectors: (Default value = 0)
1334 :param next_table_index: (Default value = 0xFFFFFFFF)
1335 :param miss_next_index: (Default value = 0xFFFFFFFF)
1336 :param current_data_flag: (Default value = 0)
1337 :param current_data_offset: (Default value = 0)
1341 self.papi.classify_add_del_table,
1343 'table_index': table_index,
1344 'nbuckets': nbuckets,
1345 'memory_size': memory_size,
1346 'skip_n_vectors': skip_n_vectors,
1347 'match_n_vectors': match_n_vectors,
1348 'next_table_index': next_table_index,
1349 'miss_next_index': miss_next_index,
1350 'current_data_flag': current_data_flag,
1351 'current_data_offset': current_data_offset,
1354 def classify_add_del_session(
1359 opaque_index=0xFFFFFFFF,
1360 hit_next_index=0xFFFFFFFF,
1368 :param opaque_index: (Default value = 0xFFFFFFFF)
1369 :param hit_next_index: (Default value = 0xFFFFFFFF)
1370 :param advance: (Default value = 0)
1371 :param action: (Default value = 0)
1372 :param metadata: (Default value = 0)
1376 self.papi.classify_add_del_session,
1378 'table_index': table_index,
1379 'hit_next_index': hit_next_index,
1380 'opaque_index': opaque_index,
1383 'metadata': metadata,
1386 def input_acl_set_interface(
1390 ip4_table_index=0xFFFFFFFF,
1391 ip6_table_index=0xFFFFFFFF,
1392 l2_table_index=0xFFFFFFFF):
1396 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1397 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1398 :param l2_table_index: (Default value = 0xFFFFFFFF)
1402 self.papi.input_acl_set_interface,
1403 {'sw_if_index': sw_if_index,
1404 'ip4_table_index': ip4_table_index,
1405 'ip6_table_index': ip6_table_index,
1406 'l2_table_index': l2_table_index,
1409 def set_ipfix_exporter(
1416 collector_port=4739,
1419 self.papi.set_ipfix_exporter,
1421 'collector_address': collector_address,
1422 'collector_port': collector_port,
1423 'src_address': src_address,
1425 'path_mtu': path_mtu,
1426 'template_interval': template_interval,
1427 'udp_checksum': udp_checksum,
1430 def dhcp_proxy_config(self,
1438 self.papi.dhcp_proxy_config,
1440 'rx_vrf_id': rx_table_id,
1441 'server_vrf_id': server_table_id,
1444 'dhcp_server': dhcp_server,
1445 'dhcp_src_address': dhcp_src_address,
1448 def dhcp_proxy_set_vss(self,
1455 self.papi.dhcp_proxy_set_vss,
1464 def ip_mroute_add_del(self,
1469 next_hop_sw_if_index,
1472 create_vrf_if_needed=0,
1479 self.papi.ip_mroute_add_del,
1480 {'next_hop_sw_if_index': next_hop_sw_if_index,
1481 'entry_flags': e_flags,
1482 'itf_flags': i_flags,
1483 'create_vrf_if_needed': create_vrf_if_needed,
1486 'is_local': is_local,
1487 'grp_address_length': grp_address_length,
1488 'grp_address': grp_address,
1489 'src_address': src_address})
1491 def mfib_signal_dump(self):
1492 return self.api(self.papi.mfib_signal_dump, {})
1494 def ip_mfib_dump(self):
1495 return self.api(self.papi.ip_mfib_dump, {})
1497 def lisp_enable_disable(self, is_enabled):
1499 self.papi.lisp_enable_disable,
1501 'is_en': is_enabled,
1504 def lisp_locator_set(self,
1508 self.papi.lisp_add_del_locator_set,
1511 'locator_set_name': ls_name
1514 def lisp_locator_set_dump(self):
1515 return self.api(self.papi.lisp_locator_set_dump, {})
1517 def lisp_locator(self,
1524 self.papi.lisp_add_del_locator,
1527 'locator_set_name': ls_name,
1528 'sw_if_index': sw_if_index,
1529 'priority': priority,
1533 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1535 self.papi.lisp_locator_dump,
1537 'is_index_set': is_index_set,
1539 'ls_index': ls_index,
1542 def lisp_local_mapping(self,
1552 self.papi.lisp_add_del_local_eid,
1554 'locator_set_name': ls_name,
1556 'eid_type': eid_type,
1558 'prefix_len': prefix_len,
1564 def lisp_eid_table_dump(self,
1572 self.papi.lisp_eid_table_dump,
1575 'prefix_length': prefix_length,
1577 'eid_type': eid_type,
1579 'filter': filter_opt,
1582 def lisp_remote_mapping(self,
1592 self.papi.lisp_add_del_remote_mapping,
1595 'eid_type': eid_type,
1597 'eid_len': eid_prefix_len,
1598 'rloc_num': rlocs_num,
1601 'is_src_dst': is_src_dst,
1604 def lisp_adjacency(self,
1613 self.papi.lisp_add_del_adjacency,
1617 'eid_type': eid_type,
1620 'leid_len': leid_len,
1621 'reid_len': reid_len,
1624 def lisp_adjacencies_get(self, vni=0):
1626 self.papi.lisp_adjacencies_get,
1631 def map_add_domain(self,
1644 self.papi.map_add_domain,
1646 'ip6_prefix': ip6_prefix,
1647 'ip6_prefix_len': ip6_prefix_len,
1648 'ip4_prefix': ip4_prefix,
1649 'ip4_prefix_len': ip4_prefix_len,
1651 'ip6_src_prefix_len': ip6_src_prefix_len,
1652 'ea_bits_len': ea_bits_len,
1653 'psid_offset': psid_offset,
1654 'psid_length': psid_length,
1655 'is_translation': is_translation,