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
46 class UnexpectedApiReturnValueError(Exception):
47 """ exception raised when the API return value is unexpected """
51 class VppPapiProvider(object):
52 """VPP-api provider using vpp-papi
54 @property hook: hook object providing before and after api/cli hooks
57 _zero, _negative = range(2)
59 def __init__(self, name, shm_prefix, test_class):
60 self.hook = Hook("vpp-papi-provider")
62 self.shm_prefix = shm_prefix
63 self.test_class = test_class
64 self._expect_api_retval = self._zero
65 self._expect_stack = []
68 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
69 for root, dirnames, filenames in os.walk(install_dir):
70 for filename in fnmatch.filter(filenames, '*.api.json'):
71 jsonfiles.append(os.path.join(root, filename))
73 self.vpp = VPP(jsonfiles, logger=test_class.logger)
74 self._events = deque()
79 def expect_negative_api_retval(self):
80 """ Expect API failure """
81 self._expect_stack.append(self._expect_api_retval)
82 self._expect_api_retval = self._negative
85 def expect_zero_api_retval(self):
86 """ Expect API success """
87 self._expect_stack.append(self._expect_api_retval)
88 self._expect_api_retval = self._zero
91 def __exit__(self, exc_type, exc_value, traceback):
92 self._expect_api_retval = self._expect_stack.pop()
94 def register_hook(self, hook):
95 """Replace hook registration with new hook
102 def collect_events(self):
103 """ Collect all events from the internal queue and clear the queue. """
105 self._events = deque()
108 def wait_for_event(self, timeout, name=None):
109 """ Wait for and return next event. """
111 self.test_class.logger.debug("Expecting event '%s' within %ss",
114 self.test_class.logger.debug("Expecting event within %ss",
117 self.test_class.logger.debug("Not waiting, event already queued")
118 limit = time.time() + timeout
119 while time.time() < limit:
121 e = self._events.popleft()
122 if name and type(e).__name__ != name:
124 "Unexpected event received: %s, expected: %s" %
125 (type(e).__name__, name))
126 self.test_class.logger.debug("Returning event %s:%s" %
129 time.sleep(0) # yield
130 raise Exception("Event did not occur within timeout")
132 def __call__(self, name, event):
133 """ Enqueue event in the internal event queue. """
134 # FIXME use the name instead of relying on type(e).__name__ ?
135 # FIXME #2 if this throws, it is eaten silently, Ole?
136 self.test_class.logger.debug("New event: %s: %s" % (name, event))
137 self._events.append(event)
140 """Connect the API to VPP"""
141 self.vpp.connect(self.name, self.shm_prefix)
142 self.papi = self.vpp.api
143 self.vpp.register_event_callback(self)
145 def disconnect(self):
146 """Disconnect the API from VPP"""
147 self.vpp.disconnect()
149 def api(self, api_fn, api_args, expected_retval=0):
150 """ Call API function and check it's return value.
151 Call the appropriate hooks before and after the API call
153 :param api_fn: API function to call
154 :param api_args: tuple of API function arguments
155 :param expected_retval: Expected return value (Default value = 0)
156 :returns: reply from the API
159 self.hook.before_api(api_fn.__name__, api_args)
160 reply = api_fn(**api_args)
161 if self._expect_api_retval == self._negative:
162 if hasattr(reply, 'retval') and reply.retval >= 0:
163 msg = "API call passed unexpectedly: expected negative "\
164 "return value instead of %d in %s" % \
165 (reply.retval, repr(reply))
166 self.test_class.logger.info(msg)
167 raise UnexpectedApiReturnValueError(msg)
168 elif self._expect_api_retval == self._zero:
169 if hasattr(reply, 'retval') and reply.retval != expected_retval:
170 msg = "API call failed, expected %d return value instead "\
171 "of %d in %s" % (expected_retval, reply.retval,
173 self.test_class.logger.info(msg)
174 raise UnexpectedApiReturnValueError(msg)
176 raise Exception("Internal error, unexpected value for "
177 "self._expect_api_retval %s" %
178 self._expect_api_retval)
179 self.hook.after_api(api_fn.__name__, api_args)
183 """ Execute a CLI, calling the before/after hooks appropriately.
185 :param cli: CLI to execute
189 self.hook.before_cli(cli)
191 r = self.papi.cli_inband(length=len(cli), cmd=cli)
192 self.hook.after_cli(cli)
193 if hasattr(r, 'reply'):
194 return r.reply.decode().rstrip('\x00')
196 def ppcli(self, cli):
197 """ Helper method to print CLI command in case of info logging level.
199 :param cli: CLI to execute
202 return cli + "\n" + str(self.cli(cli))
204 def _convert_mac(self, mac):
205 return mac.replace(':', '').decode('hex')
207 def show_version(self):
209 return self.api(self.papi.show_version, {})
211 def pg_create_interface(self, pg_index):
217 return self.api(self.papi.pg_create_interface,
218 {"interface_id": pg_index})
220 def sw_interface_dump(self, filter=None):
223 :param filter: (Default value = None)
226 if filter is not None:
227 args = {"name_filter_valid": 1, "name_filter": filter}
230 return self.api(self.papi.sw_interface_dump, args)
232 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
233 """ Set the IPvX Table-id for the Interface
240 return self.api(self.papi.sw_interface_set_table,
241 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
244 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
245 is_ipv6=0, is_add=1, del_all=0):
248 :param addr: param is_ipv6: (Default value = 0)
251 :param is_ipv6: (Default value = 0)
252 :param is_add: (Default value = 1)
253 :param del_all: (Default value = 0)
256 return self.api(self.papi.sw_interface_add_del_address,
257 {'sw_if_index': sw_if_index,
261 'address_length': addr_len,
264 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
266 """ Set the Interface to be unnumbered
268 :param is_add: (Default value = 1)
269 :param sw_if_index - interface That will be unnumbered
270 :param ip_sw_if_index - interface with an IP addres
273 return self.api(self.papi.sw_interface_set_unnumbered,
274 {'sw_if_index': ip_sw_if_index,
275 'unnumbered_sw_if_index': sw_if_index,
278 def sw_interface_enable_disable_mpls(self, sw_if_index,
281 Enable/Disable MPLS on the interface
283 :param is_enable: (Default value = 1)
286 return self.api(self.papi.sw_interface_set_mpls_enable,
287 {'sw_if_index': sw_if_index,
288 'enable': is_enable})
290 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
291 return self.api(self.papi.sw_interface_ip6nd_ra_config,
292 {'sw_if_index': sw_if_index,
293 'suppress': suppress})
295 def set_ip_flow_hash(self,
304 return self.api(self.papi.set_ip_flow_hash,
314 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
315 return self.api(self.papi.ip6nd_proxy_add_del,
317 'sw_if_index': sw_if_index,
320 def ip6_sw_interface_ra_config(self, sw_if_index,
324 return self.api(self.papi.sw_interface_ip6nd_ra_config,
325 {'sw_if_index': sw_if_index,
327 'suppress': suppress,
328 'send_unicast': send_unicast})
330 def ip6_sw_interface_ra_prefix(self,
340 val_lifetime=0xffffffff,
341 pref_lifetime=0xffffffff):
342 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
343 {'sw_if_index': sw_if_index,
345 'address_length': address_length,
346 'use_default': use_default,
347 'no_advertise': no_advertise,
348 'off_link': off_link,
349 'no_autoconfig': no_autoconfig,
350 'no_onlink': no_onlink,
352 'val_lifetime': val_lifetime,
353 'pref_lifetime': pref_lifetime})
355 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
357 Enable/Disable An interface for IPv6
359 return self.api(self.papi.sw_interface_ip6_enable_disable,
360 {'sw_if_index': sw_if_index,
363 def vxlan_add_del_tunnel(
367 mcast_sw_if_index=0xFFFFFFFF,
371 decap_next_index=0xFFFFFFFF,
373 instance=0xFFFFFFFF):
378 :param is_add: (Default value = 1)
379 :param is_ipv6: (Default value = 0)
380 :param encap_vrf_id: (Default value = 0)
381 :param decap_next_index: (Default value = 0xFFFFFFFF)
382 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
383 :param vni: (Default value = 0)
384 :param instance: (Default value = 0xFFFFFFFF)
387 return self.api(self.papi.vxlan_add_del_tunnel,
390 'src_address': src_addr,
391 'dst_address': dst_addr,
392 'mcast_sw_if_index': mcast_sw_if_index,
393 'encap_vrf_id': encap_vrf_id,
394 'decap_next_index': decap_next_index,
396 'instance': instance})
398 def geneve_add_del_tunnel(
402 mcast_sw_if_index=0xFFFFFFFF,
406 decap_next_index=0xFFFFFFFF,
412 :param is_add: (Default value = 1)
413 :param is_ipv6: (Default value = 0)
414 :param encap_vrf_id: (Default value = 0)
415 :param decap_next_index: (Default value = 0xFFFFFFFF)
416 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
417 :param vni: (Default value = 0)
420 return self.api(self.papi.geneve_add_del_tunnel,
423 'local_address': local_addr,
424 'remote_address': remote_addr,
425 'mcast_sw_if_index': mcast_sw_if_index,
426 'encap_vrf_id': encap_vrf_id,
427 'decap_next_index': decap_next_index,
430 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
431 learn=1, arp_term=0, is_add=1):
432 """Create/delete bridge domain.
434 :param int bd_id: Bridge domain index.
435 :param int flood: Enable/disable bcast/mcast flooding in the BD.
437 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
439 :param int forward: Enable/disable forwarding on all interfaces in
440 the BD. (Default value = 1)
441 :param int learn: Enable/disable learning on all interfaces in the BD.
443 :param int arp_term: Enable/disable arp termination in the BD.
445 :param int is_add: Add or delete flag. (Default value = 1)
447 return self.api(self.papi.bridge_domain_add_del,
450 'uu_flood': uu_flood,
453 'arp_term': arp_term,
456 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
457 return self.api(self.papi.bd_ip_mac_add_del,
464 def want_ip4_arp_events(self, enable_disable=1, address=0):
465 return self.api(self.papi.want_ip4_arp_events,
466 {'enable_disable': enable_disable,
468 'pid': os.getpid(), })
470 def want_ip6_nd_events(self, enable_disable=1, address=0):
471 return self.api(self.papi.want_ip6_nd_events,
472 {'enable_disable': enable_disable,
474 'pid': os.getpid(), })
476 def want_ip6_ra_events(self, enable_disable=1):
477 return self.api(self.papi.want_ip6_ra_events,
478 {'enable_disable': enable_disable,
479 'pid': os.getpid(), })
481 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
483 return self.api(self.papi.ip6nd_send_router_solicitation,
488 'sw_if_index': sw_if_index})
490 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
491 install_default_routes):
492 return self.api(self.papi.ip6_nd_address_autoconfig,
493 {'sw_if_index': sw_if_index,
495 'install_default_routes': install_default_routes})
497 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
498 max_macs_in_event=0, learn_limit=0):
499 return self.api(self.papi.want_l2_macs_events,
500 {'enable_disable': enable_disable,
501 'scan_delay': scan_delay,
502 'max_macs_in_event': max_macs_in_event,
503 'learn_limit': learn_limit,
504 'pid': os.getpid(), })
506 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
507 filter_mac=0, bvi_mac=0):
508 """Create/delete L2 FIB entry.
510 :param str mac: MAC address to create FIB entry for.
511 :param int bd_id: Bridge domain index.
512 :param int sw_if_index: Software interface index of the interface.
513 :param int is_add: Add or delete flag. (Default value = 1)
514 :param int static_mac: Set to 1 to create static MAC entry.
516 :param int filter_mac: Set to 1 to drop packet that's source or
517 destination MAC address contains defined MAC address.
519 :param int bvi_mac: Set to 1 to create entry that points to BVI
520 interface. (Default value = 0)
522 return self.api(self.papi.l2fib_add_del,
523 {'mac': self._convert_mac(mac),
525 'sw_if_index': sw_if_index,
527 'static_mac': static_mac,
528 'filter_mac': filter_mac,
531 def l2fib_flush_int(self, sw_if_index):
532 """Flush L2 FIB entries for sw_if_index.
534 :param int sw_if_index: Software interface index of the interface.
536 return self.api(self.papi.l2fib_flush_int,
537 {'sw_if_index': sw_if_index})
539 def l2fib_flush_bd(self, bd_id):
540 """Flush L2 FIB entries for bd_id.
542 :param int sw_if_index: Bridge Domain id.
544 return self.api(self.papi.l2fib_flush_bd,
547 def l2fib_flush_all(self):
550 return self.api(self.papi.l2fib_flush_all, {})
552 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
553 shg=0, bvi=0, enable=1):
554 """Add/remove interface to/from bridge domain.
556 :param int sw_if_index: Software interface index of the interface.
557 :param int bd_id: Bridge domain index.
558 :param int shg: Split-horizon group index. (Default value = 0)
559 :param int bvi: Set interface as a bridge group virtual interface.
561 :param int enable: Add or remove interface. (Default value = 1)
563 return self.api(self.papi.sw_interface_set_l2_bridge,
564 {'rx_sw_if_index': sw_if_index,
570 def bridge_flags(self, bd_id, is_set, feature_bitmap):
571 """Enable/disable required feature of the bridge domain with defined
574 :param int bd_id: Bridge domain ID.
575 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
576 :param int feature_bitmap: Bitmap value of the feature to be set:
580 - uu-flood (1 << 3) or
583 return self.api(self.papi.bridge_flags,
586 'feature_bitmap': feature_bitmap})
588 def bridge_domain_dump(self, bd_id=0):
591 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
592 existing bridge domains returned)
593 :return: Dictionary of bridge domain(s) data.
595 return self.api(self.papi.bridge_domain_dump,
598 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
600 """Create or delete unidirectional cross-connect from Tx interface to
603 :param int rx_sw_if_index: Software interface index of Rx interface.
604 :param int tx_sw_if_index: Software interface index of Tx interface.
605 :param int enable: Create cross-connect if equal to 1, delete
606 cross-connect if equal to 0.
609 return self.api(self.papi.sw_interface_set_l2_xconnect,
610 {'rx_sw_if_index': rx_sw_if_index,
611 'tx_sw_if_index': tx_sw_if_index,
614 def sw_interface_set_l2_tag_rewrite(
621 """L2 interface vlan tag rewrite configure request
622 :param client_index - opaque cookie to identify the sender
623 :param context - sender context, to match reply w/ request
624 :param sw_if_index - interface the operation is applied to
625 :param vtr_op - Choose from l2_vtr_op_t enum values
626 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
627 :param tag1 - Needed for any push or translate vtr op
628 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
631 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
632 {'sw_if_index': sw_if_index,
638 def sw_interface_set_l2_emulation(
643 :param sw_if_index - interface the operation is applied to
646 return self.api(self.papi.l2_emulation,
647 {'sw_if_index': sw_if_index,
650 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
653 :param admin_up_down:
657 return self.api(self.papi.sw_interface_set_flags,
658 {'sw_if_index': sw_if_index,
659 'admin_up_down': admin_up_down})
661 def sw_interface_set_mtu(self, sw_if_index, mtu):
667 return self.api(self.papi.sw_interface_set_mtu,
668 {'sw_if_index': sw_if_index,
671 def sw_interface_set_promiscuous(self, sw_if_index, enable):
677 return self.api(self.papi.sw_interface_set_promiscuous,
678 {'sw_if_index': sw_if_index,
681 def sw_interface_set_mac_address(self, sw_if_index, mac):
682 return self.api(self.papi.sw_interface_set_mac_address,
683 {'sw_if_index': sw_if_index,
686 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
687 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
688 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
689 """Create subinterface
690 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
692 :param sub_id: param inner_vlan:
696 :param no_tags: (Default value = 0)
697 :param one_tag: (Default value = 0)
698 :param two_tags: (Default value = 0)
699 :param dot1ad: (Default value = 0)
700 :param exact_match: (Default value = 0)
701 :param default_sub: (Default value = 0)
702 :param outer_vlan_id_any: (Default value = 0)
703 :param inner_vlan_id_any: (Default value = 0)
707 self.papi.create_subif,
708 {'sw_if_index': sw_if_index,
712 'two_tags': two_tags,
714 'exact_match': exact_match,
715 'default_sub': default_sub,
716 'outer_vlan_id_any': outer_vlan_id_any,
717 'inner_vlan_id_any': inner_vlan_id_any,
718 'outer_vlan_id': outer_vlan,
719 'inner_vlan_id': inner_vlan})
721 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
722 """Create p2p ethernet subinterface
724 :param sw_if_index: main (parent) interface
725 :param remote_mac: client (remote) mac address
729 self.papi.p2p_ethernet_add,
730 {'parent_if_index': sw_if_index,
731 'remote_mac': remote_mac,
732 'subif_id': subif_id})
734 def delete_subif(self, sw_if_index):
735 """Delete subinterface
739 return self.api(self.papi.delete_subif,
740 {'sw_if_index': sw_if_index})
742 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
743 """Delete p2p ethernet subinterface
745 :param sw_if_index: main (parent) interface
746 :param remote_mac: client (remote) mac address
750 self.papi.p2p_ethernet_del,
751 {'parent_if_index': sw_if_index,
752 'remote_mac': remote_mac})
754 def create_vlan_subif(self, sw_if_index, vlan):
761 return self.api(self.papi.create_vlan_subif,
762 {'sw_if_index': sw_if_index,
765 def create_loopback(self, mac=''):
768 :param mac: (Optional)
770 return self.api(self.papi.create_loopback,
771 {'mac_address': mac})
773 def delete_loopback(self, sw_if_index):
774 return self.api(self.papi.delete_loopback,
775 {'sw_if_index': sw_if_index, })
777 def ip_table_add_del(self,
784 :param is_add: (Default value = 1)
785 :param is_ipv6: (Default value = 0)
790 self.papi.ip_table_add_del,
791 {'table_id': table_id,
795 def ip_add_del_route(
800 next_hop_sw_if_index=0xFFFFFFFF,
804 next_hop_n_out_labels=0,
805 next_hop_out_label_stack=[],
806 next_hop_via_label=MPLS_LABEL_INVALID,
807 next_hop_id=0xFFFFFFFF,
809 is_resolve_attached=0,
810 classify_table_index=0xFFFFFFFF,
824 :param dst_address_length:
825 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
827 :param next_hop_address:
828 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
829 :param vrf_id: (Default value = 0)
830 :param lookup_in_vrf: (Default value = 0)
831 :param classify_table_index: (Default value = 0xFFFFFFFF)
832 :param is_add: (Default value = 1)
833 :param is_drop: (Default value = 0)
834 :param is_ipv6: (Default value = 0)
835 :param is_local: (Default value = 0)
836 :param is_classify: (Default value = 0)
837 :param is_multipath: (Default value = 0)
838 :param is_resolve_host: (Default value = 0)
839 :param is_resolve_attached: (Default value = 0)
840 :param is_dvr: (Default value = 0)
841 :param is_source_lookup: (Default value = 0)
842 :param next_hop_weight: (Default value = 1)
847 self.papi.ip_add_del_route,
848 {'next_hop_sw_if_index': next_hop_sw_if_index,
849 'table_id': table_id,
850 'classify_table_index': classify_table_index,
851 'next_hop_table_id': next_hop_table_id,
854 'is_unreach': is_unreach,
855 'is_prohibit': is_prohibit,
857 'is_local': is_local,
858 'is_classify': is_classify,
859 'is_multipath': is_multipath,
860 'is_resolve_host': is_resolve_host,
861 'is_resolve_attached': is_resolve_attached,
863 'is_source_lookup': is_source_lookup,
864 'is_udp_encap': is_udp_encap,
865 'next_hop_weight': next_hop_weight,
866 'dst_address_length': dst_address_length,
867 'dst_address': dst_address,
868 'next_hop_id': next_hop_id,
869 'next_hop_address': next_hop_address,
870 'next_hop_n_out_labels': next_hop_n_out_labels,
871 'next_hop_via_label': next_hop_via_label,
872 'next_hop_out_label_stack': next_hop_out_label_stack})
874 def ip_fib_dump(self):
875 return self.api(self.papi.ip_fib_dump, {})
877 def ip6_fib_dump(self):
878 return self.api(self.papi.ip6_fib_dump, {})
880 def ip_neighbor_add_del(self,
889 """ Add neighbor MAC to IPv4 or IPv6 address.
894 :param is_add: (Default value = 1)
895 :param is_ipv6: (Default value = 0)
896 :param is_static: (Default value = 0)
897 :param is_no_adj_fib: (Default value = 0)
901 self.papi.ip_neighbor_add_del,
902 {'sw_if_index': sw_if_index,
905 'is_static': is_static,
906 'is_no_adj_fib': is_no_adj_fib,
907 'mac_address': mac_address,
908 'dst_address': dst_address
912 def ip_neighbor_dump(self,
915 """ Return IP neighbor dump.
918 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
922 self.papi.ip_neighbor_dump,
924 'sw_if_index': sw_if_index
928 def proxy_arp_add_del(self,
933 """ Config Proxy Arp Range.
935 :param low_address: Start address in the rnage to Proxy for
936 :param hi_address: End address in the rnage to Proxy for
937 :param vrf_id: The VRF/table in which to proxy
941 self.papi.proxy_arp_add_del,
945 'low_address': low_address,
946 'hi_address': hi_address,
950 def proxy_arp_intfc_enable_disable(self,
953 """ Enable/Disable an interface for proxy ARP requests
955 :param sw_if_index: Interface
956 :param enable_disable: Enable/Disable
960 self.papi.proxy_arp_intfc_enable_disable,
961 {'sw_if_index': sw_if_index,
962 'enable_disable': is_enable
970 """ Reset VRF (remove all routes etc.) request.
972 :param int vrf_id: ID of the FIB table / VRF to reset.
973 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
987 """ Reset VRF (remove all routes etc.) request.
989 :param int vrf_id: ID of the FIB table / VRF to reset.
990 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1005 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1010 {'is_ipv6': is_ipv6,
1014 def sw_interface_span_enable_disable(
1015 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1018 :param sw_if_index_from:
1019 :param sw_if_index_to:
1023 return self.api(self.papi.sw_interface_span_enable_disable,
1024 {'sw_if_index_from': sw_if_index_from,
1025 'sw_if_index_to': sw_if_index_to,
1030 def gre_tunnel_add_del(self,
1035 instance=0xFFFFFFFF,
1039 """ Add a GRE tunnel
1043 :param outer_fib_id: (Default value = 0)
1044 :param tunnel_type: (Default value = 0)
1045 :param instance: (Default value = 0xFFFFFFFF)
1046 :param session_id: (Defalt value = 0)
1047 :param is_add: (Default value = 1)
1048 :param is_ipv6: (Default value = 0)
1052 self.papi.gre_add_del_tunnel,
1055 'tunnel_type': tunnel_type,
1056 'instance': instance,
1057 'src_address': src_address,
1058 'dst_address': dst_address,
1059 'outer_fib_id': outer_fib_id,
1060 'session_id': session_id}
1063 def udp_encap_add_del(self,
1072 """ Add a GRE tunnel
1073 :param id: user provided ID
1078 :param outer_fib_id: (Default value = 0)
1079 :param is_add: (Default value = 1)
1080 :param is_ipv6: (Default value = 0)
1084 self.papi.udp_encap_add_del,
1090 'src_port': src_port,
1091 'dst_port': dst_port,
1092 'table_id': table_id}
1095 def udp_encap_dump(self):
1096 return self.api(self.papi.udp_encap_dump, {})
1098 def want_udp_encap_stats(self, enable=1):
1099 return self.api(self.papi.want_udp_encap_stats,
1101 'pid': os.getpid()})
1103 def mpls_fib_dump(self):
1104 return self.api(self.papi.mpls_fib_dump, {})
1106 def mpls_table_add_del(
1113 :param is_add: (Default value = 1)
1118 self.papi.mpls_table_add_del,
1119 {'mt_table_id': table_id,
1120 'mt_is_add': is_add})
1122 def mpls_route_add_del(
1128 next_hop_sw_if_index=0xFFFFFFFF,
1130 next_hop_table_id=0,
1132 next_hop_n_out_labels=0,
1133 next_hop_out_label_stack=[],
1134 next_hop_via_label=MPLS_LABEL_INVALID,
1136 is_resolve_attached=0,
1143 classify_table_index=0xFFFFFFFF,
1147 :param dst_address_length:
1148 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1150 :param next_hop_address:
1151 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1152 :param vrf_id: (Default value = 0)
1153 :param lookup_in_vrf: (Default value = 0)
1154 :param classify_table_index: (Default value = 0xFFFFFFFF)
1155 :param is_add: (Default value = 1)
1156 :param is_drop: (Default value = 0)
1157 :param is_ipv6: (Default value = 0)
1158 :param is_local: (Default value = 0)
1159 :param is_classify: (Default value = 0)
1160 :param is_multipath: (Default value = 0)
1161 :param is_multicast: (Default value = 0)
1162 :param is_resolve_host: (Default value = 0)
1163 :param is_resolve_attached: (Default value = 0)
1164 :param next_hop_weight: (Default value = 1)
1168 self.papi.mpls_route_add_del,
1171 'mr_table_id': table_id,
1172 'mr_classify_table_index': classify_table_index,
1173 'mr_is_add': is_add,
1174 'mr_is_classify': is_classify,
1175 'mr_is_multipath': is_multipath,
1176 'mr_is_multicast': is_multicast,
1177 'mr_is_resolve_host': is_resolve_host,
1178 'mr_is_resolve_attached': is_resolve_attached,
1179 'mr_is_interface_rx': is_interface_rx,
1180 'mr_is_rpf_id': is_rpf_id,
1181 'mr_next_hop_proto': next_hop_proto,
1182 'mr_next_hop_weight': next_hop_weight,
1183 'mr_next_hop': next_hop_address,
1184 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1185 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1186 'mr_next_hop_table_id': next_hop_table_id,
1187 'mr_next_hop_via_label': next_hop_via_label,
1188 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1190 def mpls_ip_bind_unbind(
1202 self.papi.mpls_ip_bind_unbind,
1203 {'mb_mpls_table_id': table_id,
1205 'mb_ip_table_id': ip_table_id,
1206 'mb_is_bind': is_bind,
1207 'mb_is_ip4': is_ip4,
1208 'mb_address_length': dst_address_length,
1209 'mb_address': dst_address})
1211 def mpls_tunnel_add_del(
1214 next_hop_proto_is_ip4,
1216 next_hop_sw_if_index=0xFFFFFFFF,
1217 next_hop_table_id=0,
1219 next_hop_n_out_labels=0,
1220 next_hop_out_label_stack=[],
1221 next_hop_via_label=MPLS_LABEL_INVALID,
1227 :param dst_address_length:
1228 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1230 :param next_hop_address:
1231 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1232 :param vrf_id: (Default value = 0)
1233 :param lookup_in_vrf: (Default value = 0)
1234 :param classify_table_index: (Default value = 0xFFFFFFFF)
1235 :param is_add: (Default value = 1)
1236 :param is_drop: (Default value = 0)
1237 :param is_ipv6: (Default value = 0)
1238 :param is_local: (Default value = 0)
1239 :param is_classify: (Default value = 0)
1240 :param is_multipath: (Default value = 0)
1241 :param is_resolve_host: (Default value = 0)
1242 :param is_resolve_attached: (Default value = 0)
1243 :param next_hop_weight: (Default value = 1)
1244 :param is_multicast: (Default value = 0)
1248 self.papi.mpls_tunnel_add_del,
1249 {'mt_sw_if_index': tun_sw_if_index,
1250 'mt_is_add': is_add,
1251 'mt_l2_only': l2_only,
1252 'mt_is_multicast': is_multicast,
1253 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1254 'mt_next_hop_weight': next_hop_weight,
1255 'mt_next_hop': next_hop_address,
1256 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1257 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1258 'mt_next_hop_table_id': next_hop_table_id,
1259 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1261 def nat44_interface_add_del_feature(
1266 """Enable/disable NAT44 feature on the interface
1268 :param sw_if_index: Software index of the interface
1269 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1270 :param is_add: 1 if add, 0 if delete (Default value = 1)
1273 self.papi.nat44_interface_add_del_feature,
1275 'is_inside': is_inside,
1276 'sw_if_index': sw_if_index})
1278 def nat44_interface_add_del_output_feature(
1283 """Enable/disable NAT44 output feature on the interface
1285 :param sw_if_index: Software index of the interface
1286 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1287 :param is_add: 1 if add, 0 if delete (Default value = 1)
1290 self.papi.nat44_interface_add_del_output_feature,
1292 'is_inside': is_inside,
1293 'sw_if_index': sw_if_index})
1295 def nat44_add_del_static_mapping(
1299 external_sw_if_index=0xFFFFFFFF,
1310 """Add/delete NAT44 static mapping
1312 :param local_ip: Local IP address
1313 :param external_ip: External IP address
1314 :param external_sw_if_index: External interface instead of IP address
1315 :param local_port: Local port number (Default value = 0)
1316 :param external_port: External port number (Default value = 0)
1317 :param addr_only: 1 if address only mapping, 0 if address and port
1318 :param vrf_id: VRF ID
1319 :param protocol: IP protocol (Default value = 0)
1320 :param twice_nat: 1 if translate external host address and port
1321 :param self_twice_nat: 1 if translate external host address and port
1322 whenever external host address equals
1323 local address of internal host
1324 :param out2in_only: if 1 rule is matching only out2in direction
1325 :param tag: Opaque string tag
1326 :param is_add: 1 if add, 0 if delete (Default value = 1)
1329 self.papi.nat44_add_del_static_mapping,
1331 'addr_only': addr_only,
1332 'local_ip_address': local_ip,
1333 'external_ip_address': external_ip,
1334 'local_port': local_port,
1335 'external_port': external_port,
1336 'external_sw_if_index': external_sw_if_index,
1338 'protocol': protocol,
1339 'twice_nat': twice_nat,
1340 'self_twice_nat': self_twice_nat,
1341 'out2in_only': out2in_only,
1344 def nat44_add_del_identity_mapping(
1347 sw_if_index=0xFFFFFFFF,
1354 """Add/delete NAT44 identity mapping
1356 :param ip: IP address (Default value = 0)
1357 :param sw_if_index: Interface instead of IP address
1358 :param port: Port number (Default value = 0)
1359 :param addr_only: 1 if address only mapping, 0 if address and port
1360 :param vrf_id: VRF ID
1361 :param protocol: IP protocol (Default value = 0)
1362 :param tag: Opaque string tag
1363 :param is_add: 1 if add, 0 if delete (Default value = 1)
1366 self.papi.nat44_add_del_identity_mapping,
1368 'addr_only': addr_only,
1371 'sw_if_index': sw_if_index,
1374 'protocol': protocol})
1376 def nat44_add_del_address_range(
1383 """Add/del NAT44 address range
1385 :param first_ip_address: First IP address
1386 :param last_ip_address: Last IP address
1387 :param vrf_id: VRF id for the address range
1388 :param twice_nat: twice NAT address for extenal hosts
1389 :param is_add: 1 if add, 0 if delete (Default value = 1)
1392 self.papi.nat44_add_del_address_range,
1393 {'first_ip_address': first_ip_address,
1394 'last_ip_address': last_ip_address,
1396 'twice_nat': twice_nat,
1399 def nat44_address_dump(self):
1400 """Dump NAT44 addresses
1401 :return: Dictionary of NAT44 addresses
1403 return self.api(self.papi.nat44_address_dump, {})
1405 def nat44_interface_dump(self):
1406 """Dump interfaces with NAT44 feature
1407 :return: Dictionary of interfaces with NAT44 feature
1409 return self.api(self.papi.nat44_interface_dump, {})
1411 def nat44_interface_output_feature_dump(self):
1412 """Dump interfaces with NAT44 output feature
1413 :return: Dictionary of interfaces with NAT44 output feature
1415 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1417 def nat44_static_mapping_dump(self):
1418 """Dump NAT44 static mappings
1419 :return: Dictionary of NAT44 static mappings
1421 return self.api(self.papi.nat44_static_mapping_dump, {})
1423 def nat44_identity_mapping_dump(self):
1424 """Dump NAT44 identity mappings
1425 :return: Dictionary of NAT44 identity mappings
1427 return self.api(self.papi.nat44_identity_mapping_dump, {})
1429 def nat_show_config(self):
1430 """Show NAT plugin config
1431 :return: NAT plugin config parameters
1433 return self.api(self.papi.nat_show_config, {})
1435 def nat44_add_interface_addr(
1440 """Add/del NAT44 address from interface
1442 :param sw_if_index: Software index of the interface
1443 :param twice_nat: twice NAT address for extenal hosts
1444 :param is_add: 1 if add, 0 if delete (Default value = 1)
1447 self.papi.nat44_add_del_interface_addr,
1449 'sw_if_index': sw_if_index,
1450 'twice_nat': twice_nat})
1452 def nat44_interface_addr_dump(self):
1453 """Dump NAT44 addresses interfaces
1454 :return: Dictionary of NAT44 addresses interfaces
1456 return self.api(self.papi.nat44_interface_addr_dump, {})
1463 """Enable/disable NAT IPFIX logging
1465 :param domain_id: Observation domain ID (Default value = 1)
1466 :param src_port: Source port number (Default value = 4739)
1467 :param enable: 1 if enable, 0 if disable (Default value = 1)
1470 self.papi.nat_ipfix_enable_disable,
1471 {'domain_id': domain_id,
1472 'src_port': src_port,
1475 def nat44_user_session_dump(
1479 """Dump NAT44 user's sessions
1481 :param ip_address: ip adress of the user to be dumped
1482 :param cpu_index: cpu_index on which the user is
1483 :param vrf_id: VRF ID
1484 :return: Dictionary of S-NAT sessions
1487 self.papi.nat44_user_session_dump,
1488 {'ip_address': ip_address,
1491 def nat44_user_dump(self):
1494 :return: Dictionary of NAT44 users
1496 return self.api(self.papi.nat44_user_dump, {})
1498 def nat44_add_del_lb_static_mapping(
1511 """Add/delete NAT44 load balancing static mapping
1513 :param twice_nat: 1 if translate external host address and port
1514 :param tag: Opaque string tag
1515 :param is_add - 1 if add, 0 if delete
1518 self.papi.nat44_add_del_lb_static_mapping,
1520 'external_addr': external_addr,
1521 'external_port': external_port,
1522 'protocol': protocol,
1524 'twice_nat': twice_nat,
1525 'self_twice_nat': self_twice_nat,
1526 'out2in_only': out2in_only,
1528 'local_num': local_num,
1531 def nat44_lb_static_mapping_dump(self):
1532 """Dump NAT44 load balancing static mappings
1534 :return: Dictionary of NAT44 load balancing static mapping
1536 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1538 def nat44_del_session(
1545 ext_host_address=None,
1547 """Delete NAT44 session
1549 :param addr: IPv4 address
1550 :param por: port number
1551 :param protocol: IP protocol number
1552 :param vrf_id: VRF ID
1553 :param is_in: 1 if inside network addres and port pari, 0 if outside
1554 :param ext_host_address: external host IPv4 address
1555 :param ext_host_port: external host port
1557 if ext_host_address is None:
1559 self.papi.nat44_del_session,
1562 'protocol': protocol,
1567 self.papi.nat44_del_session,
1570 'protocol': protocol,
1573 'ext_host_valid': 1,
1574 'ext_host_address': ext_host_address,
1575 'ext_host_port': ext_host_port})
1577 def nat44_forwarding_enable_disable(
1580 """Enable/disable forwarding for NAT44
1582 :param enable: 1 for enable, 0 for disable
1585 self.papi.nat44_forwarding_enable_disable,
1595 """Set NAT virtual fragmentation reassembly
1597 :param timeout: reassembly timeout (Default 2sec)
1598 :param max_reass: maximum concurrent reassemblies (Default 1024)
1599 :param max_frag: maximum fragmets per reassembly (Default 5)
1600 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1601 :param is_ip6: 1 if IPv6, 0 if IPv4
1604 self.papi.nat_set_reass,
1605 {'timeout': timeout,
1606 'max_reass': max_reass,
1607 'max_frag': max_frag,
1608 'drop_frag': drop_frag,
1611 def nat_get_reass(self):
1612 """Get NAT virtual fragmentation reassembly configuration
1614 :return: NAT virtual fragmentation reassembly configuration
1616 return self.api(self.papi.nat_get_reass, {})
1618 def nat_reass_dump(self):
1619 """Dump NAT virtual fragmentation reassemblies
1621 :return: Dictionary of NAT virtual fragmentation reassemblies
1623 return self.api(self.papi.nat_reass_dump, {})
1625 def nat_det_add_del_map(
1632 """Add/delete deterministic NAT mapping
1634 :param is_add - 1 if add, 0 if delete
1635 :param in_addr - inside IP address
1636 :param in_plen - inside IP address prefix length
1637 :param out_addr - outside IP address
1638 :param out_plen - outside IP address prefix length
1641 self.papi.nat_det_add_del_map,
1646 'out_addr': out_addr,
1647 'out_plen': out_plen})
1649 def nat_det_forward(
1652 """Get outside address and port range from inside address
1654 :param in_addr - inside IP address
1657 self.papi.nat_det_forward,
1658 {'in_addr': in_addr,
1661 def nat_det_reverse(
1665 """Get inside address from outside address and port
1667 :param out_addr - outside IP address
1668 :param out_port - outside port
1671 self.papi.nat_det_reverse,
1672 {'out_addr': out_addr,
1673 'out_port': out_port})
1675 def nat_det_map_dump(self):
1676 """Dump deterministic NAT mappings
1678 :return: Dictionary of deterministic NAT mappings
1680 return self.api(self.papi.nat_det_map_dump, {})
1682 def nat_det_set_timeouts(
1685 tcp_established=7440,
1688 """Set values of timeouts for deterministic NAT (in seconds)
1690 :param udp - UDP timeout (Default value = 300)
1691 :param tcp_established - TCP established timeout (Default value = 7440)
1692 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1693 :param icmp - ICMP timeout (Default value = 60)
1696 self.papi.nat_det_set_timeouts,
1698 'tcp_established': tcp_established,
1699 'tcp_transitory': tcp_transitory,
1702 def nat_det_get_timeouts(self):
1703 """Get values of timeouts for deterministic NAT
1705 :return: Timeouts for deterministic NAT (in seconds)
1707 return self.api(self.papi.nat_det_get_timeouts, {})
1709 def nat_det_close_session_out(
1715 """Close deterministic NAT session using outside address and port
1717 :param out_addr - outside IP address
1718 :param out_port - outside port
1719 :param ext_addr - external host IP address
1720 :param ext_port - external host port
1723 self.papi.nat_det_close_session_out,
1724 {'out_addr': out_addr,
1725 'out_port': out_port,
1726 'ext_addr': ext_addr,
1727 'ext_port': ext_port})
1729 def nat_det_close_session_in(
1735 """Close deterministic NAT session using inside address and port
1737 :param in_addr - inside IP address
1738 :param in_port - inside port
1739 :param ext_addr - external host IP address
1740 :param ext_port - external host port
1743 self.papi.nat_det_close_session_in,
1744 {'in_addr': in_addr,
1746 'ext_addr': ext_addr,
1747 'ext_port': ext_port,
1750 def nat_det_session_dump(
1753 """Dump deterministic NAT sessions belonging to a user
1755 :param user_addr - inside IP address of the user
1756 :return: Dictionary of deterministic NAT sessions
1759 self.papi.nat_det_session_dump,
1761 'user_addr': user_addr})
1763 def nat64_add_del_pool_addr_range(
1769 """Add/del address range to NAT64 pool
1771 :param start_addr: First IP address
1772 :param end_addr: Last IP address
1773 :param vrf_id: VRF id for the address range
1774 :param is_add: 1 if add, 0 if delete (Default value = 1)
1777 self.papi.nat64_add_del_pool_addr_range,
1778 {'start_addr': start_addr,
1779 'end_addr': end_addr,
1783 def nat64_pool_addr_dump(self):
1784 """Dump NAT64 pool addresses
1785 :return: Dictionary of NAT64 pool addresses
1787 return self.api(self.papi.nat64_pool_addr_dump, {})
1789 def nat64_add_del_interface(
1794 """Enable/disable NAT64 feature on the interface
1795 :param sw_if_index: Index of the interface
1796 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1797 :param is_add: 1 if add, 0 if delete (Default value = 1)
1800 self.papi.nat64_add_del_interface,
1801 {'sw_if_index': sw_if_index,
1802 'is_inside': is_inside,
1805 def nat64_interface_dump(self):
1806 """Dump interfaces with NAT64 feature
1807 :return: Dictionary of interfaces with NAT64 feature
1809 return self.api(self.papi.nat64_interface_dump, {})
1811 def nat64_add_del_static_bib(
1820 """Add/delete S-NAT static BIB entry
1822 :param in_ip: Inside IPv6 address
1823 :param out_ip: Outside IPv4 address
1824 :param in_port: Inside port number
1825 :param out_port: Outside port number
1826 :param protocol: IP protocol
1827 :param vrf_id: VRF ID (Default value = 0)
1828 :param is_add: 1 if add, 0 if delete (Default value = 1)
1831 self.papi.nat64_add_del_static_bib,
1840 def nat64_bib_dump(self, protocol=255):
1843 :param protocol: IP protocol (Default value = 255, all BIBs)
1844 :returns: Dictionary of NAT64 BIB entries
1846 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1848 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1849 tcp_incoming_syn=6):
1850 """Set values of timeouts for NAT64 (in seconds)
1852 :param udpi: UDP timeout (Default value = 300)
1853 :param icmp: ICMP timeout (Default value = 60)
1854 :param tcp_trans: TCP transitory timeout (Default value = 240)
1855 :param tcp_est: TCP established timeout (Default value = 7440)
1856 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1859 self.papi.nat64_set_timeouts,
1862 'tcp_trans': tcp_trans,
1864 'tcp_incoming_syn': tcp_incoming_syn})
1866 def nat64_get_timeouts(self):
1867 """Get values of timeouts for NAT64
1869 :return: Timeouts for NAT64 (in seconds)
1871 return self.api(self.papi.nat64_get_timeouts, {})
1873 def nat64_st_dump(self, protocol=255):
1874 """Dump NAT64 session table
1876 :param protocol: IP protocol (Default value = 255, all STs)
1877 :returns: Dictionary of NAT64 sesstion table entries
1879 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1881 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1882 """Add/del NAT64 prefix
1884 :param prefix: NAT64 prefix
1885 :param plen: NAT64 prefix length
1886 :param vrf_id: VRF id of tenant (Default 0)
1887 :param is_add: 1 if add, 0 if delete (Default value = 1)
1890 self.papi.nat64_add_del_prefix,
1896 def nat64_prefix_dump(self):
1897 """Dump NAT64 prefix
1899 :returns: Dictionary of NAT64 prefixes
1901 return self.api(self.papi.nat64_prefix_dump, {})
1903 def nat64_add_interface_addr(
1907 """Add/del NAT64 address from interface
1909 :param sw_if_index: Software index of the interface
1910 :param is_add: 1 if add, 0 if delete (Default value = 1)
1912 return self.api(self.papi.nat64_add_del_interface_addr,
1913 {'is_add': is_add, 'sw_if_index': sw_if_index})
1915 def dslite_set_aftr_addr(self, ip6, ip4):
1916 """Set DS-Lite AFTR addresses
1918 :param ip4: IPv4 address
1919 :param ip6: IPv6 address
1922 self.papi.dslite_set_aftr_addr,
1926 def dslite_set_b4_addr(self, ip6, ip4):
1927 """Set DS-Lite B4 IPv6 address
1929 :param ip4: IPv4 address
1930 :param ip6: IPv6 address
1933 self.papi.dslite_set_b4_addr,
1937 def dslite_add_del_pool_addr_range(
1942 """Add/del address range to DS-Lite pool
1944 :param start_addr: First IP address
1945 :param end_addr: Last IP address
1946 :param is_add: 1 if add, 0 if delete (Default value = 1)
1949 self.papi.dslite_add_del_pool_addr_range,
1950 {'start_addr': start_addr,
1951 'end_addr': end_addr,
1954 def nat66_add_del_interface(
1959 """Enable/disable NAT66 feature on the interface
1960 :param sw_if_index: Index of the interface
1961 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1962 :param is_add: 1 if add, 0 if delete (Default value = 1)
1965 self.papi.nat66_add_del_interface,
1966 {'sw_if_index': sw_if_index,
1967 'is_inside': is_inside,
1970 def nat66_add_del_static_mapping(
1976 """Add/delete NAT66 static mapping
1978 :param in_ip: Inside IPv6 address
1979 :param out_ip: Outside IPv6 address
1980 :param vrf_id: VRF ID (Default value = 0)
1981 :param is_add: 1 if add, 0 if delete (Default value = 1)
1984 self.papi.nat66_add_del_static_mapping,
1985 {'local_ip_address': in_ip,
1986 'external_ip_address': out_ip,
1990 def nat66_interface_dump(self):
1991 """Dump interfaces with NAT66 feature
1992 :return: Dictionary of interfaces with NAT66 feature
1994 return self.api(self.papi.nat66_interface_dump, {})
1996 def nat66_static_mapping_dump(self):
1997 """Dump NAT66 static mappings
1998 :return: Dictionary of NAT66 static mappings
2000 return self.api(self.papi.nat66_static_mapping_dump, {})
2002 def control_ping(self):
2003 self.api(self.papi.control_ping)
2005 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2006 detect_mult, local_addr, peer_addr, is_ipv6=0,
2007 bfd_key_id=None, conf_key_id=None):
2008 if bfd_key_id is None:
2009 return self.api(self.papi.bfd_udp_add,
2011 'sw_if_index': sw_if_index,
2012 'desired_min_tx': desired_min_tx,
2013 'required_min_rx': required_min_rx,
2014 'local_addr': local_addr,
2015 'peer_addr': peer_addr,
2017 'detect_mult': detect_mult,
2020 return self.api(self.papi.bfd_udp_add,
2022 'sw_if_index': sw_if_index,
2023 'desired_min_tx': desired_min_tx,
2024 'required_min_rx': required_min_rx,
2025 'local_addr': local_addr,
2026 'peer_addr': peer_addr,
2028 'detect_mult': detect_mult,
2029 'is_authenticated': 1,
2030 'bfd_key_id': bfd_key_id,
2031 'conf_key_id': conf_key_id,
2034 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2035 detect_mult, local_addr, peer_addr, is_ipv6=0):
2036 return self.api(self.papi.bfd_udp_mod,
2038 'sw_if_index': sw_if_index,
2039 'desired_min_tx': desired_min_tx,
2040 'required_min_rx': required_min_rx,
2041 'local_addr': local_addr,
2042 'peer_addr': peer_addr,
2044 'detect_mult': detect_mult,
2047 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2048 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2050 return self.api(self.papi.bfd_udp_auth_activate,
2052 'sw_if_index': sw_if_index,
2053 'local_addr': local_addr,
2054 'peer_addr': peer_addr,
2056 'is_delayed': 1 if is_delayed else 0,
2057 'bfd_key_id': bfd_key_id,
2058 'conf_key_id': conf_key_id,
2061 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2062 is_ipv6=0, is_delayed=False):
2063 return self.api(self.papi.bfd_udp_auth_deactivate,
2065 'sw_if_index': sw_if_index,
2066 'local_addr': local_addr,
2067 'peer_addr': peer_addr,
2069 'is_delayed': 1 if is_delayed else 0,
2072 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2073 return self.api(self.papi.bfd_udp_del,
2075 'sw_if_index': sw_if_index,
2076 'local_addr': local_addr,
2077 'peer_addr': peer_addr,
2081 def bfd_udp_session_dump(self):
2082 return self.api(self.papi.bfd_udp_session_dump, {})
2084 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2085 peer_addr, is_ipv6=0):
2086 return self.api(self.papi.bfd_udp_session_set_flags, {
2087 'admin_up_down': admin_up_down,
2088 'sw_if_index': sw_if_index,
2089 'local_addr': local_addr,
2090 'peer_addr': peer_addr,
2094 def want_bfd_events(self, enable_disable=1):
2095 return self.api(self.papi.want_bfd_events, {
2096 'enable_disable': enable_disable,
2100 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2101 return self.api(self.papi.bfd_auth_set_key, {
2102 'conf_key_id': conf_key_id,
2103 'auth_type': auth_type,
2105 'key_len': len(key),
2108 def bfd_auth_del_key(self, conf_key_id):
2109 return self.api(self.papi.bfd_auth_del_key, {
2110 'conf_key_id': conf_key_id,
2113 def bfd_auth_keys_dump(self):
2114 return self.api(self.papi.bfd_auth_keys_dump, {})
2116 def bfd_udp_set_echo_source(self, sw_if_index):
2117 return self.api(self.papi.bfd_udp_set_echo_source,
2118 {'sw_if_index': sw_if_index})
2120 def bfd_udp_del_echo_source(self):
2121 return self.api(self.papi.bfd_udp_del_echo_source, {})
2123 def classify_add_del_table(
2128 table_index=0xFFFFFFFF,
2130 memory_size=2097152,
2132 next_table_index=0xFFFFFFFF,
2133 miss_next_index=0xFFFFFFFF,
2134 current_data_flag=0,
2135 current_data_offset=0):
2139 :param match_n_vectors: (Default value = 1)
2140 :param table_index: (Default value = 0xFFFFFFFF)
2141 :param nbuckets: (Default value = 2)
2142 :param memory_size: (Default value = 2097152)
2143 :param skip_n_vectors: (Default value = 0)
2144 :param next_table_index: (Default value = 0xFFFFFFFF)
2145 :param miss_next_index: (Default value = 0xFFFFFFFF)
2146 :param current_data_flag: (Default value = 0)
2147 :param current_data_offset: (Default value = 0)
2151 self.papi.classify_add_del_table,
2153 'table_index': table_index,
2154 'nbuckets': nbuckets,
2155 'memory_size': memory_size,
2156 'skip_n_vectors': skip_n_vectors,
2157 'match_n_vectors': match_n_vectors,
2158 'next_table_index': next_table_index,
2159 'miss_next_index': miss_next_index,
2160 'current_data_flag': current_data_flag,
2161 'current_data_offset': current_data_offset,
2164 def classify_add_del_session(
2169 opaque_index=0xFFFFFFFF,
2170 hit_next_index=0xFFFFFFFF,
2178 :param opaque_index: (Default value = 0xFFFFFFFF)
2179 :param hit_next_index: (Default value = 0xFFFFFFFF)
2180 :param advance: (Default value = 0)
2181 :param action: (Default value = 0)
2182 :param metadata: (Default value = 0)
2186 self.papi.classify_add_del_session,
2188 'table_index': table_index,
2189 'hit_next_index': hit_next_index,
2190 'opaque_index': opaque_index,
2193 'metadata': metadata,
2196 def input_acl_set_interface(
2200 ip4_table_index=0xFFFFFFFF,
2201 ip6_table_index=0xFFFFFFFF,
2202 l2_table_index=0xFFFFFFFF):
2206 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2207 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2208 :param l2_table_index: (Default value = 0xFFFFFFFF)
2212 self.papi.input_acl_set_interface,
2213 {'sw_if_index': sw_if_index,
2214 'ip4_table_index': ip4_table_index,
2215 'ip6_table_index': ip6_table_index,
2216 'l2_table_index': l2_table_index,
2219 def output_acl_set_interface(
2223 ip4_table_index=0xFFFFFFFF,
2224 ip6_table_index=0xFFFFFFFF,
2225 l2_table_index=0xFFFFFFFF):
2229 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2230 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2231 :param l2_table_index: (Default value = 0xFFFFFFFF)
2235 self.papi.output_acl_set_interface,
2236 {'sw_if_index': sw_if_index,
2237 'ip4_table_index': ip4_table_index,
2238 'ip6_table_index': ip6_table_index,
2239 'l2_table_index': l2_table_index,
2242 def set_ipfix_exporter(
2249 collector_port=4739,
2252 self.papi.set_ipfix_exporter,
2254 'collector_address': collector_address,
2255 'collector_port': collector_port,
2256 'src_address': src_address,
2258 'path_mtu': path_mtu,
2259 'template_interval': template_interval,
2260 'udp_checksum': udp_checksum,
2263 def dhcp_proxy_config(self,
2271 self.papi.dhcp_proxy_config,
2273 'rx_vrf_id': rx_table_id,
2274 'server_vrf_id': server_table_id,
2277 'dhcp_server': dhcp_server,
2278 'dhcp_src_address': dhcp_src_address,
2281 def dhcp_proxy_set_vss(self,
2290 self.papi.dhcp_proxy_set_vss,
2293 'vss_type': vss_type,
2294 'vpn_ascii_id': vpn_ascii_id,
2296 'vpn_index': vpn_index,
2301 def dhcp_client(self,
2306 set_broadcast_flag=1,
2307 want_dhcp_events=0):
2309 self.papi.dhcp_client_config,
2311 'sw_if_index': sw_if_index,
2312 'hostname': hostname,
2313 'client_id': client_id,
2315 'want_dhcp_event': want_dhcp_events,
2316 'set_broadcast_flag': set_broadcast_flag,
2320 def ip_mroute_add_del(self,
2326 next_hop_sw_if_index,
2336 IP Multicast Route add/del
2339 self.papi.ip_mroute_add_del,
2340 {'next_hop_sw_if_index': next_hop_sw_if_index,
2341 'entry_flags': e_flags,
2342 'itf_flags': i_flags,
2343 'table_id': table_id,
2347 'is_local': is_local,
2348 'bier_imp': bier_imp,
2349 'next_hop_afi': next_hop_afi,
2350 'grp_address_length': grp_address_length,
2351 'grp_address': grp_address,
2352 'src_address': src_address,
2353 'nh_address': next_hop_address})
2355 def mfib_signal_dump(self):
2356 return self.api(self.papi.mfib_signal_dump, {})
2358 def ip_mfib_dump(self):
2359 return self.api(self.papi.ip_mfib_dump, {})
2361 def ip6_mfib_dump(self):
2362 return self.api(self.papi.ip6_mfib_dump, {})
2364 def lisp_enable_disable(self, is_enabled):
2366 self.papi.lisp_enable_disable,
2368 'is_en': is_enabled,
2371 def lisp_locator_set(self,
2375 self.papi.lisp_add_del_locator_set,
2378 'locator_set_name': ls_name
2381 def lisp_locator_set_dump(self):
2382 return self.api(self.papi.lisp_locator_set_dump, {})
2384 def lisp_locator(self,
2391 self.papi.lisp_add_del_locator,
2394 'locator_set_name': ls_name,
2395 'sw_if_index': sw_if_index,
2396 'priority': priority,
2400 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2402 self.papi.lisp_locator_dump,
2404 'is_index_set': is_index_set,
2406 'ls_index': ls_index,
2409 def lisp_local_mapping(self,
2419 self.papi.lisp_add_del_local_eid,
2421 'locator_set_name': ls_name,
2423 'eid_type': eid_type,
2425 'prefix_len': prefix_len,
2431 def lisp_eid_table_dump(self,
2439 self.papi.lisp_eid_table_dump,
2442 'prefix_length': prefix_length,
2444 'eid_type': eid_type,
2446 'filter': filter_opt,
2449 def lisp_remote_mapping(self,
2459 self.papi.lisp_add_del_remote_mapping,
2462 'eid_type': eid_type,
2464 'eid_len': eid_prefix_len,
2465 'rloc_num': rlocs_num,
2468 'is_src_dst': is_src_dst,
2471 def lisp_adjacency(self,
2480 self.papi.lisp_add_del_adjacency,
2484 'eid_type': eid_type,
2487 'leid_len': leid_len,
2488 'reid_len': reid_len,
2491 def lisp_adjacencies_get(self, vni=0):
2493 self.papi.lisp_adjacencies_get,
2498 def map_add_domain(self,
2512 self.papi.map_add_domain,
2514 'ip6_prefix': ip6_prefix,
2515 'ip6_prefix_len': ip6_prefix_len,
2516 'ip4_prefix': ip4_prefix,
2517 'ip4_prefix_len': ip4_prefix_len,
2519 'ip6_src_prefix_len': ip6_src_prefix_len,
2520 'ea_bits_len': ea_bits_len,
2521 'psid_offset': psid_offset,
2522 'psid_length': psid_length,
2523 'is_translation': is_translation,
2524 'is_rfc6052': is_rfc6052,
2528 def gtpu_add_del_tunnel(
2534 mcast_sw_if_index=0xFFFFFFFF,
2536 decap_next_index=0xFFFFFFFF,
2540 :param is_add: (Default value = 1)
2541 :param is_ipv6: (Default value = 0)
2544 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2545 :param encap_vrf_id: (Default value = 0)
2546 :param decap_next_index: (Default value = 0xFFFFFFFF)
2547 :param teid: (Default value = 0)
2550 return self.api(self.papi.gtpu_add_del_tunnel,
2553 'src_address': src_addr,
2554 'dst_address': dst_addr,
2555 'mcast_sw_if_index': mcast_sw_if_index,
2556 'encap_vrf_id': encap_vrf_id,
2557 'decap_next_index': decap_next_index,
2560 def vxlan_gpe_add_del_tunnel(
2564 mcast_sw_if_index=0xFFFFFFFF,
2575 :param is_add: (Default value = 1)
2576 :param is_ipv6: (Default value = 0)
2577 :param encap_vrf_id: (Default value = 0)
2578 :param decap_vrf_id: (Default value = 0)
2579 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2580 :param protocol: (Default value = 3)
2581 :param vni: (Default value = 0)
2584 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2589 'mcast_sw_if_index': mcast_sw_if_index,
2590 'encap_vrf_id': encap_vrf_id,
2591 'decap_vrf_id': decap_vrf_id,
2592 'protocol': protocol,
2595 def pppoe_add_del_session(
2605 :param is_add: (Default value = 1)
2606 :param is_ipv6: (Default value = 0)
2608 :param session_id: (Default value = 0)
2610 :param decap_vrf_id: (Default value = 0)
2613 return self.api(self.papi.pppoe_add_del_session,
2616 'session_id': session_id,
2617 'client_ip': client_ip,
2618 'decap_vrf_id': decap_vrf_id,
2619 'client_mac': client_mac})
2621 def sr_localsid_add_del(self,
2627 sw_if_index=0xFFFFFFFF,
2631 """ Add/del IPv6 SR local-SID.
2633 :param localsid_addr:
2634 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2635 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2637 :param is_del: (Default value = 0)
2638 :param end_psp: (Default value = 0)
2639 :param sw_if_index: (Default value = 0xFFFFFFFF)
2640 :param vlan_index: (Default value = 0)
2641 :param fib_table: (Default value = 0)
2644 self.papi.sr_localsid_add_del,
2646 'localsid_addr': localsid_addr,
2648 'behavior': behavior,
2649 'sw_if_index': sw_if_index,
2650 'vlan_index': vlan_index,
2651 'fib_table': fib_table,
2666 :param bsid_addr: bindingSID of the SR Policy
2667 :param weight: weight of the sid list. optional. (default: 1)
2668 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2670 :param type: type/behavior of the SR policy. (default or spray) \
2672 :param fib_table: VRF where to install the FIB entry for the BSID \
2674 :param n_segments: number of segments \
2676 :param segments: a vector of IPv6 address composing the segment list \
2680 self.papi.sr_policy_add,
2681 {'bsid_addr': bsid_addr,
2683 'is_encap': is_encap,
2685 'fib_table': fib_table,
2686 'n_segments': n_segments,
2687 'segments': segments
2696 :param bsid: bindingSID of the SR Policy
2697 :param sr_policy_index: index of the sr policy (default: 0)
2700 self.papi.sr_policy_del,
2701 {'bsid_addr': bsid_addr,
2702 'sr_policy_index': sr_policy_index
2705 def sr_steering_add_del(
2716 Steer traffic L2 and L3 traffic through a given SR policy
2718 :param is_del: delete or add
2719 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2720 :param sr_policy: is the index of the SR Policy (alt to bsid)
2721 :param table_id: is the VRF where to install the FIB entry for the BSID
2722 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2723 :param mask_width: is the mask for L3 traffic type
2724 :param sw_if_index: is the incoming interface for L2 traffic
2725 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2728 self.papi.sr_steering_add_del,
2730 'bsid_addr': bsid_addr,
2731 'sr_policy_index': sr_policy_index,
2732 'table_id': table_id,
2733 'prefix_addr': prefix_addr,
2734 'mask_width': mask_width,
2735 'sw_if_index': sw_if_index,
2736 'traffic_type': traffic_type
2739 def acl_add_replace(self, acl_index, r, tag='',
2741 """Add/replace an ACL
2742 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2743 :param acl_rule r: ACL rules array.
2744 :param str tag: symbolic tag (description) for this ACL.
2745 :param int count: number of rules.
2747 return self.api(self.papi.acl_add_replace,
2748 {'acl_index': acl_index,
2752 expected_retval=expected_retval)
2754 def acl_del(self, acl_index, expected_retval=0):
2760 return self.api(self.papi.acl_del,
2761 {'acl_index': acl_index},
2762 expected_retval=expected_retval)
2764 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2766 return self.api(self.papi.acl_interface_set_acl_list,
2767 {'sw_if_index': sw_if_index,
2771 expected_retval=expected_retval)
2773 def acl_interface_set_etype_whitelist(self, sw_if_index,
2776 return self.api(self.papi.acl_interface_set_etype_whitelist,
2777 {'sw_if_index': sw_if_index,
2778 'count': len(whitelist),
2780 'whitelist': whitelist},
2781 expected_retval=expected_retval)
2783 def acl_interface_add_del(self,
2787 """ Add/Delete ACL to/from interface
2791 :param is_add: (Default value = 1)
2794 return self.api(self.papi.acl_interface_add_del,
2797 'sw_if_index': sw_if_index,
2798 'acl_index': acl_index})
2800 def acl_dump(self, acl_index, expected_retval=0):
2801 return self.api(self.papi.acl_dump,
2802 {'acl_index': acl_index},
2803 expected_retval=expected_retval)
2805 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2807 return self.api(self.papi.acl_interface_list_dump,
2808 {'sw_if_index': sw_if_index},
2809 expected_retval=expected_retval)
2811 def macip_acl_add(self, rules, tag=""):
2814 :param rules: list of rules for given acl
2818 return self.api(self.papi.macip_acl_add,
2820 'count': len(rules),
2823 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2826 :param rules: list of rules for given acl
2830 return self.api(self.papi.macip_acl_add_replace,
2831 {'acl_index': acl_index,
2833 'count': len(rules),
2836 def macip_acl_del(self, acl_index):
2842 return self.api(self.papi.macip_acl_del,
2843 {'acl_index': acl_index})
2845 def macip_acl_interface_add_del(self,
2849 """ Add MACIP acl to interface
2853 :param is_add: (Default value = 1)
2856 return self.api(self.papi.macip_acl_interface_add_del,
2858 'sw_if_index': sw_if_index,
2859 'acl_index': acl_index})
2861 def macip_acl_interface_get(self):
2862 """ Return interface acls dump
2865 self.papi.macip_acl_interface_get, {})
2867 def macip_acl_dump(self, acl_index=4294967295):
2868 """ Return MACIP acl dump
2872 self.papi.macip_acl_dump, {'acl_index': acl_index})
2874 def policer_add_del(self,
2885 conform_action_type=1,
2887 exceed_action_type=0,
2889 violate_action_type=0,
2891 return self.api(self.papi.policer_add_del,
2898 'rate_type': rate_type,
2899 'round_type': round_type,
2901 'color_aware': color_aware,
2902 'conform_action_type': conform_action_type,
2903 'conform_dscp': conform_dscp,
2904 'exceed_action_type': exceed_action_type,
2905 'exceed_dscp': exceed_dscp,
2906 'violate_action_type': violate_action_type,
2907 'violate_dscp': violate_dscp})
2909 def ip_punt_police(self,
2913 return self.api(self.papi.ip_punt_police,
2914 {'policer_index': policer_index,
2918 def ip_punt_redirect(self,
2924 return self.api(self.papi.ip_punt_redirect,
2925 {'rx_sw_if_index': rx_sw_if_index,
2926 'tx_sw_if_index': tx_sw_if_index,
2931 def bier_table_add_del(self,
2935 """ BIER Table add/del """
2937 self.papi.bier_table_add_del,
2938 {'bt_tbl_id': {"bt_set": bti.set_id,
2939 "bt_sub_domain": bti.sub_domain_id,
2940 "bt_hdr_len_id": bti.hdr_len_id},
2941 'bt_label': mpls_label,
2942 'bt_is_add': is_add})
2944 def bier_table_dump(self):
2945 return self.api(self.papi.bier_table_dump, {})
2947 def bier_route_add_del(self,
2952 """ BIER Route add/del """
2954 self.papi.bier_route_add_del,
2955 {'br_tbl_id': {"bt_set": bti.set_id,
2956 "bt_sub_domain": bti.sub_domain_id,
2957 "bt_hdr_len_id": bti.hdr_len_id},
2959 'br_n_paths': len(paths),
2961 'br_is_add': is_add})
2963 def bier_route_dump(self, bti):
2965 self.papi.bier_route_dump,
2966 {'br_tbl_id': {"bt_set": bti.set_id,
2967 "bt_sub_domain": bti.sub_domain_id,
2968 "bt_hdr_len_id": bti.hdr_len_id}})
2970 def bier_imp_add(self,
2975 """ BIER Imposition Add """
2977 self.papi.bier_imp_add,
2978 {'bi_tbl_id': {"bt_set": bti.set_id,
2979 "bt_sub_domain": bti.sub_domain_id,
2980 "bt_hdr_len_id": bti.hdr_len_id},
2982 'bi_n_bytes': len(ibytes),
2983 'bi_bytes': ibytes})
2985 def bier_imp_del(self, bi_index):
2986 """ BIER Imposition del """
2988 self.papi.bier_imp_del,
2989 {'bi_index': bi_index})
2991 def bier_imp_dump(self):
2992 return self.api(self.papi.bier_imp_dump, {})
2994 def bier_disp_table_add_del(self,
2997 """ BIER Disposition Table add/del """
2999 self.papi.bier_disp_table_add_del,
3000 {'bdt_tbl_id': bdti,
3001 'bdt_is_add': is_add})
3003 def bier_disp_table_dump(self):
3004 return self.api(self.papi.bier_disp_table_dump, {})
3006 def bier_disp_entry_add_del(self,
3016 """ BIER Route add/del """
3018 while (len(lstack) < 16):
3021 self.papi.bier_disp_entry_add_del,
3022 {'bde_tbl_id': bdti,
3024 'bde_payload_proto': payload_proto,
3026 'bde_paths': [{'next_hop': next_hop,
3027 'table_id': next_hop_tbl_id,
3028 'afi': next_hop_afi,
3029 'rpf_id': next_hop_rpf_id,
3031 'label_stack': lstack}],
3032 'bde_is_add': is_add})
3034 def bier_disp_entry_dump(self, bdti):
3036 self.papi.bier_disp_entry_dump,
3037 {'bde_tbl_id': bdti})
3039 def add_node_next(self, node_name, next_name):
3040 """ Set the next node for a given node request
3045 return self.api(self.papi.add_node_next,
3046 {'node_name': node_name,
3047 'next_name': next_name})
3049 def session_enable_disable(self, is_enabled):
3051 self.papi.session_enable_disable,
3052 {'is_enable': is_enabled})
3054 def ipsec_spd_add_del(self, spd_id, is_add=1):
3055 """ SPD add/del - Wrapper to add or del ipsec SPD
3056 Sample CLI : 'ipsec spd add 1'
3058 :param spd_id - SPD ID to be created in the vpp . mandatory
3059 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3061 :returns: reply from the API
3064 self.papi.ipsec_spd_add_del, {
3065 'spd_id': spd_id, 'is_add': is_add})
3067 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3068 """ IPSEC interface SPD add/del - \
3069 Wrapper to associate/disassociate SPD to interface in VPP
3070 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3072 :param spd_id - SPD ID to associate with the interface . mandatory
3073 :param sw_if_index - Interface Index which needs to ipsec \
3074 association mandatory
3075 :param is_add - add(1) or del(0) association with interface \
3076 (Default 1 - add) . optional
3077 :returns: reply from the API
3080 self.papi.ipsec_interface_add_del_spd,
3081 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3083 def ipsec_sad_add_del_entry(self,
3086 tunnel_src_address='',
3087 tunnel_dst_address='',
3089 integrity_algorithm=2,
3090 integrity_key_length=0,
3091 integrity_key='C91KUR9GYMm5GfkEvNjX',
3093 crypto_key_length=0,
3094 crypto_key='JPjyOWBeVEQiMe7h',
3098 """ IPSEC SA add/del
3099 Sample CLI : 'ipsec sa add 10 spi 1001 esp \
3100 crypto-key 4a506a794f574265564551694d653768 \
3101 crypto-alg aes-cbc-128 \
3102 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3103 integ-alg sha1-96 tunnel-src 192.168.100.3 \
3104 tunnel-dst 192.168.100.2'
3105 Sample CLI : 'ipsec sa add 20 spi 2001 \
3106 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3109 :param sad_id - Security Association ID to be \
3110 created or deleted. mandatory
3111 :param spi - security param index of the SA in decimal. mandatory
3112 :param tunnel_src_address - incase of tunnel mode outer src address .\
3113 mandatory for tunnel mode
3114 :param tunnel_dst_address - incase of transport mode \
3115 outer dst address. mandatory for tunnel mode
3116 :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional
3117 :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\
3119 :param integrity_key - value in string \
3120 (Default C91KUR9GYMm5GfkEvNjX).optional
3121 :param integrity_key_length - length of the key string in bytes\
3122 (Default 0 - integrity disabled). optional
3123 :param crypto_algorithm - value range 1-11 Default \
3124 (1- AES_CBC_128).optional **
3125 :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional
3126 :param crypto_key_length - length of the key string in bytes\
3127 (Default 0 - crypto disabled). optional
3128 :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\
3130 :param is_tunnel - tunnel mode (1) or transport mode(0) \
3131 (Default 1 - tunnel). optional
3132 :returns: reply from the API
3133 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3134 crypto and ipsec algorithms
3137 self.papi.ipsec_sad_add_del_entry,
3140 'tunnel_src_address': tunnel_src_address,
3141 'tunnel_dst_address': tunnel_dst_address,
3142 'protocol': protocol,
3143 'integrity_algorithm': integrity_algorithm,
3144 'integrity_key_length': integrity_key_length,
3145 'integrity_key': integrity_key,
3146 'crypto_algorithm': crypto_algorithm,
3147 'crypto_key_length': crypto_key_length,
3148 'crypto_key': crypto_key,
3150 'is_tunnel': is_tunnel,
3151 'udp_encap': udp_encap})
3153 def ipsec_spd_add_del_entry(self,
3155 local_address_start,
3157 remote_address_start,
3158 remote_address_stop,
3160 local_port_stop=65535,
3161 remote_port_start=0,
3162 remote_port_stop=65535,
3170 """ IPSEC policy SPD add/del -
3171 Wrapper to configure ipsec SPD policy entries in VPP
3172 Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \
3173 protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \
3174 remote-ip-range 192.168.3.3 - 192.168.3.3'
3176 :param spd_id - SPD ID for the policy . mandatory
3177 :param local_address_start - local-ip-range start address . mandatory
3178 :param local_address_stop - local-ip-range stop address . mandatory
3179 :param remote_address_start - remote-ip-range start address . mandatory
3180 :param remote_address_stop - remote-ip-range stop address . mandatory
3181 :param local_port_start - (Default 0) . optional
3182 :param local_port_stop - (Default 65535). optional
3183 :param remote_port_start - (Default 0). optional
3184 :param remote_port_stop - (Default 65535). optional
3185 :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any).
3187 :param sa_id - Security Association ID for mapping it to SPD
3188 (default 10). optional
3189 :param policy - bypass(0), discard(1), resolve(2) or protect(3)action
3190 (Default 0 - bypass). optional
3191 :param priotity - value for the spd action (Default 100). optional
3192 :param is_outbound - flag for inbound(0) or outbound(1)
3193 (Default 1 - outbound). optional
3194 :param is_add flag - for addition(1) or deletion(0) of the spd
3195 (Default 1 - addtion). optional
3196 :returns: reply from the API
3199 self.papi.ipsec_spd_add_del_entry,
3201 'local_address_start': local_address_start,
3202 'local_address_stop': local_address_stop,
3203 'remote_address_start': remote_address_start,
3204 'remote_address_stop': remote_address_stop,
3205 'local_port_start': local_port_start,
3206 'local_port_stop': local_port_stop,
3207 'remote_port_start': remote_port_start,
3208 'remote_port_stop': remote_port_stop,
3210 'protocol': protocol,
3212 'priority': priority,
3213 'is_outbound': is_outbound,
3215 'is_ip_any': is_ip_any})
3217 def app_namespace_add(self,
3221 sw_if_index=0xFFFFFFFF,
3224 self.papi.app_namespace_add_del,
3226 'sw_if_index': sw_if_index,
3227 'ip4_fib_id': ip4_fib_id,
3228 'ip6_fib_id': ip6_fib_id,
3229 'namespace_id': namespace_id,
3230 'namespace_id_len': len(namespace_id)})
3232 def punt_socket_register(self, l4_port, pathname, header_version=1,
3233 is_ip4=1, l4_protocol=0x11):
3234 """ Punt to socket """
3235 return self.api(self.papi.punt_socket_register,
3237 'l4_protocol': l4_protocol,
3239 'pathname': pathname,
3240 'header_version': header_version})
3242 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3243 expire_walk_interval_ms, is_ip6=0):
3244 """ Set IP reassembly parameters """
3245 return self.api(self.papi.ip_reassembly_set,
3247 'timeout_ms': timeout_ms,
3248 'expire_walk_interval_ms': expire_walk_interval_ms,
3249 'max_reassemblies': max_reassemblies})
3251 def ip_reassembly_get(self, is_ip6=0):
3252 """ Get IP reassembly parameters """
3253 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3255 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3257 """ Enable/disable IP reassembly """
3258 return self.api(self.papi.ip_reassembly_enable_disable,
3259 {'sw_if_index': sw_if_index,
3260 'enable_ip4': 1 if enable_ip4 else 0,
3261 'enable_ip6': 1 if enable_ip6 else 0,
3264 def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
3265 """ GBP endpoint Add/Del """
3266 return self.api(self.papi.gbp_endpoint_add_del,
3270 'sw_if_index': sw_if_index,
3274 def gbp_endpoint_dump(self):
3275 """ GBP endpoint Dump """
3276 return self.api(self.papi.gbp_endpoint_dump, {})
3278 def gbp_endpoint_group_add_del(self, is_add, epg, bd,
3281 uplink_sw_if_index):
3282 """ GBP endpoint group Add/Del """
3283 return self.api(self.papi.gbp_endpoint_group_add_del,
3286 'uplink_sw_if_index': uplink_sw_if_index,
3288 'ip4_table_id': ip4_rd,
3289 'ip6_table_id': ip6_rd,
3292 def gbp_endpoint_group_dump(self):
3293 """ GBP endpoint group Dump """
3294 return self.api(self.papi.gbp_endpoint_group_dump, {})
3296 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3297 """ GBP recirc Add/Del """
3298 return self.api(self.papi.gbp_recirc_add_del,
3302 'sw_if_index': sw_if_index,
3305 def gbp_recirc_dump(self):
3306 """ GBP recirc Dump """
3307 return self.api(self.papi.gbp_recirc_dump, {})
3309 def gbp_subnet_add_del(self, is_add, table_id,
3312 sw_if_index=0xffffffff,
3315 """ GBP Subnet Add/Del """
3316 return self.api(self.papi.gbp_subnet_add_del,
3319 'is_internal': is_internal,
3321 'sw_if_index': sw_if_index,
3324 'address_length': addr_len,
3325 'table_id': table_id}})
3327 def gbp_subnet_dump(self):
3328 """ GBP Subnet Dump """
3329 return self.api(self.papi.gbp_subnet_dump, {})
3331 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3332 """ GBP contract Add/Del """
3333 return self.api(self.papi.gbp_contract_add_del,
3336 'acl_index': acl_index,
3338 'dst_epg': dst_epg}})
3340 def gbp_contract_dump(self):
3341 """ GBP contract Dump """
3342 return self.api(self.papi.gbp_contract_dump, {})
3344 def ipip_6rd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len,
3345 ip4_prefix, ip4_prefix_len, ip4_src,
3347 """ 6RD tunnel Add """
3348 return self.api(self.papi.ipip_6rd_add_tunnel,
3349 {'fib_index': fib_index,
3350 'ip6_prefix': ip6_prefix,
3351 'ip6_prefix_len': ip6_prefix_len,
3352 'ip4_prefix': ip4_prefix,
3353 'ip4_prefix_len': ip4_prefix_len,
3355 'security_check': security_check})
3357 def ipip_6rd_del_tunnel(self, sw_if_index):
3358 """ 6RD tunnel Delete """
3359 return self.api(self.papi.ipip_6rd_del_tunnel,
3360 {'sw_if_index': sw_if_index})
3362 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3363 instance=0xFFFFFFFF, fib_index=0, tc_tos=0):
3364 """ IPIP tunnel Add/Del """
3365 return self.api(self.papi.ipip_add_tunnel,
3366 {'is_ipv6': is_ipv6,
3367 'instance': instance,
3368 'src_address': src_address,
3369 'dst_address': dst_address,
3370 'fib_index': fib_index,
3373 def ipip_del_tunnel(self, sw_if_index):
3374 """ IPIP tunnel Delete """
3375 return self.api(self.papi.ipip_del_tunnel,
3376 {'sw_if_index': sw_if_index})
3378 def qos_egress_map_update(self, id, outputs):
3379 """ QOS egress map update """
3380 return self.api(self.papi.qos_egress_map_update,
3384 def qos_egress_map_delete(self, id):
3385 """ QOS egress map delete """
3386 return self.api(self.papi.qos_egress_map_delete,
3389 def qos_mark_enable_disable(self, sw_if_index,
3393 """ QOS Mark Enable/Disable """
3394 return self.api(self.papi.qos_mark_enable_disable,
3396 'sw_if_index': sw_if_index,
3397 'output_source': output_source,
3400 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3401 """ IP QoS recording Enble/Disable """
3402 return self.api(self.papi.qos_record_enable_disable,
3403 {'sw_if_index': sw_if_index,
3404 'input_source': input_source,
3407 def igmp_listen(self, enable, sw_if_index, saddr, gaddr):
3408 """ Listen for new (S,G) on specified interface
3410 :param enable: add/del
3411 :param sw_if_index: interface sw index
3412 :param saddr: source ip4 addr
3413 :param gaddr: group ip4 addr
3415 return self.api(self.papi.igmp_listen,
3417 'sw_if_index': sw_if_index,
3421 def igmp_dump(self, sw_if_index=None):
3422 """ Dump all (S,G) interface configurations """
3423 if sw_if_index is None:
3428 return self.api(self.papi.igmp_dump, {'sw_if_index': sw_if_index,
3429 'dump_all': dump_all})
3431 def igmp_clear_interface(self, sw_if_index):
3432 """ Remove all (S,G)s from specified interface
3433 doesn't send IGMP report!
3436 self.papi.igmp_clear_interface, {
3437 'sw_if_index': sw_if_index})
3439 def want_igmp_events(self, enable=1):
3440 return self.api(self.papi.want_igmp_events, {'enable': enable,
3441 'pid': os.getpid()})
3451 :param lb: load balance
3452 :param use_custom_mac: use custom mac
3453 :param mac_address: mac address
3456 self.papi.bond_create,
3459 'use_custom_mac': use_custom_mac,
3460 'mac_address': mac_address
3467 :param sw_if_index: interface the operation is applied to
3469 return self.api(self.papi.bond_delete,
3470 {'sw_if_index': sw_if_index})
3479 :param sw_if_index: slave sw_if_index
3480 :param bond_sw_if_index: bond sw_if_index
3481 :param is_passive: is passive lacp speaker
3482 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3485 self.papi.bond_enslave,
3486 {'sw_if_index': sw_if_index,
3487 'bond_sw_if_index': bond_sw_if_index,
3488 'is_passive': is_passive,
3489 'is_long_timeout': is_long_timeout
3492 def bond_detach_slave(
3496 :param sw_if_index: slave interface the operation is applied to
3498 return self.api(self.papi.bond_detach_slave,
3499 {'sw_if_index': sw_if_index})
3501 def sw_interface_slave_dump(
3505 :param sw_if_index: bond sw_if_index
3507 return self.api(self.papi.sw_interface_slave_dump,
3508 {'sw_if_index': sw_if_index})
3510 def sw_interface_bond_dump(
3515 return self.api(self.papi.sw_interface_bond_dump,
3518 def create_vhost_user_if(
3523 custom_dev_instance,
3528 :param is_server: is server
3529 :param sock_filename: socket name
3530 :param renumber: renumber
3531 :param custom_dev_instance: custom dev instance
3532 :param use_custom_mac: use custom mac
3533 :param mac_address: mac address
3534 :param tag: tag (default ''
3537 self.papi.create_vhost_user_if,
3538 {'is_server': is_server,
3539 'sock_filename': sock_filename,
3540 'renumber': renumber,
3541 'custom_dev_instance': custom_dev_instance,
3542 'use_custom_mac': use_custom_mac,
3543 'mac_address': mac_address,
3547 def delete_vhost_user_if(
3551 :param sw_if_index: interface the operation is applied to
3553 return self.api(self.papi.delete_vhost_user_if,
3554 {'sw_if_index': sw_if_index, })
3556 def sw_interface_vhost_user_dump(
3561 return self.api(self.papi.sw_interface_vhost_user_dump,
3564 def abf_policy_add_del(self, is_add, policy):
3566 self.papi.abf_policy_add_del,
3570 def abf_itf_attach_add_del(self, is_add, attach):
3572 self.papi.abf_itf_attach_add_del,
3576 def abf_policy_dump(self):
3578 self.papi.abf_policy_dump, {})
3580 def abf_itf_attach_dump(self):
3582 self.papi.abf_itf_attach_dump, {})