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_flags(self, sw_if_index, admin_up_down):
726 :param admin_up_down:
730 return self.api(self.papi.sw_interface_set_flags,
731 {'sw_if_index': sw_if_index,
732 'admin_up_down': admin_up_down})
734 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
740 return self.api(self.papi.sw_interface_set_mtu,
741 {'sw_if_index': sw_if_index,
744 def sw_interface_set_promiscuous(self, sw_if_index, enable):
750 return self.api(self.papi.sw_interface_set_promiscuous,
751 {'sw_if_index': sw_if_index,
754 def sw_interface_set_mac_address(self, sw_if_index, mac):
755 return self.api(self.papi.sw_interface_set_mac_address,
756 {'sw_if_index': sw_if_index,
759 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
760 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
761 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
762 """Create subinterface
763 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
765 :param sub_id: param inner_vlan:
769 :param no_tags: (Default value = 0)
770 :param one_tag: (Default value = 0)
771 :param two_tags: (Default value = 0)
772 :param dot1ad: (Default value = 0)
773 :param exact_match: (Default value = 0)
774 :param default_sub: (Default value = 0)
775 :param outer_vlan_id_any: (Default value = 0)
776 :param inner_vlan_id_any: (Default value = 0)
780 self.papi.create_subif,
781 {'sw_if_index': sw_if_index,
785 'two_tags': two_tags,
787 'exact_match': exact_match,
788 'default_sub': default_sub,
789 'outer_vlan_id_any': outer_vlan_id_any,
790 'inner_vlan_id_any': inner_vlan_id_any,
791 'outer_vlan_id': outer_vlan,
792 'inner_vlan_id': inner_vlan})
794 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
795 """Create p2p ethernet subinterface
797 :param sw_if_index: main (parent) interface
798 :param remote_mac: client (remote) mac address
802 self.papi.p2p_ethernet_add,
803 {'parent_if_index': sw_if_index,
804 'remote_mac': remote_mac,
805 'subif_id': subif_id})
807 def delete_subif(self, sw_if_index):
808 """Delete subinterface
812 return self.api(self.papi.delete_subif,
813 {'sw_if_index': sw_if_index})
815 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
816 """Delete p2p ethernet subinterface
818 :param sw_if_index: main (parent) interface
819 :param remote_mac: client (remote) mac address
823 self.papi.p2p_ethernet_del,
824 {'parent_if_index': sw_if_index,
825 'remote_mac': remote_mac})
827 def create_vlan_subif(self, sw_if_index, vlan):
834 return self.api(self.papi.create_vlan_subif,
835 {'sw_if_index': sw_if_index,
838 def create_loopback(self, mac=''):
841 :param mac: (Optional)
843 return self.api(self.papi.create_loopback,
844 {'mac_address': mac})
846 def delete_loopback(self, sw_if_index):
847 return self.api(self.papi.delete_loopback,
848 {'sw_if_index': sw_if_index, })
850 def ip_table_add_del(self,
857 :param is_add: (Default value = 1)
858 :param is_ipv6: (Default value = 0)
863 self.papi.ip_table_add_del,
864 {'table_id': table_id,
868 def ip_add_del_route(
873 next_hop_sw_if_index=0xFFFFFFFF,
877 next_hop_n_out_labels=0,
878 next_hop_out_label_stack=[],
879 next_hop_via_label=MPLS_LABEL_INVALID,
880 next_hop_id=0xFFFFFFFF,
882 is_resolve_attached=0,
883 classify_table_index=0xFFFFFFFF,
897 :param dst_address_length:
898 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
900 :param next_hop_address:
901 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
902 :param vrf_id: (Default value = 0)
903 :param lookup_in_vrf: (Default value = 0)
904 :param classify_table_index: (Default value = 0xFFFFFFFF)
905 :param is_add: (Default value = 1)
906 :param is_drop: (Default value = 0)
907 :param is_ipv6: (Default value = 0)
908 :param is_local: (Default value = 0)
909 :param is_classify: (Default value = 0)
910 :param is_multipath: (Default value = 0)
911 :param is_resolve_host: (Default value = 0)
912 :param is_resolve_attached: (Default value = 0)
913 :param is_dvr: (Default value = 0)
914 :param is_source_lookup: (Default value = 0)
915 :param next_hop_weight: (Default value = 1)
920 self.papi.ip_add_del_route,
921 {'next_hop_sw_if_index': next_hop_sw_if_index,
922 'table_id': table_id,
923 'classify_table_index': classify_table_index,
924 'next_hop_table_id': next_hop_table_id,
927 'is_unreach': is_unreach,
928 'is_prohibit': is_prohibit,
930 'is_local': is_local,
931 'is_classify': is_classify,
932 'is_multipath': is_multipath,
933 'is_resolve_host': is_resolve_host,
934 'is_resolve_attached': is_resolve_attached,
936 'is_source_lookup': is_source_lookup,
937 'is_udp_encap': is_udp_encap,
938 'next_hop_weight': next_hop_weight,
939 'dst_address_length': dst_address_length,
940 'dst_address': dst_address,
941 'next_hop_id': next_hop_id,
942 'next_hop_address': next_hop_address,
943 'next_hop_n_out_labels': next_hop_n_out_labels,
944 'next_hop_via_label': next_hop_via_label,
945 'next_hop_out_label_stack': next_hop_out_label_stack})
947 def ip_fib_dump(self):
948 return self.api(self.papi.ip_fib_dump, {})
950 def ip6_fib_dump(self):
951 return self.api(self.papi.ip6_fib_dump, {})
953 def ip_neighbor_add_del(self,
962 """ Add neighbor MAC to IPv4 or IPv6 address.
967 :param is_add: (Default value = 1)
968 :param is_ipv6: (Default value = 0)
969 :param is_static: (Default value = 0)
970 :param is_no_adj_fib: (Default value = 0)
974 self.papi.ip_neighbor_add_del,
975 {'sw_if_index': sw_if_index,
978 'is_static': is_static,
979 'is_no_adj_fib': is_no_adj_fib,
980 'mac_address': mac_address,
981 'dst_address': dst_address
985 def ip_neighbor_dump(self,
988 """ Return IP neighbor dump.
991 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
995 self.papi.ip_neighbor_dump,
997 'sw_if_index': sw_if_index
1001 def proxy_arp_add_del(self,
1006 """ Config Proxy Arp Range.
1008 :param low_address: Start address in the rnage to Proxy for
1009 :param hi_address: End address in the rnage to Proxy for
1010 :param vrf_id: The VRF/table in which to proxy
1014 self.papi.proxy_arp_add_del,
1018 'low_address': low_address,
1019 'hi_address': hi_address,
1023 def proxy_arp_intfc_enable_disable(self,
1026 """ Enable/Disable an interface for proxy ARP requests
1028 :param sw_if_index: Interface
1029 :param enable_disable: Enable/Disable
1033 self.papi.proxy_arp_intfc_enable_disable,
1034 {'sw_if_index': sw_if_index,
1035 'enable_disable': is_enable
1043 """ Reset VRF (remove all routes etc.) request.
1045 :param int vrf_id: ID of the FIB table / VRF to reset.
1046 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1050 self.papi.reset_vrf,
1060 """ Reset VRF (remove all routes etc.) request.
1062 :param int vrf_id: ID of the FIB table / VRF to reset.
1063 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1067 self.papi.reset_fib,
1078 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1083 {'is_ipv6': is_ipv6,
1087 def sw_interface_span_enable_disable(
1088 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1091 :param sw_if_index_from:
1092 :param sw_if_index_to:
1096 return self.api(self.papi.sw_interface_span_enable_disable,
1097 {'sw_if_index_from': sw_if_index_from,
1098 'sw_if_index_to': sw_if_index_to,
1103 def gre_tunnel_add_del(self,
1108 instance=0xFFFFFFFF,
1112 """ Add a GRE tunnel
1116 :param outer_fib_id: (Default value = 0)
1117 :param tunnel_type: (Default value = 0)
1118 :param instance: (Default value = 0xFFFFFFFF)
1119 :param session_id: (Defalt value = 0)
1120 :param is_add: (Default value = 1)
1121 :param is_ipv6: (Default value = 0)
1125 self.papi.gre_add_del_tunnel,
1128 'tunnel_type': tunnel_type,
1129 'instance': instance,
1130 'src_address': src_address,
1131 'dst_address': dst_address,
1132 'outer_fib_id': outer_fib_id,
1133 'session_id': session_id}
1136 def udp_encap_add_del(self,
1145 """ Add a GRE tunnel
1146 :param id: user provided ID
1151 :param outer_fib_id: (Default value = 0)
1152 :param is_add: (Default value = 1)
1153 :param is_ipv6: (Default value = 0)
1157 self.papi.udp_encap_add_del,
1163 'src_port': src_port,
1164 'dst_port': dst_port,
1165 'table_id': table_id}
1168 def udp_encap_dump(self):
1169 return self.api(self.papi.udp_encap_dump, {})
1171 def want_udp_encap_stats(self, enable=1):
1172 return self.api(self.papi.want_udp_encap_stats,
1174 'pid': os.getpid()})
1176 def mpls_fib_dump(self):
1177 return self.api(self.papi.mpls_fib_dump, {})
1179 def mpls_table_add_del(
1186 :param is_add: (Default value = 1)
1191 self.papi.mpls_table_add_del,
1192 {'mt_table_id': table_id,
1193 'mt_is_add': is_add})
1195 def mpls_route_add_del(
1201 next_hop_sw_if_index=0xFFFFFFFF,
1203 next_hop_table_id=0,
1205 next_hop_n_out_labels=0,
1206 next_hop_out_label_stack=[],
1207 next_hop_via_label=MPLS_LABEL_INVALID,
1209 is_resolve_attached=0,
1216 classify_table_index=0xFFFFFFFF,
1220 :param dst_address_length:
1221 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1223 :param next_hop_address:
1224 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1225 :param vrf_id: (Default value = 0)
1226 :param lookup_in_vrf: (Default value = 0)
1227 :param classify_table_index: (Default value = 0xFFFFFFFF)
1228 :param is_add: (Default value = 1)
1229 :param is_drop: (Default value = 0)
1230 :param is_ipv6: (Default value = 0)
1231 :param is_local: (Default value = 0)
1232 :param is_classify: (Default value = 0)
1233 :param is_multipath: (Default value = 0)
1234 :param is_multicast: (Default value = 0)
1235 :param is_resolve_host: (Default value = 0)
1236 :param is_resolve_attached: (Default value = 0)
1237 :param next_hop_weight: (Default value = 1)
1241 self.papi.mpls_route_add_del,
1244 'mr_table_id': table_id,
1245 'mr_classify_table_index': classify_table_index,
1246 'mr_is_add': is_add,
1247 'mr_is_classify': is_classify,
1248 'mr_is_multipath': is_multipath,
1249 'mr_is_multicast': is_multicast,
1250 'mr_is_resolve_host': is_resolve_host,
1251 'mr_is_resolve_attached': is_resolve_attached,
1252 'mr_is_interface_rx': is_interface_rx,
1253 'mr_is_rpf_id': is_rpf_id,
1254 'mr_next_hop_proto': next_hop_proto,
1255 'mr_next_hop_weight': next_hop_weight,
1256 'mr_next_hop': next_hop_address,
1257 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1258 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1259 'mr_next_hop_table_id': next_hop_table_id,
1260 'mr_next_hop_via_label': next_hop_via_label,
1261 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1263 def mpls_ip_bind_unbind(
1275 self.papi.mpls_ip_bind_unbind,
1276 {'mb_mpls_table_id': table_id,
1278 'mb_ip_table_id': ip_table_id,
1279 'mb_is_bind': is_bind,
1280 'mb_is_ip4': is_ip4,
1281 'mb_address_length': dst_address_length,
1282 'mb_address': dst_address})
1284 def mpls_tunnel_add_del(
1287 next_hop_proto_is_ip4,
1289 next_hop_sw_if_index=0xFFFFFFFF,
1290 next_hop_table_id=0,
1292 next_hop_n_out_labels=0,
1293 next_hop_out_label_stack=[],
1294 next_hop_via_label=MPLS_LABEL_INVALID,
1300 :param dst_address_length:
1301 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1303 :param next_hop_address:
1304 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1305 :param vrf_id: (Default value = 0)
1306 :param lookup_in_vrf: (Default value = 0)
1307 :param classify_table_index: (Default value = 0xFFFFFFFF)
1308 :param is_add: (Default value = 1)
1309 :param is_drop: (Default value = 0)
1310 :param is_ipv6: (Default value = 0)
1311 :param is_local: (Default value = 0)
1312 :param is_classify: (Default value = 0)
1313 :param is_multipath: (Default value = 0)
1314 :param is_resolve_host: (Default value = 0)
1315 :param is_resolve_attached: (Default value = 0)
1316 :param next_hop_weight: (Default value = 1)
1317 :param is_multicast: (Default value = 0)
1321 self.papi.mpls_tunnel_add_del,
1322 {'mt_sw_if_index': tun_sw_if_index,
1323 'mt_is_add': is_add,
1324 'mt_l2_only': l2_only,
1325 'mt_is_multicast': is_multicast,
1326 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1327 'mt_next_hop_weight': next_hop_weight,
1328 'mt_next_hop': next_hop_address,
1329 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1330 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1331 'mt_next_hop_table_id': next_hop_table_id,
1332 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1334 def nat44_interface_add_del_feature(
1339 """Enable/disable NAT44 feature on the interface
1341 :param sw_if_index: Software index of the interface
1342 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1343 :param is_add: 1 if add, 0 if delete (Default value = 1)
1346 self.papi.nat44_interface_add_del_feature,
1348 'is_inside': is_inside,
1349 'sw_if_index': sw_if_index})
1351 def nat44_interface_add_del_output_feature(
1356 """Enable/disable NAT44 output feature on the interface
1358 :param sw_if_index: Software index of the interface
1359 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1360 :param is_add: 1 if add, 0 if delete (Default value = 1)
1363 self.papi.nat44_interface_add_del_output_feature,
1365 'is_inside': is_inside,
1366 'sw_if_index': sw_if_index})
1368 def nat44_add_del_static_mapping(
1372 external_sw_if_index=0xFFFFFFFF,
1383 """Add/delete NAT44 static mapping
1385 :param local_ip: Local IP address
1386 :param external_ip: External IP address
1387 :param external_sw_if_index: External interface instead of IP address
1388 :param local_port: Local port number (Default value = 0)
1389 :param external_port: External port number (Default value = 0)
1390 :param addr_only: 1 if address only mapping, 0 if address and port
1391 :param vrf_id: VRF ID
1392 :param protocol: IP protocol (Default value = 0)
1393 :param twice_nat: 1 if translate external host address and port
1394 :param self_twice_nat: 1 if translate external host address and port
1395 whenever external host address equals
1396 local address of internal host
1397 :param out2in_only: if 1 rule is matching only out2in direction
1398 :param tag: Opaque string tag
1399 :param is_add: 1 if add, 0 if delete (Default value = 1)
1402 self.papi.nat44_add_del_static_mapping,
1404 'addr_only': addr_only,
1405 'local_ip_address': local_ip,
1406 'external_ip_address': external_ip,
1407 'local_port': local_port,
1408 'external_port': external_port,
1409 'external_sw_if_index': external_sw_if_index,
1411 'protocol': protocol,
1412 'twice_nat': twice_nat,
1413 'self_twice_nat': self_twice_nat,
1414 'out2in_only': out2in_only,
1417 def nat44_add_del_identity_mapping(
1420 sw_if_index=0xFFFFFFFF,
1427 """Add/delete NAT44 identity mapping
1429 :param ip: IP address (Default value = 0)
1430 :param sw_if_index: Interface instead of IP address
1431 :param port: Port number (Default value = 0)
1432 :param addr_only: 1 if address only mapping, 0 if address and port
1433 :param vrf_id: VRF ID
1434 :param protocol: IP protocol (Default value = 0)
1435 :param tag: Opaque string tag
1436 :param is_add: 1 if add, 0 if delete (Default value = 1)
1439 self.papi.nat44_add_del_identity_mapping,
1441 'addr_only': addr_only,
1444 'sw_if_index': sw_if_index,
1447 'protocol': protocol})
1449 def nat44_add_del_address_range(
1456 """Add/del NAT44 address range
1458 :param first_ip_address: First IP address
1459 :param last_ip_address: Last IP address
1460 :param vrf_id: VRF id for the address range
1461 :param twice_nat: twice NAT address for extenal hosts
1462 :param is_add: 1 if add, 0 if delete (Default value = 1)
1465 self.papi.nat44_add_del_address_range,
1466 {'first_ip_address': first_ip_address,
1467 'last_ip_address': last_ip_address,
1469 'twice_nat': twice_nat,
1472 def nat44_address_dump(self):
1473 """Dump NAT44 addresses
1474 :return: Dictionary of NAT44 addresses
1476 return self.api(self.papi.nat44_address_dump, {})
1478 def nat44_interface_dump(self):
1479 """Dump interfaces with NAT44 feature
1480 :return: Dictionary of interfaces with NAT44 feature
1482 return self.api(self.papi.nat44_interface_dump, {})
1484 def nat44_interface_output_feature_dump(self):
1485 """Dump interfaces with NAT44 output feature
1486 :return: Dictionary of interfaces with NAT44 output feature
1488 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1490 def nat44_static_mapping_dump(self):
1491 """Dump NAT44 static mappings
1492 :return: Dictionary of NAT44 static mappings
1494 return self.api(self.papi.nat44_static_mapping_dump, {})
1496 def nat44_identity_mapping_dump(self):
1497 """Dump NAT44 identity mappings
1498 :return: Dictionary of NAT44 identity mappings
1500 return self.api(self.papi.nat44_identity_mapping_dump, {})
1502 def nat_show_config(self):
1503 """Show NAT plugin config
1504 :return: NAT plugin config parameters
1506 return self.api(self.papi.nat_show_config, {})
1508 def nat44_add_interface_addr(
1513 """Add/del NAT44 address from interface
1515 :param sw_if_index: Software index of the interface
1516 :param twice_nat: twice NAT address for extenal hosts
1517 :param is_add: 1 if add, 0 if delete (Default value = 1)
1520 self.papi.nat44_add_del_interface_addr,
1522 'sw_if_index': sw_if_index,
1523 'twice_nat': twice_nat})
1525 def nat44_interface_addr_dump(self):
1526 """Dump NAT44 addresses interfaces
1527 :return: Dictionary of NAT44 addresses interfaces
1529 return self.api(self.papi.nat44_interface_addr_dump, {})
1536 """Enable/disable NAT IPFIX logging
1538 :param domain_id: Observation domain ID (Default value = 1)
1539 :param src_port: Source port number (Default value = 4739)
1540 :param enable: 1 if enable, 0 if disable (Default value = 1)
1543 self.papi.nat_ipfix_enable_disable,
1544 {'domain_id': domain_id,
1545 'src_port': src_port,
1548 def nat44_user_session_dump(
1552 """Dump NAT44 user's sessions
1554 :param ip_address: ip adress of the user to be dumped
1555 :param cpu_index: cpu_index on which the user is
1556 :param vrf_id: VRF ID
1557 :return: Dictionary of S-NAT sessions
1560 self.papi.nat44_user_session_dump,
1561 {'ip_address': ip_address,
1564 def nat44_user_dump(self):
1567 :return: Dictionary of NAT44 users
1569 return self.api(self.papi.nat44_user_dump, {})
1571 def nat44_add_del_lb_static_mapping(
1584 """Add/delete NAT44 load balancing static mapping
1586 :param twice_nat: 1 if translate external host address and port
1587 :param tag: Opaque string tag
1588 :param is_add - 1 if add, 0 if delete
1591 self.papi.nat44_add_del_lb_static_mapping,
1593 'external_addr': external_addr,
1594 'external_port': external_port,
1595 'protocol': protocol,
1597 'twice_nat': twice_nat,
1598 'self_twice_nat': self_twice_nat,
1599 'out2in_only': out2in_only,
1601 'local_num': local_num,
1604 def nat44_lb_static_mapping_dump(self):
1605 """Dump NAT44 load balancing static mappings
1607 :return: Dictionary of NAT44 load balancing static mapping
1609 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1611 def nat44_del_session(
1618 ext_host_address=None,
1620 """Delete NAT44 session
1622 :param addr: IPv4 address
1623 :param por: port number
1624 :param protocol: IP protocol number
1625 :param vrf_id: VRF ID
1626 :param is_in: 1 if inside network addres and port pari, 0 if outside
1627 :param ext_host_address: external host IPv4 address
1628 :param ext_host_port: external host port
1630 if ext_host_address is None:
1632 self.papi.nat44_del_session,
1635 'protocol': protocol,
1640 self.papi.nat44_del_session,
1643 'protocol': protocol,
1646 'ext_host_valid': 1,
1647 'ext_host_address': ext_host_address,
1648 'ext_host_port': ext_host_port})
1650 def nat44_forwarding_enable_disable(
1653 """Enable/disable forwarding for NAT44
1655 :param enable: 1 for enable, 0 for disable
1658 self.papi.nat44_forwarding_enable_disable,
1668 """Set NAT virtual fragmentation reassembly
1670 :param timeout: reassembly timeout (Default 2sec)
1671 :param max_reass: maximum concurrent reassemblies (Default 1024)
1672 :param max_frag: maximum fragmets per reassembly (Default 5)
1673 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1674 :param is_ip6: 1 if IPv6, 0 if IPv4
1677 self.papi.nat_set_reass,
1678 {'timeout': timeout,
1679 'max_reass': max_reass,
1680 'max_frag': max_frag,
1681 'drop_frag': drop_frag,
1684 def nat_get_reass(self):
1685 """Get NAT virtual fragmentation reassembly configuration
1687 :return: NAT virtual fragmentation reassembly configuration
1689 return self.api(self.papi.nat_get_reass, {})
1691 def nat_reass_dump(self):
1692 """Dump NAT virtual fragmentation reassemblies
1694 :return: Dictionary of NAT virtual fragmentation reassemblies
1696 return self.api(self.papi.nat_reass_dump, {})
1698 def nat_det_add_del_map(
1705 """Add/delete deterministic NAT mapping
1707 :param is_add - 1 if add, 0 if delete
1708 :param in_addr - inside IP address
1709 :param in_plen - inside IP address prefix length
1710 :param out_addr - outside IP address
1711 :param out_plen - outside IP address prefix length
1714 self.papi.nat_det_add_del_map,
1719 'out_addr': out_addr,
1720 'out_plen': out_plen})
1722 def nat_det_forward(
1725 """Get outside address and port range from inside address
1727 :param in_addr - inside IP address
1730 self.papi.nat_det_forward,
1731 {'in_addr': in_addr,
1734 def nat_det_reverse(
1738 """Get inside address from outside address and port
1740 :param out_addr - outside IP address
1741 :param out_port - outside port
1744 self.papi.nat_det_reverse,
1745 {'out_addr': out_addr,
1746 'out_port': out_port})
1748 def nat_det_map_dump(self):
1749 """Dump deterministic NAT mappings
1751 :return: Dictionary of deterministic NAT mappings
1753 return self.api(self.papi.nat_det_map_dump, {})
1755 def nat_det_set_timeouts(
1758 tcp_established=7440,
1761 """Set values of timeouts for deterministic NAT (in seconds)
1763 :param udp - UDP timeout (Default value = 300)
1764 :param tcp_established - TCP established timeout (Default value = 7440)
1765 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1766 :param icmp - ICMP timeout (Default value = 60)
1769 self.papi.nat_det_set_timeouts,
1771 'tcp_established': tcp_established,
1772 'tcp_transitory': tcp_transitory,
1775 def nat_det_get_timeouts(self):
1776 """Get values of timeouts for deterministic NAT
1778 :return: Timeouts for deterministic NAT (in seconds)
1780 return self.api(self.papi.nat_det_get_timeouts, {})
1782 def nat_det_close_session_out(
1788 """Close deterministic NAT session using outside address and port
1790 :param out_addr - outside IP address
1791 :param out_port - outside port
1792 :param ext_addr - external host IP address
1793 :param ext_port - external host port
1796 self.papi.nat_det_close_session_out,
1797 {'out_addr': out_addr,
1798 'out_port': out_port,
1799 'ext_addr': ext_addr,
1800 'ext_port': ext_port})
1802 def nat_det_close_session_in(
1808 """Close deterministic NAT session using inside address and port
1810 :param in_addr - inside IP address
1811 :param in_port - inside port
1812 :param ext_addr - external host IP address
1813 :param ext_port - external host port
1816 self.papi.nat_det_close_session_in,
1817 {'in_addr': in_addr,
1819 'ext_addr': ext_addr,
1820 'ext_port': ext_port,
1823 def nat_det_session_dump(
1826 """Dump deterministic NAT sessions belonging to a user
1828 :param user_addr - inside IP address of the user
1829 :return: Dictionary of deterministic NAT sessions
1832 self.papi.nat_det_session_dump,
1834 'user_addr': user_addr})
1836 def nat64_add_del_pool_addr_range(
1842 """Add/del address range to NAT64 pool
1844 :param start_addr: First IP address
1845 :param end_addr: Last IP address
1846 :param vrf_id: VRF id for the address range
1847 :param is_add: 1 if add, 0 if delete (Default value = 1)
1850 self.papi.nat64_add_del_pool_addr_range,
1851 {'start_addr': start_addr,
1852 'end_addr': end_addr,
1856 def nat64_pool_addr_dump(self):
1857 """Dump NAT64 pool addresses
1858 :return: Dictionary of NAT64 pool addresses
1860 return self.api(self.papi.nat64_pool_addr_dump, {})
1862 def nat64_add_del_interface(
1867 """Enable/disable NAT64 feature on the interface
1868 :param sw_if_index: Index of the interface
1869 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1870 :param is_add: 1 if add, 0 if delete (Default value = 1)
1873 self.papi.nat64_add_del_interface,
1874 {'sw_if_index': sw_if_index,
1875 'is_inside': is_inside,
1878 def nat64_interface_dump(self):
1879 """Dump interfaces with NAT64 feature
1880 :return: Dictionary of interfaces with NAT64 feature
1882 return self.api(self.papi.nat64_interface_dump, {})
1884 def nat64_add_del_static_bib(
1893 """Add/delete S-NAT static BIB entry
1895 :param in_ip: Inside IPv6 address
1896 :param out_ip: Outside IPv4 address
1897 :param in_port: Inside port number
1898 :param out_port: Outside port number
1899 :param protocol: IP protocol
1900 :param vrf_id: VRF ID (Default value = 0)
1901 :param is_add: 1 if add, 0 if delete (Default value = 1)
1904 self.papi.nat64_add_del_static_bib,
1913 def nat64_bib_dump(self, protocol=255):
1916 :param protocol: IP protocol (Default value = 255, all BIBs)
1917 :returns: Dictionary of NAT64 BIB entries
1919 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1921 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1922 tcp_incoming_syn=6):
1923 """Set values of timeouts for NAT64 (in seconds)
1925 :param udpi: UDP timeout (Default value = 300)
1926 :param icmp: ICMP timeout (Default value = 60)
1927 :param tcp_trans: TCP transitory timeout (Default value = 240)
1928 :param tcp_est: TCP established timeout (Default value = 7440)
1929 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1932 self.papi.nat64_set_timeouts,
1935 'tcp_trans': tcp_trans,
1937 'tcp_incoming_syn': tcp_incoming_syn})
1939 def nat64_get_timeouts(self):
1940 """Get values of timeouts for NAT64
1942 :return: Timeouts for NAT64 (in seconds)
1944 return self.api(self.papi.nat64_get_timeouts, {})
1946 def nat64_st_dump(self, protocol=255):
1947 """Dump NAT64 session table
1949 :param protocol: IP protocol (Default value = 255, all STs)
1950 :returns: Dictionary of NAT64 sesstion table entries
1952 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1954 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1955 """Add/del NAT64 prefix
1957 :param prefix: NAT64 prefix
1958 :param plen: NAT64 prefix length
1959 :param vrf_id: VRF id of tenant (Default 0)
1960 :param is_add: 1 if add, 0 if delete (Default value = 1)
1963 self.papi.nat64_add_del_prefix,
1969 def nat64_prefix_dump(self):
1970 """Dump NAT64 prefix
1972 :returns: Dictionary of NAT64 prefixes
1974 return self.api(self.papi.nat64_prefix_dump, {})
1976 def nat64_add_interface_addr(
1980 """Add/del NAT64 address from interface
1982 :param sw_if_index: Software index of the interface
1983 :param is_add: 1 if add, 0 if delete (Default value = 1)
1985 return self.api(self.papi.nat64_add_del_interface_addr,
1986 {'is_add': is_add, 'sw_if_index': sw_if_index})
1988 def dslite_set_aftr_addr(self, ip6, ip4):
1989 """Set DS-Lite AFTR addresses
1991 :param ip4: IPv4 address
1992 :param ip6: IPv6 address
1995 self.papi.dslite_set_aftr_addr,
1999 def dslite_set_b4_addr(self, ip6, ip4):
2000 """Set DS-Lite B4 IPv6 address
2002 :param ip4: IPv4 address
2003 :param ip6: IPv6 address
2006 self.papi.dslite_set_b4_addr,
2010 def dslite_add_del_pool_addr_range(
2015 """Add/del address range to DS-Lite pool
2017 :param start_addr: First IP address
2018 :param end_addr: Last IP address
2019 :param is_add: 1 if add, 0 if delete (Default value = 1)
2022 self.papi.dslite_add_del_pool_addr_range,
2023 {'start_addr': start_addr,
2024 'end_addr': end_addr,
2027 def nat66_add_del_interface(
2032 """Enable/disable NAT66 feature on the interface
2033 :param sw_if_index: Index of the interface
2034 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2035 :param is_add: 1 if add, 0 if delete (Default value = 1)
2038 self.papi.nat66_add_del_interface,
2039 {'sw_if_index': sw_if_index,
2040 'is_inside': is_inside,
2043 def nat66_add_del_static_mapping(
2049 """Add/delete NAT66 static mapping
2051 :param in_ip: Inside IPv6 address
2052 :param out_ip: Outside IPv6 address
2053 :param vrf_id: VRF ID (Default value = 0)
2054 :param is_add: 1 if add, 0 if delete (Default value = 1)
2057 self.papi.nat66_add_del_static_mapping,
2058 {'local_ip_address': in_ip,
2059 'external_ip_address': out_ip,
2063 def nat66_interface_dump(self):
2064 """Dump interfaces with NAT66 feature
2065 :return: Dictionary of interfaces with NAT66 feature
2067 return self.api(self.papi.nat66_interface_dump, {})
2069 def nat66_static_mapping_dump(self):
2070 """Dump NAT66 static mappings
2071 :return: Dictionary of NAT66 static mappings
2073 return self.api(self.papi.nat66_static_mapping_dump, {})
2075 def control_ping(self):
2076 self.api(self.papi.control_ping)
2078 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2079 detect_mult, local_addr, peer_addr, is_ipv6=0,
2080 bfd_key_id=None, conf_key_id=None):
2081 if bfd_key_id is None:
2082 return self.api(self.papi.bfd_udp_add,
2084 'sw_if_index': sw_if_index,
2085 'desired_min_tx': desired_min_tx,
2086 'required_min_rx': required_min_rx,
2087 'local_addr': local_addr,
2088 'peer_addr': peer_addr,
2090 'detect_mult': detect_mult,
2093 return self.api(self.papi.bfd_udp_add,
2095 'sw_if_index': sw_if_index,
2096 'desired_min_tx': desired_min_tx,
2097 'required_min_rx': required_min_rx,
2098 'local_addr': local_addr,
2099 'peer_addr': peer_addr,
2101 'detect_mult': detect_mult,
2102 'is_authenticated': 1,
2103 'bfd_key_id': bfd_key_id,
2104 'conf_key_id': conf_key_id,
2107 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2108 detect_mult, local_addr, peer_addr, is_ipv6=0):
2109 return self.api(self.papi.bfd_udp_mod,
2111 'sw_if_index': sw_if_index,
2112 'desired_min_tx': desired_min_tx,
2113 'required_min_rx': required_min_rx,
2114 'local_addr': local_addr,
2115 'peer_addr': peer_addr,
2117 'detect_mult': detect_mult,
2120 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2121 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2123 return self.api(self.papi.bfd_udp_auth_activate,
2125 'sw_if_index': sw_if_index,
2126 'local_addr': local_addr,
2127 'peer_addr': peer_addr,
2129 'is_delayed': 1 if is_delayed else 0,
2130 'bfd_key_id': bfd_key_id,
2131 'conf_key_id': conf_key_id,
2134 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2135 is_ipv6=0, is_delayed=False):
2136 return self.api(self.papi.bfd_udp_auth_deactivate,
2138 'sw_if_index': sw_if_index,
2139 'local_addr': local_addr,
2140 'peer_addr': peer_addr,
2142 'is_delayed': 1 if is_delayed else 0,
2145 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2146 return self.api(self.papi.bfd_udp_del,
2148 'sw_if_index': sw_if_index,
2149 'local_addr': local_addr,
2150 'peer_addr': peer_addr,
2154 def bfd_udp_session_dump(self):
2155 return self.api(self.papi.bfd_udp_session_dump, {})
2157 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2158 peer_addr, is_ipv6=0):
2159 return self.api(self.papi.bfd_udp_session_set_flags, {
2160 'admin_up_down': admin_up_down,
2161 'sw_if_index': sw_if_index,
2162 'local_addr': local_addr,
2163 'peer_addr': peer_addr,
2167 def want_bfd_events(self, enable_disable=1):
2168 return self.api(self.papi.want_bfd_events, {
2169 'enable_disable': enable_disable,
2173 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2174 return self.api(self.papi.bfd_auth_set_key, {
2175 'conf_key_id': conf_key_id,
2176 'auth_type': auth_type,
2178 'key_len': len(key),
2181 def bfd_auth_del_key(self, conf_key_id):
2182 return self.api(self.papi.bfd_auth_del_key, {
2183 'conf_key_id': conf_key_id,
2186 def bfd_auth_keys_dump(self):
2187 return self.api(self.papi.bfd_auth_keys_dump, {})
2189 def bfd_udp_set_echo_source(self, sw_if_index):
2190 return self.api(self.papi.bfd_udp_set_echo_source,
2191 {'sw_if_index': sw_if_index})
2193 def bfd_udp_del_echo_source(self):
2194 return self.api(self.papi.bfd_udp_del_echo_source, {})
2196 def classify_add_del_table(
2201 table_index=0xFFFFFFFF,
2203 memory_size=2097152,
2205 next_table_index=0xFFFFFFFF,
2206 miss_next_index=0xFFFFFFFF,
2207 current_data_flag=0,
2208 current_data_offset=0):
2212 :param match_n_vectors: (Default value = 1)
2213 :param table_index: (Default value = 0xFFFFFFFF)
2214 :param nbuckets: (Default value = 2)
2215 :param memory_size: (Default value = 2097152)
2216 :param skip_n_vectors: (Default value = 0)
2217 :param next_table_index: (Default value = 0xFFFFFFFF)
2218 :param miss_next_index: (Default value = 0xFFFFFFFF)
2219 :param current_data_flag: (Default value = 0)
2220 :param current_data_offset: (Default value = 0)
2224 self.papi.classify_add_del_table,
2226 'table_index': table_index,
2227 'nbuckets': nbuckets,
2228 'memory_size': memory_size,
2229 'skip_n_vectors': skip_n_vectors,
2230 'match_n_vectors': match_n_vectors,
2231 'next_table_index': next_table_index,
2232 'miss_next_index': miss_next_index,
2233 'current_data_flag': current_data_flag,
2234 'current_data_offset': current_data_offset,
2237 def classify_add_del_session(
2242 opaque_index=0xFFFFFFFF,
2243 hit_next_index=0xFFFFFFFF,
2251 :param opaque_index: (Default value = 0xFFFFFFFF)
2252 :param hit_next_index: (Default value = 0xFFFFFFFF)
2253 :param advance: (Default value = 0)
2254 :param action: (Default value = 0)
2255 :param metadata: (Default value = 0)
2259 self.papi.classify_add_del_session,
2261 'table_index': table_index,
2262 'hit_next_index': hit_next_index,
2263 'opaque_index': opaque_index,
2266 'metadata': metadata,
2269 def input_acl_set_interface(
2273 ip4_table_index=0xFFFFFFFF,
2274 ip6_table_index=0xFFFFFFFF,
2275 l2_table_index=0xFFFFFFFF):
2279 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2280 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2281 :param l2_table_index: (Default value = 0xFFFFFFFF)
2285 self.papi.input_acl_set_interface,
2286 {'sw_if_index': sw_if_index,
2287 'ip4_table_index': ip4_table_index,
2288 'ip6_table_index': ip6_table_index,
2289 'l2_table_index': l2_table_index,
2292 def output_acl_set_interface(
2296 ip4_table_index=0xFFFFFFFF,
2297 ip6_table_index=0xFFFFFFFF,
2298 l2_table_index=0xFFFFFFFF):
2302 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2303 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2304 :param l2_table_index: (Default value = 0xFFFFFFFF)
2308 self.papi.output_acl_set_interface,
2309 {'sw_if_index': sw_if_index,
2310 'ip4_table_index': ip4_table_index,
2311 'ip6_table_index': ip6_table_index,
2312 'l2_table_index': l2_table_index,
2315 def set_ipfix_exporter(
2322 collector_port=4739,
2325 self.papi.set_ipfix_exporter,
2327 'collector_address': collector_address,
2328 'collector_port': collector_port,
2329 'src_address': src_address,
2331 'path_mtu': path_mtu,
2332 'template_interval': template_interval,
2333 'udp_checksum': udp_checksum,
2336 def dhcp_proxy_config(self,
2344 self.papi.dhcp_proxy_config,
2346 'rx_vrf_id': rx_table_id,
2347 'server_vrf_id': server_table_id,
2350 'dhcp_server': dhcp_server,
2351 'dhcp_src_address': dhcp_src_address,
2354 def dhcp_proxy_set_vss(self,
2363 self.papi.dhcp_proxy_set_vss,
2366 'vss_type': vss_type,
2367 'vpn_ascii_id': vpn_ascii_id,
2369 'vpn_index': vpn_index,
2374 def dhcp_client_dump(self):
2375 return self.api(self.papi.dhcp_client_dump, {})
2377 def dhcp_client(self,
2382 set_broadcast_flag=1,
2383 want_dhcp_events=0):
2385 self.papi.dhcp_client_config,
2389 'sw_if_index': sw_if_index,
2390 'hostname': hostname,
2392 'want_dhcp_event': want_dhcp_events,
2393 'set_broadcast_flag': set_broadcast_flag,
2397 def ip_mroute_add_del(self,
2403 next_hop_sw_if_index,
2413 IP Multicast Route add/del
2416 self.papi.ip_mroute_add_del,
2417 {'next_hop_sw_if_index': next_hop_sw_if_index,
2418 'entry_flags': e_flags,
2419 'itf_flags': i_flags,
2420 'table_id': table_id,
2424 'is_local': is_local,
2425 'bier_imp': bier_imp,
2426 'next_hop_afi': next_hop_afi,
2427 'grp_address_length': grp_address_length,
2428 'grp_address': grp_address,
2429 'src_address': src_address,
2430 'nh_address': next_hop_address})
2432 def mfib_signal_dump(self):
2433 return self.api(self.papi.mfib_signal_dump, {})
2435 def ip_mfib_dump(self):
2436 return self.api(self.papi.ip_mfib_dump, {})
2438 def ip6_mfib_dump(self):
2439 return self.api(self.papi.ip6_mfib_dump, {})
2441 def lisp_enable_disable(self, is_enabled):
2443 self.papi.lisp_enable_disable,
2445 'is_en': is_enabled,
2448 def lisp_locator_set(self,
2452 self.papi.lisp_add_del_locator_set,
2455 'locator_set_name': ls_name
2458 def lisp_locator_set_dump(self):
2459 return self.api(self.papi.lisp_locator_set_dump, {})
2461 def lisp_locator(self,
2468 self.papi.lisp_add_del_locator,
2471 'locator_set_name': ls_name,
2472 'sw_if_index': sw_if_index,
2473 'priority': priority,
2477 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2479 self.papi.lisp_locator_dump,
2481 'is_index_set': is_index_set,
2483 'ls_index': ls_index,
2486 def lisp_local_mapping(self,
2496 self.papi.lisp_add_del_local_eid,
2498 'locator_set_name': ls_name,
2500 'eid_type': eid_type,
2502 'prefix_len': prefix_len,
2508 def lisp_eid_table_dump(self,
2516 self.papi.lisp_eid_table_dump,
2519 'prefix_length': prefix_length,
2521 'eid_type': eid_type,
2523 'filter': filter_opt,
2526 def lisp_remote_mapping(self,
2536 self.papi.lisp_add_del_remote_mapping,
2539 'eid_type': eid_type,
2541 'eid_len': eid_prefix_len,
2542 'rloc_num': rlocs_num,
2545 'is_src_dst': is_src_dst,
2548 def lisp_adjacency(self,
2557 self.papi.lisp_add_del_adjacency,
2561 'eid_type': eid_type,
2564 'leid_len': leid_len,
2565 'reid_len': reid_len,
2568 def lisp_adjacencies_get(self, vni=0):
2570 self.papi.lisp_adjacencies_get,
2575 def map_add_domain(self,
2589 self.papi.map_add_domain,
2591 'ip6_prefix': ip6_prefix,
2592 'ip6_prefix_len': ip6_prefix_len,
2593 'ip4_prefix': ip4_prefix,
2594 'ip4_prefix_len': ip4_prefix_len,
2596 'ip6_src_prefix_len': ip6_src_prefix_len,
2597 'ea_bits_len': ea_bits_len,
2598 'psid_offset': psid_offset,
2599 'psid_length': psid_length,
2600 'is_translation': is_translation,
2601 'is_rfc6052': is_rfc6052,
2605 def gtpu_add_del_tunnel(
2611 mcast_sw_if_index=0xFFFFFFFF,
2613 decap_next_index=0xFFFFFFFF,
2617 :param is_add: (Default value = 1)
2618 :param is_ipv6: (Default value = 0)
2621 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2622 :param encap_vrf_id: (Default value = 0)
2623 :param decap_next_index: (Default value = 0xFFFFFFFF)
2624 :param teid: (Default value = 0)
2627 return self.api(self.papi.gtpu_add_del_tunnel,
2630 'src_address': src_addr,
2631 'dst_address': dst_addr,
2632 'mcast_sw_if_index': mcast_sw_if_index,
2633 'encap_vrf_id': encap_vrf_id,
2634 'decap_next_index': decap_next_index,
2637 def vxlan_gpe_add_del_tunnel(
2641 mcast_sw_if_index=0xFFFFFFFF,
2652 :param is_add: (Default value = 1)
2653 :param is_ipv6: (Default value = 0)
2654 :param encap_vrf_id: (Default value = 0)
2655 :param decap_vrf_id: (Default value = 0)
2656 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2657 :param protocol: (Default value = 3)
2658 :param vni: (Default value = 0)
2661 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2666 'mcast_sw_if_index': mcast_sw_if_index,
2667 'encap_vrf_id': encap_vrf_id,
2668 'decap_vrf_id': decap_vrf_id,
2669 'protocol': protocol,
2672 def pppoe_add_del_session(
2682 :param is_add: (Default value = 1)
2683 :param is_ipv6: (Default value = 0)
2685 :param session_id: (Default value = 0)
2687 :param decap_vrf_id: (Default value = 0)
2690 return self.api(self.papi.pppoe_add_del_session,
2693 'session_id': session_id,
2694 'client_ip': client_ip,
2695 'decap_vrf_id': decap_vrf_id,
2696 'client_mac': client_mac})
2698 def sr_localsid_add_del(self,
2705 sw_if_index=0xFFFFFFFF,
2709 """ Add/del IPv6 SR local-SID.
2712 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2713 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2716 :param is_del: (Default value = 0)
2717 :param end_psp: (Default value = 0)
2718 :param sw_if_index: (Default value = 0xFFFFFFFF)
2719 :param vlan_index: (Default value = 0)
2720 :param fib_table: (Default value = 0)
2723 self.papi.sr_localsid_add_del,
2725 'localsid': localsid,
2727 'behavior': behavior,
2728 'sw_if_index': sw_if_index,
2729 'vlan_index': vlan_index,
2730 'fib_table': fib_table,
2731 'nh_addr4': nh_addr4,
2732 'nh_addr6': nh_addr6
2746 :param bsid_addr: bindingSID of the SR Policy
2747 :param weight: weight of the sid list. optional. (default: 1)
2748 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2750 :param type: type/behavior of the SR policy. (default or spray) \
2752 :param fib_table: VRF where to install the FIB entry for the BSID \
2754 :param n_segments: number of segments \
2756 :param segments: a vector of IPv6 address composing the segment list \
2760 self.papi.sr_policy_add,
2761 {'bsid_addr': bsid_addr,
2763 'is_encap': is_encap,
2765 'fib_table': fib_table,
2766 'n_segments': n_segments,
2767 'segments': segments
2776 :param bsid: bindingSID of the SR Policy
2777 :param sr_policy_index: index of the sr policy (default: 0)
2780 self.papi.sr_policy_del,
2781 {'bsid_addr': bsid_addr,
2782 'sr_policy_index': sr_policy_index
2785 def sr_steering_add_del(
2796 Steer traffic L2 and L3 traffic through a given SR policy
2798 :param is_del: delete or add
2799 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2800 :param sr_policy: is the index of the SR Policy (alt to bsid)
2801 :param table_id: is the VRF where to install the FIB entry for the BSID
2802 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2803 :param mask_width: is the mask for L3 traffic type
2804 :param sw_if_index: is the incoming interface for L2 traffic
2805 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2808 self.papi.sr_steering_add_del,
2810 'bsid_addr': bsid_addr,
2811 'sr_policy_index': sr_policy_index,
2812 'table_id': table_id,
2813 'prefix_addr': prefix_addr,
2814 'mask_width': mask_width,
2815 'sw_if_index': sw_if_index,
2816 'traffic_type': traffic_type
2819 def acl_add_replace(self, acl_index, r, tag='',
2821 """Add/replace an ACL
2822 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2823 :param acl_rule r: ACL rules array.
2824 :param str tag: symbolic tag (description) for this ACL.
2825 :param int count: number of rules.
2827 return self.api(self.papi.acl_add_replace,
2828 {'acl_index': acl_index,
2832 expected_retval=expected_retval)
2834 def acl_del(self, acl_index, expected_retval=0):
2840 return self.api(self.papi.acl_del,
2841 {'acl_index': acl_index},
2842 expected_retval=expected_retval)
2844 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2846 return self.api(self.papi.acl_interface_set_acl_list,
2847 {'sw_if_index': sw_if_index,
2851 expected_retval=expected_retval)
2853 def acl_interface_set_etype_whitelist(self, sw_if_index,
2856 return self.api(self.papi.acl_interface_set_etype_whitelist,
2857 {'sw_if_index': sw_if_index,
2858 'count': len(whitelist),
2860 'whitelist': whitelist},
2861 expected_retval=expected_retval)
2863 def acl_interface_add_del(self,
2867 """ Add/Delete ACL to/from interface
2871 :param is_add: (Default value = 1)
2874 return self.api(self.papi.acl_interface_add_del,
2877 'sw_if_index': sw_if_index,
2878 'acl_index': acl_index})
2880 def acl_dump(self, acl_index, expected_retval=0):
2881 return self.api(self.papi.acl_dump,
2882 {'acl_index': acl_index},
2883 expected_retval=expected_retval)
2885 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2887 return self.api(self.papi.acl_interface_list_dump,
2888 {'sw_if_index': sw_if_index},
2889 expected_retval=expected_retval)
2891 def macip_acl_add(self, rules, tag=""):
2894 :param rules: list of rules for given acl
2898 return self.api(self.papi.macip_acl_add,
2900 'count': len(rules),
2903 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2906 :param rules: list of rules for given acl
2910 return self.api(self.papi.macip_acl_add_replace,
2911 {'acl_index': acl_index,
2913 'count': len(rules),
2916 def macip_acl_del(self, acl_index):
2922 return self.api(self.papi.macip_acl_del,
2923 {'acl_index': acl_index})
2925 def macip_acl_interface_add_del(self,
2929 """ Add MACIP acl to interface
2933 :param is_add: (Default value = 1)
2936 return self.api(self.papi.macip_acl_interface_add_del,
2938 'sw_if_index': sw_if_index,
2939 'acl_index': acl_index})
2941 def macip_acl_interface_get(self):
2942 """ Return interface acls dump
2945 self.papi.macip_acl_interface_get, {})
2947 def macip_acl_dump(self, acl_index=4294967295):
2948 """ Return MACIP acl dump
2952 self.papi.macip_acl_dump, {'acl_index': acl_index})
2954 def policer_add_del(self,
2965 conform_action_type=1,
2967 exceed_action_type=0,
2969 violate_action_type=0,
2971 return self.api(self.papi.policer_add_del,
2978 'rate_type': rate_type,
2979 'round_type': round_type,
2981 'color_aware': color_aware,
2982 'conform_action_type': conform_action_type,
2983 'conform_dscp': conform_dscp,
2984 'exceed_action_type': exceed_action_type,
2985 'exceed_dscp': exceed_dscp,
2986 'violate_action_type': violate_action_type,
2987 'violate_dscp': violate_dscp})
2989 def ip_punt_police(self,
2993 return self.api(self.papi.ip_punt_police,
2994 {'policer_index': policer_index,
2998 def ip_punt_redirect(self,
3004 return self.api(self.papi.ip_punt_redirect,
3005 {'rx_sw_if_index': rx_sw_if_index,
3006 'tx_sw_if_index': tx_sw_if_index,
3011 def bier_table_add_del(self,
3015 """ BIER Table add/del """
3017 self.papi.bier_table_add_del,
3018 {'bt_tbl_id': {"bt_set": bti.set_id,
3019 "bt_sub_domain": bti.sub_domain_id,
3020 "bt_hdr_len_id": bti.hdr_len_id},
3021 'bt_label': mpls_label,
3022 'bt_is_add': is_add})
3024 def bier_table_dump(self):
3025 return self.api(self.papi.bier_table_dump, {})
3027 def bier_route_add_del(self,
3032 """ BIER Route add/del """
3034 self.papi.bier_route_add_del,
3035 {'br_tbl_id': {"bt_set": bti.set_id,
3036 "bt_sub_domain": bti.sub_domain_id,
3037 "bt_hdr_len_id": bti.hdr_len_id},
3039 'br_n_paths': len(paths),
3041 'br_is_add': is_add})
3043 def bier_route_dump(self, bti):
3045 self.papi.bier_route_dump,
3046 {'br_tbl_id': {"bt_set": bti.set_id,
3047 "bt_sub_domain": bti.sub_domain_id,
3048 "bt_hdr_len_id": bti.hdr_len_id}})
3050 def bier_imp_add(self,
3055 """ BIER Imposition Add """
3057 self.papi.bier_imp_add,
3058 {'bi_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 'bi_n_bytes': len(ibytes),
3063 'bi_bytes': ibytes})
3065 def bier_imp_del(self, bi_index):
3066 """ BIER Imposition del """
3068 self.papi.bier_imp_del,
3069 {'bi_index': bi_index})
3071 def bier_imp_dump(self):
3072 return self.api(self.papi.bier_imp_dump, {})
3074 def bier_disp_table_add_del(self,
3077 """ BIER Disposition Table add/del """
3079 self.papi.bier_disp_table_add_del,
3080 {'bdt_tbl_id': bdti,
3081 'bdt_is_add': is_add})
3083 def bier_disp_table_dump(self):
3084 return self.api(self.papi.bier_disp_table_dump, {})
3086 def bier_disp_entry_add_del(self,
3096 """ BIER Route add/del """
3098 while (len(lstack) < 16):
3101 self.papi.bier_disp_entry_add_del,
3102 {'bde_tbl_id': bdti,
3104 'bde_payload_proto': payload_proto,
3106 'bde_paths': [{'next_hop': next_hop,
3107 'table_id': next_hop_tbl_id,
3108 'afi': next_hop_afi,
3109 'rpf_id': next_hop_rpf_id,
3111 'label_stack': lstack}],
3112 'bde_is_add': is_add})
3114 def bier_disp_entry_dump(self, bdti):
3116 self.papi.bier_disp_entry_dump,
3117 {'bde_tbl_id': bdti})
3119 def add_node_next(self, node_name, next_name):
3120 """ Set the next node for a given node request
3125 return self.api(self.papi.add_node_next,
3126 {'node_name': node_name,
3127 'next_name': next_name})
3129 def session_enable_disable(self, is_enabled):
3131 self.papi.session_enable_disable,
3132 {'is_enable': is_enabled})
3134 def ipsec_spd_add_del(self, spd_id, is_add=1):
3135 """ SPD add/del - Wrapper to add or del ipsec SPD
3136 Sample CLI : 'ipsec spd add 1'
3138 :param spd_id - SPD ID to be created in the vpp . mandatory
3139 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3141 :returns: reply from the API
3144 self.papi.ipsec_spd_add_del, {
3145 'spd_id': spd_id, 'is_add': is_add})
3147 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3148 """ IPSEC interface SPD add/del - \
3149 Wrapper to associate/disassociate SPD to interface in VPP
3150 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3152 :param spd_id - SPD ID to associate with the interface . mandatory
3153 :param sw_if_index - Interface Index which needs to ipsec \
3154 association mandatory
3155 :param is_add - add(1) or del(0) association with interface \
3156 (Default 1 - add) . optional
3157 :returns: reply from the API
3160 self.papi.ipsec_interface_add_del_spd,
3161 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3163 def ipsec_sad_add_del_entry(self,
3166 integrity_algorithm,
3171 tunnel_src_address='',
3172 tunnel_dst_address='',
3176 """ IPSEC SA add/del
3177 :param sad_id: security association ID
3178 :param spi: security param index of the SA in decimal
3179 :param integrity_algorithm:
3180 :param integrity_key:
3181 :param crypto_algorithm:
3183 :param protocol: AH(0) or ESP(1) protocol
3184 :param tunnel_src_address: tunnel mode outer src address
3185 :param tunnel_dst_address: tunnel mode outer dst address
3188 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3189 crypto and ipsec algorithms
3192 self.papi.ipsec_sad_add_del_entry,
3195 'tunnel_src_address': tunnel_src_address,
3196 'tunnel_dst_address': tunnel_dst_address,
3197 'protocol': protocol,
3198 'integrity_algorithm': integrity_algorithm,
3199 'integrity_key_length': len(integrity_key),
3200 'integrity_key': integrity_key,
3201 'crypto_algorithm': crypto_algorithm,
3202 'crypto_key_length': len(crypto_key) if crypto_key is not None
3204 'crypto_key': crypto_key,
3206 'is_tunnel': is_tunnel,
3207 'udp_encap': udp_encap})
3209 def ipsec_spd_add_del_entry(self,
3212 local_address_start,
3214 remote_address_start,
3215 remote_address_stop,
3217 local_port_stop=65535,
3218 remote_port_start=0,
3219 remote_port_stop=65535,
3226 """ IPSEC policy SPD add/del -
3227 Wrapper to configure ipsec SPD policy entries in VPP
3228 :param spd_id: SPD ID for the policy
3229 :param local_address_start: local-ip-range start address
3230 :param local_address_stop : local-ip-range stop address
3231 :param remote_address_start: remote-ip-range start address
3232 :param remote_address_stop : remote-ip-range stop address
3233 :param local_port_start: (Default value = 0)
3234 :param local_port_stop: (Default value = 65535)
3235 :param remote_port_start: (Default value = 0)
3236 :param remote_port_stop: (Default value = 65535)
3237 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3238 :param sa_id: Security Association ID for mapping it to SPD
3239 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3241 :param priority: value for the spd action (Default value = 100)
3242 :param is_outbound: flag for inbound(0) or outbound(1)
3244 :param is_add: (Default value = 1)
3247 self.papi.ipsec_spd_add_del_entry,
3250 'local_address_start': local_address_start,
3251 'local_address_stop': local_address_stop,
3252 'remote_address_start': remote_address_start,
3253 'remote_address_stop': remote_address_stop,
3254 'local_port_start': local_port_start,
3255 'local_port_stop': local_port_stop,
3256 'remote_port_start': remote_port_start,
3257 'remote_port_stop': remote_port_stop,
3259 'protocol': protocol,
3261 'priority': priority,
3262 'is_outbound': is_outbound,
3263 'is_ip_any': is_ip_any})
3265 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3266 remote_spi, crypto_alg, local_crypto_key,
3267 remote_crypto_key, integ_alg, local_integ_key,
3268 remote_integ_key, is_add=1, esn=0,
3269 anti_replay=1, renumber=0, show_instance=0):
3271 self.papi.ipsec_tunnel_if_add_del,
3272 {'local_ip': local_ip, 'remote_ip': remote_ip,
3273 'local_spi': local_spi, 'remote_spi': remote_spi,
3274 'crypto_alg': crypto_alg,
3275 'local_crypto_key_len': len(local_crypto_key),
3276 'local_crypto_key': local_crypto_key,
3277 'remote_crypto_key_len': len(remote_crypto_key),
3278 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3279 'local_integ_key_len': len(local_integ_key),
3280 'local_integ_key': local_integ_key,
3281 'remote_integ_key_len': len(remote_integ_key),
3282 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3283 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3284 'show_instance': show_instance
3287 def app_namespace_add(self,
3291 sw_if_index=0xFFFFFFFF,
3294 self.papi.app_namespace_add_del,
3296 'sw_if_index': sw_if_index,
3297 'ip4_fib_id': ip4_fib_id,
3298 'ip6_fib_id': ip6_fib_id,
3299 'namespace_id': namespace_id,
3300 'namespace_id_len': len(namespace_id)})
3302 def punt_socket_register(self, l4_port, pathname, header_version=1,
3303 is_ip4=1, l4_protocol=0x11):
3304 """ Punt to socket """
3305 return self.api(self.papi.punt_socket_register,
3307 'l4_protocol': l4_protocol,
3309 'pathname': pathname,
3310 'header_version': header_version})
3312 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3313 expire_walk_interval_ms, is_ip6=0):
3314 """ Set IP reassembly parameters """
3315 return self.api(self.papi.ip_reassembly_set,
3317 'timeout_ms': timeout_ms,
3318 'expire_walk_interval_ms': expire_walk_interval_ms,
3319 'max_reassemblies': max_reassemblies})
3321 def ip_reassembly_get(self, is_ip6=0):
3322 """ Get IP reassembly parameters """
3323 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3325 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3327 """ Enable/disable IP reassembly """
3328 return self.api(self.papi.ip_reassembly_enable_disable,
3329 {'sw_if_index': sw_if_index,
3330 'enable_ip4': 1 if enable_ip4 else 0,
3331 'enable_ip6': 1 if enable_ip6 else 0,
3334 def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
3335 """ GBP endpoint Add/Del """
3336 return self.api(self.papi.gbp_endpoint_add_del,
3340 'sw_if_index': sw_if_index,
3344 def gbp_endpoint_dump(self):
3345 """ GBP endpoint Dump """
3346 return self.api(self.papi.gbp_endpoint_dump, {})
3348 def gbp_endpoint_group_add_del(self, is_add, epg, bd,
3351 uplink_sw_if_index):
3352 """ GBP endpoint group Add/Del """
3353 return self.api(self.papi.gbp_endpoint_group_add_del,
3356 'uplink_sw_if_index': uplink_sw_if_index,
3358 'ip4_table_id': ip4_rd,
3359 'ip6_table_id': ip6_rd,
3362 def gbp_endpoint_group_dump(self):
3363 """ GBP endpoint group Dump """
3364 return self.api(self.papi.gbp_endpoint_group_dump, {})
3366 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3367 """ GBP recirc Add/Del """
3368 return self.api(self.papi.gbp_recirc_add_del,
3372 'sw_if_index': sw_if_index,
3375 def gbp_recirc_dump(self):
3376 """ GBP recirc Dump """
3377 return self.api(self.papi.gbp_recirc_dump, {})
3379 def gbp_subnet_add_del(self, is_add, table_id,
3382 sw_if_index=0xffffffff,
3385 """ GBP Subnet Add/Del """
3386 return self.api(self.papi.gbp_subnet_add_del,
3389 'is_internal': is_internal,
3391 'sw_if_index': sw_if_index,
3394 'address_length': addr_len,
3395 'table_id': table_id}})
3397 def gbp_subnet_dump(self):
3398 """ GBP Subnet Dump """
3399 return self.api(self.papi.gbp_subnet_dump, {})
3401 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3402 """ GBP contract Add/Del """
3403 return self.api(self.papi.gbp_contract_add_del,
3406 'acl_index': acl_index,
3408 'dst_epg': dst_epg}})
3410 def gbp_contract_dump(self):
3411 """ GBP contract Dump """
3412 return self.api(self.papi.gbp_contract_dump, {})
3414 def ipip_6rd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len,
3415 ip4_prefix, ip4_prefix_len, ip4_src,
3417 """ 6RD tunnel Add """
3418 return self.api(self.papi.ipip_6rd_add_tunnel,
3419 {'fib_index': fib_index,
3420 'ip6_prefix': ip6_prefix,
3421 'ip6_prefix_len': ip6_prefix_len,
3422 'ip4_prefix': ip4_prefix,
3423 'ip4_prefix_len': ip4_prefix_len,
3425 'security_check': security_check})
3427 def ipip_6rd_del_tunnel(self, sw_if_index):
3428 """ 6RD tunnel Delete """
3429 return self.api(self.papi.ipip_6rd_del_tunnel,
3430 {'sw_if_index': sw_if_index})
3432 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3433 instance=0xFFFFFFFF, fib_index=0, tc_tos=0):
3434 """ IPIP tunnel Add/Del """
3435 return self.api(self.papi.ipip_add_tunnel,
3436 {'is_ipv6': is_ipv6,
3437 'instance': instance,
3438 'src_address': src_address,
3439 'dst_address': dst_address,
3440 'fib_index': fib_index,
3443 def ipip_del_tunnel(self, sw_if_index):
3444 """ IPIP tunnel Delete """
3445 return self.api(self.papi.ipip_del_tunnel,
3446 {'sw_if_index': sw_if_index})
3448 def qos_egress_map_update(self, id, outputs):
3449 """ QOS egress map update """
3450 return self.api(self.papi.qos_egress_map_update,
3454 def qos_egress_map_delete(self, id):
3455 """ QOS egress map delete """
3456 return self.api(self.papi.qos_egress_map_delete,
3459 def qos_mark_enable_disable(self, sw_if_index,
3463 """ QOS Mark Enable/Disable """
3464 return self.api(self.papi.qos_mark_enable_disable,
3466 'sw_if_index': sw_if_index,
3467 'output_source': output_source,
3470 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3471 """ IP QoS recording Enble/Disable """
3472 return self.api(self.papi.qos_record_enable_disable,
3473 {'sw_if_index': sw_if_index,
3474 'input_source': input_source,
3477 def igmp_listen(self, enable, sw_if_index, saddr, gaddr):
3478 """ Listen for new (S,G) on specified interface
3480 :param enable: add/del
3481 :param sw_if_index: interface sw index
3482 :param saddr: source ip4 addr
3483 :param gaddr: group ip4 addr
3485 return self.api(self.papi.igmp_listen,
3487 'sw_if_index': sw_if_index,
3491 def igmp_dump(self, sw_if_index=None):
3492 """ Dump all (S,G) interface configurations """
3493 if sw_if_index is None:
3498 return self.api(self.papi.igmp_dump, {'sw_if_index': sw_if_index,
3499 'dump_all': dump_all})
3501 def igmp_clear_interface(self, sw_if_index):
3502 """ Remove all (S,G)s from specified interface
3503 doesn't send IGMP report!
3506 self.papi.igmp_clear_interface, {
3507 'sw_if_index': sw_if_index})
3509 def want_igmp_events(self, enable=1):
3510 return self.api(self.papi.want_igmp_events, {'enable': enable,
3511 'pid': os.getpid()})
3521 :param lb: load balance
3522 :param use_custom_mac: use custom mac
3523 :param mac_address: mac address
3526 self.papi.bond_create,
3529 'use_custom_mac': use_custom_mac,
3530 'mac_address': mac_address
3537 :param sw_if_index: interface the operation is applied to
3539 return self.api(self.papi.bond_delete,
3540 {'sw_if_index': sw_if_index})
3549 :param sw_if_index: slave sw_if_index
3550 :param bond_sw_if_index: bond sw_if_index
3551 :param is_passive: is passive lacp speaker
3552 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3555 self.papi.bond_enslave,
3556 {'sw_if_index': sw_if_index,
3557 'bond_sw_if_index': bond_sw_if_index,
3558 'is_passive': is_passive,
3559 'is_long_timeout': is_long_timeout
3562 def bond_detach_slave(
3566 :param sw_if_index: slave interface the operation is applied to
3568 return self.api(self.papi.bond_detach_slave,
3569 {'sw_if_index': sw_if_index})
3571 def sw_interface_slave_dump(
3575 :param sw_if_index: bond sw_if_index
3577 return self.api(self.papi.sw_interface_slave_dump,
3578 {'sw_if_index': sw_if_index})
3580 def sw_interface_bond_dump(
3585 return self.api(self.papi.sw_interface_bond_dump,
3588 def create_vhost_user_if(
3593 custom_dev_instance,
3598 :param is_server: is server
3599 :param sock_filename: socket name
3600 :param renumber: renumber
3601 :param custom_dev_instance: custom dev instance
3602 :param use_custom_mac: use custom mac
3603 :param mac_address: mac address
3604 :param tag: tag (default ''
3607 self.papi.create_vhost_user_if,
3608 {'is_server': is_server,
3609 'sock_filename': sock_filename,
3610 'renumber': renumber,
3611 'custom_dev_instance': custom_dev_instance,
3612 'use_custom_mac': use_custom_mac,
3613 'mac_address': mac_address,
3617 def delete_vhost_user_if(
3621 :param sw_if_index: interface the operation is applied to
3623 return self.api(self.papi.delete_vhost_user_if,
3624 {'sw_if_index': sw_if_index, })
3626 def sw_interface_vhost_user_dump(
3631 return self.api(self.papi.sw_interface_vhost_user_dump,
3634 def abf_policy_add_del(self, is_add, policy):
3636 self.papi.abf_policy_add_del,
3640 def abf_itf_attach_add_del(self, is_add, attach):
3642 self.papi.abf_itf_attach_add_del,
3646 def abf_policy_dump(self):
3648 self.papi.abf_policy_dump, {})
3650 def abf_itf_attach_dump(self):
3652 self.papi.abf_itf_attach_dump, {})