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 bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
389 learn=1, arp_term=0, is_add=1):
390 """Create/delete bridge domain.
392 :param int bd_id: Bridge domain index.
393 :param int flood: Enable/disable bcast/mcast flooding in the BD.
395 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
397 :param int forward: Enable/disable forwarding on all interfaces in
398 the BD. (Default value = 1)
399 :param int learn: Enable/disable learning on all interfaces in the BD.
401 :param int arp_term: Enable/disable arp termination in the BD.
403 :param int is_add: Add or delete flag. (Default value = 1)
405 return self.api(self.papi.bridge_domain_add_del,
408 'uu_flood': uu_flood,
411 'arp_term': arp_term,
414 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
415 return self.api(self.papi.bd_ip_mac_add_del,
422 def want_ip4_arp_events(self, enable_disable=1, address=0):
423 return self.api(self.papi.want_ip4_arp_events,
424 {'enable_disable': enable_disable,
426 'pid': os.getpid(), })
428 def want_ip6_nd_events(self, enable_disable=1, address=0):
429 return self.api(self.papi.want_ip6_nd_events,
430 {'enable_disable': enable_disable,
432 'pid': os.getpid(), })
434 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
435 max_macs_in_event=0, learn_limit=0):
436 return self.api(self.papi.want_l2_macs_events,
437 {'enable_disable': enable_disable,
438 'scan_delay': scan_delay,
439 'max_macs_in_event': max_macs_in_event,
440 'learn_limit': learn_limit,
441 'pid': os.getpid(), })
443 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
444 filter_mac=0, bvi_mac=0):
445 """Create/delete L2 FIB entry.
447 :param str mac: MAC address to create FIB entry for.
448 :param int bd_id: Bridge domain index.
449 :param int sw_if_index: Software interface index of the interface.
450 :param int is_add: Add or delete flag. (Default value = 1)
451 :param int static_mac: Set to 1 to create static MAC entry.
453 :param int filter_mac: Set to 1 to drop packet that's source or
454 destination MAC address contains defined MAC address.
456 :param int bvi_mac: Set to 1 to create entry that points to BVI
457 interface. (Default value = 0)
459 return self.api(self.papi.l2fib_add_del,
460 {'mac': self._convert_mac(mac),
462 'sw_if_index': sw_if_index,
464 'static_mac': static_mac,
465 'filter_mac': filter_mac,
468 def l2fib_flush_int(self, sw_if_index):
469 """Flush L2 FIB entries for sw_if_index.
471 :param int sw_if_index: Software interface index of the interface.
473 return self.api(self.papi.l2fib_flush_int,
474 {'sw_if_index': sw_if_index})
476 def l2fib_flush_bd(self, bd_id):
477 """Flush L2 FIB entries for bd_id.
479 :param int sw_if_index: Bridge Domain id.
481 return self.api(self.papi.l2fib_flush_bd,
484 def l2fib_flush_all(self):
487 return self.api(self.papi.l2fib_flush_all, {})
489 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
490 shg=0, bvi=0, enable=1):
491 """Add/remove interface to/from bridge domain.
493 :param int sw_if_index: Software interface index of the interface.
494 :param int bd_id: Bridge domain index.
495 :param int shg: Split-horizon group index. (Default value = 0)
496 :param int bvi: Set interface as a bridge group virtual interface.
498 :param int enable: Add or remove interface. (Default value = 1)
500 return self.api(self.papi.sw_interface_set_l2_bridge,
501 {'rx_sw_if_index': sw_if_index,
507 def bridge_flags(self, bd_id, is_set, feature_bitmap):
508 """Enable/disable required feature of the bridge domain with defined ID.
510 :param int bd_id: Bridge domain ID.
511 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
512 :param int feature_bitmap: Bitmap value of the feature to be set:
516 - uu-flood (1 << 3) or
519 return self.api(self.papi.bridge_flags,
522 'feature_bitmap': feature_bitmap})
524 def bridge_domain_dump(self, bd_id=0):
527 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
528 existing bridge domains returned)
529 :return: Dictionary of bridge domain(s) data.
531 return self.api(self.papi.bridge_domain_dump,
534 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
536 """Create or delete unidirectional cross-connect from Tx interface to
539 :param int rx_sw_if_index: Software interface index of Rx interface.
540 :param int tx_sw_if_index: Software interface index of Tx interface.
541 :param int enable: Create cross-connect if equal to 1, delete
542 cross-connect if equal to 0.
545 return self.api(self.papi.sw_interface_set_l2_xconnect,
546 {'rx_sw_if_index': rx_sw_if_index,
547 'tx_sw_if_index': tx_sw_if_index,
550 def sw_interface_set_l2_tag_rewrite(
557 """L2 interface vlan tag rewrite configure request
558 :param client_index - opaque cookie to identify the sender
559 :param context - sender context, to match reply w/ request
560 :param sw_if_index - interface the operation is applied to
561 :param vtr_op - Choose from l2_vtr_op_t enum values
562 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
563 :param tag1 - Needed for any push or translate vtr op
564 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
567 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
568 {'sw_if_index': sw_if_index,
574 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
577 :param admin_up_down:
581 return self.api(self.papi.sw_interface_set_flags,
582 {'sw_if_index': sw_if_index,
583 'admin_up_down': admin_up_down})
585 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
586 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
587 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
588 """Create subinterface
589 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
591 :param sub_id: param inner_vlan:
595 :param no_tags: (Default value = 0)
596 :param one_tag: (Default value = 0)
597 :param two_tags: (Default value = 0)
598 :param dot1ad: (Default value = 0)
599 :param exact_match: (Default value = 0)
600 :param default_sub: (Default value = 0)
601 :param outer_vlan_id_any: (Default value = 0)
602 :param inner_vlan_id_any: (Default value = 0)
606 self.papi.create_subif,
607 {'sw_if_index': sw_if_index,
611 'two_tags': two_tags,
613 'exact_match': exact_match,
614 'default_sub': default_sub,
615 'outer_vlan_id_any': outer_vlan_id_any,
616 'inner_vlan_id_any': inner_vlan_id_any,
617 'outer_vlan_id': outer_vlan,
618 'inner_vlan_id': inner_vlan})
620 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
621 """Create p2p ethernet subinterface
623 :param sw_if_index: main (parent) interface
624 :param remote_mac: client (remote) mac address
628 self.papi.p2p_ethernet_add,
629 {'parent_if_index': sw_if_index,
630 'remote_mac': remote_mac,
631 'subif_id': subif_id})
633 def delete_subif(self, sw_if_index):
634 """Delete subinterface
638 return self.api(self.papi.delete_subif,
639 {'sw_if_index': sw_if_index})
641 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
642 """Delete p2p ethernet subinterface
644 :param sw_if_index: main (parent) interface
645 :param remote_mac: client (remote) mac address
649 self.papi.p2p_ethernet_del,
650 {'parent_if_index': sw_if_index,
651 'remote_mac': remote_mac})
653 def create_vlan_subif(self, sw_if_index, vlan):
660 return self.api(self.papi.create_vlan_subif,
661 {'sw_if_index': sw_if_index,
664 def create_loopback(self, mac=''):
667 :param mac: (Optional)
669 return self.api(self.papi.create_loopback,
670 {'mac_address': mac})
672 def delete_loopback(self, sw_if_index):
673 return self.api(self.papi.delete_loopback,
674 {'sw_if_index': sw_if_index, })
676 def ip_table_add_del(self,
683 :param is_add: (Default value = 1)
684 :param is_ipv6: (Default value = 0)
689 self.papi.ip_table_add_del,
690 {'table_id': table_id,
694 def ip_add_del_route(
699 next_hop_sw_if_index=0xFFFFFFFF,
703 next_hop_n_out_labels=0,
704 next_hop_out_label_stack=[],
705 next_hop_via_label=MPLS_LABEL_INVALID,
707 is_resolve_attached=0,
708 classify_table_index=0xFFFFFFFF,
721 :param dst_address_length:
722 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
724 :param next_hop_address:
725 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
726 :param vrf_id: (Default value = 0)
727 :param lookup_in_vrf: (Default value = 0)
728 :param classify_table_index: (Default value = 0xFFFFFFFF)
729 :param is_add: (Default value = 1)
730 :param is_drop: (Default value = 0)
731 :param is_ipv6: (Default value = 0)
732 :param is_local: (Default value = 0)
733 :param is_classify: (Default value = 0)
734 :param is_multipath: (Default value = 0)
735 :param is_resolve_host: (Default value = 0)
736 :param is_resolve_attached: (Default value = 0)
737 :param not_last: (Default value = 0)
738 :param next_hop_weight: (Default value = 1)
743 self.papi.ip_add_del_route,
744 {'next_hop_sw_if_index': next_hop_sw_if_index,
745 'table_id': table_id,
746 'classify_table_index': classify_table_index,
747 'next_hop_table_id': next_hop_table_id,
750 'is_unreach': is_unreach,
751 'is_prohibit': is_prohibit,
753 'is_local': is_local,
754 'is_classify': is_classify,
755 'is_multipath': is_multipath,
756 'is_resolve_host': is_resolve_host,
757 'is_resolve_attached': is_resolve_attached,
758 'is_l2_bridged': is_l2_bridged,
759 'not_last': not_last,
760 'next_hop_weight': next_hop_weight,
761 'dst_address_length': dst_address_length,
762 'dst_address': dst_address,
763 'next_hop_address': next_hop_address,
764 'next_hop_n_out_labels': next_hop_n_out_labels,
765 'next_hop_via_label': next_hop_via_label,
766 'next_hop_out_label_stack': next_hop_out_label_stack})
768 def ip_fib_dump(self):
769 return self.api(self.papi.ip_fib_dump, {})
771 def ip6_fib_dump(self):
772 return self.api(self.papi.ip6_fib_dump, {})
774 def ip_neighbor_add_del(self,
783 """ Add neighbor MAC to IPv4 or IPv6 address.
788 :param is_add: (Default value = 1)
789 :param is_ipv6: (Default value = 0)
790 :param is_static: (Default value = 0)
791 :param is_no_adj_fib: (Default value = 0)
795 self.papi.ip_neighbor_add_del,
796 {'sw_if_index': sw_if_index,
799 'is_static': is_static,
800 'is_no_adj_fib': is_no_adj_fib,
801 'mac_address': mac_address,
802 'dst_address': dst_address
806 def ip_neighbor_dump(self,
809 """ Return IP neighbor dump.
812 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
816 self.papi.ip_neighbor_dump,
818 'sw_if_index': sw_if_index
822 def proxy_arp_add_del(self,
827 """ Config Proxy Arp Range.
829 :param low_address: Start address in the rnage to Proxy for
830 :param hi_address: End address in the rnage to Proxy for
831 :param vrf_id: The VRF/table in which to proxy
835 self.papi.proxy_arp_add_del,
838 'low_address': low_address,
839 'hi_address': hi_address,
843 def proxy_arp_intfc_enable_disable(self,
846 """ Enable/Disable an interface for proxy ARP requests
848 :param sw_if_index: Interface
849 :param enable_disable: Enable/Disable
853 self.papi.proxy_arp_intfc_enable_disable,
854 {'sw_if_index': sw_if_index,
855 'enable_disable': is_enable
863 """ Reset VRF (remove all routes etc.) request.
865 :param int vrf_id: ID of the FIB table / VRF to reset.
866 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
880 """ Reset VRF (remove all routes etc.) request.
882 :param int vrf_id: ID of the FIB table / VRF to reset.
883 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
898 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
907 def sw_interface_span_enable_disable(
908 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
911 :param sw_if_index_from:
912 :param sw_if_index_to:
916 return self.api(self.papi.sw_interface_span_enable_disable,
917 {'sw_if_index_from': sw_if_index_from,
918 'sw_if_index_to': sw_if_index_to,
923 def gre_tunnel_add_del(self,
934 :param outer_fib_id: (Default value = 0)
935 :param is_add: (Default value = 1)
936 :param is_ipv6: (Default value = 0)
937 :param is_teb: (Default value = 0)
941 self.papi.gre_add_del_tunnel,
945 'src_address': src_address,
946 'dst_address': dst_address,
947 'outer_fib_id': outer_fib_id}
950 def mpls_fib_dump(self):
951 return self.api(self.papi.mpls_fib_dump, {})
953 def mpls_table_add_del(
960 :param is_add: (Default value = 1)
965 self.papi.mpls_table_add_del,
966 {'mt_table_id': table_id,
967 'mt_is_add': is_add})
969 def mpls_route_add_del(
975 next_hop_sw_if_index=0xFFFFFFFF,
979 next_hop_n_out_labels=0,
980 next_hop_out_label_stack=[],
981 next_hop_via_label=MPLS_LABEL_INVALID,
983 is_resolve_attached=0,
990 classify_table_index=0xFFFFFFFF,
995 :param dst_address_length:
996 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
998 :param next_hop_address:
999 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1000 :param vrf_id: (Default value = 0)
1001 :param lookup_in_vrf: (Default value = 0)
1002 :param classify_table_index: (Default value = 0xFFFFFFFF)
1003 :param is_add: (Default value = 1)
1004 :param is_drop: (Default value = 0)
1005 :param is_ipv6: (Default value = 0)
1006 :param is_local: (Default value = 0)
1007 :param is_classify: (Default value = 0)
1008 :param is_multipath: (Default value = 0)
1009 :param is_multicast: (Default value = 0)
1010 :param is_resolve_host: (Default value = 0)
1011 :param is_resolve_attached: (Default value = 0)
1012 :param not_last: (Default value = 0)
1013 :param next_hop_weight: (Default value = 1)
1018 self.papi.mpls_route_add_del,
1021 'mr_table_id': table_id,
1022 'mr_classify_table_index': classify_table_index,
1023 'mr_is_add': is_add,
1024 'mr_is_classify': is_classify,
1025 'mr_is_multipath': is_multipath,
1026 'mr_is_multicast': is_multicast,
1027 'mr_is_resolve_host': is_resolve_host,
1028 'mr_is_resolve_attached': is_resolve_attached,
1029 'mr_is_interface_rx': is_interface_rx,
1030 'mr_is_rpf_id': is_rpf_id,
1031 'mr_next_hop_proto': next_hop_proto,
1032 'mr_next_hop_weight': next_hop_weight,
1033 'mr_next_hop': next_hop_address,
1034 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1035 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1036 'mr_next_hop_table_id': next_hop_table_id,
1037 'mr_next_hop_via_label': next_hop_via_label,
1038 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1040 def mpls_ip_bind_unbind(
1052 self.papi.mpls_ip_bind_unbind,
1053 {'mb_mpls_table_id': table_id,
1055 'mb_ip_table_id': ip_table_id,
1056 'mb_is_bind': is_bind,
1057 'mb_is_ip4': is_ip4,
1058 'mb_address_length': dst_address_length,
1059 'mb_address': dst_address})
1061 def mpls_tunnel_add_del(
1064 next_hop_proto_is_ip4,
1066 next_hop_sw_if_index=0xFFFFFFFF,
1067 next_hop_table_id=0,
1069 next_hop_n_out_labels=0,
1070 next_hop_out_label_stack=[],
1071 next_hop_via_label=MPLS_LABEL_INVALID,
1077 :param dst_address_length:
1078 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1080 :param next_hop_address:
1081 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1082 :param vrf_id: (Default value = 0)
1083 :param lookup_in_vrf: (Default value = 0)
1084 :param classify_table_index: (Default value = 0xFFFFFFFF)
1085 :param is_add: (Default value = 1)
1086 :param is_drop: (Default value = 0)
1087 :param is_ipv6: (Default value = 0)
1088 :param is_local: (Default value = 0)
1089 :param is_classify: (Default value = 0)
1090 :param is_multipath: (Default value = 0)
1091 :param is_resolve_host: (Default value = 0)
1092 :param is_resolve_attached: (Default value = 0)
1093 :param next_hop_weight: (Default value = 1)
1094 :param is_multicast: (Default value = 0)
1098 self.papi.mpls_tunnel_add_del,
1099 {'mt_sw_if_index': tun_sw_if_index,
1100 'mt_is_add': is_add,
1101 'mt_l2_only': l2_only,
1102 'mt_is_multicast': is_multicast,
1103 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1104 'mt_next_hop_weight': next_hop_weight,
1105 'mt_next_hop': next_hop_address,
1106 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1107 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1108 'mt_next_hop_table_id': next_hop_table_id,
1109 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1111 def nat44_interface_add_del_feature(
1116 """Enable/disable NAT44 feature on the interface
1118 :param sw_if_index: Software index of the interface
1119 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1120 :param is_add: 1 if add, 0 if delete (Default value = 1)
1123 self.papi.nat44_interface_add_del_feature,
1125 'is_inside': is_inside,
1126 'sw_if_index': sw_if_index})
1128 def nat44_interface_add_del_output_feature(
1133 """Enable/disable NAT44 output feature on the interface
1135 :param sw_if_index: Software index of the interface
1136 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1137 :param is_add: 1 if add, 0 if delete (Default value = 1)
1140 self.papi.nat44_interface_add_del_output_feature,
1142 'is_inside': is_inside,
1143 'sw_if_index': sw_if_index})
1145 def nat44_add_del_static_mapping(
1149 external_sw_if_index=0xFFFFFFFF,
1156 """Add/delete NAT44 static mapping
1158 :param local_ip: Local IP address
1159 :param external_ip: External IP address
1160 :param external_sw_if_index: External interface instead of IP address
1161 :param local_port: Local port number (Default value = 0)
1162 :param external_port: External port number (Default value = 0)
1163 :param addr_only: 1 if address only mapping, 0 if address and port
1164 :param vrf_id: VRF ID
1165 :param protocol: IP protocol (Default value = 0)
1166 :param is_add: 1 if add, 0 if delete (Default value = 1)
1169 self.papi.nat44_add_del_static_mapping,
1171 'addr_only': addr_only,
1172 'local_ip_address': local_ip,
1173 'external_ip_address': external_ip,
1174 'local_port': local_port,
1175 'external_port': external_port,
1176 'external_sw_if_index': external_sw_if_index,
1178 'protocol': protocol})
1180 def nat44_add_del_address_range(
1186 """Add/del NAT44 address range
1188 :param first_ip_address: First IP address
1189 :param last_ip_address: Last IP address
1190 :param vrf_id: VRF id for the address range
1191 :param is_add: 1 if add, 0 if delete (Default value = 1)
1194 self.papi.nat44_add_del_address_range,
1195 {'first_ip_address': first_ip_address,
1196 'last_ip_address': last_ip_address,
1200 def nat44_address_dump(self):
1201 """Dump NAT44 addresses
1202 :return: Dictionary of NAT44 addresses
1204 return self.api(self.papi.nat44_address_dump, {})
1206 def nat44_interface_dump(self):
1207 """Dump interfaces with NAT44 feature
1208 :return: Dictionary of interfaces with NAT44 feature
1210 return self.api(self.papi.nat44_interface_dump, {})
1212 def nat44_interface_output_feature_dump(self):
1213 """Dump interfaces with NAT44 output feature
1214 :return: Dictionary of interfaces with NAT44 output feature
1216 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1218 def nat44_static_mapping_dump(self):
1219 """Dump NAT44 static mappings
1220 :return: Dictionary of NAT44 static mappings
1222 return self.api(self.papi.nat44_static_mapping_dump, {})
1224 def nat_show_config(self):
1225 """Show NAT plugin config
1226 :return: NAT plugin config parameters
1228 return self.api(self.papi.nat_show_config, {})
1230 def nat44_add_interface_addr(
1234 """Add/del NAT44 address from interface
1236 :param sw_if_index: Software index of the interface
1237 :param is_add: 1 if add, 0 if delete (Default value = 1)
1239 return self.api(self.papi.nat44_add_del_interface_addr,
1240 {'is_add': is_add, 'sw_if_index': sw_if_index})
1242 def nat44_interface_addr_dump(self):
1243 """Dump NAT44 addresses interfaces
1244 :return: Dictionary of NAT44 addresses interfaces
1246 return self.api(self.papi.nat44_interface_addr_dump, {})
1253 """Enable/disable NAT IPFIX logging
1255 :param domain_id: Observation domain ID (Default value = 1)
1256 :param src_port: Source port number (Default value = 4739)
1257 :param enable: 1 if enable, 0 if disable (Default value = 1)
1260 self.papi.nat_ipfix_enable_disable,
1261 {'domain_id': domain_id,
1262 'src_port': src_port,
1265 def nat44_user_session_dump(
1269 """Dump NAT44 user's sessions
1271 :param ip_address: ip adress of the user to be dumped
1272 :param cpu_index: cpu_index on which the user is
1273 :param vrf_id: VRF ID
1274 :return: Dictionary of S-NAT sessions
1277 self.papi.nat44_user_session_dump,
1278 {'ip_address': ip_address,
1281 def nat44_user_dump(self):
1284 :return: Dictionary of NAT44 users
1286 return self.api(self.papi.nat44_user_dump, {})
1288 def nat44_add_del_lb_static_mapping(
1297 """Add/delete NAT44 load balancing static mapping
1299 :param is_add - 1 if add, 0 if delete
1302 self.papi.nat44_add_del_lb_static_mapping,
1304 'external_addr': external_addr,
1305 'external_port': external_port,
1306 'protocol': protocol,
1308 'local_num': local_num,
1311 def nat44_lb_static_mapping_dump(self):
1312 """Dump NAT44 load balancing static mappings
1314 :return: Dictionary of NAT44 load balancing static mapping
1316 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1318 def nat_det_add_del_map(
1325 """Add/delete deterministic NAT mapping
1327 :param is_add - 1 if add, 0 if delete
1328 :param in_addr - inside IP address
1329 :param in_plen - inside IP address prefix length
1330 :param out_addr - outside IP address
1331 :param out_plen - outside IP address prefix length
1334 self.papi.nat_det_add_del_map,
1339 'out_addr': out_addr,
1340 'out_plen': out_plen})
1342 def nat_det_forward(
1345 """Get outside address and port range from inside address
1347 :param in_addr - inside IP address
1350 self.papi.nat_det_forward,
1351 {'in_addr': in_addr,
1354 def nat_det_reverse(
1358 """Get inside address from outside address and port
1360 :param out_addr - outside IP address
1361 :param out_port - outside port
1364 self.papi.nat_det_reverse,
1365 {'out_addr': out_addr,
1366 'out_port': out_port})
1368 def nat_det_map_dump(self):
1369 """Dump deterministic NAT mappings
1371 :return: Dictionary of deterministic NAT mappings
1373 return self.api(self.papi.nat_det_map_dump, {})
1375 def nat_det_set_timeouts(
1378 tcp_established=7440,
1381 """Set values of timeouts for deterministic NAT (in seconds)
1383 :param udp - UDP timeout (Default value = 300)
1384 :param tcp_established - TCP established timeout (Default value = 7440)
1385 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1386 :param icmp - ICMP timeout (Default value = 60)
1389 self.papi.nat_det_set_timeouts,
1391 'tcp_established': tcp_established,
1392 'tcp_transitory': tcp_transitory,
1395 def nat_det_get_timeouts(self):
1396 """Get values of timeouts for deterministic NAT
1398 :return: Timeouts for deterministic NAT (in seconds)
1400 return self.api(self.papi.nat_det_get_timeouts, {})
1402 def nat_det_close_session_out(
1408 """Close deterministic NAT session using outside address and port
1410 :param out_addr - outside IP address
1411 :param out_port - outside port
1412 :param ext_addr - external host IP address
1413 :param ext_port - external host port
1416 self.papi.nat_det_close_session_out,
1417 {'out_addr': out_addr,
1418 'out_port': out_port,
1419 'ext_addr': ext_addr,
1420 'ext_port': ext_port})
1422 def nat_det_close_session_in(
1428 """Close deterministic NAT session using inside address and port
1430 :param in_addr - inside IP address
1431 :param in_port - inside port
1432 :param ext_addr - external host IP address
1433 :param ext_port - external host port
1436 self.papi.nat_det_close_session_in,
1437 {'in_addr': in_addr,
1439 'ext_addr': ext_addr,
1440 'ext_port': ext_port,
1443 def nat_det_session_dump(
1446 """Dump deterministic NAT sessions belonging to a user
1448 :param user_addr - inside IP address of the user
1449 :return: Dictionary of deterministic NAT sessions
1452 self.papi.nat_det_session_dump,
1454 'user_addr': user_addr})
1456 def nat64_add_del_pool_addr_range(
1462 """Add/del address range to NAT64 pool
1464 :param start_addr: First IP address
1465 :param end_addr: Last IP address
1466 :param vrf_id: VRF id for the address range
1467 :param is_add: 1 if add, 0 if delete (Default value = 1)
1470 self.papi.nat64_add_del_pool_addr_range,
1471 {'start_addr': start_addr,
1472 'end_addr': end_addr,
1476 def nat64_pool_addr_dump(self):
1477 """Dump NAT64 pool addresses
1478 :return: Dictionary of NAT64 pool addresses
1480 return self.api(self.papi.nat64_pool_addr_dump, {})
1482 def nat64_add_del_interface(
1487 """Enable/disable NAT64 feature on the interface
1488 :param sw_if_index: Index of the interface
1489 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1490 :param is_add: 1 if add, 0 if delete (Default value = 1)
1493 self.papi.nat64_add_del_interface,
1494 {'sw_if_index': sw_if_index,
1495 'is_inside': is_inside,
1498 def nat64_interface_dump(self):
1499 """Dump interfaces with NAT64 feature
1500 :return: Dictionary of interfaces with NAT64 feature
1502 return self.api(self.papi.nat64_interface_dump, {})
1504 def nat64_add_del_static_bib(
1513 """Add/delete S-NAT static BIB entry
1515 :param in_ip: Inside IPv6 address
1516 :param out_ip: Outside IPv4 address
1517 :param in_port: Inside port number
1518 :param out_port: Outside port number
1519 :param protocol: IP protocol
1520 :param vrf_id: VRF ID (Default value = 0)
1521 :param is_add: 1 if add, 0 if delete (Default value = 1)
1524 self.papi.nat64_add_del_static_bib,
1533 def nat64_bib_dump(self, protocol=255):
1536 :param protocol: IP protocol (Default value = 255, all BIBs)
1537 :returns: Dictionary of NAT64 BIB entries
1539 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1541 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1542 tcp_incoming_syn=6):
1543 """Set values of timeouts for NAT64 (in seconds)
1545 :param udpi: UDP timeout (Default value = 300)
1546 :param icmp: ICMP timeout (Default value = 60)
1547 :param tcp_trans: TCP transitory timeout (Default value = 240)
1548 :param tcp_est: TCP established timeout (Default value = 7440)
1549 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1552 self.papi.nat64_set_timeouts,
1555 'tcp_trans': tcp_trans,
1557 'tcp_incoming_syn': tcp_incoming_syn})
1559 def nat64_get_timeouts(self):
1560 """Get values of timeouts for NAT64
1562 :return: Timeouts for NAT64 (in seconds)
1564 return self.api(self.papi.nat64_get_timeouts, {})
1566 def nat64_st_dump(self, protocol=255):
1567 """Dump NAT64 session table
1569 :param protocol: IP protocol (Default value = 255, all STs)
1570 :returns: Dictionary of NAT64 sesstion table entries
1572 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1574 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1575 """Add/del NAT64 prefix
1577 :param prefix: NAT64 prefix
1578 :param plen: NAT64 prefix length
1579 :param vrf_id: VRF id of tenant (Default 0)
1580 :param is_add: 1 if add, 0 if delete (Default value = 1)
1583 self.papi.nat64_add_del_prefix,
1589 def nat64_prefix_dump(self):
1590 """Dump NAT64 prefix
1592 :returns: Dictionary of NAT64 prefixes
1594 return self.api(self.papi.nat64_prefix_dump, {})
1596 def control_ping(self):
1597 self.api(self.papi.control_ping)
1599 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1600 detect_mult, local_addr, peer_addr, is_ipv6=0,
1601 bfd_key_id=None, conf_key_id=None):
1602 if bfd_key_id is None:
1603 return self.api(self.papi.bfd_udp_add,
1605 'sw_if_index': sw_if_index,
1606 'desired_min_tx': desired_min_tx,
1607 'required_min_rx': required_min_rx,
1608 'local_addr': local_addr,
1609 'peer_addr': peer_addr,
1611 'detect_mult': detect_mult,
1614 return self.api(self.papi.bfd_udp_add,
1616 'sw_if_index': sw_if_index,
1617 'desired_min_tx': desired_min_tx,
1618 'required_min_rx': required_min_rx,
1619 'local_addr': local_addr,
1620 'peer_addr': peer_addr,
1622 'detect_mult': detect_mult,
1623 'is_authenticated': 1,
1624 'bfd_key_id': bfd_key_id,
1625 'conf_key_id': conf_key_id,
1628 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1629 detect_mult, local_addr, peer_addr, is_ipv6=0):
1630 return self.api(self.papi.bfd_udp_mod,
1632 'sw_if_index': sw_if_index,
1633 'desired_min_tx': desired_min_tx,
1634 'required_min_rx': required_min_rx,
1635 'local_addr': local_addr,
1636 'peer_addr': peer_addr,
1638 'detect_mult': detect_mult,
1641 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1642 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1644 return self.api(self.papi.bfd_udp_auth_activate,
1646 'sw_if_index': sw_if_index,
1647 'local_addr': local_addr,
1648 'peer_addr': peer_addr,
1650 'is_delayed': 1 if is_delayed else 0,
1651 'bfd_key_id': bfd_key_id,
1652 'conf_key_id': conf_key_id,
1655 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1656 is_ipv6=0, is_delayed=False):
1657 return self.api(self.papi.bfd_udp_auth_deactivate,
1659 'sw_if_index': sw_if_index,
1660 'local_addr': local_addr,
1661 'peer_addr': peer_addr,
1663 'is_delayed': 1 if is_delayed else 0,
1666 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1667 return self.api(self.papi.bfd_udp_del,
1669 'sw_if_index': sw_if_index,
1670 'local_addr': local_addr,
1671 'peer_addr': peer_addr,
1675 def bfd_udp_session_dump(self):
1676 return self.api(self.papi.bfd_udp_session_dump, {})
1678 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1679 peer_addr, is_ipv6=0):
1680 return self.api(self.papi.bfd_udp_session_set_flags, {
1681 'admin_up_down': admin_up_down,
1682 'sw_if_index': sw_if_index,
1683 'local_addr': local_addr,
1684 'peer_addr': peer_addr,
1688 def want_bfd_events(self, enable_disable=1):
1689 return self.api(self.papi.want_bfd_events, {
1690 'enable_disable': enable_disable,
1694 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1695 return self.api(self.papi.bfd_auth_set_key, {
1696 'conf_key_id': conf_key_id,
1697 'auth_type': auth_type,
1699 'key_len': len(key),
1702 def bfd_auth_del_key(self, conf_key_id):
1703 return self.api(self.papi.bfd_auth_del_key, {
1704 'conf_key_id': conf_key_id,
1707 def bfd_auth_keys_dump(self):
1708 return self.api(self.papi.bfd_auth_keys_dump, {})
1710 def bfd_udp_set_echo_source(self, sw_if_index):
1711 return self.api(self.papi.bfd_udp_set_echo_source,
1712 {'sw_if_index': sw_if_index})
1714 def bfd_udp_del_echo_source(self):
1715 return self.api(self.papi.bfd_udp_del_echo_source, {})
1717 def classify_add_del_table(
1722 table_index=0xFFFFFFFF,
1724 memory_size=2097152,
1726 next_table_index=0xFFFFFFFF,
1727 miss_next_index=0xFFFFFFFF,
1728 current_data_flag=0,
1729 current_data_offset=0):
1733 :param match_n_vectors: (Default value = 1)
1734 :param table_index: (Default value = 0xFFFFFFFF)
1735 :param nbuckets: (Default value = 2)
1736 :param memory_size: (Default value = 2097152)
1737 :param skip_n_vectors: (Default value = 0)
1738 :param next_table_index: (Default value = 0xFFFFFFFF)
1739 :param miss_next_index: (Default value = 0xFFFFFFFF)
1740 :param current_data_flag: (Default value = 0)
1741 :param current_data_offset: (Default value = 0)
1745 self.papi.classify_add_del_table,
1747 'table_index': table_index,
1748 'nbuckets': nbuckets,
1749 'memory_size': memory_size,
1750 'skip_n_vectors': skip_n_vectors,
1751 'match_n_vectors': match_n_vectors,
1752 'next_table_index': next_table_index,
1753 'miss_next_index': miss_next_index,
1754 'current_data_flag': current_data_flag,
1755 'current_data_offset': current_data_offset,
1758 def classify_add_del_session(
1763 opaque_index=0xFFFFFFFF,
1764 hit_next_index=0xFFFFFFFF,
1772 :param opaque_index: (Default value = 0xFFFFFFFF)
1773 :param hit_next_index: (Default value = 0xFFFFFFFF)
1774 :param advance: (Default value = 0)
1775 :param action: (Default value = 0)
1776 :param metadata: (Default value = 0)
1780 self.papi.classify_add_del_session,
1782 'table_index': table_index,
1783 'hit_next_index': hit_next_index,
1784 'opaque_index': opaque_index,
1787 'metadata': metadata,
1790 def input_acl_set_interface(
1794 ip4_table_index=0xFFFFFFFF,
1795 ip6_table_index=0xFFFFFFFF,
1796 l2_table_index=0xFFFFFFFF):
1800 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1801 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1802 :param l2_table_index: (Default value = 0xFFFFFFFF)
1806 self.papi.input_acl_set_interface,
1807 {'sw_if_index': sw_if_index,
1808 'ip4_table_index': ip4_table_index,
1809 'ip6_table_index': ip6_table_index,
1810 'l2_table_index': l2_table_index,
1813 def set_ipfix_exporter(
1820 collector_port=4739,
1823 self.papi.set_ipfix_exporter,
1825 'collector_address': collector_address,
1826 'collector_port': collector_port,
1827 'src_address': src_address,
1829 'path_mtu': path_mtu,
1830 'template_interval': template_interval,
1831 'udp_checksum': udp_checksum,
1834 def dhcp_proxy_config(self,
1842 self.papi.dhcp_proxy_config,
1844 'rx_vrf_id': rx_table_id,
1845 'server_vrf_id': server_table_id,
1848 'dhcp_server': dhcp_server,
1849 'dhcp_src_address': dhcp_src_address,
1852 def dhcp_proxy_set_vss(self,
1859 self.papi.dhcp_proxy_set_vss,
1868 def dhcp_client(self,
1873 want_dhcp_events=0):
1875 self.papi.dhcp_client_config,
1877 'sw_if_index': sw_if_index,
1878 'hostname': hostname,
1879 'client_id': client_id,
1881 'want_dhcp_event': want_dhcp_events,
1885 def ip_mroute_add_del(self,
1890 next_hop_sw_if_index,
1900 self.papi.ip_mroute_add_del,
1901 {'next_hop_sw_if_index': next_hop_sw_if_index,
1902 'entry_flags': e_flags,
1903 'itf_flags': i_flags,
1904 'table_id': table_id,
1908 'is_local': is_local,
1909 'grp_address_length': grp_address_length,
1910 'grp_address': grp_address,
1911 'src_address': src_address})
1913 def mfib_signal_dump(self):
1914 return self.api(self.papi.mfib_signal_dump, {})
1916 def ip_mfib_dump(self):
1917 return self.api(self.papi.ip_mfib_dump, {})
1919 def lisp_enable_disable(self, is_enabled):
1921 self.papi.lisp_enable_disable,
1923 'is_en': is_enabled,
1926 def lisp_locator_set(self,
1930 self.papi.lisp_add_del_locator_set,
1933 'locator_set_name': ls_name
1936 def lisp_locator_set_dump(self):
1937 return self.api(self.papi.lisp_locator_set_dump, {})
1939 def lisp_locator(self,
1946 self.papi.lisp_add_del_locator,
1949 'locator_set_name': ls_name,
1950 'sw_if_index': sw_if_index,
1951 'priority': priority,
1955 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1957 self.papi.lisp_locator_dump,
1959 'is_index_set': is_index_set,
1961 'ls_index': ls_index,
1964 def lisp_local_mapping(self,
1974 self.papi.lisp_add_del_local_eid,
1976 'locator_set_name': ls_name,
1978 'eid_type': eid_type,
1980 'prefix_len': prefix_len,
1986 def lisp_eid_table_dump(self,
1994 self.papi.lisp_eid_table_dump,
1997 'prefix_length': prefix_length,
1999 'eid_type': eid_type,
2001 'filter': filter_opt,
2004 def lisp_remote_mapping(self,
2014 self.papi.lisp_add_del_remote_mapping,
2017 'eid_type': eid_type,
2019 'eid_len': eid_prefix_len,
2020 'rloc_num': rlocs_num,
2023 'is_src_dst': is_src_dst,
2026 def lisp_adjacency(self,
2035 self.papi.lisp_add_del_adjacency,
2039 'eid_type': eid_type,
2042 'leid_len': leid_len,
2043 'reid_len': reid_len,
2046 def lisp_adjacencies_get(self, vni=0):
2048 self.papi.lisp_adjacencies_get,
2053 def map_add_domain(self,
2066 self.papi.map_add_domain,
2068 'ip6_prefix': ip6_prefix,
2069 'ip6_prefix_len': ip6_prefix_len,
2070 'ip4_prefix': ip4_prefix,
2071 'ip4_prefix_len': ip4_prefix_len,
2073 'ip6_src_prefix_len': ip6_src_prefix_len,
2074 'ea_bits_len': ea_bits_len,
2075 'psid_offset': psid_offset,
2076 'psid_length': psid_length,
2077 'is_translation': is_translation,
2081 def gtpu_add_del_tunnel(
2087 mcast_sw_if_index=0xFFFFFFFF,
2089 decap_next_index=0xFFFFFFFF,
2093 :param is_add: (Default value = 1)
2094 :param is_ipv6: (Default value = 0)
2097 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2098 :param encap_vrf_id: (Default value = 0)
2099 :param decap_next_index: (Default value = 0xFFFFFFFF)
2100 :param teid: (Default value = 0)
2103 return self.api(self.papi.gtpu_add_del_tunnel,
2106 'src_address': src_addr,
2107 'dst_address': dst_addr,
2108 'mcast_sw_if_index': mcast_sw_if_index,
2109 'encap_vrf_id': encap_vrf_id,
2110 'decap_next_index': decap_next_index,
2113 def vxlan_gpe_add_del_tunnel(
2117 mcast_sw_if_index=0xFFFFFFFF,
2128 :param is_add: (Default value = 1)
2129 :param is_ipv6: (Default value = 0)
2130 :param encap_vrf_id: (Default value = 0)
2131 :param decap_vrf_id: (Default value = 0)
2132 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2133 :param protocol: (Default value = 3)
2134 :param vni: (Default value = 0)
2137 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2142 'mcast_sw_if_index': mcast_sw_if_index,
2143 'encap_vrf_id': encap_vrf_id,
2144 'decap_vrf_id': decap_vrf_id,
2145 'protocol': protocol,
2148 def pppoe_add_del_session(
2158 :param is_add: (Default value = 1)
2159 :param is_ipv6: (Default value = 0)
2161 :param session_id: (Default value = 0)
2163 :param decap_vrf_id: (Default value = 0)
2166 return self.api(self.papi.pppoe_add_del_session,
2169 'session_id': session_id,
2170 'client_ip': client_ip,
2171 'decap_vrf_id': decap_vrf_id,
2172 'client_mac': client_mac})
2174 def sr_localsid_add_del(self,
2180 sw_if_index=0xFFFFFFFF,
2184 """ Add/del IPv6 SR local-SID.
2186 :param localsid_addr:
2187 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2188 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2190 :param is_del: (Default value = 0)
2191 :param end_psp: (Default value = 0)
2192 :param sw_if_index: (Default value = 0xFFFFFFFF)
2193 :param vlan_index: (Default value = 0)
2194 :param fib_table: (Default value = 0)
2197 self.papi.sr_localsid_add_del,
2199 'localsid_addr': localsid_addr,
2201 'behavior': behavior,
2202 'sw_if_index': sw_if_index,
2203 'vlan_index': vlan_index,
2204 'fib_table': fib_table,
2219 :param bsid_addr: bindingSID of the SR Policy
2220 :param weight: weight of the sid list. optional. (default: 1)
2221 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2223 :param type: type/behavior of the SR policy. (default or spray) \
2225 :param fib_table: VRF where to install the FIB entry for the BSID \
2227 :param n_segments: number of segments \
2229 :param segments: a vector of IPv6 address composing the segment list \
2233 self.papi.sr_policy_add,
2234 {'bsid_addr': bsid_addr,
2236 'is_encap': is_encap,
2238 'fib_table': fib_table,
2239 'n_segments': n_segments,
2240 'segments': segments
2249 :param bsid: bindingSID of the SR Policy
2250 :param sr_policy_index: index of the sr policy (default: 0)
2253 self.papi.sr_policy_del,
2254 {'bsid_addr': bsid_addr,
2255 'sr_policy_index': sr_policy_index
2258 def sr_steering_add_del(
2269 Steer traffic L2 and L3 traffic through a given SR policy
2271 :param is_del: delete or add
2272 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2273 :param sr_policy: is the index of the SR Policy (alt to bsid)
2274 :param table_id: is the VRF where to install the FIB entry for the BSID
2275 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2276 :param mask_width: is the mask for L3 traffic type
2277 :param sw_if_index: is the incoming interface for L2 traffic
2278 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2281 self.papi.sr_steering_add_del,
2283 'bsid_addr': bsid_addr,
2284 'sr_policy_index': sr_policy_index,
2285 'table_id': table_id,
2286 'prefix_addr': prefix_addr,
2287 'mask_width': mask_width,
2288 'sw_if_index': sw_if_index,
2289 'traffic_type': traffic_type
2292 def acl_add_replace(self, acl_index, r, tag='',
2294 """Add/replace an ACL
2295 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2296 :param acl_rule r: ACL rules array.
2297 :param str tag: symbolic tag (description) for this ACL.
2298 :param int count: number of rules.
2300 return self.api(self.papi.acl_add_replace,
2301 {'acl_index': acl_index,
2305 expected_retval=expected_retval)
2307 def acl_del(self, acl_index, expected_retval=0):
2313 return self.api(self.papi.acl_del,
2314 {'acl_index': acl_index},
2315 expected_retval=expected_retval)
2317 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2319 return self.api(self.papi.acl_interface_set_acl_list,
2320 {'sw_if_index': sw_if_index,
2324 expected_retval=expected_retval)
2326 def acl_dump(self, acl_index, expected_retval=0):
2327 return self.api(self.papi.acl_dump,
2328 {'acl_index': acl_index},
2329 expected_retval=expected_retval)
2331 def macip_acl_add(self, rules, tag=""):
2334 :param rules: list of rules for given acl
2338 return self.api(self.papi.macip_acl_add,
2340 'count': len(rules),
2343 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2346 :param rules: list of rules for given acl
2350 return self.api(self.papi.macip_acl_add_replace,
2351 {'acl_index': acl_index,
2353 'count': len(rules),
2356 def macip_acl_del(self, acl_index):
2362 return self.api(self.papi.macip_acl_del,
2363 {'acl_index': acl_index})
2365 def macip_acl_interface_add_del(self,
2369 """ Add MACIP acl to interface
2373 :param is_add: (Default value = 1)
2376 return self.api(self.papi.macip_acl_interface_add_del,
2378 'sw_if_index': sw_if_index,
2379 'acl_index': acl_index})
2381 def macip_acl_interface_get(self):
2382 """ Return interface acls dump
2385 self.papi.macip_acl_interface_get, {})
2387 def macip_acl_dump(self, acl_index=4294967295):
2388 """ Return MACIP acl dump
2392 self.papi.macip_acl_dump, {'acl_index': acl_index})