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 VppPapiProvider(object):
32 """VPP-api provider using vpp-papi
34 @property hook: hook object providing before and after api/cli hooks
37 _zero, _negative = range(2)
39 def __init__(self, name, shm_prefix, test_class):
40 self.hook = Hook("vpp-papi-provider")
42 self.shm_prefix = shm_prefix
43 self.test_class = test_class
44 self._expect_api_retval = self._zero
45 self._expect_stack = []
48 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
49 for root, dirnames, filenames in os.walk(install_dir):
50 for filename in fnmatch.filter(filenames, '*.api.json'):
51 jsonfiles.append(os.path.join(root, filename))
53 self.papi = VPP(jsonfiles)
54 self._events = deque()
59 def expect_negative_api_retval(self):
60 """ Expect API failure """
61 self._expect_stack.append(self._expect_api_retval)
62 self._expect_api_retval = self._negative
65 def expect_zero_api_retval(self):
66 """ Expect API success """
67 self._expect_stack.append(self._expect_api_retval)
68 self._expect_api_retval = self._zero
71 def __exit__(self, exc_type, exc_value, traceback):
72 self._expect_api_retval = self._expect_stack.pop()
74 def register_hook(self, hook):
75 """Replace hook registration with new hook
82 def collect_events(self):
83 """ Collect all events from the internal queue and clear the queue. """
85 self._events = deque()
88 def wait_for_event(self, timeout, name=None):
89 """ Wait for and return next event. """
91 self.test_class.logger.debug("Not waiting, event already queued")
92 limit = time.time() + timeout
93 while time.time() < limit:
95 e = self._events.popleft()
96 if name and type(e).__name__ != name:
98 "Unexpected event received: %s, expected: %s" %
99 (type(e).__name__, name))
100 self.test_class.logger.debug("Returning event %s:%s" %
103 time.sleep(0) # yield
105 raise Exception("Event %s did not occur within timeout" % name)
106 raise Exception("Event did not occur within timeout")
108 def __call__(self, name, event):
109 """ Enqueue event in the internal event queue. """
110 # FIXME use the name instead of relying on type(e).__name__ ?
111 # FIXME #2 if this throws, it is eaten silently, Ole?
112 self.test_class.logger.debug("New event: %s: %s" % (name, event))
113 self._events.append(event)
116 """Connect the API to VPP"""
117 self.papi.connect(self.name, self.shm_prefix)
118 self.papi.register_event_callback(self)
120 def disconnect(self):
121 """Disconnect the API from VPP"""
122 self.papi.disconnect()
124 def api(self, api_fn, api_args, expected_retval=0):
125 """ Call API function and check it's return value.
126 Call the appropriate hooks before and after the API call
128 :param api_fn: API function to call
129 :param api_args: tuple of API function arguments
130 :param expected_retval: Expected return value (Default value = 0)
131 :returns: reply from the API
134 self.hook.before_api(api_fn.__name__, api_args)
135 reply = api_fn(**api_args)
136 if self._expect_api_retval == self._negative:
137 if hasattr(reply, 'retval') and reply.retval >= 0:
138 msg = "API call passed unexpectedly: expected negative "\
139 "return value instead of %d in %s" % \
140 (reply.retval, repr(reply))
141 self.test_class.logger.info(msg)
143 elif self._expect_api_retval == self._zero:
144 if hasattr(reply, 'retval') and reply.retval != expected_retval:
145 msg = "API call failed, expected zero return value instead "\
146 "of %d in %s" % (expected_retval, repr(reply))
147 self.test_class.logger.info(msg)
150 raise Exception("Internal error, unexpected value for "
151 "self._expect_api_retval %s" %
152 self._expect_api_retval)
153 self.hook.after_api(api_fn.__name__, api_args)
157 """ Execute a CLI, calling the before/after hooks appropriately.
159 :param cli: CLI to execute
163 self.hook.before_cli(cli)
165 r = self.papi.cli_inband(length=len(cli), cmd=cli)
166 self.hook.after_cli(cli)
167 if hasattr(r, 'reply'):
168 return r.reply.decode().rstrip('\x00')
170 def ppcli(self, cli):
171 """ Helper method to print CLI command in case of info logging level.
173 :param cli: CLI to execute
176 return cli + "\n" + str(self.cli(cli))
178 def _convert_mac(self, mac):
179 return int(mac.replace(":", ""), 16) << 16
181 def show_version(self):
183 return self.papi.show_version()
185 def pg_create_interface(self, pg_index):
191 return self.api(self.papi.pg_create_interface,
192 {"interface_id": pg_index})
194 def sw_interface_dump(self, filter=None):
197 :param filter: (Default value = None)
200 if filter is not None:
201 args = {"name_filter_valid": 1, "name_filter": filter}
204 return self.api(self.papi.sw_interface_dump, args)
206 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
207 """ Set the IPvX Table-id for the Interface
214 return self.api(self.papi.sw_interface_set_table,
215 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
218 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
219 is_ipv6=0, is_add=1, del_all=0):
222 :param addr: param is_ipv6: (Default value = 0)
225 :param is_ipv6: (Default value = 0)
226 :param is_add: (Default value = 1)
227 :param del_all: (Default value = 0)
230 return self.api(self.papi.sw_interface_add_del_address,
231 {'sw_if_index': sw_if_index,
235 'address_length': addr_len,
238 def sw_interface_enable_disable_mpls(self, sw_if_index,
241 Enable/Disable MPLS on the interface
243 :param is_enable: (Default value = 1)
246 return self.api(self.papi.sw_interface_set_mpls_enable,
247 {'sw_if_index': sw_if_index,
248 'enable': is_enable})
250 def sw_interface_ra_suppress(self, sw_if_index):
251 return self.api(self.papi.sw_interface_ip6nd_ra_config,
252 {'sw_if_index': sw_if_index})
254 def ip6_sw_interface_ra_config(self, sw_if_index,
258 return self.api(self.papi.sw_interface_ip6nd_ra_config,
259 {'sw_if_index': sw_if_index,
261 'suppress': suppress,
262 'send_unicast': send_unicast})
264 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
266 Enable/Disable An interface for IPv6
268 return self.api(self.papi.sw_interface_ip6_enable_disable,
269 {'sw_if_index': sw_if_index,
272 def vxlan_add_del_tunnel(
276 mcast_sw_if_index=0xFFFFFFFF,
280 decap_next_index=0xFFFFFFFF,
286 :param is_add: (Default value = 1)
287 :param is_ipv6: (Default value = 0)
288 :param encap_vrf_id: (Default value = 0)
289 :param decap_next_index: (Default value = 0xFFFFFFFF)
290 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
291 :param vni: (Default value = 0)
294 return self.api(self.papi.vxlan_add_del_tunnel,
297 'src_address': src_addr,
298 'dst_address': dst_addr,
299 'mcast_sw_if_index': mcast_sw_if_index,
300 'encap_vrf_id': encap_vrf_id,
301 'decap_next_index': decap_next_index,
304 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
305 learn=1, arp_term=0, is_add=1):
306 """Create/delete bridge domain.
308 :param int bd_id: Bridge domain index.
309 :param int flood: Enable/disable bcast/mcast flooding in the BD.
311 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
313 :param int forward: Enable/disable forwarding on all interfaces in
314 the BD. (Default value = 1)
315 :param int learn: Enable/disable learning on all interfaces in the BD.
317 :param int arp_term: Enable/disable arp termination in the BD.
319 :param int is_add: Add or delete flag. (Default value = 1)
321 return self.api(self.papi.bridge_domain_add_del,
324 'uu_flood': uu_flood,
327 'arp_term': arp_term,
330 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
331 filter_mac=0, bvi_mac=0):
332 """Create/delete L2 FIB entry.
334 :param str mac: MAC address to create FIB entry for.
335 :param int bd_id: Bridge domain index.
336 :param int sw_if_index: Software interface index of the interface.
337 :param int is_add: Add or delete flag. (Default value = 1)
338 :param int static_mac: Set to 1 to create static MAC entry.
340 :param int filter_mac: Set to 1 to drop packet that's source or
341 destination MAC address contains defined MAC address.
343 :param int bvi_mac: Set to 1 to create entry that points to BVI
344 interface. (Default value = 0)
346 return self.api(self.papi.l2fib_add_del,
347 {'mac': self._convert_mac(mac),
349 'sw_if_index': sw_if_index,
351 'static_mac': static_mac,
352 'filter_mac': filter_mac,
355 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
356 shg=0, bvi=0, enable=1):
357 """Add/remove interface to/from bridge domain.
359 :param int sw_if_index: Software interface index of the interface.
360 :param int bd_id: Bridge domain index.
361 :param int shg: Split-horizon group index. (Default value = 0)
362 :param int bvi: Set interface as a bridge group virtual interface.
364 :param int enable: Add or remove interface. (Default value = 1)
366 return self.api(self.papi.sw_interface_set_l2_bridge,
367 {'rx_sw_if_index': sw_if_index,
373 def bridge_flags(self, bd_id, is_set, feature_bitmap):
374 """Enable/disable required feature of the bridge domain with defined ID.
376 :param int bd_id: Bridge domain ID.
377 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
378 :param int feature_bitmap: Bitmap value of the feature to be set:
382 - uu-flood (1 << 3) or
385 return self.api(self.papi.bridge_flags,
388 'feature_bitmap': feature_bitmap})
390 def bridge_domain_dump(self, bd_id=0):
393 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
394 existing bridge domains returned)
395 :return: Dictionary of bridge domain(s) data.
397 return self.api(self.papi.bridge_domain_dump,
400 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
402 """Create or delete unidirectional cross-connect from Tx interface to
405 :param int rx_sw_if_index: Software interface index of Rx interface.
406 :param int tx_sw_if_index: Software interface index of Tx interface.
407 :param int enable: Create cross-connect if equal to 1, delete
408 cross-connect if equal to 0.
411 return self.api(self.papi.sw_interface_set_l2_xconnect,
412 {'rx_sw_if_index': rx_sw_if_index,
413 'tx_sw_if_index': tx_sw_if_index,
416 def sw_interface_set_l2_tag_rewrite(
423 """L2 interface vlan tag rewrite configure request
424 :param client_index - opaque cookie to identify the sender
425 :param context - sender context, to match reply w/ request
426 :param sw_if_index - interface the operation is applied to
427 :param vtr_op - Choose from l2_vtr_op_t enum values
428 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
429 :param tag1 - Needed for any push or translate vtr op
430 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
433 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
434 {'sw_if_index': sw_if_index,
440 def sw_interface_set_flags(self, sw_if_index, admin_up_down,
441 link_up_down=0, deleted=0):
444 :param admin_up_down:
446 :param link_up_down: (Default value = 0)
447 :param deleted: (Default value = 0)
450 return self.api(self.papi.sw_interface_set_flags,
451 {'sw_if_index': sw_if_index,
452 'admin_up_down': admin_up_down,
453 'link_up_down': link_up_down,
456 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
457 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
458 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
459 """Create subinterface
460 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
462 :param sub_id: param inner_vlan:
466 :param no_tags: (Default value = 0)
467 :param one_tag: (Default value = 0)
468 :param two_tags: (Default value = 0)
469 :param dot1ad: (Default value = 0)
470 :param exact_match: (Default value = 0)
471 :param default_sub: (Default value = 0)
472 :param outer_vlan_id_any: (Default value = 0)
473 :param inner_vlan_id_any: (Default value = 0)
477 self.papi.create_subif,
478 {'sw_if_index': sw_if_index,
482 'two_tags': two_tags,
484 'exact_match': exact_match,
485 'default_sub': default_sub,
486 'outer_vlan_id_any': outer_vlan_id_any,
487 'inner_vlan_id_any': inner_vlan_id_any,
488 'outer_vlan_id': outer_vlan,
489 'inner_vlan_id': inner_vlan})
491 def delete_subif(self, sw_if_index):
492 """Delete subinterface
496 return self.api(self.papi.delete_subif,
497 {'sw_if_index': sw_if_index})
499 def create_vlan_subif(self, sw_if_index, vlan):
506 return self.api(self.papi.create_vlan_subif,
507 {'sw_if_index': sw_if_index,
510 def create_loopback(self, mac=''):
513 :param mac: (Optional)
515 return self.api(self.papi.create_loopback,
516 {'mac_address': mac})
518 def delete_loopback(self, sw_if_index):
519 return self.api(self.papi.delete_loopback,
520 {'sw_if_index': sw_if_index, })
522 def ip_add_del_route(
527 next_hop_sw_if_index=0xFFFFFFFF,
531 next_hop_n_out_labels=0,
532 next_hop_out_label_stack=[],
533 next_hop_via_label=MPLS_LABEL_INVALID,
534 create_vrf_if_needed=0,
536 is_resolve_attached=0,
537 classify_table_index=0xFFFFFFFF,
549 :param dst_address_length:
550 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
552 :param next_hop_address:
553 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
554 :param vrf_id: (Default value = 0)
555 :param lookup_in_vrf: (Default value = 0)
556 :param classify_table_index: (Default value = 0xFFFFFFFF)
557 :param create_vrf_if_needed: (Default value = 0)
558 :param is_add: (Default value = 1)
559 :param is_drop: (Default value = 0)
560 :param is_ipv6: (Default value = 0)
561 :param is_local: (Default value = 0)
562 :param is_classify: (Default value = 0)
563 :param is_multipath: (Default value = 0)
564 :param is_resolve_host: (Default value = 0)
565 :param is_resolve_attached: (Default value = 0)
566 :param not_last: (Default value = 0)
567 :param next_hop_weight: (Default value = 1)
572 self.papi.ip_add_del_route,
573 {'next_hop_sw_if_index': next_hop_sw_if_index,
574 'table_id': table_id,
575 'classify_table_index': classify_table_index,
576 'next_hop_table_id': next_hop_table_id,
577 'create_vrf_if_needed': create_vrf_if_needed,
580 'is_unreach': is_unreach,
581 'is_prohibit': is_prohibit,
583 'is_local': is_local,
584 'is_classify': is_classify,
585 'is_multipath': is_multipath,
586 'is_resolve_host': is_resolve_host,
587 'is_resolve_attached': is_resolve_attached,
588 'not_last': not_last,
589 'next_hop_weight': next_hop_weight,
590 'dst_address_length': dst_address_length,
591 'dst_address': dst_address,
592 'next_hop_address': next_hop_address,
593 'next_hop_n_out_labels': next_hop_n_out_labels,
594 'next_hop_via_label': next_hop_via_label,
595 'next_hop_out_label_stack': next_hop_out_label_stack})
597 def ip_fib_dump(self):
598 return self.api(self.papi.ip_fib_dump, {})
600 def ip_neighbor_add_del(self,
609 """ Add neighbor MAC to IPv4 or IPv6 address.
614 :param vrf_id: (Default value = 0)
615 :param is_add: (Default value = 1)
616 :param is_ipv6: (Default value = 0)
617 :param is_static: (Default value = 0)
621 self.papi.ip_neighbor_add_del,
623 'sw_if_index': sw_if_index,
626 'is_static': is_static,
627 'mac_address': mac_address,
628 'dst_address': dst_address
636 """ Reset VRF (remove all routes etc.) request.
638 :param int vrf_id: ID of the FIB table / VRF to reset.
639 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
653 """ Reset VRF (remove all routes etc.) request.
655 :param int vrf_id: ID of the FIB table / VRF to reset.
656 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
671 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
680 def sw_interface_span_enable_disable(
681 self, sw_if_index_from, sw_if_index_to, state=1):
684 :param sw_if_index_from:
685 :param sw_if_index_to:
688 return self.api(self.papi.sw_interface_span_enable_disable,
689 {'sw_if_index_from': sw_if_index_from,
690 'sw_if_index_to': sw_if_index_to,
693 def gre_tunnel_add_del(self,
704 :param outer_fib_id: (Default value = 0)
705 :param is_add: (Default value = 1)
706 :param is_ipv6: (Default value = 0)
707 :param is_teb: (Default value = 0)
711 self.papi.gre_add_del_tunnel,
715 'src_address': src_address,
716 'dst_address': dst_address,
717 'outer_fib_id': outer_fib_id}
720 def mpls_route_add_del(
724 next_hop_proto_is_ip4,
726 next_hop_sw_if_index=0xFFFFFFFF,
730 next_hop_n_out_labels=0,
731 next_hop_out_label_stack=[],
732 next_hop_via_label=MPLS_LABEL_INVALID,
733 create_vrf_if_needed=0,
735 is_resolve_attached=0,
739 classify_table_index=0xFFFFFFFF,
744 :param dst_address_length:
745 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
747 :param next_hop_address:
748 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
749 :param vrf_id: (Default value = 0)
750 :param lookup_in_vrf: (Default value = 0)
751 :param classify_table_index: (Default value = 0xFFFFFFFF)
752 :param create_vrf_if_needed: (Default value = 0)
753 :param is_add: (Default value = 1)
754 :param is_drop: (Default value = 0)
755 :param is_ipv6: (Default value = 0)
756 :param is_local: (Default value = 0)
757 :param is_classify: (Default value = 0)
758 :param is_multipath: (Default value = 0)
759 :param is_resolve_host: (Default value = 0)
760 :param is_resolve_attached: (Default value = 0)
761 :param not_last: (Default value = 0)
762 :param next_hop_weight: (Default value = 1)
767 self.papi.mpls_route_add_del,
770 'mr_table_id': table_id,
771 'mr_classify_table_index': classify_table_index,
772 'mr_create_table_if_needed': create_vrf_if_needed,
774 'mr_is_classify': is_classify,
775 'mr_is_multipath': is_multipath,
776 'mr_is_resolve_host': is_resolve_host,
777 'mr_is_resolve_attached': is_resolve_attached,
778 'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
779 'mr_next_hop_weight': next_hop_weight,
780 'mr_next_hop': next_hop_address,
781 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
782 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
783 'mr_next_hop_table_id': next_hop_table_id,
784 'mr_next_hop_via_label': next_hop_via_label,
785 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
787 def mpls_ip_bind_unbind(
795 create_vrf_if_needed=0,
800 self.papi.mpls_ip_bind_unbind,
801 {'mb_mpls_table_id': table_id,
803 'mb_ip_table_id': ip_table_id,
804 'mb_create_table_if_needed': create_vrf_if_needed,
805 'mb_is_bind': is_bind,
807 'mb_address_length': dst_address_length,
808 'mb_address': dst_address})
810 def mpls_tunnel_add_del(
813 next_hop_proto_is_ip4,
815 next_hop_sw_if_index=0xFFFFFFFF,
818 next_hop_n_out_labels=0,
819 next_hop_out_label_stack=[],
820 next_hop_via_label=MPLS_LABEL_INVALID,
821 create_vrf_if_needed=0,
826 :param dst_address_length:
827 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
829 :param next_hop_address:
830 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
831 :param vrf_id: (Default value = 0)
832 :param lookup_in_vrf: (Default value = 0)
833 :param classify_table_index: (Default value = 0xFFFFFFFF)
834 :param create_vrf_if_needed: (Default value = 0)
835 :param is_add: (Default value = 1)
836 :param is_drop: (Default value = 0)
837 :param is_ipv6: (Default value = 0)
838 :param is_local: (Default value = 0)
839 :param is_classify: (Default value = 0)
840 :param is_multipath: (Default value = 0)
841 :param is_resolve_host: (Default value = 0)
842 :param is_resolve_attached: (Default value = 0)
843 :param not_last: (Default value = 0)
844 :param next_hop_weight: (Default value = 1)
848 self.papi.mpls_tunnel_add_del,
849 {'mt_sw_if_index': tun_sw_if_index,
851 'mt_l2_only': l2_only,
852 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
853 'mt_next_hop_weight': next_hop_weight,
854 'mt_next_hop': next_hop_address,
855 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
856 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
857 'mt_next_hop_table_id': next_hop_table_id,
858 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
860 def snat_interface_add_del_feature(
865 """Enable/disable S-NAT feature on the interface
867 :param sw_if_index: Software index of the interface
868 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
869 :param is_add: 1 if add, 0 if delete (Default value = 1)
872 self.papi.snat_interface_add_del_feature,
874 'is_inside': is_inside,
875 'sw_if_index': sw_if_index})
877 def snat_add_static_mapping(
881 external_sw_if_index=0xFFFFFFFF,
888 """Add/delete S-NAT static mapping
890 :param local_ip: Local IP address
891 :param external_ip: External IP address
892 :param external_sw_if_index: External interface instead of IP address
893 :param local_port: Local port number (Default value = 0)
894 :param external_port: External port number (Default value = 0)
895 :param addr_only: 1 if address only mapping, 0 if address and port
896 :param vrf_id: VRF ID
897 :param is_add: 1 if add, 0 if delete (Default value = 1)
898 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
901 self.papi.snat_add_static_mapping,
904 'addr_only': addr_only,
905 'local_ip_address': local_ip,
906 'external_ip_address': external_ip,
907 'local_port': local_port,
908 'external_port': external_port,
909 'external_sw_if_index': external_sw_if_index,
912 def snat_add_address_range(
918 """Add/del S-NAT address range
920 :param first_ip_address: First IP address
921 :param last_ip_address: Last IP address
922 :param is_add: 1 if add, 0 if delete (Default value = 1)
923 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
926 self.papi.snat_add_address_range,
928 'first_ip_address': first_ip_address,
929 'last_ip_address': last_ip_address,
932 def snat_address_dump(self):
933 """Dump S-NAT addresses
934 :return: Dictionary of S-NAT addresses
936 return self.api(self.papi.snat_address_dump, {})
938 def snat_interface_dump(self):
939 """Dump interfaces with S-NAT feature
940 :return: Dictionary of interfaces with S-NAT feature
942 return self.api(self.papi.snat_interface_dump, {})
944 def snat_static_mapping_dump(self):
945 """Dump S-NAT static mappings
946 :return: Dictionary of S-NAT static mappings
948 return self.api(self.papi.snat_static_mapping_dump, {})
950 def snat_show_config(self):
952 :return: S-NAT config parameters
954 return self.api(self.papi.snat_show_config, {})
956 def snat_add_interface_addr(
960 """Add/del S-NAT address from interface
962 :param sw_if_index: Software index of the interface
963 :param is_add: 1 if add, 0 if delete (Default value = 1)
965 return self.api(self.papi.snat_add_del_interface_addr,
966 {'is_add': is_add, 'sw_if_index': sw_if_index})
968 def snat_interface_addr_dump(self):
969 """Dump S-NAT addresses interfaces
970 :return: Dictionary of S-NAT addresses interfaces
972 return self.api(self.papi.snat_interface_addr_dump, {})
979 """Enable/disable S-NAT IPFIX logging
981 :param domain_id: Observation domain ID (Default value = 1)
982 :param src_port: Source port number (Default value = 4739)
983 :param enable: 1 if enable, 0 if disable (Default value = 1)
986 self.papi.snat_ipfix_enable_disable,
987 {'domain_id': domain_id,
988 'src_port': src_port,
991 def control_ping(self):
992 self.api(self.papi.control_ping)
994 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
995 detect_mult, local_addr, peer_addr, is_ipv6=0,
996 bfd_key_id=None, conf_key_id=None):
997 if bfd_key_id is None:
998 return self.api(self.papi.bfd_udp_add,
1000 'sw_if_index': sw_if_index,
1001 'desired_min_tx': desired_min_tx,
1002 'required_min_rx': required_min_rx,
1003 'local_addr': local_addr,
1004 'peer_addr': peer_addr,
1006 'detect_mult': detect_mult,
1009 return self.api(self.papi.bfd_udp_add,
1011 'sw_if_index': sw_if_index,
1012 'desired_min_tx': desired_min_tx,
1013 'required_min_rx': required_min_rx,
1014 'local_addr': local_addr,
1015 'peer_addr': peer_addr,
1017 'detect_mult': detect_mult,
1018 'is_authenticated': 1,
1019 'bfd_key_id': bfd_key_id,
1020 'conf_key_id': conf_key_id,
1023 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1024 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1026 return self.api(self.papi.bfd_udp_auth_activate,
1028 'sw_if_index': sw_if_index,
1029 'local_addr': local_addr,
1030 'peer_addr': peer_addr,
1032 'is_delayed': 1 if is_delayed else 0,
1033 'bfd_key_id': bfd_key_id,
1034 'conf_key_id': conf_key_id,
1037 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1038 is_ipv6=0, is_delayed=False):
1039 return self.api(self.papi.bfd_udp_auth_deactivate,
1041 'sw_if_index': sw_if_index,
1042 'local_addr': local_addr,
1043 'peer_addr': peer_addr,
1045 'is_delayed': 1 if is_delayed else 0,
1048 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1049 return self.api(self.papi.bfd_udp_del,
1051 'sw_if_index': sw_if_index,
1052 'local_addr': local_addr,
1053 'peer_addr': peer_addr,
1057 def bfd_udp_session_dump(self):
1058 return self.api(self.papi.bfd_udp_session_dump, {})
1060 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1061 peer_addr, is_ipv6=0):
1062 return self.api(self.papi.bfd_udp_session_set_flags, {
1063 'admin_up_down': admin_up_down,
1064 'sw_if_index': sw_if_index,
1065 'local_addr': local_addr,
1066 'peer_addr': peer_addr,
1070 def want_bfd_events(self, enable_disable=1):
1071 return self.api(self.papi.want_bfd_events, {
1072 'enable_disable': enable_disable,
1076 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1077 return self.api(self.papi.bfd_auth_set_key, {
1078 'conf_key_id': conf_key_id,
1079 'auth_type': auth_type,
1081 'key_len': len(key),
1084 def bfd_auth_del_key(self, conf_key_id):
1085 return self.api(self.papi.bfd_auth_del_key, {
1086 'conf_key_id': conf_key_id,
1089 def bfd_auth_keys_dump(self):
1090 return self.api(self.papi.bfd_auth_keys_dump, {})
1092 def classify_add_del_table(
1097 table_index=0xFFFFFFFF,
1099 memory_size=2097152,
1101 next_table_index=0xFFFFFFFF,
1102 miss_next_index=0xFFFFFFFF,
1103 current_data_flag=0,
1104 current_data_offset=0):
1108 :param match_n_vectors: (Default value = 1)
1109 :param table_index: (Default value = 0xFFFFFFFF)
1110 :param nbuckets: (Default value = 2)
1111 :param memory_size: (Default value = 2097152)
1112 :param skip_n_vectors: (Default value = 0)
1113 :param next_table_index: (Default value = 0xFFFFFFFF)
1114 :param miss_next_index: (Default value = 0xFFFFFFFF)
1115 :param current_data_flag: (Default value = 0)
1116 :param current_data_offset: (Default value = 0)
1120 self.papi.classify_add_del_table,
1122 'table_index': table_index,
1123 'nbuckets': nbuckets,
1124 'memory_size': memory_size,
1125 'skip_n_vectors': skip_n_vectors,
1126 'match_n_vectors': match_n_vectors,
1127 'next_table_index': next_table_index,
1128 'miss_next_index': miss_next_index,
1129 'current_data_flag': current_data_flag,
1130 'current_data_offset': current_data_offset,
1133 def classify_add_del_session(
1138 opaque_index=0xFFFFFFFF,
1139 hit_next_index=0xFFFFFFFF,
1147 :param opaque_index: (Default value = 0xFFFFFFFF)
1148 :param hit_next_index: (Default value = 0xFFFFFFFF)
1149 :param advance: (Default value = 0)
1150 :param action: (Default value = 0)
1151 :param metadata: (Default value = 0)
1155 self.papi.classify_add_del_session,
1157 'table_index': table_index,
1158 'hit_next_index': hit_next_index,
1159 'opaque_index': opaque_index,
1162 'metadata': metadata,
1165 def input_acl_set_interface(
1169 ip4_table_index=0xFFFFFFFF,
1170 ip6_table_index=0xFFFFFFFF,
1171 l2_table_index=0xFFFFFFFF):
1175 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1176 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1177 :param l2_table_index: (Default value = 0xFFFFFFFF)
1181 self.papi.input_acl_set_interface,
1182 {'sw_if_index': sw_if_index,
1183 'ip4_table_index': ip4_table_index,
1184 'ip6_table_index': ip6_table_index,
1185 'l2_table_index': l2_table_index,
1188 def set_ipfix_exporter(
1195 collector_port=4739,
1198 self.papi.set_ipfix_exporter,
1200 'collector_address': collector_address,
1201 'collector_port': collector_port,
1202 'src_address': src_address,
1204 'path_mtu': path_mtu,
1205 'template_interval': template_interval,
1206 'udp_checksum': udp_checksum,
1209 def dhcp_proxy_config(self,
1216 insert_circuit_id=0):
1218 self.papi.dhcp_proxy_config_2,
1220 'rx_vrf_id': rx_table_id,
1221 'server_vrf_id': server_table_id,
1224 'insert_circuit_id': insert_circuit_id,
1225 'dhcp_server': dhcp_server,
1226 'dhcp_src_address': dhcp_src_address,
1229 def dhcp_proxy_set_vss(self,
1236 self.papi.dhcp_proxy_set_vss,
1245 def ip_mroute_add_del(self,
1250 next_hop_sw_if_index,
1253 create_vrf_if_needed=0,
1260 self.papi.ip_mroute_add_del,
1261 {'next_hop_sw_if_index': next_hop_sw_if_index,
1262 'entry_flags': e_flags,
1263 'itf_flags': i_flags,
1264 'create_vrf_if_needed': create_vrf_if_needed,
1267 'is_local': is_local,
1268 'grp_address_length': grp_address_length,
1269 'grp_address': grp_address,
1270 'src_address': src_address})
1272 def mfib_signal_dump(self):
1273 return self.api(self.papi.mfib_signal_dump, {})