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 l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
429 filter_mac=0, bvi_mac=0):
430 """Create/delete L2 FIB entry.
432 :param str mac: MAC address to create FIB entry for.
433 :param int bd_id: Bridge domain index.
434 :param int sw_if_index: Software interface index of the interface.
435 :param int is_add: Add or delete flag. (Default value = 1)
436 :param int static_mac: Set to 1 to create static MAC entry.
438 :param int filter_mac: Set to 1 to drop packet that's source or
439 destination MAC address contains defined MAC address.
441 :param int bvi_mac: Set to 1 to create entry that points to BVI
442 interface. (Default value = 0)
444 return self.api(self.papi.l2fib_add_del,
445 {'mac': self._convert_mac(mac),
447 'sw_if_index': sw_if_index,
449 'static_mac': static_mac,
450 'filter_mac': filter_mac,
453 def l2fib_flush_int(self, sw_if_index):
454 """Flush L2 FIB entries for sw_if_index.
456 :param int sw_if_index: Software interface index of the interface.
458 return self.api(self.papi.l2fib_flush_int,
459 {'sw_if_index': sw_if_index})
461 def l2fib_flush_bd(self, bd_id):
462 """Flush L2 FIB entries for bd_id.
464 :param int sw_if_index: Bridge Domain id.
466 return self.api(self.papi.l2fib_flush_bd,
469 def l2fib_flush_all(self):
472 return self.api(self.papi.l2fib_flush_all, {})
474 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
475 shg=0, bvi=0, enable=1):
476 """Add/remove interface to/from bridge domain.
478 :param int sw_if_index: Software interface index of the interface.
479 :param int bd_id: Bridge domain index.
480 :param int shg: Split-horizon group index. (Default value = 0)
481 :param int bvi: Set interface as a bridge group virtual interface.
483 :param int enable: Add or remove interface. (Default value = 1)
485 return self.api(self.papi.sw_interface_set_l2_bridge,
486 {'rx_sw_if_index': sw_if_index,
492 def bridge_flags(self, bd_id, is_set, feature_bitmap):
493 """Enable/disable required feature of the bridge domain with defined ID.
495 :param int bd_id: Bridge domain ID.
496 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
497 :param int feature_bitmap: Bitmap value of the feature to be set:
501 - uu-flood (1 << 3) or
504 return self.api(self.papi.bridge_flags,
507 'feature_bitmap': feature_bitmap})
509 def bridge_domain_dump(self, bd_id=0):
512 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
513 existing bridge domains returned)
514 :return: Dictionary of bridge domain(s) data.
516 return self.api(self.papi.bridge_domain_dump,
519 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
521 """Create or delete unidirectional cross-connect from Tx interface to
524 :param int rx_sw_if_index: Software interface index of Rx interface.
525 :param int tx_sw_if_index: Software interface index of Tx interface.
526 :param int enable: Create cross-connect if equal to 1, delete
527 cross-connect if equal to 0.
530 return self.api(self.papi.sw_interface_set_l2_xconnect,
531 {'rx_sw_if_index': rx_sw_if_index,
532 'tx_sw_if_index': tx_sw_if_index,
535 def sw_interface_set_l2_tag_rewrite(
542 """L2 interface vlan tag rewrite configure request
543 :param client_index - opaque cookie to identify the sender
544 :param context - sender context, to match reply w/ request
545 :param sw_if_index - interface the operation is applied to
546 :param vtr_op - Choose from l2_vtr_op_t enum values
547 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
548 :param tag1 - Needed for any push or translate vtr op
549 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
552 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
553 {'sw_if_index': sw_if_index,
559 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
562 :param admin_up_down:
566 return self.api(self.papi.sw_interface_set_flags,
567 {'sw_if_index': sw_if_index,
568 'admin_up_down': admin_up_down})
570 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
571 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
572 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
573 """Create subinterface
574 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
576 :param sub_id: param inner_vlan:
580 :param no_tags: (Default value = 0)
581 :param one_tag: (Default value = 0)
582 :param two_tags: (Default value = 0)
583 :param dot1ad: (Default value = 0)
584 :param exact_match: (Default value = 0)
585 :param default_sub: (Default value = 0)
586 :param outer_vlan_id_any: (Default value = 0)
587 :param inner_vlan_id_any: (Default value = 0)
591 self.papi.create_subif,
592 {'sw_if_index': sw_if_index,
596 'two_tags': two_tags,
598 'exact_match': exact_match,
599 'default_sub': default_sub,
600 'outer_vlan_id_any': outer_vlan_id_any,
601 'inner_vlan_id_any': inner_vlan_id_any,
602 'outer_vlan_id': outer_vlan,
603 'inner_vlan_id': inner_vlan})
605 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
606 """Create p2p ethernet subinterface
608 :param sw_if_index: main (parent) interface
609 :param remote_mac: client (remote) mac address
613 self.papi.p2p_ethernet_add,
614 {'parent_if_index': sw_if_index,
615 'remote_mac': remote_mac,
616 'subif_id': subif_id})
618 def delete_subif(self, sw_if_index):
619 """Delete subinterface
623 return self.api(self.papi.delete_subif,
624 {'sw_if_index': sw_if_index})
626 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
627 """Delete p2p ethernet subinterface
629 :param sw_if_index: main (parent) interface
630 :param remote_mac: client (remote) mac address
634 self.papi.p2p_ethernet_del,
635 {'parent_if_index': sw_if_index,
636 'remote_mac': remote_mac})
638 def create_vlan_subif(self, sw_if_index, vlan):
645 return self.api(self.papi.create_vlan_subif,
646 {'sw_if_index': sw_if_index,
649 def create_loopback(self, mac=''):
652 :param mac: (Optional)
654 return self.api(self.papi.create_loopback,
655 {'mac_address': mac})
657 def delete_loopback(self, sw_if_index):
658 return self.api(self.papi.delete_loopback,
659 {'sw_if_index': sw_if_index, })
661 def ip_table_add_del(self,
668 :param is_add: (Default value = 1)
669 :param is_ipv6: (Default value = 0)
674 self.papi.ip_table_add_del,
675 {'table_id': table_id,
679 def ip_add_del_route(
684 next_hop_sw_if_index=0xFFFFFFFF,
688 next_hop_n_out_labels=0,
689 next_hop_out_label_stack=[],
690 next_hop_via_label=MPLS_LABEL_INVALID,
692 is_resolve_attached=0,
693 classify_table_index=0xFFFFFFFF,
705 :param dst_address_length:
706 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
708 :param next_hop_address:
709 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
710 :param vrf_id: (Default value = 0)
711 :param lookup_in_vrf: (Default value = 0)
712 :param classify_table_index: (Default value = 0xFFFFFFFF)
713 :param is_add: (Default value = 1)
714 :param is_drop: (Default value = 0)
715 :param is_ipv6: (Default value = 0)
716 :param is_local: (Default value = 0)
717 :param is_classify: (Default value = 0)
718 :param is_multipath: (Default value = 0)
719 :param is_resolve_host: (Default value = 0)
720 :param is_resolve_attached: (Default value = 0)
721 :param not_last: (Default value = 0)
722 :param next_hop_weight: (Default value = 1)
727 self.papi.ip_add_del_route,
728 {'next_hop_sw_if_index': next_hop_sw_if_index,
729 'table_id': table_id,
730 'classify_table_index': classify_table_index,
731 'next_hop_table_id': next_hop_table_id,
734 'is_unreach': is_unreach,
735 'is_prohibit': is_prohibit,
737 'is_local': is_local,
738 'is_classify': is_classify,
739 'is_multipath': is_multipath,
740 'is_resolve_host': is_resolve_host,
741 'is_resolve_attached': is_resolve_attached,
742 'not_last': not_last,
743 'next_hop_weight': next_hop_weight,
744 'dst_address_length': dst_address_length,
745 'dst_address': dst_address,
746 'next_hop_address': next_hop_address,
747 'next_hop_n_out_labels': next_hop_n_out_labels,
748 'next_hop_via_label': next_hop_via_label,
749 'next_hop_out_label_stack': next_hop_out_label_stack})
751 def ip_fib_dump(self):
752 return self.api(self.papi.ip_fib_dump, {})
754 def ip6_fib_dump(self):
755 return self.api(self.papi.ip6_fib_dump, {})
757 def ip_neighbor_add_del(self,
766 """ Add neighbor MAC to IPv4 or IPv6 address.
771 :param is_add: (Default value = 1)
772 :param is_ipv6: (Default value = 0)
773 :param is_static: (Default value = 0)
774 :param is_no_adj_fib: (Default value = 0)
778 self.papi.ip_neighbor_add_del,
779 {'sw_if_index': sw_if_index,
782 'is_static': is_static,
783 'is_no_adj_fib': is_no_adj_fib,
784 'mac_address': mac_address,
785 'dst_address': dst_address
789 def ip_neighbor_dump(self,
792 """ Return IP neighbor dump.
795 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
799 self.papi.ip_neighbor_dump,
801 'sw_if_index': sw_if_index
805 def proxy_arp_add_del(self,
810 """ Config Proxy Arp Range.
812 :param low_address: Start address in the rnage to Proxy for
813 :param hi_address: End address in the rnage to Proxy for
814 :param vrf_id: The VRF/table in which to proxy
818 self.papi.proxy_arp_add_del,
821 'low_address': low_address,
822 'hi_address': hi_address,
826 def proxy_arp_intfc_enable_disable(self,
829 """ Enable/Disable an interface for proxy ARP requests
831 :param sw_if_index: Interface
832 :param enable_disable: Enable/Disable
836 self.papi.proxy_arp_intfc_enable_disable,
837 {'sw_if_index': sw_if_index,
838 'enable_disable': is_enable
846 """ Reset VRF (remove all routes etc.) request.
848 :param int vrf_id: ID of the FIB table / VRF to reset.
849 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
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)
881 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
890 def sw_interface_span_enable_disable(
891 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
894 :param sw_if_index_from:
895 :param sw_if_index_to:
899 return self.api(self.papi.sw_interface_span_enable_disable,
900 {'sw_if_index_from': sw_if_index_from,
901 'sw_if_index_to': sw_if_index_to,
906 def gre_tunnel_add_del(self,
917 :param outer_fib_id: (Default value = 0)
918 :param is_add: (Default value = 1)
919 :param is_ipv6: (Default value = 0)
920 :param is_teb: (Default value = 0)
924 self.papi.gre_add_del_tunnel,
928 'src_address': src_address,
929 'dst_address': dst_address,
930 'outer_fib_id': outer_fib_id}
933 def mpls_fib_dump(self):
934 return self.api(self.papi.mpls_fib_dump, {})
936 def mpls_table_add_del(
943 :param is_add: (Default value = 1)
948 self.papi.mpls_table_add_del,
949 {'mt_table_id': table_id,
950 'mt_is_add': is_add})
952 def mpls_route_add_del(
958 next_hop_sw_if_index=0xFFFFFFFF,
962 next_hop_n_out_labels=0,
963 next_hop_out_label_stack=[],
964 next_hop_via_label=MPLS_LABEL_INVALID,
966 is_resolve_attached=0,
973 classify_table_index=0xFFFFFFFF,
978 :param dst_address_length:
979 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
981 :param next_hop_address:
982 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
983 :param vrf_id: (Default value = 0)
984 :param lookup_in_vrf: (Default value = 0)
985 :param classify_table_index: (Default value = 0xFFFFFFFF)
986 :param is_add: (Default value = 1)
987 :param is_drop: (Default value = 0)
988 :param is_ipv6: (Default value = 0)
989 :param is_local: (Default value = 0)
990 :param is_classify: (Default value = 0)
991 :param is_multipath: (Default value = 0)
992 :param is_multicast: (Default value = 0)
993 :param is_resolve_host: (Default value = 0)
994 :param is_resolve_attached: (Default value = 0)
995 :param not_last: (Default value = 0)
996 :param next_hop_weight: (Default value = 1)
1001 self.papi.mpls_route_add_del,
1004 'mr_table_id': table_id,
1005 'mr_classify_table_index': classify_table_index,
1006 'mr_is_add': is_add,
1007 'mr_is_classify': is_classify,
1008 'mr_is_multipath': is_multipath,
1009 'mr_is_multicast': is_multicast,
1010 'mr_is_resolve_host': is_resolve_host,
1011 'mr_is_resolve_attached': is_resolve_attached,
1012 'mr_is_interface_rx': is_interface_rx,
1013 'mr_is_rpf_id': is_rpf_id,
1014 'mr_next_hop_proto': next_hop_proto,
1015 'mr_next_hop_weight': next_hop_weight,
1016 'mr_next_hop': next_hop_address,
1017 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1018 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1019 'mr_next_hop_table_id': next_hop_table_id,
1020 'mr_next_hop_via_label': next_hop_via_label,
1021 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1023 def mpls_ip_bind_unbind(
1035 self.papi.mpls_ip_bind_unbind,
1036 {'mb_mpls_table_id': table_id,
1038 'mb_ip_table_id': ip_table_id,
1039 'mb_is_bind': is_bind,
1040 'mb_is_ip4': is_ip4,
1041 'mb_address_length': dst_address_length,
1042 'mb_address': dst_address})
1044 def mpls_tunnel_add_del(
1047 next_hop_proto_is_ip4,
1049 next_hop_sw_if_index=0xFFFFFFFF,
1050 next_hop_table_id=0,
1052 next_hop_n_out_labels=0,
1053 next_hop_out_label_stack=[],
1054 next_hop_via_label=MPLS_LABEL_INVALID,
1060 :param dst_address_length:
1061 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1063 :param next_hop_address:
1064 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1065 :param vrf_id: (Default value = 0)
1066 :param lookup_in_vrf: (Default value = 0)
1067 :param classify_table_index: (Default value = 0xFFFFFFFF)
1068 :param is_add: (Default value = 1)
1069 :param is_drop: (Default value = 0)
1070 :param is_ipv6: (Default value = 0)
1071 :param is_local: (Default value = 0)
1072 :param is_classify: (Default value = 0)
1073 :param is_multipath: (Default value = 0)
1074 :param is_resolve_host: (Default value = 0)
1075 :param is_resolve_attached: (Default value = 0)
1076 :param next_hop_weight: (Default value = 1)
1077 :param is_multicast: (Default value = 0)
1081 self.papi.mpls_tunnel_add_del,
1082 {'mt_sw_if_index': tun_sw_if_index,
1083 'mt_is_add': is_add,
1084 'mt_l2_only': l2_only,
1085 'mt_is_multicast': is_multicast,
1086 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1087 'mt_next_hop_weight': next_hop_weight,
1088 'mt_next_hop': next_hop_address,
1089 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1090 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1091 'mt_next_hop_table_id': next_hop_table_id,
1092 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1094 def nat44_interface_add_del_feature(
1099 """Enable/disable NAT44 feature on the interface
1101 :param sw_if_index: Software index of the interface
1102 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1103 :param is_add: 1 if add, 0 if delete (Default value = 1)
1106 self.papi.nat44_interface_add_del_feature,
1108 'is_inside': is_inside,
1109 'sw_if_index': sw_if_index})
1111 def nat44_interface_add_del_output_feature(
1116 """Enable/disable NAT44 output 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_output_feature,
1125 'is_inside': is_inside,
1126 'sw_if_index': sw_if_index})
1128 def nat44_add_del_static_mapping(
1132 external_sw_if_index=0xFFFFFFFF,
1139 """Add/delete NAT44 static mapping
1141 :param local_ip: Local IP address
1142 :param external_ip: External IP address
1143 :param external_sw_if_index: External interface instead of IP address
1144 :param local_port: Local port number (Default value = 0)
1145 :param external_port: External port number (Default value = 0)
1146 :param addr_only: 1 if address only mapping, 0 if address and port
1147 :param vrf_id: VRF ID
1148 :param protocol: IP protocol (Default value = 0)
1149 :param is_add: 1 if add, 0 if delete (Default value = 1)
1152 self.papi.nat44_add_del_static_mapping,
1154 'addr_only': addr_only,
1155 'local_ip_address': local_ip,
1156 'external_ip_address': external_ip,
1157 'local_port': local_port,
1158 'external_port': external_port,
1159 'external_sw_if_index': external_sw_if_index,
1161 'protocol': protocol})
1163 def nat44_add_del_address_range(
1169 """Add/del NAT44 address range
1171 :param first_ip_address: First IP address
1172 :param last_ip_address: Last IP address
1173 :param vrf_id: VRF id for the address range
1174 :param is_add: 1 if add, 0 if delete (Default value = 1)
1177 self.papi.nat44_add_del_address_range,
1178 {'first_ip_address': first_ip_address,
1179 'last_ip_address': last_ip_address,
1183 def nat44_address_dump(self):
1184 """Dump NAT44 addresses
1185 :return: Dictionary of NAT44 addresses
1187 return self.api(self.papi.nat44_address_dump, {})
1189 def nat44_interface_dump(self):
1190 """Dump interfaces with NAT44 feature
1191 :return: Dictionary of interfaces with NAT44 feature
1193 return self.api(self.papi.nat44_interface_dump, {})
1195 def nat44_interface_output_feature_dump(self):
1196 """Dump interfaces with NAT44 output feature
1197 :return: Dictionary of interfaces with NAT44 output feature
1199 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1201 def nat44_static_mapping_dump(self):
1202 """Dump NAT44 static mappings
1203 :return: Dictionary of NAT44 static mappings
1205 return self.api(self.papi.nat44_static_mapping_dump, {})
1207 def nat_show_config(self):
1208 """Show NAT plugin config
1209 :return: NAT plugin config parameters
1211 return self.api(self.papi.nat_show_config, {})
1213 def nat44_add_interface_addr(
1217 """Add/del NAT44 address from interface
1219 :param sw_if_index: Software index of the interface
1220 :param is_add: 1 if add, 0 if delete (Default value = 1)
1222 return self.api(self.papi.nat44_add_del_interface_addr,
1223 {'is_add': is_add, 'sw_if_index': sw_if_index})
1225 def nat44_interface_addr_dump(self):
1226 """Dump NAT44 addresses interfaces
1227 :return: Dictionary of NAT44 addresses interfaces
1229 return self.api(self.papi.nat44_interface_addr_dump, {})
1236 """Enable/disable NAT IPFIX logging
1238 :param domain_id: Observation domain ID (Default value = 1)
1239 :param src_port: Source port number (Default value = 4739)
1240 :param enable: 1 if enable, 0 if disable (Default value = 1)
1243 self.papi.nat_ipfix_enable_disable,
1244 {'domain_id': domain_id,
1245 'src_port': src_port,
1248 def nat44_user_session_dump(
1252 """Dump NAT44 user's sessions
1254 :param ip_address: ip adress of the user to be dumped
1255 :param cpu_index: cpu_index on which the user is
1256 :param vrf_id: VRF ID
1257 :return: Dictionary of S-NAT sessions
1260 self.papi.nat44_user_session_dump,
1261 {'ip_address': ip_address,
1264 def nat44_user_dump(self):
1267 :return: Dictionary of NAT44 users
1269 return self.api(self.papi.nat44_user_dump, {})
1271 def nat44_add_del_lb_static_mapping(
1280 """Add/delete NAT44 load balancing static mapping
1282 :param is_add - 1 if add, 0 if delete
1285 self.papi.nat44_add_del_lb_static_mapping,
1287 'external_addr': external_addr,
1288 'external_port': external_port,
1289 'protocol': protocol,
1291 'local_num': local_num,
1294 def nat44_lb_static_mapping_dump(self):
1295 """Dump NAT44 load balancing static mappings
1297 :return: Dictionary of NAT44 load balancing static mapping
1299 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1301 def nat_det_add_del_map(
1308 """Add/delete deterministic NAT mapping
1310 :param is_add - 1 if add, 0 if delete
1311 :param in_addr - inside IP address
1312 :param in_plen - inside IP address prefix length
1313 :param out_addr - outside IP address
1314 :param out_plen - outside IP address prefix length
1317 self.papi.nat_det_add_del_map,
1322 'out_addr': out_addr,
1323 'out_plen': out_plen})
1325 def nat_det_forward(
1328 """Get outside address and port range from inside address
1330 :param in_addr - inside IP address
1333 self.papi.nat_det_forward,
1334 {'in_addr': in_addr,
1337 def nat_det_reverse(
1341 """Get inside address from outside address and port
1343 :param out_addr - outside IP address
1344 :param out_port - outside port
1347 self.papi.nat_det_reverse,
1348 {'out_addr': out_addr,
1349 'out_port': out_port})
1351 def nat_det_map_dump(self):
1352 """Dump deterministic NAT mappings
1354 :return: Dictionary of deterministic NAT mappings
1356 return self.api(self.papi.nat_det_map_dump, {})
1358 def nat_det_set_timeouts(
1361 tcp_established=7440,
1364 """Set values of timeouts for deterministic NAT (in seconds)
1366 :param udp - UDP timeout (Default value = 300)
1367 :param tcp_established - TCP established timeout (Default value = 7440)
1368 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1369 :param icmp - ICMP timeout (Default value = 60)
1372 self.papi.nat_det_set_timeouts,
1374 'tcp_established': tcp_established,
1375 'tcp_transitory': tcp_transitory,
1378 def nat_det_get_timeouts(self):
1379 """Get values of timeouts for deterministic NAT
1381 :return: Timeouts for deterministic NAT (in seconds)
1383 return self.api(self.papi.nat_det_get_timeouts, {})
1385 def nat_det_close_session_out(
1391 """Close deterministic NAT session using outside address and port
1393 :param out_addr - outside IP address
1394 :param out_port - outside port
1395 :param ext_addr - external host IP address
1396 :param ext_port - external host port
1399 self.papi.nat_det_close_session_out,
1400 {'out_addr': out_addr,
1401 'out_port': out_port,
1402 'ext_addr': ext_addr,
1403 'ext_port': ext_port})
1405 def nat_det_close_session_in(
1411 """Close deterministic NAT session using inside address and port
1413 :param in_addr - inside IP address
1414 :param in_port - inside port
1415 :param ext_addr - external host IP address
1416 :param ext_port - external host port
1419 self.papi.nat_det_close_session_in,
1420 {'in_addr': in_addr,
1422 'ext_addr': ext_addr,
1423 'ext_port': ext_port,
1426 def nat_det_session_dump(
1429 """Dump deterministic NAT sessions belonging to a user
1431 :param user_addr - inside IP address of the user
1432 :return: Dictionary of deterministic NAT sessions
1435 self.papi.nat_det_session_dump,
1437 'user_addr': user_addr})
1439 def nat64_add_del_pool_addr_range(
1445 """Add/del address range to NAT64 pool
1447 :param start_addr: First IP address
1448 :param end_addr: Last IP address
1449 :param vrf_id: VRF id for the address range
1450 :param is_add: 1 if add, 0 if delete (Default value = 1)
1453 self.papi.nat64_add_del_pool_addr_range,
1454 {'start_addr': start_addr,
1455 'end_addr': end_addr,
1459 def nat64_pool_addr_dump(self):
1460 """Dump NAT64 pool addresses
1461 :return: Dictionary of NAT64 pool addresses
1463 return self.api(self.papi.nat64_pool_addr_dump, {})
1465 def nat64_add_del_interface(
1470 """Enable/disable NAT64 feature on the interface
1471 :param sw_if_index: Index of the interface
1472 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1473 :param is_add: 1 if add, 0 if delete (Default value = 1)
1476 self.papi.nat64_add_del_interface,
1477 {'sw_if_index': sw_if_index,
1478 'is_inside': is_inside,
1481 def nat64_interface_dump(self):
1482 """Dump interfaces with NAT64 feature
1483 :return: Dictionary of interfaces with NAT64 feature
1485 return self.api(self.papi.nat64_interface_dump, {})
1487 def nat64_add_del_static_bib(
1496 """Add/delete S-NAT static BIB entry
1498 :param in_ip: Inside IPv6 address
1499 :param out_ip: Outside IPv4 address
1500 :param in_port: Inside port number
1501 :param out_port: Outside port number
1502 :param protocol: IP protocol
1503 :param vrf_id: VRF ID (Default value = 0)
1504 :param is_add: 1 if add, 0 if delete (Default value = 1)
1507 self.papi.nat64_add_del_static_bib,
1516 def nat64_bib_dump(self, protocol=255):
1519 :param protocol: IP protocol (Default value = 255, all BIBs)
1520 :returns: Dictionary of NAT64 BIB entries
1522 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1524 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1525 tcp_incoming_syn=6):
1526 """Set values of timeouts for NAT64 (in seconds)
1528 :param udpi: UDP timeout (Default value = 300)
1529 :param icmp: ICMP timeout (Default value = 60)
1530 :param tcp_trans: TCP transitory timeout (Default value = 240)
1531 :param tcp_est: TCP established timeout (Default value = 7440)
1532 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1535 self.papi.nat64_set_timeouts,
1538 'tcp_trans': tcp_trans,
1540 'tcp_incoming_syn': tcp_incoming_syn})
1542 def nat64_get_timeouts(self):
1543 """Get values of timeouts for NAT64
1545 :return: Timeouts for NAT64 (in seconds)
1547 return self.api(self.papi.nat64_get_timeouts, {})
1549 def nat64_st_dump(self, protocol=255):
1550 """Dump NAT64 session table
1552 :param protocol: IP protocol (Default value = 255, all STs)
1553 :returns: Dictionary of NAT64 sesstion table entries
1555 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1557 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1558 """Add/del NAT64 prefix
1560 :param prefix: NAT64 prefix
1561 :param plen: NAT64 prefix length
1562 :param vrf_id: VRF id of tenant (Default 0)
1563 :param is_add: 1 if add, 0 if delete (Default value = 1)
1566 self.papi.nat64_add_del_prefix,
1572 def nat64_prefix_dump(self):
1573 """Dump NAT64 prefix
1575 :returns: Dictionary of NAT64 prefixes
1577 return self.api(self.papi.nat64_prefix_dump, {})
1579 def control_ping(self):
1580 self.api(self.papi.control_ping)
1582 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1583 detect_mult, local_addr, peer_addr, is_ipv6=0,
1584 bfd_key_id=None, conf_key_id=None):
1585 if bfd_key_id is None:
1586 return self.api(self.papi.bfd_udp_add,
1588 'sw_if_index': sw_if_index,
1589 'desired_min_tx': desired_min_tx,
1590 'required_min_rx': required_min_rx,
1591 'local_addr': local_addr,
1592 'peer_addr': peer_addr,
1594 'detect_mult': detect_mult,
1597 return self.api(self.papi.bfd_udp_add,
1599 'sw_if_index': sw_if_index,
1600 'desired_min_tx': desired_min_tx,
1601 'required_min_rx': required_min_rx,
1602 'local_addr': local_addr,
1603 'peer_addr': peer_addr,
1605 'detect_mult': detect_mult,
1606 'is_authenticated': 1,
1607 'bfd_key_id': bfd_key_id,
1608 'conf_key_id': conf_key_id,
1611 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1612 detect_mult, local_addr, peer_addr, is_ipv6=0):
1613 return self.api(self.papi.bfd_udp_mod,
1615 'sw_if_index': sw_if_index,
1616 'desired_min_tx': desired_min_tx,
1617 'required_min_rx': required_min_rx,
1618 'local_addr': local_addr,
1619 'peer_addr': peer_addr,
1621 'detect_mult': detect_mult,
1624 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1625 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1627 return self.api(self.papi.bfd_udp_auth_activate,
1629 'sw_if_index': sw_if_index,
1630 'local_addr': local_addr,
1631 'peer_addr': peer_addr,
1633 'is_delayed': 1 if is_delayed else 0,
1634 'bfd_key_id': bfd_key_id,
1635 'conf_key_id': conf_key_id,
1638 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1639 is_ipv6=0, is_delayed=False):
1640 return self.api(self.papi.bfd_udp_auth_deactivate,
1642 'sw_if_index': sw_if_index,
1643 'local_addr': local_addr,
1644 'peer_addr': peer_addr,
1646 'is_delayed': 1 if is_delayed else 0,
1649 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1650 return self.api(self.papi.bfd_udp_del,
1652 'sw_if_index': sw_if_index,
1653 'local_addr': local_addr,
1654 'peer_addr': peer_addr,
1658 def bfd_udp_session_dump(self):
1659 return self.api(self.papi.bfd_udp_session_dump, {})
1661 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1662 peer_addr, is_ipv6=0):
1663 return self.api(self.papi.bfd_udp_session_set_flags, {
1664 'admin_up_down': admin_up_down,
1665 'sw_if_index': sw_if_index,
1666 'local_addr': local_addr,
1667 'peer_addr': peer_addr,
1671 def want_bfd_events(self, enable_disable=1):
1672 return self.api(self.papi.want_bfd_events, {
1673 'enable_disable': enable_disable,
1677 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1678 return self.api(self.papi.bfd_auth_set_key, {
1679 'conf_key_id': conf_key_id,
1680 'auth_type': auth_type,
1682 'key_len': len(key),
1685 def bfd_auth_del_key(self, conf_key_id):
1686 return self.api(self.papi.bfd_auth_del_key, {
1687 'conf_key_id': conf_key_id,
1690 def bfd_auth_keys_dump(self):
1691 return self.api(self.papi.bfd_auth_keys_dump, {})
1693 def bfd_udp_set_echo_source(self, sw_if_index):
1694 return self.api(self.papi.bfd_udp_set_echo_source,
1695 {'sw_if_index': sw_if_index})
1697 def bfd_udp_del_echo_source(self):
1698 return self.api(self.papi.bfd_udp_del_echo_source, {})
1700 def classify_add_del_table(
1705 table_index=0xFFFFFFFF,
1707 memory_size=2097152,
1709 next_table_index=0xFFFFFFFF,
1710 miss_next_index=0xFFFFFFFF,
1711 current_data_flag=0,
1712 current_data_offset=0):
1716 :param match_n_vectors: (Default value = 1)
1717 :param table_index: (Default value = 0xFFFFFFFF)
1718 :param nbuckets: (Default value = 2)
1719 :param memory_size: (Default value = 2097152)
1720 :param skip_n_vectors: (Default value = 0)
1721 :param next_table_index: (Default value = 0xFFFFFFFF)
1722 :param miss_next_index: (Default value = 0xFFFFFFFF)
1723 :param current_data_flag: (Default value = 0)
1724 :param current_data_offset: (Default value = 0)
1728 self.papi.classify_add_del_table,
1730 'table_index': table_index,
1731 'nbuckets': nbuckets,
1732 'memory_size': memory_size,
1733 'skip_n_vectors': skip_n_vectors,
1734 'match_n_vectors': match_n_vectors,
1735 'next_table_index': next_table_index,
1736 'miss_next_index': miss_next_index,
1737 'current_data_flag': current_data_flag,
1738 'current_data_offset': current_data_offset,
1741 def classify_add_del_session(
1746 opaque_index=0xFFFFFFFF,
1747 hit_next_index=0xFFFFFFFF,
1755 :param opaque_index: (Default value = 0xFFFFFFFF)
1756 :param hit_next_index: (Default value = 0xFFFFFFFF)
1757 :param advance: (Default value = 0)
1758 :param action: (Default value = 0)
1759 :param metadata: (Default value = 0)
1763 self.papi.classify_add_del_session,
1765 'table_index': table_index,
1766 'hit_next_index': hit_next_index,
1767 'opaque_index': opaque_index,
1770 'metadata': metadata,
1773 def input_acl_set_interface(
1777 ip4_table_index=0xFFFFFFFF,
1778 ip6_table_index=0xFFFFFFFF,
1779 l2_table_index=0xFFFFFFFF):
1783 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1784 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1785 :param l2_table_index: (Default value = 0xFFFFFFFF)
1789 self.papi.input_acl_set_interface,
1790 {'sw_if_index': sw_if_index,
1791 'ip4_table_index': ip4_table_index,
1792 'ip6_table_index': ip6_table_index,
1793 'l2_table_index': l2_table_index,
1796 def set_ipfix_exporter(
1803 collector_port=4739,
1806 self.papi.set_ipfix_exporter,
1808 'collector_address': collector_address,
1809 'collector_port': collector_port,
1810 'src_address': src_address,
1812 'path_mtu': path_mtu,
1813 'template_interval': template_interval,
1814 'udp_checksum': udp_checksum,
1817 def dhcp_proxy_config(self,
1825 self.papi.dhcp_proxy_config,
1827 'rx_vrf_id': rx_table_id,
1828 'server_vrf_id': server_table_id,
1831 'dhcp_server': dhcp_server,
1832 'dhcp_src_address': dhcp_src_address,
1835 def dhcp_proxy_set_vss(self,
1842 self.papi.dhcp_proxy_set_vss,
1851 def dhcp_client(self,
1856 want_dhcp_events=0):
1858 self.papi.dhcp_client_config,
1860 'sw_if_index': sw_if_index,
1861 'hostname': hostname,
1862 'client_id': client_id,
1864 'want_dhcp_event': want_dhcp_events,
1868 def ip_mroute_add_del(self,
1873 next_hop_sw_if_index,
1883 self.papi.ip_mroute_add_del,
1884 {'next_hop_sw_if_index': next_hop_sw_if_index,
1885 'entry_flags': e_flags,
1886 'itf_flags': i_flags,
1887 'table_id': table_id,
1891 'is_local': is_local,
1892 'grp_address_length': grp_address_length,
1893 'grp_address': grp_address,
1894 'src_address': src_address})
1896 def mfib_signal_dump(self):
1897 return self.api(self.papi.mfib_signal_dump, {})
1899 def ip_mfib_dump(self):
1900 return self.api(self.papi.ip_mfib_dump, {})
1902 def lisp_enable_disable(self, is_enabled):
1904 self.papi.lisp_enable_disable,
1906 'is_en': is_enabled,
1909 def lisp_locator_set(self,
1913 self.papi.lisp_add_del_locator_set,
1916 'locator_set_name': ls_name
1919 def lisp_locator_set_dump(self):
1920 return self.api(self.papi.lisp_locator_set_dump, {})
1922 def lisp_locator(self,
1929 self.papi.lisp_add_del_locator,
1932 'locator_set_name': ls_name,
1933 'sw_if_index': sw_if_index,
1934 'priority': priority,
1938 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1940 self.papi.lisp_locator_dump,
1942 'is_index_set': is_index_set,
1944 'ls_index': ls_index,
1947 def lisp_local_mapping(self,
1957 self.papi.lisp_add_del_local_eid,
1959 'locator_set_name': ls_name,
1961 'eid_type': eid_type,
1963 'prefix_len': prefix_len,
1969 def lisp_eid_table_dump(self,
1977 self.papi.lisp_eid_table_dump,
1980 'prefix_length': prefix_length,
1982 'eid_type': eid_type,
1984 'filter': filter_opt,
1987 def lisp_remote_mapping(self,
1997 self.papi.lisp_add_del_remote_mapping,
2000 'eid_type': eid_type,
2002 'eid_len': eid_prefix_len,
2003 'rloc_num': rlocs_num,
2006 'is_src_dst': is_src_dst,
2009 def lisp_adjacency(self,
2018 self.papi.lisp_add_del_adjacency,
2022 'eid_type': eid_type,
2025 'leid_len': leid_len,
2026 'reid_len': reid_len,
2029 def lisp_adjacencies_get(self, vni=0):
2031 self.papi.lisp_adjacencies_get,
2036 def map_add_domain(self,
2049 self.papi.map_add_domain,
2051 'ip6_prefix': ip6_prefix,
2052 'ip6_prefix_len': ip6_prefix_len,
2053 'ip4_prefix': ip4_prefix,
2054 'ip4_prefix_len': ip4_prefix_len,
2056 'ip6_src_prefix_len': ip6_src_prefix_len,
2057 'ea_bits_len': ea_bits_len,
2058 'psid_offset': psid_offset,
2059 'psid_length': psid_length,
2060 'is_translation': is_translation,
2064 def gtpu_add_del_tunnel(
2070 mcast_sw_if_index=0xFFFFFFFF,
2072 decap_next_index=0xFFFFFFFF,
2076 :param is_add: (Default value = 1)
2077 :param is_ipv6: (Default value = 0)
2080 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2081 :param encap_vrf_id: (Default value = 0)
2082 :param decap_next_index: (Default value = 0xFFFFFFFF)
2083 :param teid: (Default value = 0)
2086 return self.api(self.papi.gtpu_add_del_tunnel,
2089 'src_address': src_addr,
2090 'dst_address': dst_addr,
2091 'mcast_sw_if_index': mcast_sw_if_index,
2092 'encap_vrf_id': encap_vrf_id,
2093 'decap_next_index': decap_next_index,
2096 def vxlan_gpe_add_del_tunnel(
2100 mcast_sw_if_index=0xFFFFFFFF,
2111 :param is_add: (Default value = 1)
2112 :param is_ipv6: (Default value = 0)
2113 :param encap_vrf_id: (Default value = 0)
2114 :param decap_vrf_id: (Default value = 0)
2115 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2116 :param protocol: (Default value = 3)
2117 :param vni: (Default value = 0)
2120 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2125 'mcast_sw_if_index': mcast_sw_if_index,
2126 'encap_vrf_id': encap_vrf_id,
2127 'decap_vrf_id': decap_vrf_id,
2128 'protocol': protocol,
2131 def pppoe_add_del_session(
2141 :param is_add: (Default value = 1)
2142 :param is_ipv6: (Default value = 0)
2144 :param session_id: (Default value = 0)
2146 :param decap_vrf_id: (Default value = 0)
2149 return self.api(self.papi.pppoe_add_del_session,
2152 'session_id': session_id,
2153 'client_ip': client_ip,
2154 'decap_vrf_id': decap_vrf_id,
2155 'client_mac': client_mac})
2157 def sr_localsid_add_del(self,
2163 sw_if_index=0xFFFFFFFF,
2167 """ Add/del IPv6 SR local-SID.
2169 :param localsid_addr:
2170 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2171 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2173 :param is_del: (Default value = 0)
2174 :param end_psp: (Default value = 0)
2175 :param sw_if_index: (Default value = 0xFFFFFFFF)
2176 :param vlan_index: (Default value = 0)
2177 :param fib_table: (Default value = 0)
2180 self.papi.sr_localsid_add_del,
2182 'localsid_addr': localsid_addr,
2184 'behavior': behavior,
2185 'sw_if_index': sw_if_index,
2186 'vlan_index': vlan_index,
2187 'fib_table': fib_table,
2202 :param bsid_addr: bindingSID of the SR Policy
2203 :param weight: weight of the sid list. optional. (default: 1)
2204 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2206 :param type: type/behavior of the SR policy. (default or spray) \
2208 :param fib_table: VRF where to install the FIB entry for the BSID \
2210 :param n_segments: number of segments \
2212 :param segments: a vector of IPv6 address composing the segment list \
2216 self.papi.sr_policy_add,
2217 {'bsid_addr': bsid_addr,
2219 'is_encap': is_encap,
2221 'fib_table': fib_table,
2222 'n_segments': n_segments,
2223 'segments': segments
2232 :param bsid: bindingSID of the SR Policy
2233 :param sr_policy_index: index of the sr policy (default: 0)
2236 self.papi.sr_policy_del,
2237 {'bsid_addr': bsid_addr,
2238 'sr_policy_index': sr_policy_index
2241 def sr_steering_add_del(
2252 Steer traffic L2 and L3 traffic through a given SR policy
2254 :param is_del: delete or add
2255 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2256 :param sr_policy: is the index of the SR Policy (alt to bsid)
2257 :param table_id: is the VRF where to install the FIB entry for the BSID
2258 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2259 :param mask_width: is the mask for L3 traffic type
2260 :param sw_if_index: is the incoming interface for L2 traffic
2261 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2264 self.papi.sr_steering_add_del,
2266 'bsid_addr': bsid_addr,
2267 'sr_policy_index': sr_policy_index,
2268 'table_id': table_id,
2269 'prefix_addr': prefix_addr,
2270 'mask_width': mask_width,
2271 'sw_if_index': sw_if_index,
2272 'traffic_type': traffic_type
2275 def macip_acl_add(self, rules, tag=""):
2278 :param rules: list of rules for given acl
2282 return self.api(self.papi.macip_acl_add,
2284 'count': len(rules),
2287 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2290 :param rules: list of rules for given acl
2294 return self.api(self.papi.macip_acl_add_replace,
2295 {'acl_index': acl_index,
2297 'count': len(rules),
2300 def macip_acl_del(self, acl_index):
2306 return self.api(self.papi.macip_acl_del,
2307 {'acl_index': acl_index})
2309 def macip_acl_interface_add_del(self,
2313 """ Add MACIP acl to interface
2317 :param is_add: (Default value = 1)
2320 return self.api(self.papi.macip_acl_interface_add_del,
2322 'sw_if_index': sw_if_index,
2323 'acl_index': acl_index})
2325 def macip_acl_interface_get(self):
2326 """ Return interface acls dump
2329 self.papi.macip_acl_interface_get, {})
2331 def macip_acl_dump(self, acl_index=4294967295):
2332 """ Return MACIP acl dump
2336 self.papi.macip_acl_dump, {'acl_index': acl_index})