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
39 class UnexpectedApiReturnValueError(Exception):
40 """ exception raised when the API return value is unexpected """
44 class VppPapiProvider(object):
45 """VPP-api provider using vpp-papi
47 @property hook: hook object providing before and after api/cli hooks
50 _zero, _negative = range(2)
52 def __init__(self, name, shm_prefix, test_class):
53 self.hook = Hook("vpp-papi-provider")
55 self.shm_prefix = shm_prefix
56 self.test_class = test_class
57 self._expect_api_retval = self._zero
58 self._expect_stack = []
61 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
62 for root, dirnames, filenames in os.walk(install_dir):
63 for filename in fnmatch.filter(filenames, '*.api.json'):
64 jsonfiles.append(os.path.join(root, filename))
66 self.vpp = VPP(jsonfiles, logger=test_class.logger)
67 self._events = deque()
72 def expect_negative_api_retval(self):
73 """ Expect API failure """
74 self._expect_stack.append(self._expect_api_retval)
75 self._expect_api_retval = self._negative
78 def expect_zero_api_retval(self):
79 """ Expect API success """
80 self._expect_stack.append(self._expect_api_retval)
81 self._expect_api_retval = self._zero
84 def __exit__(self, exc_type, exc_value, traceback):
85 self._expect_api_retval = self._expect_stack.pop()
87 def register_hook(self, hook):
88 """Replace hook registration with new hook
95 def collect_events(self):
96 """ Collect all events from the internal queue and clear the queue. """
98 self._events = deque()
101 def wait_for_event(self, timeout, name=None):
102 """ Wait for and return next event. """
104 self.test_class.logger.debug("Expecting event '%s' within %ss",
107 self.test_class.logger.debug("Expecting event within %ss",
110 self.test_class.logger.debug("Not waiting, event already queued")
111 limit = time.time() + timeout
112 while time.time() < limit:
114 e = self._events.popleft()
115 if name and type(e).__name__ != name:
117 "Unexpected event received: %s, expected: %s" %
118 (type(e).__name__, name))
119 self.test_class.logger.debug("Returning event %s:%s" %
122 time.sleep(0) # yield
123 raise Exception("Event did not occur within timeout")
125 def __call__(self, name, event):
126 """ Enqueue event in the internal event queue. """
127 # FIXME use the name instead of relying on type(e).__name__ ?
128 # FIXME #2 if this throws, it is eaten silently, Ole?
129 self.test_class.logger.debug("New event: %s: %s" % (name, event))
130 self._events.append(event)
133 """Connect the API to VPP"""
134 self.vpp.connect(self.name, self.shm_prefix)
135 self.papi = self.vpp.api
136 self.vpp.register_event_callback(self)
138 def disconnect(self):
139 """Disconnect the API from VPP"""
140 self.vpp.disconnect()
142 def api(self, api_fn, api_args, expected_retval=0):
143 """ Call API function and check it's return value.
144 Call the appropriate hooks before and after the API call
146 :param api_fn: API function to call
147 :param api_args: tuple of API function arguments
148 :param expected_retval: Expected return value (Default value = 0)
149 :returns: reply from the API
152 self.hook.before_api(api_fn.__name__, api_args)
153 reply = api_fn(**api_args)
154 if self._expect_api_retval == self._negative:
155 if hasattr(reply, 'retval') and reply.retval >= 0:
156 msg = "API call passed unexpectedly: expected negative "\
157 "return value instead of %d in %s" % \
158 (reply.retval, repr(reply))
159 self.test_class.logger.info(msg)
160 raise UnexpectedApiReturnValueError(msg)
161 elif self._expect_api_retval == self._zero:
162 if hasattr(reply, 'retval') and reply.retval != expected_retval:
163 msg = "API call failed, expected %d return value instead "\
164 "of %d in %s" % (expected_retval, reply.retval,
166 self.test_class.logger.info(msg)
167 raise UnexpectedApiReturnValueError(msg)
169 raise Exception("Internal error, unexpected value for "
170 "self._expect_api_retval %s" %
171 self._expect_api_retval)
172 self.hook.after_api(api_fn.__name__, api_args)
176 """ Execute a CLI, calling the before/after hooks appropriately.
178 :param cli: CLI to execute
182 self.hook.before_cli(cli)
184 r = self.papi.cli_inband(length=len(cli), cmd=cli)
185 self.hook.after_cli(cli)
186 if hasattr(r, 'reply'):
187 return r.reply.decode().rstrip('\x00')
189 def ppcli(self, cli):
190 """ Helper method to print CLI command in case of info logging level.
192 :param cli: CLI to execute
195 return cli + "\n" + str(self.cli(cli))
197 def _convert_mac(self, mac):
198 return int(mac.replace(":", ""), 16) << 16
200 def show_version(self):
202 return self.api(self.papi.show_version, {})
204 def pg_create_interface(self, pg_index):
210 return self.api(self.papi.pg_create_interface,
211 {"interface_id": pg_index})
213 def sw_interface_dump(self, filter=None):
216 :param filter: (Default value = None)
219 if filter is not None:
220 args = {"name_filter_valid": 1, "name_filter": filter}
223 return self.api(self.papi.sw_interface_dump, args)
225 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
226 """ Set the IPvX Table-id for the Interface
233 return self.api(self.papi.sw_interface_set_table,
234 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
237 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
238 is_ipv6=0, is_add=1, del_all=0):
241 :param addr: param is_ipv6: (Default value = 0)
244 :param is_ipv6: (Default value = 0)
245 :param is_add: (Default value = 1)
246 :param del_all: (Default value = 0)
249 return self.api(self.papi.sw_interface_add_del_address,
250 {'sw_if_index': sw_if_index,
254 'address_length': addr_len,
257 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
259 """ Set the Interface to be unnumbered
261 :param is_add: (Default value = 1)
262 :param sw_if_index - interface That will be unnumbered
263 :param ip_sw_if_index - interface with an IP addres
266 return self.api(self.papi.sw_interface_set_unnumbered,
267 {'sw_if_index': ip_sw_if_index,
268 'unnumbered_sw_if_index': sw_if_index,
271 def sw_interface_enable_disable_mpls(self, sw_if_index,
274 Enable/Disable MPLS on the interface
276 :param is_enable: (Default value = 1)
279 return self.api(self.papi.sw_interface_set_mpls_enable,
280 {'sw_if_index': sw_if_index,
281 'enable': is_enable})
283 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
284 return self.api(self.papi.sw_interface_ip6nd_ra_config,
285 {'sw_if_index': sw_if_index,
286 'suppress': suppress})
288 def set_ip_flow_hash(self,
297 return self.api(self.papi.set_ip_flow_hash,
307 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
308 return self.api(self.papi.ip6nd_proxy_add_del,
310 'sw_if_index': sw_if_index,
313 def ip6_sw_interface_ra_config(self, sw_if_index,
317 return self.api(self.papi.sw_interface_ip6nd_ra_config,
318 {'sw_if_index': sw_if_index,
320 'suppress': suppress,
321 'send_unicast': send_unicast})
323 def ip6_sw_interface_ra_prefix(self,
333 val_lifetime=0xffffffff,
334 pref_lifetime=0xffffffff):
335 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
336 {'sw_if_index': sw_if_index,
338 'address_length': address_length,
339 'use_default': use_default,
340 'no_advertise': no_advertise,
341 'off_link': off_link,
342 'no_autoconfig': no_autoconfig,
343 'no_onlink': no_onlink,
345 'val_lifetime': val_lifetime,
346 'pref_lifetime': pref_lifetime})
348 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
350 Enable/Disable An interface for IPv6
352 return self.api(self.papi.sw_interface_ip6_enable_disable,
353 {'sw_if_index': sw_if_index,
356 def vxlan_add_del_tunnel(
360 mcast_sw_if_index=0xFFFFFFFF,
364 decap_next_index=0xFFFFFFFF,
370 :param is_add: (Default value = 1)
371 :param is_ipv6: (Default value = 0)
372 :param encap_vrf_id: (Default value = 0)
373 :param decap_next_index: (Default value = 0xFFFFFFFF)
374 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
375 :param vni: (Default value = 0)
378 return self.api(self.papi.vxlan_add_del_tunnel,
381 'src_address': src_addr,
382 'dst_address': dst_addr,
383 'mcast_sw_if_index': mcast_sw_if_index,
384 'encap_vrf_id': encap_vrf_id,
385 'decap_next_index': decap_next_index,
388 def geneve_add_del_tunnel(
392 mcast_sw_if_index=0xFFFFFFFF,
396 decap_next_index=0xFFFFFFFF,
402 :param is_add: (Default value = 1)
403 :param is_ipv6: (Default value = 0)
404 :param encap_vrf_id: (Default value = 0)
405 :param decap_next_index: (Default value = 0xFFFFFFFF)
406 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
407 :param vni: (Default value = 0)
410 return self.api(self.papi.geneve_add_del_tunnel,
413 'local_address': local_addr,
414 'remote_address': remote_addr,
415 'mcast_sw_if_index': mcast_sw_if_index,
416 'encap_vrf_id': encap_vrf_id,
417 'decap_next_index': decap_next_index,
420 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
421 learn=1, arp_term=0, is_add=1):
422 """Create/delete bridge domain.
424 :param int bd_id: Bridge domain index.
425 :param int flood: Enable/disable bcast/mcast flooding in the BD.
427 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
429 :param int forward: Enable/disable forwarding on all interfaces in
430 the BD. (Default value = 1)
431 :param int learn: Enable/disable learning on all interfaces in the BD.
433 :param int arp_term: Enable/disable arp termination in the BD.
435 :param int is_add: Add or delete flag. (Default value = 1)
437 return self.api(self.papi.bridge_domain_add_del,
440 'uu_flood': uu_flood,
443 'arp_term': arp_term,
446 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
447 return self.api(self.papi.bd_ip_mac_add_del,
454 def want_ip4_arp_events(self, enable_disable=1, address=0):
455 return self.api(self.papi.want_ip4_arp_events,
456 {'enable_disable': enable_disable,
458 'pid': os.getpid(), })
460 def want_ip6_nd_events(self, enable_disable=1, address=0):
461 return self.api(self.papi.want_ip6_nd_events,
462 {'enable_disable': enable_disable,
464 'pid': os.getpid(), })
466 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
467 max_macs_in_event=0, learn_limit=0):
468 return self.api(self.papi.want_l2_macs_events,
469 {'enable_disable': enable_disable,
470 'scan_delay': scan_delay,
471 'max_macs_in_event': max_macs_in_event,
472 'learn_limit': learn_limit,
473 'pid': os.getpid(), })
475 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
476 filter_mac=0, bvi_mac=0):
477 """Create/delete L2 FIB entry.
479 :param str mac: MAC address to create FIB entry for.
480 :param int bd_id: Bridge domain index.
481 :param int sw_if_index: Software interface index of the interface.
482 :param int is_add: Add or delete flag. (Default value = 1)
483 :param int static_mac: Set to 1 to create static MAC entry.
485 :param int filter_mac: Set to 1 to drop packet that's source or
486 destination MAC address contains defined MAC address.
488 :param int bvi_mac: Set to 1 to create entry that points to BVI
489 interface. (Default value = 0)
491 return self.api(self.papi.l2fib_add_del,
492 {'mac': self._convert_mac(mac),
494 'sw_if_index': sw_if_index,
496 'static_mac': static_mac,
497 'filter_mac': filter_mac,
500 def l2fib_flush_int(self, sw_if_index):
501 """Flush L2 FIB entries for sw_if_index.
503 :param int sw_if_index: Software interface index of the interface.
505 return self.api(self.papi.l2fib_flush_int,
506 {'sw_if_index': sw_if_index})
508 def l2fib_flush_bd(self, bd_id):
509 """Flush L2 FIB entries for bd_id.
511 :param int sw_if_index: Bridge Domain id.
513 return self.api(self.papi.l2fib_flush_bd,
516 def l2fib_flush_all(self):
519 return self.api(self.papi.l2fib_flush_all, {})
521 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
522 shg=0, bvi=0, enable=1):
523 """Add/remove interface to/from bridge domain.
525 :param int sw_if_index: Software interface index of the interface.
526 :param int bd_id: Bridge domain index.
527 :param int shg: Split-horizon group index. (Default value = 0)
528 :param int bvi: Set interface as a bridge group virtual interface.
530 :param int enable: Add or remove interface. (Default value = 1)
532 return self.api(self.papi.sw_interface_set_l2_bridge,
533 {'rx_sw_if_index': sw_if_index,
539 def bridge_flags(self, bd_id, is_set, feature_bitmap):
540 """Enable/disable required feature of the bridge domain with defined ID.
542 :param int bd_id: Bridge domain ID.
543 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
544 :param int feature_bitmap: Bitmap value of the feature to be set:
548 - uu-flood (1 << 3) or
551 return self.api(self.papi.bridge_flags,
554 'feature_bitmap': feature_bitmap})
556 def bridge_domain_dump(self, bd_id=0):
559 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
560 existing bridge domains returned)
561 :return: Dictionary of bridge domain(s) data.
563 return self.api(self.papi.bridge_domain_dump,
566 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
568 """Create or delete unidirectional cross-connect from Tx interface to
571 :param int rx_sw_if_index: Software interface index of Rx interface.
572 :param int tx_sw_if_index: Software interface index of Tx interface.
573 :param int enable: Create cross-connect if equal to 1, delete
574 cross-connect if equal to 0.
577 return self.api(self.papi.sw_interface_set_l2_xconnect,
578 {'rx_sw_if_index': rx_sw_if_index,
579 'tx_sw_if_index': tx_sw_if_index,
582 def sw_interface_set_l2_tag_rewrite(
589 """L2 interface vlan tag rewrite configure request
590 :param client_index - opaque cookie to identify the sender
591 :param context - sender context, to match reply w/ request
592 :param sw_if_index - interface the operation is applied to
593 :param vtr_op - Choose from l2_vtr_op_t enum values
594 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
595 :param tag1 - Needed for any push or translate vtr op
596 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
599 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
600 {'sw_if_index': sw_if_index,
606 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
609 :param admin_up_down:
613 return self.api(self.papi.sw_interface_set_flags,
614 {'sw_if_index': sw_if_index,
615 'admin_up_down': admin_up_down})
617 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
618 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
619 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
620 """Create subinterface
621 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
623 :param sub_id: param inner_vlan:
627 :param no_tags: (Default value = 0)
628 :param one_tag: (Default value = 0)
629 :param two_tags: (Default value = 0)
630 :param dot1ad: (Default value = 0)
631 :param exact_match: (Default value = 0)
632 :param default_sub: (Default value = 0)
633 :param outer_vlan_id_any: (Default value = 0)
634 :param inner_vlan_id_any: (Default value = 0)
638 self.papi.create_subif,
639 {'sw_if_index': sw_if_index,
643 'two_tags': two_tags,
645 'exact_match': exact_match,
646 'default_sub': default_sub,
647 'outer_vlan_id_any': outer_vlan_id_any,
648 'inner_vlan_id_any': inner_vlan_id_any,
649 'outer_vlan_id': outer_vlan,
650 'inner_vlan_id': inner_vlan})
652 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
653 """Create p2p ethernet subinterface
655 :param sw_if_index: main (parent) interface
656 :param remote_mac: client (remote) mac address
660 self.papi.p2p_ethernet_add,
661 {'parent_if_index': sw_if_index,
662 'remote_mac': remote_mac,
663 'subif_id': subif_id})
665 def delete_subif(self, sw_if_index):
666 """Delete subinterface
670 return self.api(self.papi.delete_subif,
671 {'sw_if_index': sw_if_index})
673 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
674 """Delete p2p ethernet subinterface
676 :param sw_if_index: main (parent) interface
677 :param remote_mac: client (remote) mac address
681 self.papi.p2p_ethernet_del,
682 {'parent_if_index': sw_if_index,
683 'remote_mac': remote_mac})
685 def create_vlan_subif(self, sw_if_index, vlan):
692 return self.api(self.papi.create_vlan_subif,
693 {'sw_if_index': sw_if_index,
696 def create_loopback(self, mac=''):
699 :param mac: (Optional)
701 return self.api(self.papi.create_loopback,
702 {'mac_address': mac})
704 def delete_loopback(self, sw_if_index):
705 return self.api(self.papi.delete_loopback,
706 {'sw_if_index': sw_if_index, })
708 def ip_table_add_del(self,
715 :param is_add: (Default value = 1)
716 :param is_ipv6: (Default value = 0)
721 self.papi.ip_table_add_del,
722 {'table_id': table_id,
726 def ip_add_del_route(
731 next_hop_sw_if_index=0xFFFFFFFF,
735 next_hop_n_out_labels=0,
736 next_hop_out_label_stack=[],
737 next_hop_via_label=MPLS_LABEL_INVALID,
739 is_resolve_attached=0,
740 classify_table_index=0xFFFFFFFF,
753 :param dst_address_length:
754 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
756 :param next_hop_address:
757 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
758 :param vrf_id: (Default value = 0)
759 :param lookup_in_vrf: (Default value = 0)
760 :param classify_table_index: (Default value = 0xFFFFFFFF)
761 :param is_add: (Default value = 1)
762 :param is_drop: (Default value = 0)
763 :param is_ipv6: (Default value = 0)
764 :param is_local: (Default value = 0)
765 :param is_classify: (Default value = 0)
766 :param is_multipath: (Default value = 0)
767 :param is_resolve_host: (Default value = 0)
768 :param is_resolve_attached: (Default value = 0)
769 :param not_last: (Default value = 0)
770 :param next_hop_weight: (Default value = 1)
775 self.papi.ip_add_del_route,
776 {'next_hop_sw_if_index': next_hop_sw_if_index,
777 'table_id': table_id,
778 'classify_table_index': classify_table_index,
779 'next_hop_table_id': next_hop_table_id,
782 'is_unreach': is_unreach,
783 'is_prohibit': is_prohibit,
785 'is_local': is_local,
786 'is_classify': is_classify,
787 'is_multipath': is_multipath,
788 'is_resolve_host': is_resolve_host,
789 'is_resolve_attached': is_resolve_attached,
790 'is_l2_bridged': is_l2_bridged,
791 'not_last': not_last,
792 'next_hop_weight': next_hop_weight,
793 'dst_address_length': dst_address_length,
794 'dst_address': dst_address,
795 'next_hop_address': next_hop_address,
796 'next_hop_n_out_labels': next_hop_n_out_labels,
797 'next_hop_via_label': next_hop_via_label,
798 'next_hop_out_label_stack': next_hop_out_label_stack})
800 def ip_fib_dump(self):
801 return self.api(self.papi.ip_fib_dump, {})
803 def ip6_fib_dump(self):
804 return self.api(self.papi.ip6_fib_dump, {})
806 def ip_neighbor_add_del(self,
815 """ Add neighbor MAC to IPv4 or IPv6 address.
820 :param is_add: (Default value = 1)
821 :param is_ipv6: (Default value = 0)
822 :param is_static: (Default value = 0)
823 :param is_no_adj_fib: (Default value = 0)
827 self.papi.ip_neighbor_add_del,
828 {'sw_if_index': sw_if_index,
831 'is_static': is_static,
832 'is_no_adj_fib': is_no_adj_fib,
833 'mac_address': mac_address,
834 'dst_address': dst_address
838 def ip_neighbor_dump(self,
841 """ Return IP neighbor dump.
844 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
848 self.papi.ip_neighbor_dump,
850 'sw_if_index': sw_if_index
854 def proxy_arp_add_del(self,
859 """ Config Proxy Arp Range.
861 :param low_address: Start address in the rnage to Proxy for
862 :param hi_address: End address in the rnage to Proxy for
863 :param vrf_id: The VRF/table in which to proxy
867 self.papi.proxy_arp_add_del,
870 'low_address': low_address,
871 'hi_address': hi_address,
875 def proxy_arp_intfc_enable_disable(self,
878 """ Enable/Disable an interface for proxy ARP requests
880 :param sw_if_index: Interface
881 :param enable_disable: Enable/Disable
885 self.papi.proxy_arp_intfc_enable_disable,
886 {'sw_if_index': sw_if_index,
887 'enable_disable': is_enable
895 """ Reset VRF (remove all routes etc.) request.
897 :param int vrf_id: ID of the FIB table / VRF to reset.
898 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
912 """ Reset VRF (remove all routes etc.) request.
914 :param int vrf_id: ID of the FIB table / VRF to reset.
915 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
930 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
939 def sw_interface_span_enable_disable(
940 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
943 :param sw_if_index_from:
944 :param sw_if_index_to:
948 return self.api(self.papi.sw_interface_span_enable_disable,
949 {'sw_if_index_from': sw_if_index_from,
950 'sw_if_index_to': sw_if_index_to,
955 def gre_tunnel_add_del(self,
966 :param outer_fib_id: (Default value = 0)
967 :param is_add: (Default value = 1)
968 :param is_ipv6: (Default value = 0)
969 :param is_teb: (Default value = 0)
973 self.papi.gre_add_del_tunnel,
977 'src_address': src_address,
978 'dst_address': dst_address,
979 'outer_fib_id': outer_fib_id}
982 def mpls_fib_dump(self):
983 return self.api(self.papi.mpls_fib_dump, {})
985 def mpls_table_add_del(
992 :param is_add: (Default value = 1)
997 self.papi.mpls_table_add_del,
998 {'mt_table_id': table_id,
999 'mt_is_add': is_add})
1001 def mpls_route_add_del(
1007 next_hop_sw_if_index=0xFFFFFFFF,
1009 next_hop_table_id=0,
1011 next_hop_n_out_labels=0,
1012 next_hop_out_label_stack=[],
1013 next_hop_via_label=MPLS_LABEL_INVALID,
1015 is_resolve_attached=0,
1022 classify_table_index=0xFFFFFFFF,
1027 :param dst_address_length:
1028 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1030 :param next_hop_address:
1031 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1032 :param vrf_id: (Default value = 0)
1033 :param lookup_in_vrf: (Default value = 0)
1034 :param classify_table_index: (Default value = 0xFFFFFFFF)
1035 :param is_add: (Default value = 1)
1036 :param is_drop: (Default value = 0)
1037 :param is_ipv6: (Default value = 0)
1038 :param is_local: (Default value = 0)
1039 :param is_classify: (Default value = 0)
1040 :param is_multipath: (Default value = 0)
1041 :param is_multicast: (Default value = 0)
1042 :param is_resolve_host: (Default value = 0)
1043 :param is_resolve_attached: (Default value = 0)
1044 :param not_last: (Default value = 0)
1045 :param next_hop_weight: (Default value = 1)
1050 self.papi.mpls_route_add_del,
1053 'mr_table_id': table_id,
1054 'mr_classify_table_index': classify_table_index,
1055 'mr_is_add': is_add,
1056 'mr_is_classify': is_classify,
1057 'mr_is_multipath': is_multipath,
1058 'mr_is_multicast': is_multicast,
1059 'mr_is_resolve_host': is_resolve_host,
1060 'mr_is_resolve_attached': is_resolve_attached,
1061 'mr_is_interface_rx': is_interface_rx,
1062 'mr_is_rpf_id': is_rpf_id,
1063 'mr_next_hop_proto': next_hop_proto,
1064 'mr_next_hop_weight': next_hop_weight,
1065 'mr_next_hop': next_hop_address,
1066 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1067 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1068 'mr_next_hop_table_id': next_hop_table_id,
1069 'mr_next_hop_via_label': next_hop_via_label,
1070 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1072 def mpls_ip_bind_unbind(
1084 self.papi.mpls_ip_bind_unbind,
1085 {'mb_mpls_table_id': table_id,
1087 'mb_ip_table_id': ip_table_id,
1088 'mb_is_bind': is_bind,
1089 'mb_is_ip4': is_ip4,
1090 'mb_address_length': dst_address_length,
1091 'mb_address': dst_address})
1093 def mpls_tunnel_add_del(
1096 next_hop_proto_is_ip4,
1098 next_hop_sw_if_index=0xFFFFFFFF,
1099 next_hop_table_id=0,
1101 next_hop_n_out_labels=0,
1102 next_hop_out_label_stack=[],
1103 next_hop_via_label=MPLS_LABEL_INVALID,
1109 :param dst_address_length:
1110 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1112 :param next_hop_address:
1113 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1114 :param vrf_id: (Default value = 0)
1115 :param lookup_in_vrf: (Default value = 0)
1116 :param classify_table_index: (Default value = 0xFFFFFFFF)
1117 :param is_add: (Default value = 1)
1118 :param is_drop: (Default value = 0)
1119 :param is_ipv6: (Default value = 0)
1120 :param is_local: (Default value = 0)
1121 :param is_classify: (Default value = 0)
1122 :param is_multipath: (Default value = 0)
1123 :param is_resolve_host: (Default value = 0)
1124 :param is_resolve_attached: (Default value = 0)
1125 :param next_hop_weight: (Default value = 1)
1126 :param is_multicast: (Default value = 0)
1130 self.papi.mpls_tunnel_add_del,
1131 {'mt_sw_if_index': tun_sw_if_index,
1132 'mt_is_add': is_add,
1133 'mt_l2_only': l2_only,
1134 'mt_is_multicast': is_multicast,
1135 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1136 'mt_next_hop_weight': next_hop_weight,
1137 'mt_next_hop': next_hop_address,
1138 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1139 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1140 'mt_next_hop_table_id': next_hop_table_id,
1141 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1143 def nat44_interface_add_del_feature(
1148 """Enable/disable NAT44 feature on the interface
1150 :param sw_if_index: Software index of the interface
1151 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1152 :param is_add: 1 if add, 0 if delete (Default value = 1)
1155 self.papi.nat44_interface_add_del_feature,
1157 'is_inside': is_inside,
1158 'sw_if_index': sw_if_index})
1160 def nat44_interface_add_del_output_feature(
1165 """Enable/disable NAT44 output feature on the interface
1167 :param sw_if_index: Software index of the interface
1168 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1169 :param is_add: 1 if add, 0 if delete (Default value = 1)
1172 self.papi.nat44_interface_add_del_output_feature,
1174 'is_inside': is_inside,
1175 'sw_if_index': sw_if_index})
1177 def nat44_add_del_static_mapping(
1181 external_sw_if_index=0xFFFFFFFF,
1188 """Add/delete NAT44 static mapping
1190 :param local_ip: Local IP address
1191 :param external_ip: External IP address
1192 :param external_sw_if_index: External interface instead of IP address
1193 :param local_port: Local port number (Default value = 0)
1194 :param external_port: External port number (Default value = 0)
1195 :param addr_only: 1 if address only mapping, 0 if address and port
1196 :param vrf_id: VRF ID
1197 :param protocol: IP protocol (Default value = 0)
1198 :param is_add: 1 if add, 0 if delete (Default value = 1)
1201 self.papi.nat44_add_del_static_mapping,
1203 'addr_only': addr_only,
1204 'local_ip_address': local_ip,
1205 'external_ip_address': external_ip,
1206 'local_port': local_port,
1207 'external_port': external_port,
1208 'external_sw_if_index': external_sw_if_index,
1210 'protocol': protocol})
1212 def nat44_add_del_address_range(
1218 """Add/del NAT44 address range
1220 :param first_ip_address: First IP address
1221 :param last_ip_address: Last IP address
1222 :param vrf_id: VRF id for the address range
1223 :param is_add: 1 if add, 0 if delete (Default value = 1)
1226 self.papi.nat44_add_del_address_range,
1227 {'first_ip_address': first_ip_address,
1228 'last_ip_address': last_ip_address,
1232 def nat44_address_dump(self):
1233 """Dump NAT44 addresses
1234 :return: Dictionary of NAT44 addresses
1236 return self.api(self.papi.nat44_address_dump, {})
1238 def nat44_interface_dump(self):
1239 """Dump interfaces with NAT44 feature
1240 :return: Dictionary of interfaces with NAT44 feature
1242 return self.api(self.papi.nat44_interface_dump, {})
1244 def nat44_interface_output_feature_dump(self):
1245 """Dump interfaces with NAT44 output feature
1246 :return: Dictionary of interfaces with NAT44 output feature
1248 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1250 def nat44_static_mapping_dump(self):
1251 """Dump NAT44 static mappings
1252 :return: Dictionary of NAT44 static mappings
1254 return self.api(self.papi.nat44_static_mapping_dump, {})
1256 def nat_show_config(self):
1257 """Show NAT plugin config
1258 :return: NAT plugin config parameters
1260 return self.api(self.papi.nat_show_config, {})
1262 def nat44_add_interface_addr(
1266 """Add/del NAT44 address from interface
1268 :param sw_if_index: Software index of the interface
1269 :param is_add: 1 if add, 0 if delete (Default value = 1)
1271 return self.api(self.papi.nat44_add_del_interface_addr,
1272 {'is_add': is_add, 'sw_if_index': sw_if_index})
1274 def nat44_interface_addr_dump(self):
1275 """Dump NAT44 addresses interfaces
1276 :return: Dictionary of NAT44 addresses interfaces
1278 return self.api(self.papi.nat44_interface_addr_dump, {})
1285 """Enable/disable NAT IPFIX logging
1287 :param domain_id: Observation domain ID (Default value = 1)
1288 :param src_port: Source port number (Default value = 4739)
1289 :param enable: 1 if enable, 0 if disable (Default value = 1)
1292 self.papi.nat_ipfix_enable_disable,
1293 {'domain_id': domain_id,
1294 'src_port': src_port,
1297 def nat44_user_session_dump(
1301 """Dump NAT44 user's sessions
1303 :param ip_address: ip adress of the user to be dumped
1304 :param cpu_index: cpu_index on which the user is
1305 :param vrf_id: VRF ID
1306 :return: Dictionary of S-NAT sessions
1309 self.papi.nat44_user_session_dump,
1310 {'ip_address': ip_address,
1313 def nat44_user_dump(self):
1316 :return: Dictionary of NAT44 users
1318 return self.api(self.papi.nat44_user_dump, {})
1320 def nat44_add_del_lb_static_mapping(
1329 """Add/delete NAT44 load balancing static mapping
1331 :param is_add - 1 if add, 0 if delete
1334 self.papi.nat44_add_del_lb_static_mapping,
1336 'external_addr': external_addr,
1337 'external_port': external_port,
1338 'protocol': protocol,
1340 'local_num': local_num,
1343 def nat44_lb_static_mapping_dump(self):
1344 """Dump NAT44 load balancing static mappings
1346 :return: Dictionary of NAT44 load balancing static mapping
1348 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1350 def nat_det_add_del_map(
1357 """Add/delete deterministic NAT mapping
1359 :param is_add - 1 if add, 0 if delete
1360 :param in_addr - inside IP address
1361 :param in_plen - inside IP address prefix length
1362 :param out_addr - outside IP address
1363 :param out_plen - outside IP address prefix length
1366 self.papi.nat_det_add_del_map,
1371 'out_addr': out_addr,
1372 'out_plen': out_plen})
1374 def nat_det_forward(
1377 """Get outside address and port range from inside address
1379 :param in_addr - inside IP address
1382 self.papi.nat_det_forward,
1383 {'in_addr': in_addr,
1386 def nat_det_reverse(
1390 """Get inside address from outside address and port
1392 :param out_addr - outside IP address
1393 :param out_port - outside port
1396 self.papi.nat_det_reverse,
1397 {'out_addr': out_addr,
1398 'out_port': out_port})
1400 def nat_det_map_dump(self):
1401 """Dump deterministic NAT mappings
1403 :return: Dictionary of deterministic NAT mappings
1405 return self.api(self.papi.nat_det_map_dump, {})
1407 def nat_det_set_timeouts(
1410 tcp_established=7440,
1413 """Set values of timeouts for deterministic NAT (in seconds)
1415 :param udp - UDP timeout (Default value = 300)
1416 :param tcp_established - TCP established timeout (Default value = 7440)
1417 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1418 :param icmp - ICMP timeout (Default value = 60)
1421 self.papi.nat_det_set_timeouts,
1423 'tcp_established': tcp_established,
1424 'tcp_transitory': tcp_transitory,
1427 def nat_det_get_timeouts(self):
1428 """Get values of timeouts for deterministic NAT
1430 :return: Timeouts for deterministic NAT (in seconds)
1432 return self.api(self.papi.nat_det_get_timeouts, {})
1434 def nat_det_close_session_out(
1440 """Close deterministic NAT session using outside address and port
1442 :param out_addr - outside IP address
1443 :param out_port - outside port
1444 :param ext_addr - external host IP address
1445 :param ext_port - external host port
1448 self.papi.nat_det_close_session_out,
1449 {'out_addr': out_addr,
1450 'out_port': out_port,
1451 'ext_addr': ext_addr,
1452 'ext_port': ext_port})
1454 def nat_det_close_session_in(
1460 """Close deterministic NAT session using inside address and port
1462 :param in_addr - inside IP address
1463 :param in_port - inside port
1464 :param ext_addr - external host IP address
1465 :param ext_port - external host port
1468 self.papi.nat_det_close_session_in,
1469 {'in_addr': in_addr,
1471 'ext_addr': ext_addr,
1472 'ext_port': ext_port,
1475 def nat_det_session_dump(
1478 """Dump deterministic NAT sessions belonging to a user
1480 :param user_addr - inside IP address of the user
1481 :return: Dictionary of deterministic NAT sessions
1484 self.papi.nat_det_session_dump,
1486 'user_addr': user_addr})
1488 def nat64_add_del_pool_addr_range(
1494 """Add/del address range to NAT64 pool
1496 :param start_addr: First IP address
1497 :param end_addr: Last IP address
1498 :param vrf_id: VRF id for the address range
1499 :param is_add: 1 if add, 0 if delete (Default value = 1)
1502 self.papi.nat64_add_del_pool_addr_range,
1503 {'start_addr': start_addr,
1504 'end_addr': end_addr,
1508 def nat64_pool_addr_dump(self):
1509 """Dump NAT64 pool addresses
1510 :return: Dictionary of NAT64 pool addresses
1512 return self.api(self.papi.nat64_pool_addr_dump, {})
1514 def nat64_add_del_interface(
1519 """Enable/disable NAT64 feature on the interface
1520 :param sw_if_index: Index of the interface
1521 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1522 :param is_add: 1 if add, 0 if delete (Default value = 1)
1525 self.papi.nat64_add_del_interface,
1526 {'sw_if_index': sw_if_index,
1527 'is_inside': is_inside,
1530 def nat64_interface_dump(self):
1531 """Dump interfaces with NAT64 feature
1532 :return: Dictionary of interfaces with NAT64 feature
1534 return self.api(self.papi.nat64_interface_dump, {})
1536 def nat64_add_del_static_bib(
1545 """Add/delete S-NAT static BIB entry
1547 :param in_ip: Inside IPv6 address
1548 :param out_ip: Outside IPv4 address
1549 :param in_port: Inside port number
1550 :param out_port: Outside port number
1551 :param protocol: IP protocol
1552 :param vrf_id: VRF ID (Default value = 0)
1553 :param is_add: 1 if add, 0 if delete (Default value = 1)
1556 self.papi.nat64_add_del_static_bib,
1565 def nat64_bib_dump(self, protocol=255):
1568 :param protocol: IP protocol (Default value = 255, all BIBs)
1569 :returns: Dictionary of NAT64 BIB entries
1571 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1573 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1574 tcp_incoming_syn=6):
1575 """Set values of timeouts for NAT64 (in seconds)
1577 :param udpi: UDP timeout (Default value = 300)
1578 :param icmp: ICMP timeout (Default value = 60)
1579 :param tcp_trans: TCP transitory timeout (Default value = 240)
1580 :param tcp_est: TCP established timeout (Default value = 7440)
1581 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1584 self.papi.nat64_set_timeouts,
1587 'tcp_trans': tcp_trans,
1589 'tcp_incoming_syn': tcp_incoming_syn})
1591 def nat64_get_timeouts(self):
1592 """Get values of timeouts for NAT64
1594 :return: Timeouts for NAT64 (in seconds)
1596 return self.api(self.papi.nat64_get_timeouts, {})
1598 def nat64_st_dump(self, protocol=255):
1599 """Dump NAT64 session table
1601 :param protocol: IP protocol (Default value = 255, all STs)
1602 :returns: Dictionary of NAT64 sesstion table entries
1604 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1606 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1607 """Add/del NAT64 prefix
1609 :param prefix: NAT64 prefix
1610 :param plen: NAT64 prefix length
1611 :param vrf_id: VRF id of tenant (Default 0)
1612 :param is_add: 1 if add, 0 if delete (Default value = 1)
1615 self.papi.nat64_add_del_prefix,
1621 def nat64_prefix_dump(self):
1622 """Dump NAT64 prefix
1624 :returns: Dictionary of NAT64 prefixes
1626 return self.api(self.papi.nat64_prefix_dump, {})
1628 def control_ping(self):
1629 self.api(self.papi.control_ping)
1631 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1632 detect_mult, local_addr, peer_addr, is_ipv6=0,
1633 bfd_key_id=None, conf_key_id=None):
1634 if bfd_key_id is None:
1635 return self.api(self.papi.bfd_udp_add,
1637 'sw_if_index': sw_if_index,
1638 'desired_min_tx': desired_min_tx,
1639 'required_min_rx': required_min_rx,
1640 'local_addr': local_addr,
1641 'peer_addr': peer_addr,
1643 'detect_mult': detect_mult,
1646 return self.api(self.papi.bfd_udp_add,
1648 'sw_if_index': sw_if_index,
1649 'desired_min_tx': desired_min_tx,
1650 'required_min_rx': required_min_rx,
1651 'local_addr': local_addr,
1652 'peer_addr': peer_addr,
1654 'detect_mult': detect_mult,
1655 'is_authenticated': 1,
1656 'bfd_key_id': bfd_key_id,
1657 'conf_key_id': conf_key_id,
1660 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1661 detect_mult, local_addr, peer_addr, is_ipv6=0):
1662 return self.api(self.papi.bfd_udp_mod,
1664 'sw_if_index': sw_if_index,
1665 'desired_min_tx': desired_min_tx,
1666 'required_min_rx': required_min_rx,
1667 'local_addr': local_addr,
1668 'peer_addr': peer_addr,
1670 'detect_mult': detect_mult,
1673 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1674 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1676 return self.api(self.papi.bfd_udp_auth_activate,
1678 'sw_if_index': sw_if_index,
1679 'local_addr': local_addr,
1680 'peer_addr': peer_addr,
1682 'is_delayed': 1 if is_delayed else 0,
1683 'bfd_key_id': bfd_key_id,
1684 'conf_key_id': conf_key_id,
1687 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1688 is_ipv6=0, is_delayed=False):
1689 return self.api(self.papi.bfd_udp_auth_deactivate,
1691 'sw_if_index': sw_if_index,
1692 'local_addr': local_addr,
1693 'peer_addr': peer_addr,
1695 'is_delayed': 1 if is_delayed else 0,
1698 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1699 return self.api(self.papi.bfd_udp_del,
1701 'sw_if_index': sw_if_index,
1702 'local_addr': local_addr,
1703 'peer_addr': peer_addr,
1707 def bfd_udp_session_dump(self):
1708 return self.api(self.papi.bfd_udp_session_dump, {})
1710 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1711 peer_addr, is_ipv6=0):
1712 return self.api(self.papi.bfd_udp_session_set_flags, {
1713 'admin_up_down': admin_up_down,
1714 'sw_if_index': sw_if_index,
1715 'local_addr': local_addr,
1716 'peer_addr': peer_addr,
1720 def want_bfd_events(self, enable_disable=1):
1721 return self.api(self.papi.want_bfd_events, {
1722 'enable_disable': enable_disable,
1726 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1727 return self.api(self.papi.bfd_auth_set_key, {
1728 'conf_key_id': conf_key_id,
1729 'auth_type': auth_type,
1731 'key_len': len(key),
1734 def bfd_auth_del_key(self, conf_key_id):
1735 return self.api(self.papi.bfd_auth_del_key, {
1736 'conf_key_id': conf_key_id,
1739 def bfd_auth_keys_dump(self):
1740 return self.api(self.papi.bfd_auth_keys_dump, {})
1742 def bfd_udp_set_echo_source(self, sw_if_index):
1743 return self.api(self.papi.bfd_udp_set_echo_source,
1744 {'sw_if_index': sw_if_index})
1746 def bfd_udp_del_echo_source(self):
1747 return self.api(self.papi.bfd_udp_del_echo_source, {})
1749 def classify_add_del_table(
1754 table_index=0xFFFFFFFF,
1756 memory_size=2097152,
1758 next_table_index=0xFFFFFFFF,
1759 miss_next_index=0xFFFFFFFF,
1760 current_data_flag=0,
1761 current_data_offset=0):
1765 :param match_n_vectors: (Default value = 1)
1766 :param table_index: (Default value = 0xFFFFFFFF)
1767 :param nbuckets: (Default value = 2)
1768 :param memory_size: (Default value = 2097152)
1769 :param skip_n_vectors: (Default value = 0)
1770 :param next_table_index: (Default value = 0xFFFFFFFF)
1771 :param miss_next_index: (Default value = 0xFFFFFFFF)
1772 :param current_data_flag: (Default value = 0)
1773 :param current_data_offset: (Default value = 0)
1777 self.papi.classify_add_del_table,
1779 'table_index': table_index,
1780 'nbuckets': nbuckets,
1781 'memory_size': memory_size,
1782 'skip_n_vectors': skip_n_vectors,
1783 'match_n_vectors': match_n_vectors,
1784 'next_table_index': next_table_index,
1785 'miss_next_index': miss_next_index,
1786 'current_data_flag': current_data_flag,
1787 'current_data_offset': current_data_offset,
1790 def classify_add_del_session(
1795 opaque_index=0xFFFFFFFF,
1796 hit_next_index=0xFFFFFFFF,
1804 :param opaque_index: (Default value = 0xFFFFFFFF)
1805 :param hit_next_index: (Default value = 0xFFFFFFFF)
1806 :param advance: (Default value = 0)
1807 :param action: (Default value = 0)
1808 :param metadata: (Default value = 0)
1812 self.papi.classify_add_del_session,
1814 'table_index': table_index,
1815 'hit_next_index': hit_next_index,
1816 'opaque_index': opaque_index,
1819 'metadata': metadata,
1822 def input_acl_set_interface(
1826 ip4_table_index=0xFFFFFFFF,
1827 ip6_table_index=0xFFFFFFFF,
1828 l2_table_index=0xFFFFFFFF):
1832 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1833 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1834 :param l2_table_index: (Default value = 0xFFFFFFFF)
1838 self.papi.input_acl_set_interface,
1839 {'sw_if_index': sw_if_index,
1840 'ip4_table_index': ip4_table_index,
1841 'ip6_table_index': ip6_table_index,
1842 'l2_table_index': l2_table_index,
1845 def set_ipfix_exporter(
1852 collector_port=4739,
1855 self.papi.set_ipfix_exporter,
1857 'collector_address': collector_address,
1858 'collector_port': collector_port,
1859 'src_address': src_address,
1861 'path_mtu': path_mtu,
1862 'template_interval': template_interval,
1863 'udp_checksum': udp_checksum,
1866 def dhcp_proxy_config(self,
1874 self.papi.dhcp_proxy_config,
1876 'rx_vrf_id': rx_table_id,
1877 'server_vrf_id': server_table_id,
1880 'dhcp_server': dhcp_server,
1881 'dhcp_src_address': dhcp_src_address,
1884 def dhcp_proxy_set_vss(self,
1891 self.papi.dhcp_proxy_set_vss,
1900 def dhcp_client(self,
1905 want_dhcp_events=0):
1907 self.papi.dhcp_client_config,
1909 'sw_if_index': sw_if_index,
1910 'hostname': hostname,
1911 'client_id': client_id,
1913 'want_dhcp_event': want_dhcp_events,
1917 def ip_mroute_add_del(self,
1922 next_hop_sw_if_index,
1932 self.papi.ip_mroute_add_del,
1933 {'next_hop_sw_if_index': next_hop_sw_if_index,
1934 'entry_flags': e_flags,
1935 'itf_flags': i_flags,
1936 'table_id': table_id,
1940 'is_local': is_local,
1941 'grp_address_length': grp_address_length,
1942 'grp_address': grp_address,
1943 'src_address': src_address})
1945 def mfib_signal_dump(self):
1946 return self.api(self.papi.mfib_signal_dump, {})
1948 def ip_mfib_dump(self):
1949 return self.api(self.papi.ip_mfib_dump, {})
1951 def lisp_enable_disable(self, is_enabled):
1953 self.papi.lisp_enable_disable,
1955 'is_en': is_enabled,
1958 def lisp_locator_set(self,
1962 self.papi.lisp_add_del_locator_set,
1965 'locator_set_name': ls_name
1968 def lisp_locator_set_dump(self):
1969 return self.api(self.papi.lisp_locator_set_dump, {})
1971 def lisp_locator(self,
1978 self.papi.lisp_add_del_locator,
1981 'locator_set_name': ls_name,
1982 'sw_if_index': sw_if_index,
1983 'priority': priority,
1987 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1989 self.papi.lisp_locator_dump,
1991 'is_index_set': is_index_set,
1993 'ls_index': ls_index,
1996 def lisp_local_mapping(self,
2006 self.papi.lisp_add_del_local_eid,
2008 'locator_set_name': ls_name,
2010 'eid_type': eid_type,
2012 'prefix_len': prefix_len,
2018 def lisp_eid_table_dump(self,
2026 self.papi.lisp_eid_table_dump,
2029 'prefix_length': prefix_length,
2031 'eid_type': eid_type,
2033 'filter': filter_opt,
2036 def lisp_remote_mapping(self,
2046 self.papi.lisp_add_del_remote_mapping,
2049 'eid_type': eid_type,
2051 'eid_len': eid_prefix_len,
2052 'rloc_num': rlocs_num,
2055 'is_src_dst': is_src_dst,
2058 def lisp_adjacency(self,
2067 self.papi.lisp_add_del_adjacency,
2071 'eid_type': eid_type,
2074 'leid_len': leid_len,
2075 'reid_len': reid_len,
2078 def lisp_adjacencies_get(self, vni=0):
2080 self.papi.lisp_adjacencies_get,
2085 def map_add_domain(self,
2098 self.papi.map_add_domain,
2100 'ip6_prefix': ip6_prefix,
2101 'ip6_prefix_len': ip6_prefix_len,
2102 'ip4_prefix': ip4_prefix,
2103 'ip4_prefix_len': ip4_prefix_len,
2105 'ip6_src_prefix_len': ip6_src_prefix_len,
2106 'ea_bits_len': ea_bits_len,
2107 'psid_offset': psid_offset,
2108 'psid_length': psid_length,
2109 'is_translation': is_translation,
2113 def gtpu_add_del_tunnel(
2119 mcast_sw_if_index=0xFFFFFFFF,
2121 decap_next_index=0xFFFFFFFF,
2125 :param is_add: (Default value = 1)
2126 :param is_ipv6: (Default value = 0)
2129 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2130 :param encap_vrf_id: (Default value = 0)
2131 :param decap_next_index: (Default value = 0xFFFFFFFF)
2132 :param teid: (Default value = 0)
2135 return self.api(self.papi.gtpu_add_del_tunnel,
2138 'src_address': src_addr,
2139 'dst_address': dst_addr,
2140 'mcast_sw_if_index': mcast_sw_if_index,
2141 'encap_vrf_id': encap_vrf_id,
2142 'decap_next_index': decap_next_index,
2145 def vxlan_gpe_add_del_tunnel(
2149 mcast_sw_if_index=0xFFFFFFFF,
2160 :param is_add: (Default value = 1)
2161 :param is_ipv6: (Default value = 0)
2162 :param encap_vrf_id: (Default value = 0)
2163 :param decap_vrf_id: (Default value = 0)
2164 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2165 :param protocol: (Default value = 3)
2166 :param vni: (Default value = 0)
2169 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2174 'mcast_sw_if_index': mcast_sw_if_index,
2175 'encap_vrf_id': encap_vrf_id,
2176 'decap_vrf_id': decap_vrf_id,
2177 'protocol': protocol,
2180 def pppoe_add_del_session(
2190 :param is_add: (Default value = 1)
2191 :param is_ipv6: (Default value = 0)
2193 :param session_id: (Default value = 0)
2195 :param decap_vrf_id: (Default value = 0)
2198 return self.api(self.papi.pppoe_add_del_session,
2201 'session_id': session_id,
2202 'client_ip': client_ip,
2203 'decap_vrf_id': decap_vrf_id,
2204 'client_mac': client_mac})
2206 def sr_localsid_add_del(self,
2212 sw_if_index=0xFFFFFFFF,
2216 """ Add/del IPv6 SR local-SID.
2218 :param localsid_addr:
2219 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2220 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2222 :param is_del: (Default value = 0)
2223 :param end_psp: (Default value = 0)
2224 :param sw_if_index: (Default value = 0xFFFFFFFF)
2225 :param vlan_index: (Default value = 0)
2226 :param fib_table: (Default value = 0)
2229 self.papi.sr_localsid_add_del,
2231 'localsid_addr': localsid_addr,
2233 'behavior': behavior,
2234 'sw_if_index': sw_if_index,
2235 'vlan_index': vlan_index,
2236 'fib_table': fib_table,
2251 :param bsid_addr: bindingSID of the SR Policy
2252 :param weight: weight of the sid list. optional. (default: 1)
2253 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2255 :param type: type/behavior of the SR policy. (default or spray) \
2257 :param fib_table: VRF where to install the FIB entry for the BSID \
2259 :param n_segments: number of segments \
2261 :param segments: a vector of IPv6 address composing the segment list \
2265 self.papi.sr_policy_add,
2266 {'bsid_addr': bsid_addr,
2268 'is_encap': is_encap,
2270 'fib_table': fib_table,
2271 'n_segments': n_segments,
2272 'segments': segments
2281 :param bsid: bindingSID of the SR Policy
2282 :param sr_policy_index: index of the sr policy (default: 0)
2285 self.papi.sr_policy_del,
2286 {'bsid_addr': bsid_addr,
2287 'sr_policy_index': sr_policy_index
2290 def sr_steering_add_del(
2301 Steer traffic L2 and L3 traffic through a given SR policy
2303 :param is_del: delete or add
2304 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2305 :param sr_policy: is the index of the SR Policy (alt to bsid)
2306 :param table_id: is the VRF where to install the FIB entry for the BSID
2307 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2308 :param mask_width: is the mask for L3 traffic type
2309 :param sw_if_index: is the incoming interface for L2 traffic
2310 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2313 self.papi.sr_steering_add_del,
2315 'bsid_addr': bsid_addr,
2316 'sr_policy_index': sr_policy_index,
2317 'table_id': table_id,
2318 'prefix_addr': prefix_addr,
2319 'mask_width': mask_width,
2320 'sw_if_index': sw_if_index,
2321 'traffic_type': traffic_type
2324 def acl_add_replace(self, acl_index, r, tag='',
2326 """Add/replace an ACL
2327 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2328 :param acl_rule r: ACL rules array.
2329 :param str tag: symbolic tag (description) for this ACL.
2330 :param int count: number of rules.
2332 return self.api(self.papi.acl_add_replace,
2333 {'acl_index': acl_index,
2337 expected_retval=expected_retval)
2339 def acl_del(self, acl_index, expected_retval=0):
2345 return self.api(self.papi.acl_del,
2346 {'acl_index': acl_index},
2347 expected_retval=expected_retval)
2349 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2351 return self.api(self.papi.acl_interface_set_acl_list,
2352 {'sw_if_index': sw_if_index,
2356 expected_retval=expected_retval)
2358 def acl_dump(self, acl_index, expected_retval=0):
2359 return self.api(self.papi.acl_dump,
2360 {'acl_index': acl_index},
2361 expected_retval=expected_retval)
2363 def macip_acl_add(self, rules, tag=""):
2366 :param rules: list of rules for given acl
2370 return self.api(self.papi.macip_acl_add,
2372 'count': len(rules),
2375 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2378 :param rules: list of rules for given acl
2382 return self.api(self.papi.macip_acl_add_replace,
2383 {'acl_index': acl_index,
2385 'count': len(rules),
2388 def macip_acl_del(self, acl_index):
2394 return self.api(self.papi.macip_acl_del,
2395 {'acl_index': acl_index})
2397 def macip_acl_interface_add_del(self,
2401 """ Add MACIP acl to interface
2405 :param is_add: (Default value = 1)
2408 return self.api(self.papi.macip_acl_interface_add_del,
2410 'sw_if_index': sw_if_index,
2411 'acl_index': acl_index})
2413 def macip_acl_interface_get(self):
2414 """ Return interface acls dump
2417 self.papi.macip_acl_interface_get, {})
2419 def macip_acl_dump(self, acl_index=4294967295):
2420 """ Return MACIP acl dump
2424 self.papi.macip_acl_dump, {'acl_index': acl_index})
2426 def policer_add_del(self,
2437 conform_action_type=1,
2439 exceed_action_type=0,
2441 violate_action_type=0,
2443 return self.api(self.papi.policer_add_del,
2450 'rate_type': rate_type,
2451 'round_type': round_type,
2453 'color_aware': color_aware,
2454 'conform_action_type': conform_action_type,
2455 'conform_dscp': conform_dscp,
2456 'exceed_action_type': exceed_action_type,
2457 'exceed_dscp': exceed_dscp,
2458 'violate_action_type': violate_action_type,
2459 'violate_dscp': violate_dscp})
2461 def ip_punt_police(self,
2465 return self.api(self.papi.ip_punt_police,
2466 {'policer_index': policer_index,
2470 def ip_punt_redirect(self,
2476 return self.api(self.papi.ip_punt_redirect,
2477 {'rx_sw_if_index': rx_sw_if_index,
2478 'tx_sw_if_index': tx_sw_if_index,