5 from collections import deque
7 # Sphinx creates auto-generated documentation by importing the python source
8 # files and collecting the docstrings from them. The NO_VPP_PAPI flag allows
9 # the vpp_papi_provider.py file to be importable without having to build
10 # the whole vpp api if the user only wishes to generate the test documentation.
13 no_vpp_papi = os.getenv("NO_VPP_PAPI")
14 if no_vpp_papi == "1":
20 from vpp_papi import VPP
22 # from vnet/vnet/mpls/mpls_types.h
23 MPLS_IETF_MAX_LABEL = 0xfffff
24 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
39 class UnexpectedApiReturnValueError(Exception):
40 """ exception raised when the API return value is unexpected """
44 class VppPapiProvider(object):
45 """VPP-api provider using vpp-papi
47 @property hook: hook object providing before and after api/cli hooks
50 _zero, _negative = range(2)
52 def __init__(self, name, shm_prefix, test_class):
53 self.hook = Hook("vpp-papi-provider")
55 self.shm_prefix = shm_prefix
56 self.test_class = test_class
57 self._expect_api_retval = self._zero
58 self._expect_stack = []
61 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
62 for root, dirnames, filenames in os.walk(install_dir):
63 for filename in fnmatch.filter(filenames, '*.api.json'):
64 jsonfiles.append(os.path.join(root, filename))
66 self.vpp = VPP(jsonfiles, logger=test_class.logger)
67 self._events = deque()
72 def expect_negative_api_retval(self):
73 """ Expect API failure """
74 self._expect_stack.append(self._expect_api_retval)
75 self._expect_api_retval = self._negative
78 def expect_zero_api_retval(self):
79 """ Expect API success """
80 self._expect_stack.append(self._expect_api_retval)
81 self._expect_api_retval = self._zero
84 def __exit__(self, exc_type, exc_value, traceback):
85 self._expect_api_retval = self._expect_stack.pop()
87 def register_hook(self, hook):
88 """Replace hook registration with new hook
95 def collect_events(self):
96 """ Collect all events from the internal queue and clear the queue. """
98 self._events = deque()
101 def wait_for_event(self, timeout, name=None):
102 """ Wait for and return next event. """
104 self.test_class.logger.debug("Expecting event '%s' within %ss",
107 self.test_class.logger.debug("Expecting event within %ss",
110 self.test_class.logger.debug("Not waiting, event already queued")
111 limit = time.time() + timeout
112 while time.time() < limit:
114 e = self._events.popleft()
115 if name and type(e).__name__ != name:
117 "Unexpected event received: %s, expected: %s" %
118 (type(e).__name__, name))
119 self.test_class.logger.debug("Returning event %s:%s" %
122 time.sleep(0) # yield
123 raise Exception("Event did not occur within timeout")
125 def __call__(self, name, event):
126 """ Enqueue event in the internal event queue. """
127 # FIXME use the name instead of relying on type(e).__name__ ?
128 # FIXME #2 if this throws, it is eaten silently, Ole?
129 self.test_class.logger.debug("New event: %s: %s" % (name, event))
130 self._events.append(event)
133 """Connect the API to VPP"""
134 self.vpp.connect(self.name, self.shm_prefix)
135 self.papi = self.vpp.api
136 self.vpp.register_event_callback(self)
138 def disconnect(self):
139 """Disconnect the API from VPP"""
140 self.vpp.disconnect()
142 def api(self, api_fn, api_args, expected_retval=0):
143 """ Call API function and check it's return value.
144 Call the appropriate hooks before and after the API call
146 :param api_fn: API function to call
147 :param api_args: tuple of API function arguments
148 :param expected_retval: Expected return value (Default value = 0)
149 :returns: reply from the API
152 self.hook.before_api(api_fn.__name__, api_args)
153 reply = api_fn(**api_args)
154 if self._expect_api_retval == self._negative:
155 if hasattr(reply, 'retval') and reply.retval >= 0:
156 msg = "API call passed unexpectedly: expected negative "\
157 "return value instead of %d in %s" % \
158 (reply.retval, repr(reply))
159 self.test_class.logger.info(msg)
160 raise UnexpectedApiReturnValueError(msg)
161 elif self._expect_api_retval == self._zero:
162 if hasattr(reply, 'retval') and reply.retval != expected_retval:
163 msg = "API call failed, expected %d return value instead "\
164 "of %d in %s" % (expected_retval, reply.retval,
166 self.test_class.logger.info(msg)
167 raise UnexpectedApiReturnValueError(msg)
169 raise Exception("Internal error, unexpected value for "
170 "self._expect_api_retval %s" %
171 self._expect_api_retval)
172 self.hook.after_api(api_fn.__name__, api_args)
176 """ Execute a CLI, calling the before/after hooks appropriately.
178 :param cli: CLI to execute
182 self.hook.before_cli(cli)
184 r = self.papi.cli_inband(length=len(cli), cmd=cli)
185 self.hook.after_cli(cli)
186 if hasattr(r, 'reply'):
187 return r.reply.decode().rstrip('\x00')
189 def ppcli(self, cli):
190 """ Helper method to print CLI command in case of info logging level.
192 :param cli: CLI to execute
195 return cli + "\n" + str(self.cli(cli))
197 def _convert_mac(self, mac):
198 return int(mac.replace(":", ""), 16) << 16
200 def show_version(self):
202 return self.api(self.papi.show_version, {})
204 def pg_create_interface(self, pg_index):
210 return self.api(self.papi.pg_create_interface,
211 {"interface_id": pg_index})
213 def sw_interface_dump(self, filter=None):
216 :param filter: (Default value = None)
219 if filter is not None:
220 args = {"name_filter_valid": 1, "name_filter": filter}
223 return self.api(self.papi.sw_interface_dump, args)
225 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
226 """ Set the IPvX Table-id for the Interface
233 return self.api(self.papi.sw_interface_set_table,
234 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
237 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
238 is_ipv6=0, is_add=1, del_all=0):
241 :param addr: param is_ipv6: (Default value = 0)
244 :param is_ipv6: (Default value = 0)
245 :param is_add: (Default value = 1)
246 :param del_all: (Default value = 0)
249 return self.api(self.papi.sw_interface_add_del_address,
250 {'sw_if_index': sw_if_index,
254 'address_length': addr_len,
257 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
259 """ Set the Interface to be unnumbered
261 :param is_add: (Default value = 1)
262 :param sw_if_index - interface That will be unnumbered
263 :param ip_sw_if_index - interface with an IP addres
266 return self.api(self.papi.sw_interface_set_unnumbered,
267 {'sw_if_index': ip_sw_if_index,
268 'unnumbered_sw_if_index': sw_if_index,
271 def sw_interface_enable_disable_mpls(self, sw_if_index,
274 Enable/Disable MPLS on the interface
276 :param is_enable: (Default value = 1)
279 return self.api(self.papi.sw_interface_set_mpls_enable,
280 {'sw_if_index': sw_if_index,
281 'enable': is_enable})
283 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
284 return self.api(self.papi.sw_interface_ip6nd_ra_config,
285 {'sw_if_index': sw_if_index,
286 'suppress': suppress})
288 def set_ip_flow_hash(self,
297 return self.api(self.papi.set_ip_flow_hash,
307 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
308 return self.api(self.papi.ip6nd_proxy_add_del,
310 'sw_if_index': sw_if_index,
313 def ip6_sw_interface_ra_config(self, sw_if_index,
317 return self.api(self.papi.sw_interface_ip6nd_ra_config,
318 {'sw_if_index': sw_if_index,
320 'suppress': suppress,
321 'send_unicast': send_unicast})
323 def ip6_sw_interface_ra_prefix(self,
333 val_lifetime=0xffffffff,
334 pref_lifetime=0xffffffff):
335 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
336 {'sw_if_index': sw_if_index,
338 'address_length': address_length,
339 'use_default': use_default,
340 'no_advertise': no_advertise,
341 'off_link': off_link,
342 'no_autoconfig': no_autoconfig,
343 'no_onlink': no_onlink,
345 'val_lifetime': val_lifetime,
346 'pref_lifetime': pref_lifetime})
348 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
350 Enable/Disable An interface for IPv6
352 return self.api(self.papi.sw_interface_ip6_enable_disable,
353 {'sw_if_index': sw_if_index,
356 def vxlan_add_del_tunnel(
360 mcast_sw_if_index=0xFFFFFFFF,
364 decap_next_index=0xFFFFFFFF,
370 :param is_add: (Default value = 1)
371 :param is_ipv6: (Default value = 0)
372 :param encap_vrf_id: (Default value = 0)
373 :param decap_next_index: (Default value = 0xFFFFFFFF)
374 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
375 :param vni: (Default value = 0)
378 return self.api(self.papi.vxlan_add_del_tunnel,
381 'src_address': src_addr,
382 'dst_address': dst_addr,
383 'mcast_sw_if_index': mcast_sw_if_index,
384 'encap_vrf_id': encap_vrf_id,
385 'decap_next_index': decap_next_index,
388 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
389 learn=1, arp_term=0, is_add=1):
390 """Create/delete bridge domain.
392 :param int bd_id: Bridge domain index.
393 :param int flood: Enable/disable bcast/mcast flooding in the BD.
395 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
397 :param int forward: Enable/disable forwarding on all interfaces in
398 the BD. (Default value = 1)
399 :param int learn: Enable/disable learning on all interfaces in the BD.
401 :param int arp_term: Enable/disable arp termination in the BD.
403 :param int is_add: Add or delete flag. (Default value = 1)
405 return self.api(self.papi.bridge_domain_add_del,
408 'uu_flood': uu_flood,
411 'arp_term': arp_term,
414 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
415 return self.api(self.papi.bd_ip_mac_add_del,
422 def want_ip4_arp_events(self, enable_disable=1, address=0):
423 return self.api(self.papi.want_ip4_arp_events,
424 {'enable_disable': enable_disable,
426 'pid': os.getpid(), })
428 def want_ip6_nd_events(self, enable_disable=1, address=0):
429 return self.api(self.papi.want_ip6_nd_events,
430 {'enable_disable': enable_disable,
432 'pid': os.getpid(), })
434 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
435 filter_mac=0, bvi_mac=0):
436 """Create/delete L2 FIB entry.
438 :param str mac: MAC address to create FIB entry for.
439 :param int bd_id: Bridge domain index.
440 :param int sw_if_index: Software interface index of the interface.
441 :param int is_add: Add or delete flag. (Default value = 1)
442 :param int static_mac: Set to 1 to create static MAC entry.
444 :param int filter_mac: Set to 1 to drop packet that's source or
445 destination MAC address contains defined MAC address.
447 :param int bvi_mac: Set to 1 to create entry that points to BVI
448 interface. (Default value = 0)
450 return self.api(self.papi.l2fib_add_del,
451 {'mac': self._convert_mac(mac),
453 'sw_if_index': sw_if_index,
455 'static_mac': static_mac,
456 'filter_mac': filter_mac,
459 def l2fib_flush_int(self, sw_if_index):
460 """Flush L2 FIB entries for sw_if_index.
462 :param int sw_if_index: Software interface index of the interface.
464 return self.api(self.papi.l2fib_flush_int,
465 {'sw_if_index': sw_if_index})
467 def l2fib_flush_bd(self, bd_id):
468 """Flush L2 FIB entries for bd_id.
470 :param int sw_if_index: Bridge Domain id.
472 return self.api(self.papi.l2fib_flush_bd,
475 def l2fib_flush_all(self):
478 return self.api(self.papi.l2fib_flush_all, {})
480 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
481 shg=0, bvi=0, enable=1):
482 """Add/remove interface to/from bridge domain.
484 :param int sw_if_index: Software interface index of the interface.
485 :param int bd_id: Bridge domain index.
486 :param int shg: Split-horizon group index. (Default value = 0)
487 :param int bvi: Set interface as a bridge group virtual interface.
489 :param int enable: Add or remove interface. (Default value = 1)
491 return self.api(self.papi.sw_interface_set_l2_bridge,
492 {'rx_sw_if_index': sw_if_index,
498 def bridge_flags(self, bd_id, is_set, feature_bitmap):
499 """Enable/disable required feature of the bridge domain with defined ID.
501 :param int bd_id: Bridge domain ID.
502 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
503 :param int feature_bitmap: Bitmap value of the feature to be set:
507 - uu-flood (1 << 3) or
510 return self.api(self.papi.bridge_flags,
513 'feature_bitmap': feature_bitmap})
515 def bridge_domain_dump(self, bd_id=0):
518 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
519 existing bridge domains returned)
520 :return: Dictionary of bridge domain(s) data.
522 return self.api(self.papi.bridge_domain_dump,
525 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
527 """Create or delete unidirectional cross-connect from Tx interface to
530 :param int rx_sw_if_index: Software interface index of Rx interface.
531 :param int tx_sw_if_index: Software interface index of Tx interface.
532 :param int enable: Create cross-connect if equal to 1, delete
533 cross-connect if equal to 0.
536 return self.api(self.papi.sw_interface_set_l2_xconnect,
537 {'rx_sw_if_index': rx_sw_if_index,
538 'tx_sw_if_index': tx_sw_if_index,
541 def sw_interface_set_l2_tag_rewrite(
548 """L2 interface vlan tag rewrite configure request
549 :param client_index - opaque cookie to identify the sender
550 :param context - sender context, to match reply w/ request
551 :param sw_if_index - interface the operation is applied to
552 :param vtr_op - Choose from l2_vtr_op_t enum values
553 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
554 :param tag1 - Needed for any push or translate vtr op
555 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
558 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
559 {'sw_if_index': sw_if_index,
565 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
568 :param admin_up_down:
572 return self.api(self.papi.sw_interface_set_flags,
573 {'sw_if_index': sw_if_index,
574 'admin_up_down': admin_up_down})
576 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
577 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
578 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
579 """Create subinterface
580 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
582 :param sub_id: param inner_vlan:
586 :param no_tags: (Default value = 0)
587 :param one_tag: (Default value = 0)
588 :param two_tags: (Default value = 0)
589 :param dot1ad: (Default value = 0)
590 :param exact_match: (Default value = 0)
591 :param default_sub: (Default value = 0)
592 :param outer_vlan_id_any: (Default value = 0)
593 :param inner_vlan_id_any: (Default value = 0)
597 self.papi.create_subif,
598 {'sw_if_index': sw_if_index,
602 'two_tags': two_tags,
604 'exact_match': exact_match,
605 'default_sub': default_sub,
606 'outer_vlan_id_any': outer_vlan_id_any,
607 'inner_vlan_id_any': inner_vlan_id_any,
608 'outer_vlan_id': outer_vlan,
609 'inner_vlan_id': inner_vlan})
611 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
612 """Create p2p ethernet subinterface
614 :param sw_if_index: main (parent) interface
615 :param remote_mac: client (remote) mac address
619 self.papi.p2p_ethernet_add,
620 {'parent_if_index': sw_if_index,
621 'remote_mac': remote_mac,
622 'subif_id': subif_id})
624 def delete_subif(self, sw_if_index):
625 """Delete subinterface
629 return self.api(self.papi.delete_subif,
630 {'sw_if_index': sw_if_index})
632 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
633 """Delete p2p ethernet subinterface
635 :param sw_if_index: main (parent) interface
636 :param remote_mac: client (remote) mac address
640 self.papi.p2p_ethernet_del,
641 {'parent_if_index': sw_if_index,
642 'remote_mac': remote_mac})
644 def create_vlan_subif(self, sw_if_index, vlan):
651 return self.api(self.papi.create_vlan_subif,
652 {'sw_if_index': sw_if_index,
655 def create_loopback(self, mac=''):
658 :param mac: (Optional)
660 return self.api(self.papi.create_loopback,
661 {'mac_address': mac})
663 def delete_loopback(self, sw_if_index):
664 return self.api(self.papi.delete_loopback,
665 {'sw_if_index': sw_if_index, })
667 def ip_table_add_del(self,
674 :param is_add: (Default value = 1)
675 :param is_ipv6: (Default value = 0)
680 self.papi.ip_table_add_del,
681 {'table_id': table_id,
685 def ip_add_del_route(
690 next_hop_sw_if_index=0xFFFFFFFF,
694 next_hop_n_out_labels=0,
695 next_hop_out_label_stack=[],
696 next_hop_via_label=MPLS_LABEL_INVALID,
698 is_resolve_attached=0,
699 classify_table_index=0xFFFFFFFF,
711 :param dst_address_length:
712 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
714 :param next_hop_address:
715 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
716 :param vrf_id: (Default value = 0)
717 :param lookup_in_vrf: (Default value = 0)
718 :param classify_table_index: (Default value = 0xFFFFFFFF)
719 :param is_add: (Default value = 1)
720 :param is_drop: (Default value = 0)
721 :param is_ipv6: (Default value = 0)
722 :param is_local: (Default value = 0)
723 :param is_classify: (Default value = 0)
724 :param is_multipath: (Default value = 0)
725 :param is_resolve_host: (Default value = 0)
726 :param is_resolve_attached: (Default value = 0)
727 :param not_last: (Default value = 0)
728 :param next_hop_weight: (Default value = 1)
733 self.papi.ip_add_del_route,
734 {'next_hop_sw_if_index': next_hop_sw_if_index,
735 'table_id': table_id,
736 'classify_table_index': classify_table_index,
737 'next_hop_table_id': next_hop_table_id,
740 'is_unreach': is_unreach,
741 'is_prohibit': is_prohibit,
743 'is_local': is_local,
744 'is_classify': is_classify,
745 'is_multipath': is_multipath,
746 'is_resolve_host': is_resolve_host,
747 'is_resolve_attached': is_resolve_attached,
748 'not_last': not_last,
749 'next_hop_weight': next_hop_weight,
750 'dst_address_length': dst_address_length,
751 'dst_address': dst_address,
752 'next_hop_address': next_hop_address,
753 'next_hop_n_out_labels': next_hop_n_out_labels,
754 'next_hop_via_label': next_hop_via_label,
755 'next_hop_out_label_stack': next_hop_out_label_stack})
757 def ip_fib_dump(self):
758 return self.api(self.papi.ip_fib_dump, {})
760 def ip6_fib_dump(self):
761 return self.api(self.papi.ip6_fib_dump, {})
763 def ip_neighbor_add_del(self,
772 """ Add neighbor MAC to IPv4 or IPv6 address.
777 :param is_add: (Default value = 1)
778 :param is_ipv6: (Default value = 0)
779 :param is_static: (Default value = 0)
780 :param is_no_adj_fib: (Default value = 0)
784 self.papi.ip_neighbor_add_del,
785 {'sw_if_index': sw_if_index,
788 'is_static': is_static,
789 'is_no_adj_fib': is_no_adj_fib,
790 'mac_address': mac_address,
791 'dst_address': dst_address
795 def ip_neighbor_dump(self,
798 """ Return IP neighbor dump.
801 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
805 self.papi.ip_neighbor_dump,
807 'sw_if_index': sw_if_index
811 def proxy_arp_add_del(self,
816 """ Config Proxy Arp Range.
818 :param low_address: Start address in the rnage to Proxy for
819 :param hi_address: End address in the rnage to Proxy for
820 :param vrf_id: The VRF/table in which to proxy
824 self.papi.proxy_arp_add_del,
827 'low_address': low_address,
828 'hi_address': hi_address,
832 def proxy_arp_intfc_enable_disable(self,
835 """ Enable/Disable an interface for proxy ARP requests
837 :param sw_if_index: Interface
838 :param enable_disable: Enable/Disable
842 self.papi.proxy_arp_intfc_enable_disable,
843 {'sw_if_index': sw_if_index,
844 'enable_disable': is_enable
852 """ Reset VRF (remove all routes etc.) request.
854 :param int vrf_id: ID of the FIB table / VRF to reset.
855 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
869 """ Reset VRF (remove all routes etc.) request.
871 :param int vrf_id: ID of the FIB table / VRF to reset.
872 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
887 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
896 def sw_interface_span_enable_disable(
897 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
900 :param sw_if_index_from:
901 :param sw_if_index_to:
905 return self.api(self.papi.sw_interface_span_enable_disable,
906 {'sw_if_index_from': sw_if_index_from,
907 'sw_if_index_to': sw_if_index_to,
912 def gre_tunnel_add_del(self,
923 :param outer_fib_id: (Default value = 0)
924 :param is_add: (Default value = 1)
925 :param is_ipv6: (Default value = 0)
926 :param is_teb: (Default value = 0)
930 self.papi.gre_add_del_tunnel,
934 'src_address': src_address,
935 'dst_address': dst_address,
936 'outer_fib_id': outer_fib_id}
939 def mpls_fib_dump(self):
940 return self.api(self.papi.mpls_fib_dump, {})
942 def mpls_table_add_del(
949 :param is_add: (Default value = 1)
954 self.papi.mpls_table_add_del,
955 {'mt_table_id': table_id,
956 'mt_is_add': is_add})
958 def mpls_route_add_del(
964 next_hop_sw_if_index=0xFFFFFFFF,
968 next_hop_n_out_labels=0,
969 next_hop_out_label_stack=[],
970 next_hop_via_label=MPLS_LABEL_INVALID,
972 is_resolve_attached=0,
979 classify_table_index=0xFFFFFFFF,
984 :param dst_address_length:
985 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
987 :param next_hop_address:
988 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
989 :param vrf_id: (Default value = 0)
990 :param lookup_in_vrf: (Default value = 0)
991 :param classify_table_index: (Default value = 0xFFFFFFFF)
992 :param is_add: (Default value = 1)
993 :param is_drop: (Default value = 0)
994 :param is_ipv6: (Default value = 0)
995 :param is_local: (Default value = 0)
996 :param is_classify: (Default value = 0)
997 :param is_multipath: (Default value = 0)
998 :param is_multicast: (Default value = 0)
999 :param is_resolve_host: (Default value = 0)
1000 :param is_resolve_attached: (Default value = 0)
1001 :param not_last: (Default value = 0)
1002 :param next_hop_weight: (Default value = 1)
1007 self.papi.mpls_route_add_del,
1010 'mr_table_id': table_id,
1011 'mr_classify_table_index': classify_table_index,
1012 'mr_is_add': is_add,
1013 'mr_is_classify': is_classify,
1014 'mr_is_multipath': is_multipath,
1015 'mr_is_multicast': is_multicast,
1016 'mr_is_resolve_host': is_resolve_host,
1017 'mr_is_resolve_attached': is_resolve_attached,
1018 'mr_is_interface_rx': is_interface_rx,
1019 'mr_is_rpf_id': is_rpf_id,
1020 'mr_next_hop_proto': next_hop_proto,
1021 'mr_next_hop_weight': next_hop_weight,
1022 'mr_next_hop': next_hop_address,
1023 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1024 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1025 'mr_next_hop_table_id': next_hop_table_id,
1026 'mr_next_hop_via_label': next_hop_via_label,
1027 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1029 def mpls_ip_bind_unbind(
1041 self.papi.mpls_ip_bind_unbind,
1042 {'mb_mpls_table_id': table_id,
1044 'mb_ip_table_id': ip_table_id,
1045 'mb_is_bind': is_bind,
1046 'mb_is_ip4': is_ip4,
1047 'mb_address_length': dst_address_length,
1048 'mb_address': dst_address})
1050 def mpls_tunnel_add_del(
1053 next_hop_proto_is_ip4,
1055 next_hop_sw_if_index=0xFFFFFFFF,
1056 next_hop_table_id=0,
1058 next_hop_n_out_labels=0,
1059 next_hop_out_label_stack=[],
1060 next_hop_via_label=MPLS_LABEL_INVALID,
1066 :param dst_address_length:
1067 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1069 :param next_hop_address:
1070 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1071 :param vrf_id: (Default value = 0)
1072 :param lookup_in_vrf: (Default value = 0)
1073 :param classify_table_index: (Default value = 0xFFFFFFFF)
1074 :param is_add: (Default value = 1)
1075 :param is_drop: (Default value = 0)
1076 :param is_ipv6: (Default value = 0)
1077 :param is_local: (Default value = 0)
1078 :param is_classify: (Default value = 0)
1079 :param is_multipath: (Default value = 0)
1080 :param is_resolve_host: (Default value = 0)
1081 :param is_resolve_attached: (Default value = 0)
1082 :param next_hop_weight: (Default value = 1)
1083 :param is_multicast: (Default value = 0)
1087 self.papi.mpls_tunnel_add_del,
1088 {'mt_sw_if_index': tun_sw_if_index,
1089 'mt_is_add': is_add,
1090 'mt_l2_only': l2_only,
1091 'mt_is_multicast': is_multicast,
1092 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1093 'mt_next_hop_weight': next_hop_weight,
1094 'mt_next_hop': next_hop_address,
1095 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1096 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1097 'mt_next_hop_table_id': next_hop_table_id,
1098 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1100 def nat44_interface_add_del_feature(
1105 """Enable/disable NAT44 feature on the interface
1107 :param sw_if_index: Software index of the interface
1108 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1109 :param is_add: 1 if add, 0 if delete (Default value = 1)
1112 self.papi.nat44_interface_add_del_feature,
1114 'is_inside': is_inside,
1115 'sw_if_index': sw_if_index})
1117 def nat44_interface_add_del_output_feature(
1122 """Enable/disable NAT44 output feature on the interface
1124 :param sw_if_index: Software index of the interface
1125 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1126 :param is_add: 1 if add, 0 if delete (Default value = 1)
1129 self.papi.nat44_interface_add_del_output_feature,
1131 'is_inside': is_inside,
1132 'sw_if_index': sw_if_index})
1134 def nat44_add_del_static_mapping(
1138 external_sw_if_index=0xFFFFFFFF,
1145 """Add/delete NAT44 static mapping
1147 :param local_ip: Local IP address
1148 :param external_ip: External IP address
1149 :param external_sw_if_index: External interface instead of IP address
1150 :param local_port: Local port number (Default value = 0)
1151 :param external_port: External port number (Default value = 0)
1152 :param addr_only: 1 if address only mapping, 0 if address and port
1153 :param vrf_id: VRF ID
1154 :param protocol: IP protocol (Default value = 0)
1155 :param is_add: 1 if add, 0 if delete (Default value = 1)
1158 self.papi.nat44_add_del_static_mapping,
1160 'addr_only': addr_only,
1161 'local_ip_address': local_ip,
1162 'external_ip_address': external_ip,
1163 'local_port': local_port,
1164 'external_port': external_port,
1165 'external_sw_if_index': external_sw_if_index,
1167 'protocol': protocol})
1169 def nat44_add_del_address_range(
1175 """Add/del NAT44 address range
1177 :param first_ip_address: First IP address
1178 :param last_ip_address: Last IP address
1179 :param vrf_id: VRF id for the address range
1180 :param is_add: 1 if add, 0 if delete (Default value = 1)
1183 self.papi.nat44_add_del_address_range,
1184 {'first_ip_address': first_ip_address,
1185 'last_ip_address': last_ip_address,
1189 def nat44_address_dump(self):
1190 """Dump NAT44 addresses
1191 :return: Dictionary of NAT44 addresses
1193 return self.api(self.papi.nat44_address_dump, {})
1195 def nat44_interface_dump(self):
1196 """Dump interfaces with NAT44 feature
1197 :return: Dictionary of interfaces with NAT44 feature
1199 return self.api(self.papi.nat44_interface_dump, {})
1201 def nat44_interface_output_feature_dump(self):
1202 """Dump interfaces with NAT44 output feature
1203 :return: Dictionary of interfaces with NAT44 output feature
1205 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1207 def nat44_static_mapping_dump(self):
1208 """Dump NAT44 static mappings
1209 :return: Dictionary of NAT44 static mappings
1211 return self.api(self.papi.nat44_static_mapping_dump, {})
1213 def nat_show_config(self):
1214 """Show NAT plugin config
1215 :return: NAT plugin config parameters
1217 return self.api(self.papi.nat_show_config, {})
1219 def nat44_add_interface_addr(
1223 """Add/del NAT44 address from interface
1225 :param sw_if_index: Software index of the interface
1226 :param is_add: 1 if add, 0 if delete (Default value = 1)
1228 return self.api(self.papi.nat44_add_del_interface_addr,
1229 {'is_add': is_add, 'sw_if_index': sw_if_index})
1231 def nat44_interface_addr_dump(self):
1232 """Dump NAT44 addresses interfaces
1233 :return: Dictionary of NAT44 addresses interfaces
1235 return self.api(self.papi.nat44_interface_addr_dump, {})
1242 """Enable/disable NAT IPFIX logging
1244 :param domain_id: Observation domain ID (Default value = 1)
1245 :param src_port: Source port number (Default value = 4739)
1246 :param enable: 1 if enable, 0 if disable (Default value = 1)
1249 self.papi.nat_ipfix_enable_disable,
1250 {'domain_id': domain_id,
1251 'src_port': src_port,
1254 def nat44_user_session_dump(
1258 """Dump NAT44 user's sessions
1260 :param ip_address: ip adress of the user to be dumped
1261 :param cpu_index: cpu_index on which the user is
1262 :param vrf_id: VRF ID
1263 :return: Dictionary of S-NAT sessions
1266 self.papi.nat44_user_session_dump,
1267 {'ip_address': ip_address,
1270 def nat44_user_dump(self):
1273 :return: Dictionary of NAT44 users
1275 return self.api(self.papi.nat44_user_dump, {})
1277 def nat44_add_del_lb_static_mapping(
1286 """Add/delete NAT44 load balancing static mapping
1288 :param is_add - 1 if add, 0 if delete
1291 self.papi.nat44_add_del_lb_static_mapping,
1293 'external_addr': external_addr,
1294 'external_port': external_port,
1295 'protocol': protocol,
1297 'local_num': local_num,
1300 def nat44_lb_static_mapping_dump(self):
1301 """Dump NAT44 load balancing static mappings
1303 :return: Dictionary of NAT44 load balancing static mapping
1305 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1307 def nat_det_add_del_map(
1314 """Add/delete deterministic NAT mapping
1316 :param is_add - 1 if add, 0 if delete
1317 :param in_addr - inside IP address
1318 :param in_plen - inside IP address prefix length
1319 :param out_addr - outside IP address
1320 :param out_plen - outside IP address prefix length
1323 self.papi.nat_det_add_del_map,
1328 'out_addr': out_addr,
1329 'out_plen': out_plen})
1331 def nat_det_forward(
1334 """Get outside address and port range from inside address
1336 :param in_addr - inside IP address
1339 self.papi.nat_det_forward,
1340 {'in_addr': in_addr,
1343 def nat_det_reverse(
1347 """Get inside address from outside address and port
1349 :param out_addr - outside IP address
1350 :param out_port - outside port
1353 self.papi.nat_det_reverse,
1354 {'out_addr': out_addr,
1355 'out_port': out_port})
1357 def nat_det_map_dump(self):
1358 """Dump deterministic NAT mappings
1360 :return: Dictionary of deterministic NAT mappings
1362 return self.api(self.papi.nat_det_map_dump, {})
1364 def nat_det_set_timeouts(
1367 tcp_established=7440,
1370 """Set values of timeouts for deterministic NAT (in seconds)
1372 :param udp - UDP timeout (Default value = 300)
1373 :param tcp_established - TCP established timeout (Default value = 7440)
1374 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1375 :param icmp - ICMP timeout (Default value = 60)
1378 self.papi.nat_det_set_timeouts,
1380 'tcp_established': tcp_established,
1381 'tcp_transitory': tcp_transitory,
1384 def nat_det_get_timeouts(self):
1385 """Get values of timeouts for deterministic NAT
1387 :return: Timeouts for deterministic NAT (in seconds)
1389 return self.api(self.papi.nat_det_get_timeouts, {})
1391 def nat_det_close_session_out(
1397 """Close deterministic NAT session using outside address and port
1399 :param out_addr - outside IP address
1400 :param out_port - outside port
1401 :param ext_addr - external host IP address
1402 :param ext_port - external host port
1405 self.papi.nat_det_close_session_out,
1406 {'out_addr': out_addr,
1407 'out_port': out_port,
1408 'ext_addr': ext_addr,
1409 'ext_port': ext_port})
1411 def nat_det_close_session_in(
1417 """Close deterministic NAT session using inside address and port
1419 :param in_addr - inside IP address
1420 :param in_port - inside port
1421 :param ext_addr - external host IP address
1422 :param ext_port - external host port
1425 self.papi.nat_det_close_session_in,
1426 {'in_addr': in_addr,
1428 'ext_addr': ext_addr,
1429 'ext_port': ext_port,
1432 def nat_det_session_dump(
1435 """Dump deterministic NAT sessions belonging to a user
1437 :param user_addr - inside IP address of the user
1438 :return: Dictionary of deterministic NAT sessions
1441 self.papi.nat_det_session_dump,
1443 'user_addr': user_addr})
1445 def nat64_add_del_pool_addr_range(
1451 """Add/del address range to NAT64 pool
1453 :param start_addr: First IP address
1454 :param end_addr: Last IP address
1455 :param vrf_id: VRF id for the address range
1456 :param is_add: 1 if add, 0 if delete (Default value = 1)
1459 self.papi.nat64_add_del_pool_addr_range,
1460 {'start_addr': start_addr,
1461 'end_addr': end_addr,
1465 def nat64_pool_addr_dump(self):
1466 """Dump NAT64 pool addresses
1467 :return: Dictionary of NAT64 pool addresses
1469 return self.api(self.papi.nat64_pool_addr_dump, {})
1471 def nat64_add_del_interface(
1476 """Enable/disable NAT64 feature on the interface
1477 :param sw_if_index: Index of the interface
1478 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1479 :param is_add: 1 if add, 0 if delete (Default value = 1)
1482 self.papi.nat64_add_del_interface,
1483 {'sw_if_index': sw_if_index,
1484 'is_inside': is_inside,
1487 def nat64_interface_dump(self):
1488 """Dump interfaces with NAT64 feature
1489 :return: Dictionary of interfaces with NAT64 feature
1491 return self.api(self.papi.nat64_interface_dump, {})
1493 def nat64_add_del_static_bib(
1502 """Add/delete S-NAT static BIB entry
1504 :param in_ip: Inside IPv6 address
1505 :param out_ip: Outside IPv4 address
1506 :param in_port: Inside port number
1507 :param out_port: Outside port number
1508 :param protocol: IP protocol
1509 :param vrf_id: VRF ID (Default value = 0)
1510 :param is_add: 1 if add, 0 if delete (Default value = 1)
1513 self.papi.nat64_add_del_static_bib,
1522 def nat64_bib_dump(self, protocol=255):
1525 :param protocol: IP protocol (Default value = 255, all BIBs)
1526 :returns: Dictionary of NAT64 BIB entries
1528 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1530 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1531 tcp_incoming_syn=6):
1532 """Set values of timeouts for NAT64 (in seconds)
1534 :param udpi: UDP timeout (Default value = 300)
1535 :param icmp: ICMP timeout (Default value = 60)
1536 :param tcp_trans: TCP transitory timeout (Default value = 240)
1537 :param tcp_est: TCP established timeout (Default value = 7440)
1538 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1541 self.papi.nat64_set_timeouts,
1544 'tcp_trans': tcp_trans,
1546 'tcp_incoming_syn': tcp_incoming_syn})
1548 def nat64_get_timeouts(self):
1549 """Get values of timeouts for NAT64
1551 :return: Timeouts for NAT64 (in seconds)
1553 return self.api(self.papi.nat64_get_timeouts, {})
1555 def nat64_st_dump(self, protocol=255):
1556 """Dump NAT64 session table
1558 :param protocol: IP protocol (Default value = 255, all STs)
1559 :returns: Dictionary of NAT64 sesstion table entries
1561 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1563 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1564 """Add/del NAT64 prefix
1566 :param prefix: NAT64 prefix
1567 :param plen: NAT64 prefix length
1568 :param vrf_id: VRF id of tenant (Default 0)
1569 :param is_add: 1 if add, 0 if delete (Default value = 1)
1572 self.papi.nat64_add_del_prefix,
1578 def nat64_prefix_dump(self):
1579 """Dump NAT64 prefix
1581 :returns: Dictionary of NAT64 prefixes
1583 return self.api(self.papi.nat64_prefix_dump, {})
1585 def control_ping(self):
1586 self.api(self.papi.control_ping)
1588 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1589 detect_mult, local_addr, peer_addr, is_ipv6=0,
1590 bfd_key_id=None, conf_key_id=None):
1591 if bfd_key_id is None:
1592 return self.api(self.papi.bfd_udp_add,
1594 'sw_if_index': sw_if_index,
1595 'desired_min_tx': desired_min_tx,
1596 'required_min_rx': required_min_rx,
1597 'local_addr': local_addr,
1598 'peer_addr': peer_addr,
1600 'detect_mult': detect_mult,
1603 return self.api(self.papi.bfd_udp_add,
1605 'sw_if_index': sw_if_index,
1606 'desired_min_tx': desired_min_tx,
1607 'required_min_rx': required_min_rx,
1608 'local_addr': local_addr,
1609 'peer_addr': peer_addr,
1611 'detect_mult': detect_mult,
1612 'is_authenticated': 1,
1613 'bfd_key_id': bfd_key_id,
1614 'conf_key_id': conf_key_id,
1617 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1618 detect_mult, local_addr, peer_addr, is_ipv6=0):
1619 return self.api(self.papi.bfd_udp_mod,
1621 'sw_if_index': sw_if_index,
1622 'desired_min_tx': desired_min_tx,
1623 'required_min_rx': required_min_rx,
1624 'local_addr': local_addr,
1625 'peer_addr': peer_addr,
1627 'detect_mult': detect_mult,
1630 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1631 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1633 return self.api(self.papi.bfd_udp_auth_activate,
1635 'sw_if_index': sw_if_index,
1636 'local_addr': local_addr,
1637 'peer_addr': peer_addr,
1639 'is_delayed': 1 if is_delayed else 0,
1640 'bfd_key_id': bfd_key_id,
1641 'conf_key_id': conf_key_id,
1644 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1645 is_ipv6=0, is_delayed=False):
1646 return self.api(self.papi.bfd_udp_auth_deactivate,
1648 'sw_if_index': sw_if_index,
1649 'local_addr': local_addr,
1650 'peer_addr': peer_addr,
1652 'is_delayed': 1 if is_delayed else 0,
1655 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1656 return self.api(self.papi.bfd_udp_del,
1658 'sw_if_index': sw_if_index,
1659 'local_addr': local_addr,
1660 'peer_addr': peer_addr,
1664 def bfd_udp_session_dump(self):
1665 return self.api(self.papi.bfd_udp_session_dump, {})
1667 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1668 peer_addr, is_ipv6=0):
1669 return self.api(self.papi.bfd_udp_session_set_flags, {
1670 'admin_up_down': admin_up_down,
1671 'sw_if_index': sw_if_index,
1672 'local_addr': local_addr,
1673 'peer_addr': peer_addr,
1677 def want_bfd_events(self, enable_disable=1):
1678 return self.api(self.papi.want_bfd_events, {
1679 'enable_disable': enable_disable,
1683 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1684 return self.api(self.papi.bfd_auth_set_key, {
1685 'conf_key_id': conf_key_id,
1686 'auth_type': auth_type,
1688 'key_len': len(key),
1691 def bfd_auth_del_key(self, conf_key_id):
1692 return self.api(self.papi.bfd_auth_del_key, {
1693 'conf_key_id': conf_key_id,
1696 def bfd_auth_keys_dump(self):
1697 return self.api(self.papi.bfd_auth_keys_dump, {})
1699 def bfd_udp_set_echo_source(self, sw_if_index):
1700 return self.api(self.papi.bfd_udp_set_echo_source,
1701 {'sw_if_index': sw_if_index})
1703 def bfd_udp_del_echo_source(self):
1704 return self.api(self.papi.bfd_udp_del_echo_source, {})
1706 def classify_add_del_table(
1711 table_index=0xFFFFFFFF,
1713 memory_size=2097152,
1715 next_table_index=0xFFFFFFFF,
1716 miss_next_index=0xFFFFFFFF,
1717 current_data_flag=0,
1718 current_data_offset=0):
1722 :param match_n_vectors: (Default value = 1)
1723 :param table_index: (Default value = 0xFFFFFFFF)
1724 :param nbuckets: (Default value = 2)
1725 :param memory_size: (Default value = 2097152)
1726 :param skip_n_vectors: (Default value = 0)
1727 :param next_table_index: (Default value = 0xFFFFFFFF)
1728 :param miss_next_index: (Default value = 0xFFFFFFFF)
1729 :param current_data_flag: (Default value = 0)
1730 :param current_data_offset: (Default value = 0)
1734 self.papi.classify_add_del_table,
1736 'table_index': table_index,
1737 'nbuckets': nbuckets,
1738 'memory_size': memory_size,
1739 'skip_n_vectors': skip_n_vectors,
1740 'match_n_vectors': match_n_vectors,
1741 'next_table_index': next_table_index,
1742 'miss_next_index': miss_next_index,
1743 'current_data_flag': current_data_flag,
1744 'current_data_offset': current_data_offset,
1747 def classify_add_del_session(
1752 opaque_index=0xFFFFFFFF,
1753 hit_next_index=0xFFFFFFFF,
1761 :param opaque_index: (Default value = 0xFFFFFFFF)
1762 :param hit_next_index: (Default value = 0xFFFFFFFF)
1763 :param advance: (Default value = 0)
1764 :param action: (Default value = 0)
1765 :param metadata: (Default value = 0)
1769 self.papi.classify_add_del_session,
1771 'table_index': table_index,
1772 'hit_next_index': hit_next_index,
1773 'opaque_index': opaque_index,
1776 'metadata': metadata,
1779 def input_acl_set_interface(
1783 ip4_table_index=0xFFFFFFFF,
1784 ip6_table_index=0xFFFFFFFF,
1785 l2_table_index=0xFFFFFFFF):
1789 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1790 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1791 :param l2_table_index: (Default value = 0xFFFFFFFF)
1795 self.papi.input_acl_set_interface,
1796 {'sw_if_index': sw_if_index,
1797 'ip4_table_index': ip4_table_index,
1798 'ip6_table_index': ip6_table_index,
1799 'l2_table_index': l2_table_index,
1802 def set_ipfix_exporter(
1809 collector_port=4739,
1812 self.papi.set_ipfix_exporter,
1814 'collector_address': collector_address,
1815 'collector_port': collector_port,
1816 'src_address': src_address,
1818 'path_mtu': path_mtu,
1819 'template_interval': template_interval,
1820 'udp_checksum': udp_checksum,
1823 def dhcp_proxy_config(self,
1831 self.papi.dhcp_proxy_config,
1833 'rx_vrf_id': rx_table_id,
1834 'server_vrf_id': server_table_id,
1837 'dhcp_server': dhcp_server,
1838 'dhcp_src_address': dhcp_src_address,
1841 def dhcp_proxy_set_vss(self,
1848 self.papi.dhcp_proxy_set_vss,
1857 def dhcp_client(self,
1862 want_dhcp_events=0):
1864 self.papi.dhcp_client_config,
1866 'sw_if_index': sw_if_index,
1867 'hostname': hostname,
1868 'client_id': client_id,
1870 'want_dhcp_event': want_dhcp_events,
1874 def ip_mroute_add_del(self,
1879 next_hop_sw_if_index,
1889 self.papi.ip_mroute_add_del,
1890 {'next_hop_sw_if_index': next_hop_sw_if_index,
1891 'entry_flags': e_flags,
1892 'itf_flags': i_flags,
1893 'table_id': table_id,
1897 'is_local': is_local,
1898 'grp_address_length': grp_address_length,
1899 'grp_address': grp_address,
1900 'src_address': src_address})
1902 def mfib_signal_dump(self):
1903 return self.api(self.papi.mfib_signal_dump, {})
1905 def ip_mfib_dump(self):
1906 return self.api(self.papi.ip_mfib_dump, {})
1908 def lisp_enable_disable(self, is_enabled):
1910 self.papi.lisp_enable_disable,
1912 'is_en': is_enabled,
1915 def lisp_locator_set(self,
1919 self.papi.lisp_add_del_locator_set,
1922 'locator_set_name': ls_name
1925 def lisp_locator_set_dump(self):
1926 return self.api(self.papi.lisp_locator_set_dump, {})
1928 def lisp_locator(self,
1935 self.papi.lisp_add_del_locator,
1938 'locator_set_name': ls_name,
1939 'sw_if_index': sw_if_index,
1940 'priority': priority,
1944 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1946 self.papi.lisp_locator_dump,
1948 'is_index_set': is_index_set,
1950 'ls_index': ls_index,
1953 def lisp_local_mapping(self,
1963 self.papi.lisp_add_del_local_eid,
1965 'locator_set_name': ls_name,
1967 'eid_type': eid_type,
1969 'prefix_len': prefix_len,
1975 def lisp_eid_table_dump(self,
1983 self.papi.lisp_eid_table_dump,
1986 'prefix_length': prefix_length,
1988 'eid_type': eid_type,
1990 'filter': filter_opt,
1993 def lisp_remote_mapping(self,
2003 self.papi.lisp_add_del_remote_mapping,
2006 'eid_type': eid_type,
2008 'eid_len': eid_prefix_len,
2009 'rloc_num': rlocs_num,
2012 'is_src_dst': is_src_dst,
2015 def lisp_adjacency(self,
2024 self.papi.lisp_add_del_adjacency,
2028 'eid_type': eid_type,
2031 'leid_len': leid_len,
2032 'reid_len': reid_len,
2035 def lisp_adjacencies_get(self, vni=0):
2037 self.papi.lisp_adjacencies_get,
2042 def map_add_domain(self,
2055 self.papi.map_add_domain,
2057 'ip6_prefix': ip6_prefix,
2058 'ip6_prefix_len': ip6_prefix_len,
2059 'ip4_prefix': ip4_prefix,
2060 'ip4_prefix_len': ip4_prefix_len,
2062 'ip6_src_prefix_len': ip6_src_prefix_len,
2063 'ea_bits_len': ea_bits_len,
2064 'psid_offset': psid_offset,
2065 'psid_length': psid_length,
2066 'is_translation': is_translation,
2070 def gtpu_add_del_tunnel(
2076 mcast_sw_if_index=0xFFFFFFFF,
2078 decap_next_index=0xFFFFFFFF,
2082 :param is_add: (Default value = 1)
2083 :param is_ipv6: (Default value = 0)
2086 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2087 :param encap_vrf_id: (Default value = 0)
2088 :param decap_next_index: (Default value = 0xFFFFFFFF)
2089 :param teid: (Default value = 0)
2092 return self.api(self.papi.gtpu_add_del_tunnel,
2095 'src_address': src_addr,
2096 'dst_address': dst_addr,
2097 'mcast_sw_if_index': mcast_sw_if_index,
2098 'encap_vrf_id': encap_vrf_id,
2099 'decap_next_index': decap_next_index,
2102 def vxlan_gpe_add_del_tunnel(
2106 mcast_sw_if_index=0xFFFFFFFF,
2117 :param is_add: (Default value = 1)
2118 :param is_ipv6: (Default value = 0)
2119 :param encap_vrf_id: (Default value = 0)
2120 :param decap_vrf_id: (Default value = 0)
2121 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2122 :param protocol: (Default value = 3)
2123 :param vni: (Default value = 0)
2126 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2131 'mcast_sw_if_index': mcast_sw_if_index,
2132 'encap_vrf_id': encap_vrf_id,
2133 'decap_vrf_id': decap_vrf_id,
2134 'protocol': protocol,
2137 def pppoe_add_del_session(
2147 :param is_add: (Default value = 1)
2148 :param is_ipv6: (Default value = 0)
2150 :param session_id: (Default value = 0)
2152 :param decap_vrf_id: (Default value = 0)
2155 return self.api(self.papi.pppoe_add_del_session,
2158 'session_id': session_id,
2159 'client_ip': client_ip,
2160 'decap_vrf_id': decap_vrf_id,
2161 'client_mac': client_mac})
2163 def sr_localsid_add_del(self,
2169 sw_if_index=0xFFFFFFFF,
2173 """ Add/del IPv6 SR local-SID.
2175 :param localsid_addr:
2176 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2177 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2179 :param is_del: (Default value = 0)
2180 :param end_psp: (Default value = 0)
2181 :param sw_if_index: (Default value = 0xFFFFFFFF)
2182 :param vlan_index: (Default value = 0)
2183 :param fib_table: (Default value = 0)
2186 self.papi.sr_localsid_add_del,
2188 'localsid_addr': localsid_addr,
2190 'behavior': behavior,
2191 'sw_if_index': sw_if_index,
2192 'vlan_index': vlan_index,
2193 'fib_table': fib_table,
2208 :param bsid_addr: bindingSID of the SR Policy
2209 :param weight: weight of the sid list. optional. (default: 1)
2210 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2212 :param type: type/behavior of the SR policy. (default or spray) \
2214 :param fib_table: VRF where to install the FIB entry for the BSID \
2216 :param n_segments: number of segments \
2218 :param segments: a vector of IPv6 address composing the segment list \
2222 self.papi.sr_policy_add,
2223 {'bsid_addr': bsid_addr,
2225 'is_encap': is_encap,
2227 'fib_table': fib_table,
2228 'n_segments': n_segments,
2229 'segments': segments
2238 :param bsid: bindingSID of the SR Policy
2239 :param sr_policy_index: index of the sr policy (default: 0)
2242 self.papi.sr_policy_del,
2243 {'bsid_addr': bsid_addr,
2244 'sr_policy_index': sr_policy_index
2247 def sr_steering_add_del(
2258 Steer traffic L2 and L3 traffic through a given SR policy
2260 :param is_del: delete or add
2261 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2262 :param sr_policy: is the index of the SR Policy (alt to bsid)
2263 :param table_id: is the VRF where to install the FIB entry for the BSID
2264 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2265 :param mask_width: is the mask for L3 traffic type
2266 :param sw_if_index: is the incoming interface for L2 traffic
2267 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2270 self.papi.sr_steering_add_del,
2272 'bsid_addr': bsid_addr,
2273 'sr_policy_index': sr_policy_index,
2274 'table_id': table_id,
2275 'prefix_addr': prefix_addr,
2276 'mask_width': mask_width,
2277 'sw_if_index': sw_if_index,
2278 'traffic_type': traffic_type
2281 def macip_acl_add(self, rules, tag=""):
2284 :param rules: list of rules for given acl
2288 return self.api(self.papi.macip_acl_add,
2290 'count': len(rules),
2293 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2296 :param rules: list of rules for given acl
2300 return self.api(self.papi.macip_acl_add_replace,
2301 {'acl_index': acl_index,
2303 'count': len(rules),
2306 def macip_acl_del(self, acl_index):
2312 return self.api(self.papi.macip_acl_del,
2313 {'acl_index': acl_index})
2315 def macip_acl_interface_add_del(self,
2319 """ Add MACIP acl to interface
2323 :param is_add: (Default value = 1)
2326 return self.api(self.papi.macip_acl_interface_add_del,
2328 'sw_if_index': sw_if_index,
2329 'acl_index': acl_index})
2331 def macip_acl_interface_get(self):
2332 """ Return interface acls dump
2335 self.papi.macip_acl_interface_get, {})
2337 def macip_acl_dump(self, acl_index=4294967295):
2338 """ Return MACIP acl dump
2342 self.papi.macip_acl_dump, {'acl_index': acl_index})