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 sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
432 shg=0, bvi=0, enable=1):
433 """Add/remove interface to/from bridge domain.
435 :param int sw_if_index: Software interface index of the interface.
436 :param int bd_id: Bridge domain index.
437 :param int shg: Split-horizon group index. (Default value = 0)
438 :param int bvi: Set interface as a bridge group virtual interface.
440 :param int enable: Add or remove interface. (Default value = 1)
442 return self.api(self.papi.sw_interface_set_l2_bridge,
443 {'rx_sw_if_index': sw_if_index,
449 def bridge_flags(self, bd_id, is_set, feature_bitmap):
450 """Enable/disable required feature of the bridge domain with defined ID.
452 :param int bd_id: Bridge domain ID.
453 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
454 :param int feature_bitmap: Bitmap value of the feature to be set:
458 - uu-flood (1 << 3) or
461 return self.api(self.papi.bridge_flags,
464 'feature_bitmap': feature_bitmap})
466 def bridge_domain_dump(self, bd_id=0):
469 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
470 existing bridge domains returned)
471 :return: Dictionary of bridge domain(s) data.
473 return self.api(self.papi.bridge_domain_dump,
476 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
478 """Create or delete unidirectional cross-connect from Tx interface to
481 :param int rx_sw_if_index: Software interface index of Rx interface.
482 :param int tx_sw_if_index: Software interface index of Tx interface.
483 :param int enable: Create cross-connect if equal to 1, delete
484 cross-connect if equal to 0.
487 return self.api(self.papi.sw_interface_set_l2_xconnect,
488 {'rx_sw_if_index': rx_sw_if_index,
489 'tx_sw_if_index': tx_sw_if_index,
492 def sw_interface_set_l2_tag_rewrite(
499 """L2 interface vlan tag rewrite configure request
500 :param client_index - opaque cookie to identify the sender
501 :param context - sender context, to match reply w/ request
502 :param sw_if_index - interface the operation is applied to
503 :param vtr_op - Choose from l2_vtr_op_t enum values
504 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
505 :param tag1 - Needed for any push or translate vtr op
506 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
509 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
510 {'sw_if_index': sw_if_index,
516 def sw_interface_set_flags(self, sw_if_index, admin_up_down,
517 link_up_down=0, deleted=0):
520 :param admin_up_down:
522 :param link_up_down: (Default value = 0)
523 :param deleted: (Default value = 0)
526 return self.api(self.papi.sw_interface_set_flags,
527 {'sw_if_index': sw_if_index,
528 'admin_up_down': admin_up_down,
529 'link_up_down': link_up_down,
532 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
533 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
534 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
535 """Create subinterface
536 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
538 :param sub_id: param inner_vlan:
542 :param no_tags: (Default value = 0)
543 :param one_tag: (Default value = 0)
544 :param two_tags: (Default value = 0)
545 :param dot1ad: (Default value = 0)
546 :param exact_match: (Default value = 0)
547 :param default_sub: (Default value = 0)
548 :param outer_vlan_id_any: (Default value = 0)
549 :param inner_vlan_id_any: (Default value = 0)
553 self.papi.create_subif,
554 {'sw_if_index': sw_if_index,
558 'two_tags': two_tags,
560 'exact_match': exact_match,
561 'default_sub': default_sub,
562 'outer_vlan_id_any': outer_vlan_id_any,
563 'inner_vlan_id_any': inner_vlan_id_any,
564 'outer_vlan_id': outer_vlan,
565 'inner_vlan_id': inner_vlan})
567 def delete_subif(self, sw_if_index):
568 """Delete subinterface
572 return self.api(self.papi.delete_subif,
573 {'sw_if_index': sw_if_index})
575 def create_vlan_subif(self, sw_if_index, vlan):
582 return self.api(self.papi.create_vlan_subif,
583 {'sw_if_index': sw_if_index,
586 def create_loopback(self, mac=''):
589 :param mac: (Optional)
591 return self.api(self.papi.create_loopback,
592 {'mac_address': mac})
594 def delete_loopback(self, sw_if_index):
595 return self.api(self.papi.delete_loopback,
596 {'sw_if_index': sw_if_index, })
598 def ip_add_del_route(
603 next_hop_sw_if_index=0xFFFFFFFF,
607 next_hop_n_out_labels=0,
608 next_hop_out_label_stack=[],
609 next_hop_via_label=MPLS_LABEL_INVALID,
610 create_vrf_if_needed=0,
612 is_resolve_attached=0,
613 classify_table_index=0xFFFFFFFF,
625 :param dst_address_length:
626 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
628 :param next_hop_address:
629 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
630 :param vrf_id: (Default value = 0)
631 :param lookup_in_vrf: (Default value = 0)
632 :param classify_table_index: (Default value = 0xFFFFFFFF)
633 :param create_vrf_if_needed: (Default value = 0)
634 :param is_add: (Default value = 1)
635 :param is_drop: (Default value = 0)
636 :param is_ipv6: (Default value = 0)
637 :param is_local: (Default value = 0)
638 :param is_classify: (Default value = 0)
639 :param is_multipath: (Default value = 0)
640 :param is_resolve_host: (Default value = 0)
641 :param is_resolve_attached: (Default value = 0)
642 :param not_last: (Default value = 0)
643 :param next_hop_weight: (Default value = 1)
648 self.papi.ip_add_del_route,
649 {'next_hop_sw_if_index': next_hop_sw_if_index,
650 'table_id': table_id,
651 'classify_table_index': classify_table_index,
652 'next_hop_table_id': next_hop_table_id,
653 'create_vrf_if_needed': create_vrf_if_needed,
656 'is_unreach': is_unreach,
657 'is_prohibit': is_prohibit,
659 'is_local': is_local,
660 'is_classify': is_classify,
661 'is_multipath': is_multipath,
662 'is_resolve_host': is_resolve_host,
663 'is_resolve_attached': is_resolve_attached,
664 'not_last': not_last,
665 'next_hop_weight': next_hop_weight,
666 'dst_address_length': dst_address_length,
667 'dst_address': dst_address,
668 'next_hop_address': next_hop_address,
669 'next_hop_n_out_labels': next_hop_n_out_labels,
670 'next_hop_via_label': next_hop_via_label,
671 'next_hop_out_label_stack': next_hop_out_label_stack})
673 def ip_fib_dump(self):
674 return self.api(self.papi.ip_fib_dump, {})
676 def ip6_fib_dump(self):
677 return self.api(self.papi.ip6_fib_dump, {})
679 def ip_neighbor_add_del(self,
688 """ Add neighbor MAC to IPv4 or IPv6 address.
693 :param is_add: (Default value = 1)
694 :param is_ipv6: (Default value = 0)
695 :param is_static: (Default value = 0)
696 :param is_no_adj_fib: (Default value = 0)
700 self.papi.ip_neighbor_add_del,
701 {'sw_if_index': sw_if_index,
704 'is_static': is_static,
705 'is_no_adj_fib': is_no_adj_fib,
706 'mac_address': mac_address,
707 'dst_address': dst_address
711 def ip_neighbor_dump(self,
714 """ Return IP neighbor dump.
717 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
721 self.papi.ip_neighbor_dump,
723 'sw_if_index': sw_if_index
727 def proxy_arp_add_del(self,
732 """ Config Proxy Arp Range.
734 :param low_address: Start address in the rnage to Proxy for
735 :param hi_address: End address in the rnage to Proxy for
736 :param vrf_id: The VRF/table in which to proxy
740 self.papi.proxy_arp_add_del,
743 'low_address': low_address,
744 'hi_address': hi_address,
748 def proxy_arp_intfc_enable_disable(self,
751 """ Enable/Disable an interface for proxy ARP requests
753 :param sw_if_index: Interface
754 :param enable_disable: Enable/Disable
758 self.papi.proxy_arp_intfc_enable_disable,
759 {'sw_if_index': sw_if_index,
760 'enable_disable': is_enable
768 """ Reset VRF (remove all routes etc.) request.
770 :param int vrf_id: ID of the FIB table / VRF to reset.
771 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
785 """ Reset VRF (remove all routes etc.) request.
787 :param int vrf_id: ID of the FIB table / VRF to reset.
788 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
803 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
812 def sw_interface_span_enable_disable(
813 self, sw_if_index_from, sw_if_index_to, state=1):
816 :param sw_if_index_from:
817 :param sw_if_index_to:
820 return self.api(self.papi.sw_interface_span_enable_disable,
821 {'sw_if_index_from': sw_if_index_from,
822 'sw_if_index_to': sw_if_index_to,
825 def gre_tunnel_add_del(self,
836 :param outer_fib_id: (Default value = 0)
837 :param is_add: (Default value = 1)
838 :param is_ipv6: (Default value = 0)
839 :param is_teb: (Default value = 0)
843 self.papi.gre_add_del_tunnel,
847 'src_address': src_address,
848 'dst_address': dst_address,
849 'outer_fib_id': outer_fib_id}
852 def mpls_fib_dump(self):
853 return self.api(self.papi.mpls_fib_dump, {})
855 def mpls_route_add_del(
859 next_hop_proto_is_ip4,
861 next_hop_sw_if_index=0xFFFFFFFF,
865 next_hop_n_out_labels=0,
866 next_hop_out_label_stack=[],
867 next_hop_via_label=MPLS_LABEL_INVALID,
868 create_vrf_if_needed=0,
870 is_resolve_attached=0,
877 classify_table_index=0xFFFFFFFF,
882 :param dst_address_length:
883 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
885 :param next_hop_address:
886 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
887 :param vrf_id: (Default value = 0)
888 :param lookup_in_vrf: (Default value = 0)
889 :param classify_table_index: (Default value = 0xFFFFFFFF)
890 :param create_vrf_if_needed: (Default value = 0)
891 :param is_add: (Default value = 1)
892 :param is_drop: (Default value = 0)
893 :param is_ipv6: (Default value = 0)
894 :param is_local: (Default value = 0)
895 :param is_classify: (Default value = 0)
896 :param is_multipath: (Default value = 0)
897 :param is_multicast: (Default value = 0)
898 :param is_resolve_host: (Default value = 0)
899 :param is_resolve_attached: (Default value = 0)
900 :param not_last: (Default value = 0)
901 :param next_hop_weight: (Default value = 1)
906 self.papi.mpls_route_add_del,
909 'mr_table_id': table_id,
910 'mr_classify_table_index': classify_table_index,
911 'mr_create_table_if_needed': create_vrf_if_needed,
913 'mr_is_classify': is_classify,
914 'mr_is_multipath': is_multipath,
915 'mr_is_multicast': is_multicast,
916 'mr_is_resolve_host': is_resolve_host,
917 'mr_is_resolve_attached': is_resolve_attached,
918 'mr_is_interface_rx': is_interface_rx,
919 'mr_is_rpf_id': is_rpf_id,
920 'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
921 'mr_next_hop_weight': next_hop_weight,
922 'mr_next_hop': next_hop_address,
923 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
924 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
925 'mr_next_hop_table_id': next_hop_table_id,
926 'mr_next_hop_via_label': next_hop_via_label,
927 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
929 def mpls_ip_bind_unbind(
937 create_vrf_if_needed=0,
942 self.papi.mpls_ip_bind_unbind,
943 {'mb_mpls_table_id': table_id,
945 'mb_ip_table_id': ip_table_id,
946 'mb_create_table_if_needed': create_vrf_if_needed,
947 'mb_is_bind': is_bind,
949 'mb_address_length': dst_address_length,
950 'mb_address': dst_address})
952 def mpls_tunnel_add_del(
955 next_hop_proto_is_ip4,
957 next_hop_sw_if_index=0xFFFFFFFF,
960 next_hop_n_out_labels=0,
961 next_hop_out_label_stack=[],
962 next_hop_via_label=MPLS_LABEL_INVALID,
963 create_vrf_if_needed=0,
969 :param dst_address_length:
970 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
972 :param next_hop_address:
973 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
974 :param vrf_id: (Default value = 0)
975 :param lookup_in_vrf: (Default value = 0)
976 :param classify_table_index: (Default value = 0xFFFFFFFF)
977 :param create_vrf_if_needed: (Default value = 0)
978 :param is_add: (Default value = 1)
979 :param is_drop: (Default value = 0)
980 :param is_ipv6: (Default value = 0)
981 :param is_local: (Default value = 0)
982 :param is_classify: (Default value = 0)
983 :param is_multipath: (Default value = 0)
984 :param is_resolve_host: (Default value = 0)
985 :param is_resolve_attached: (Default value = 0)
986 :param next_hop_weight: (Default value = 1)
987 :param is_multicast: (Default value = 0)
991 self.papi.mpls_tunnel_add_del,
992 {'mt_sw_if_index': tun_sw_if_index,
994 'mt_l2_only': l2_only,
995 'mt_is_multicast': is_multicast,
996 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
997 'mt_next_hop_weight': next_hop_weight,
998 'mt_next_hop': next_hop_address,
999 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1000 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1001 'mt_next_hop_table_id': next_hop_table_id,
1002 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1004 def snat_interface_add_del_feature(
1009 """Enable/disable S-NAT feature on the interface
1011 :param sw_if_index: Software index of the interface
1012 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1013 :param is_add: 1 if add, 0 if delete (Default value = 1)
1016 self.papi.snat_interface_add_del_feature,
1018 'is_inside': is_inside,
1019 'sw_if_index': sw_if_index})
1021 def snat_add_static_mapping(
1025 external_sw_if_index=0xFFFFFFFF,
1033 """Add/delete S-NAT static mapping
1035 :param local_ip: Local IP address
1036 :param external_ip: External IP address
1037 :param external_sw_if_index: External interface instead of IP address
1038 :param local_port: Local port number (Default value = 0)
1039 :param external_port: External port number (Default value = 0)
1040 :param addr_only: 1 if address only mapping, 0 if address and port
1041 :param vrf_id: VRF ID
1042 :param protocol: IP protocol (Default value = 0)
1043 :param is_add: 1 if add, 0 if delete (Default value = 1)
1044 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1047 self.papi.snat_add_static_mapping,
1050 'addr_only': addr_only,
1051 'local_ip_address': local_ip,
1052 'external_ip_address': external_ip,
1053 'local_port': local_port,
1054 'external_port': external_port,
1055 'external_sw_if_index': external_sw_if_index,
1057 'protocol': protocol})
1059 def snat_add_address_range(
1066 """Add/del S-NAT address range
1068 :param first_ip_address: First IP address
1069 :param last_ip_address: Last IP address
1070 :param vrf_id: VRF id for the address range
1071 :param is_add: 1 if add, 0 if delete (Default value = 1)
1072 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1075 self.papi.snat_add_address_range,
1077 'first_ip_address': first_ip_address,
1078 'last_ip_address': last_ip_address,
1082 def snat_address_dump(self):
1083 """Dump S-NAT addresses
1084 :return: Dictionary of S-NAT addresses
1086 return self.api(self.papi.snat_address_dump, {})
1088 def snat_interface_dump(self):
1089 """Dump interfaces with S-NAT feature
1090 :return: Dictionary of interfaces with S-NAT feature
1092 return self.api(self.papi.snat_interface_dump, {})
1094 def snat_static_mapping_dump(self):
1095 """Dump S-NAT static mappings
1096 :return: Dictionary of S-NAT static mappings
1098 return self.api(self.papi.snat_static_mapping_dump, {})
1100 def snat_show_config(self):
1101 """Show S-NAT config
1102 :return: S-NAT config parameters
1104 return self.api(self.papi.snat_show_config, {})
1106 def snat_add_interface_addr(
1110 """Add/del S-NAT address from interface
1112 :param sw_if_index: Software index of the interface
1113 :param is_add: 1 if add, 0 if delete (Default value = 1)
1115 return self.api(self.papi.snat_add_del_interface_addr,
1116 {'is_add': is_add, 'sw_if_index': sw_if_index})
1118 def snat_interface_addr_dump(self):
1119 """Dump S-NAT addresses interfaces
1120 :return: Dictionary of S-NAT addresses interfaces
1122 return self.api(self.papi.snat_interface_addr_dump, {})
1129 """Enable/disable S-NAT IPFIX logging
1131 :param domain_id: Observation domain ID (Default value = 1)
1132 :param src_port: Source port number (Default value = 4739)
1133 :param enable: 1 if enable, 0 if disable (Default value = 1)
1136 self.papi.snat_ipfix_enable_disable,
1137 {'domain_id': domain_id,
1138 'src_port': src_port,
1141 def snat_user_session_dump(
1146 """Dump S-NAT user's sessions
1148 :param ip_address: ip adress of the user to be dumped
1149 :param cpu_index: cpu_index on which the user is
1150 :param vrf_id: VRF ID
1151 :return: Dictionary of S-NAT sessions
1154 self.papi.snat_user_session_dump,
1155 {'ip_address': ip_address,
1159 def snat_user_dump(self):
1162 :return: Dictionary of S-NAT users
1164 return self.api(self.papi.snat_user_dump, {})
1166 def snat_add_det_map(
1173 """Add/delete S-NAT deterministic mapping
1175 :param is_add - 1 if add, 0 if delete
1176 :param in_addr - inside IP address
1177 :param in_plen - inside IP address prefix length
1178 :param out_addr - outside IP address
1179 :param out_plen - outside IP address prefix length
1182 self.papi.snat_add_det_map,
1186 'out_addr': out_addr,
1187 'out_plen': out_plen})
1189 def snat_det_forward(
1192 """Get outside address and port range from inside address
1194 :param in_addr - inside IP address
1197 self.papi.snat_det_forward,
1198 {'in_addr': in_addr})
1200 def snat_det_reverse(
1204 """Get inside address from outside address and port
1206 :param out_addr - outside IP address
1207 :param out_port - outside port
1210 self.papi.snat_det_reverse,
1211 {'out_addr': out_addr,
1212 'out_port': out_port})
1214 def snat_det_map_dump(self):
1215 """Dump S-NAT deterministic mappings
1217 :return: Dictionary of S-NAT deterministic mappings
1219 return self.api(self.papi.snat_det_map_dump, {})
1221 def snat_det_set_timeouts(
1224 tcp_established=7440,
1227 """Set values of timeouts for deterministic NAT (in seconds)
1229 :param udp - UDP timeout (Default value = 300)
1230 :param tcp_established - TCP established timeout (Default value = 7440)
1231 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1232 :param icmp - ICMP timeout (Default value = 60)
1235 self.papi.snat_det_set_timeouts,
1237 'tcp_established': tcp_established,
1238 'tcp_transitory': tcp_transitory,
1241 def snat_det_get_timeouts(self):
1242 """Get values of timeouts for deterministic NAT
1244 :return: Timeouts for deterministic NAT (in seconds)
1246 return self.api(self.papi.snat_det_get_timeouts, {})
1248 def snat_det_close_session_out(
1255 """Close CGN session using outside address and port
1257 :param out_addr - outside IP address
1258 :param out_port - outside port
1259 :param ext_addr - external host IP address
1260 :param ext_port - external host port
1261 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1264 self.papi.snat_det_close_session_out,
1265 {'out_addr': out_addr,
1266 'out_port': out_port,
1267 'ext_addr': ext_addr,
1268 'ext_port': ext_port,
1271 def snat_det_close_session_in(
1278 """Close CGN session using inside address and port
1280 :param in_addr - inside IP address
1281 :param in_port - inside port
1282 :param ext_addr - external host IP address
1283 :param ext_port - external host port
1284 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1287 self.papi.snat_det_close_session_in,
1288 {'in_addr': in_addr,
1290 'ext_addr': ext_addr,
1291 'ext_port': ext_port,
1294 def snat_det_session_dump(
1298 """Dump S-NAT deterministic sessions belonging to a user
1300 :param user_addr - inside IP address of the user
1301 :param is_ip4: - 1 if address type is IPv4 (Default value = 1)
1302 :return: Dictionary of S-NAT deterministic sessions
1305 self.papi.snat_det_session_dump,
1307 'user_addr': user_addr})
1309 def control_ping(self):
1310 self.api(self.papi.control_ping)
1312 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1313 detect_mult, local_addr, peer_addr, is_ipv6=0,
1314 bfd_key_id=None, conf_key_id=None):
1315 if bfd_key_id is None:
1316 return self.api(self.papi.bfd_udp_add,
1318 'sw_if_index': sw_if_index,
1319 'desired_min_tx': desired_min_tx,
1320 'required_min_rx': required_min_rx,
1321 'local_addr': local_addr,
1322 'peer_addr': peer_addr,
1324 'detect_mult': detect_mult,
1327 return self.api(self.papi.bfd_udp_add,
1329 'sw_if_index': sw_if_index,
1330 'desired_min_tx': desired_min_tx,
1331 'required_min_rx': required_min_rx,
1332 'local_addr': local_addr,
1333 'peer_addr': peer_addr,
1335 'detect_mult': detect_mult,
1336 'is_authenticated': 1,
1337 'bfd_key_id': bfd_key_id,
1338 'conf_key_id': conf_key_id,
1341 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1342 detect_mult, local_addr, peer_addr, is_ipv6=0):
1343 return self.api(self.papi.bfd_udp_mod,
1345 'sw_if_index': sw_if_index,
1346 'desired_min_tx': desired_min_tx,
1347 'required_min_rx': required_min_rx,
1348 'local_addr': local_addr,
1349 'peer_addr': peer_addr,
1351 'detect_mult': detect_mult,
1354 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1355 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1357 return self.api(self.papi.bfd_udp_auth_activate,
1359 'sw_if_index': sw_if_index,
1360 'local_addr': local_addr,
1361 'peer_addr': peer_addr,
1363 'is_delayed': 1 if is_delayed else 0,
1364 'bfd_key_id': bfd_key_id,
1365 'conf_key_id': conf_key_id,
1368 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1369 is_ipv6=0, is_delayed=False):
1370 return self.api(self.papi.bfd_udp_auth_deactivate,
1372 'sw_if_index': sw_if_index,
1373 'local_addr': local_addr,
1374 'peer_addr': peer_addr,
1376 'is_delayed': 1 if is_delayed else 0,
1379 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1380 return self.api(self.papi.bfd_udp_del,
1382 'sw_if_index': sw_if_index,
1383 'local_addr': local_addr,
1384 'peer_addr': peer_addr,
1388 def bfd_udp_session_dump(self):
1389 return self.api(self.papi.bfd_udp_session_dump, {})
1391 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1392 peer_addr, is_ipv6=0):
1393 return self.api(self.papi.bfd_udp_session_set_flags, {
1394 'admin_up_down': admin_up_down,
1395 'sw_if_index': sw_if_index,
1396 'local_addr': local_addr,
1397 'peer_addr': peer_addr,
1401 def want_bfd_events(self, enable_disable=1):
1402 return self.api(self.papi.want_bfd_events, {
1403 'enable_disable': enable_disable,
1407 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1408 return self.api(self.papi.bfd_auth_set_key, {
1409 'conf_key_id': conf_key_id,
1410 'auth_type': auth_type,
1412 'key_len': len(key),
1415 def bfd_auth_del_key(self, conf_key_id):
1416 return self.api(self.papi.bfd_auth_del_key, {
1417 'conf_key_id': conf_key_id,
1420 def bfd_auth_keys_dump(self):
1421 return self.api(self.papi.bfd_auth_keys_dump, {})
1423 def bfd_udp_set_echo_source(self, sw_if_index):
1424 return self.api(self.papi.bfd_udp_set_echo_source,
1425 {'sw_if_index': sw_if_index})
1427 def bfd_udp_del_echo_source(self):
1428 return self.api(self.papi.bfd_udp_del_echo_source, {})
1430 def classify_add_del_table(
1435 table_index=0xFFFFFFFF,
1437 memory_size=2097152,
1439 next_table_index=0xFFFFFFFF,
1440 miss_next_index=0xFFFFFFFF,
1441 current_data_flag=0,
1442 current_data_offset=0):
1446 :param match_n_vectors: (Default value = 1)
1447 :param table_index: (Default value = 0xFFFFFFFF)
1448 :param nbuckets: (Default value = 2)
1449 :param memory_size: (Default value = 2097152)
1450 :param skip_n_vectors: (Default value = 0)
1451 :param next_table_index: (Default value = 0xFFFFFFFF)
1452 :param miss_next_index: (Default value = 0xFFFFFFFF)
1453 :param current_data_flag: (Default value = 0)
1454 :param current_data_offset: (Default value = 0)
1458 self.papi.classify_add_del_table,
1460 'table_index': table_index,
1461 'nbuckets': nbuckets,
1462 'memory_size': memory_size,
1463 'skip_n_vectors': skip_n_vectors,
1464 'match_n_vectors': match_n_vectors,
1465 'next_table_index': next_table_index,
1466 'miss_next_index': miss_next_index,
1467 'current_data_flag': current_data_flag,
1468 'current_data_offset': current_data_offset,
1471 def classify_add_del_session(
1476 opaque_index=0xFFFFFFFF,
1477 hit_next_index=0xFFFFFFFF,
1485 :param opaque_index: (Default value = 0xFFFFFFFF)
1486 :param hit_next_index: (Default value = 0xFFFFFFFF)
1487 :param advance: (Default value = 0)
1488 :param action: (Default value = 0)
1489 :param metadata: (Default value = 0)
1493 self.papi.classify_add_del_session,
1495 'table_index': table_index,
1496 'hit_next_index': hit_next_index,
1497 'opaque_index': opaque_index,
1500 'metadata': metadata,
1503 def input_acl_set_interface(
1507 ip4_table_index=0xFFFFFFFF,
1508 ip6_table_index=0xFFFFFFFF,
1509 l2_table_index=0xFFFFFFFF):
1513 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1514 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1515 :param l2_table_index: (Default value = 0xFFFFFFFF)
1519 self.papi.input_acl_set_interface,
1520 {'sw_if_index': sw_if_index,
1521 'ip4_table_index': ip4_table_index,
1522 'ip6_table_index': ip6_table_index,
1523 'l2_table_index': l2_table_index,
1526 def set_ipfix_exporter(
1533 collector_port=4739,
1536 self.papi.set_ipfix_exporter,
1538 'collector_address': collector_address,
1539 'collector_port': collector_port,
1540 'src_address': src_address,
1542 'path_mtu': path_mtu,
1543 'template_interval': template_interval,
1544 'udp_checksum': udp_checksum,
1547 def dhcp_proxy_config(self,
1555 self.papi.dhcp_proxy_config,
1557 'rx_vrf_id': rx_table_id,
1558 'server_vrf_id': server_table_id,
1561 'dhcp_server': dhcp_server,
1562 'dhcp_src_address': dhcp_src_address,
1565 def dhcp_proxy_set_vss(self,
1572 self.papi.dhcp_proxy_set_vss,
1581 def ip_mroute_add_del(self,
1586 next_hop_sw_if_index,
1590 create_vrf_if_needed=0,
1597 self.papi.ip_mroute_add_del,
1598 {'next_hop_sw_if_index': next_hop_sw_if_index,
1599 'entry_flags': e_flags,
1600 'itf_flags': i_flags,
1601 'table_id': table_id,
1603 'create_vrf_if_needed': create_vrf_if_needed,
1606 'is_local': is_local,
1607 'grp_address_length': grp_address_length,
1608 'grp_address': grp_address,
1609 'src_address': src_address})
1611 def mfib_signal_dump(self):
1612 return self.api(self.papi.mfib_signal_dump, {})
1614 def ip_mfib_dump(self):
1615 return self.api(self.papi.ip_mfib_dump, {})
1617 def lisp_enable_disable(self, is_enabled):
1619 self.papi.lisp_enable_disable,
1621 'is_en': is_enabled,
1624 def lisp_locator_set(self,
1628 self.papi.lisp_add_del_locator_set,
1631 'locator_set_name': ls_name
1634 def lisp_locator_set_dump(self):
1635 return self.api(self.papi.lisp_locator_set_dump, {})
1637 def lisp_locator(self,
1644 self.papi.lisp_add_del_locator,
1647 'locator_set_name': ls_name,
1648 'sw_if_index': sw_if_index,
1649 'priority': priority,
1653 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1655 self.papi.lisp_locator_dump,
1657 'is_index_set': is_index_set,
1659 'ls_index': ls_index,
1662 def lisp_local_mapping(self,
1672 self.papi.lisp_add_del_local_eid,
1674 'locator_set_name': ls_name,
1676 'eid_type': eid_type,
1678 'prefix_len': prefix_len,
1684 def lisp_eid_table_dump(self,
1692 self.papi.lisp_eid_table_dump,
1695 'prefix_length': prefix_length,
1697 'eid_type': eid_type,
1699 'filter': filter_opt,
1702 def lisp_remote_mapping(self,
1712 self.papi.lisp_add_del_remote_mapping,
1715 'eid_type': eid_type,
1717 'eid_len': eid_prefix_len,
1718 'rloc_num': rlocs_num,
1721 'is_src_dst': is_src_dst,
1724 def lisp_adjacency(self,
1733 self.papi.lisp_add_del_adjacency,
1737 'eid_type': eid_type,
1740 'leid_len': leid_len,
1741 'reid_len': reid_len,
1744 def lisp_adjacencies_get(self, vni=0):
1746 self.papi.lisp_adjacencies_get,
1751 def map_add_domain(self,
1764 self.papi.map_add_domain,
1766 'ip6_prefix': ip6_prefix,
1767 'ip6_prefix_len': ip6_prefix_len,
1768 'ip4_prefix': ip4_prefix,
1769 'ip4_prefix_len': ip4_prefix_len,
1771 'ip6_src_prefix_len': ip6_src_prefix_len,
1772 'ea_bits_len': ea_bits_len,
1773 'psid_offset': psid_offset,
1774 'psid_length': psid_length,
1775 'is_translation': is_translation,