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):
853 :param sw_if_index_from:
854 :param sw_if_index_to:
857 return self.api(self.papi.sw_interface_span_enable_disable,
858 {'sw_if_index_from': sw_if_index_from,
859 'sw_if_index_to': sw_if_index_to,
862 def gre_tunnel_add_del(self,
873 :param outer_fib_id: (Default value = 0)
874 :param is_add: (Default value = 1)
875 :param is_ipv6: (Default value = 0)
876 :param is_teb: (Default value = 0)
880 self.papi.gre_add_del_tunnel,
884 'src_address': src_address,
885 'dst_address': dst_address,
886 'outer_fib_id': outer_fib_id}
889 def mpls_fib_dump(self):
890 return self.api(self.papi.mpls_fib_dump, {})
892 def mpls_route_add_del(
896 next_hop_proto_is_ip4,
898 next_hop_sw_if_index=0xFFFFFFFF,
902 next_hop_n_out_labels=0,
903 next_hop_out_label_stack=[],
904 next_hop_via_label=MPLS_LABEL_INVALID,
905 create_vrf_if_needed=0,
907 is_resolve_attached=0,
914 classify_table_index=0xFFFFFFFF,
919 :param dst_address_length:
920 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
922 :param next_hop_address:
923 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
924 :param vrf_id: (Default value = 0)
925 :param lookup_in_vrf: (Default value = 0)
926 :param classify_table_index: (Default value = 0xFFFFFFFF)
927 :param create_vrf_if_needed: (Default value = 0)
928 :param is_add: (Default value = 1)
929 :param is_drop: (Default value = 0)
930 :param is_ipv6: (Default value = 0)
931 :param is_local: (Default value = 0)
932 :param is_classify: (Default value = 0)
933 :param is_multipath: (Default value = 0)
934 :param is_multicast: (Default value = 0)
935 :param is_resolve_host: (Default value = 0)
936 :param is_resolve_attached: (Default value = 0)
937 :param not_last: (Default value = 0)
938 :param next_hop_weight: (Default value = 1)
943 self.papi.mpls_route_add_del,
946 'mr_table_id': table_id,
947 'mr_classify_table_index': classify_table_index,
948 'mr_create_table_if_needed': create_vrf_if_needed,
950 'mr_is_classify': is_classify,
951 'mr_is_multipath': is_multipath,
952 'mr_is_multicast': is_multicast,
953 'mr_is_resolve_host': is_resolve_host,
954 'mr_is_resolve_attached': is_resolve_attached,
955 'mr_is_interface_rx': is_interface_rx,
956 'mr_is_rpf_id': is_rpf_id,
957 'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
958 'mr_next_hop_weight': next_hop_weight,
959 'mr_next_hop': next_hop_address,
960 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
961 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
962 'mr_next_hop_table_id': next_hop_table_id,
963 'mr_next_hop_via_label': next_hop_via_label,
964 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
966 def mpls_ip_bind_unbind(
974 create_vrf_if_needed=0,
979 self.papi.mpls_ip_bind_unbind,
980 {'mb_mpls_table_id': table_id,
982 'mb_ip_table_id': ip_table_id,
983 'mb_create_table_if_needed': create_vrf_if_needed,
984 'mb_is_bind': is_bind,
986 'mb_address_length': dst_address_length,
987 'mb_address': dst_address})
989 def mpls_tunnel_add_del(
992 next_hop_proto_is_ip4,
994 next_hop_sw_if_index=0xFFFFFFFF,
997 next_hop_n_out_labels=0,
998 next_hop_out_label_stack=[],
999 next_hop_via_label=MPLS_LABEL_INVALID,
1000 create_vrf_if_needed=0,
1006 :param dst_address_length:
1007 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1009 :param next_hop_address:
1010 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1011 :param vrf_id: (Default value = 0)
1012 :param lookup_in_vrf: (Default value = 0)
1013 :param classify_table_index: (Default value = 0xFFFFFFFF)
1014 :param create_vrf_if_needed: (Default value = 0)
1015 :param is_add: (Default value = 1)
1016 :param is_drop: (Default value = 0)
1017 :param is_ipv6: (Default value = 0)
1018 :param is_local: (Default value = 0)
1019 :param is_classify: (Default value = 0)
1020 :param is_multipath: (Default value = 0)
1021 :param is_resolve_host: (Default value = 0)
1022 :param is_resolve_attached: (Default value = 0)
1023 :param next_hop_weight: (Default value = 1)
1024 :param is_multicast: (Default value = 0)
1028 self.papi.mpls_tunnel_add_del,
1029 {'mt_sw_if_index': tun_sw_if_index,
1030 'mt_is_add': is_add,
1031 'mt_l2_only': l2_only,
1032 'mt_is_multicast': is_multicast,
1033 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1034 'mt_next_hop_weight': next_hop_weight,
1035 'mt_next_hop': next_hop_address,
1036 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1037 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1038 'mt_next_hop_table_id': next_hop_table_id,
1039 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1041 def snat_interface_add_del_feature(
1046 """Enable/disable S-NAT feature on the interface
1048 :param sw_if_index: Software index of the interface
1049 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1050 :param is_add: 1 if add, 0 if delete (Default value = 1)
1053 self.papi.snat_interface_add_del_feature,
1055 'is_inside': is_inside,
1056 'sw_if_index': sw_if_index})
1058 def snat_add_static_mapping(
1062 external_sw_if_index=0xFFFFFFFF,
1070 """Add/delete S-NAT static mapping
1072 :param local_ip: Local IP address
1073 :param external_ip: External IP address
1074 :param external_sw_if_index: External interface instead of IP address
1075 :param local_port: Local port number (Default value = 0)
1076 :param external_port: External port number (Default value = 0)
1077 :param addr_only: 1 if address only mapping, 0 if address and port
1078 :param vrf_id: VRF ID
1079 :param protocol: IP protocol (Default value = 0)
1080 :param is_add: 1 if add, 0 if delete (Default value = 1)
1081 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1084 self.papi.snat_add_static_mapping,
1087 'addr_only': addr_only,
1088 'local_ip_address': local_ip,
1089 'external_ip_address': external_ip,
1090 'local_port': local_port,
1091 'external_port': external_port,
1092 'external_sw_if_index': external_sw_if_index,
1094 'protocol': protocol})
1096 def snat_add_address_range(
1103 """Add/del S-NAT address range
1105 :param first_ip_address: First IP address
1106 :param last_ip_address: Last IP address
1107 :param vrf_id: VRF id for the address range
1108 :param is_add: 1 if add, 0 if delete (Default value = 1)
1109 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1112 self.papi.snat_add_address_range,
1114 'first_ip_address': first_ip_address,
1115 'last_ip_address': last_ip_address,
1119 def snat_address_dump(self):
1120 """Dump S-NAT addresses
1121 :return: Dictionary of S-NAT addresses
1123 return self.api(self.papi.snat_address_dump, {})
1125 def snat_interface_dump(self):
1126 """Dump interfaces with S-NAT feature
1127 :return: Dictionary of interfaces with S-NAT feature
1129 return self.api(self.papi.snat_interface_dump, {})
1131 def snat_static_mapping_dump(self):
1132 """Dump S-NAT static mappings
1133 :return: Dictionary of S-NAT static mappings
1135 return self.api(self.papi.snat_static_mapping_dump, {})
1137 def snat_show_config(self):
1138 """Show S-NAT config
1139 :return: S-NAT config parameters
1141 return self.api(self.papi.snat_show_config, {})
1143 def snat_add_interface_addr(
1147 """Add/del S-NAT address from interface
1149 :param sw_if_index: Software index of the interface
1150 :param is_add: 1 if add, 0 if delete (Default value = 1)
1152 return self.api(self.papi.snat_add_del_interface_addr,
1153 {'is_add': is_add, 'sw_if_index': sw_if_index})
1155 def snat_interface_addr_dump(self):
1156 """Dump S-NAT addresses interfaces
1157 :return: Dictionary of S-NAT addresses interfaces
1159 return self.api(self.papi.snat_interface_addr_dump, {})
1166 """Enable/disable S-NAT IPFIX logging
1168 :param domain_id: Observation domain ID (Default value = 1)
1169 :param src_port: Source port number (Default value = 4739)
1170 :param enable: 1 if enable, 0 if disable (Default value = 1)
1173 self.papi.snat_ipfix_enable_disable,
1174 {'domain_id': domain_id,
1175 'src_port': src_port,
1178 def snat_user_session_dump(
1183 """Dump S-NAT user's sessions
1185 :param ip_address: ip adress of the user to be dumped
1186 :param cpu_index: cpu_index on which the user is
1187 :param vrf_id: VRF ID
1188 :return: Dictionary of S-NAT sessions
1191 self.papi.snat_user_session_dump,
1192 {'ip_address': ip_address,
1196 def snat_user_dump(self):
1199 :return: Dictionary of S-NAT users
1201 return self.api(self.papi.snat_user_dump, {})
1203 def snat_add_det_map(
1210 """Add/delete S-NAT deterministic mapping
1212 :param is_add - 1 if add, 0 if delete
1213 :param in_addr - inside IP address
1214 :param in_plen - inside IP address prefix length
1215 :param out_addr - outside IP address
1216 :param out_plen - outside IP address prefix length
1219 self.papi.snat_add_det_map,
1223 'out_addr': out_addr,
1224 'out_plen': out_plen})
1226 def snat_det_forward(
1229 """Get outside address and port range from inside address
1231 :param in_addr - inside IP address
1234 self.papi.snat_det_forward,
1235 {'in_addr': in_addr})
1237 def snat_det_reverse(
1241 """Get inside address from outside address and port
1243 :param out_addr - outside IP address
1244 :param out_port - outside port
1247 self.papi.snat_det_reverse,
1248 {'out_addr': out_addr,
1249 'out_port': out_port})
1251 def snat_det_map_dump(self):
1252 """Dump S-NAT deterministic mappings
1254 :return: Dictionary of S-NAT deterministic mappings
1256 return self.api(self.papi.snat_det_map_dump, {})
1258 def snat_det_set_timeouts(
1261 tcp_established=7440,
1264 """Set values of timeouts for deterministic NAT (in seconds)
1266 :param udp - UDP timeout (Default value = 300)
1267 :param tcp_established - TCP established timeout (Default value = 7440)
1268 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1269 :param icmp - ICMP timeout (Default value = 60)
1272 self.papi.snat_det_set_timeouts,
1274 'tcp_established': tcp_established,
1275 'tcp_transitory': tcp_transitory,
1278 def snat_det_get_timeouts(self):
1279 """Get values of timeouts for deterministic NAT
1281 :return: Timeouts for deterministic NAT (in seconds)
1283 return self.api(self.papi.snat_det_get_timeouts, {})
1285 def snat_det_close_session_out(
1292 """Close CGN session using outside address and port
1294 :param out_addr - outside IP address
1295 :param out_port - outside port
1296 :param ext_addr - external host IP address
1297 :param ext_port - external host port
1298 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1301 self.papi.snat_det_close_session_out,
1302 {'out_addr': out_addr,
1303 'out_port': out_port,
1304 'ext_addr': ext_addr,
1305 'ext_port': ext_port,
1308 def snat_det_close_session_in(
1315 """Close CGN session using inside address and port
1317 :param in_addr - inside IP address
1318 :param in_port - inside port
1319 :param ext_addr - external host IP address
1320 :param ext_port - external host port
1321 :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1324 self.papi.snat_det_close_session_in,
1325 {'in_addr': in_addr,
1327 'ext_addr': ext_addr,
1328 'ext_port': ext_port,
1331 def snat_det_session_dump(
1335 """Dump S-NAT deterministic sessions belonging to a user
1337 :param user_addr - inside IP address of the user
1338 :param is_ip4: - 1 if address type is IPv4 (Default value = 1)
1339 :return: Dictionary of S-NAT deterministic sessions
1342 self.papi.snat_det_session_dump,
1344 'user_addr': user_addr})
1346 def nat64_add_del_pool_addr_range(
1352 """Add/del address range to NAT64 pool
1354 :param start_addr: First IP address
1355 :param end_addr: Last IP address
1356 :param vrf_id: VRF id for the address range
1357 :param is_add: 1 if add, 0 if delete (Default value = 1)
1360 self.papi.nat64_add_del_pool_addr_range,
1361 {'start_addr': start_addr,
1362 'end_addr': end_addr,
1366 def nat64_pool_addr_dump(self):
1367 """Dump NAT64 pool addresses
1368 :return: Dictionary of NAT64 pool addresses
1370 return self.api(self.papi.nat64_pool_addr_dump, {})
1372 def nat64_add_del_interface(
1377 """Enable/disable NAT64 feature on the interface
1378 :param sw_if_index: Index of the interface
1379 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1380 :param is_add: 1 if add, 0 if delete (Default value = 1)
1383 self.papi.nat64_add_del_interface,
1384 {'sw_if_index': sw_if_index,
1385 'is_inside': is_inside,
1388 def nat64_interface_dump(self):
1389 """Dump interfaces with NAT64 feature
1390 :return: Dictionary of interfaces with NAT64 feature
1392 return self.api(self.papi.nat64_interface_dump, {})
1394 def nat64_add_del_static_bib(
1403 """Add/delete S-NAT static BIB entry
1405 :param in_ip: Inside IPv6 address
1406 :param out_ip: Outside IPv4 address
1407 :param in_port: Inside port number
1408 :param out_port: Outside port number
1409 :param protocol: IP protocol
1410 :param vrf_id: VRF ID (Default value = 0)
1411 :param is_add: 1 if add, 0 if delete (Default value = 1)
1414 self.papi.nat64_add_del_static_bib,
1423 def nat64_bib_dump(self, protocol):
1426 :param protocol: IP protocol
1427 :returns: Dictionary of NAT64 BIB entries
1429 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1431 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1432 tcp_incoming_syn=6):
1433 """Set values of timeouts for NAT64 (in seconds)
1435 :param udpi: UDP timeout (Default value = 300)
1436 :param icmp: ICMP timeout (Default value = 60)
1437 :param tcp_trans: TCP transitory timeout (Default value = 240)
1438 :param tcp_est: TCP established timeout (Default value = 7440)
1439 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1442 self.papi.nat64_set_timeouts,
1445 'tcp_trans': tcp_trans,
1447 'tcp_incoming_syn': tcp_incoming_syn})
1449 def nat64_get_timeouts(self):
1450 """Get values of timeouts for NAT64
1452 :return: Timeouts for NAT64 (in seconds)
1454 return self.api(self.papi.nat64_get_timeouts, {})
1456 def nat64_st_dump(self, protocol):
1457 """Dump NAT64 session table
1459 :param protocol: IP protocol
1460 :returns: Dictionary of NAT64 sesstion table entries
1462 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1464 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1465 """Add/del NAT64 prefix
1467 :param prefix: NAT64 prefix
1468 :param plen: NAT64 prefix length
1469 :param vrf_id: VRF id of tenant (Default 0)
1470 :param is_add: 1 if add, 0 if delete (Default value = 1)
1473 self.papi.nat64_add_del_prefix,
1479 def nat64_prefix_dump(self):
1480 """Dump NAT64 prefix
1482 :returns: Dictionary of NAT64 prefixes
1484 return self.api(self.papi.nat64_prefix_dump, {})
1486 def control_ping(self):
1487 self.api(self.papi.control_ping)
1489 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1490 detect_mult, local_addr, peer_addr, is_ipv6=0,
1491 bfd_key_id=None, conf_key_id=None):
1492 if bfd_key_id is None:
1493 return self.api(self.papi.bfd_udp_add,
1495 'sw_if_index': sw_if_index,
1496 'desired_min_tx': desired_min_tx,
1497 'required_min_rx': required_min_rx,
1498 'local_addr': local_addr,
1499 'peer_addr': peer_addr,
1501 'detect_mult': detect_mult,
1504 return self.api(self.papi.bfd_udp_add,
1506 'sw_if_index': sw_if_index,
1507 'desired_min_tx': desired_min_tx,
1508 'required_min_rx': required_min_rx,
1509 'local_addr': local_addr,
1510 'peer_addr': peer_addr,
1512 'detect_mult': detect_mult,
1513 'is_authenticated': 1,
1514 'bfd_key_id': bfd_key_id,
1515 'conf_key_id': conf_key_id,
1518 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1519 detect_mult, local_addr, peer_addr, is_ipv6=0):
1520 return self.api(self.papi.bfd_udp_mod,
1522 'sw_if_index': sw_if_index,
1523 'desired_min_tx': desired_min_tx,
1524 'required_min_rx': required_min_rx,
1525 'local_addr': local_addr,
1526 'peer_addr': peer_addr,
1528 'detect_mult': detect_mult,
1531 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1532 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1534 return self.api(self.papi.bfd_udp_auth_activate,
1536 'sw_if_index': sw_if_index,
1537 'local_addr': local_addr,
1538 'peer_addr': peer_addr,
1540 'is_delayed': 1 if is_delayed else 0,
1541 'bfd_key_id': bfd_key_id,
1542 'conf_key_id': conf_key_id,
1545 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1546 is_ipv6=0, is_delayed=False):
1547 return self.api(self.papi.bfd_udp_auth_deactivate,
1549 'sw_if_index': sw_if_index,
1550 'local_addr': local_addr,
1551 'peer_addr': peer_addr,
1553 'is_delayed': 1 if is_delayed else 0,
1556 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1557 return self.api(self.papi.bfd_udp_del,
1559 'sw_if_index': sw_if_index,
1560 'local_addr': local_addr,
1561 'peer_addr': peer_addr,
1565 def bfd_udp_session_dump(self):
1566 return self.api(self.papi.bfd_udp_session_dump, {})
1568 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1569 peer_addr, is_ipv6=0):
1570 return self.api(self.papi.bfd_udp_session_set_flags, {
1571 'admin_up_down': admin_up_down,
1572 'sw_if_index': sw_if_index,
1573 'local_addr': local_addr,
1574 'peer_addr': peer_addr,
1578 def want_bfd_events(self, enable_disable=1):
1579 return self.api(self.papi.want_bfd_events, {
1580 'enable_disable': enable_disable,
1584 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1585 return self.api(self.papi.bfd_auth_set_key, {
1586 'conf_key_id': conf_key_id,
1587 'auth_type': auth_type,
1589 'key_len': len(key),
1592 def bfd_auth_del_key(self, conf_key_id):
1593 return self.api(self.papi.bfd_auth_del_key, {
1594 'conf_key_id': conf_key_id,
1597 def bfd_auth_keys_dump(self):
1598 return self.api(self.papi.bfd_auth_keys_dump, {})
1600 def bfd_udp_set_echo_source(self, sw_if_index):
1601 return self.api(self.papi.bfd_udp_set_echo_source,
1602 {'sw_if_index': sw_if_index})
1604 def bfd_udp_del_echo_source(self):
1605 return self.api(self.papi.bfd_udp_del_echo_source, {})
1607 def classify_add_del_table(
1612 table_index=0xFFFFFFFF,
1614 memory_size=2097152,
1616 next_table_index=0xFFFFFFFF,
1617 miss_next_index=0xFFFFFFFF,
1618 current_data_flag=0,
1619 current_data_offset=0):
1623 :param match_n_vectors: (Default value = 1)
1624 :param table_index: (Default value = 0xFFFFFFFF)
1625 :param nbuckets: (Default value = 2)
1626 :param memory_size: (Default value = 2097152)
1627 :param skip_n_vectors: (Default value = 0)
1628 :param next_table_index: (Default value = 0xFFFFFFFF)
1629 :param miss_next_index: (Default value = 0xFFFFFFFF)
1630 :param current_data_flag: (Default value = 0)
1631 :param current_data_offset: (Default value = 0)
1635 self.papi.classify_add_del_table,
1637 'table_index': table_index,
1638 'nbuckets': nbuckets,
1639 'memory_size': memory_size,
1640 'skip_n_vectors': skip_n_vectors,
1641 'match_n_vectors': match_n_vectors,
1642 'next_table_index': next_table_index,
1643 'miss_next_index': miss_next_index,
1644 'current_data_flag': current_data_flag,
1645 'current_data_offset': current_data_offset,
1648 def classify_add_del_session(
1653 opaque_index=0xFFFFFFFF,
1654 hit_next_index=0xFFFFFFFF,
1662 :param opaque_index: (Default value = 0xFFFFFFFF)
1663 :param hit_next_index: (Default value = 0xFFFFFFFF)
1664 :param advance: (Default value = 0)
1665 :param action: (Default value = 0)
1666 :param metadata: (Default value = 0)
1670 self.papi.classify_add_del_session,
1672 'table_index': table_index,
1673 'hit_next_index': hit_next_index,
1674 'opaque_index': opaque_index,
1677 'metadata': metadata,
1680 def input_acl_set_interface(
1684 ip4_table_index=0xFFFFFFFF,
1685 ip6_table_index=0xFFFFFFFF,
1686 l2_table_index=0xFFFFFFFF):
1690 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1691 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1692 :param l2_table_index: (Default value = 0xFFFFFFFF)
1696 self.papi.input_acl_set_interface,
1697 {'sw_if_index': sw_if_index,
1698 'ip4_table_index': ip4_table_index,
1699 'ip6_table_index': ip6_table_index,
1700 'l2_table_index': l2_table_index,
1703 def set_ipfix_exporter(
1710 collector_port=4739,
1713 self.papi.set_ipfix_exporter,
1715 'collector_address': collector_address,
1716 'collector_port': collector_port,
1717 'src_address': src_address,
1719 'path_mtu': path_mtu,
1720 'template_interval': template_interval,
1721 'udp_checksum': udp_checksum,
1724 def dhcp_proxy_config(self,
1732 self.papi.dhcp_proxy_config,
1734 'rx_vrf_id': rx_table_id,
1735 'server_vrf_id': server_table_id,
1738 'dhcp_server': dhcp_server,
1739 'dhcp_src_address': dhcp_src_address,
1742 def dhcp_proxy_set_vss(self,
1749 self.papi.dhcp_proxy_set_vss,
1758 def ip_mroute_add_del(self,
1763 next_hop_sw_if_index,
1767 create_vrf_if_needed=0,
1774 self.papi.ip_mroute_add_del,
1775 {'next_hop_sw_if_index': next_hop_sw_if_index,
1776 'entry_flags': e_flags,
1777 'itf_flags': i_flags,
1778 'table_id': table_id,
1780 'create_vrf_if_needed': create_vrf_if_needed,
1783 'is_local': is_local,
1784 'grp_address_length': grp_address_length,
1785 'grp_address': grp_address,
1786 'src_address': src_address})
1788 def mfib_signal_dump(self):
1789 return self.api(self.papi.mfib_signal_dump, {})
1791 def ip_mfib_dump(self):
1792 return self.api(self.papi.ip_mfib_dump, {})
1794 def lisp_enable_disable(self, is_enabled):
1796 self.papi.lisp_enable_disable,
1798 'is_en': is_enabled,
1801 def lisp_locator_set(self,
1805 self.papi.lisp_add_del_locator_set,
1808 'locator_set_name': ls_name
1811 def lisp_locator_set_dump(self):
1812 return self.api(self.papi.lisp_locator_set_dump, {})
1814 def lisp_locator(self,
1821 self.papi.lisp_add_del_locator,
1824 'locator_set_name': ls_name,
1825 'sw_if_index': sw_if_index,
1826 'priority': priority,
1830 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1832 self.papi.lisp_locator_dump,
1834 'is_index_set': is_index_set,
1836 'ls_index': ls_index,
1839 def lisp_local_mapping(self,
1849 self.papi.lisp_add_del_local_eid,
1851 'locator_set_name': ls_name,
1853 'eid_type': eid_type,
1855 'prefix_len': prefix_len,
1861 def lisp_eid_table_dump(self,
1869 self.papi.lisp_eid_table_dump,
1872 'prefix_length': prefix_length,
1874 'eid_type': eid_type,
1876 'filter': filter_opt,
1879 def lisp_remote_mapping(self,
1889 self.papi.lisp_add_del_remote_mapping,
1892 'eid_type': eid_type,
1894 'eid_len': eid_prefix_len,
1895 'rloc_num': rlocs_num,
1898 'is_src_dst': is_src_dst,
1901 def lisp_adjacency(self,
1910 self.papi.lisp_add_del_adjacency,
1914 'eid_type': eid_type,
1917 'leid_len': leid_len,
1918 'reid_len': reid_len,
1921 def lisp_adjacencies_get(self, vni=0):
1923 self.papi.lisp_adjacencies_get,
1928 def map_add_domain(self,
1941 self.papi.map_add_domain,
1943 'ip6_prefix': ip6_prefix,
1944 'ip6_prefix_len': ip6_prefix_len,
1945 'ip4_prefix': ip4_prefix,
1946 'ip4_prefix_len': ip4_prefix_len,
1948 'ip6_src_prefix_len': ip6_src_prefix_len,
1949 'ea_bits_len': ea_bits_len,
1950 'psid_offset': psid_offset,
1951 'psid_length': psid_length,
1952 'is_translation': is_translation,
1956 def gtpu_add_del_tunnel(
1962 mcast_sw_if_index=0xFFFFFFFF,
1964 decap_next_index=0xFFFFFFFF,
1968 :param is_add: (Default value = 1)
1969 :param is_ipv6: (Default value = 0)
1972 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
1973 :param encap_vrf_id: (Default value = 0)
1974 :param decap_next_index: (Default value = 0xFFFFFFFF)
1975 :param teid: (Default value = 0)
1978 return self.api(self.papi.gtpu_add_del_tunnel,
1981 'src_address': src_addr,
1982 'dst_address': dst_addr,
1983 'mcast_sw_if_index': mcast_sw_if_index,
1984 'encap_vrf_id': encap_vrf_id,
1985 'decap_next_index': decap_next_index,
1988 def vxlan_gpe_add_del_tunnel(
1992 mcast_sw_if_index=0xFFFFFFFF,
2003 :param is_add: (Default value = 1)
2004 :param is_ipv6: (Default value = 0)
2005 :param encap_vrf_id: (Default value = 0)
2006 :param decap_vrf_id: (Default value = 0)
2007 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2008 :param protocol: (Default value = 3)
2009 :param vni: (Default value = 0)
2012 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2017 'mcast_sw_if_index': mcast_sw_if_index,
2018 'encap_vrf_id': encap_vrf_id,
2019 'decap_vrf_id': decap_vrf_id,
2020 'protocol': protocol,