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 within %ss",
107 self.test_class.logger.debug("Expecting event '%s' 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 l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
423 filter_mac=0, bvi_mac=0):
424 """Create/delete L2 FIB entry.
426 :param str mac: MAC address to create FIB entry for.
427 :param int bd_id: Bridge domain index.
428 :param int sw_if_index: Software interface index of the interface.
429 :param int is_add: Add or delete flag. (Default value = 1)
430 :param int static_mac: Set to 1 to create static MAC entry.
432 :param int filter_mac: Set to 1 to drop packet that's source or
433 destination MAC address contains defined MAC address.
435 :param int bvi_mac: Set to 1 to create entry that points to BVI
436 interface. (Default value = 0)
438 return self.api(self.papi.l2fib_add_del,
439 {'mac': self._convert_mac(mac),
441 'sw_if_index': sw_if_index,
443 'static_mac': static_mac,
444 'filter_mac': filter_mac,
447 def l2fib_flush_int(self, sw_if_index):
448 """Flush L2 FIB entries for sw_if_index.
450 :param int sw_if_index: Software interface index of the interface.
452 return self.api(self.papi.l2fib_flush_int,
453 {'sw_if_index': sw_if_index})
455 def l2fib_flush_bd(self, bd_id):
456 """Flush L2 FIB entries for bd_id.
458 :param int sw_if_index: Bridge Domain id.
460 return self.api(self.papi.l2fib_flush_bd,
463 def l2fib_flush_all(self):
466 return self.api(self.papi.l2fib_flush_all, {})
468 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
469 shg=0, bvi=0, enable=1):
470 """Add/remove interface to/from bridge domain.
472 :param int sw_if_index: Software interface index of the interface.
473 :param int bd_id: Bridge domain index.
474 :param int shg: Split-horizon group index. (Default value = 0)
475 :param int bvi: Set interface as a bridge group virtual interface.
477 :param int enable: Add or remove interface. (Default value = 1)
479 return self.api(self.papi.sw_interface_set_l2_bridge,
480 {'rx_sw_if_index': sw_if_index,
486 def bridge_flags(self, bd_id, is_set, feature_bitmap):
487 """Enable/disable required feature of the bridge domain with defined ID.
489 :param int bd_id: Bridge domain ID.
490 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
491 :param int feature_bitmap: Bitmap value of the feature to be set:
495 - uu-flood (1 << 3) or
498 return self.api(self.papi.bridge_flags,
501 'feature_bitmap': feature_bitmap})
503 def bridge_domain_dump(self, bd_id=0):
506 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
507 existing bridge domains returned)
508 :return: Dictionary of bridge domain(s) data.
510 return self.api(self.papi.bridge_domain_dump,
513 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
515 """Create or delete unidirectional cross-connect from Tx interface to
518 :param int rx_sw_if_index: Software interface index of Rx interface.
519 :param int tx_sw_if_index: Software interface index of Tx interface.
520 :param int enable: Create cross-connect if equal to 1, delete
521 cross-connect if equal to 0.
524 return self.api(self.papi.sw_interface_set_l2_xconnect,
525 {'rx_sw_if_index': rx_sw_if_index,
526 'tx_sw_if_index': tx_sw_if_index,
529 def sw_interface_set_l2_tag_rewrite(
536 """L2 interface vlan tag rewrite configure request
537 :param client_index - opaque cookie to identify the sender
538 :param context - sender context, to match reply w/ request
539 :param sw_if_index - interface the operation is applied to
540 :param vtr_op - Choose from l2_vtr_op_t enum values
541 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
542 :param tag1 - Needed for any push or translate vtr op
543 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
546 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
547 {'sw_if_index': sw_if_index,
553 def sw_interface_set_flags(self, sw_if_index, admin_up_down,
554 link_up_down=0, deleted=0):
557 :param admin_up_down:
559 :param link_up_down: (Default value = 0)
560 :param deleted: (Default value = 0)
563 return self.api(self.papi.sw_interface_set_flags,
564 {'sw_if_index': sw_if_index,
565 'admin_up_down': admin_up_down,
566 'link_up_down': link_up_down,
569 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
570 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
571 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
572 """Create subinterface
573 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
575 :param sub_id: param inner_vlan:
579 :param no_tags: (Default value = 0)
580 :param one_tag: (Default value = 0)
581 :param two_tags: (Default value = 0)
582 :param dot1ad: (Default value = 0)
583 :param exact_match: (Default value = 0)
584 :param default_sub: (Default value = 0)
585 :param outer_vlan_id_any: (Default value = 0)
586 :param inner_vlan_id_any: (Default value = 0)
590 self.papi.create_subif,
591 {'sw_if_index': sw_if_index,
595 'two_tags': two_tags,
597 'exact_match': exact_match,
598 'default_sub': default_sub,
599 'outer_vlan_id_any': outer_vlan_id_any,
600 'inner_vlan_id_any': inner_vlan_id_any,
601 'outer_vlan_id': outer_vlan,
602 'inner_vlan_id': inner_vlan})
604 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
605 """Create p2p ethernet subinterface
607 :param sw_if_index: main (parent) interface
608 :param remote_mac: client (remote) mac address
612 self.papi.p2p_ethernet_add,
613 {'parent_if_index': sw_if_index,
614 'remote_mac': remote_mac,
615 'subif_id': subif_id})
617 def delete_subif(self, sw_if_index):
618 """Delete subinterface
622 return self.api(self.papi.delete_subif,
623 {'sw_if_index': sw_if_index})
625 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
626 """Delete p2p ethernet subinterface
628 :param sw_if_index: main (parent) interface
629 :param remote_mac: client (remote) mac address
633 self.papi.p2p_ethernet_del,
634 {'parent_if_index': sw_if_index,
635 'remote_mac': remote_mac})
637 def create_vlan_subif(self, sw_if_index, vlan):
644 return self.api(self.papi.create_vlan_subif,
645 {'sw_if_index': sw_if_index,
648 def create_loopback(self, mac=''):
651 :param mac: (Optional)
653 return self.api(self.papi.create_loopback,
654 {'mac_address': mac})
656 def delete_loopback(self, sw_if_index):
657 return self.api(self.papi.delete_loopback,
658 {'sw_if_index': sw_if_index, })
660 def ip_add_del_route(
665 next_hop_sw_if_index=0xFFFFFFFF,
669 next_hop_n_out_labels=0,
670 next_hop_out_label_stack=[],
671 next_hop_via_label=MPLS_LABEL_INVALID,
672 create_vrf_if_needed=0,
674 is_resolve_attached=0,
675 classify_table_index=0xFFFFFFFF,
687 :param dst_address_length:
688 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
690 :param next_hop_address:
691 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
692 :param vrf_id: (Default value = 0)
693 :param lookup_in_vrf: (Default value = 0)
694 :param classify_table_index: (Default value = 0xFFFFFFFF)
695 :param create_vrf_if_needed: (Default value = 0)
696 :param is_add: (Default value = 1)
697 :param is_drop: (Default value = 0)
698 :param is_ipv6: (Default value = 0)
699 :param is_local: (Default value = 0)
700 :param is_classify: (Default value = 0)
701 :param is_multipath: (Default value = 0)
702 :param is_resolve_host: (Default value = 0)
703 :param is_resolve_attached: (Default value = 0)
704 :param not_last: (Default value = 0)
705 :param next_hop_weight: (Default value = 1)
710 self.papi.ip_add_del_route,
711 {'next_hop_sw_if_index': next_hop_sw_if_index,
712 'table_id': table_id,
713 'classify_table_index': classify_table_index,
714 'next_hop_table_id': next_hop_table_id,
715 'create_vrf_if_needed': create_vrf_if_needed,
718 'is_unreach': is_unreach,
719 'is_prohibit': is_prohibit,
721 'is_local': is_local,
722 'is_classify': is_classify,
723 'is_multipath': is_multipath,
724 'is_resolve_host': is_resolve_host,
725 'is_resolve_attached': is_resolve_attached,
726 'not_last': not_last,
727 'next_hop_weight': next_hop_weight,
728 'dst_address_length': dst_address_length,
729 'dst_address': dst_address,
730 'next_hop_address': next_hop_address,
731 'next_hop_n_out_labels': next_hop_n_out_labels,
732 'next_hop_via_label': next_hop_via_label,
733 'next_hop_out_label_stack': next_hop_out_label_stack})
735 def ip_fib_dump(self):
736 return self.api(self.papi.ip_fib_dump, {})
738 def ip6_fib_dump(self):
739 return self.api(self.papi.ip6_fib_dump, {})
741 def ip_neighbor_add_del(self,
750 """ Add neighbor MAC to IPv4 or IPv6 address.
755 :param is_add: (Default value = 1)
756 :param is_ipv6: (Default value = 0)
757 :param is_static: (Default value = 0)
758 :param is_no_adj_fib: (Default value = 0)
762 self.papi.ip_neighbor_add_del,
763 {'sw_if_index': sw_if_index,
766 'is_static': is_static,
767 'is_no_adj_fib': is_no_adj_fib,
768 'mac_address': mac_address,
769 'dst_address': dst_address
773 def ip_neighbor_dump(self,
776 """ Return IP neighbor dump.
779 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
783 self.papi.ip_neighbor_dump,
785 'sw_if_index': sw_if_index
789 def proxy_arp_add_del(self,
794 """ Config Proxy Arp Range.
796 :param low_address: Start address in the rnage to Proxy for
797 :param hi_address: End address in the rnage to Proxy for
798 :param vrf_id: The VRF/table in which to proxy
802 self.papi.proxy_arp_add_del,
805 'low_address': low_address,
806 'hi_address': hi_address,
810 def proxy_arp_intfc_enable_disable(self,
813 """ Enable/Disable an interface for proxy ARP requests
815 :param sw_if_index: Interface
816 :param enable_disable: Enable/Disable
820 self.papi.proxy_arp_intfc_enable_disable,
821 {'sw_if_index': sw_if_index,
822 'enable_disable': is_enable
830 """ Reset VRF (remove all routes etc.) request.
832 :param int vrf_id: ID of the FIB table / VRF to reset.
833 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
847 """ Reset VRF (remove all routes etc.) request.
849 :param int vrf_id: ID of the FIB table / VRF to reset.
850 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
865 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
874 def sw_interface_span_enable_disable(
875 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
878 :param sw_if_index_from:
879 :param sw_if_index_to:
883 return self.api(self.papi.sw_interface_span_enable_disable,
884 {'sw_if_index_from': sw_if_index_from,
885 'sw_if_index_to': sw_if_index_to,
890 def gre_tunnel_add_del(self,
901 :param outer_fib_id: (Default value = 0)
902 :param is_add: (Default value = 1)
903 :param is_ipv6: (Default value = 0)
904 :param is_teb: (Default value = 0)
908 self.papi.gre_add_del_tunnel,
912 'src_address': src_address,
913 'dst_address': dst_address,
914 'outer_fib_id': outer_fib_id}
917 def mpls_fib_dump(self):
918 return self.api(self.papi.mpls_fib_dump, {})
920 def mpls_route_add_del(
924 next_hop_proto_is_ip4,
926 next_hop_sw_if_index=0xFFFFFFFF,
930 next_hop_n_out_labels=0,
931 next_hop_out_label_stack=[],
932 next_hop_via_label=MPLS_LABEL_INVALID,
933 create_vrf_if_needed=0,
935 is_resolve_attached=0,
942 classify_table_index=0xFFFFFFFF,
947 :param dst_address_length:
948 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
950 :param next_hop_address:
951 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
952 :param vrf_id: (Default value = 0)
953 :param lookup_in_vrf: (Default value = 0)
954 :param classify_table_index: (Default value = 0xFFFFFFFF)
955 :param create_vrf_if_needed: (Default value = 0)
956 :param is_add: (Default value = 1)
957 :param is_drop: (Default value = 0)
958 :param is_ipv6: (Default value = 0)
959 :param is_local: (Default value = 0)
960 :param is_classify: (Default value = 0)
961 :param is_multipath: (Default value = 0)
962 :param is_multicast: (Default value = 0)
963 :param is_resolve_host: (Default value = 0)
964 :param is_resolve_attached: (Default value = 0)
965 :param not_last: (Default value = 0)
966 :param next_hop_weight: (Default value = 1)
971 self.papi.mpls_route_add_del,
974 'mr_table_id': table_id,
975 'mr_classify_table_index': classify_table_index,
976 'mr_create_table_if_needed': create_vrf_if_needed,
978 'mr_is_classify': is_classify,
979 'mr_is_multipath': is_multipath,
980 'mr_is_multicast': is_multicast,
981 'mr_is_resolve_host': is_resolve_host,
982 'mr_is_resolve_attached': is_resolve_attached,
983 'mr_is_interface_rx': is_interface_rx,
984 'mr_is_rpf_id': is_rpf_id,
985 'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
986 'mr_next_hop_weight': next_hop_weight,
987 'mr_next_hop': next_hop_address,
988 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
989 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
990 'mr_next_hop_table_id': next_hop_table_id,
991 'mr_next_hop_via_label': next_hop_via_label,
992 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
994 def mpls_ip_bind_unbind(
1002 create_vrf_if_needed=0,
1007 self.papi.mpls_ip_bind_unbind,
1008 {'mb_mpls_table_id': table_id,
1010 'mb_ip_table_id': ip_table_id,
1011 'mb_create_table_if_needed': create_vrf_if_needed,
1012 'mb_is_bind': is_bind,
1013 'mb_is_ip4': is_ip4,
1014 'mb_address_length': dst_address_length,
1015 'mb_address': dst_address})
1017 def mpls_tunnel_add_del(
1020 next_hop_proto_is_ip4,
1022 next_hop_sw_if_index=0xFFFFFFFF,
1023 next_hop_table_id=0,
1025 next_hop_n_out_labels=0,
1026 next_hop_out_label_stack=[],
1027 next_hop_via_label=MPLS_LABEL_INVALID,
1028 create_vrf_if_needed=0,
1034 :param dst_address_length:
1035 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1037 :param next_hop_address:
1038 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1039 :param vrf_id: (Default value = 0)
1040 :param lookup_in_vrf: (Default value = 0)
1041 :param classify_table_index: (Default value = 0xFFFFFFFF)
1042 :param create_vrf_if_needed: (Default value = 0)
1043 :param is_add: (Default value = 1)
1044 :param is_drop: (Default value = 0)
1045 :param is_ipv6: (Default value = 0)
1046 :param is_local: (Default value = 0)
1047 :param is_classify: (Default value = 0)
1048 :param is_multipath: (Default value = 0)
1049 :param is_resolve_host: (Default value = 0)
1050 :param is_resolve_attached: (Default value = 0)
1051 :param next_hop_weight: (Default value = 1)
1052 :param is_multicast: (Default value = 0)
1056 self.papi.mpls_tunnel_add_del,
1057 {'mt_sw_if_index': tun_sw_if_index,
1058 'mt_is_add': is_add,
1059 'mt_l2_only': l2_only,
1060 'mt_is_multicast': is_multicast,
1061 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1062 'mt_next_hop_weight': next_hop_weight,
1063 'mt_next_hop': next_hop_address,
1064 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1065 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1066 'mt_next_hop_table_id': next_hop_table_id,
1067 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1069 def snat_interface_add_del_feature(
1074 """Enable/disable S-NAT feature on the interface
1076 :param sw_if_index: Software index of the interface
1077 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1078 :param is_add: 1 if add, 0 if delete (Default value = 1)
1081 self.papi.snat_interface_add_del_feature,
1083 'is_inside': is_inside,
1084 'sw_if_index': sw_if_index})
1086 def snat_interface_add_del_output_feature(
1091 """Enable/disable S-NAT output feature on the interface
1093 :param sw_if_index: Software index of the interface
1094 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1095 :param is_add: 1 if add, 0 if delete (Default value = 1)
1098 self.papi.snat_interface_add_del_output_feature,
1100 'is_inside': is_inside,
1101 'sw_if_index': sw_if_index})
1103 def snat_add_static_mapping(
1107 external_sw_if_index=0xFFFFFFFF,
1115 """Add/delete S-NAT static mapping
1117 :param local_ip: Local IP address
1118 :param external_ip: External IP address
1119 :param external_sw_if_index: External interface instead of IP address
1120 :param local_port: Local port number (Default value = 0)
1121 :param external_port: External port number (Default value = 0)
1122 :param addr_only: 1 if address only mapping, 0 if address and port
1123 :param vrf_id: VRF ID
1124 :param protocol: IP protocol (Default value = 0)
1125 :param is_add: 1 if add, 0 if delete (Default value = 1)
1126 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1129 self.papi.snat_add_static_mapping,
1132 'addr_only': addr_only,
1133 'local_ip_address': local_ip,
1134 'external_ip_address': external_ip,
1135 'local_port': local_port,
1136 'external_port': external_port,
1137 'external_sw_if_index': external_sw_if_index,
1139 'protocol': protocol})
1141 def snat_add_address_range(
1148 """Add/del S-NAT address range
1150 :param first_ip_address: First IP address
1151 :param last_ip_address: Last IP address
1152 :param vrf_id: VRF id for the address range
1153 :param is_add: 1 if add, 0 if delete (Default value = 1)
1154 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1157 self.papi.snat_add_address_range,
1159 'first_ip_address': first_ip_address,
1160 'last_ip_address': last_ip_address,
1164 def snat_address_dump(self):
1165 """Dump S-NAT addresses
1166 :return: Dictionary of S-NAT addresses
1168 return self.api(self.papi.snat_address_dump, {})
1170 def snat_interface_dump(self):
1171 """Dump interfaces with S-NAT feature
1172 :return: Dictionary of interfaces with S-NAT feature
1174 return self.api(self.papi.snat_interface_dump, {})
1176 def snat_interface_output_feature_dump(self):
1177 """Dump interfaces with S-NAT output feature
1178 :return: Dictionary of interfaces with S-NAT output feature
1180 return self.api(self.papi.snat_interface_output_feature_dump, {})
1182 def snat_static_mapping_dump(self):
1183 """Dump S-NAT static mappings
1184 :return: Dictionary of S-NAT static mappings
1186 return self.api(self.papi.snat_static_mapping_dump, {})
1188 def snat_show_config(self):
1189 """Show S-NAT config
1190 :return: S-NAT config parameters
1192 return self.api(self.papi.snat_show_config, {})
1194 def snat_add_interface_addr(
1198 """Add/del S-NAT address from interface
1200 :param sw_if_index: Software index of the interface
1201 :param is_add: 1 if add, 0 if delete (Default value = 1)
1203 return self.api(self.papi.snat_add_del_interface_addr,
1204 {'is_add': is_add, 'sw_if_index': sw_if_index})
1206 def snat_interface_addr_dump(self):
1207 """Dump S-NAT addresses interfaces
1208 :return: Dictionary of S-NAT addresses interfaces
1210 return self.api(self.papi.snat_interface_addr_dump, {})
1217 """Enable/disable S-NAT IPFIX logging
1219 :param domain_id: Observation domain ID (Default value = 1)
1220 :param src_port: Source port number (Default value = 4739)
1221 :param enable: 1 if enable, 0 if disable (Default value = 1)
1224 self.papi.snat_ipfix_enable_disable,
1225 {'domain_id': domain_id,
1226 'src_port': src_port,
1229 def snat_user_session_dump(
1234 """Dump S-NAT user's sessions
1236 :param ip_address: ip adress of the user to be dumped
1237 :param cpu_index: cpu_index on which the user is
1238 :param vrf_id: VRF ID
1239 :return: Dictionary of S-NAT sessions
1242 self.papi.snat_user_session_dump,
1243 {'ip_address': ip_address,
1247 def snat_user_dump(self):
1250 :return: Dictionary of S-NAT users
1252 return self.api(self.papi.snat_user_dump, {})
1254 def snat_add_det_map(
1261 """Add/delete S-NAT deterministic mapping
1263 :param is_add - 1 if add, 0 if delete
1264 :param in_addr - inside IP address
1265 :param in_plen - inside IP address prefix length
1266 :param out_addr - outside IP address
1267 :param out_plen - outside IP address prefix length
1270 self.papi.snat_add_det_map,
1274 'out_addr': out_addr,
1275 'out_plen': out_plen})
1277 def snat_det_forward(
1280 """Get outside address and port range from inside address
1282 :param in_addr - inside IP address
1285 self.papi.snat_det_forward,
1286 {'in_addr': in_addr})
1288 def snat_det_reverse(
1292 """Get inside address from outside address and port
1294 :param out_addr - outside IP address
1295 :param out_port - outside port
1298 self.papi.snat_det_reverse,
1299 {'out_addr': out_addr,
1300 'out_port': out_port})
1302 def snat_det_map_dump(self):
1303 """Dump S-NAT deterministic mappings
1305 :return: Dictionary of S-NAT deterministic mappings
1307 return self.api(self.papi.snat_det_map_dump, {})
1309 def snat_det_set_timeouts(
1312 tcp_established=7440,
1315 """Set values of timeouts for deterministic NAT (in seconds)
1317 :param udp - UDP timeout (Default value = 300)
1318 :param tcp_established - TCP established timeout (Default value = 7440)
1319 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1320 :param icmp - ICMP timeout (Default value = 60)
1323 self.papi.snat_det_set_timeouts,
1325 'tcp_established': tcp_established,
1326 'tcp_transitory': tcp_transitory,
1329 def snat_det_get_timeouts(self):
1330 """Get values of timeouts for deterministic NAT
1332 :return: Timeouts for deterministic NAT (in seconds)
1334 return self.api(self.papi.snat_det_get_timeouts, {})
1336 def snat_det_close_session_out(
1343 """Close CGN session using outside address and port
1345 :param out_addr - outside IP address
1346 :param out_port - outside port
1347 :param ext_addr - external host IP address
1348 :param ext_port - external host port
1349 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1352 self.papi.snat_det_close_session_out,
1353 {'out_addr': out_addr,
1354 'out_port': out_port,
1355 'ext_addr': ext_addr,
1356 'ext_port': ext_port,
1359 def snat_det_close_session_in(
1366 """Close CGN session using inside address and port
1368 :param in_addr - inside IP address
1369 :param in_port - inside port
1370 :param ext_addr - external host IP address
1371 :param ext_port - external host port
1372 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1375 self.papi.snat_det_close_session_in,
1376 {'in_addr': in_addr,
1378 'ext_addr': ext_addr,
1379 'ext_port': ext_port,
1382 def snat_det_session_dump(
1386 """Dump S-NAT deterministic sessions belonging to a user
1388 :param user_addr - inside IP address of the user
1389 :param is_ip4: - 1 if address type is IPv4 (Default value = 1)
1390 :return: Dictionary of S-NAT deterministic sessions
1393 self.papi.snat_det_session_dump,
1395 'user_addr': user_addr})
1397 def nat64_add_del_pool_addr_range(
1403 """Add/del address range to NAT64 pool
1405 :param start_addr: First IP address
1406 :param end_addr: Last IP address
1407 :param vrf_id: VRF id for the address range
1408 :param is_add: 1 if add, 0 if delete (Default value = 1)
1411 self.papi.nat64_add_del_pool_addr_range,
1412 {'start_addr': start_addr,
1413 'end_addr': end_addr,
1417 def nat64_pool_addr_dump(self):
1418 """Dump NAT64 pool addresses
1419 :return: Dictionary of NAT64 pool addresses
1421 return self.api(self.papi.nat64_pool_addr_dump, {})
1423 def nat64_add_del_interface(
1428 """Enable/disable NAT64 feature on the interface
1429 :param sw_if_index: Index of the interface
1430 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1431 :param is_add: 1 if add, 0 if delete (Default value = 1)
1434 self.papi.nat64_add_del_interface,
1435 {'sw_if_index': sw_if_index,
1436 'is_inside': is_inside,
1439 def nat64_interface_dump(self):
1440 """Dump interfaces with NAT64 feature
1441 :return: Dictionary of interfaces with NAT64 feature
1443 return self.api(self.papi.nat64_interface_dump, {})
1445 def nat64_add_del_static_bib(
1454 """Add/delete S-NAT static BIB entry
1456 :param in_ip: Inside IPv6 address
1457 :param out_ip: Outside IPv4 address
1458 :param in_port: Inside port number
1459 :param out_port: Outside port number
1460 :param protocol: IP protocol
1461 :param vrf_id: VRF ID (Default value = 0)
1462 :param is_add: 1 if add, 0 if delete (Default value = 1)
1465 self.papi.nat64_add_del_static_bib,
1474 def nat64_bib_dump(self, protocol):
1477 :param protocol: IP protocol
1478 :returns: Dictionary of NAT64 BIB entries
1480 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1482 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1483 tcp_incoming_syn=6):
1484 """Set values of timeouts for NAT64 (in seconds)
1486 :param udpi: UDP timeout (Default value = 300)
1487 :param icmp: ICMP timeout (Default value = 60)
1488 :param tcp_trans: TCP transitory timeout (Default value = 240)
1489 :param tcp_est: TCP established timeout (Default value = 7440)
1490 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1493 self.papi.nat64_set_timeouts,
1496 'tcp_trans': tcp_trans,
1498 'tcp_incoming_syn': tcp_incoming_syn})
1500 def nat64_get_timeouts(self):
1501 """Get values of timeouts for NAT64
1503 :return: Timeouts for NAT64 (in seconds)
1505 return self.api(self.papi.nat64_get_timeouts, {})
1507 def nat64_st_dump(self, protocol):
1508 """Dump NAT64 session table
1510 :param protocol: IP protocol
1511 :returns: Dictionary of NAT64 sesstion table entries
1513 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1515 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1516 """Add/del NAT64 prefix
1518 :param prefix: NAT64 prefix
1519 :param plen: NAT64 prefix length
1520 :param vrf_id: VRF id of tenant (Default 0)
1521 :param is_add: 1 if add, 0 if delete (Default value = 1)
1524 self.papi.nat64_add_del_prefix,
1530 def nat64_prefix_dump(self):
1531 """Dump NAT64 prefix
1533 :returns: Dictionary of NAT64 prefixes
1535 return self.api(self.papi.nat64_prefix_dump, {})
1537 def control_ping(self):
1538 self.api(self.papi.control_ping)
1540 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1541 detect_mult, local_addr, peer_addr, is_ipv6=0,
1542 bfd_key_id=None, conf_key_id=None):
1543 if bfd_key_id is None:
1544 return self.api(self.papi.bfd_udp_add,
1546 'sw_if_index': sw_if_index,
1547 'desired_min_tx': desired_min_tx,
1548 'required_min_rx': required_min_rx,
1549 'local_addr': local_addr,
1550 'peer_addr': peer_addr,
1552 'detect_mult': detect_mult,
1555 return self.api(self.papi.bfd_udp_add,
1557 'sw_if_index': sw_if_index,
1558 'desired_min_tx': desired_min_tx,
1559 'required_min_rx': required_min_rx,
1560 'local_addr': local_addr,
1561 'peer_addr': peer_addr,
1563 'detect_mult': detect_mult,
1564 'is_authenticated': 1,
1565 'bfd_key_id': bfd_key_id,
1566 'conf_key_id': conf_key_id,
1569 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1570 detect_mult, local_addr, peer_addr, is_ipv6=0):
1571 return self.api(self.papi.bfd_udp_mod,
1573 'sw_if_index': sw_if_index,
1574 'desired_min_tx': desired_min_tx,
1575 'required_min_rx': required_min_rx,
1576 'local_addr': local_addr,
1577 'peer_addr': peer_addr,
1579 'detect_mult': detect_mult,
1582 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1583 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1585 return self.api(self.papi.bfd_udp_auth_activate,
1587 'sw_if_index': sw_if_index,
1588 'local_addr': local_addr,
1589 'peer_addr': peer_addr,
1591 'is_delayed': 1 if is_delayed else 0,
1592 'bfd_key_id': bfd_key_id,
1593 'conf_key_id': conf_key_id,
1596 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1597 is_ipv6=0, is_delayed=False):
1598 return self.api(self.papi.bfd_udp_auth_deactivate,
1600 'sw_if_index': sw_if_index,
1601 'local_addr': local_addr,
1602 'peer_addr': peer_addr,
1604 'is_delayed': 1 if is_delayed else 0,
1607 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1608 return self.api(self.papi.bfd_udp_del,
1610 'sw_if_index': sw_if_index,
1611 'local_addr': local_addr,
1612 'peer_addr': peer_addr,
1616 def bfd_udp_session_dump(self):
1617 return self.api(self.papi.bfd_udp_session_dump, {})
1619 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1620 peer_addr, is_ipv6=0):
1621 return self.api(self.papi.bfd_udp_session_set_flags, {
1622 'admin_up_down': admin_up_down,
1623 'sw_if_index': sw_if_index,
1624 'local_addr': local_addr,
1625 'peer_addr': peer_addr,
1629 def want_bfd_events(self, enable_disable=1):
1630 return self.api(self.papi.want_bfd_events, {
1631 'enable_disable': enable_disable,
1635 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1636 return self.api(self.papi.bfd_auth_set_key, {
1637 'conf_key_id': conf_key_id,
1638 'auth_type': auth_type,
1640 'key_len': len(key),
1643 def bfd_auth_del_key(self, conf_key_id):
1644 return self.api(self.papi.bfd_auth_del_key, {
1645 'conf_key_id': conf_key_id,
1648 def bfd_auth_keys_dump(self):
1649 return self.api(self.papi.bfd_auth_keys_dump, {})
1651 def bfd_udp_set_echo_source(self, sw_if_index):
1652 return self.api(self.papi.bfd_udp_set_echo_source,
1653 {'sw_if_index': sw_if_index})
1655 def bfd_udp_del_echo_source(self):
1656 return self.api(self.papi.bfd_udp_del_echo_source, {})
1658 def classify_add_del_table(
1663 table_index=0xFFFFFFFF,
1665 memory_size=2097152,
1667 next_table_index=0xFFFFFFFF,
1668 miss_next_index=0xFFFFFFFF,
1669 current_data_flag=0,
1670 current_data_offset=0):
1674 :param match_n_vectors: (Default value = 1)
1675 :param table_index: (Default value = 0xFFFFFFFF)
1676 :param nbuckets: (Default value = 2)
1677 :param memory_size: (Default value = 2097152)
1678 :param skip_n_vectors: (Default value = 0)
1679 :param next_table_index: (Default value = 0xFFFFFFFF)
1680 :param miss_next_index: (Default value = 0xFFFFFFFF)
1681 :param current_data_flag: (Default value = 0)
1682 :param current_data_offset: (Default value = 0)
1686 self.papi.classify_add_del_table,
1688 'table_index': table_index,
1689 'nbuckets': nbuckets,
1690 'memory_size': memory_size,
1691 'skip_n_vectors': skip_n_vectors,
1692 'match_n_vectors': match_n_vectors,
1693 'next_table_index': next_table_index,
1694 'miss_next_index': miss_next_index,
1695 'current_data_flag': current_data_flag,
1696 'current_data_offset': current_data_offset,
1699 def classify_add_del_session(
1704 opaque_index=0xFFFFFFFF,
1705 hit_next_index=0xFFFFFFFF,
1713 :param opaque_index: (Default value = 0xFFFFFFFF)
1714 :param hit_next_index: (Default value = 0xFFFFFFFF)
1715 :param advance: (Default value = 0)
1716 :param action: (Default value = 0)
1717 :param metadata: (Default value = 0)
1721 self.papi.classify_add_del_session,
1723 'table_index': table_index,
1724 'hit_next_index': hit_next_index,
1725 'opaque_index': opaque_index,
1728 'metadata': metadata,
1731 def input_acl_set_interface(
1735 ip4_table_index=0xFFFFFFFF,
1736 ip6_table_index=0xFFFFFFFF,
1737 l2_table_index=0xFFFFFFFF):
1741 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1742 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1743 :param l2_table_index: (Default value = 0xFFFFFFFF)
1747 self.papi.input_acl_set_interface,
1748 {'sw_if_index': sw_if_index,
1749 'ip4_table_index': ip4_table_index,
1750 'ip6_table_index': ip6_table_index,
1751 'l2_table_index': l2_table_index,
1754 def set_ipfix_exporter(
1761 collector_port=4739,
1764 self.papi.set_ipfix_exporter,
1766 'collector_address': collector_address,
1767 'collector_port': collector_port,
1768 'src_address': src_address,
1770 'path_mtu': path_mtu,
1771 'template_interval': template_interval,
1772 'udp_checksum': udp_checksum,
1775 def dhcp_proxy_config(self,
1783 self.papi.dhcp_proxy_config,
1785 'rx_vrf_id': rx_table_id,
1786 'server_vrf_id': server_table_id,
1789 'dhcp_server': dhcp_server,
1790 'dhcp_src_address': dhcp_src_address,
1793 def dhcp_proxy_set_vss(self,
1800 self.papi.dhcp_proxy_set_vss,
1809 def dhcp_client(self,
1814 want_dhcp_events=0):
1816 self.papi.dhcp_client_config,
1818 'sw_if_index': sw_if_index,
1819 'hostname': hostname,
1820 'client_id': client_id,
1822 'want_dhcp_event': want_dhcp_events,
1826 def ip_mroute_add_del(self,
1831 next_hop_sw_if_index,
1835 create_vrf_if_needed=0,
1842 self.papi.ip_mroute_add_del,
1843 {'next_hop_sw_if_index': next_hop_sw_if_index,
1844 'entry_flags': e_flags,
1845 'itf_flags': i_flags,
1846 'table_id': table_id,
1848 'create_vrf_if_needed': create_vrf_if_needed,
1851 'is_local': is_local,
1852 'grp_address_length': grp_address_length,
1853 'grp_address': grp_address,
1854 'src_address': src_address})
1856 def mfib_signal_dump(self):
1857 return self.api(self.papi.mfib_signal_dump, {})
1859 def ip_mfib_dump(self):
1860 return self.api(self.papi.ip_mfib_dump, {})
1862 def lisp_enable_disable(self, is_enabled):
1864 self.papi.lisp_enable_disable,
1866 'is_en': is_enabled,
1869 def lisp_locator_set(self,
1873 self.papi.lisp_add_del_locator_set,
1876 'locator_set_name': ls_name
1879 def lisp_locator_set_dump(self):
1880 return self.api(self.papi.lisp_locator_set_dump, {})
1882 def lisp_locator(self,
1889 self.papi.lisp_add_del_locator,
1892 'locator_set_name': ls_name,
1893 'sw_if_index': sw_if_index,
1894 'priority': priority,
1898 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1900 self.papi.lisp_locator_dump,
1902 'is_index_set': is_index_set,
1904 'ls_index': ls_index,
1907 def lisp_local_mapping(self,
1917 self.papi.lisp_add_del_local_eid,
1919 'locator_set_name': ls_name,
1921 'eid_type': eid_type,
1923 'prefix_len': prefix_len,
1929 def lisp_eid_table_dump(self,
1937 self.papi.lisp_eid_table_dump,
1940 'prefix_length': prefix_length,
1942 'eid_type': eid_type,
1944 'filter': filter_opt,
1947 def lisp_remote_mapping(self,
1957 self.papi.lisp_add_del_remote_mapping,
1960 'eid_type': eid_type,
1962 'eid_len': eid_prefix_len,
1963 'rloc_num': rlocs_num,
1966 'is_src_dst': is_src_dst,
1969 def lisp_adjacency(self,
1978 self.papi.lisp_add_del_adjacency,
1982 'eid_type': eid_type,
1985 'leid_len': leid_len,
1986 'reid_len': reid_len,
1989 def lisp_adjacencies_get(self, vni=0):
1991 self.papi.lisp_adjacencies_get,
1996 def map_add_domain(self,
2009 self.papi.map_add_domain,
2011 'ip6_prefix': ip6_prefix,
2012 'ip6_prefix_len': ip6_prefix_len,
2013 'ip4_prefix': ip4_prefix,
2014 'ip4_prefix_len': ip4_prefix_len,
2016 'ip6_src_prefix_len': ip6_src_prefix_len,
2017 'ea_bits_len': ea_bits_len,
2018 'psid_offset': psid_offset,
2019 'psid_length': psid_length,
2020 'is_translation': is_translation,
2024 def gtpu_add_del_tunnel(
2030 mcast_sw_if_index=0xFFFFFFFF,
2032 decap_next_index=0xFFFFFFFF,
2036 :param is_add: (Default value = 1)
2037 :param is_ipv6: (Default value = 0)
2040 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2041 :param encap_vrf_id: (Default value = 0)
2042 :param decap_next_index: (Default value = 0xFFFFFFFF)
2043 :param teid: (Default value = 0)
2046 return self.api(self.papi.gtpu_add_del_tunnel,
2049 'src_address': src_addr,
2050 'dst_address': dst_addr,
2051 'mcast_sw_if_index': mcast_sw_if_index,
2052 'encap_vrf_id': encap_vrf_id,
2053 'decap_next_index': decap_next_index,
2056 def vxlan_gpe_add_del_tunnel(
2060 mcast_sw_if_index=0xFFFFFFFF,
2071 :param is_add: (Default value = 1)
2072 :param is_ipv6: (Default value = 0)
2073 :param encap_vrf_id: (Default value = 0)
2074 :param decap_vrf_id: (Default value = 0)
2075 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2076 :param protocol: (Default value = 3)
2077 :param vni: (Default value = 0)
2080 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2085 'mcast_sw_if_index': mcast_sw_if_index,
2086 'encap_vrf_id': encap_vrf_id,
2087 'decap_vrf_id': decap_vrf_id,
2088 'protocol': protocol,