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(
1595 """Add/delete NAT44 load balancing static mapping
1597 :param twice_nat: 1 if translate external host address and port
1598 :param tag: Opaque string tag
1599 :param is_add - 1 if add, 0 if delete
1602 self.papi.nat44_add_del_lb_static_mapping,
1604 'external_addr': external_addr,
1605 'external_port': external_port,
1606 'protocol': protocol,
1607 'twice_nat': twice_nat,
1608 'self_twice_nat': self_twice_nat,
1609 'out2in_only': out2in_only,
1611 'local_num': local_num,
1614 def nat44_lb_static_mapping_dump(self):
1615 """Dump NAT44 load balancing static mappings
1617 :return: Dictionary of NAT44 load balancing static mapping
1619 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1621 def nat44_del_session(
1628 ext_host_address=None,
1630 """Delete NAT44 session
1632 :param addr: IPv4 address
1633 :param por: port number
1634 :param protocol: IP protocol number
1635 :param vrf_id: VRF ID
1636 :param is_in: 1 if inside network addres and port pari, 0 if outside
1637 :param ext_host_address: external host IPv4 address
1638 :param ext_host_port: external host port
1640 if ext_host_address is None:
1642 self.papi.nat44_del_session,
1645 'protocol': protocol,
1650 self.papi.nat44_del_session,
1653 'protocol': protocol,
1656 'ext_host_valid': 1,
1657 'ext_host_address': ext_host_address,
1658 'ext_host_port': ext_host_port})
1660 def nat44_forwarding_enable_disable(
1663 """Enable/disable forwarding for NAT44
1665 :param enable: 1 for enable, 0 for disable
1668 self.papi.nat44_forwarding_enable_disable,
1678 """Set NAT virtual fragmentation reassembly
1680 :param timeout: reassembly timeout (Default 2sec)
1681 :param max_reass: maximum concurrent reassemblies (Default 1024)
1682 :param max_frag: maximum fragmets per reassembly (Default 5)
1683 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1684 :param is_ip6: 1 if IPv6, 0 if IPv4
1687 self.papi.nat_set_reass,
1688 {'timeout': timeout,
1689 'max_reass': max_reass,
1690 'max_frag': max_frag,
1691 'drop_frag': drop_frag,
1694 def nat_get_reass(self):
1695 """Get NAT virtual fragmentation reassembly configuration
1697 :return: NAT virtual fragmentation reassembly configuration
1699 return self.api(self.papi.nat_get_reass, {})
1701 def nat_reass_dump(self):
1702 """Dump NAT virtual fragmentation reassemblies
1704 :return: Dictionary of NAT virtual fragmentation reassemblies
1706 return self.api(self.papi.nat_reass_dump, {})
1708 def nat_det_add_del_map(
1715 """Add/delete deterministic NAT mapping
1717 :param is_add - 1 if add, 0 if delete
1718 :param in_addr - inside IP address
1719 :param in_plen - inside IP address prefix length
1720 :param out_addr - outside IP address
1721 :param out_plen - outside IP address prefix length
1724 self.papi.nat_det_add_del_map,
1729 'out_addr': out_addr,
1730 'out_plen': out_plen})
1732 def nat_det_forward(
1735 """Get outside address and port range from inside address
1737 :param in_addr - inside IP address
1740 self.papi.nat_det_forward,
1741 {'in_addr': in_addr,
1744 def nat_det_reverse(
1748 """Get inside address from outside address and port
1750 :param out_addr - outside IP address
1751 :param out_port - outside port
1754 self.papi.nat_det_reverse,
1755 {'out_addr': out_addr,
1756 'out_port': out_port})
1758 def nat_det_map_dump(self):
1759 """Dump deterministic NAT mappings
1761 :return: Dictionary of deterministic NAT mappings
1763 return self.api(self.papi.nat_det_map_dump, {})
1765 def nat_det_set_timeouts(
1768 tcp_established=7440,
1771 """Set values of timeouts for deterministic NAT (in seconds)
1773 :param udp - UDP timeout (Default value = 300)
1774 :param tcp_established - TCP established timeout (Default value = 7440)
1775 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1776 :param icmp - ICMP timeout (Default value = 60)
1779 self.papi.nat_det_set_timeouts,
1781 'tcp_established': tcp_established,
1782 'tcp_transitory': tcp_transitory,
1785 def nat_det_get_timeouts(self):
1786 """Get values of timeouts for deterministic NAT
1788 :return: Timeouts for deterministic NAT (in seconds)
1790 return self.api(self.papi.nat_det_get_timeouts, {})
1792 def nat_det_close_session_out(
1798 """Close deterministic NAT session using outside address and port
1800 :param out_addr - outside IP address
1801 :param out_port - outside port
1802 :param ext_addr - external host IP address
1803 :param ext_port - external host port
1806 self.papi.nat_det_close_session_out,
1807 {'out_addr': out_addr,
1808 'out_port': out_port,
1809 'ext_addr': ext_addr,
1810 'ext_port': ext_port})
1812 def nat_det_close_session_in(
1818 """Close deterministic NAT session using inside address and port
1820 :param in_addr - inside IP address
1821 :param in_port - inside port
1822 :param ext_addr - external host IP address
1823 :param ext_port - external host port
1826 self.papi.nat_det_close_session_in,
1827 {'in_addr': in_addr,
1829 'ext_addr': ext_addr,
1830 'ext_port': ext_port,
1833 def nat_det_session_dump(
1836 """Dump deterministic NAT sessions belonging to a user
1838 :param user_addr - inside IP address of the user
1839 :return: Dictionary of deterministic NAT sessions
1842 self.papi.nat_det_session_dump,
1844 'user_addr': user_addr})
1846 def nat64_add_del_pool_addr_range(
1852 """Add/del address range to NAT64 pool
1854 :param start_addr: First IP address
1855 :param end_addr: Last IP address
1856 :param vrf_id: VRF id for the address range
1857 :param is_add: 1 if add, 0 if delete (Default value = 1)
1860 self.papi.nat64_add_del_pool_addr_range,
1861 {'start_addr': start_addr,
1862 'end_addr': end_addr,
1866 def nat64_pool_addr_dump(self):
1867 """Dump NAT64 pool addresses
1868 :return: Dictionary of NAT64 pool addresses
1870 return self.api(self.papi.nat64_pool_addr_dump, {})
1872 def nat64_add_del_interface(
1877 """Enable/disable NAT64 feature on the interface
1878 :param sw_if_index: Index of the interface
1879 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1880 :param is_add: 1 if add, 0 if delete (Default value = 1)
1883 self.papi.nat64_add_del_interface,
1884 {'sw_if_index': sw_if_index,
1885 'is_inside': is_inside,
1888 def nat64_interface_dump(self):
1889 """Dump interfaces with NAT64 feature
1890 :return: Dictionary of interfaces with NAT64 feature
1892 return self.api(self.papi.nat64_interface_dump, {})
1894 def nat64_add_del_static_bib(
1903 """Add/delete S-NAT static BIB entry
1905 :param in_ip: Inside IPv6 address
1906 :param out_ip: Outside IPv4 address
1907 :param in_port: Inside port number
1908 :param out_port: Outside port number
1909 :param protocol: IP protocol
1910 :param vrf_id: VRF ID (Default value = 0)
1911 :param is_add: 1 if add, 0 if delete (Default value = 1)
1914 self.papi.nat64_add_del_static_bib,
1923 def nat64_bib_dump(self, protocol=255):
1926 :param protocol: IP protocol (Default value = 255, all BIBs)
1927 :returns: Dictionary of NAT64 BIB entries
1929 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1931 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1932 tcp_incoming_syn=6):
1933 """Set values of timeouts for NAT64 (in seconds)
1935 :param udpi: UDP timeout (Default value = 300)
1936 :param icmp: ICMP timeout (Default value = 60)
1937 :param tcp_trans: TCP transitory timeout (Default value = 240)
1938 :param tcp_est: TCP established timeout (Default value = 7440)
1939 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1942 self.papi.nat64_set_timeouts,
1945 'tcp_trans': tcp_trans,
1947 'tcp_incoming_syn': tcp_incoming_syn})
1949 def nat64_get_timeouts(self):
1950 """Get values of timeouts for NAT64
1952 :return: Timeouts for NAT64 (in seconds)
1954 return self.api(self.papi.nat64_get_timeouts, {})
1956 def nat64_st_dump(self, protocol=255):
1957 """Dump NAT64 session table
1959 :param protocol: IP protocol (Default value = 255, all STs)
1960 :returns: Dictionary of NAT64 sesstion table entries
1962 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1964 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1965 """Add/del NAT64 prefix
1967 :param prefix: NAT64 prefix
1968 :param plen: NAT64 prefix length
1969 :param vrf_id: VRF id of tenant (Default 0)
1970 :param is_add: 1 if add, 0 if delete (Default value = 1)
1973 self.papi.nat64_add_del_prefix,
1979 def nat64_prefix_dump(self):
1980 """Dump NAT64 prefix
1982 :returns: Dictionary of NAT64 prefixes
1984 return self.api(self.papi.nat64_prefix_dump, {})
1986 def nat64_add_interface_addr(
1990 """Add/del NAT64 address from interface
1992 :param sw_if_index: Software index of the interface
1993 :param is_add: 1 if add, 0 if delete (Default value = 1)
1995 return self.api(self.papi.nat64_add_del_interface_addr,
1996 {'is_add': is_add, 'sw_if_index': sw_if_index})
1998 def dslite_set_aftr_addr(self, ip6, ip4):
1999 """Set DS-Lite AFTR addresses
2001 :param ip4: IPv4 address
2002 :param ip6: IPv6 address
2005 self.papi.dslite_set_aftr_addr,
2009 def dslite_set_b4_addr(self, ip6, ip4):
2010 """Set DS-Lite B4 IPv6 address
2012 :param ip4: IPv4 address
2013 :param ip6: IPv6 address
2016 self.papi.dslite_set_b4_addr,
2020 def dslite_add_del_pool_addr_range(
2025 """Add/del address range to DS-Lite pool
2027 :param start_addr: First IP address
2028 :param end_addr: Last IP address
2029 :param is_add: 1 if add, 0 if delete (Default value = 1)
2032 self.papi.dslite_add_del_pool_addr_range,
2033 {'start_addr': start_addr,
2034 'end_addr': end_addr,
2037 def nat66_add_del_interface(
2042 """Enable/disable NAT66 feature on the interface
2043 :param sw_if_index: Index of the interface
2044 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2045 :param is_add: 1 if add, 0 if delete (Default value = 1)
2048 self.papi.nat66_add_del_interface,
2049 {'sw_if_index': sw_if_index,
2050 'is_inside': is_inside,
2053 def nat66_add_del_static_mapping(
2059 """Add/delete NAT66 static mapping
2061 :param in_ip: Inside IPv6 address
2062 :param out_ip: Outside IPv6 address
2063 :param vrf_id: VRF ID (Default value = 0)
2064 :param is_add: 1 if add, 0 if delete (Default value = 1)
2067 self.papi.nat66_add_del_static_mapping,
2068 {'local_ip_address': in_ip,
2069 'external_ip_address': out_ip,
2073 def nat66_interface_dump(self):
2074 """Dump interfaces with NAT66 feature
2075 :return: Dictionary of interfaces with NAT66 feature
2077 return self.api(self.papi.nat66_interface_dump, {})
2079 def nat66_static_mapping_dump(self):
2080 """Dump NAT66 static mappings
2081 :return: Dictionary of NAT66 static mappings
2083 return self.api(self.papi.nat66_static_mapping_dump, {})
2085 def control_ping(self):
2086 self.api(self.papi.control_ping)
2088 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2089 detect_mult, local_addr, peer_addr, is_ipv6=0,
2090 bfd_key_id=None, conf_key_id=None):
2091 if bfd_key_id is None:
2092 return self.api(self.papi.bfd_udp_add,
2094 'sw_if_index': sw_if_index,
2095 'desired_min_tx': desired_min_tx,
2096 'required_min_rx': required_min_rx,
2097 'local_addr': local_addr,
2098 'peer_addr': peer_addr,
2100 'detect_mult': detect_mult,
2103 return self.api(self.papi.bfd_udp_add,
2105 'sw_if_index': sw_if_index,
2106 'desired_min_tx': desired_min_tx,
2107 'required_min_rx': required_min_rx,
2108 'local_addr': local_addr,
2109 'peer_addr': peer_addr,
2111 'detect_mult': detect_mult,
2112 'is_authenticated': 1,
2113 'bfd_key_id': bfd_key_id,
2114 'conf_key_id': conf_key_id,
2117 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2118 detect_mult, local_addr, peer_addr, is_ipv6=0):
2119 return self.api(self.papi.bfd_udp_mod,
2121 'sw_if_index': sw_if_index,
2122 'desired_min_tx': desired_min_tx,
2123 'required_min_rx': required_min_rx,
2124 'local_addr': local_addr,
2125 'peer_addr': peer_addr,
2127 'detect_mult': detect_mult,
2130 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2131 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2133 return self.api(self.papi.bfd_udp_auth_activate,
2135 'sw_if_index': sw_if_index,
2136 'local_addr': local_addr,
2137 'peer_addr': peer_addr,
2139 'is_delayed': 1 if is_delayed else 0,
2140 'bfd_key_id': bfd_key_id,
2141 'conf_key_id': conf_key_id,
2144 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2145 is_ipv6=0, is_delayed=False):
2146 return self.api(self.papi.bfd_udp_auth_deactivate,
2148 'sw_if_index': sw_if_index,
2149 'local_addr': local_addr,
2150 'peer_addr': peer_addr,
2152 'is_delayed': 1 if is_delayed else 0,
2155 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2156 return self.api(self.papi.bfd_udp_del,
2158 'sw_if_index': sw_if_index,
2159 'local_addr': local_addr,
2160 'peer_addr': peer_addr,
2164 def bfd_udp_session_dump(self):
2165 return self.api(self.papi.bfd_udp_session_dump, {})
2167 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2168 peer_addr, is_ipv6=0):
2169 return self.api(self.papi.bfd_udp_session_set_flags, {
2170 'admin_up_down': admin_up_down,
2171 'sw_if_index': sw_if_index,
2172 'local_addr': local_addr,
2173 'peer_addr': peer_addr,
2177 def want_bfd_events(self, enable_disable=1):
2178 return self.api(self.papi.want_bfd_events, {
2179 'enable_disable': enable_disable,
2183 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2184 return self.api(self.papi.bfd_auth_set_key, {
2185 'conf_key_id': conf_key_id,
2186 'auth_type': auth_type,
2188 'key_len': len(key),
2191 def bfd_auth_del_key(self, conf_key_id):
2192 return self.api(self.papi.bfd_auth_del_key, {
2193 'conf_key_id': conf_key_id,
2196 def bfd_auth_keys_dump(self):
2197 return self.api(self.papi.bfd_auth_keys_dump, {})
2199 def bfd_udp_set_echo_source(self, sw_if_index):
2200 return self.api(self.papi.bfd_udp_set_echo_source,
2201 {'sw_if_index': sw_if_index})
2203 def bfd_udp_del_echo_source(self):
2204 return self.api(self.papi.bfd_udp_del_echo_source, {})
2206 def classify_add_del_table(
2211 table_index=0xFFFFFFFF,
2213 memory_size=2097152,
2215 next_table_index=0xFFFFFFFF,
2216 miss_next_index=0xFFFFFFFF,
2217 current_data_flag=0,
2218 current_data_offset=0):
2222 :param match_n_vectors: (Default value = 1)
2223 :param table_index: (Default value = 0xFFFFFFFF)
2224 :param nbuckets: (Default value = 2)
2225 :param memory_size: (Default value = 2097152)
2226 :param skip_n_vectors: (Default value = 0)
2227 :param next_table_index: (Default value = 0xFFFFFFFF)
2228 :param miss_next_index: (Default value = 0xFFFFFFFF)
2229 :param current_data_flag: (Default value = 0)
2230 :param current_data_offset: (Default value = 0)
2233 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2234 mask = mask + '\0' * (mask_len - len(mask))
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,
2247 'mask_len': mask_len,
2250 def classify_add_del_session(
2255 opaque_index=0xFFFFFFFF,
2256 hit_next_index=0xFFFFFFFF,
2264 :param opaque_index: (Default value = 0xFFFFFFFF)
2265 :param hit_next_index: (Default value = 0xFFFFFFFF)
2266 :param advance: (Default value = 0)
2267 :param action: (Default value = 0)
2268 :param metadata: (Default value = 0)
2271 match_len = ((len(match) - 1) / 16 + 1) * 16
2272 match = match + '\0' * (match_len - len(match))
2274 self.papi.classify_add_del_session,
2276 'table_index': table_index,
2277 'hit_next_index': hit_next_index,
2278 'opaque_index': opaque_index,
2281 'metadata': metadata,
2282 'match_len': match_len,
2285 def input_acl_set_interface(
2289 ip4_table_index=0xFFFFFFFF,
2290 ip6_table_index=0xFFFFFFFF,
2291 l2_table_index=0xFFFFFFFF):
2295 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2296 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2297 :param l2_table_index: (Default value = 0xFFFFFFFF)
2301 self.papi.input_acl_set_interface,
2302 {'sw_if_index': sw_if_index,
2303 'ip4_table_index': ip4_table_index,
2304 'ip6_table_index': ip6_table_index,
2305 'l2_table_index': l2_table_index,
2308 def output_acl_set_interface(
2312 ip4_table_index=0xFFFFFFFF,
2313 ip6_table_index=0xFFFFFFFF,
2314 l2_table_index=0xFFFFFFFF):
2318 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2319 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2320 :param l2_table_index: (Default value = 0xFFFFFFFF)
2324 self.papi.output_acl_set_interface,
2325 {'sw_if_index': sw_if_index,
2326 'ip4_table_index': ip4_table_index,
2327 'ip6_table_index': ip6_table_index,
2328 'l2_table_index': l2_table_index,
2331 def set_ipfix_exporter(
2338 collector_port=4739,
2341 self.papi.set_ipfix_exporter,
2343 'collector_address': collector_address,
2344 'collector_port': collector_port,
2345 'src_address': src_address,
2347 'path_mtu': path_mtu,
2348 'template_interval': template_interval,
2349 'udp_checksum': udp_checksum,
2352 def dhcp_proxy_config(self,
2360 self.papi.dhcp_proxy_config,
2362 'rx_vrf_id': rx_table_id,
2363 'server_vrf_id': server_table_id,
2366 'dhcp_server': dhcp_server,
2367 'dhcp_src_address': dhcp_src_address,
2370 def dhcp_proxy_set_vss(self,
2379 self.papi.dhcp_proxy_set_vss,
2382 'vss_type': vss_type,
2383 'vpn_ascii_id': vpn_ascii_id,
2385 'vpn_index': vpn_index,
2390 def dhcp_client_dump(self):
2391 return self.api(self.papi.dhcp_client_dump, {})
2393 def dhcp_client(self,
2398 set_broadcast_flag=1,
2399 want_dhcp_events=0):
2401 self.papi.dhcp_client_config,
2405 'sw_if_index': sw_if_index,
2406 'hostname': hostname,
2408 'want_dhcp_event': want_dhcp_events,
2409 'set_broadcast_flag': set_broadcast_flag,
2413 def ip_mroute_add_del(self,
2419 next_hop_sw_if_index,
2429 IP Multicast Route add/del
2432 self.papi.ip_mroute_add_del,
2433 {'next_hop_sw_if_index': next_hop_sw_if_index,
2434 'entry_flags': e_flags,
2435 'itf_flags': i_flags,
2436 'table_id': table_id,
2440 'is_local': is_local,
2441 'bier_imp': bier_imp,
2442 'next_hop_afi': next_hop_afi,
2443 'grp_address_length': grp_address_length,
2444 'grp_address': grp_address,
2445 'src_address': src_address,
2446 'nh_address': next_hop_address})
2448 def mfib_signal_dump(self):
2449 return self.api(self.papi.mfib_signal_dump, {})
2451 def ip_mfib_dump(self):
2452 return self.api(self.papi.ip_mfib_dump, {})
2454 def ip6_mfib_dump(self):
2455 return self.api(self.papi.ip6_mfib_dump, {})
2457 def lisp_enable_disable(self, is_enabled):
2459 self.papi.lisp_enable_disable,
2461 'is_en': is_enabled,
2464 def lisp_locator_set(self,
2468 self.papi.lisp_add_del_locator_set,
2471 'locator_set_name': ls_name
2474 def lisp_locator_set_dump(self):
2475 return self.api(self.papi.lisp_locator_set_dump, {})
2477 def lisp_locator(self,
2484 self.papi.lisp_add_del_locator,
2487 'locator_set_name': ls_name,
2488 'sw_if_index': sw_if_index,
2489 'priority': priority,
2493 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2495 self.papi.lisp_locator_dump,
2497 'is_index_set': is_index_set,
2499 'ls_index': ls_index,
2502 def lisp_local_mapping(self,
2512 self.papi.lisp_add_del_local_eid,
2514 'locator_set_name': ls_name,
2516 'eid_type': eid_type,
2518 'prefix_len': prefix_len,
2524 def lisp_eid_table_dump(self,
2532 self.papi.lisp_eid_table_dump,
2535 'prefix_length': prefix_length,
2537 'eid_type': eid_type,
2539 'filter': filter_opt,
2542 def lisp_remote_mapping(self,
2552 self.papi.lisp_add_del_remote_mapping,
2555 'eid_type': eid_type,
2557 'eid_len': eid_prefix_len,
2558 'rloc_num': rlocs_num,
2561 'is_src_dst': is_src_dst,
2564 def lisp_adjacency(self,
2573 self.papi.lisp_add_del_adjacency,
2577 'eid_type': eid_type,
2580 'leid_len': leid_len,
2581 'reid_len': reid_len,
2584 def lisp_adjacencies_get(self, vni=0):
2586 self.papi.lisp_adjacencies_get,
2591 def map_add_domain(self,
2605 self.papi.map_add_domain,
2607 'ip6_prefix': ip6_prefix,
2608 'ip6_prefix_len': ip6_prefix_len,
2609 'ip4_prefix': ip4_prefix,
2610 'ip4_prefix_len': ip4_prefix_len,
2612 'ip6_src_prefix_len': ip6_src_prefix_len,
2613 'ea_bits_len': ea_bits_len,
2614 'psid_offset': psid_offset,
2615 'psid_length': psid_length,
2616 'is_translation': is_translation,
2617 'is_rfc6052': is_rfc6052,
2621 def gtpu_add_del_tunnel(
2627 mcast_sw_if_index=0xFFFFFFFF,
2629 decap_next_index=0xFFFFFFFF,
2633 :param is_add: (Default value = 1)
2634 :param is_ipv6: (Default value = 0)
2637 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2638 :param encap_vrf_id: (Default value = 0)
2639 :param decap_next_index: (Default value = 0xFFFFFFFF)
2640 :param teid: (Default value = 0)
2643 return self.api(self.papi.gtpu_add_del_tunnel,
2646 'src_address': src_addr,
2647 'dst_address': dst_addr,
2648 'mcast_sw_if_index': mcast_sw_if_index,
2649 'encap_vrf_id': encap_vrf_id,
2650 'decap_next_index': decap_next_index,
2653 def vxlan_gpe_add_del_tunnel(
2657 mcast_sw_if_index=0xFFFFFFFF,
2668 :param is_add: (Default value = 1)
2669 :param is_ipv6: (Default value = 0)
2670 :param encap_vrf_id: (Default value = 0)
2671 :param decap_vrf_id: (Default value = 0)
2672 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2673 :param protocol: (Default value = 3)
2674 :param vni: (Default value = 0)
2677 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2682 'mcast_sw_if_index': mcast_sw_if_index,
2683 'encap_vrf_id': encap_vrf_id,
2684 'decap_vrf_id': decap_vrf_id,
2685 'protocol': protocol,
2688 def pppoe_add_del_session(
2698 :param is_add: (Default value = 1)
2699 :param is_ipv6: (Default value = 0)
2701 :param session_id: (Default value = 0)
2703 :param decap_vrf_id: (Default value = 0)
2706 return self.api(self.papi.pppoe_add_del_session,
2709 'session_id': session_id,
2710 'client_ip': client_ip,
2711 'decap_vrf_id': decap_vrf_id,
2712 'client_mac': client_mac})
2714 def sr_localsid_add_del(self,
2721 sw_if_index=0xFFFFFFFF,
2725 """ Add/del IPv6 SR local-SID.
2728 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2729 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2732 :param is_del: (Default value = 0)
2733 :param end_psp: (Default value = 0)
2734 :param sw_if_index: (Default value = 0xFFFFFFFF)
2735 :param vlan_index: (Default value = 0)
2736 :param fib_table: (Default value = 0)
2739 self.papi.sr_localsid_add_del,
2741 'localsid': localsid,
2743 'behavior': behavior,
2744 'sw_if_index': sw_if_index,
2745 'vlan_index': vlan_index,
2746 'fib_table': fib_table,
2747 'nh_addr4': nh_addr4,
2748 'nh_addr6': nh_addr6
2762 :param bsid_addr: bindingSID of the SR Policy
2763 :param weight: weight of the sid list. optional. (default: 1)
2764 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2766 :param type: type/behavior of the SR policy. (default or spray) \
2768 :param fib_table: VRF where to install the FIB entry for the BSID \
2770 :param n_segments: number of segments \
2772 :param segments: a vector of IPv6 address composing the segment list \
2776 self.papi.sr_policy_add,
2777 {'bsid_addr': bsid_addr,
2779 'is_encap': is_encap,
2781 'fib_table': fib_table,
2782 'n_segments': n_segments,
2783 'segments': segments
2792 :param bsid: bindingSID of the SR Policy
2793 :param sr_policy_index: index of the sr policy (default: 0)
2796 self.papi.sr_policy_del,
2797 {'bsid_addr': bsid_addr,
2798 'sr_policy_index': sr_policy_index
2801 def sr_steering_add_del(
2812 Steer traffic L2 and L3 traffic through a given SR policy
2814 :param is_del: delete or add
2815 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2816 :param sr_policy: is the index of the SR Policy (alt to bsid)
2817 :param table_id: is the VRF where to install the FIB entry for the BSID
2818 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2819 :param mask_width: is the mask for L3 traffic type
2820 :param sw_if_index: is the incoming interface for L2 traffic
2821 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2824 self.papi.sr_steering_add_del,
2826 'bsid_addr': bsid_addr,
2827 'sr_policy_index': sr_policy_index,
2828 'table_id': table_id,
2829 'prefix_addr': prefix_addr,
2830 'mask_width': mask_width,
2831 'sw_if_index': sw_if_index,
2832 'traffic_type': traffic_type
2835 def acl_add_replace(self, acl_index, r, tag='',
2837 """Add/replace an ACL
2838 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2839 :param acl_rule r: ACL rules array.
2840 :param str tag: symbolic tag (description) for this ACL.
2841 :param int count: number of rules.
2843 return self.api(self.papi.acl_add_replace,
2844 {'acl_index': acl_index,
2848 expected_retval=expected_retval)
2850 def acl_del(self, acl_index, expected_retval=0):
2856 return self.api(self.papi.acl_del,
2857 {'acl_index': acl_index},
2858 expected_retval=expected_retval)
2860 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2862 return self.api(self.papi.acl_interface_set_acl_list,
2863 {'sw_if_index': sw_if_index,
2867 expected_retval=expected_retval)
2869 def acl_interface_set_etype_whitelist(self, sw_if_index,
2872 return self.api(self.papi.acl_interface_set_etype_whitelist,
2873 {'sw_if_index': sw_if_index,
2874 'count': len(whitelist),
2876 'whitelist': whitelist},
2877 expected_retval=expected_retval)
2879 def acl_interface_add_del(self,
2883 """ Add/Delete ACL to/from interface
2887 :param is_add: (Default value = 1)
2890 return self.api(self.papi.acl_interface_add_del,
2893 'sw_if_index': sw_if_index,
2894 'acl_index': acl_index})
2896 def acl_dump(self, acl_index, expected_retval=0):
2897 return self.api(self.papi.acl_dump,
2898 {'acl_index': acl_index},
2899 expected_retval=expected_retval)
2901 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2903 return self.api(self.papi.acl_interface_list_dump,
2904 {'sw_if_index': sw_if_index},
2905 expected_retval=expected_retval)
2907 def macip_acl_add(self, rules, tag=""):
2910 :param rules: list of rules for given acl
2914 return self.api(self.papi.macip_acl_add,
2916 'count': len(rules),
2919 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2922 :param rules: list of rules for given acl
2926 return self.api(self.papi.macip_acl_add_replace,
2927 {'acl_index': acl_index,
2929 'count': len(rules),
2932 def macip_acl_del(self, acl_index):
2938 return self.api(self.papi.macip_acl_del,
2939 {'acl_index': acl_index})
2941 def macip_acl_interface_add_del(self,
2945 """ Add MACIP acl to interface
2949 :param is_add: (Default value = 1)
2952 return self.api(self.papi.macip_acl_interface_add_del,
2954 'sw_if_index': sw_if_index,
2955 'acl_index': acl_index})
2957 def macip_acl_interface_get(self):
2958 """ Return interface acls dump
2961 self.papi.macip_acl_interface_get, {})
2963 def macip_acl_dump(self, acl_index=4294967295):
2964 """ Return MACIP acl dump
2968 self.papi.macip_acl_dump, {'acl_index': acl_index})
2970 def policer_add_del(self,
2981 conform_action_type=1,
2983 exceed_action_type=0,
2985 violate_action_type=0,
2987 return self.api(self.papi.policer_add_del,
2994 'rate_type': rate_type,
2995 'round_type': round_type,
2997 'color_aware': color_aware,
2998 'conform_action_type': conform_action_type,
2999 'conform_dscp': conform_dscp,
3000 'exceed_action_type': exceed_action_type,
3001 'exceed_dscp': exceed_dscp,
3002 'violate_action_type': violate_action_type,
3003 'violate_dscp': violate_dscp})
3005 def ip_punt_police(self,
3009 return self.api(self.papi.ip_punt_police,
3010 {'policer_index': policer_index,
3014 def ip_punt_redirect(self,
3020 return self.api(self.papi.ip_punt_redirect,
3021 {'rx_sw_if_index': rx_sw_if_index,
3022 'tx_sw_if_index': tx_sw_if_index,
3027 def bier_table_add_del(self,
3031 """ BIER Table add/del """
3033 self.papi.bier_table_add_del,
3034 {'bt_tbl_id': {"bt_set": bti.set_id,
3035 "bt_sub_domain": bti.sub_domain_id,
3036 "bt_hdr_len_id": bti.hdr_len_id},
3037 'bt_label': mpls_label,
3038 'bt_is_add': is_add})
3040 def bier_table_dump(self):
3041 return self.api(self.papi.bier_table_dump, {})
3043 def bier_route_add_del(self,
3048 """ BIER Route add/del """
3050 self.papi.bier_route_add_del,
3051 {'br_tbl_id': {"bt_set": bti.set_id,
3052 "bt_sub_domain": bti.sub_domain_id,
3053 "bt_hdr_len_id": bti.hdr_len_id},
3055 'br_n_paths': len(paths),
3057 'br_is_add': is_add})
3059 def bier_route_dump(self, bti):
3061 self.papi.bier_route_dump,
3062 {'br_tbl_id': {"bt_set": bti.set_id,
3063 "bt_sub_domain": bti.sub_domain_id,
3064 "bt_hdr_len_id": bti.hdr_len_id}})
3066 def bier_imp_add(self,
3071 """ BIER Imposition Add """
3073 self.papi.bier_imp_add,
3074 {'bi_tbl_id': {"bt_set": bti.set_id,
3075 "bt_sub_domain": bti.sub_domain_id,
3076 "bt_hdr_len_id": bti.hdr_len_id},
3078 'bi_n_bytes': len(ibytes),
3079 'bi_bytes': ibytes})
3081 def bier_imp_del(self, bi_index):
3082 """ BIER Imposition del """
3084 self.papi.bier_imp_del,
3085 {'bi_index': bi_index})
3087 def bier_imp_dump(self):
3088 return self.api(self.papi.bier_imp_dump, {})
3090 def bier_disp_table_add_del(self,
3093 """ BIER Disposition Table add/del """
3095 self.papi.bier_disp_table_add_del,
3096 {'bdt_tbl_id': bdti,
3097 'bdt_is_add': is_add})
3099 def bier_disp_table_dump(self):
3100 return self.api(self.papi.bier_disp_table_dump, {})
3102 def bier_disp_entry_add_del(self,
3112 """ BIER Route add/del """
3114 while (len(lstack) < 16):
3117 self.papi.bier_disp_entry_add_del,
3118 {'bde_tbl_id': bdti,
3120 'bde_payload_proto': payload_proto,
3122 'bde_paths': [{'next_hop': next_hop,
3123 'table_id': next_hop_tbl_id,
3124 'afi': next_hop_afi,
3125 'rpf_id': next_hop_rpf_id,
3127 'label_stack': lstack}],
3128 'bde_is_add': is_add})
3130 def bier_disp_entry_dump(self, bdti):
3132 self.papi.bier_disp_entry_dump,
3133 {'bde_tbl_id': bdti})
3135 def add_node_next(self, node_name, next_name):
3136 """ Set the next node for a given node request
3141 return self.api(self.papi.add_node_next,
3142 {'node_name': node_name,
3143 'next_name': next_name})
3145 def session_enable_disable(self, is_enabled):
3147 self.papi.session_enable_disable,
3148 {'is_enable': is_enabled})
3150 def ipsec_spd_add_del(self, spd_id, is_add=1):
3151 """ SPD add/del - Wrapper to add or del ipsec SPD
3152 Sample CLI : 'ipsec spd add 1'
3154 :param spd_id - SPD ID to be created in the vpp . mandatory
3155 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3157 :returns: reply from the API
3160 self.papi.ipsec_spd_add_del, {
3161 'spd_id': spd_id, 'is_add': is_add})
3163 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3164 """ IPSEC interface SPD add/del - \
3165 Wrapper to associate/disassociate SPD to interface in VPP
3166 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3168 :param spd_id - SPD ID to associate with the interface . mandatory
3169 :param sw_if_index - Interface Index which needs to ipsec \
3170 association mandatory
3171 :param is_add - add(1) or del(0) association with interface \
3172 (Default 1 - add) . optional
3173 :returns: reply from the API
3176 self.papi.ipsec_interface_add_del_spd,
3177 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3179 def ipsec_sad_add_del_entry(self,
3182 integrity_algorithm,
3187 tunnel_src_address='',
3188 tunnel_dst_address='',
3192 """ IPSEC SA add/del
3193 :param sad_id: security association ID
3194 :param spi: security param index of the SA in decimal
3195 :param integrity_algorithm:
3196 :param integrity_key:
3197 :param crypto_algorithm:
3199 :param protocol: AH(0) or ESP(1) protocol
3200 :param tunnel_src_address: tunnel mode outer src address
3201 :param tunnel_dst_address: tunnel mode outer dst address
3204 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3205 crypto and ipsec algorithms
3208 self.papi.ipsec_sad_add_del_entry,
3211 'tunnel_src_address': tunnel_src_address,
3212 'tunnel_dst_address': tunnel_dst_address,
3213 'protocol': protocol,
3214 'integrity_algorithm': integrity_algorithm,
3215 'integrity_key_length': len(integrity_key),
3216 'integrity_key': integrity_key,
3217 'crypto_algorithm': crypto_algorithm,
3218 'crypto_key_length': len(crypto_key) if crypto_key is not None
3220 'crypto_key': crypto_key,
3222 'is_tunnel': is_tunnel,
3223 'udp_encap': udp_encap})
3225 def ipsec_spd_add_del_entry(self,
3228 local_address_start,
3230 remote_address_start,
3231 remote_address_stop,
3233 local_port_stop=65535,
3234 remote_port_start=0,
3235 remote_port_stop=65535,
3242 """ IPSEC policy SPD add/del -
3243 Wrapper to configure ipsec SPD policy entries in VPP
3244 :param spd_id: SPD ID for the policy
3245 :param local_address_start: local-ip-range start address
3246 :param local_address_stop : local-ip-range stop address
3247 :param remote_address_start: remote-ip-range start address
3248 :param remote_address_stop : remote-ip-range stop address
3249 :param local_port_start: (Default value = 0)
3250 :param local_port_stop: (Default value = 65535)
3251 :param remote_port_start: (Default value = 0)
3252 :param remote_port_stop: (Default value = 65535)
3253 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3254 :param sa_id: Security Association ID for mapping it to SPD
3255 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3257 :param priority: value for the spd action (Default value = 100)
3258 :param is_outbound: flag for inbound(0) or outbound(1)
3260 :param is_add: (Default value = 1)
3263 self.papi.ipsec_spd_add_del_entry,
3266 'local_address_start': local_address_start,
3267 'local_address_stop': local_address_stop,
3268 'remote_address_start': remote_address_start,
3269 'remote_address_stop': remote_address_stop,
3270 'local_port_start': local_port_start,
3271 'local_port_stop': local_port_stop,
3272 'remote_port_start': remote_port_start,
3273 'remote_port_stop': remote_port_stop,
3275 'protocol': protocol,
3277 'priority': priority,
3278 'is_outbound': is_outbound,
3279 'is_ip_any': is_ip_any})
3281 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3282 remote_spi, crypto_alg, local_crypto_key,
3283 remote_crypto_key, integ_alg, local_integ_key,
3284 remote_integ_key, is_add=1, esn=0,
3285 anti_replay=1, renumber=0, show_instance=0):
3287 self.papi.ipsec_tunnel_if_add_del,
3288 {'local_ip': local_ip, 'remote_ip': remote_ip,
3289 'local_spi': local_spi, 'remote_spi': remote_spi,
3290 'crypto_alg': crypto_alg,
3291 'local_crypto_key_len': len(local_crypto_key),
3292 'local_crypto_key': local_crypto_key,
3293 'remote_crypto_key_len': len(remote_crypto_key),
3294 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3295 'local_integ_key_len': len(local_integ_key),
3296 'local_integ_key': local_integ_key,
3297 'remote_integ_key_len': len(remote_integ_key),
3298 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3299 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3300 'show_instance': show_instance
3303 def app_namespace_add(self,
3307 sw_if_index=0xFFFFFFFF,
3310 self.papi.app_namespace_add_del,
3312 'sw_if_index': sw_if_index,
3313 'ip4_fib_id': ip4_fib_id,
3314 'ip6_fib_id': ip6_fib_id,
3315 'namespace_id': namespace_id,
3316 'namespace_id_len': len(namespace_id)})
3318 def punt_socket_register(self, l4_port, pathname, header_version=1,
3319 is_ip4=1, l4_protocol=0x11):
3320 """ Punt to socket """
3321 return self.api(self.papi.punt_socket_register,
3323 'l4_protocol': l4_protocol,
3325 'pathname': pathname,
3326 'header_version': header_version})
3328 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3329 expire_walk_interval_ms, is_ip6=0):
3330 """ Set IP reassembly parameters """
3331 return self.api(self.papi.ip_reassembly_set,
3333 'timeout_ms': timeout_ms,
3334 'expire_walk_interval_ms': expire_walk_interval_ms,
3335 'max_reassemblies': max_reassemblies})
3337 def ip_reassembly_get(self, is_ip6=0):
3338 """ Get IP reassembly parameters """
3339 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3341 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3343 """ Enable/disable IP reassembly """
3344 return self.api(self.papi.ip_reassembly_enable_disable,
3345 {'sw_if_index': sw_if_index,
3346 'enable_ip4': 1 if enable_ip4 else 0,
3347 'enable_ip6': 1 if enable_ip6 else 0,
3350 def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
3351 """ GBP endpoint Add/Del """
3352 return self.api(self.papi.gbp_endpoint_add_del,
3356 'sw_if_index': sw_if_index,
3360 def gbp_endpoint_dump(self):
3361 """ GBP endpoint Dump """
3362 return self.api(self.papi.gbp_endpoint_dump, {})
3364 def gbp_endpoint_group_add_del(self, is_add, epg, bd,
3367 uplink_sw_if_index):
3368 """ GBP endpoint group Add/Del """
3369 return self.api(self.papi.gbp_endpoint_group_add_del,
3372 'uplink_sw_if_index': uplink_sw_if_index,
3374 'ip4_table_id': ip4_rd,
3375 'ip6_table_id': ip6_rd,
3378 def gbp_endpoint_group_dump(self):
3379 """ GBP endpoint group Dump """
3380 return self.api(self.papi.gbp_endpoint_group_dump, {})
3382 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3383 """ GBP recirc Add/Del """
3384 return self.api(self.papi.gbp_recirc_add_del,
3388 'sw_if_index': sw_if_index,
3391 def gbp_recirc_dump(self):
3392 """ GBP recirc Dump """
3393 return self.api(self.papi.gbp_recirc_dump, {})
3395 def gbp_subnet_add_del(self, is_add, table_id,
3398 sw_if_index=0xffffffff,
3401 """ GBP Subnet Add/Del """
3402 return self.api(self.papi.gbp_subnet_add_del,
3405 'is_internal': is_internal,
3407 'sw_if_index': sw_if_index,
3410 'address_length': addr_len,
3411 'table_id': table_id}})
3413 def gbp_subnet_dump(self):
3414 """ GBP Subnet Dump """
3415 return self.api(self.papi.gbp_subnet_dump, {})
3417 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3418 """ GBP contract Add/Del """
3419 return self.api(self.papi.gbp_contract_add_del,
3422 'acl_index': acl_index,
3424 'dst_epg': dst_epg}})
3426 def gbp_contract_dump(self):
3427 """ GBP contract Dump """
3428 return self.api(self.papi.gbp_contract_dump, {})
3430 def ipip_6rd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len,
3431 ip4_prefix, ip4_prefix_len, ip4_src,
3433 """ 6RD tunnel Add """
3434 return self.api(self.papi.ipip_6rd_add_tunnel,
3435 {'fib_index': fib_index,
3436 'ip6_prefix': ip6_prefix,
3437 'ip6_prefix_len': ip6_prefix_len,
3438 'ip4_prefix': ip4_prefix,
3439 'ip4_prefix_len': ip4_prefix_len,
3441 'security_check': security_check})
3443 def ipip_6rd_del_tunnel(self, sw_if_index):
3444 """ 6RD tunnel Delete """
3445 return self.api(self.papi.ipip_6rd_del_tunnel,
3446 {'sw_if_index': sw_if_index})
3448 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3449 instance=0xFFFFFFFF, fib_index=0, tc_tos=0):
3450 """ IPIP tunnel Add/Del """
3451 return self.api(self.papi.ipip_add_tunnel,
3452 {'is_ipv6': is_ipv6,
3453 'instance': instance,
3454 'src_address': src_address,
3455 'dst_address': dst_address,
3456 'fib_index': fib_index,
3459 def ipip_del_tunnel(self, sw_if_index):
3460 """ IPIP tunnel Delete """
3461 return self.api(self.papi.ipip_del_tunnel,
3462 {'sw_if_index': sw_if_index})
3464 def qos_egress_map_update(self, id, outputs):
3465 """ QOS egress map update """
3466 return self.api(self.papi.qos_egress_map_update,
3470 def qos_egress_map_delete(self, id):
3471 """ QOS egress map delete """
3472 return self.api(self.papi.qos_egress_map_delete,
3475 def qos_mark_enable_disable(self, sw_if_index,
3479 """ QOS Mark Enable/Disable """
3480 return self.api(self.papi.qos_mark_enable_disable,
3482 'sw_if_index': sw_if_index,
3483 'output_source': output_source,
3486 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3487 """ IP QoS recording Enble/Disable """
3488 return self.api(self.papi.qos_record_enable_disable,
3489 {'sw_if_index': sw_if_index,
3490 'input_source': input_source,
3493 def igmp_enable_disable(self, sw_if_index, enable, host):
3494 """ Enable/disable IGMP on a given interface """
3495 return self.api(self.papi.igmp_enable_disable,
3498 'sw_if_index': sw_if_index})
3500 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3501 """ Listen for new (S,G) on specified interface
3503 :param enable: add/del
3504 :param sw_if_index: interface sw index
3505 :param saddr: source ip4 addr
3506 :param gaddr: group ip4 addr
3508 return self.api(self.papi.igmp_listen,
3513 'sw_if_index': sw_if_index,
3514 'n_srcs': len(saddrs),
3523 def igmp_dump(self, sw_if_index=None):
3524 """ Dump all (S,G) interface configurations """
3525 if sw_if_index is None:
3526 sw_if_index = 0xffffffff
3527 return self.api(self.papi.igmp_dump,
3528 {'sw_if_index': sw_if_index})
3530 def igmp_clear_interface(self, sw_if_index):
3531 """ Remove all (S,G)s from specified interface
3532 doesn't send IGMP report!
3535 self.papi.igmp_clear_interface, {
3536 'sw_if_index': sw_if_index})
3538 def want_igmp_events(self, enable=1):
3539 return self.api(self.papi.want_igmp_events, {'enable': enable,
3540 'pid': os.getpid()})
3550 :param lb: load balance
3551 :param use_custom_mac: use custom mac
3552 :param mac_address: mac address
3555 self.papi.bond_create,
3558 'use_custom_mac': use_custom_mac,
3559 'mac_address': mac_address
3566 :param sw_if_index: interface the operation is applied to
3568 return self.api(self.papi.bond_delete,
3569 {'sw_if_index': sw_if_index})
3578 :param sw_if_index: slave sw_if_index
3579 :param bond_sw_if_index: bond sw_if_index
3580 :param is_passive: is passive lacp speaker
3581 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3584 self.papi.bond_enslave,
3585 {'sw_if_index': sw_if_index,
3586 'bond_sw_if_index': bond_sw_if_index,
3587 'is_passive': is_passive,
3588 'is_long_timeout': is_long_timeout
3591 def bond_detach_slave(
3595 :param sw_if_index: slave interface the operation is applied to
3597 return self.api(self.papi.bond_detach_slave,
3598 {'sw_if_index': sw_if_index})
3600 def sw_interface_slave_dump(
3604 :param sw_if_index: bond sw_if_index
3606 return self.api(self.papi.sw_interface_slave_dump,
3607 {'sw_if_index': sw_if_index})
3609 def sw_interface_bond_dump(
3614 return self.api(self.papi.sw_interface_bond_dump,
3617 def create_vhost_user_if(
3622 custom_dev_instance,
3627 :param is_server: is server
3628 :param sock_filename: socket name
3629 :param renumber: renumber
3630 :param custom_dev_instance: custom dev instance
3631 :param use_custom_mac: use custom mac
3632 :param mac_address: mac address
3633 :param tag: tag (default ''
3636 self.papi.create_vhost_user_if,
3637 {'is_server': is_server,
3638 'sock_filename': sock_filename,
3639 'renumber': renumber,
3640 'custom_dev_instance': custom_dev_instance,
3641 'use_custom_mac': use_custom_mac,
3642 'mac_address': mac_address,
3646 def delete_vhost_user_if(
3650 :param sw_if_index: interface the operation is applied to
3652 return self.api(self.papi.delete_vhost_user_if,
3653 {'sw_if_index': sw_if_index, })
3655 def sw_interface_vhost_user_dump(
3660 return self.api(self.papi.sw_interface_vhost_user_dump,
3663 def abf_policy_add_del(self, is_add, policy):
3665 self.papi.abf_policy_add_del,
3669 def abf_itf_attach_add_del(self, is_add, attach):
3671 self.papi.abf_itf_attach_add_del,
3675 def abf_policy_dump(self):
3677 self.papi.abf_policy_dump, {})
3679 def abf_itf_attach_dump(self):
3681 self.papi.abf_itf_attach_dump, {})
3683 def pipe_create(self, is_specified, user_instance):
3684 return self.api(self.papi.pipe_create,
3685 {'is_specified': is_specified,
3686 'user_instance': user_instance})
3688 def pipe_delete(self, parent_sw_if_index):
3689 return self.api(self.papi.pipe_delete,
3690 {'parent_sw_if_index': parent_sw_if_index})
3692 def pipe_dump(self):
3693 return self.api(self.papi.pipe_dump, {})