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):
556 :param admin_up_down:
560 return self.api(self.papi.sw_interface_set_flags,
561 {'sw_if_index': sw_if_index,
562 'admin_up_down': admin_up_down})
564 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
565 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
566 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
567 """Create subinterface
568 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
570 :param sub_id: param inner_vlan:
574 :param no_tags: (Default value = 0)
575 :param one_tag: (Default value = 0)
576 :param two_tags: (Default value = 0)
577 :param dot1ad: (Default value = 0)
578 :param exact_match: (Default value = 0)
579 :param default_sub: (Default value = 0)
580 :param outer_vlan_id_any: (Default value = 0)
581 :param inner_vlan_id_any: (Default value = 0)
585 self.papi.create_subif,
586 {'sw_if_index': sw_if_index,
590 'two_tags': two_tags,
592 'exact_match': exact_match,
593 'default_sub': default_sub,
594 'outer_vlan_id_any': outer_vlan_id_any,
595 'inner_vlan_id_any': inner_vlan_id_any,
596 'outer_vlan_id': outer_vlan,
597 'inner_vlan_id': inner_vlan})
599 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
600 """Create p2p ethernet subinterface
602 :param sw_if_index: main (parent) interface
603 :param remote_mac: client (remote) mac address
607 self.papi.p2p_ethernet_add,
608 {'parent_if_index': sw_if_index,
609 'remote_mac': remote_mac,
610 'subif_id': subif_id})
612 def delete_subif(self, sw_if_index):
613 """Delete subinterface
617 return self.api(self.papi.delete_subif,
618 {'sw_if_index': sw_if_index})
620 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
621 """Delete p2p ethernet subinterface
623 :param sw_if_index: main (parent) interface
624 :param remote_mac: client (remote) mac address
628 self.papi.p2p_ethernet_del,
629 {'parent_if_index': sw_if_index,
630 'remote_mac': remote_mac})
632 def create_vlan_subif(self, sw_if_index, vlan):
639 return self.api(self.papi.create_vlan_subif,
640 {'sw_if_index': sw_if_index,
643 def create_loopback(self, mac=''):
646 :param mac: (Optional)
648 return self.api(self.papi.create_loopback,
649 {'mac_address': mac})
651 def delete_loopback(self, sw_if_index):
652 return self.api(self.papi.delete_loopback,
653 {'sw_if_index': sw_if_index, })
655 def ip_add_del_route(
660 next_hop_sw_if_index=0xFFFFFFFF,
664 next_hop_n_out_labels=0,
665 next_hop_out_label_stack=[],
666 next_hop_via_label=MPLS_LABEL_INVALID,
667 create_vrf_if_needed=0,
669 is_resolve_attached=0,
670 classify_table_index=0xFFFFFFFF,
682 :param dst_address_length:
683 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
685 :param next_hop_address:
686 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
687 :param vrf_id: (Default value = 0)
688 :param lookup_in_vrf: (Default value = 0)
689 :param classify_table_index: (Default value = 0xFFFFFFFF)
690 :param create_vrf_if_needed: (Default value = 0)
691 :param is_add: (Default value = 1)
692 :param is_drop: (Default value = 0)
693 :param is_ipv6: (Default value = 0)
694 :param is_local: (Default value = 0)
695 :param is_classify: (Default value = 0)
696 :param is_multipath: (Default value = 0)
697 :param is_resolve_host: (Default value = 0)
698 :param is_resolve_attached: (Default value = 0)
699 :param not_last: (Default value = 0)
700 :param next_hop_weight: (Default value = 1)
705 self.papi.ip_add_del_route,
706 {'next_hop_sw_if_index': next_hop_sw_if_index,
707 'table_id': table_id,
708 'classify_table_index': classify_table_index,
709 'next_hop_table_id': next_hop_table_id,
710 'create_vrf_if_needed': create_vrf_if_needed,
713 'is_unreach': is_unreach,
714 'is_prohibit': is_prohibit,
716 'is_local': is_local,
717 'is_classify': is_classify,
718 'is_multipath': is_multipath,
719 'is_resolve_host': is_resolve_host,
720 'is_resolve_attached': is_resolve_attached,
721 'not_last': not_last,
722 'next_hop_weight': next_hop_weight,
723 'dst_address_length': dst_address_length,
724 'dst_address': dst_address,
725 'next_hop_address': next_hop_address,
726 'next_hop_n_out_labels': next_hop_n_out_labels,
727 'next_hop_via_label': next_hop_via_label,
728 'next_hop_out_label_stack': next_hop_out_label_stack})
730 def ip_fib_dump(self):
731 return self.api(self.papi.ip_fib_dump, {})
733 def ip6_fib_dump(self):
734 return self.api(self.papi.ip6_fib_dump, {})
736 def ip_neighbor_add_del(self,
745 """ Add neighbor MAC to IPv4 or IPv6 address.
750 :param is_add: (Default value = 1)
751 :param is_ipv6: (Default value = 0)
752 :param is_static: (Default value = 0)
753 :param is_no_adj_fib: (Default value = 0)
757 self.papi.ip_neighbor_add_del,
758 {'sw_if_index': sw_if_index,
761 'is_static': is_static,
762 'is_no_adj_fib': is_no_adj_fib,
763 'mac_address': mac_address,
764 'dst_address': dst_address
768 def ip_neighbor_dump(self,
771 """ Return IP neighbor dump.
774 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
778 self.papi.ip_neighbor_dump,
780 'sw_if_index': sw_if_index
784 def proxy_arp_add_del(self,
789 """ Config Proxy Arp Range.
791 :param low_address: Start address in the rnage to Proxy for
792 :param hi_address: End address in the rnage to Proxy for
793 :param vrf_id: The VRF/table in which to proxy
797 self.papi.proxy_arp_add_del,
800 'low_address': low_address,
801 'hi_address': hi_address,
805 def proxy_arp_intfc_enable_disable(self,
808 """ Enable/Disable an interface for proxy ARP requests
810 :param sw_if_index: Interface
811 :param enable_disable: Enable/Disable
815 self.papi.proxy_arp_intfc_enable_disable,
816 {'sw_if_index': sw_if_index,
817 'enable_disable': is_enable
825 """ Reset VRF (remove all routes etc.) request.
827 :param int vrf_id: ID of the FIB table / VRF to reset.
828 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
842 """ Reset VRF (remove all routes etc.) request.
844 :param int vrf_id: ID of the FIB table / VRF to reset.
845 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
860 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
869 def sw_interface_span_enable_disable(
870 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
873 :param sw_if_index_from:
874 :param sw_if_index_to:
878 return self.api(self.papi.sw_interface_span_enable_disable,
879 {'sw_if_index_from': sw_if_index_from,
880 'sw_if_index_to': sw_if_index_to,
885 def gre_tunnel_add_del(self,
896 :param outer_fib_id: (Default value = 0)
897 :param is_add: (Default value = 1)
898 :param is_ipv6: (Default value = 0)
899 :param is_teb: (Default value = 0)
903 self.papi.gre_add_del_tunnel,
907 'src_address': src_address,
908 'dst_address': dst_address,
909 'outer_fib_id': outer_fib_id}
912 def mpls_fib_dump(self):
913 return self.api(self.papi.mpls_fib_dump, {})
915 def mpls_route_add_del(
921 next_hop_sw_if_index=0xFFFFFFFF,
925 next_hop_n_out_labels=0,
926 next_hop_out_label_stack=[],
927 next_hop_via_label=MPLS_LABEL_INVALID,
928 create_vrf_if_needed=0,
930 is_resolve_attached=0,
937 classify_table_index=0xFFFFFFFF,
942 :param dst_address_length:
943 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
945 :param next_hop_address:
946 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
947 :param vrf_id: (Default value = 0)
948 :param lookup_in_vrf: (Default value = 0)
949 :param classify_table_index: (Default value = 0xFFFFFFFF)
950 :param create_vrf_if_needed: (Default value = 0)
951 :param is_add: (Default value = 1)
952 :param is_drop: (Default value = 0)
953 :param is_ipv6: (Default value = 0)
954 :param is_local: (Default value = 0)
955 :param is_classify: (Default value = 0)
956 :param is_multipath: (Default value = 0)
957 :param is_multicast: (Default value = 0)
958 :param is_resolve_host: (Default value = 0)
959 :param is_resolve_attached: (Default value = 0)
960 :param not_last: (Default value = 0)
961 :param next_hop_weight: (Default value = 1)
966 self.papi.mpls_route_add_del,
969 'mr_table_id': table_id,
970 'mr_classify_table_index': classify_table_index,
971 'mr_create_table_if_needed': create_vrf_if_needed,
973 'mr_is_classify': is_classify,
974 'mr_is_multipath': is_multipath,
975 'mr_is_multicast': is_multicast,
976 'mr_is_resolve_host': is_resolve_host,
977 'mr_is_resolve_attached': is_resolve_attached,
978 'mr_is_interface_rx': is_interface_rx,
979 'mr_is_rpf_id': is_rpf_id,
980 'mr_next_hop_proto': next_hop_proto,
981 'mr_next_hop_weight': next_hop_weight,
982 'mr_next_hop': next_hop_address,
983 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
984 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
985 'mr_next_hop_table_id': next_hop_table_id,
986 'mr_next_hop_via_label': next_hop_via_label,
987 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
989 def mpls_ip_bind_unbind(
997 create_vrf_if_needed=0,
1002 self.papi.mpls_ip_bind_unbind,
1003 {'mb_mpls_table_id': table_id,
1005 'mb_ip_table_id': ip_table_id,
1006 'mb_create_table_if_needed': create_vrf_if_needed,
1007 'mb_is_bind': is_bind,
1008 'mb_is_ip4': is_ip4,
1009 'mb_address_length': dst_address_length,
1010 'mb_address': dst_address})
1012 def mpls_tunnel_add_del(
1015 next_hop_proto_is_ip4,
1017 next_hop_sw_if_index=0xFFFFFFFF,
1018 next_hop_table_id=0,
1020 next_hop_n_out_labels=0,
1021 next_hop_out_label_stack=[],
1022 next_hop_via_label=MPLS_LABEL_INVALID,
1023 create_vrf_if_needed=0,
1029 :param dst_address_length:
1030 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1032 :param next_hop_address:
1033 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1034 :param vrf_id: (Default value = 0)
1035 :param lookup_in_vrf: (Default value = 0)
1036 :param classify_table_index: (Default value = 0xFFFFFFFF)
1037 :param create_vrf_if_needed: (Default value = 0)
1038 :param is_add: (Default value = 1)
1039 :param is_drop: (Default value = 0)
1040 :param is_ipv6: (Default value = 0)
1041 :param is_local: (Default value = 0)
1042 :param is_classify: (Default value = 0)
1043 :param is_multipath: (Default value = 0)
1044 :param is_resolve_host: (Default value = 0)
1045 :param is_resolve_attached: (Default value = 0)
1046 :param next_hop_weight: (Default value = 1)
1047 :param is_multicast: (Default value = 0)
1051 self.papi.mpls_tunnel_add_del,
1052 {'mt_sw_if_index': tun_sw_if_index,
1053 'mt_is_add': is_add,
1054 'mt_l2_only': l2_only,
1055 'mt_is_multicast': is_multicast,
1056 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1057 'mt_next_hop_weight': next_hop_weight,
1058 'mt_next_hop': next_hop_address,
1059 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1060 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1061 'mt_next_hop_table_id': next_hop_table_id,
1062 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1064 def nat44_interface_add_del_feature(
1069 """Enable/disable NAT44 feature on the interface
1071 :param sw_if_index: Software index of the interface
1072 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1073 :param is_add: 1 if add, 0 if delete (Default value = 1)
1076 self.papi.nat44_interface_add_del_feature,
1078 'is_inside': is_inside,
1079 'sw_if_index': sw_if_index})
1081 def nat44_interface_add_del_output_feature(
1086 """Enable/disable NAT44 output feature on the interface
1088 :param sw_if_index: Software index of the interface
1089 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1090 :param is_add: 1 if add, 0 if delete (Default value = 1)
1093 self.papi.nat44_interface_add_del_output_feature,
1095 'is_inside': is_inside,
1096 'sw_if_index': sw_if_index})
1098 def nat44_add_del_static_mapping(
1102 external_sw_if_index=0xFFFFFFFF,
1109 """Add/delete NAT44 static mapping
1111 :param local_ip: Local IP address
1112 :param external_ip: External IP address
1113 :param external_sw_if_index: External interface instead of IP address
1114 :param local_port: Local port number (Default value = 0)
1115 :param external_port: External port number (Default value = 0)
1116 :param addr_only: 1 if address only mapping, 0 if address and port
1117 :param vrf_id: VRF ID
1118 :param protocol: IP protocol (Default value = 0)
1119 :param is_add: 1 if add, 0 if delete (Default value = 1)
1122 self.papi.nat44_add_del_static_mapping,
1124 'addr_only': addr_only,
1125 'local_ip_address': local_ip,
1126 'external_ip_address': external_ip,
1127 'local_port': local_port,
1128 'external_port': external_port,
1129 'external_sw_if_index': external_sw_if_index,
1131 'protocol': protocol})
1133 def nat44_add_del_address_range(
1139 """Add/del NAT44 address range
1141 :param first_ip_address: First IP address
1142 :param last_ip_address: Last IP address
1143 :param vrf_id: VRF id for the address range
1144 :param is_add: 1 if add, 0 if delete (Default value = 1)
1147 self.papi.nat44_add_del_address_range,
1148 {'first_ip_address': first_ip_address,
1149 'last_ip_address': last_ip_address,
1153 def nat44_address_dump(self):
1154 """Dump NAT44 addresses
1155 :return: Dictionary of NAT44 addresses
1157 return self.api(self.papi.nat44_address_dump, {})
1159 def nat44_interface_dump(self):
1160 """Dump interfaces with NAT44 feature
1161 :return: Dictionary of interfaces with NAT44 feature
1163 return self.api(self.papi.nat44_interface_dump, {})
1165 def nat44_interface_output_feature_dump(self):
1166 """Dump interfaces with NAT44 output feature
1167 :return: Dictionary of interfaces with NAT44 output feature
1169 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1171 def nat44_static_mapping_dump(self):
1172 """Dump NAT44 static mappings
1173 :return: Dictionary of NAT44 static mappings
1175 return self.api(self.papi.nat44_static_mapping_dump, {})
1177 def nat_show_config(self):
1178 """Show NAT plugin config
1179 :return: NAT plugin config parameters
1181 return self.api(self.papi.nat_show_config, {})
1183 def nat44_add_interface_addr(
1187 """Add/del NAT44 address from interface
1189 :param sw_if_index: Software index of the interface
1190 :param is_add: 1 if add, 0 if delete (Default value = 1)
1192 return self.api(self.papi.nat44_add_del_interface_addr,
1193 {'is_add': is_add, 'sw_if_index': sw_if_index})
1195 def nat44_interface_addr_dump(self):
1196 """Dump NAT44 addresses interfaces
1197 :return: Dictionary of NAT44 addresses interfaces
1199 return self.api(self.papi.nat44_interface_addr_dump, {})
1206 """Enable/disable NAT IPFIX logging
1208 :param domain_id: Observation domain ID (Default value = 1)
1209 :param src_port: Source port number (Default value = 4739)
1210 :param enable: 1 if enable, 0 if disable (Default value = 1)
1213 self.papi.nat_ipfix_enable_disable,
1214 {'domain_id': domain_id,
1215 'src_port': src_port,
1218 def nat44_user_session_dump(
1222 """Dump NAT44 user's sessions
1224 :param ip_address: ip adress of the user to be dumped
1225 :param cpu_index: cpu_index on which the user is
1226 :param vrf_id: VRF ID
1227 :return: Dictionary of S-NAT sessions
1230 self.papi.nat44_user_session_dump,
1231 {'ip_address': ip_address,
1234 def nat44_user_dump(self):
1237 :return: Dictionary of NAT44 users
1239 return self.api(self.papi.nat44_user_dump, {})
1241 def nat_det_add_del_map(
1248 """Add/delete deterministic NAT mapping
1250 :param is_add - 1 if add, 0 if delete
1251 :param in_addr - inside IP address
1252 :param in_plen - inside IP address prefix length
1253 :param out_addr - outside IP address
1254 :param out_plen - outside IP address prefix length
1257 self.papi.nat_det_add_del_map,
1262 'out_addr': out_addr,
1263 'out_plen': out_plen})
1265 def nat_det_forward(
1268 """Get outside address and port range from inside address
1270 :param in_addr - inside IP address
1273 self.papi.nat_det_forward,
1274 {'in_addr': in_addr,
1277 def nat_det_reverse(
1281 """Get inside address from outside address and port
1283 :param out_addr - outside IP address
1284 :param out_port - outside port
1287 self.papi.nat_det_reverse,
1288 {'out_addr': out_addr,
1289 'out_port': out_port})
1291 def nat_det_map_dump(self):
1292 """Dump deterministic NAT mappings
1294 :return: Dictionary of deterministic NAT mappings
1296 return self.api(self.papi.nat_det_map_dump, {})
1298 def nat_det_set_timeouts(
1301 tcp_established=7440,
1304 """Set values of timeouts for deterministic NAT (in seconds)
1306 :param udp - UDP timeout (Default value = 300)
1307 :param tcp_established - TCP established timeout (Default value = 7440)
1308 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1309 :param icmp - ICMP timeout (Default value = 60)
1312 self.papi.nat_det_set_timeouts,
1314 'tcp_established': tcp_established,
1315 'tcp_transitory': tcp_transitory,
1318 def nat_det_get_timeouts(self):
1319 """Get values of timeouts for deterministic NAT
1321 :return: Timeouts for deterministic NAT (in seconds)
1323 return self.api(self.papi.nat_det_get_timeouts, {})
1325 def nat_det_close_session_out(
1331 """Close deterministic NAT session using outside address and port
1333 :param out_addr - outside IP address
1334 :param out_port - outside port
1335 :param ext_addr - external host IP address
1336 :param ext_port - external host port
1339 self.papi.nat_det_close_session_out,
1340 {'out_addr': out_addr,
1341 'out_port': out_port,
1342 'ext_addr': ext_addr,
1343 'ext_port': ext_port})
1345 def nat_det_close_session_in(
1351 """Close deterministic NAT session using inside address and port
1353 :param in_addr - inside IP address
1354 :param in_port - inside port
1355 :param ext_addr - external host IP address
1356 :param ext_port - external host port
1359 self.papi.nat_det_close_session_in,
1360 {'in_addr': in_addr,
1362 'ext_addr': ext_addr,
1363 'ext_port': ext_port,
1366 def nat_det_session_dump(
1369 """Dump deterministic NAT sessions belonging to a user
1371 :param user_addr - inside IP address of the user
1372 :return: Dictionary of deterministic NAT sessions
1375 self.papi.nat_det_session_dump,
1377 'user_addr': user_addr})
1379 def nat64_add_del_pool_addr_range(
1385 """Add/del address range to NAT64 pool
1387 :param start_addr: First IP address
1388 :param end_addr: Last IP address
1389 :param vrf_id: VRF id for the address range
1390 :param is_add: 1 if add, 0 if delete (Default value = 1)
1393 self.papi.nat64_add_del_pool_addr_range,
1394 {'start_addr': start_addr,
1395 'end_addr': end_addr,
1399 def nat64_pool_addr_dump(self):
1400 """Dump NAT64 pool addresses
1401 :return: Dictionary of NAT64 pool addresses
1403 return self.api(self.papi.nat64_pool_addr_dump, {})
1405 def nat64_add_del_interface(
1410 """Enable/disable NAT64 feature on the interface
1411 :param sw_if_index: Index of the interface
1412 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1413 :param is_add: 1 if add, 0 if delete (Default value = 1)
1416 self.papi.nat64_add_del_interface,
1417 {'sw_if_index': sw_if_index,
1418 'is_inside': is_inside,
1421 def nat64_interface_dump(self):
1422 """Dump interfaces with NAT64 feature
1423 :return: Dictionary of interfaces with NAT64 feature
1425 return self.api(self.papi.nat64_interface_dump, {})
1427 def nat64_add_del_static_bib(
1436 """Add/delete S-NAT static BIB entry
1438 :param in_ip: Inside IPv6 address
1439 :param out_ip: Outside IPv4 address
1440 :param in_port: Inside port number
1441 :param out_port: Outside port number
1442 :param protocol: IP protocol
1443 :param vrf_id: VRF ID (Default value = 0)
1444 :param is_add: 1 if add, 0 if delete (Default value = 1)
1447 self.papi.nat64_add_del_static_bib,
1456 def nat64_bib_dump(self, protocol=255):
1459 :param protocol: IP protocol (Default value = 255, all BIBs)
1460 :returns: Dictionary of NAT64 BIB entries
1462 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1464 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1465 tcp_incoming_syn=6):
1466 """Set values of timeouts for NAT64 (in seconds)
1468 :param udpi: UDP timeout (Default value = 300)
1469 :param icmp: ICMP timeout (Default value = 60)
1470 :param tcp_trans: TCP transitory timeout (Default value = 240)
1471 :param tcp_est: TCP established timeout (Default value = 7440)
1472 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1475 self.papi.nat64_set_timeouts,
1478 'tcp_trans': tcp_trans,
1480 'tcp_incoming_syn': tcp_incoming_syn})
1482 def nat64_get_timeouts(self):
1483 """Get values of timeouts for NAT64
1485 :return: Timeouts for NAT64 (in seconds)
1487 return self.api(self.papi.nat64_get_timeouts, {})
1489 def nat64_st_dump(self, protocol=255):
1490 """Dump NAT64 session table
1492 :param protocol: IP protocol (Default value = 255, all STs)
1493 :returns: Dictionary of NAT64 sesstion table entries
1495 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1497 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1498 """Add/del NAT64 prefix
1500 :param prefix: NAT64 prefix
1501 :param plen: NAT64 prefix length
1502 :param vrf_id: VRF id of tenant (Default 0)
1503 :param is_add: 1 if add, 0 if delete (Default value = 1)
1506 self.papi.nat64_add_del_prefix,
1512 def nat64_prefix_dump(self):
1513 """Dump NAT64 prefix
1515 :returns: Dictionary of NAT64 prefixes
1517 return self.api(self.papi.nat64_prefix_dump, {})
1519 def control_ping(self):
1520 self.api(self.papi.control_ping)
1522 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1523 detect_mult, local_addr, peer_addr, is_ipv6=0,
1524 bfd_key_id=None, conf_key_id=None):
1525 if bfd_key_id is None:
1526 return self.api(self.papi.bfd_udp_add,
1528 'sw_if_index': sw_if_index,
1529 'desired_min_tx': desired_min_tx,
1530 'required_min_rx': required_min_rx,
1531 'local_addr': local_addr,
1532 'peer_addr': peer_addr,
1534 'detect_mult': detect_mult,
1537 return self.api(self.papi.bfd_udp_add,
1539 'sw_if_index': sw_if_index,
1540 'desired_min_tx': desired_min_tx,
1541 'required_min_rx': required_min_rx,
1542 'local_addr': local_addr,
1543 'peer_addr': peer_addr,
1545 'detect_mult': detect_mult,
1546 'is_authenticated': 1,
1547 'bfd_key_id': bfd_key_id,
1548 'conf_key_id': conf_key_id,
1551 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1552 detect_mult, local_addr, peer_addr, is_ipv6=0):
1553 return self.api(self.papi.bfd_udp_mod,
1555 'sw_if_index': sw_if_index,
1556 'desired_min_tx': desired_min_tx,
1557 'required_min_rx': required_min_rx,
1558 'local_addr': local_addr,
1559 'peer_addr': peer_addr,
1561 'detect_mult': detect_mult,
1564 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1565 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1567 return self.api(self.papi.bfd_udp_auth_activate,
1569 'sw_if_index': sw_if_index,
1570 'local_addr': local_addr,
1571 'peer_addr': peer_addr,
1573 'is_delayed': 1 if is_delayed else 0,
1574 'bfd_key_id': bfd_key_id,
1575 'conf_key_id': conf_key_id,
1578 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1579 is_ipv6=0, is_delayed=False):
1580 return self.api(self.papi.bfd_udp_auth_deactivate,
1582 'sw_if_index': sw_if_index,
1583 'local_addr': local_addr,
1584 'peer_addr': peer_addr,
1586 'is_delayed': 1 if is_delayed else 0,
1589 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1590 return self.api(self.papi.bfd_udp_del,
1592 'sw_if_index': sw_if_index,
1593 'local_addr': local_addr,
1594 'peer_addr': peer_addr,
1598 def bfd_udp_session_dump(self):
1599 return self.api(self.papi.bfd_udp_session_dump, {})
1601 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1602 peer_addr, is_ipv6=0):
1603 return self.api(self.papi.bfd_udp_session_set_flags, {
1604 'admin_up_down': admin_up_down,
1605 'sw_if_index': sw_if_index,
1606 'local_addr': local_addr,
1607 'peer_addr': peer_addr,
1611 def want_bfd_events(self, enable_disable=1):
1612 return self.api(self.papi.want_bfd_events, {
1613 'enable_disable': enable_disable,
1617 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1618 return self.api(self.papi.bfd_auth_set_key, {
1619 'conf_key_id': conf_key_id,
1620 'auth_type': auth_type,
1622 'key_len': len(key),
1625 def bfd_auth_del_key(self, conf_key_id):
1626 return self.api(self.papi.bfd_auth_del_key, {
1627 'conf_key_id': conf_key_id,
1630 def bfd_auth_keys_dump(self):
1631 return self.api(self.papi.bfd_auth_keys_dump, {})
1633 def bfd_udp_set_echo_source(self, sw_if_index):
1634 return self.api(self.papi.bfd_udp_set_echo_source,
1635 {'sw_if_index': sw_if_index})
1637 def bfd_udp_del_echo_source(self):
1638 return self.api(self.papi.bfd_udp_del_echo_source, {})
1640 def classify_add_del_table(
1645 table_index=0xFFFFFFFF,
1647 memory_size=2097152,
1649 next_table_index=0xFFFFFFFF,
1650 miss_next_index=0xFFFFFFFF,
1651 current_data_flag=0,
1652 current_data_offset=0):
1656 :param match_n_vectors: (Default value = 1)
1657 :param table_index: (Default value = 0xFFFFFFFF)
1658 :param nbuckets: (Default value = 2)
1659 :param memory_size: (Default value = 2097152)
1660 :param skip_n_vectors: (Default value = 0)
1661 :param next_table_index: (Default value = 0xFFFFFFFF)
1662 :param miss_next_index: (Default value = 0xFFFFFFFF)
1663 :param current_data_flag: (Default value = 0)
1664 :param current_data_offset: (Default value = 0)
1668 self.papi.classify_add_del_table,
1670 'table_index': table_index,
1671 'nbuckets': nbuckets,
1672 'memory_size': memory_size,
1673 'skip_n_vectors': skip_n_vectors,
1674 'match_n_vectors': match_n_vectors,
1675 'next_table_index': next_table_index,
1676 'miss_next_index': miss_next_index,
1677 'current_data_flag': current_data_flag,
1678 'current_data_offset': current_data_offset,
1681 def classify_add_del_session(
1686 opaque_index=0xFFFFFFFF,
1687 hit_next_index=0xFFFFFFFF,
1695 :param opaque_index: (Default value = 0xFFFFFFFF)
1696 :param hit_next_index: (Default value = 0xFFFFFFFF)
1697 :param advance: (Default value = 0)
1698 :param action: (Default value = 0)
1699 :param metadata: (Default value = 0)
1703 self.papi.classify_add_del_session,
1705 'table_index': table_index,
1706 'hit_next_index': hit_next_index,
1707 'opaque_index': opaque_index,
1710 'metadata': metadata,
1713 def input_acl_set_interface(
1717 ip4_table_index=0xFFFFFFFF,
1718 ip6_table_index=0xFFFFFFFF,
1719 l2_table_index=0xFFFFFFFF):
1723 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1724 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1725 :param l2_table_index: (Default value = 0xFFFFFFFF)
1729 self.papi.input_acl_set_interface,
1730 {'sw_if_index': sw_if_index,
1731 'ip4_table_index': ip4_table_index,
1732 'ip6_table_index': ip6_table_index,
1733 'l2_table_index': l2_table_index,
1736 def set_ipfix_exporter(
1743 collector_port=4739,
1746 self.papi.set_ipfix_exporter,
1748 'collector_address': collector_address,
1749 'collector_port': collector_port,
1750 'src_address': src_address,
1752 'path_mtu': path_mtu,
1753 'template_interval': template_interval,
1754 'udp_checksum': udp_checksum,
1757 def dhcp_proxy_config(self,
1765 self.papi.dhcp_proxy_config,
1767 'rx_vrf_id': rx_table_id,
1768 'server_vrf_id': server_table_id,
1771 'dhcp_server': dhcp_server,
1772 'dhcp_src_address': dhcp_src_address,
1775 def dhcp_proxy_set_vss(self,
1782 self.papi.dhcp_proxy_set_vss,
1791 def dhcp_client(self,
1796 want_dhcp_events=0):
1798 self.papi.dhcp_client_config,
1800 'sw_if_index': sw_if_index,
1801 'hostname': hostname,
1802 'client_id': client_id,
1804 'want_dhcp_event': want_dhcp_events,
1808 def ip_mroute_add_del(self,
1813 next_hop_sw_if_index,
1817 create_vrf_if_needed=0,
1824 self.papi.ip_mroute_add_del,
1825 {'next_hop_sw_if_index': next_hop_sw_if_index,
1826 'entry_flags': e_flags,
1827 'itf_flags': i_flags,
1828 'table_id': table_id,
1830 'create_vrf_if_needed': create_vrf_if_needed,
1833 'is_local': is_local,
1834 'grp_address_length': grp_address_length,
1835 'grp_address': grp_address,
1836 'src_address': src_address})
1838 def mfib_signal_dump(self):
1839 return self.api(self.papi.mfib_signal_dump, {})
1841 def ip_mfib_dump(self):
1842 return self.api(self.papi.ip_mfib_dump, {})
1844 def lisp_enable_disable(self, is_enabled):
1846 self.papi.lisp_enable_disable,
1848 'is_en': is_enabled,
1851 def lisp_locator_set(self,
1855 self.papi.lisp_add_del_locator_set,
1858 'locator_set_name': ls_name
1861 def lisp_locator_set_dump(self):
1862 return self.api(self.papi.lisp_locator_set_dump, {})
1864 def lisp_locator(self,
1871 self.papi.lisp_add_del_locator,
1874 'locator_set_name': ls_name,
1875 'sw_if_index': sw_if_index,
1876 'priority': priority,
1880 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1882 self.papi.lisp_locator_dump,
1884 'is_index_set': is_index_set,
1886 'ls_index': ls_index,
1889 def lisp_local_mapping(self,
1899 self.papi.lisp_add_del_local_eid,
1901 'locator_set_name': ls_name,
1903 'eid_type': eid_type,
1905 'prefix_len': prefix_len,
1911 def lisp_eid_table_dump(self,
1919 self.papi.lisp_eid_table_dump,
1922 'prefix_length': prefix_length,
1924 'eid_type': eid_type,
1926 'filter': filter_opt,
1929 def lisp_remote_mapping(self,
1939 self.papi.lisp_add_del_remote_mapping,
1942 'eid_type': eid_type,
1944 'eid_len': eid_prefix_len,
1945 'rloc_num': rlocs_num,
1948 'is_src_dst': is_src_dst,
1951 def lisp_adjacency(self,
1960 self.papi.lisp_add_del_adjacency,
1964 'eid_type': eid_type,
1967 'leid_len': leid_len,
1968 'reid_len': reid_len,
1971 def lisp_adjacencies_get(self, vni=0):
1973 self.papi.lisp_adjacencies_get,
1978 def map_add_domain(self,
1991 self.papi.map_add_domain,
1993 'ip6_prefix': ip6_prefix,
1994 'ip6_prefix_len': ip6_prefix_len,
1995 'ip4_prefix': ip4_prefix,
1996 'ip4_prefix_len': ip4_prefix_len,
1998 'ip6_src_prefix_len': ip6_src_prefix_len,
1999 'ea_bits_len': ea_bits_len,
2000 'psid_offset': psid_offset,
2001 'psid_length': psid_length,
2002 'is_translation': is_translation,
2006 def gtpu_add_del_tunnel(
2012 mcast_sw_if_index=0xFFFFFFFF,
2014 decap_next_index=0xFFFFFFFF,
2018 :param is_add: (Default value = 1)
2019 :param is_ipv6: (Default value = 0)
2022 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2023 :param encap_vrf_id: (Default value = 0)
2024 :param decap_next_index: (Default value = 0xFFFFFFFF)
2025 :param teid: (Default value = 0)
2028 return self.api(self.papi.gtpu_add_del_tunnel,
2031 'src_address': src_addr,
2032 'dst_address': dst_addr,
2033 'mcast_sw_if_index': mcast_sw_if_index,
2034 'encap_vrf_id': encap_vrf_id,
2035 'decap_next_index': decap_next_index,
2038 def vxlan_gpe_add_del_tunnel(
2042 mcast_sw_if_index=0xFFFFFFFF,
2053 :param is_add: (Default value = 1)
2054 :param is_ipv6: (Default value = 0)
2055 :param encap_vrf_id: (Default value = 0)
2056 :param decap_vrf_id: (Default value = 0)
2057 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2058 :param protocol: (Default value = 3)
2059 :param vni: (Default value = 0)
2062 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2067 'mcast_sw_if_index': mcast_sw_if_index,
2068 'encap_vrf_id': encap_vrf_id,
2069 'decap_vrf_id': decap_vrf_id,
2070 'protocol': protocol,
2073 def pppoe_add_del_session(
2083 :param is_add: (Default value = 1)
2084 :param is_ipv6: (Default value = 0)
2086 :param session_id: (Default value = 0)
2088 :param decap_vrf_id: (Default value = 0)
2091 return self.api(self.papi.pppoe_add_del_session,
2094 'session_id': session_id,
2095 'client_ip': client_ip,
2096 'decap_vrf_id': decap_vrf_id,
2097 'client_mac': client_mac})
2099 def sr_localsid_add_del(self,
2105 sw_if_index=0xFFFFFFFF,
2109 """ Add/del IPv6 SR local-SID.
2111 :param localsid_addr:
2112 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2113 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2115 :param is_del: (Default value = 0)
2116 :param end_psp: (Default value = 0)
2117 :param sw_if_index: (Default value = 0xFFFFFFFF)
2118 :param vlan_index: (Default value = 0)
2119 :param fib_table: (Default value = 0)
2122 self.papi.sr_localsid_add_del,
2124 'localsid_addr': localsid_addr,
2126 'behavior': behavior,
2127 'sw_if_index': sw_if_index,
2128 'vlan_index': vlan_index,
2129 'fib_table': fib_table,
2144 :param bsid_addr: bindingSID of the SR Policy
2145 :param weight: weight of the sid list. optional. (default: 1)
2146 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2148 :param type: type/behavior of the SR policy. (default or spray) \
2150 :param fib_table: VRF where to install the FIB entry for the BSID \
2152 :param n_segments: number of segments \
2154 :param segments: a vector of IPv6 address composing the segment list \
2158 self.papi.sr_policy_add,
2159 {'bsid_addr': bsid_addr,
2161 'is_encap': is_encap,
2163 'fib_table': fib_table,
2164 'n_segments': n_segments,
2165 'segments': segments
2174 :param bsid: bindingSID of the SR Policy
2175 :param sr_policy_index: index of the sr policy (default: 0)
2178 self.papi.sr_policy_del,
2179 {'bsid_addr': bsid_addr,
2180 'sr_policy_index': sr_policy_index
2183 def sr_steering_add_del(
2194 Steer traffic L2 and L3 traffic through a given SR policy
2196 :param is_del: delete or add
2197 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2198 :param sr_policy: is the index of the SR Policy (alt to bsid)
2199 :param table_id: is the VRF where to install the FIB entry for the BSID
2200 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2201 :param mask_width: is the mask for L3 traffic type
2202 :param sw_if_index: is the incoming interface for L2 traffic
2203 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2206 self.papi.sr_steering_add_del,
2208 'bsid_addr': bsid_addr,
2209 'sr_policy_index': sr_policy_index,
2210 'table_id': table_id,
2211 'prefix_addr': prefix_addr,
2212 'mask_width': mask_width,
2213 'sw_if_index': sw_if_index,
2214 'traffic_type': traffic_type