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 delete_subif(self, sw_if_index):
605 """Delete subinterface
609 return self.api(self.papi.delete_subif,
610 {'sw_if_index': sw_if_index})
612 def create_vlan_subif(self, sw_if_index, vlan):
619 return self.api(self.papi.create_vlan_subif,
620 {'sw_if_index': sw_if_index,
623 def create_loopback(self, mac=''):
626 :param mac: (Optional)
628 return self.api(self.papi.create_loopback,
629 {'mac_address': mac})
631 def delete_loopback(self, sw_if_index):
632 return self.api(self.papi.delete_loopback,
633 {'sw_if_index': sw_if_index, })
635 def ip_add_del_route(
640 next_hop_sw_if_index=0xFFFFFFFF,
644 next_hop_n_out_labels=0,
645 next_hop_out_label_stack=[],
646 next_hop_via_label=MPLS_LABEL_INVALID,
647 create_vrf_if_needed=0,
649 is_resolve_attached=0,
650 classify_table_index=0xFFFFFFFF,
662 :param dst_address_length:
663 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
665 :param next_hop_address:
666 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
667 :param vrf_id: (Default value = 0)
668 :param lookup_in_vrf: (Default value = 0)
669 :param classify_table_index: (Default value = 0xFFFFFFFF)
670 :param create_vrf_if_needed: (Default value = 0)
671 :param is_add: (Default value = 1)
672 :param is_drop: (Default value = 0)
673 :param is_ipv6: (Default value = 0)
674 :param is_local: (Default value = 0)
675 :param is_classify: (Default value = 0)
676 :param is_multipath: (Default value = 0)
677 :param is_resolve_host: (Default value = 0)
678 :param is_resolve_attached: (Default value = 0)
679 :param not_last: (Default value = 0)
680 :param next_hop_weight: (Default value = 1)
685 self.papi.ip_add_del_route,
686 {'next_hop_sw_if_index': next_hop_sw_if_index,
687 'table_id': table_id,
688 'classify_table_index': classify_table_index,
689 'next_hop_table_id': next_hop_table_id,
690 'create_vrf_if_needed': create_vrf_if_needed,
693 'is_unreach': is_unreach,
694 'is_prohibit': is_prohibit,
696 'is_local': is_local,
697 'is_classify': is_classify,
698 'is_multipath': is_multipath,
699 'is_resolve_host': is_resolve_host,
700 'is_resolve_attached': is_resolve_attached,
701 'not_last': not_last,
702 'next_hop_weight': next_hop_weight,
703 'dst_address_length': dst_address_length,
704 'dst_address': dst_address,
705 'next_hop_address': next_hop_address,
706 'next_hop_n_out_labels': next_hop_n_out_labels,
707 'next_hop_via_label': next_hop_via_label,
708 'next_hop_out_label_stack': next_hop_out_label_stack})
710 def ip_fib_dump(self):
711 return self.api(self.papi.ip_fib_dump, {})
713 def ip6_fib_dump(self):
714 return self.api(self.papi.ip6_fib_dump, {})
716 def ip_neighbor_add_del(self,
725 """ Add neighbor MAC to IPv4 or IPv6 address.
730 :param is_add: (Default value = 1)
731 :param is_ipv6: (Default value = 0)
732 :param is_static: (Default value = 0)
733 :param is_no_adj_fib: (Default value = 0)
737 self.papi.ip_neighbor_add_del,
738 {'sw_if_index': sw_if_index,
741 'is_static': is_static,
742 'is_no_adj_fib': is_no_adj_fib,
743 'mac_address': mac_address,
744 'dst_address': dst_address
748 def ip_neighbor_dump(self,
751 """ Return IP neighbor dump.
754 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
758 self.papi.ip_neighbor_dump,
760 'sw_if_index': sw_if_index
764 def proxy_arp_add_del(self,
769 """ Config Proxy Arp Range.
771 :param low_address: Start address in the rnage to Proxy for
772 :param hi_address: End address in the rnage to Proxy for
773 :param vrf_id: The VRF/table in which to proxy
777 self.papi.proxy_arp_add_del,
780 'low_address': low_address,
781 'hi_address': hi_address,
785 def proxy_arp_intfc_enable_disable(self,
788 """ Enable/Disable an interface for proxy ARP requests
790 :param sw_if_index: Interface
791 :param enable_disable: Enable/Disable
795 self.papi.proxy_arp_intfc_enable_disable,
796 {'sw_if_index': sw_if_index,
797 'enable_disable': is_enable
805 """ Reset VRF (remove all routes etc.) request.
807 :param int vrf_id: ID of the FIB table / VRF to reset.
808 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
822 """ Reset VRF (remove all routes etc.) request.
824 :param int vrf_id: ID of the FIB table / VRF to reset.
825 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
840 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
849 def sw_interface_span_enable_disable(
850 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
853 :param sw_if_index_from:
854 :param sw_if_index_to:
858 return self.api(self.papi.sw_interface_span_enable_disable,
859 {'sw_if_index_from': sw_if_index_from,
860 'sw_if_index_to': sw_if_index_to,
865 def gre_tunnel_add_del(self,
876 :param outer_fib_id: (Default value = 0)
877 :param is_add: (Default value = 1)
878 :param is_ipv6: (Default value = 0)
879 :param is_teb: (Default value = 0)
883 self.papi.gre_add_del_tunnel,
887 'src_address': src_address,
888 'dst_address': dst_address,
889 'outer_fib_id': outer_fib_id}
892 def mpls_fib_dump(self):
893 return self.api(self.papi.mpls_fib_dump, {})
895 def mpls_route_add_del(
899 next_hop_proto_is_ip4,
901 next_hop_sw_if_index=0xFFFFFFFF,
905 next_hop_n_out_labels=0,
906 next_hop_out_label_stack=[],
907 next_hop_via_label=MPLS_LABEL_INVALID,
908 create_vrf_if_needed=0,
910 is_resolve_attached=0,
917 classify_table_index=0xFFFFFFFF,
922 :param dst_address_length:
923 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
925 :param next_hop_address:
926 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
927 :param vrf_id: (Default value = 0)
928 :param lookup_in_vrf: (Default value = 0)
929 :param classify_table_index: (Default value = 0xFFFFFFFF)
930 :param create_vrf_if_needed: (Default value = 0)
931 :param is_add: (Default value = 1)
932 :param is_drop: (Default value = 0)
933 :param is_ipv6: (Default value = 0)
934 :param is_local: (Default value = 0)
935 :param is_classify: (Default value = 0)
936 :param is_multipath: (Default value = 0)
937 :param is_multicast: (Default value = 0)
938 :param is_resolve_host: (Default value = 0)
939 :param is_resolve_attached: (Default value = 0)
940 :param not_last: (Default value = 0)
941 :param next_hop_weight: (Default value = 1)
946 self.papi.mpls_route_add_del,
949 'mr_table_id': table_id,
950 'mr_classify_table_index': classify_table_index,
951 'mr_create_table_if_needed': create_vrf_if_needed,
953 'mr_is_classify': is_classify,
954 'mr_is_multipath': is_multipath,
955 'mr_is_multicast': is_multicast,
956 'mr_is_resolve_host': is_resolve_host,
957 'mr_is_resolve_attached': is_resolve_attached,
958 'mr_is_interface_rx': is_interface_rx,
959 'mr_is_rpf_id': is_rpf_id,
960 'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
961 'mr_next_hop_weight': next_hop_weight,
962 'mr_next_hop': next_hop_address,
963 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
964 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
965 'mr_next_hop_table_id': next_hop_table_id,
966 'mr_next_hop_via_label': next_hop_via_label,
967 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
969 def mpls_ip_bind_unbind(
977 create_vrf_if_needed=0,
982 self.papi.mpls_ip_bind_unbind,
983 {'mb_mpls_table_id': table_id,
985 'mb_ip_table_id': ip_table_id,
986 'mb_create_table_if_needed': create_vrf_if_needed,
987 'mb_is_bind': is_bind,
989 'mb_address_length': dst_address_length,
990 'mb_address': dst_address})
992 def mpls_tunnel_add_del(
995 next_hop_proto_is_ip4,
997 next_hop_sw_if_index=0xFFFFFFFF,
1000 next_hop_n_out_labels=0,
1001 next_hop_out_label_stack=[],
1002 next_hop_via_label=MPLS_LABEL_INVALID,
1003 create_vrf_if_needed=0,
1009 :param dst_address_length:
1010 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1012 :param next_hop_address:
1013 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1014 :param vrf_id: (Default value = 0)
1015 :param lookup_in_vrf: (Default value = 0)
1016 :param classify_table_index: (Default value = 0xFFFFFFFF)
1017 :param create_vrf_if_needed: (Default value = 0)
1018 :param is_add: (Default value = 1)
1019 :param is_drop: (Default value = 0)
1020 :param is_ipv6: (Default value = 0)
1021 :param is_local: (Default value = 0)
1022 :param is_classify: (Default value = 0)
1023 :param is_multipath: (Default value = 0)
1024 :param is_resolve_host: (Default value = 0)
1025 :param is_resolve_attached: (Default value = 0)
1026 :param next_hop_weight: (Default value = 1)
1027 :param is_multicast: (Default value = 0)
1031 self.papi.mpls_tunnel_add_del,
1032 {'mt_sw_if_index': tun_sw_if_index,
1033 'mt_is_add': is_add,
1034 'mt_l2_only': l2_only,
1035 'mt_is_multicast': is_multicast,
1036 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1037 'mt_next_hop_weight': next_hop_weight,
1038 'mt_next_hop': next_hop_address,
1039 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1040 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1041 'mt_next_hop_table_id': next_hop_table_id,
1042 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1044 def snat_interface_add_del_feature(
1049 """Enable/disable S-NAT feature on the interface
1051 :param sw_if_index: Software index of the interface
1052 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1053 :param is_add: 1 if add, 0 if delete (Default value = 1)
1056 self.papi.snat_interface_add_del_feature,
1058 'is_inside': is_inside,
1059 'sw_if_index': sw_if_index})
1061 def snat_interface_add_del_output_feature(
1066 """Enable/disable S-NAT output feature on the interface
1068 :param sw_if_index: Software index of the interface
1069 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1070 :param is_add: 1 if add, 0 if delete (Default value = 1)
1073 self.papi.snat_interface_add_del_output_feature,
1075 'is_inside': is_inside,
1076 'sw_if_index': sw_if_index})
1078 def snat_add_static_mapping(
1082 external_sw_if_index=0xFFFFFFFF,
1090 """Add/delete S-NAT static mapping
1092 :param local_ip: Local IP address
1093 :param external_ip: External IP address
1094 :param external_sw_if_index: External interface instead of IP address
1095 :param local_port: Local port number (Default value = 0)
1096 :param external_port: External port number (Default value = 0)
1097 :param addr_only: 1 if address only mapping, 0 if address and port
1098 :param vrf_id: VRF ID
1099 :param protocol: IP protocol (Default value = 0)
1100 :param is_add: 1 if add, 0 if delete (Default value = 1)
1101 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1104 self.papi.snat_add_static_mapping,
1107 'addr_only': addr_only,
1108 'local_ip_address': local_ip,
1109 'external_ip_address': external_ip,
1110 'local_port': local_port,
1111 'external_port': external_port,
1112 'external_sw_if_index': external_sw_if_index,
1114 'protocol': protocol})
1116 def snat_add_address_range(
1123 """Add/del S-NAT address range
1125 :param first_ip_address: First IP address
1126 :param last_ip_address: Last IP address
1127 :param vrf_id: VRF id for the address range
1128 :param is_add: 1 if add, 0 if delete (Default value = 1)
1129 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1132 self.papi.snat_add_address_range,
1134 'first_ip_address': first_ip_address,
1135 'last_ip_address': last_ip_address,
1139 def snat_address_dump(self):
1140 """Dump S-NAT addresses
1141 :return: Dictionary of S-NAT addresses
1143 return self.api(self.papi.snat_address_dump, {})
1145 def snat_interface_dump(self):
1146 """Dump interfaces with S-NAT feature
1147 :return: Dictionary of interfaces with S-NAT feature
1149 return self.api(self.papi.snat_interface_dump, {})
1151 def snat_interface_output_feature_dump(self):
1152 """Dump interfaces with S-NAT output feature
1153 :return: Dictionary of interfaces with S-NAT output feature
1155 return self.api(self.papi.snat_interface_output_feature_dump, {})
1157 def snat_static_mapping_dump(self):
1158 """Dump S-NAT static mappings
1159 :return: Dictionary of S-NAT static mappings
1161 return self.api(self.papi.snat_static_mapping_dump, {})
1163 def snat_show_config(self):
1164 """Show S-NAT config
1165 :return: S-NAT config parameters
1167 return self.api(self.papi.snat_show_config, {})
1169 def snat_add_interface_addr(
1173 """Add/del S-NAT address from interface
1175 :param sw_if_index: Software index of the interface
1176 :param is_add: 1 if add, 0 if delete (Default value = 1)
1178 return self.api(self.papi.snat_add_del_interface_addr,
1179 {'is_add': is_add, 'sw_if_index': sw_if_index})
1181 def snat_interface_addr_dump(self):
1182 """Dump S-NAT addresses interfaces
1183 :return: Dictionary of S-NAT addresses interfaces
1185 return self.api(self.papi.snat_interface_addr_dump, {})
1192 """Enable/disable S-NAT IPFIX logging
1194 :param domain_id: Observation domain ID (Default value = 1)
1195 :param src_port: Source port number (Default value = 4739)
1196 :param enable: 1 if enable, 0 if disable (Default value = 1)
1199 self.papi.snat_ipfix_enable_disable,
1200 {'domain_id': domain_id,
1201 'src_port': src_port,
1204 def snat_user_session_dump(
1209 """Dump S-NAT user's sessions
1211 :param ip_address: ip adress of the user to be dumped
1212 :param cpu_index: cpu_index on which the user is
1213 :param vrf_id: VRF ID
1214 :return: Dictionary of S-NAT sessions
1217 self.papi.snat_user_session_dump,
1218 {'ip_address': ip_address,
1222 def snat_user_dump(self):
1225 :return: Dictionary of S-NAT users
1227 return self.api(self.papi.snat_user_dump, {})
1229 def snat_add_det_map(
1236 """Add/delete S-NAT deterministic mapping
1238 :param is_add - 1 if add, 0 if delete
1239 :param in_addr - inside IP address
1240 :param in_plen - inside IP address prefix length
1241 :param out_addr - outside IP address
1242 :param out_plen - outside IP address prefix length
1245 self.papi.snat_add_det_map,
1249 'out_addr': out_addr,
1250 'out_plen': out_plen})
1252 def snat_det_forward(
1255 """Get outside address and port range from inside address
1257 :param in_addr - inside IP address
1260 self.papi.snat_det_forward,
1261 {'in_addr': in_addr})
1263 def snat_det_reverse(
1267 """Get inside address from outside address and port
1269 :param out_addr - outside IP address
1270 :param out_port - outside port
1273 self.papi.snat_det_reverse,
1274 {'out_addr': out_addr,
1275 'out_port': out_port})
1277 def snat_det_map_dump(self):
1278 """Dump S-NAT deterministic mappings
1280 :return: Dictionary of S-NAT deterministic mappings
1282 return self.api(self.papi.snat_det_map_dump, {})
1284 def snat_det_set_timeouts(
1287 tcp_established=7440,
1290 """Set values of timeouts for deterministic NAT (in seconds)
1292 :param udp - UDP timeout (Default value = 300)
1293 :param tcp_established - TCP established timeout (Default value = 7440)
1294 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1295 :param icmp - ICMP timeout (Default value = 60)
1298 self.papi.snat_det_set_timeouts,
1300 'tcp_established': tcp_established,
1301 'tcp_transitory': tcp_transitory,
1304 def snat_det_get_timeouts(self):
1305 """Get values of timeouts for deterministic NAT
1307 :return: Timeouts for deterministic NAT (in seconds)
1309 return self.api(self.papi.snat_det_get_timeouts, {})
1311 def snat_det_close_session_out(
1318 """Close CGN session using outside address and port
1320 :param out_addr - outside IP address
1321 :param out_port - outside port
1322 :param ext_addr - external host IP address
1323 :param ext_port - external host port
1324 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1327 self.papi.snat_det_close_session_out,
1328 {'out_addr': out_addr,
1329 'out_port': out_port,
1330 'ext_addr': ext_addr,
1331 'ext_port': ext_port,
1334 def snat_det_close_session_in(
1341 """Close CGN session using inside address and port
1343 :param in_addr - inside IP address
1344 :param in_port - inside port
1345 :param ext_addr - external host IP address
1346 :param ext_port - external host port
1347 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1350 self.papi.snat_det_close_session_in,
1351 {'in_addr': in_addr,
1353 'ext_addr': ext_addr,
1354 'ext_port': ext_port,
1357 def snat_det_session_dump(
1361 """Dump S-NAT deterministic sessions belonging to a user
1363 :param user_addr - inside IP address of the user
1364 :param is_ip4: - 1 if address type is IPv4 (Default value = 1)
1365 :return: Dictionary of S-NAT deterministic sessions
1368 self.papi.snat_det_session_dump,
1370 'user_addr': user_addr})
1372 def nat64_add_del_pool_addr_range(
1378 """Add/del address range to NAT64 pool
1380 :param start_addr: First IP address
1381 :param end_addr: Last IP address
1382 :param vrf_id: VRF id for the address range
1383 :param is_add: 1 if add, 0 if delete (Default value = 1)
1386 self.papi.nat64_add_del_pool_addr_range,
1387 {'start_addr': start_addr,
1388 'end_addr': end_addr,
1392 def nat64_pool_addr_dump(self):
1393 """Dump NAT64 pool addresses
1394 :return: Dictionary of NAT64 pool addresses
1396 return self.api(self.papi.nat64_pool_addr_dump, {})
1398 def nat64_add_del_interface(
1403 """Enable/disable NAT64 feature on the interface
1404 :param sw_if_index: Index of the interface
1405 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1406 :param is_add: 1 if add, 0 if delete (Default value = 1)
1409 self.papi.nat64_add_del_interface,
1410 {'sw_if_index': sw_if_index,
1411 'is_inside': is_inside,
1414 def nat64_interface_dump(self):
1415 """Dump interfaces with NAT64 feature
1416 :return: Dictionary of interfaces with NAT64 feature
1418 return self.api(self.papi.nat64_interface_dump, {})
1420 def nat64_add_del_static_bib(
1429 """Add/delete S-NAT static BIB entry
1431 :param in_ip: Inside IPv6 address
1432 :param out_ip: Outside IPv4 address
1433 :param in_port: Inside port number
1434 :param out_port: Outside port number
1435 :param protocol: IP protocol
1436 :param vrf_id: VRF ID (Default value = 0)
1437 :param is_add: 1 if add, 0 if delete (Default value = 1)
1440 self.papi.nat64_add_del_static_bib,
1449 def nat64_bib_dump(self, protocol):
1452 :param protocol: IP protocol
1453 :returns: Dictionary of NAT64 BIB entries
1455 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1457 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1458 tcp_incoming_syn=6):
1459 """Set values of timeouts for NAT64 (in seconds)
1461 :param udpi: UDP timeout (Default value = 300)
1462 :param icmp: ICMP timeout (Default value = 60)
1463 :param tcp_trans: TCP transitory timeout (Default value = 240)
1464 :param tcp_est: TCP established timeout (Default value = 7440)
1465 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1468 self.papi.nat64_set_timeouts,
1471 'tcp_trans': tcp_trans,
1473 'tcp_incoming_syn': tcp_incoming_syn})
1475 def nat64_get_timeouts(self):
1476 """Get values of timeouts for NAT64
1478 :return: Timeouts for NAT64 (in seconds)
1480 return self.api(self.papi.nat64_get_timeouts, {})
1482 def nat64_st_dump(self, protocol):
1483 """Dump NAT64 session table
1485 :param protocol: IP protocol
1486 :returns: Dictionary of NAT64 sesstion table entries
1488 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1490 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1491 """Add/del NAT64 prefix
1493 :param prefix: NAT64 prefix
1494 :param plen: NAT64 prefix length
1495 :param vrf_id: VRF id of tenant (Default 0)
1496 :param is_add: 1 if add, 0 if delete (Default value = 1)
1499 self.papi.nat64_add_del_prefix,
1505 def nat64_prefix_dump(self):
1506 """Dump NAT64 prefix
1508 :returns: Dictionary of NAT64 prefixes
1510 return self.api(self.papi.nat64_prefix_dump, {})
1512 def control_ping(self):
1513 self.api(self.papi.control_ping)
1515 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1516 detect_mult, local_addr, peer_addr, is_ipv6=0,
1517 bfd_key_id=None, conf_key_id=None):
1518 if bfd_key_id is None:
1519 return self.api(self.papi.bfd_udp_add,
1521 'sw_if_index': sw_if_index,
1522 'desired_min_tx': desired_min_tx,
1523 'required_min_rx': required_min_rx,
1524 'local_addr': local_addr,
1525 'peer_addr': peer_addr,
1527 'detect_mult': detect_mult,
1530 return self.api(self.papi.bfd_udp_add,
1532 'sw_if_index': sw_if_index,
1533 'desired_min_tx': desired_min_tx,
1534 'required_min_rx': required_min_rx,
1535 'local_addr': local_addr,
1536 'peer_addr': peer_addr,
1538 'detect_mult': detect_mult,
1539 'is_authenticated': 1,
1540 'bfd_key_id': bfd_key_id,
1541 'conf_key_id': conf_key_id,
1544 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1545 detect_mult, local_addr, peer_addr, is_ipv6=0):
1546 return self.api(self.papi.bfd_udp_mod,
1548 'sw_if_index': sw_if_index,
1549 'desired_min_tx': desired_min_tx,
1550 'required_min_rx': required_min_rx,
1551 'local_addr': local_addr,
1552 'peer_addr': peer_addr,
1554 'detect_mult': detect_mult,
1557 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1558 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1560 return self.api(self.papi.bfd_udp_auth_activate,
1562 'sw_if_index': sw_if_index,
1563 'local_addr': local_addr,
1564 'peer_addr': peer_addr,
1566 'is_delayed': 1 if is_delayed else 0,
1567 'bfd_key_id': bfd_key_id,
1568 'conf_key_id': conf_key_id,
1571 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1572 is_ipv6=0, is_delayed=False):
1573 return self.api(self.papi.bfd_udp_auth_deactivate,
1575 'sw_if_index': sw_if_index,
1576 'local_addr': local_addr,
1577 'peer_addr': peer_addr,
1579 'is_delayed': 1 if is_delayed else 0,
1582 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1583 return self.api(self.papi.bfd_udp_del,
1585 'sw_if_index': sw_if_index,
1586 'local_addr': local_addr,
1587 'peer_addr': peer_addr,
1591 def bfd_udp_session_dump(self):
1592 return self.api(self.papi.bfd_udp_session_dump, {})
1594 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1595 peer_addr, is_ipv6=0):
1596 return self.api(self.papi.bfd_udp_session_set_flags, {
1597 'admin_up_down': admin_up_down,
1598 'sw_if_index': sw_if_index,
1599 'local_addr': local_addr,
1600 'peer_addr': peer_addr,
1604 def want_bfd_events(self, enable_disable=1):
1605 return self.api(self.papi.want_bfd_events, {
1606 'enable_disable': enable_disable,
1610 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1611 return self.api(self.papi.bfd_auth_set_key, {
1612 'conf_key_id': conf_key_id,
1613 'auth_type': auth_type,
1615 'key_len': len(key),
1618 def bfd_auth_del_key(self, conf_key_id):
1619 return self.api(self.papi.bfd_auth_del_key, {
1620 'conf_key_id': conf_key_id,
1623 def bfd_auth_keys_dump(self):
1624 return self.api(self.papi.bfd_auth_keys_dump, {})
1626 def bfd_udp_set_echo_source(self, sw_if_index):
1627 return self.api(self.papi.bfd_udp_set_echo_source,
1628 {'sw_if_index': sw_if_index})
1630 def bfd_udp_del_echo_source(self):
1631 return self.api(self.papi.bfd_udp_del_echo_source, {})
1633 def classify_add_del_table(
1638 table_index=0xFFFFFFFF,
1640 memory_size=2097152,
1642 next_table_index=0xFFFFFFFF,
1643 miss_next_index=0xFFFFFFFF,
1644 current_data_flag=0,
1645 current_data_offset=0):
1649 :param match_n_vectors: (Default value = 1)
1650 :param table_index: (Default value = 0xFFFFFFFF)
1651 :param nbuckets: (Default value = 2)
1652 :param memory_size: (Default value = 2097152)
1653 :param skip_n_vectors: (Default value = 0)
1654 :param next_table_index: (Default value = 0xFFFFFFFF)
1655 :param miss_next_index: (Default value = 0xFFFFFFFF)
1656 :param current_data_flag: (Default value = 0)
1657 :param current_data_offset: (Default value = 0)
1661 self.papi.classify_add_del_table,
1663 'table_index': table_index,
1664 'nbuckets': nbuckets,
1665 'memory_size': memory_size,
1666 'skip_n_vectors': skip_n_vectors,
1667 'match_n_vectors': match_n_vectors,
1668 'next_table_index': next_table_index,
1669 'miss_next_index': miss_next_index,
1670 'current_data_flag': current_data_flag,
1671 'current_data_offset': current_data_offset,
1674 def classify_add_del_session(
1679 opaque_index=0xFFFFFFFF,
1680 hit_next_index=0xFFFFFFFF,
1688 :param opaque_index: (Default value = 0xFFFFFFFF)
1689 :param hit_next_index: (Default value = 0xFFFFFFFF)
1690 :param advance: (Default value = 0)
1691 :param action: (Default value = 0)
1692 :param metadata: (Default value = 0)
1696 self.papi.classify_add_del_session,
1698 'table_index': table_index,
1699 'hit_next_index': hit_next_index,
1700 'opaque_index': opaque_index,
1703 'metadata': metadata,
1706 def input_acl_set_interface(
1710 ip4_table_index=0xFFFFFFFF,
1711 ip6_table_index=0xFFFFFFFF,
1712 l2_table_index=0xFFFFFFFF):
1716 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1717 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1718 :param l2_table_index: (Default value = 0xFFFFFFFF)
1722 self.papi.input_acl_set_interface,
1723 {'sw_if_index': sw_if_index,
1724 'ip4_table_index': ip4_table_index,
1725 'ip6_table_index': ip6_table_index,
1726 'l2_table_index': l2_table_index,
1729 def set_ipfix_exporter(
1736 collector_port=4739,
1739 self.papi.set_ipfix_exporter,
1741 'collector_address': collector_address,
1742 'collector_port': collector_port,
1743 'src_address': src_address,
1745 'path_mtu': path_mtu,
1746 'template_interval': template_interval,
1747 'udp_checksum': udp_checksum,
1750 def dhcp_proxy_config(self,
1758 self.papi.dhcp_proxy_config,
1760 'rx_vrf_id': rx_table_id,
1761 'server_vrf_id': server_table_id,
1764 'dhcp_server': dhcp_server,
1765 'dhcp_src_address': dhcp_src_address,
1768 def dhcp_proxy_set_vss(self,
1775 self.papi.dhcp_proxy_set_vss,
1784 def dhcp_client(self,
1789 want_dhcp_events=0):
1791 self.papi.dhcp_client_config,
1793 'sw_if_index': sw_if_index,
1794 'hostname': hostname,
1795 'client_id': client_id,
1797 'want_dhcp_event': want_dhcp_events,
1801 def ip_mroute_add_del(self,
1806 next_hop_sw_if_index,
1810 create_vrf_if_needed=0,
1817 self.papi.ip_mroute_add_del,
1818 {'next_hop_sw_if_index': next_hop_sw_if_index,
1819 'entry_flags': e_flags,
1820 'itf_flags': i_flags,
1821 'table_id': table_id,
1823 'create_vrf_if_needed': create_vrf_if_needed,
1826 'is_local': is_local,
1827 'grp_address_length': grp_address_length,
1828 'grp_address': grp_address,
1829 'src_address': src_address})
1831 def mfib_signal_dump(self):
1832 return self.api(self.papi.mfib_signal_dump, {})
1834 def ip_mfib_dump(self):
1835 return self.api(self.papi.ip_mfib_dump, {})
1837 def lisp_enable_disable(self, is_enabled):
1839 self.papi.lisp_enable_disable,
1841 'is_en': is_enabled,
1844 def lisp_locator_set(self,
1848 self.papi.lisp_add_del_locator_set,
1851 'locator_set_name': ls_name
1854 def lisp_locator_set_dump(self):
1855 return self.api(self.papi.lisp_locator_set_dump, {})
1857 def lisp_locator(self,
1864 self.papi.lisp_add_del_locator,
1867 'locator_set_name': ls_name,
1868 'sw_if_index': sw_if_index,
1869 'priority': priority,
1873 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1875 self.papi.lisp_locator_dump,
1877 'is_index_set': is_index_set,
1879 'ls_index': ls_index,
1882 def lisp_local_mapping(self,
1892 self.papi.lisp_add_del_local_eid,
1894 'locator_set_name': ls_name,
1896 'eid_type': eid_type,
1898 'prefix_len': prefix_len,
1904 def lisp_eid_table_dump(self,
1912 self.papi.lisp_eid_table_dump,
1915 'prefix_length': prefix_length,
1917 'eid_type': eid_type,
1919 'filter': filter_opt,
1922 def lisp_remote_mapping(self,
1932 self.papi.lisp_add_del_remote_mapping,
1935 'eid_type': eid_type,
1937 'eid_len': eid_prefix_len,
1938 'rloc_num': rlocs_num,
1941 'is_src_dst': is_src_dst,
1944 def lisp_adjacency(self,
1953 self.papi.lisp_add_del_adjacency,
1957 'eid_type': eid_type,
1960 'leid_len': leid_len,
1961 'reid_len': reid_len,
1964 def lisp_adjacencies_get(self, vni=0):
1966 self.papi.lisp_adjacencies_get,
1971 def map_add_domain(self,
1984 self.papi.map_add_domain,
1986 'ip6_prefix': ip6_prefix,
1987 'ip6_prefix_len': ip6_prefix_len,
1988 'ip4_prefix': ip4_prefix,
1989 'ip4_prefix_len': ip4_prefix_len,
1991 'ip6_src_prefix_len': ip6_src_prefix_len,
1992 'ea_bits_len': ea_bits_len,
1993 'psid_offset': psid_offset,
1994 'psid_length': psid_length,
1995 'is_translation': is_translation,
1999 def gtpu_add_del_tunnel(
2005 mcast_sw_if_index=0xFFFFFFFF,
2007 decap_next_index=0xFFFFFFFF,
2011 :param is_add: (Default value = 1)
2012 :param is_ipv6: (Default value = 0)
2015 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2016 :param encap_vrf_id: (Default value = 0)
2017 :param decap_next_index: (Default value = 0xFFFFFFFF)
2018 :param teid: (Default value = 0)
2021 return self.api(self.papi.gtpu_add_del_tunnel,
2024 'src_address': src_addr,
2025 'dst_address': dst_addr,
2026 'mcast_sw_if_index': mcast_sw_if_index,
2027 'encap_vrf_id': encap_vrf_id,
2028 'decap_next_index': decap_next_index,
2031 def vxlan_gpe_add_del_tunnel(
2035 mcast_sw_if_index=0xFFFFFFFF,
2046 :param is_add: (Default value = 1)
2047 :param is_ipv6: (Default value = 0)
2048 :param encap_vrf_id: (Default value = 0)
2049 :param decap_vrf_id: (Default value = 0)
2050 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2051 :param protocol: (Default value = 3)
2052 :param vni: (Default value = 0)
2055 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2060 'mcast_sw_if_index': mcast_sw_if_index,
2061 'encap_vrf_id': encap_vrf_id,
2062 'decap_vrf_id': decap_vrf_id,
2063 'protocol': protocol,