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, read_timeout=5)
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 want_dhcp6_reply_events(self, enable_disable=1):
507 return self.api(self.papi.want_dhcp6_reply_events,
508 {'enable_disable': enable_disable,
511 def want_dhcp6_pd_reply_events(self, enable_disable=1):
512 return self.api(self.papi.want_dhcp6_pd_reply_events,
513 {'enable_disable': enable_disable,
516 def dhcp6_clients_enable_disable(self, enable=1):
517 return self.api(self.papi.dhcp6_clients_enable_disable,
520 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
521 addresses, server_index=0xFFFFFFFF,
522 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
524 return self.api(self.papi.dhcp6_send_client_message,
525 {'sw_if_index': sw_if_index,
526 'server_index': server_index,
532 'msg_type': msg_type,
535 'n_addresses': len(addresses),
536 'addresses': addresses})
538 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
539 prefixes, server_index=0xFFFFFFFF,
540 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
542 return self.api(self.papi.dhcp6_pd_send_client_message,
543 {'sw_if_index': sw_if_index,
544 'server_index': server_index,
550 'msg_type': msg_type,
553 'n_prefixes': len(prefixes),
554 'prefixes': prefixes})
556 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
558 return self.api(self.papi.dhcp6_client_enable_disable,
559 {'sw_if_index': sw_if_index,
562 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
564 return self.api(self.papi.dhcp6_pd_client_enable_disable,
565 {'sw_if_index': sw_if_index,
566 'prefix_group': prefix_group,
569 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
570 prefix_length, prefix_group,
572 return self.api(self.papi.ip6_add_del_address_using_prefix,
573 {'sw_if_index': sw_if_index,
574 'prefix_group': prefix_group,
576 'prefix_length': prefix_length,
579 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
580 filter_mac=0, bvi_mac=0):
581 """Create/delete L2 FIB entry.
583 :param str mac: MAC address to create FIB entry for.
584 :param int bd_id: Bridge domain index.
585 :param int sw_if_index: Software interface index of the interface.
586 :param int is_add: Add or delete flag. (Default value = 1)
587 :param int static_mac: Set to 1 to create static MAC entry.
589 :param int filter_mac: Set to 1 to drop packet that's source or
590 destination MAC address contains defined MAC address.
592 :param int bvi_mac: Set to 1 to create entry that points to BVI
593 interface. (Default value = 0)
595 return self.api(self.papi.l2fib_add_del,
596 {'mac': self._convert_mac(mac),
598 'sw_if_index': sw_if_index,
600 'static_mac': static_mac,
601 'filter_mac': filter_mac,
604 def l2fib_flush_int(self, sw_if_index):
605 """Flush L2 FIB entries for sw_if_index.
607 :param int sw_if_index: Software interface index of the interface.
609 return self.api(self.papi.l2fib_flush_int,
610 {'sw_if_index': sw_if_index})
612 def l2fib_flush_bd(self, bd_id):
613 """Flush L2 FIB entries for bd_id.
615 :param int sw_if_index: Bridge Domain id.
617 return self.api(self.papi.l2fib_flush_bd,
620 def l2fib_flush_all(self):
623 return self.api(self.papi.l2fib_flush_all, {})
625 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
626 shg=0, bvi=0, enable=1):
627 """Add/remove interface to/from bridge domain.
629 :param int sw_if_index: Software interface index of the interface.
630 :param int bd_id: Bridge domain index.
631 :param int shg: Split-horizon group index. (Default value = 0)
632 :param int bvi: Set interface as a bridge group virtual interface.
634 :param int enable: Add or remove interface. (Default value = 1)
636 return self.api(self.papi.sw_interface_set_l2_bridge,
637 {'rx_sw_if_index': sw_if_index,
643 def bridge_flags(self, bd_id, is_set, feature_bitmap):
644 """Enable/disable required feature of the bridge domain with defined
647 :param int bd_id: Bridge domain ID.
648 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
649 :param int feature_bitmap: Bitmap value of the feature to be set:
653 - uu-flood (1 << 3) or
656 return self.api(self.papi.bridge_flags,
659 'feature_bitmap': feature_bitmap})
661 def bridge_domain_dump(self, bd_id=0):
664 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
665 existing bridge domains returned)
666 :return: Dictionary of bridge domain(s) data.
668 return self.api(self.papi.bridge_domain_dump,
671 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
673 """Create or delete unidirectional cross-connect from Tx interface to
676 :param int rx_sw_if_index: Software interface index of Rx interface.
677 :param int tx_sw_if_index: Software interface index of Tx interface.
678 :param int enable: Create cross-connect if equal to 1, delete
679 cross-connect if equal to 0.
682 return self.api(self.papi.sw_interface_set_l2_xconnect,
683 {'rx_sw_if_index': rx_sw_if_index,
684 'tx_sw_if_index': tx_sw_if_index,
687 def sw_interface_set_l2_tag_rewrite(
694 """L2 interface vlan tag rewrite configure request
695 :param client_index - opaque cookie to identify the sender
696 :param context - sender context, to match reply w/ request
697 :param sw_if_index - interface the operation is applied to
698 :param vtr_op - Choose from l2_vtr_op_t enum values
699 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
700 :param tag1 - Needed for any push or translate vtr op
701 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
704 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
705 {'sw_if_index': sw_if_index,
711 def sw_interface_set_l2_emulation(
716 :param sw_if_index - interface the operation is applied to
719 return self.api(self.papi.l2_emulation,
720 {'sw_if_index': sw_if_index,
723 def sw_interface_set_ip_directed_broadcast(
727 """IP Directed broadcast
728 :param sw_if_index - interface the operation is applied to
731 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
732 {'sw_if_index': sw_if_index,
735 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
738 :param admin_up_down:
742 return self.api(self.papi.sw_interface_set_flags,
743 {'sw_if_index': sw_if_index,
744 'admin_up_down': admin_up_down})
746 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
752 return self.api(self.papi.sw_interface_set_mtu,
753 {'sw_if_index': sw_if_index,
756 def sw_interface_set_promiscuous(self, sw_if_index, enable):
762 return self.api(self.papi.sw_interface_set_promiscuous,
763 {'sw_if_index': sw_if_index,
766 def sw_interface_set_mac_address(self, sw_if_index, mac):
767 return self.api(self.papi.sw_interface_set_mac_address,
768 {'sw_if_index': sw_if_index,
771 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
772 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
773 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
774 """Create subinterface
775 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
777 :param sub_id: param inner_vlan:
781 :param no_tags: (Default value = 0)
782 :param one_tag: (Default value = 0)
783 :param two_tags: (Default value = 0)
784 :param dot1ad: (Default value = 0)
785 :param exact_match: (Default value = 0)
786 :param default_sub: (Default value = 0)
787 :param outer_vlan_id_any: (Default value = 0)
788 :param inner_vlan_id_any: (Default value = 0)
792 self.papi.create_subif,
793 {'sw_if_index': sw_if_index,
797 'two_tags': two_tags,
799 'exact_match': exact_match,
800 'default_sub': default_sub,
801 'outer_vlan_id_any': outer_vlan_id_any,
802 'inner_vlan_id_any': inner_vlan_id_any,
803 'outer_vlan_id': outer_vlan,
804 'inner_vlan_id': inner_vlan})
806 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
807 """Create p2p ethernet subinterface
809 :param sw_if_index: main (parent) interface
810 :param remote_mac: client (remote) mac address
814 self.papi.p2p_ethernet_add,
815 {'parent_if_index': sw_if_index,
816 'remote_mac': remote_mac,
817 'subif_id': subif_id})
819 def delete_subif(self, sw_if_index):
820 """Delete subinterface
824 return self.api(self.papi.delete_subif,
825 {'sw_if_index': sw_if_index})
827 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
828 """Delete p2p ethernet subinterface
830 :param sw_if_index: main (parent) interface
831 :param remote_mac: client (remote) mac address
835 self.papi.p2p_ethernet_del,
836 {'parent_if_index': sw_if_index,
837 'remote_mac': remote_mac})
839 def create_vlan_subif(self, sw_if_index, vlan):
846 return self.api(self.papi.create_vlan_subif,
847 {'sw_if_index': sw_if_index,
850 def create_loopback(self, mac=''):
853 :param mac: (Optional)
855 return self.api(self.papi.create_loopback,
856 {'mac_address': mac})
858 def delete_loopback(self, sw_if_index):
859 return self.api(self.papi.delete_loopback,
860 {'sw_if_index': sw_if_index, })
862 def ip_table_add_del(self,
869 :param is_add: (Default value = 1)
870 :param is_ipv6: (Default value = 0)
875 self.papi.ip_table_add_del,
876 {'table_id': table_id,
880 def ip_add_del_route(
885 next_hop_sw_if_index=0xFFFFFFFF,
889 next_hop_n_out_labels=0,
890 next_hop_out_label_stack=[],
891 next_hop_via_label=MPLS_LABEL_INVALID,
892 next_hop_id=0xFFFFFFFF,
894 is_resolve_attached=0,
895 classify_table_index=0xFFFFFFFF,
909 :param dst_address_length:
910 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
912 :param next_hop_address:
913 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
914 :param vrf_id: (Default value = 0)
915 :param lookup_in_vrf: (Default value = 0)
916 :param classify_table_index: (Default value = 0xFFFFFFFF)
917 :param is_add: (Default value = 1)
918 :param is_drop: (Default value = 0)
919 :param is_ipv6: (Default value = 0)
920 :param is_local: (Default value = 0)
921 :param is_classify: (Default value = 0)
922 :param is_multipath: (Default value = 0)
923 :param is_resolve_host: (Default value = 0)
924 :param is_resolve_attached: (Default value = 0)
925 :param is_dvr: (Default value = 0)
926 :param is_source_lookup: (Default value = 0)
927 :param next_hop_weight: (Default value = 1)
932 self.papi.ip_add_del_route,
933 {'next_hop_sw_if_index': next_hop_sw_if_index,
934 'table_id': table_id,
935 'classify_table_index': classify_table_index,
936 'next_hop_table_id': next_hop_table_id,
939 'is_unreach': is_unreach,
940 'is_prohibit': is_prohibit,
942 'is_local': is_local,
943 'is_classify': is_classify,
944 'is_multipath': is_multipath,
945 'is_resolve_host': is_resolve_host,
946 'is_resolve_attached': is_resolve_attached,
948 'is_source_lookup': is_source_lookup,
949 'is_udp_encap': is_udp_encap,
950 'next_hop_weight': next_hop_weight,
951 'dst_address_length': dst_address_length,
952 'dst_address': dst_address,
953 'next_hop_id': next_hop_id,
954 'next_hop_address': next_hop_address,
955 'next_hop_n_out_labels': next_hop_n_out_labels,
956 'next_hop_via_label': next_hop_via_label,
957 'next_hop_out_label_stack': next_hop_out_label_stack})
959 def ip_fib_dump(self):
960 return self.api(self.papi.ip_fib_dump, {})
962 def ip6_fib_dump(self):
963 return self.api(self.papi.ip6_fib_dump, {})
965 def ip_neighbor_add_del(self,
974 """ Add neighbor MAC to IPv4 or IPv6 address.
979 :param is_add: (Default value = 1)
980 :param is_ipv6: (Default value = 0)
981 :param is_static: (Default value = 0)
982 :param is_no_adj_fib: (Default value = 0)
986 self.papi.ip_neighbor_add_del,
987 {'sw_if_index': sw_if_index,
990 'is_static': is_static,
991 'is_no_adj_fib': is_no_adj_fib,
992 'mac_address': mac_address,
993 'dst_address': dst_address
997 def ip_neighbor_dump(self,
1000 """ Return IP neighbor dump.
1003 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1007 self.papi.ip_neighbor_dump,
1008 {'is_ipv6': is_ipv6,
1009 'sw_if_index': sw_if_index
1013 def proxy_arp_add_del(self,
1018 """ Config Proxy Arp Range.
1020 :param low_address: Start address in the rnage to Proxy for
1021 :param hi_address: End address in the rnage to Proxy for
1022 :param vrf_id: The VRF/table in which to proxy
1026 self.papi.proxy_arp_add_del,
1030 'low_address': low_address,
1031 'hi_address': hi_address,
1035 def proxy_arp_intfc_enable_disable(self,
1038 """ Enable/Disable an interface for proxy ARP requests
1040 :param sw_if_index: Interface
1041 :param enable_disable: Enable/Disable
1045 self.papi.proxy_arp_intfc_enable_disable,
1046 {'sw_if_index': sw_if_index,
1047 'enable_disable': is_enable
1055 """ Reset VRF (remove all routes etc.) request.
1057 :param int vrf_id: ID of the FIB table / VRF to reset.
1058 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1062 self.papi.reset_vrf,
1072 """ Reset VRF (remove all routes etc.) request.
1074 :param int vrf_id: ID of the FIB table / VRF to reset.
1075 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1079 self.papi.reset_fib,
1090 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1095 {'is_ipv6': is_ipv6,
1099 def sw_interface_span_enable_disable(
1100 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1103 :param sw_if_index_from:
1104 :param sw_if_index_to:
1108 return self.api(self.papi.sw_interface_span_enable_disable,
1109 {'sw_if_index_from': sw_if_index_from,
1110 'sw_if_index_to': sw_if_index_to,
1115 def gre_tunnel_add_del(self,
1120 instance=0xFFFFFFFF,
1124 """ Add a GRE tunnel
1128 :param outer_fib_id: (Default value = 0)
1129 :param tunnel_type: (Default value = 0)
1130 :param instance: (Default value = 0xFFFFFFFF)
1131 :param session_id: (Defalt value = 0)
1132 :param is_add: (Default value = 1)
1133 :param is_ipv6: (Default value = 0)
1137 self.papi.gre_add_del_tunnel,
1140 'tunnel_type': tunnel_type,
1141 'instance': instance,
1142 'src_address': src_address,
1143 'dst_address': dst_address,
1144 'outer_fib_id': outer_fib_id,
1145 'session_id': session_id}
1148 def udp_encap_add_del(self,
1157 """ Add a GRE tunnel
1158 :param id: user provided ID
1163 :param outer_fib_id: (Default value = 0)
1164 :param is_add: (Default value = 1)
1165 :param is_ipv6: (Default value = 0)
1169 self.papi.udp_encap_add_del,
1175 'src_port': src_port,
1176 'dst_port': dst_port,
1177 'table_id': table_id}
1180 def udp_encap_dump(self):
1181 return self.api(self.papi.udp_encap_dump, {})
1183 def want_udp_encap_stats(self, enable=1):
1184 return self.api(self.papi.want_udp_encap_stats,
1186 'pid': os.getpid()})
1188 def mpls_fib_dump(self):
1189 return self.api(self.papi.mpls_fib_dump, {})
1191 def mpls_table_add_del(
1198 :param is_add: (Default value = 1)
1203 self.papi.mpls_table_add_del,
1204 {'mt_table_id': table_id,
1205 'mt_is_add': is_add})
1207 def mpls_route_add_del(
1213 next_hop_sw_if_index=0xFFFFFFFF,
1215 next_hop_table_id=0,
1217 next_hop_n_out_labels=0,
1218 next_hop_out_label_stack=[],
1219 next_hop_via_label=MPLS_LABEL_INVALID,
1221 is_resolve_attached=0,
1228 classify_table_index=0xFFFFFFFF,
1232 :param dst_address_length:
1233 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1235 :param next_hop_address:
1236 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1237 :param vrf_id: (Default value = 0)
1238 :param lookup_in_vrf: (Default value = 0)
1239 :param classify_table_index: (Default value = 0xFFFFFFFF)
1240 :param is_add: (Default value = 1)
1241 :param is_drop: (Default value = 0)
1242 :param is_ipv6: (Default value = 0)
1243 :param is_local: (Default value = 0)
1244 :param is_classify: (Default value = 0)
1245 :param is_multipath: (Default value = 0)
1246 :param is_multicast: (Default value = 0)
1247 :param is_resolve_host: (Default value = 0)
1248 :param is_resolve_attached: (Default value = 0)
1249 :param next_hop_weight: (Default value = 1)
1253 self.papi.mpls_route_add_del,
1256 'mr_table_id': table_id,
1257 'mr_classify_table_index': classify_table_index,
1258 'mr_is_add': is_add,
1259 'mr_is_classify': is_classify,
1260 'mr_is_multipath': is_multipath,
1261 'mr_is_multicast': is_multicast,
1262 'mr_is_resolve_host': is_resolve_host,
1263 'mr_is_resolve_attached': is_resolve_attached,
1264 'mr_is_interface_rx': is_interface_rx,
1265 'mr_is_rpf_id': is_rpf_id,
1266 'mr_next_hop_proto': next_hop_proto,
1267 'mr_next_hop_weight': next_hop_weight,
1268 'mr_next_hop': next_hop_address,
1269 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1270 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1271 'mr_next_hop_table_id': next_hop_table_id,
1272 'mr_next_hop_via_label': next_hop_via_label,
1273 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1275 def mpls_ip_bind_unbind(
1287 self.papi.mpls_ip_bind_unbind,
1288 {'mb_mpls_table_id': table_id,
1290 'mb_ip_table_id': ip_table_id,
1291 'mb_is_bind': is_bind,
1292 'mb_is_ip4': is_ip4,
1293 'mb_address_length': dst_address_length,
1294 'mb_address': dst_address})
1296 def mpls_tunnel_add_del(
1299 next_hop_proto_is_ip4,
1301 next_hop_sw_if_index=0xFFFFFFFF,
1302 next_hop_table_id=0,
1304 next_hop_n_out_labels=0,
1305 next_hop_out_label_stack=[],
1306 next_hop_via_label=MPLS_LABEL_INVALID,
1312 :param dst_address_length:
1313 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1315 :param next_hop_address:
1316 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1317 :param vrf_id: (Default value = 0)
1318 :param lookup_in_vrf: (Default value = 0)
1319 :param classify_table_index: (Default value = 0xFFFFFFFF)
1320 :param is_add: (Default value = 1)
1321 :param is_drop: (Default value = 0)
1322 :param is_ipv6: (Default value = 0)
1323 :param is_local: (Default value = 0)
1324 :param is_classify: (Default value = 0)
1325 :param is_multipath: (Default value = 0)
1326 :param is_resolve_host: (Default value = 0)
1327 :param is_resolve_attached: (Default value = 0)
1328 :param next_hop_weight: (Default value = 1)
1329 :param is_multicast: (Default value = 0)
1333 self.papi.mpls_tunnel_add_del,
1334 {'mt_sw_if_index': tun_sw_if_index,
1335 'mt_is_add': is_add,
1336 'mt_l2_only': l2_only,
1337 'mt_is_multicast': is_multicast,
1338 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1339 'mt_next_hop_weight': next_hop_weight,
1340 'mt_next_hop': next_hop_address,
1341 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1342 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1343 'mt_next_hop_table_id': next_hop_table_id,
1344 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1346 def nat44_interface_add_del_feature(
1351 """Enable/disable NAT44 feature on the interface
1353 :param sw_if_index: Software index of the interface
1354 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1355 :param is_add: 1 if add, 0 if delete (Default value = 1)
1358 self.papi.nat44_interface_add_del_feature,
1360 'is_inside': is_inside,
1361 'sw_if_index': sw_if_index})
1363 def nat44_interface_add_del_output_feature(
1368 """Enable/disable NAT44 output feature on the interface
1370 :param sw_if_index: Software index of the interface
1371 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1372 :param is_add: 1 if add, 0 if delete (Default value = 1)
1375 self.papi.nat44_interface_add_del_output_feature,
1377 'is_inside': is_inside,
1378 'sw_if_index': sw_if_index})
1380 def nat44_add_del_static_mapping(
1384 external_sw_if_index=0xFFFFFFFF,
1395 """Add/delete NAT44 static mapping
1397 :param local_ip: Local IP address
1398 :param external_ip: External IP address
1399 :param external_sw_if_index: External interface instead of IP address
1400 :param local_port: Local port number (Default value = 0)
1401 :param external_port: External port number (Default value = 0)
1402 :param addr_only: 1 if address only mapping, 0 if address and port
1403 :param vrf_id: VRF ID
1404 :param protocol: IP protocol (Default value = 0)
1405 :param twice_nat: 1 if translate external host address and port
1406 :param self_twice_nat: 1 if translate external host address and port
1407 whenever external host address equals
1408 local address of internal host
1409 :param out2in_only: if 1 rule is matching only out2in direction
1410 :param tag: Opaque string tag
1411 :param is_add: 1 if add, 0 if delete (Default value = 1)
1414 self.papi.nat44_add_del_static_mapping,
1416 'addr_only': addr_only,
1417 'local_ip_address': local_ip,
1418 'external_ip_address': external_ip,
1419 'local_port': local_port,
1420 'external_port': external_port,
1421 'external_sw_if_index': external_sw_if_index,
1423 'protocol': protocol,
1424 'twice_nat': twice_nat,
1425 'self_twice_nat': self_twice_nat,
1426 'out2in_only': out2in_only,
1429 def nat44_add_del_identity_mapping(
1432 sw_if_index=0xFFFFFFFF,
1439 """Add/delete NAT44 identity mapping
1441 :param ip: IP address (Default value = 0)
1442 :param sw_if_index: Interface instead of IP address
1443 :param port: Port number (Default value = 0)
1444 :param addr_only: 1 if address only mapping, 0 if address and port
1445 :param vrf_id: VRF ID
1446 :param protocol: IP protocol (Default value = 0)
1447 :param tag: Opaque string tag
1448 :param is_add: 1 if add, 0 if delete (Default value = 1)
1451 self.papi.nat44_add_del_identity_mapping,
1453 'addr_only': addr_only,
1456 'sw_if_index': sw_if_index,
1459 'protocol': protocol})
1461 def nat44_add_del_address_range(
1468 """Add/del NAT44 address range
1470 :param first_ip_address: First IP address
1471 :param last_ip_address: Last IP address
1472 :param vrf_id: VRF id for the address range
1473 :param twice_nat: twice NAT address for extenal hosts
1474 :param is_add: 1 if add, 0 if delete (Default value = 1)
1477 self.papi.nat44_add_del_address_range,
1478 {'first_ip_address': first_ip_address,
1479 'last_ip_address': last_ip_address,
1481 'twice_nat': twice_nat,
1484 def nat44_address_dump(self):
1485 """Dump NAT44 addresses
1486 :return: Dictionary of NAT44 addresses
1488 return self.api(self.papi.nat44_address_dump, {})
1490 def nat44_interface_dump(self):
1491 """Dump interfaces with NAT44 feature
1492 :return: Dictionary of interfaces with NAT44 feature
1494 return self.api(self.papi.nat44_interface_dump, {})
1496 def nat44_interface_output_feature_dump(self):
1497 """Dump interfaces with NAT44 output feature
1498 :return: Dictionary of interfaces with NAT44 output feature
1500 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1502 def nat44_static_mapping_dump(self):
1503 """Dump NAT44 static mappings
1504 :return: Dictionary of NAT44 static mappings
1506 return self.api(self.papi.nat44_static_mapping_dump, {})
1508 def nat44_identity_mapping_dump(self):
1509 """Dump NAT44 identity mappings
1510 :return: Dictionary of NAT44 identity mappings
1512 return self.api(self.papi.nat44_identity_mapping_dump, {})
1514 def nat_show_config(self):
1515 """Show NAT plugin config
1516 :return: NAT plugin config parameters
1518 return self.api(self.papi.nat_show_config, {})
1520 def nat44_add_interface_addr(
1525 """Add/del NAT44 address from interface
1527 :param sw_if_index: Software index of the interface
1528 :param twice_nat: twice NAT address for extenal hosts
1529 :param is_add: 1 if add, 0 if delete (Default value = 1)
1532 self.papi.nat44_add_del_interface_addr,
1534 'sw_if_index': sw_if_index,
1535 'twice_nat': twice_nat})
1537 def nat44_interface_addr_dump(self):
1538 """Dump NAT44 addresses interfaces
1539 :return: Dictionary of NAT44 addresses interfaces
1541 return self.api(self.papi.nat44_interface_addr_dump, {})
1548 """Enable/disable NAT IPFIX logging
1550 :param domain_id: Observation domain ID (Default value = 1)
1551 :param src_port: Source port number (Default value = 4739)
1552 :param enable: 1 if enable, 0 if disable (Default value = 1)
1555 self.papi.nat_ipfix_enable_disable,
1556 {'domain_id': domain_id,
1557 'src_port': src_port,
1560 def nat44_user_session_dump(
1564 """Dump NAT44 user's sessions
1566 :param ip_address: ip adress of the user to be dumped
1567 :param cpu_index: cpu_index on which the user is
1568 :param vrf_id: VRF ID
1569 :return: Dictionary of S-NAT sessions
1572 self.papi.nat44_user_session_dump,
1573 {'ip_address': ip_address,
1576 def nat44_user_dump(self):
1579 :return: Dictionary of NAT44 users
1581 return self.api(self.papi.nat44_user_dump, {})
1583 def nat44_add_del_lb_static_mapping(
1596 """Add/delete NAT44 load balancing static mapping
1598 :param twice_nat: 1 if translate external host address and port
1599 :param tag: Opaque string tag
1600 :param is_add - 1 if add, 0 if delete
1603 self.papi.nat44_add_del_lb_static_mapping,
1605 'external_addr': external_addr,
1606 'external_port': external_port,
1607 'protocol': protocol,
1609 'twice_nat': twice_nat,
1610 'self_twice_nat': self_twice_nat,
1611 'out2in_only': out2in_only,
1613 'local_num': local_num,
1616 def nat44_lb_static_mapping_dump(self):
1617 """Dump NAT44 load balancing static mappings
1619 :return: Dictionary of NAT44 load balancing static mapping
1621 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1623 def nat44_del_session(
1630 ext_host_address=None,
1632 """Delete NAT44 session
1634 :param addr: IPv4 address
1635 :param por: port number
1636 :param protocol: IP protocol number
1637 :param vrf_id: VRF ID
1638 :param is_in: 1 if inside network addres and port pari, 0 if outside
1639 :param ext_host_address: external host IPv4 address
1640 :param ext_host_port: external host port
1642 if ext_host_address is None:
1644 self.papi.nat44_del_session,
1647 'protocol': protocol,
1652 self.papi.nat44_del_session,
1655 'protocol': protocol,
1658 'ext_host_valid': 1,
1659 'ext_host_address': ext_host_address,
1660 'ext_host_port': ext_host_port})
1662 def nat44_forwarding_enable_disable(
1665 """Enable/disable forwarding for NAT44
1667 :param enable: 1 for enable, 0 for disable
1670 self.papi.nat44_forwarding_enable_disable,
1680 """Set NAT virtual fragmentation reassembly
1682 :param timeout: reassembly timeout (Default 2sec)
1683 :param max_reass: maximum concurrent reassemblies (Default 1024)
1684 :param max_frag: maximum fragmets per reassembly (Default 5)
1685 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1686 :param is_ip6: 1 if IPv6, 0 if IPv4
1689 self.papi.nat_set_reass,
1690 {'timeout': timeout,
1691 'max_reass': max_reass,
1692 'max_frag': max_frag,
1693 'drop_frag': drop_frag,
1696 def nat_get_reass(self):
1697 """Get NAT virtual fragmentation reassembly configuration
1699 :return: NAT virtual fragmentation reassembly configuration
1701 return self.api(self.papi.nat_get_reass, {})
1703 def nat_reass_dump(self):
1704 """Dump NAT virtual fragmentation reassemblies
1706 :return: Dictionary of NAT virtual fragmentation reassemblies
1708 return self.api(self.papi.nat_reass_dump, {})
1710 def nat_det_add_del_map(
1717 """Add/delete deterministic NAT mapping
1719 :param is_add - 1 if add, 0 if delete
1720 :param in_addr - inside IP address
1721 :param in_plen - inside IP address prefix length
1722 :param out_addr - outside IP address
1723 :param out_plen - outside IP address prefix length
1726 self.papi.nat_det_add_del_map,
1731 'out_addr': out_addr,
1732 'out_plen': out_plen})
1734 def nat_det_forward(
1737 """Get outside address and port range from inside address
1739 :param in_addr - inside IP address
1742 self.papi.nat_det_forward,
1743 {'in_addr': in_addr,
1746 def nat_det_reverse(
1750 """Get inside address from outside address and port
1752 :param out_addr - outside IP address
1753 :param out_port - outside port
1756 self.papi.nat_det_reverse,
1757 {'out_addr': out_addr,
1758 'out_port': out_port})
1760 def nat_det_map_dump(self):
1761 """Dump deterministic NAT mappings
1763 :return: Dictionary of deterministic NAT mappings
1765 return self.api(self.papi.nat_det_map_dump, {})
1767 def nat_det_set_timeouts(
1770 tcp_established=7440,
1773 """Set values of timeouts for deterministic NAT (in seconds)
1775 :param udp - UDP timeout (Default value = 300)
1776 :param tcp_established - TCP established timeout (Default value = 7440)
1777 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1778 :param icmp - ICMP timeout (Default value = 60)
1781 self.papi.nat_det_set_timeouts,
1783 'tcp_established': tcp_established,
1784 'tcp_transitory': tcp_transitory,
1787 def nat_det_get_timeouts(self):
1788 """Get values of timeouts for deterministic NAT
1790 :return: Timeouts for deterministic NAT (in seconds)
1792 return self.api(self.papi.nat_det_get_timeouts, {})
1794 def nat_det_close_session_out(
1800 """Close deterministic NAT session using outside address and port
1802 :param out_addr - outside IP address
1803 :param out_port - outside port
1804 :param ext_addr - external host IP address
1805 :param ext_port - external host port
1808 self.papi.nat_det_close_session_out,
1809 {'out_addr': out_addr,
1810 'out_port': out_port,
1811 'ext_addr': ext_addr,
1812 'ext_port': ext_port})
1814 def nat_det_close_session_in(
1820 """Close deterministic NAT session using inside address and port
1822 :param in_addr - inside IP address
1823 :param in_port - inside port
1824 :param ext_addr - external host IP address
1825 :param ext_port - external host port
1828 self.papi.nat_det_close_session_in,
1829 {'in_addr': in_addr,
1831 'ext_addr': ext_addr,
1832 'ext_port': ext_port,
1835 def nat_det_session_dump(
1838 """Dump deterministic NAT sessions belonging to a user
1840 :param user_addr - inside IP address of the user
1841 :return: Dictionary of deterministic NAT sessions
1844 self.papi.nat_det_session_dump,
1846 'user_addr': user_addr})
1848 def nat64_add_del_pool_addr_range(
1854 """Add/del address range to NAT64 pool
1856 :param start_addr: First IP address
1857 :param end_addr: Last IP address
1858 :param vrf_id: VRF id for the address range
1859 :param is_add: 1 if add, 0 if delete (Default value = 1)
1862 self.papi.nat64_add_del_pool_addr_range,
1863 {'start_addr': start_addr,
1864 'end_addr': end_addr,
1868 def nat64_pool_addr_dump(self):
1869 """Dump NAT64 pool addresses
1870 :return: Dictionary of NAT64 pool addresses
1872 return self.api(self.papi.nat64_pool_addr_dump, {})
1874 def nat64_add_del_interface(
1879 """Enable/disable NAT64 feature on the interface
1880 :param sw_if_index: Index of the interface
1881 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1882 :param is_add: 1 if add, 0 if delete (Default value = 1)
1885 self.papi.nat64_add_del_interface,
1886 {'sw_if_index': sw_if_index,
1887 'is_inside': is_inside,
1890 def nat64_interface_dump(self):
1891 """Dump interfaces with NAT64 feature
1892 :return: Dictionary of interfaces with NAT64 feature
1894 return self.api(self.papi.nat64_interface_dump, {})
1896 def nat64_add_del_static_bib(
1905 """Add/delete S-NAT static BIB entry
1907 :param in_ip: Inside IPv6 address
1908 :param out_ip: Outside IPv4 address
1909 :param in_port: Inside port number
1910 :param out_port: Outside port number
1911 :param protocol: IP protocol
1912 :param vrf_id: VRF ID (Default value = 0)
1913 :param is_add: 1 if add, 0 if delete (Default value = 1)
1916 self.papi.nat64_add_del_static_bib,
1925 def nat64_bib_dump(self, protocol=255):
1928 :param protocol: IP protocol (Default value = 255, all BIBs)
1929 :returns: Dictionary of NAT64 BIB entries
1931 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1933 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1934 tcp_incoming_syn=6):
1935 """Set values of timeouts for NAT64 (in seconds)
1937 :param udpi: UDP timeout (Default value = 300)
1938 :param icmp: ICMP timeout (Default value = 60)
1939 :param tcp_trans: TCP transitory timeout (Default value = 240)
1940 :param tcp_est: TCP established timeout (Default value = 7440)
1941 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1944 self.papi.nat64_set_timeouts,
1947 'tcp_trans': tcp_trans,
1949 'tcp_incoming_syn': tcp_incoming_syn})
1951 def nat64_get_timeouts(self):
1952 """Get values of timeouts for NAT64
1954 :return: Timeouts for NAT64 (in seconds)
1956 return self.api(self.papi.nat64_get_timeouts, {})
1958 def nat64_st_dump(self, protocol=255):
1959 """Dump NAT64 session table
1961 :param protocol: IP protocol (Default value = 255, all STs)
1962 :returns: Dictionary of NAT64 sesstion table entries
1964 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1966 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1967 """Add/del NAT64 prefix
1969 :param prefix: NAT64 prefix
1970 :param plen: NAT64 prefix length
1971 :param vrf_id: VRF id of tenant (Default 0)
1972 :param is_add: 1 if add, 0 if delete (Default value = 1)
1975 self.papi.nat64_add_del_prefix,
1981 def nat64_prefix_dump(self):
1982 """Dump NAT64 prefix
1984 :returns: Dictionary of NAT64 prefixes
1986 return self.api(self.papi.nat64_prefix_dump, {})
1988 def nat64_add_interface_addr(
1992 """Add/del NAT64 address from interface
1994 :param sw_if_index: Software index of the interface
1995 :param is_add: 1 if add, 0 if delete (Default value = 1)
1997 return self.api(self.papi.nat64_add_del_interface_addr,
1998 {'is_add': is_add, 'sw_if_index': sw_if_index})
2000 def dslite_set_aftr_addr(self, ip6, ip4):
2001 """Set DS-Lite AFTR addresses
2003 :param ip4: IPv4 address
2004 :param ip6: IPv6 address
2007 self.papi.dslite_set_aftr_addr,
2011 def dslite_set_b4_addr(self, ip6, ip4):
2012 """Set DS-Lite B4 IPv6 address
2014 :param ip4: IPv4 address
2015 :param ip6: IPv6 address
2018 self.papi.dslite_set_b4_addr,
2022 def dslite_add_del_pool_addr_range(
2027 """Add/del address range to DS-Lite pool
2029 :param start_addr: First IP address
2030 :param end_addr: Last IP address
2031 :param is_add: 1 if add, 0 if delete (Default value = 1)
2034 self.papi.dslite_add_del_pool_addr_range,
2035 {'start_addr': start_addr,
2036 'end_addr': end_addr,
2039 def nat66_add_del_interface(
2044 """Enable/disable NAT66 feature on the interface
2045 :param sw_if_index: Index of the interface
2046 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2047 :param is_add: 1 if add, 0 if delete (Default value = 1)
2050 self.papi.nat66_add_del_interface,
2051 {'sw_if_index': sw_if_index,
2052 'is_inside': is_inside,
2055 def nat66_add_del_static_mapping(
2061 """Add/delete NAT66 static mapping
2063 :param in_ip: Inside IPv6 address
2064 :param out_ip: Outside IPv6 address
2065 :param vrf_id: VRF ID (Default value = 0)
2066 :param is_add: 1 if add, 0 if delete (Default value = 1)
2069 self.papi.nat66_add_del_static_mapping,
2070 {'local_ip_address': in_ip,
2071 'external_ip_address': out_ip,
2075 def nat66_interface_dump(self):
2076 """Dump interfaces with NAT66 feature
2077 :return: Dictionary of interfaces with NAT66 feature
2079 return self.api(self.papi.nat66_interface_dump, {})
2081 def nat66_static_mapping_dump(self):
2082 """Dump NAT66 static mappings
2083 :return: Dictionary of NAT66 static mappings
2085 return self.api(self.papi.nat66_static_mapping_dump, {})
2087 def control_ping(self):
2088 self.api(self.papi.control_ping)
2090 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2091 detect_mult, local_addr, peer_addr, is_ipv6=0,
2092 bfd_key_id=None, conf_key_id=None):
2093 if bfd_key_id is None:
2094 return self.api(self.papi.bfd_udp_add,
2096 'sw_if_index': sw_if_index,
2097 'desired_min_tx': desired_min_tx,
2098 'required_min_rx': required_min_rx,
2099 'local_addr': local_addr,
2100 'peer_addr': peer_addr,
2102 'detect_mult': detect_mult,
2105 return self.api(self.papi.bfd_udp_add,
2107 'sw_if_index': sw_if_index,
2108 'desired_min_tx': desired_min_tx,
2109 'required_min_rx': required_min_rx,
2110 'local_addr': local_addr,
2111 'peer_addr': peer_addr,
2113 'detect_mult': detect_mult,
2114 'is_authenticated': 1,
2115 'bfd_key_id': bfd_key_id,
2116 'conf_key_id': conf_key_id,
2119 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2120 detect_mult, local_addr, peer_addr, is_ipv6=0):
2121 return self.api(self.papi.bfd_udp_mod,
2123 'sw_if_index': sw_if_index,
2124 'desired_min_tx': desired_min_tx,
2125 'required_min_rx': required_min_rx,
2126 'local_addr': local_addr,
2127 'peer_addr': peer_addr,
2129 'detect_mult': detect_mult,
2132 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2133 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2135 return self.api(self.papi.bfd_udp_auth_activate,
2137 'sw_if_index': sw_if_index,
2138 'local_addr': local_addr,
2139 'peer_addr': peer_addr,
2141 'is_delayed': 1 if is_delayed else 0,
2142 'bfd_key_id': bfd_key_id,
2143 'conf_key_id': conf_key_id,
2146 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2147 is_ipv6=0, is_delayed=False):
2148 return self.api(self.papi.bfd_udp_auth_deactivate,
2150 'sw_if_index': sw_if_index,
2151 'local_addr': local_addr,
2152 'peer_addr': peer_addr,
2154 'is_delayed': 1 if is_delayed else 0,
2157 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2158 return self.api(self.papi.bfd_udp_del,
2160 'sw_if_index': sw_if_index,
2161 'local_addr': local_addr,
2162 'peer_addr': peer_addr,
2166 def bfd_udp_session_dump(self):
2167 return self.api(self.papi.bfd_udp_session_dump, {})
2169 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2170 peer_addr, is_ipv6=0):
2171 return self.api(self.papi.bfd_udp_session_set_flags, {
2172 'admin_up_down': admin_up_down,
2173 'sw_if_index': sw_if_index,
2174 'local_addr': local_addr,
2175 'peer_addr': peer_addr,
2179 def want_bfd_events(self, enable_disable=1):
2180 return self.api(self.papi.want_bfd_events, {
2181 'enable_disable': enable_disable,
2185 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2186 return self.api(self.papi.bfd_auth_set_key, {
2187 'conf_key_id': conf_key_id,
2188 'auth_type': auth_type,
2190 'key_len': len(key),
2193 def bfd_auth_del_key(self, conf_key_id):
2194 return self.api(self.papi.bfd_auth_del_key, {
2195 'conf_key_id': conf_key_id,
2198 def bfd_auth_keys_dump(self):
2199 return self.api(self.papi.bfd_auth_keys_dump, {})
2201 def bfd_udp_set_echo_source(self, sw_if_index):
2202 return self.api(self.papi.bfd_udp_set_echo_source,
2203 {'sw_if_index': sw_if_index})
2205 def bfd_udp_del_echo_source(self):
2206 return self.api(self.papi.bfd_udp_del_echo_source, {})
2208 def classify_add_del_table(
2213 table_index=0xFFFFFFFF,
2215 memory_size=2097152,
2217 next_table_index=0xFFFFFFFF,
2218 miss_next_index=0xFFFFFFFF,
2219 current_data_flag=0,
2220 current_data_offset=0):
2224 :param match_n_vectors: (Default value = 1)
2225 :param table_index: (Default value = 0xFFFFFFFF)
2226 :param nbuckets: (Default value = 2)
2227 :param memory_size: (Default value = 2097152)
2228 :param skip_n_vectors: (Default value = 0)
2229 :param next_table_index: (Default value = 0xFFFFFFFF)
2230 :param miss_next_index: (Default value = 0xFFFFFFFF)
2231 :param current_data_flag: (Default value = 0)
2232 :param current_data_offset: (Default value = 0)
2236 self.papi.classify_add_del_table,
2238 'table_index': table_index,
2239 'nbuckets': nbuckets,
2240 'memory_size': memory_size,
2241 'skip_n_vectors': skip_n_vectors,
2242 'match_n_vectors': match_n_vectors,
2243 'next_table_index': next_table_index,
2244 'miss_next_index': miss_next_index,
2245 'current_data_flag': current_data_flag,
2246 'current_data_offset': current_data_offset,
2249 def classify_add_del_session(
2254 opaque_index=0xFFFFFFFF,
2255 hit_next_index=0xFFFFFFFF,
2263 :param opaque_index: (Default value = 0xFFFFFFFF)
2264 :param hit_next_index: (Default value = 0xFFFFFFFF)
2265 :param advance: (Default value = 0)
2266 :param action: (Default value = 0)
2267 :param metadata: (Default value = 0)
2271 self.papi.classify_add_del_session,
2273 'table_index': table_index,
2274 'hit_next_index': hit_next_index,
2275 'opaque_index': opaque_index,
2278 'metadata': metadata,
2281 def input_acl_set_interface(
2285 ip4_table_index=0xFFFFFFFF,
2286 ip6_table_index=0xFFFFFFFF,
2287 l2_table_index=0xFFFFFFFF):
2291 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2292 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2293 :param l2_table_index: (Default value = 0xFFFFFFFF)
2297 self.papi.input_acl_set_interface,
2298 {'sw_if_index': sw_if_index,
2299 'ip4_table_index': ip4_table_index,
2300 'ip6_table_index': ip6_table_index,
2301 'l2_table_index': l2_table_index,
2304 def output_acl_set_interface(
2308 ip4_table_index=0xFFFFFFFF,
2309 ip6_table_index=0xFFFFFFFF,
2310 l2_table_index=0xFFFFFFFF):
2314 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2315 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2316 :param l2_table_index: (Default value = 0xFFFFFFFF)
2320 self.papi.output_acl_set_interface,
2321 {'sw_if_index': sw_if_index,
2322 'ip4_table_index': ip4_table_index,
2323 'ip6_table_index': ip6_table_index,
2324 'l2_table_index': l2_table_index,
2327 def set_ipfix_exporter(
2334 collector_port=4739,
2337 self.papi.set_ipfix_exporter,
2339 'collector_address': collector_address,
2340 'collector_port': collector_port,
2341 'src_address': src_address,
2343 'path_mtu': path_mtu,
2344 'template_interval': template_interval,
2345 'udp_checksum': udp_checksum,
2348 def dhcp_proxy_config(self,
2356 self.papi.dhcp_proxy_config,
2358 'rx_vrf_id': rx_table_id,
2359 'server_vrf_id': server_table_id,
2362 'dhcp_server': dhcp_server,
2363 'dhcp_src_address': dhcp_src_address,
2366 def dhcp_proxy_set_vss(self,
2375 self.papi.dhcp_proxy_set_vss,
2378 'vss_type': vss_type,
2379 'vpn_ascii_id': vpn_ascii_id,
2381 'vpn_index': vpn_index,
2386 def dhcp_client_dump(self):
2387 return self.api(self.papi.dhcp_client_dump, {})
2389 def dhcp_client(self,
2394 set_broadcast_flag=1,
2395 want_dhcp_events=0):
2397 self.papi.dhcp_client_config,
2401 'sw_if_index': sw_if_index,
2402 'hostname': hostname,
2404 'want_dhcp_event': want_dhcp_events,
2405 'set_broadcast_flag': set_broadcast_flag,
2409 def ip_mroute_add_del(self,
2415 next_hop_sw_if_index,
2425 IP Multicast Route add/del
2428 self.papi.ip_mroute_add_del,
2429 {'next_hop_sw_if_index': next_hop_sw_if_index,
2430 'entry_flags': e_flags,
2431 'itf_flags': i_flags,
2432 'table_id': table_id,
2436 'is_local': is_local,
2437 'bier_imp': bier_imp,
2438 'next_hop_afi': next_hop_afi,
2439 'grp_address_length': grp_address_length,
2440 'grp_address': grp_address,
2441 'src_address': src_address,
2442 'nh_address': next_hop_address})
2444 def mfib_signal_dump(self):
2445 return self.api(self.papi.mfib_signal_dump, {})
2447 def ip_mfib_dump(self):
2448 return self.api(self.papi.ip_mfib_dump, {})
2450 def ip6_mfib_dump(self):
2451 return self.api(self.papi.ip6_mfib_dump, {})
2453 def lisp_enable_disable(self, is_enabled):
2455 self.papi.lisp_enable_disable,
2457 'is_en': is_enabled,
2460 def lisp_locator_set(self,
2464 self.papi.lisp_add_del_locator_set,
2467 'locator_set_name': ls_name
2470 def lisp_locator_set_dump(self):
2471 return self.api(self.papi.lisp_locator_set_dump, {})
2473 def lisp_locator(self,
2480 self.papi.lisp_add_del_locator,
2483 'locator_set_name': ls_name,
2484 'sw_if_index': sw_if_index,
2485 'priority': priority,
2489 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2491 self.papi.lisp_locator_dump,
2493 'is_index_set': is_index_set,
2495 'ls_index': ls_index,
2498 def lisp_local_mapping(self,
2508 self.papi.lisp_add_del_local_eid,
2510 'locator_set_name': ls_name,
2512 'eid_type': eid_type,
2514 'prefix_len': prefix_len,
2520 def lisp_eid_table_dump(self,
2528 self.papi.lisp_eid_table_dump,
2531 'prefix_length': prefix_length,
2533 'eid_type': eid_type,
2535 'filter': filter_opt,
2538 def lisp_remote_mapping(self,
2548 self.papi.lisp_add_del_remote_mapping,
2551 'eid_type': eid_type,
2553 'eid_len': eid_prefix_len,
2554 'rloc_num': rlocs_num,
2557 'is_src_dst': is_src_dst,
2560 def lisp_adjacency(self,
2569 self.papi.lisp_add_del_adjacency,
2573 'eid_type': eid_type,
2576 'leid_len': leid_len,
2577 'reid_len': reid_len,
2580 def lisp_adjacencies_get(self, vni=0):
2582 self.papi.lisp_adjacencies_get,
2587 def map_add_domain(self,
2601 self.papi.map_add_domain,
2603 'ip6_prefix': ip6_prefix,
2604 'ip6_prefix_len': ip6_prefix_len,
2605 'ip4_prefix': ip4_prefix,
2606 'ip4_prefix_len': ip4_prefix_len,
2608 'ip6_src_prefix_len': ip6_src_prefix_len,
2609 'ea_bits_len': ea_bits_len,
2610 'psid_offset': psid_offset,
2611 'psid_length': psid_length,
2612 'is_translation': is_translation,
2613 'is_rfc6052': is_rfc6052,
2617 def gtpu_add_del_tunnel(
2623 mcast_sw_if_index=0xFFFFFFFF,
2625 decap_next_index=0xFFFFFFFF,
2629 :param is_add: (Default value = 1)
2630 :param is_ipv6: (Default value = 0)
2633 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2634 :param encap_vrf_id: (Default value = 0)
2635 :param decap_next_index: (Default value = 0xFFFFFFFF)
2636 :param teid: (Default value = 0)
2639 return self.api(self.papi.gtpu_add_del_tunnel,
2642 'src_address': src_addr,
2643 'dst_address': dst_addr,
2644 'mcast_sw_if_index': mcast_sw_if_index,
2645 'encap_vrf_id': encap_vrf_id,
2646 'decap_next_index': decap_next_index,
2649 def vxlan_gpe_add_del_tunnel(
2653 mcast_sw_if_index=0xFFFFFFFF,
2664 :param is_add: (Default value = 1)
2665 :param is_ipv6: (Default value = 0)
2666 :param encap_vrf_id: (Default value = 0)
2667 :param decap_vrf_id: (Default value = 0)
2668 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2669 :param protocol: (Default value = 3)
2670 :param vni: (Default value = 0)
2673 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2678 'mcast_sw_if_index': mcast_sw_if_index,
2679 'encap_vrf_id': encap_vrf_id,
2680 'decap_vrf_id': decap_vrf_id,
2681 'protocol': protocol,
2684 def pppoe_add_del_session(
2694 :param is_add: (Default value = 1)
2695 :param is_ipv6: (Default value = 0)
2697 :param session_id: (Default value = 0)
2699 :param decap_vrf_id: (Default value = 0)
2702 return self.api(self.papi.pppoe_add_del_session,
2705 'session_id': session_id,
2706 'client_ip': client_ip,
2707 'decap_vrf_id': decap_vrf_id,
2708 'client_mac': client_mac})
2710 def sr_localsid_add_del(self,
2717 sw_if_index=0xFFFFFFFF,
2721 """ Add/del IPv6 SR local-SID.
2724 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2725 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2728 :param is_del: (Default value = 0)
2729 :param end_psp: (Default value = 0)
2730 :param sw_if_index: (Default value = 0xFFFFFFFF)
2731 :param vlan_index: (Default value = 0)
2732 :param fib_table: (Default value = 0)
2735 self.papi.sr_localsid_add_del,
2737 'localsid': localsid,
2739 'behavior': behavior,
2740 'sw_if_index': sw_if_index,
2741 'vlan_index': vlan_index,
2742 'fib_table': fib_table,
2743 'nh_addr4': nh_addr4,
2744 'nh_addr6': nh_addr6
2758 :param bsid_addr: bindingSID of the SR Policy
2759 :param weight: weight of the sid list. optional. (default: 1)
2760 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2762 :param type: type/behavior of the SR policy. (default or spray) \
2764 :param fib_table: VRF where to install the FIB entry for the BSID \
2766 :param n_segments: number of segments \
2768 :param segments: a vector of IPv6 address composing the segment list \
2772 self.papi.sr_policy_add,
2773 {'bsid_addr': bsid_addr,
2775 'is_encap': is_encap,
2777 'fib_table': fib_table,
2778 'n_segments': n_segments,
2779 'segments': segments
2788 :param bsid: bindingSID of the SR Policy
2789 :param sr_policy_index: index of the sr policy (default: 0)
2792 self.papi.sr_policy_del,
2793 {'bsid_addr': bsid_addr,
2794 'sr_policy_index': sr_policy_index
2797 def sr_steering_add_del(
2808 Steer traffic L2 and L3 traffic through a given SR policy
2810 :param is_del: delete or add
2811 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2812 :param sr_policy: is the index of the SR Policy (alt to bsid)
2813 :param table_id: is the VRF where to install the FIB entry for the BSID
2814 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2815 :param mask_width: is the mask for L3 traffic type
2816 :param sw_if_index: is the incoming interface for L2 traffic
2817 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2820 self.papi.sr_steering_add_del,
2822 'bsid_addr': bsid_addr,
2823 'sr_policy_index': sr_policy_index,
2824 'table_id': table_id,
2825 'prefix_addr': prefix_addr,
2826 'mask_width': mask_width,
2827 'sw_if_index': sw_if_index,
2828 'traffic_type': traffic_type
2831 def acl_add_replace(self, acl_index, r, tag='',
2833 """Add/replace an ACL
2834 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2835 :param acl_rule r: ACL rules array.
2836 :param str tag: symbolic tag (description) for this ACL.
2837 :param int count: number of rules.
2839 return self.api(self.papi.acl_add_replace,
2840 {'acl_index': acl_index,
2844 expected_retval=expected_retval)
2846 def acl_del(self, acl_index, expected_retval=0):
2852 return self.api(self.papi.acl_del,
2853 {'acl_index': acl_index},
2854 expected_retval=expected_retval)
2856 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2858 return self.api(self.papi.acl_interface_set_acl_list,
2859 {'sw_if_index': sw_if_index,
2863 expected_retval=expected_retval)
2865 def acl_interface_set_etype_whitelist(self, sw_if_index,
2868 return self.api(self.papi.acl_interface_set_etype_whitelist,
2869 {'sw_if_index': sw_if_index,
2870 'count': len(whitelist),
2872 'whitelist': whitelist},
2873 expected_retval=expected_retval)
2875 def acl_interface_add_del(self,
2879 """ Add/Delete ACL to/from interface
2883 :param is_add: (Default value = 1)
2886 return self.api(self.papi.acl_interface_add_del,
2889 'sw_if_index': sw_if_index,
2890 'acl_index': acl_index})
2892 def acl_dump(self, acl_index, expected_retval=0):
2893 return self.api(self.papi.acl_dump,
2894 {'acl_index': acl_index},
2895 expected_retval=expected_retval)
2897 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2899 return self.api(self.papi.acl_interface_list_dump,
2900 {'sw_if_index': sw_if_index},
2901 expected_retval=expected_retval)
2903 def macip_acl_add(self, rules, tag=""):
2906 :param rules: list of rules for given acl
2910 return self.api(self.papi.macip_acl_add,
2912 'count': len(rules),
2915 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2918 :param rules: list of rules for given acl
2922 return self.api(self.papi.macip_acl_add_replace,
2923 {'acl_index': acl_index,
2925 'count': len(rules),
2928 def macip_acl_del(self, acl_index):
2934 return self.api(self.papi.macip_acl_del,
2935 {'acl_index': acl_index})
2937 def macip_acl_interface_add_del(self,
2941 """ Add MACIP acl to interface
2945 :param is_add: (Default value = 1)
2948 return self.api(self.papi.macip_acl_interface_add_del,
2950 'sw_if_index': sw_if_index,
2951 'acl_index': acl_index})
2953 def macip_acl_interface_get(self):
2954 """ Return interface acls dump
2957 self.papi.macip_acl_interface_get, {})
2959 def macip_acl_dump(self, acl_index=4294967295):
2960 """ Return MACIP acl dump
2964 self.papi.macip_acl_dump, {'acl_index': acl_index})
2966 def policer_add_del(self,
2977 conform_action_type=1,
2979 exceed_action_type=0,
2981 violate_action_type=0,
2983 return self.api(self.papi.policer_add_del,
2990 'rate_type': rate_type,
2991 'round_type': round_type,
2993 'color_aware': color_aware,
2994 'conform_action_type': conform_action_type,
2995 'conform_dscp': conform_dscp,
2996 'exceed_action_type': exceed_action_type,
2997 'exceed_dscp': exceed_dscp,
2998 'violate_action_type': violate_action_type,
2999 'violate_dscp': violate_dscp})
3001 def ip_punt_police(self,
3005 return self.api(self.papi.ip_punt_police,
3006 {'policer_index': policer_index,
3010 def ip_punt_redirect(self,
3016 return self.api(self.papi.ip_punt_redirect,
3017 {'rx_sw_if_index': rx_sw_if_index,
3018 'tx_sw_if_index': tx_sw_if_index,
3023 def bier_table_add_del(self,
3027 """ BIER Table add/del """
3029 self.papi.bier_table_add_del,
3030 {'bt_tbl_id': {"bt_set": bti.set_id,
3031 "bt_sub_domain": bti.sub_domain_id,
3032 "bt_hdr_len_id": bti.hdr_len_id},
3033 'bt_label': mpls_label,
3034 'bt_is_add': is_add})
3036 def bier_table_dump(self):
3037 return self.api(self.papi.bier_table_dump, {})
3039 def bier_route_add_del(self,
3044 """ BIER Route add/del """
3046 self.papi.bier_route_add_del,
3047 {'br_tbl_id': {"bt_set": bti.set_id,
3048 "bt_sub_domain": bti.sub_domain_id,
3049 "bt_hdr_len_id": bti.hdr_len_id},
3051 'br_n_paths': len(paths),
3053 'br_is_add': is_add})
3055 def bier_route_dump(self, bti):
3057 self.papi.bier_route_dump,
3058 {'br_tbl_id': {"bt_set": bti.set_id,
3059 "bt_sub_domain": bti.sub_domain_id,
3060 "bt_hdr_len_id": bti.hdr_len_id}})
3062 def bier_imp_add(self,
3067 """ BIER Imposition Add """
3069 self.papi.bier_imp_add,
3070 {'bi_tbl_id': {"bt_set": bti.set_id,
3071 "bt_sub_domain": bti.sub_domain_id,
3072 "bt_hdr_len_id": bti.hdr_len_id},
3074 'bi_n_bytes': len(ibytes),
3075 'bi_bytes': ibytes})
3077 def bier_imp_del(self, bi_index):
3078 """ BIER Imposition del """
3080 self.papi.bier_imp_del,
3081 {'bi_index': bi_index})
3083 def bier_imp_dump(self):
3084 return self.api(self.papi.bier_imp_dump, {})
3086 def bier_disp_table_add_del(self,
3089 """ BIER Disposition Table add/del """
3091 self.papi.bier_disp_table_add_del,
3092 {'bdt_tbl_id': bdti,
3093 'bdt_is_add': is_add})
3095 def bier_disp_table_dump(self):
3096 return self.api(self.papi.bier_disp_table_dump, {})
3098 def bier_disp_entry_add_del(self,
3108 """ BIER Route add/del """
3110 while (len(lstack) < 16):
3113 self.papi.bier_disp_entry_add_del,
3114 {'bde_tbl_id': bdti,
3116 'bde_payload_proto': payload_proto,
3118 'bde_paths': [{'next_hop': next_hop,
3119 'table_id': next_hop_tbl_id,
3120 'afi': next_hop_afi,
3121 'rpf_id': next_hop_rpf_id,
3123 'label_stack': lstack}],
3124 'bde_is_add': is_add})
3126 def bier_disp_entry_dump(self, bdti):
3128 self.papi.bier_disp_entry_dump,
3129 {'bde_tbl_id': bdti})
3131 def add_node_next(self, node_name, next_name):
3132 """ Set the next node for a given node request
3137 return self.api(self.papi.add_node_next,
3138 {'node_name': node_name,
3139 'next_name': next_name})
3141 def session_enable_disable(self, is_enabled):
3143 self.papi.session_enable_disable,
3144 {'is_enable': is_enabled})
3146 def ipsec_spd_add_del(self, spd_id, is_add=1):
3147 """ SPD add/del - Wrapper to add or del ipsec SPD
3148 Sample CLI : 'ipsec spd add 1'
3150 :param spd_id - SPD ID to be created in the vpp . mandatory
3151 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3153 :returns: reply from the API
3156 self.papi.ipsec_spd_add_del, {
3157 'spd_id': spd_id, 'is_add': is_add})
3159 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3160 """ IPSEC interface SPD add/del - \
3161 Wrapper to associate/disassociate SPD to interface in VPP
3162 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3164 :param spd_id - SPD ID to associate with the interface . mandatory
3165 :param sw_if_index - Interface Index which needs to ipsec \
3166 association mandatory
3167 :param is_add - add(1) or del(0) association with interface \
3168 (Default 1 - add) . optional
3169 :returns: reply from the API
3172 self.papi.ipsec_interface_add_del_spd,
3173 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3175 def ipsec_sad_add_del_entry(self,
3178 integrity_algorithm,
3183 tunnel_src_address='',
3184 tunnel_dst_address='',
3188 """ IPSEC SA add/del
3189 :param sad_id: security association ID
3190 :param spi: security param index of the SA in decimal
3191 :param integrity_algorithm:
3192 :param integrity_key:
3193 :param crypto_algorithm:
3195 :param protocol: AH(0) or ESP(1) protocol
3196 :param tunnel_src_address: tunnel mode outer src address
3197 :param tunnel_dst_address: tunnel mode outer dst address
3200 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3201 crypto and ipsec algorithms
3204 self.papi.ipsec_sad_add_del_entry,
3207 'tunnel_src_address': tunnel_src_address,
3208 'tunnel_dst_address': tunnel_dst_address,
3209 'protocol': protocol,
3210 'integrity_algorithm': integrity_algorithm,
3211 'integrity_key_length': len(integrity_key),
3212 'integrity_key': integrity_key,
3213 'crypto_algorithm': crypto_algorithm,
3214 'crypto_key_length': len(crypto_key) if crypto_key is not None
3216 'crypto_key': crypto_key,
3218 'is_tunnel': is_tunnel,
3219 'udp_encap': udp_encap})
3221 def ipsec_spd_add_del_entry(self,
3224 local_address_start,
3226 remote_address_start,
3227 remote_address_stop,
3229 local_port_stop=65535,
3230 remote_port_start=0,
3231 remote_port_stop=65535,
3238 """ IPSEC policy SPD add/del -
3239 Wrapper to configure ipsec SPD policy entries in VPP
3240 :param spd_id: SPD ID for the policy
3241 :param local_address_start: local-ip-range start address
3242 :param local_address_stop : local-ip-range stop address
3243 :param remote_address_start: remote-ip-range start address
3244 :param remote_address_stop : remote-ip-range stop address
3245 :param local_port_start: (Default value = 0)
3246 :param local_port_stop: (Default value = 65535)
3247 :param remote_port_start: (Default value = 0)
3248 :param remote_port_stop: (Default value = 65535)
3249 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3250 :param sa_id: Security Association ID for mapping it to SPD
3251 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3253 :param priority: value for the spd action (Default value = 100)
3254 :param is_outbound: flag for inbound(0) or outbound(1)
3256 :param is_add: (Default value = 1)
3259 self.papi.ipsec_spd_add_del_entry,
3262 'local_address_start': local_address_start,
3263 'local_address_stop': local_address_stop,
3264 'remote_address_start': remote_address_start,
3265 'remote_address_stop': remote_address_stop,
3266 'local_port_start': local_port_start,
3267 'local_port_stop': local_port_stop,
3268 'remote_port_start': remote_port_start,
3269 'remote_port_stop': remote_port_stop,
3271 'protocol': protocol,
3273 'priority': priority,
3274 'is_outbound': is_outbound,
3275 'is_ip_any': is_ip_any})
3277 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3278 remote_spi, crypto_alg, local_crypto_key,
3279 remote_crypto_key, integ_alg, local_integ_key,
3280 remote_integ_key, is_add=1, esn=0,
3281 anti_replay=1, renumber=0, show_instance=0):
3283 self.papi.ipsec_tunnel_if_add_del,
3284 {'local_ip': local_ip, 'remote_ip': remote_ip,
3285 'local_spi': local_spi, 'remote_spi': remote_spi,
3286 'crypto_alg': crypto_alg,
3287 'local_crypto_key_len': len(local_crypto_key),
3288 'local_crypto_key': local_crypto_key,
3289 'remote_crypto_key_len': len(remote_crypto_key),
3290 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3291 'local_integ_key_len': len(local_integ_key),
3292 'local_integ_key': local_integ_key,
3293 'remote_integ_key_len': len(remote_integ_key),
3294 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3295 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3296 'show_instance': show_instance
3299 def app_namespace_add(self,
3303 sw_if_index=0xFFFFFFFF,
3306 self.papi.app_namespace_add_del,
3308 'sw_if_index': sw_if_index,
3309 'ip4_fib_id': ip4_fib_id,
3310 'ip6_fib_id': ip6_fib_id,
3311 'namespace_id': namespace_id,
3312 'namespace_id_len': len(namespace_id)})
3314 def punt_socket_register(self, l4_port, pathname, header_version=1,
3315 is_ip4=1, l4_protocol=0x11):
3316 """ Punt to socket """
3317 return self.api(self.papi.punt_socket_register,
3319 'l4_protocol': l4_protocol,
3321 'pathname': pathname,
3322 'header_version': header_version})
3324 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3325 expire_walk_interval_ms, is_ip6=0):
3326 """ Set IP reassembly parameters """
3327 return self.api(self.papi.ip_reassembly_set,
3329 'timeout_ms': timeout_ms,
3330 'expire_walk_interval_ms': expire_walk_interval_ms,
3331 'max_reassemblies': max_reassemblies})
3333 def ip_reassembly_get(self, is_ip6=0):
3334 """ Get IP reassembly parameters """
3335 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3337 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3339 """ Enable/disable IP reassembly """
3340 return self.api(self.papi.ip_reassembly_enable_disable,
3341 {'sw_if_index': sw_if_index,
3342 'enable_ip4': 1 if enable_ip4 else 0,
3343 'enable_ip6': 1 if enable_ip6 else 0,
3346 def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
3347 """ GBP endpoint Add/Del """
3348 return self.api(self.papi.gbp_endpoint_add_del,
3352 'sw_if_index': sw_if_index,
3356 def gbp_endpoint_dump(self):
3357 """ GBP endpoint Dump """
3358 return self.api(self.papi.gbp_endpoint_dump, {})
3360 def gbp_endpoint_group_add_del(self, is_add, epg, bd,
3363 uplink_sw_if_index):
3364 """ GBP endpoint group Add/Del """
3365 return self.api(self.papi.gbp_endpoint_group_add_del,
3368 'uplink_sw_if_index': uplink_sw_if_index,
3370 'ip4_table_id': ip4_rd,
3371 'ip6_table_id': ip6_rd,
3374 def gbp_endpoint_group_dump(self):
3375 """ GBP endpoint group Dump """
3376 return self.api(self.papi.gbp_endpoint_group_dump, {})
3378 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3379 """ GBP recirc Add/Del """
3380 return self.api(self.papi.gbp_recirc_add_del,
3384 'sw_if_index': sw_if_index,
3387 def gbp_recirc_dump(self):
3388 """ GBP recirc Dump """
3389 return self.api(self.papi.gbp_recirc_dump, {})
3391 def gbp_subnet_add_del(self, is_add, table_id,
3394 sw_if_index=0xffffffff,
3397 """ GBP Subnet Add/Del """
3398 return self.api(self.papi.gbp_subnet_add_del,
3401 'is_internal': is_internal,
3403 'sw_if_index': sw_if_index,
3406 'address_length': addr_len,
3407 'table_id': table_id}})
3409 def gbp_subnet_dump(self):
3410 """ GBP Subnet Dump """
3411 return self.api(self.papi.gbp_subnet_dump, {})
3413 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3414 """ GBP contract Add/Del """
3415 return self.api(self.papi.gbp_contract_add_del,
3418 'acl_index': acl_index,
3420 'dst_epg': dst_epg}})
3422 def gbp_contract_dump(self):
3423 """ GBP contract Dump """
3424 return self.api(self.papi.gbp_contract_dump, {})
3426 def ipip_6rd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len,
3427 ip4_prefix, ip4_prefix_len, ip4_src,
3429 """ 6RD tunnel Add """
3430 return self.api(self.papi.ipip_6rd_add_tunnel,
3431 {'fib_index': fib_index,
3432 'ip6_prefix': ip6_prefix,
3433 'ip6_prefix_len': ip6_prefix_len,
3434 'ip4_prefix': ip4_prefix,
3435 'ip4_prefix_len': ip4_prefix_len,
3437 'security_check': security_check})
3439 def ipip_6rd_del_tunnel(self, sw_if_index):
3440 """ 6RD tunnel Delete """
3441 return self.api(self.papi.ipip_6rd_del_tunnel,
3442 {'sw_if_index': sw_if_index})
3444 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3445 instance=0xFFFFFFFF, fib_index=0, tc_tos=0):
3446 """ IPIP tunnel Add/Del """
3447 return self.api(self.papi.ipip_add_tunnel,
3448 {'is_ipv6': is_ipv6,
3449 'instance': instance,
3450 'src_address': src_address,
3451 'dst_address': dst_address,
3452 'fib_index': fib_index,
3455 def ipip_del_tunnel(self, sw_if_index):
3456 """ IPIP tunnel Delete """
3457 return self.api(self.papi.ipip_del_tunnel,
3458 {'sw_if_index': sw_if_index})
3460 def qos_egress_map_update(self, id, outputs):
3461 """ QOS egress map update """
3462 return self.api(self.papi.qos_egress_map_update,
3466 def qos_egress_map_delete(self, id):
3467 """ QOS egress map delete """
3468 return self.api(self.papi.qos_egress_map_delete,
3471 def qos_mark_enable_disable(self, sw_if_index,
3475 """ QOS Mark Enable/Disable """
3476 return self.api(self.papi.qos_mark_enable_disable,
3478 'sw_if_index': sw_if_index,
3479 'output_source': output_source,
3482 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3483 """ IP QoS recording Enble/Disable """
3484 return self.api(self.papi.qos_record_enable_disable,
3485 {'sw_if_index': sw_if_index,
3486 'input_source': input_source,
3489 def igmp_enable_disable(self, sw_if_index, enable, host):
3490 """ Enable/disable IGMP on a given interface """
3491 return self.api(self.papi.igmp_enable_disable,
3494 'sw_if_index': sw_if_index})
3496 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3497 """ Listen for new (S,G) on specified interface
3499 :param enable: add/del
3500 :param sw_if_index: interface sw index
3501 :param saddr: source ip4 addr
3502 :param gaddr: group ip4 addr
3504 return self.api(self.papi.igmp_listen,
3509 'sw_if_index': sw_if_index,
3510 'n_srcs': len(saddrs),
3519 def igmp_dump(self, sw_if_index=None):
3520 """ Dump all (S,G) interface configurations """
3521 if sw_if_index is None:
3522 sw_if_index = 0xffffffff
3523 return self.api(self.papi.igmp_dump,
3524 {'sw_if_index': sw_if_index})
3526 def igmp_clear_interface(self, sw_if_index):
3527 """ Remove all (S,G)s from specified interface
3528 doesn't send IGMP report!
3531 self.papi.igmp_clear_interface, {
3532 'sw_if_index': sw_if_index})
3534 def want_igmp_events(self, enable=1):
3535 return self.api(self.papi.want_igmp_events, {'enable': enable,
3536 'pid': os.getpid()})
3546 :param lb: load balance
3547 :param use_custom_mac: use custom mac
3548 :param mac_address: mac address
3551 self.papi.bond_create,
3554 'use_custom_mac': use_custom_mac,
3555 'mac_address': mac_address
3562 :param sw_if_index: interface the operation is applied to
3564 return self.api(self.papi.bond_delete,
3565 {'sw_if_index': sw_if_index})
3574 :param sw_if_index: slave sw_if_index
3575 :param bond_sw_if_index: bond sw_if_index
3576 :param is_passive: is passive lacp speaker
3577 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3580 self.papi.bond_enslave,
3581 {'sw_if_index': sw_if_index,
3582 'bond_sw_if_index': bond_sw_if_index,
3583 'is_passive': is_passive,
3584 'is_long_timeout': is_long_timeout
3587 def bond_detach_slave(
3591 :param sw_if_index: slave interface the operation is applied to
3593 return self.api(self.papi.bond_detach_slave,
3594 {'sw_if_index': sw_if_index})
3596 def sw_interface_slave_dump(
3600 :param sw_if_index: bond sw_if_index
3602 return self.api(self.papi.sw_interface_slave_dump,
3603 {'sw_if_index': sw_if_index})
3605 def sw_interface_bond_dump(
3610 return self.api(self.papi.sw_interface_bond_dump,
3613 def create_vhost_user_if(
3618 custom_dev_instance,
3623 :param is_server: is server
3624 :param sock_filename: socket name
3625 :param renumber: renumber
3626 :param custom_dev_instance: custom dev instance
3627 :param use_custom_mac: use custom mac
3628 :param mac_address: mac address
3629 :param tag: tag (default ''
3632 self.papi.create_vhost_user_if,
3633 {'is_server': is_server,
3634 'sock_filename': sock_filename,
3635 'renumber': renumber,
3636 'custom_dev_instance': custom_dev_instance,
3637 'use_custom_mac': use_custom_mac,
3638 'mac_address': mac_address,
3642 def delete_vhost_user_if(
3646 :param sw_if_index: interface the operation is applied to
3648 return self.api(self.papi.delete_vhost_user_if,
3649 {'sw_if_index': sw_if_index, })
3651 def sw_interface_vhost_user_dump(
3656 return self.api(self.papi.sw_interface_vhost_user_dump,
3659 def abf_policy_add_del(self, is_add, policy):
3661 self.papi.abf_policy_add_del,
3665 def abf_itf_attach_add_del(self, is_add, attach):
3667 self.papi.abf_itf_attach_add_del,
3671 def abf_policy_dump(self):
3673 self.papi.abf_policy_dump, {})
3675 def abf_itf_attach_dump(self):
3677 self.papi.abf_itf_attach_dump, {})
3679 def pipe_create(self, is_specified, user_instance):
3680 return self.api(self.papi.pipe_create,
3681 {'is_specified': is_specified,
3682 'user_instance': user_instance})
3684 def pipe_delete(self, parent_sw_if_index):
3685 return self.api(self.papi.pipe_delete,
3686 {'parent_sw_if_index': parent_sw_if_index})
3688 def pipe_dump(self):
3689 return self.api(self.papi.pipe_dump, {})