5 from collections import deque
7 # Sphinx creates auto-generated documentation by importing the python source
8 # files and collecting the docstrings from them. The NO_VPP_PAPI flag allows
9 # the vpp_papi_provider.py file to be importable without having to build
10 # the whole vpp api if the user only wishes to generate the test documentation.
13 no_vpp_papi = os.getenv("NO_VPP_PAPI")
14 if no_vpp_papi == "1":
20 from vpp_papi import VPP
22 # from vnet/vnet/mpls/mpls_types.h
23 MPLS_IETF_MAX_LABEL = 0xfffff
24 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
46 class UnexpectedApiReturnValueError(Exception):
47 """ exception raised when the API return value is unexpected """
51 class VppPapiProvider(object):
52 """VPP-api provider using vpp-papi
54 @property hook: hook object providing before and after api/cli hooks
57 _zero, _negative = range(2)
59 def __init__(self, name, shm_prefix, test_class):
60 self.hook = Hook("vpp-papi-provider")
62 self.shm_prefix = shm_prefix
63 self.test_class = test_class
64 self._expect_api_retval = self._zero
65 self._expect_stack = []
68 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
69 for root, dirnames, filenames in os.walk(install_dir):
70 for filename in fnmatch.filter(filenames, '*.api.json'):
71 jsonfiles.append(os.path.join(root, filename))
73 self.vpp = VPP(jsonfiles, logger=test_class.logger)
74 self._events = deque()
79 def expect_negative_api_retval(self):
80 """ Expect API failure """
81 self._expect_stack.append(self._expect_api_retval)
82 self._expect_api_retval = self._negative
85 def expect_zero_api_retval(self):
86 """ Expect API success """
87 self._expect_stack.append(self._expect_api_retval)
88 self._expect_api_retval = self._zero
91 def __exit__(self, exc_type, exc_value, traceback):
92 self._expect_api_retval = self._expect_stack.pop()
94 def register_hook(self, hook):
95 """Replace hook registration with new hook
102 def collect_events(self):
103 """ Collect all events from the internal queue and clear the queue. """
105 self._events = deque()
108 def wait_for_event(self, timeout, name=None):
109 """ Wait for and return next event. """
111 self.test_class.logger.debug("Expecting event '%s' within %ss",
114 self.test_class.logger.debug("Expecting event within %ss",
117 self.test_class.logger.debug("Not waiting, event already queued")
118 limit = time.time() + timeout
119 while time.time() < limit:
121 e = self._events.popleft()
122 if name and type(e).__name__ != name:
124 "Unexpected event received: %s, expected: %s" %
125 (type(e).__name__, name))
126 self.test_class.logger.debug("Returning event %s:%s" %
129 time.sleep(0) # yield
130 raise Exception("Event did not occur within timeout")
132 def __call__(self, name, event):
133 """ Enqueue event in the internal event queue. """
134 # FIXME use the name instead of relying on type(e).__name__ ?
135 # FIXME #2 if this throws, it is eaten silently, Ole?
136 self.test_class.logger.debug("New event: %s: %s" % (name, event))
137 self._events.append(event)
140 """Connect the API to VPP"""
141 self.vpp.connect(self.name, self.shm_prefix)
142 self.papi = self.vpp.api
143 self.vpp.register_event_callback(self)
145 def disconnect(self):
146 """Disconnect the API from VPP"""
147 self.vpp.disconnect()
149 def api(self, api_fn, api_args, expected_retval=0):
150 """ Call API function and check it's return value.
151 Call the appropriate hooks before and after the API call
153 :param api_fn: API function to call
154 :param api_args: tuple of API function arguments
155 :param expected_retval: Expected return value (Default value = 0)
156 :returns: reply from the API
159 self.hook.before_api(api_fn.__name__, api_args)
160 reply = api_fn(**api_args)
161 if self._expect_api_retval == self._negative:
162 if hasattr(reply, 'retval') and reply.retval >= 0:
163 msg = "API call passed unexpectedly: expected negative "\
164 "return value instead of %d in %s" % \
165 (reply.retval, repr(reply))
166 self.test_class.logger.info(msg)
167 raise UnexpectedApiReturnValueError(msg)
168 elif self._expect_api_retval == self._zero:
169 if hasattr(reply, 'retval') and reply.retval != expected_retval:
170 msg = "API call failed, expected %d return value instead "\
171 "of %d in %s" % (expected_retval, reply.retval,
173 self.test_class.logger.info(msg)
174 raise UnexpectedApiReturnValueError(msg)
176 raise Exception("Internal error, unexpected value for "
177 "self._expect_api_retval %s" %
178 self._expect_api_retval)
179 self.hook.after_api(api_fn.__name__, api_args)
183 """ Execute a CLI, calling the before/after hooks appropriately.
185 :param cli: CLI to execute
189 self.hook.before_cli(cli)
191 r = self.papi.cli_inband(length=len(cli), cmd=cli)
192 self.hook.after_cli(cli)
193 if hasattr(r, 'reply'):
194 return r.reply.decode().rstrip('\x00')
196 def ppcli(self, cli):
197 """ Helper method to print CLI command in case of info logging level.
199 :param cli: CLI to execute
202 return cli + "\n" + str(self.cli(cli))
204 def _convert_mac(self, mac):
205 return mac.replace(':', '').decode('hex')
207 def show_version(self):
209 return self.api(self.papi.show_version, {})
211 def pg_create_interface(self, pg_index):
217 return self.api(self.papi.pg_create_interface,
218 {"interface_id": pg_index})
220 def sw_interface_dump(self, filter=None):
223 :param filter: (Default value = None)
226 if filter is not None:
227 args = {"name_filter_valid": 1, "name_filter": filter}
230 return self.api(self.papi.sw_interface_dump, args)
232 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
233 """ Set the IPvX Table-id for the Interface
240 return self.api(self.papi.sw_interface_set_table,
241 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
244 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
245 is_ipv6=0, is_add=1, del_all=0):
248 :param addr: param is_ipv6: (Default value = 0)
251 :param is_ipv6: (Default value = 0)
252 :param is_add: (Default value = 1)
253 :param del_all: (Default value = 0)
256 return self.api(self.papi.sw_interface_add_del_address,
257 {'sw_if_index': sw_if_index,
261 'address_length': addr_len,
264 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
266 """ Set the Interface to be unnumbered
268 :param is_add: (Default value = 1)
269 :param sw_if_index - interface That will be unnumbered
270 :param ip_sw_if_index - interface with an IP addres
273 return self.api(self.papi.sw_interface_set_unnumbered,
274 {'sw_if_index': ip_sw_if_index,
275 'unnumbered_sw_if_index': sw_if_index,
278 def sw_interface_enable_disable_mpls(self, sw_if_index,
281 Enable/Disable MPLS on the interface
283 :param is_enable: (Default value = 1)
286 return self.api(self.papi.sw_interface_set_mpls_enable,
287 {'sw_if_index': sw_if_index,
288 'enable': is_enable})
290 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
291 return self.api(self.papi.sw_interface_ip6nd_ra_config,
292 {'sw_if_index': sw_if_index,
293 'suppress': suppress})
295 def set_ip_flow_hash(self,
304 return self.api(self.papi.set_ip_flow_hash,
314 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
315 return self.api(self.papi.ip6nd_proxy_add_del,
317 'sw_if_index': sw_if_index,
320 def ip6_sw_interface_ra_config(self, sw_if_index,
324 return self.api(self.papi.sw_interface_ip6nd_ra_config,
325 {'sw_if_index': sw_if_index,
327 'suppress': suppress,
328 'send_unicast': send_unicast})
330 def ip6_sw_interface_ra_prefix(self,
340 val_lifetime=0xffffffff,
341 pref_lifetime=0xffffffff):
342 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
343 {'sw_if_index': sw_if_index,
345 'address_length': address_length,
346 'use_default': use_default,
347 'no_advertise': no_advertise,
348 'off_link': off_link,
349 'no_autoconfig': no_autoconfig,
350 'no_onlink': no_onlink,
352 'val_lifetime': val_lifetime,
353 'pref_lifetime': pref_lifetime})
355 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
357 Enable/Disable An interface for IPv6
359 return self.api(self.papi.sw_interface_ip6_enable_disable,
360 {'sw_if_index': sw_if_index,
363 def vxlan_add_del_tunnel(
367 mcast_sw_if_index=0xFFFFFFFF,
371 decap_next_index=0xFFFFFFFF,
373 instance=0xFFFFFFFF):
378 :param is_add: (Default value = 1)
379 :param is_ipv6: (Default value = 0)
380 :param encap_vrf_id: (Default value = 0)
381 :param decap_next_index: (Default value = 0xFFFFFFFF)
382 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
383 :param vni: (Default value = 0)
384 :param instance: (Default value = 0xFFFFFFFF)
387 return self.api(self.papi.vxlan_add_del_tunnel,
390 'src_address': src_addr,
391 'dst_address': dst_addr,
392 'mcast_sw_if_index': mcast_sw_if_index,
393 'encap_vrf_id': encap_vrf_id,
394 'decap_next_index': decap_next_index,
396 'instance': instance})
398 def geneve_add_del_tunnel(
402 mcast_sw_if_index=0xFFFFFFFF,
406 decap_next_index=0xFFFFFFFF,
412 :param is_add: (Default value = 1)
413 :param is_ipv6: (Default value = 0)
414 :param encap_vrf_id: (Default value = 0)
415 :param decap_next_index: (Default value = 0xFFFFFFFF)
416 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
417 :param vni: (Default value = 0)
420 return self.api(self.papi.geneve_add_del_tunnel,
423 'local_address': local_addr,
424 'remote_address': remote_addr,
425 'mcast_sw_if_index': mcast_sw_if_index,
426 'encap_vrf_id': encap_vrf_id,
427 'decap_next_index': decap_next_index,
430 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
431 learn=1, arp_term=0, is_add=1):
432 """Create/delete bridge domain.
434 :param int bd_id: Bridge domain index.
435 :param int flood: Enable/disable bcast/mcast flooding in the BD.
437 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
439 :param int forward: Enable/disable forwarding on all interfaces in
440 the BD. (Default value = 1)
441 :param int learn: Enable/disable learning on all interfaces in the BD.
443 :param int arp_term: Enable/disable arp termination in the BD.
445 :param int is_add: Add or delete flag. (Default value = 1)
447 return self.api(self.papi.bridge_domain_add_del,
450 'uu_flood': uu_flood,
453 'arp_term': arp_term,
456 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
457 return self.api(self.papi.bd_ip_mac_add_del,
464 def want_ip4_arp_events(self, enable_disable=1, address=0):
465 return self.api(self.papi.want_ip4_arp_events,
466 {'enable_disable': enable_disable,
468 'pid': os.getpid(), })
470 def want_ip6_nd_events(self, enable_disable=1, address=0):
471 return self.api(self.papi.want_ip6_nd_events,
472 {'enable_disable': enable_disable,
474 'pid': os.getpid(), })
476 def want_ip6_ra_events(self, enable_disable=1):
477 return self.api(self.papi.want_ip6_ra_events,
478 {'enable_disable': enable_disable,
479 'pid': os.getpid(), })
481 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
483 return self.api(self.papi.ip6nd_send_router_solicitation,
488 'sw_if_index': sw_if_index})
490 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
491 install_default_routes):
492 return self.api(self.papi.ip6_nd_address_autoconfig,
493 {'sw_if_index': sw_if_index,
495 'install_default_routes': install_default_routes})
497 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
498 max_macs_in_event=0, learn_limit=0):
499 return self.api(self.papi.want_l2_macs_events,
500 {'enable_disable': enable_disable,
501 'scan_delay': scan_delay,
502 'max_macs_in_event': max_macs_in_event,
503 'learn_limit': learn_limit,
504 'pid': os.getpid(), })
506 def want_dhcp6_pd_reply_events(self, enable_disable=1):
507 return self.api(self.papi.want_dhcp6_pd_reply_events,
508 {'enable_disable': enable_disable,
511 def dhcp6_clients_enable_disable(self, enable=1):
512 return self.api(self.papi.dhcp6_clients_enable_disable,
515 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
516 prefixes, server_index=0xFFFFFFFF,
517 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
519 return self.api(self.papi.dhcp6_pd_send_client_message,
520 {'sw_if_index': sw_if_index,
521 'server_index': server_index,
527 'msg_type': msg_type,
530 'n_prefixes': len(prefixes),
531 'prefixes': prefixes})
533 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
535 return self.api(self.papi.dhcp6_pd_client_enable_disable,
536 {'sw_if_index': sw_if_index,
537 'prefix_group': prefix_group,
540 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
541 prefix_length, prefix_group,
543 return self.api(self.papi.ip6_add_del_address_using_prefix,
544 {'sw_if_index': sw_if_index,
545 'prefix_group': prefix_group,
547 'prefix_length': prefix_length,
550 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
551 filter_mac=0, bvi_mac=0):
552 """Create/delete L2 FIB entry.
554 :param str mac: MAC address to create FIB entry for.
555 :param int bd_id: Bridge domain index.
556 :param int sw_if_index: Software interface index of the interface.
557 :param int is_add: Add or delete flag. (Default value = 1)
558 :param int static_mac: Set to 1 to create static MAC entry.
560 :param int filter_mac: Set to 1 to drop packet that's source or
561 destination MAC address contains defined MAC address.
563 :param int bvi_mac: Set to 1 to create entry that points to BVI
564 interface. (Default value = 0)
566 return self.api(self.papi.l2fib_add_del,
567 {'mac': self._convert_mac(mac),
569 'sw_if_index': sw_if_index,
571 'static_mac': static_mac,
572 'filter_mac': filter_mac,
575 def l2fib_flush_int(self, sw_if_index):
576 """Flush L2 FIB entries for sw_if_index.
578 :param int sw_if_index: Software interface index of the interface.
580 return self.api(self.papi.l2fib_flush_int,
581 {'sw_if_index': sw_if_index})
583 def l2fib_flush_bd(self, bd_id):
584 """Flush L2 FIB entries for bd_id.
586 :param int sw_if_index: Bridge Domain id.
588 return self.api(self.papi.l2fib_flush_bd,
591 def l2fib_flush_all(self):
594 return self.api(self.papi.l2fib_flush_all, {})
596 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
597 shg=0, bvi=0, enable=1):
598 """Add/remove interface to/from bridge domain.
600 :param int sw_if_index: Software interface index of the interface.
601 :param int bd_id: Bridge domain index.
602 :param int shg: Split-horizon group index. (Default value = 0)
603 :param int bvi: Set interface as a bridge group virtual interface.
605 :param int enable: Add or remove interface. (Default value = 1)
607 return self.api(self.papi.sw_interface_set_l2_bridge,
608 {'rx_sw_if_index': sw_if_index,
614 def bridge_flags(self, bd_id, is_set, feature_bitmap):
615 """Enable/disable required feature of the bridge domain with defined
618 :param int bd_id: Bridge domain ID.
619 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
620 :param int feature_bitmap: Bitmap value of the feature to be set:
624 - uu-flood (1 << 3) or
627 return self.api(self.papi.bridge_flags,
630 'feature_bitmap': feature_bitmap})
632 def bridge_domain_dump(self, bd_id=0):
635 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
636 existing bridge domains returned)
637 :return: Dictionary of bridge domain(s) data.
639 return self.api(self.papi.bridge_domain_dump,
642 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
644 """Create or delete unidirectional cross-connect from Tx interface to
647 :param int rx_sw_if_index: Software interface index of Rx interface.
648 :param int tx_sw_if_index: Software interface index of Tx interface.
649 :param int enable: Create cross-connect if equal to 1, delete
650 cross-connect if equal to 0.
653 return self.api(self.papi.sw_interface_set_l2_xconnect,
654 {'rx_sw_if_index': rx_sw_if_index,
655 'tx_sw_if_index': tx_sw_if_index,
658 def sw_interface_set_l2_tag_rewrite(
665 """L2 interface vlan tag rewrite configure request
666 :param client_index - opaque cookie to identify the sender
667 :param context - sender context, to match reply w/ request
668 :param sw_if_index - interface the operation is applied to
669 :param vtr_op - Choose from l2_vtr_op_t enum values
670 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
671 :param tag1 - Needed for any push or translate vtr op
672 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
675 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
676 {'sw_if_index': sw_if_index,
682 def sw_interface_set_l2_emulation(
687 :param sw_if_index - interface the operation is applied to
690 return self.api(self.papi.l2_emulation,
691 {'sw_if_index': sw_if_index,
694 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
697 :param admin_up_down:
701 return self.api(self.papi.sw_interface_set_flags,
702 {'sw_if_index': sw_if_index,
703 'admin_up_down': admin_up_down})
705 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
711 return self.api(self.papi.sw_interface_set_mtu,
712 {'sw_if_index': sw_if_index,
715 def sw_interface_set_promiscuous(self, sw_if_index, enable):
721 return self.api(self.papi.sw_interface_set_promiscuous,
722 {'sw_if_index': sw_if_index,
725 def sw_interface_set_mac_address(self, sw_if_index, mac):
726 return self.api(self.papi.sw_interface_set_mac_address,
727 {'sw_if_index': sw_if_index,
730 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
731 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
732 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
733 """Create subinterface
734 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
736 :param sub_id: param inner_vlan:
740 :param no_tags: (Default value = 0)
741 :param one_tag: (Default value = 0)
742 :param two_tags: (Default value = 0)
743 :param dot1ad: (Default value = 0)
744 :param exact_match: (Default value = 0)
745 :param default_sub: (Default value = 0)
746 :param outer_vlan_id_any: (Default value = 0)
747 :param inner_vlan_id_any: (Default value = 0)
751 self.papi.create_subif,
752 {'sw_if_index': sw_if_index,
756 'two_tags': two_tags,
758 'exact_match': exact_match,
759 'default_sub': default_sub,
760 'outer_vlan_id_any': outer_vlan_id_any,
761 'inner_vlan_id_any': inner_vlan_id_any,
762 'outer_vlan_id': outer_vlan,
763 'inner_vlan_id': inner_vlan})
765 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
766 """Create p2p ethernet subinterface
768 :param sw_if_index: main (parent) interface
769 :param remote_mac: client (remote) mac address
773 self.papi.p2p_ethernet_add,
774 {'parent_if_index': sw_if_index,
775 'remote_mac': remote_mac,
776 'subif_id': subif_id})
778 def delete_subif(self, sw_if_index):
779 """Delete subinterface
783 return self.api(self.papi.delete_subif,
784 {'sw_if_index': sw_if_index})
786 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
787 """Delete p2p ethernet subinterface
789 :param sw_if_index: main (parent) interface
790 :param remote_mac: client (remote) mac address
794 self.papi.p2p_ethernet_del,
795 {'parent_if_index': sw_if_index,
796 'remote_mac': remote_mac})
798 def create_vlan_subif(self, sw_if_index, vlan):
805 return self.api(self.papi.create_vlan_subif,
806 {'sw_if_index': sw_if_index,
809 def create_loopback(self, mac=''):
812 :param mac: (Optional)
814 return self.api(self.papi.create_loopback,
815 {'mac_address': mac})
817 def delete_loopback(self, sw_if_index):
818 return self.api(self.papi.delete_loopback,
819 {'sw_if_index': sw_if_index, })
821 def ip_table_add_del(self,
828 :param is_add: (Default value = 1)
829 :param is_ipv6: (Default value = 0)
834 self.papi.ip_table_add_del,
835 {'table_id': table_id,
839 def ip_add_del_route(
844 next_hop_sw_if_index=0xFFFFFFFF,
848 next_hop_n_out_labels=0,
849 next_hop_out_label_stack=[],
850 next_hop_via_label=MPLS_LABEL_INVALID,
851 next_hop_id=0xFFFFFFFF,
853 is_resolve_attached=0,
854 classify_table_index=0xFFFFFFFF,
868 :param dst_address_length:
869 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
871 :param next_hop_address:
872 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
873 :param vrf_id: (Default value = 0)
874 :param lookup_in_vrf: (Default value = 0)
875 :param classify_table_index: (Default value = 0xFFFFFFFF)
876 :param is_add: (Default value = 1)
877 :param is_drop: (Default value = 0)
878 :param is_ipv6: (Default value = 0)
879 :param is_local: (Default value = 0)
880 :param is_classify: (Default value = 0)
881 :param is_multipath: (Default value = 0)
882 :param is_resolve_host: (Default value = 0)
883 :param is_resolve_attached: (Default value = 0)
884 :param is_dvr: (Default value = 0)
885 :param is_source_lookup: (Default value = 0)
886 :param next_hop_weight: (Default value = 1)
891 self.papi.ip_add_del_route,
892 {'next_hop_sw_if_index': next_hop_sw_if_index,
893 'table_id': table_id,
894 'classify_table_index': classify_table_index,
895 'next_hop_table_id': next_hop_table_id,
898 'is_unreach': is_unreach,
899 'is_prohibit': is_prohibit,
901 'is_local': is_local,
902 'is_classify': is_classify,
903 'is_multipath': is_multipath,
904 'is_resolve_host': is_resolve_host,
905 'is_resolve_attached': is_resolve_attached,
907 'is_source_lookup': is_source_lookup,
908 'is_udp_encap': is_udp_encap,
909 'next_hop_weight': next_hop_weight,
910 'dst_address_length': dst_address_length,
911 'dst_address': dst_address,
912 'next_hop_id': next_hop_id,
913 'next_hop_address': next_hop_address,
914 'next_hop_n_out_labels': next_hop_n_out_labels,
915 'next_hop_via_label': next_hop_via_label,
916 'next_hop_out_label_stack': next_hop_out_label_stack})
918 def ip_fib_dump(self):
919 return self.api(self.papi.ip_fib_dump, {})
921 def ip6_fib_dump(self):
922 return self.api(self.papi.ip6_fib_dump, {})
924 def ip_neighbor_add_del(self,
933 """ Add neighbor MAC to IPv4 or IPv6 address.
938 :param is_add: (Default value = 1)
939 :param is_ipv6: (Default value = 0)
940 :param is_static: (Default value = 0)
941 :param is_no_adj_fib: (Default value = 0)
945 self.papi.ip_neighbor_add_del,
946 {'sw_if_index': sw_if_index,
949 'is_static': is_static,
950 'is_no_adj_fib': is_no_adj_fib,
951 'mac_address': mac_address,
952 'dst_address': dst_address
956 def ip_neighbor_dump(self,
959 """ Return IP neighbor dump.
962 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
966 self.papi.ip_neighbor_dump,
968 'sw_if_index': sw_if_index
972 def proxy_arp_add_del(self,
977 """ Config Proxy Arp Range.
979 :param low_address: Start address in the rnage to Proxy for
980 :param hi_address: End address in the rnage to Proxy for
981 :param vrf_id: The VRF/table in which to proxy
985 self.papi.proxy_arp_add_del,
989 'low_address': low_address,
990 'hi_address': hi_address,
994 def proxy_arp_intfc_enable_disable(self,
997 """ Enable/Disable an interface for proxy ARP requests
999 :param sw_if_index: Interface
1000 :param enable_disable: Enable/Disable
1004 self.papi.proxy_arp_intfc_enable_disable,
1005 {'sw_if_index': sw_if_index,
1006 'enable_disable': is_enable
1014 """ Reset VRF (remove all routes etc.) request.
1016 :param int vrf_id: ID of the FIB table / VRF to reset.
1017 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1021 self.papi.reset_vrf,
1031 """ Reset VRF (remove all routes etc.) request.
1033 :param int vrf_id: ID of the FIB table / VRF to reset.
1034 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1038 self.papi.reset_fib,
1049 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1054 {'is_ipv6': is_ipv6,
1058 def sw_interface_span_enable_disable(
1059 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1062 :param sw_if_index_from:
1063 :param sw_if_index_to:
1067 return self.api(self.papi.sw_interface_span_enable_disable,
1068 {'sw_if_index_from': sw_if_index_from,
1069 'sw_if_index_to': sw_if_index_to,
1074 def gre_tunnel_add_del(self,
1079 instance=0xFFFFFFFF,
1083 """ Add a GRE tunnel
1087 :param outer_fib_id: (Default value = 0)
1088 :param tunnel_type: (Default value = 0)
1089 :param instance: (Default value = 0xFFFFFFFF)
1090 :param session_id: (Defalt value = 0)
1091 :param is_add: (Default value = 1)
1092 :param is_ipv6: (Default value = 0)
1096 self.papi.gre_add_del_tunnel,
1099 'tunnel_type': tunnel_type,
1100 'instance': instance,
1101 'src_address': src_address,
1102 'dst_address': dst_address,
1103 'outer_fib_id': outer_fib_id,
1104 'session_id': session_id}
1107 def udp_encap_add_del(self,
1116 """ Add a GRE tunnel
1117 :param id: user provided ID
1122 :param outer_fib_id: (Default value = 0)
1123 :param is_add: (Default value = 1)
1124 :param is_ipv6: (Default value = 0)
1128 self.papi.udp_encap_add_del,
1134 'src_port': src_port,
1135 'dst_port': dst_port,
1136 'table_id': table_id}
1139 def udp_encap_dump(self):
1140 return self.api(self.papi.udp_encap_dump, {})
1142 def want_udp_encap_stats(self, enable=1):
1143 return self.api(self.papi.want_udp_encap_stats,
1145 'pid': os.getpid()})
1147 def mpls_fib_dump(self):
1148 return self.api(self.papi.mpls_fib_dump, {})
1150 def mpls_table_add_del(
1157 :param is_add: (Default value = 1)
1162 self.papi.mpls_table_add_del,
1163 {'mt_table_id': table_id,
1164 'mt_is_add': is_add})
1166 def mpls_route_add_del(
1172 next_hop_sw_if_index=0xFFFFFFFF,
1174 next_hop_table_id=0,
1176 next_hop_n_out_labels=0,
1177 next_hop_out_label_stack=[],
1178 next_hop_via_label=MPLS_LABEL_INVALID,
1180 is_resolve_attached=0,
1187 classify_table_index=0xFFFFFFFF,
1191 :param dst_address_length:
1192 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1194 :param next_hop_address:
1195 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1196 :param vrf_id: (Default value = 0)
1197 :param lookup_in_vrf: (Default value = 0)
1198 :param classify_table_index: (Default value = 0xFFFFFFFF)
1199 :param is_add: (Default value = 1)
1200 :param is_drop: (Default value = 0)
1201 :param is_ipv6: (Default value = 0)
1202 :param is_local: (Default value = 0)
1203 :param is_classify: (Default value = 0)
1204 :param is_multipath: (Default value = 0)
1205 :param is_multicast: (Default value = 0)
1206 :param is_resolve_host: (Default value = 0)
1207 :param is_resolve_attached: (Default value = 0)
1208 :param next_hop_weight: (Default value = 1)
1212 self.papi.mpls_route_add_del,
1215 'mr_table_id': table_id,
1216 'mr_classify_table_index': classify_table_index,
1217 'mr_is_add': is_add,
1218 'mr_is_classify': is_classify,
1219 'mr_is_multipath': is_multipath,
1220 'mr_is_multicast': is_multicast,
1221 'mr_is_resolve_host': is_resolve_host,
1222 'mr_is_resolve_attached': is_resolve_attached,
1223 'mr_is_interface_rx': is_interface_rx,
1224 'mr_is_rpf_id': is_rpf_id,
1225 'mr_next_hop_proto': next_hop_proto,
1226 'mr_next_hop_weight': next_hop_weight,
1227 'mr_next_hop': next_hop_address,
1228 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1229 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1230 'mr_next_hop_table_id': next_hop_table_id,
1231 'mr_next_hop_via_label': next_hop_via_label,
1232 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1234 def mpls_ip_bind_unbind(
1246 self.papi.mpls_ip_bind_unbind,
1247 {'mb_mpls_table_id': table_id,
1249 'mb_ip_table_id': ip_table_id,
1250 'mb_is_bind': is_bind,
1251 'mb_is_ip4': is_ip4,
1252 'mb_address_length': dst_address_length,
1253 'mb_address': dst_address})
1255 def mpls_tunnel_add_del(
1258 next_hop_proto_is_ip4,
1260 next_hop_sw_if_index=0xFFFFFFFF,
1261 next_hop_table_id=0,
1263 next_hop_n_out_labels=0,
1264 next_hop_out_label_stack=[],
1265 next_hop_via_label=MPLS_LABEL_INVALID,
1271 :param dst_address_length:
1272 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1274 :param next_hop_address:
1275 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1276 :param vrf_id: (Default value = 0)
1277 :param lookup_in_vrf: (Default value = 0)
1278 :param classify_table_index: (Default value = 0xFFFFFFFF)
1279 :param is_add: (Default value = 1)
1280 :param is_drop: (Default value = 0)
1281 :param is_ipv6: (Default value = 0)
1282 :param is_local: (Default value = 0)
1283 :param is_classify: (Default value = 0)
1284 :param is_multipath: (Default value = 0)
1285 :param is_resolve_host: (Default value = 0)
1286 :param is_resolve_attached: (Default value = 0)
1287 :param next_hop_weight: (Default value = 1)
1288 :param is_multicast: (Default value = 0)
1292 self.papi.mpls_tunnel_add_del,
1293 {'mt_sw_if_index': tun_sw_if_index,
1294 'mt_is_add': is_add,
1295 'mt_l2_only': l2_only,
1296 'mt_is_multicast': is_multicast,
1297 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1298 'mt_next_hop_weight': next_hop_weight,
1299 'mt_next_hop': next_hop_address,
1300 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1301 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1302 'mt_next_hop_table_id': next_hop_table_id,
1303 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1305 def nat44_interface_add_del_feature(
1310 """Enable/disable NAT44 feature on the interface
1312 :param sw_if_index: Software index of the interface
1313 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1314 :param is_add: 1 if add, 0 if delete (Default value = 1)
1317 self.papi.nat44_interface_add_del_feature,
1319 'is_inside': is_inside,
1320 'sw_if_index': sw_if_index})
1322 def nat44_interface_add_del_output_feature(
1327 """Enable/disable NAT44 output feature on the interface
1329 :param sw_if_index: Software index of the interface
1330 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1331 :param is_add: 1 if add, 0 if delete (Default value = 1)
1334 self.papi.nat44_interface_add_del_output_feature,
1336 'is_inside': is_inside,
1337 'sw_if_index': sw_if_index})
1339 def nat44_add_del_static_mapping(
1343 external_sw_if_index=0xFFFFFFFF,
1354 """Add/delete NAT44 static mapping
1356 :param local_ip: Local IP address
1357 :param external_ip: External IP address
1358 :param external_sw_if_index: External interface instead of IP address
1359 :param local_port: Local port number (Default value = 0)
1360 :param external_port: External port number (Default value = 0)
1361 :param addr_only: 1 if address only mapping, 0 if address and port
1362 :param vrf_id: VRF ID
1363 :param protocol: IP protocol (Default value = 0)
1364 :param twice_nat: 1 if translate external host address and port
1365 :param self_twice_nat: 1 if translate external host address and port
1366 whenever external host address equals
1367 local address of internal host
1368 :param out2in_only: if 1 rule is matching only out2in direction
1369 :param tag: Opaque string tag
1370 :param is_add: 1 if add, 0 if delete (Default value = 1)
1373 self.papi.nat44_add_del_static_mapping,
1375 'addr_only': addr_only,
1376 'local_ip_address': local_ip,
1377 'external_ip_address': external_ip,
1378 'local_port': local_port,
1379 'external_port': external_port,
1380 'external_sw_if_index': external_sw_if_index,
1382 'protocol': protocol,
1383 'twice_nat': twice_nat,
1384 'self_twice_nat': self_twice_nat,
1385 'out2in_only': out2in_only,
1388 def nat44_add_del_identity_mapping(
1391 sw_if_index=0xFFFFFFFF,
1398 """Add/delete NAT44 identity mapping
1400 :param ip: IP address (Default value = 0)
1401 :param sw_if_index: Interface instead of IP address
1402 :param port: Port number (Default value = 0)
1403 :param addr_only: 1 if address only mapping, 0 if address and port
1404 :param vrf_id: VRF ID
1405 :param protocol: IP protocol (Default value = 0)
1406 :param tag: Opaque string tag
1407 :param is_add: 1 if add, 0 if delete (Default value = 1)
1410 self.papi.nat44_add_del_identity_mapping,
1412 'addr_only': addr_only,
1415 'sw_if_index': sw_if_index,
1418 'protocol': protocol})
1420 def nat44_add_del_address_range(
1427 """Add/del NAT44 address range
1429 :param first_ip_address: First IP address
1430 :param last_ip_address: Last IP address
1431 :param vrf_id: VRF id for the address range
1432 :param twice_nat: twice NAT address for extenal hosts
1433 :param is_add: 1 if add, 0 if delete (Default value = 1)
1436 self.papi.nat44_add_del_address_range,
1437 {'first_ip_address': first_ip_address,
1438 'last_ip_address': last_ip_address,
1440 'twice_nat': twice_nat,
1443 def nat44_address_dump(self):
1444 """Dump NAT44 addresses
1445 :return: Dictionary of NAT44 addresses
1447 return self.api(self.papi.nat44_address_dump, {})
1449 def nat44_interface_dump(self):
1450 """Dump interfaces with NAT44 feature
1451 :return: Dictionary of interfaces with NAT44 feature
1453 return self.api(self.papi.nat44_interface_dump, {})
1455 def nat44_interface_output_feature_dump(self):
1456 """Dump interfaces with NAT44 output feature
1457 :return: Dictionary of interfaces with NAT44 output feature
1459 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1461 def nat44_static_mapping_dump(self):
1462 """Dump NAT44 static mappings
1463 :return: Dictionary of NAT44 static mappings
1465 return self.api(self.papi.nat44_static_mapping_dump, {})
1467 def nat44_identity_mapping_dump(self):
1468 """Dump NAT44 identity mappings
1469 :return: Dictionary of NAT44 identity mappings
1471 return self.api(self.papi.nat44_identity_mapping_dump, {})
1473 def nat_show_config(self):
1474 """Show NAT plugin config
1475 :return: NAT plugin config parameters
1477 return self.api(self.papi.nat_show_config, {})
1479 def nat44_add_interface_addr(
1484 """Add/del NAT44 address from interface
1486 :param sw_if_index: Software index of the interface
1487 :param twice_nat: twice NAT address for extenal hosts
1488 :param is_add: 1 if add, 0 if delete (Default value = 1)
1491 self.papi.nat44_add_del_interface_addr,
1493 'sw_if_index': sw_if_index,
1494 'twice_nat': twice_nat})
1496 def nat44_interface_addr_dump(self):
1497 """Dump NAT44 addresses interfaces
1498 :return: Dictionary of NAT44 addresses interfaces
1500 return self.api(self.papi.nat44_interface_addr_dump, {})
1507 """Enable/disable NAT IPFIX logging
1509 :param domain_id: Observation domain ID (Default value = 1)
1510 :param src_port: Source port number (Default value = 4739)
1511 :param enable: 1 if enable, 0 if disable (Default value = 1)
1514 self.papi.nat_ipfix_enable_disable,
1515 {'domain_id': domain_id,
1516 'src_port': src_port,
1519 def nat44_user_session_dump(
1523 """Dump NAT44 user's sessions
1525 :param ip_address: ip adress of the user to be dumped
1526 :param cpu_index: cpu_index on which the user is
1527 :param vrf_id: VRF ID
1528 :return: Dictionary of S-NAT sessions
1531 self.papi.nat44_user_session_dump,
1532 {'ip_address': ip_address,
1535 def nat44_user_dump(self):
1538 :return: Dictionary of NAT44 users
1540 return self.api(self.papi.nat44_user_dump, {})
1542 def nat44_add_del_lb_static_mapping(
1555 """Add/delete NAT44 load balancing static mapping
1557 :param twice_nat: 1 if translate external host address and port
1558 :param tag: Opaque string tag
1559 :param is_add - 1 if add, 0 if delete
1562 self.papi.nat44_add_del_lb_static_mapping,
1564 'external_addr': external_addr,
1565 'external_port': external_port,
1566 'protocol': protocol,
1568 'twice_nat': twice_nat,
1569 'self_twice_nat': self_twice_nat,
1570 'out2in_only': out2in_only,
1572 'local_num': local_num,
1575 def nat44_lb_static_mapping_dump(self):
1576 """Dump NAT44 load balancing static mappings
1578 :return: Dictionary of NAT44 load balancing static mapping
1580 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1582 def nat44_del_session(
1589 ext_host_address=None,
1591 """Delete NAT44 session
1593 :param addr: IPv4 address
1594 :param por: port number
1595 :param protocol: IP protocol number
1596 :param vrf_id: VRF ID
1597 :param is_in: 1 if inside network addres and port pari, 0 if outside
1598 :param ext_host_address: external host IPv4 address
1599 :param ext_host_port: external host port
1601 if ext_host_address is None:
1603 self.papi.nat44_del_session,
1606 'protocol': protocol,
1611 self.papi.nat44_del_session,
1614 'protocol': protocol,
1617 'ext_host_valid': 1,
1618 'ext_host_address': ext_host_address,
1619 'ext_host_port': ext_host_port})
1621 def nat44_forwarding_enable_disable(
1624 """Enable/disable forwarding for NAT44
1626 :param enable: 1 for enable, 0 for disable
1629 self.papi.nat44_forwarding_enable_disable,
1639 """Set NAT virtual fragmentation reassembly
1641 :param timeout: reassembly timeout (Default 2sec)
1642 :param max_reass: maximum concurrent reassemblies (Default 1024)
1643 :param max_frag: maximum fragmets per reassembly (Default 5)
1644 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1645 :param is_ip6: 1 if IPv6, 0 if IPv4
1648 self.papi.nat_set_reass,
1649 {'timeout': timeout,
1650 'max_reass': max_reass,
1651 'max_frag': max_frag,
1652 'drop_frag': drop_frag,
1655 def nat_get_reass(self):
1656 """Get NAT virtual fragmentation reassembly configuration
1658 :return: NAT virtual fragmentation reassembly configuration
1660 return self.api(self.papi.nat_get_reass, {})
1662 def nat_reass_dump(self):
1663 """Dump NAT virtual fragmentation reassemblies
1665 :return: Dictionary of NAT virtual fragmentation reassemblies
1667 return self.api(self.papi.nat_reass_dump, {})
1669 def nat_det_add_del_map(
1676 """Add/delete deterministic NAT mapping
1678 :param is_add - 1 if add, 0 if delete
1679 :param in_addr - inside IP address
1680 :param in_plen - inside IP address prefix length
1681 :param out_addr - outside IP address
1682 :param out_plen - outside IP address prefix length
1685 self.papi.nat_det_add_del_map,
1690 'out_addr': out_addr,
1691 'out_plen': out_plen})
1693 def nat_det_forward(
1696 """Get outside address and port range from inside address
1698 :param in_addr - inside IP address
1701 self.papi.nat_det_forward,
1702 {'in_addr': in_addr,
1705 def nat_det_reverse(
1709 """Get inside address from outside address and port
1711 :param out_addr - outside IP address
1712 :param out_port - outside port
1715 self.papi.nat_det_reverse,
1716 {'out_addr': out_addr,
1717 'out_port': out_port})
1719 def nat_det_map_dump(self):
1720 """Dump deterministic NAT mappings
1722 :return: Dictionary of deterministic NAT mappings
1724 return self.api(self.papi.nat_det_map_dump, {})
1726 def nat_det_set_timeouts(
1729 tcp_established=7440,
1732 """Set values of timeouts for deterministic NAT (in seconds)
1734 :param udp - UDP timeout (Default value = 300)
1735 :param tcp_established - TCP established timeout (Default value = 7440)
1736 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1737 :param icmp - ICMP timeout (Default value = 60)
1740 self.papi.nat_det_set_timeouts,
1742 'tcp_established': tcp_established,
1743 'tcp_transitory': tcp_transitory,
1746 def nat_det_get_timeouts(self):
1747 """Get values of timeouts for deterministic NAT
1749 :return: Timeouts for deterministic NAT (in seconds)
1751 return self.api(self.papi.nat_det_get_timeouts, {})
1753 def nat_det_close_session_out(
1759 """Close deterministic NAT session using outside address and port
1761 :param out_addr - outside IP address
1762 :param out_port - outside port
1763 :param ext_addr - external host IP address
1764 :param ext_port - external host port
1767 self.papi.nat_det_close_session_out,
1768 {'out_addr': out_addr,
1769 'out_port': out_port,
1770 'ext_addr': ext_addr,
1771 'ext_port': ext_port})
1773 def nat_det_close_session_in(
1779 """Close deterministic NAT session using inside address and port
1781 :param in_addr - inside IP address
1782 :param in_port - inside port
1783 :param ext_addr - external host IP address
1784 :param ext_port - external host port
1787 self.papi.nat_det_close_session_in,
1788 {'in_addr': in_addr,
1790 'ext_addr': ext_addr,
1791 'ext_port': ext_port,
1794 def nat_det_session_dump(
1797 """Dump deterministic NAT sessions belonging to a user
1799 :param user_addr - inside IP address of the user
1800 :return: Dictionary of deterministic NAT sessions
1803 self.papi.nat_det_session_dump,
1805 'user_addr': user_addr})
1807 def nat64_add_del_pool_addr_range(
1813 """Add/del address range to NAT64 pool
1815 :param start_addr: First IP address
1816 :param end_addr: Last IP address
1817 :param vrf_id: VRF id for the address range
1818 :param is_add: 1 if add, 0 if delete (Default value = 1)
1821 self.papi.nat64_add_del_pool_addr_range,
1822 {'start_addr': start_addr,
1823 'end_addr': end_addr,
1827 def nat64_pool_addr_dump(self):
1828 """Dump NAT64 pool addresses
1829 :return: Dictionary of NAT64 pool addresses
1831 return self.api(self.papi.nat64_pool_addr_dump, {})
1833 def nat64_add_del_interface(
1838 """Enable/disable NAT64 feature on the interface
1839 :param sw_if_index: Index of the interface
1840 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1841 :param is_add: 1 if add, 0 if delete (Default value = 1)
1844 self.papi.nat64_add_del_interface,
1845 {'sw_if_index': sw_if_index,
1846 'is_inside': is_inside,
1849 def nat64_interface_dump(self):
1850 """Dump interfaces with NAT64 feature
1851 :return: Dictionary of interfaces with NAT64 feature
1853 return self.api(self.papi.nat64_interface_dump, {})
1855 def nat64_add_del_static_bib(
1864 """Add/delete S-NAT static BIB entry
1866 :param in_ip: Inside IPv6 address
1867 :param out_ip: Outside IPv4 address
1868 :param in_port: Inside port number
1869 :param out_port: Outside port number
1870 :param protocol: IP protocol
1871 :param vrf_id: VRF ID (Default value = 0)
1872 :param is_add: 1 if add, 0 if delete (Default value = 1)
1875 self.papi.nat64_add_del_static_bib,
1884 def nat64_bib_dump(self, protocol=255):
1887 :param protocol: IP protocol (Default value = 255, all BIBs)
1888 :returns: Dictionary of NAT64 BIB entries
1890 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1892 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1893 tcp_incoming_syn=6):
1894 """Set values of timeouts for NAT64 (in seconds)
1896 :param udpi: UDP timeout (Default value = 300)
1897 :param icmp: ICMP timeout (Default value = 60)
1898 :param tcp_trans: TCP transitory timeout (Default value = 240)
1899 :param tcp_est: TCP established timeout (Default value = 7440)
1900 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1903 self.papi.nat64_set_timeouts,
1906 'tcp_trans': tcp_trans,
1908 'tcp_incoming_syn': tcp_incoming_syn})
1910 def nat64_get_timeouts(self):
1911 """Get values of timeouts for NAT64
1913 :return: Timeouts for NAT64 (in seconds)
1915 return self.api(self.papi.nat64_get_timeouts, {})
1917 def nat64_st_dump(self, protocol=255):
1918 """Dump NAT64 session table
1920 :param protocol: IP protocol (Default value = 255, all STs)
1921 :returns: Dictionary of NAT64 sesstion table entries
1923 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1925 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1926 """Add/del NAT64 prefix
1928 :param prefix: NAT64 prefix
1929 :param plen: NAT64 prefix length
1930 :param vrf_id: VRF id of tenant (Default 0)
1931 :param is_add: 1 if add, 0 if delete (Default value = 1)
1934 self.papi.nat64_add_del_prefix,
1940 def nat64_prefix_dump(self):
1941 """Dump NAT64 prefix
1943 :returns: Dictionary of NAT64 prefixes
1945 return self.api(self.papi.nat64_prefix_dump, {})
1947 def nat64_add_interface_addr(
1951 """Add/del NAT64 address from interface
1953 :param sw_if_index: Software index of the interface
1954 :param is_add: 1 if add, 0 if delete (Default value = 1)
1956 return self.api(self.papi.nat64_add_del_interface_addr,
1957 {'is_add': is_add, 'sw_if_index': sw_if_index})
1959 def dslite_set_aftr_addr(self, ip6, ip4):
1960 """Set DS-Lite AFTR addresses
1962 :param ip4: IPv4 address
1963 :param ip6: IPv6 address
1966 self.papi.dslite_set_aftr_addr,
1970 def dslite_set_b4_addr(self, ip6, ip4):
1971 """Set DS-Lite B4 IPv6 address
1973 :param ip4: IPv4 address
1974 :param ip6: IPv6 address
1977 self.papi.dslite_set_b4_addr,
1981 def dslite_add_del_pool_addr_range(
1986 """Add/del address range to DS-Lite pool
1988 :param start_addr: First IP address
1989 :param end_addr: Last IP address
1990 :param is_add: 1 if add, 0 if delete (Default value = 1)
1993 self.papi.dslite_add_del_pool_addr_range,
1994 {'start_addr': start_addr,
1995 'end_addr': end_addr,
1998 def nat66_add_del_interface(
2003 """Enable/disable NAT66 feature on the interface
2004 :param sw_if_index: Index of the interface
2005 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2006 :param is_add: 1 if add, 0 if delete (Default value = 1)
2009 self.papi.nat66_add_del_interface,
2010 {'sw_if_index': sw_if_index,
2011 'is_inside': is_inside,
2014 def nat66_add_del_static_mapping(
2020 """Add/delete NAT66 static mapping
2022 :param in_ip: Inside IPv6 address
2023 :param out_ip: Outside IPv6 address
2024 :param vrf_id: VRF ID (Default value = 0)
2025 :param is_add: 1 if add, 0 if delete (Default value = 1)
2028 self.papi.nat66_add_del_static_mapping,
2029 {'local_ip_address': in_ip,
2030 'external_ip_address': out_ip,
2034 def nat66_interface_dump(self):
2035 """Dump interfaces with NAT66 feature
2036 :return: Dictionary of interfaces with NAT66 feature
2038 return self.api(self.papi.nat66_interface_dump, {})
2040 def nat66_static_mapping_dump(self):
2041 """Dump NAT66 static mappings
2042 :return: Dictionary of NAT66 static mappings
2044 return self.api(self.papi.nat66_static_mapping_dump, {})
2046 def control_ping(self):
2047 self.api(self.papi.control_ping)
2049 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2050 detect_mult, local_addr, peer_addr, is_ipv6=0,
2051 bfd_key_id=None, conf_key_id=None):
2052 if bfd_key_id is None:
2053 return self.api(self.papi.bfd_udp_add,
2055 'sw_if_index': sw_if_index,
2056 'desired_min_tx': desired_min_tx,
2057 'required_min_rx': required_min_rx,
2058 'local_addr': local_addr,
2059 'peer_addr': peer_addr,
2061 'detect_mult': detect_mult,
2064 return self.api(self.papi.bfd_udp_add,
2066 'sw_if_index': sw_if_index,
2067 'desired_min_tx': desired_min_tx,
2068 'required_min_rx': required_min_rx,
2069 'local_addr': local_addr,
2070 'peer_addr': peer_addr,
2072 'detect_mult': detect_mult,
2073 'is_authenticated': 1,
2074 'bfd_key_id': bfd_key_id,
2075 'conf_key_id': conf_key_id,
2078 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2079 detect_mult, local_addr, peer_addr, is_ipv6=0):
2080 return self.api(self.papi.bfd_udp_mod,
2082 'sw_if_index': sw_if_index,
2083 'desired_min_tx': desired_min_tx,
2084 'required_min_rx': required_min_rx,
2085 'local_addr': local_addr,
2086 'peer_addr': peer_addr,
2088 'detect_mult': detect_mult,
2091 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2092 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2094 return self.api(self.papi.bfd_udp_auth_activate,
2096 'sw_if_index': sw_if_index,
2097 'local_addr': local_addr,
2098 'peer_addr': peer_addr,
2100 'is_delayed': 1 if is_delayed else 0,
2101 'bfd_key_id': bfd_key_id,
2102 'conf_key_id': conf_key_id,
2105 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2106 is_ipv6=0, is_delayed=False):
2107 return self.api(self.papi.bfd_udp_auth_deactivate,
2109 'sw_if_index': sw_if_index,
2110 'local_addr': local_addr,
2111 'peer_addr': peer_addr,
2113 'is_delayed': 1 if is_delayed else 0,
2116 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2117 return self.api(self.papi.bfd_udp_del,
2119 'sw_if_index': sw_if_index,
2120 'local_addr': local_addr,
2121 'peer_addr': peer_addr,
2125 def bfd_udp_session_dump(self):
2126 return self.api(self.papi.bfd_udp_session_dump, {})
2128 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2129 peer_addr, is_ipv6=0):
2130 return self.api(self.papi.bfd_udp_session_set_flags, {
2131 'admin_up_down': admin_up_down,
2132 'sw_if_index': sw_if_index,
2133 'local_addr': local_addr,
2134 'peer_addr': peer_addr,
2138 def want_bfd_events(self, enable_disable=1):
2139 return self.api(self.papi.want_bfd_events, {
2140 'enable_disable': enable_disable,
2144 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2145 return self.api(self.papi.bfd_auth_set_key, {
2146 'conf_key_id': conf_key_id,
2147 'auth_type': auth_type,
2149 'key_len': len(key),
2152 def bfd_auth_del_key(self, conf_key_id):
2153 return self.api(self.papi.bfd_auth_del_key, {
2154 'conf_key_id': conf_key_id,
2157 def bfd_auth_keys_dump(self):
2158 return self.api(self.papi.bfd_auth_keys_dump, {})
2160 def bfd_udp_set_echo_source(self, sw_if_index):
2161 return self.api(self.papi.bfd_udp_set_echo_source,
2162 {'sw_if_index': sw_if_index})
2164 def bfd_udp_del_echo_source(self):
2165 return self.api(self.papi.bfd_udp_del_echo_source, {})
2167 def classify_add_del_table(
2172 table_index=0xFFFFFFFF,
2174 memory_size=2097152,
2176 next_table_index=0xFFFFFFFF,
2177 miss_next_index=0xFFFFFFFF,
2178 current_data_flag=0,
2179 current_data_offset=0):
2183 :param match_n_vectors: (Default value = 1)
2184 :param table_index: (Default value = 0xFFFFFFFF)
2185 :param nbuckets: (Default value = 2)
2186 :param memory_size: (Default value = 2097152)
2187 :param skip_n_vectors: (Default value = 0)
2188 :param next_table_index: (Default value = 0xFFFFFFFF)
2189 :param miss_next_index: (Default value = 0xFFFFFFFF)
2190 :param current_data_flag: (Default value = 0)
2191 :param current_data_offset: (Default value = 0)
2195 self.papi.classify_add_del_table,
2197 'table_index': table_index,
2198 'nbuckets': nbuckets,
2199 'memory_size': memory_size,
2200 'skip_n_vectors': skip_n_vectors,
2201 'match_n_vectors': match_n_vectors,
2202 'next_table_index': next_table_index,
2203 'miss_next_index': miss_next_index,
2204 'current_data_flag': current_data_flag,
2205 'current_data_offset': current_data_offset,
2208 def classify_add_del_session(
2213 opaque_index=0xFFFFFFFF,
2214 hit_next_index=0xFFFFFFFF,
2222 :param opaque_index: (Default value = 0xFFFFFFFF)
2223 :param hit_next_index: (Default value = 0xFFFFFFFF)
2224 :param advance: (Default value = 0)
2225 :param action: (Default value = 0)
2226 :param metadata: (Default value = 0)
2230 self.papi.classify_add_del_session,
2232 'table_index': table_index,
2233 'hit_next_index': hit_next_index,
2234 'opaque_index': opaque_index,
2237 'metadata': metadata,
2240 def input_acl_set_interface(
2244 ip4_table_index=0xFFFFFFFF,
2245 ip6_table_index=0xFFFFFFFF,
2246 l2_table_index=0xFFFFFFFF):
2250 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2251 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2252 :param l2_table_index: (Default value = 0xFFFFFFFF)
2256 self.papi.input_acl_set_interface,
2257 {'sw_if_index': sw_if_index,
2258 'ip4_table_index': ip4_table_index,
2259 'ip6_table_index': ip6_table_index,
2260 'l2_table_index': l2_table_index,
2263 def output_acl_set_interface(
2267 ip4_table_index=0xFFFFFFFF,
2268 ip6_table_index=0xFFFFFFFF,
2269 l2_table_index=0xFFFFFFFF):
2273 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2274 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2275 :param l2_table_index: (Default value = 0xFFFFFFFF)
2279 self.papi.output_acl_set_interface,
2280 {'sw_if_index': sw_if_index,
2281 'ip4_table_index': ip4_table_index,
2282 'ip6_table_index': ip6_table_index,
2283 'l2_table_index': l2_table_index,
2286 def set_ipfix_exporter(
2293 collector_port=4739,
2296 self.papi.set_ipfix_exporter,
2298 'collector_address': collector_address,
2299 'collector_port': collector_port,
2300 'src_address': src_address,
2302 'path_mtu': path_mtu,
2303 'template_interval': template_interval,
2304 'udp_checksum': udp_checksum,
2307 def dhcp_proxy_config(self,
2315 self.papi.dhcp_proxy_config,
2317 'rx_vrf_id': rx_table_id,
2318 'server_vrf_id': server_table_id,
2321 'dhcp_server': dhcp_server,
2322 'dhcp_src_address': dhcp_src_address,
2325 def dhcp_proxy_set_vss(self,
2334 self.papi.dhcp_proxy_set_vss,
2337 'vss_type': vss_type,
2338 'vpn_ascii_id': vpn_ascii_id,
2340 'vpn_index': vpn_index,
2345 def dhcp_client_dump(self):
2346 return self.api(self.papi.dhcp_client_dump, {})
2348 def dhcp_client(self,
2353 set_broadcast_flag=1,
2354 want_dhcp_events=0):
2356 self.papi.dhcp_client_config,
2360 'sw_if_index': sw_if_index,
2361 'hostname': hostname,
2363 'want_dhcp_event': want_dhcp_events,
2364 'set_broadcast_flag': set_broadcast_flag,
2368 def ip_mroute_add_del(self,
2374 next_hop_sw_if_index,
2384 IP Multicast Route add/del
2387 self.papi.ip_mroute_add_del,
2388 {'next_hop_sw_if_index': next_hop_sw_if_index,
2389 'entry_flags': e_flags,
2390 'itf_flags': i_flags,
2391 'table_id': table_id,
2395 'is_local': is_local,
2396 'bier_imp': bier_imp,
2397 'next_hop_afi': next_hop_afi,
2398 'grp_address_length': grp_address_length,
2399 'grp_address': grp_address,
2400 'src_address': src_address,
2401 'nh_address': next_hop_address})
2403 def mfib_signal_dump(self):
2404 return self.api(self.papi.mfib_signal_dump, {})
2406 def ip_mfib_dump(self):
2407 return self.api(self.papi.ip_mfib_dump, {})
2409 def ip6_mfib_dump(self):
2410 return self.api(self.papi.ip6_mfib_dump, {})
2412 def lisp_enable_disable(self, is_enabled):
2414 self.papi.lisp_enable_disable,
2416 'is_en': is_enabled,
2419 def lisp_locator_set(self,
2423 self.papi.lisp_add_del_locator_set,
2426 'locator_set_name': ls_name
2429 def lisp_locator_set_dump(self):
2430 return self.api(self.papi.lisp_locator_set_dump, {})
2432 def lisp_locator(self,
2439 self.papi.lisp_add_del_locator,
2442 'locator_set_name': ls_name,
2443 'sw_if_index': sw_if_index,
2444 'priority': priority,
2448 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2450 self.papi.lisp_locator_dump,
2452 'is_index_set': is_index_set,
2454 'ls_index': ls_index,
2457 def lisp_local_mapping(self,
2467 self.papi.lisp_add_del_local_eid,
2469 'locator_set_name': ls_name,
2471 'eid_type': eid_type,
2473 'prefix_len': prefix_len,
2479 def lisp_eid_table_dump(self,
2487 self.papi.lisp_eid_table_dump,
2490 'prefix_length': prefix_length,
2492 'eid_type': eid_type,
2494 'filter': filter_opt,
2497 def lisp_remote_mapping(self,
2507 self.papi.lisp_add_del_remote_mapping,
2510 'eid_type': eid_type,
2512 'eid_len': eid_prefix_len,
2513 'rloc_num': rlocs_num,
2516 'is_src_dst': is_src_dst,
2519 def lisp_adjacency(self,
2528 self.papi.lisp_add_del_adjacency,
2532 'eid_type': eid_type,
2535 'leid_len': leid_len,
2536 'reid_len': reid_len,
2539 def lisp_adjacencies_get(self, vni=0):
2541 self.papi.lisp_adjacencies_get,
2546 def map_add_domain(self,
2560 self.papi.map_add_domain,
2562 'ip6_prefix': ip6_prefix,
2563 'ip6_prefix_len': ip6_prefix_len,
2564 'ip4_prefix': ip4_prefix,
2565 'ip4_prefix_len': ip4_prefix_len,
2567 'ip6_src_prefix_len': ip6_src_prefix_len,
2568 'ea_bits_len': ea_bits_len,
2569 'psid_offset': psid_offset,
2570 'psid_length': psid_length,
2571 'is_translation': is_translation,
2572 'is_rfc6052': is_rfc6052,
2576 def gtpu_add_del_tunnel(
2582 mcast_sw_if_index=0xFFFFFFFF,
2584 decap_next_index=0xFFFFFFFF,
2588 :param is_add: (Default value = 1)
2589 :param is_ipv6: (Default value = 0)
2592 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2593 :param encap_vrf_id: (Default value = 0)
2594 :param decap_next_index: (Default value = 0xFFFFFFFF)
2595 :param teid: (Default value = 0)
2598 return self.api(self.papi.gtpu_add_del_tunnel,
2601 'src_address': src_addr,
2602 'dst_address': dst_addr,
2603 'mcast_sw_if_index': mcast_sw_if_index,
2604 'encap_vrf_id': encap_vrf_id,
2605 'decap_next_index': decap_next_index,
2608 def vxlan_gpe_add_del_tunnel(
2612 mcast_sw_if_index=0xFFFFFFFF,
2623 :param is_add: (Default value = 1)
2624 :param is_ipv6: (Default value = 0)
2625 :param encap_vrf_id: (Default value = 0)
2626 :param decap_vrf_id: (Default value = 0)
2627 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2628 :param protocol: (Default value = 3)
2629 :param vni: (Default value = 0)
2632 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2637 'mcast_sw_if_index': mcast_sw_if_index,
2638 'encap_vrf_id': encap_vrf_id,
2639 'decap_vrf_id': decap_vrf_id,
2640 'protocol': protocol,
2643 def pppoe_add_del_session(
2653 :param is_add: (Default value = 1)
2654 :param is_ipv6: (Default value = 0)
2656 :param session_id: (Default value = 0)
2658 :param decap_vrf_id: (Default value = 0)
2661 return self.api(self.papi.pppoe_add_del_session,
2664 'session_id': session_id,
2665 'client_ip': client_ip,
2666 'decap_vrf_id': decap_vrf_id,
2667 'client_mac': client_mac})
2669 def sr_localsid_add_del(self,
2675 sw_if_index=0xFFFFFFFF,
2679 """ Add/del IPv6 SR local-SID.
2681 :param localsid_addr:
2682 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2683 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2685 :param is_del: (Default value = 0)
2686 :param end_psp: (Default value = 0)
2687 :param sw_if_index: (Default value = 0xFFFFFFFF)
2688 :param vlan_index: (Default value = 0)
2689 :param fib_table: (Default value = 0)
2692 self.papi.sr_localsid_add_del,
2694 'localsid_addr': localsid_addr,
2696 'behavior': behavior,
2697 'sw_if_index': sw_if_index,
2698 'vlan_index': vlan_index,
2699 'fib_table': fib_table,
2714 :param bsid_addr: bindingSID of the SR Policy
2715 :param weight: weight of the sid list. optional. (default: 1)
2716 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2718 :param type: type/behavior of the SR policy. (default or spray) \
2720 :param fib_table: VRF where to install the FIB entry for the BSID \
2722 :param n_segments: number of segments \
2724 :param segments: a vector of IPv6 address composing the segment list \
2728 self.papi.sr_policy_add,
2729 {'bsid_addr': bsid_addr,
2731 'is_encap': is_encap,
2733 'fib_table': fib_table,
2734 'n_segments': n_segments,
2735 'segments': segments
2744 :param bsid: bindingSID of the SR Policy
2745 :param sr_policy_index: index of the sr policy (default: 0)
2748 self.papi.sr_policy_del,
2749 {'bsid_addr': bsid_addr,
2750 'sr_policy_index': sr_policy_index
2753 def sr_steering_add_del(
2764 Steer traffic L2 and L3 traffic through a given SR policy
2766 :param is_del: delete or add
2767 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2768 :param sr_policy: is the index of the SR Policy (alt to bsid)
2769 :param table_id: is the VRF where to install the FIB entry for the BSID
2770 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2771 :param mask_width: is the mask for L3 traffic type
2772 :param sw_if_index: is the incoming interface for L2 traffic
2773 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2776 self.papi.sr_steering_add_del,
2778 'bsid_addr': bsid_addr,
2779 'sr_policy_index': sr_policy_index,
2780 'table_id': table_id,
2781 'prefix_addr': prefix_addr,
2782 'mask_width': mask_width,
2783 'sw_if_index': sw_if_index,
2784 'traffic_type': traffic_type
2787 def acl_add_replace(self, acl_index, r, tag='',
2789 """Add/replace an ACL
2790 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2791 :param acl_rule r: ACL rules array.
2792 :param str tag: symbolic tag (description) for this ACL.
2793 :param int count: number of rules.
2795 return self.api(self.papi.acl_add_replace,
2796 {'acl_index': acl_index,
2800 expected_retval=expected_retval)
2802 def acl_del(self, acl_index, expected_retval=0):
2808 return self.api(self.papi.acl_del,
2809 {'acl_index': acl_index},
2810 expected_retval=expected_retval)
2812 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2814 return self.api(self.papi.acl_interface_set_acl_list,
2815 {'sw_if_index': sw_if_index,
2819 expected_retval=expected_retval)
2821 def acl_interface_set_etype_whitelist(self, sw_if_index,
2824 return self.api(self.papi.acl_interface_set_etype_whitelist,
2825 {'sw_if_index': sw_if_index,
2826 'count': len(whitelist),
2828 'whitelist': whitelist},
2829 expected_retval=expected_retval)
2831 def acl_interface_add_del(self,
2835 """ Add/Delete ACL to/from interface
2839 :param is_add: (Default value = 1)
2842 return self.api(self.papi.acl_interface_add_del,
2845 'sw_if_index': sw_if_index,
2846 'acl_index': acl_index})
2848 def acl_dump(self, acl_index, expected_retval=0):
2849 return self.api(self.papi.acl_dump,
2850 {'acl_index': acl_index},
2851 expected_retval=expected_retval)
2853 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2855 return self.api(self.papi.acl_interface_list_dump,
2856 {'sw_if_index': sw_if_index},
2857 expected_retval=expected_retval)
2859 def macip_acl_add(self, rules, tag=""):
2862 :param rules: list of rules for given acl
2866 return self.api(self.papi.macip_acl_add,
2868 'count': len(rules),
2871 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2874 :param rules: list of rules for given acl
2878 return self.api(self.papi.macip_acl_add_replace,
2879 {'acl_index': acl_index,
2881 'count': len(rules),
2884 def macip_acl_del(self, acl_index):
2890 return self.api(self.papi.macip_acl_del,
2891 {'acl_index': acl_index})
2893 def macip_acl_interface_add_del(self,
2897 """ Add MACIP acl to interface
2901 :param is_add: (Default value = 1)
2904 return self.api(self.papi.macip_acl_interface_add_del,
2906 'sw_if_index': sw_if_index,
2907 'acl_index': acl_index})
2909 def macip_acl_interface_get(self):
2910 """ Return interface acls dump
2913 self.papi.macip_acl_interface_get, {})
2915 def macip_acl_dump(self, acl_index=4294967295):
2916 """ Return MACIP acl dump
2920 self.papi.macip_acl_dump, {'acl_index': acl_index})
2922 def policer_add_del(self,
2933 conform_action_type=1,
2935 exceed_action_type=0,
2937 violate_action_type=0,
2939 return self.api(self.papi.policer_add_del,
2946 'rate_type': rate_type,
2947 'round_type': round_type,
2949 'color_aware': color_aware,
2950 'conform_action_type': conform_action_type,
2951 'conform_dscp': conform_dscp,
2952 'exceed_action_type': exceed_action_type,
2953 'exceed_dscp': exceed_dscp,
2954 'violate_action_type': violate_action_type,
2955 'violate_dscp': violate_dscp})
2957 def ip_punt_police(self,
2961 return self.api(self.papi.ip_punt_police,
2962 {'policer_index': policer_index,
2966 def ip_punt_redirect(self,
2972 return self.api(self.papi.ip_punt_redirect,
2973 {'rx_sw_if_index': rx_sw_if_index,
2974 'tx_sw_if_index': tx_sw_if_index,
2979 def bier_table_add_del(self,
2983 """ BIER Table add/del """
2985 self.papi.bier_table_add_del,
2986 {'bt_tbl_id': {"bt_set": bti.set_id,
2987 "bt_sub_domain": bti.sub_domain_id,
2988 "bt_hdr_len_id": bti.hdr_len_id},
2989 'bt_label': mpls_label,
2990 'bt_is_add': is_add})
2992 def bier_table_dump(self):
2993 return self.api(self.papi.bier_table_dump, {})
2995 def bier_route_add_del(self,
3000 """ BIER Route add/del """
3002 self.papi.bier_route_add_del,
3003 {'br_tbl_id': {"bt_set": bti.set_id,
3004 "bt_sub_domain": bti.sub_domain_id,
3005 "bt_hdr_len_id": bti.hdr_len_id},
3007 'br_n_paths': len(paths),
3009 'br_is_add': is_add})
3011 def bier_route_dump(self, bti):
3013 self.papi.bier_route_dump,
3014 {'br_tbl_id': {"bt_set": bti.set_id,
3015 "bt_sub_domain": bti.sub_domain_id,
3016 "bt_hdr_len_id": bti.hdr_len_id}})
3018 def bier_imp_add(self,
3023 """ BIER Imposition Add """
3025 self.papi.bier_imp_add,
3026 {'bi_tbl_id': {"bt_set": bti.set_id,
3027 "bt_sub_domain": bti.sub_domain_id,
3028 "bt_hdr_len_id": bti.hdr_len_id},
3030 'bi_n_bytes': len(ibytes),
3031 'bi_bytes': ibytes})
3033 def bier_imp_del(self, bi_index):
3034 """ BIER Imposition del """
3036 self.papi.bier_imp_del,
3037 {'bi_index': bi_index})
3039 def bier_imp_dump(self):
3040 return self.api(self.papi.bier_imp_dump, {})
3042 def bier_disp_table_add_del(self,
3045 """ BIER Disposition Table add/del """
3047 self.papi.bier_disp_table_add_del,
3048 {'bdt_tbl_id': bdti,
3049 'bdt_is_add': is_add})
3051 def bier_disp_table_dump(self):
3052 return self.api(self.papi.bier_disp_table_dump, {})
3054 def bier_disp_entry_add_del(self,
3064 """ BIER Route add/del """
3066 while (len(lstack) < 16):
3069 self.papi.bier_disp_entry_add_del,
3070 {'bde_tbl_id': bdti,
3072 'bde_payload_proto': payload_proto,
3074 'bde_paths': [{'next_hop': next_hop,
3075 'table_id': next_hop_tbl_id,
3076 'afi': next_hop_afi,
3077 'rpf_id': next_hop_rpf_id,
3079 'label_stack': lstack}],
3080 'bde_is_add': is_add})
3082 def bier_disp_entry_dump(self, bdti):
3084 self.papi.bier_disp_entry_dump,
3085 {'bde_tbl_id': bdti})
3087 def add_node_next(self, node_name, next_name):
3088 """ Set the next node for a given node request
3093 return self.api(self.papi.add_node_next,
3094 {'node_name': node_name,
3095 'next_name': next_name})
3097 def session_enable_disable(self, is_enabled):
3099 self.papi.session_enable_disable,
3100 {'is_enable': is_enabled})
3102 def ipsec_spd_add_del(self, spd_id, is_add=1):
3103 """ SPD add/del - Wrapper to add or del ipsec SPD
3104 Sample CLI : 'ipsec spd add 1'
3106 :param spd_id - SPD ID to be created in the vpp . mandatory
3107 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3109 :returns: reply from the API
3112 self.papi.ipsec_spd_add_del, {
3113 'spd_id': spd_id, 'is_add': is_add})
3115 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3116 """ IPSEC interface SPD add/del - \
3117 Wrapper to associate/disassociate SPD to interface in VPP
3118 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3120 :param spd_id - SPD ID to associate with the interface . mandatory
3121 :param sw_if_index - Interface Index which needs to ipsec \
3122 association mandatory
3123 :param is_add - add(1) or del(0) association with interface \
3124 (Default 1 - add) . optional
3125 :returns: reply from the API
3128 self.papi.ipsec_interface_add_del_spd,
3129 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3131 def ipsec_sad_add_del_entry(self,
3134 tunnel_src_address='',
3135 tunnel_dst_address='',
3137 integrity_algorithm=2,
3138 integrity_key_length=0,
3139 integrity_key='C91KUR9GYMm5GfkEvNjX',
3141 crypto_key_length=0,
3142 crypto_key='JPjyOWBeVEQiMe7h',
3146 """ IPSEC SA add/del
3147 Sample CLI : 'ipsec sa add 10 spi 1001 esp \
3148 crypto-key 4a506a794f574265564551694d653768 \
3149 crypto-alg aes-cbc-128 \
3150 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3151 integ-alg sha1-96 tunnel-src 192.168.100.3 \
3152 tunnel-dst 192.168.100.2'
3153 Sample CLI : 'ipsec sa add 20 spi 2001 \
3154 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3157 :param sad_id - Security Association ID to be \
3158 created or deleted. mandatory
3159 :param spi - security param index of the SA in decimal. mandatory
3160 :param tunnel_src_address - incase of tunnel mode outer src address .\
3161 mandatory for tunnel mode
3162 :param tunnel_dst_address - incase of transport mode \
3163 outer dst address. mandatory for tunnel mode
3164 :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional
3165 :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\
3167 :param integrity_key - value in string \
3168 (Default C91KUR9GYMm5GfkEvNjX).optional
3169 :param integrity_key_length - length of the key string in bytes\
3170 (Default 0 - integrity disabled). optional
3171 :param crypto_algorithm - value range 1-11 Default \
3172 (1- AES_CBC_128).optional **
3173 :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional
3174 :param crypto_key_length - length of the key string in bytes\
3175 (Default 0 - crypto disabled). optional
3176 :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\
3178 :param is_tunnel - tunnel mode (1) or transport mode(0) \
3179 (Default 1 - tunnel). optional
3180 :returns: reply from the API
3181 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3182 crypto and ipsec algorithms
3185 self.papi.ipsec_sad_add_del_entry,
3188 'tunnel_src_address': tunnel_src_address,
3189 'tunnel_dst_address': tunnel_dst_address,
3190 'protocol': protocol,
3191 'integrity_algorithm': integrity_algorithm,
3192 'integrity_key_length': integrity_key_length,
3193 'integrity_key': integrity_key,
3194 'crypto_algorithm': crypto_algorithm,
3195 'crypto_key_length': crypto_key_length,
3196 'crypto_key': crypto_key,
3198 'is_tunnel': is_tunnel,
3199 'udp_encap': udp_encap})
3201 def ipsec_spd_add_del_entry(self,
3203 local_address_start,
3205 remote_address_start,
3206 remote_address_stop,
3208 local_port_stop=65535,
3209 remote_port_start=0,
3210 remote_port_stop=65535,
3218 """ IPSEC policy SPD add/del -
3219 Wrapper to configure ipsec SPD policy entries in VPP
3220 Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \
3221 protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \
3222 remote-ip-range 192.168.3.3 - 192.168.3.3'
3224 :param spd_id - SPD ID for the policy . mandatory
3225 :param local_address_start - local-ip-range start address . mandatory
3226 :param local_address_stop - local-ip-range stop address . mandatory
3227 :param remote_address_start - remote-ip-range start address . mandatory
3228 :param remote_address_stop - remote-ip-range stop address . mandatory
3229 :param local_port_start - (Default 0) . optional
3230 :param local_port_stop - (Default 65535). optional
3231 :param remote_port_start - (Default 0). optional
3232 :param remote_port_stop - (Default 65535). optional
3233 :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any).
3235 :param sa_id - Security Association ID for mapping it to SPD
3236 (default 10). optional
3237 :param policy - bypass(0), discard(1), resolve(2) or protect(3)action
3238 (Default 0 - bypass). optional
3239 :param priotity - value for the spd action (Default 100). optional
3240 :param is_outbound - flag for inbound(0) or outbound(1)
3241 (Default 1 - outbound). optional
3242 :param is_add flag - for addition(1) or deletion(0) of the spd
3243 (Default 1 - addtion). optional
3244 :returns: reply from the API
3247 self.papi.ipsec_spd_add_del_entry,
3249 'local_address_start': local_address_start,
3250 'local_address_stop': local_address_stop,
3251 'remote_address_start': remote_address_start,
3252 'remote_address_stop': remote_address_stop,
3253 'local_port_start': local_port_start,
3254 'local_port_stop': local_port_stop,
3255 'remote_port_start': remote_port_start,
3256 'remote_port_stop': remote_port_stop,
3258 'protocol': protocol,
3260 'priority': priority,
3261 'is_outbound': is_outbound,
3263 'is_ip_any': is_ip_any})
3265 def app_namespace_add(self,
3269 sw_if_index=0xFFFFFFFF,
3272 self.papi.app_namespace_add_del,
3274 'sw_if_index': sw_if_index,
3275 'ip4_fib_id': ip4_fib_id,
3276 'ip6_fib_id': ip6_fib_id,
3277 'namespace_id': namespace_id,
3278 'namespace_id_len': len(namespace_id)})
3280 def punt_socket_register(self, l4_port, pathname, header_version=1,
3281 is_ip4=1, l4_protocol=0x11):
3282 """ Punt to socket """
3283 return self.api(self.papi.punt_socket_register,
3285 'l4_protocol': l4_protocol,
3287 'pathname': pathname,
3288 'header_version': header_version})
3290 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3291 expire_walk_interval_ms, is_ip6=0):
3292 """ Set IP reassembly parameters """
3293 return self.api(self.papi.ip_reassembly_set,
3295 'timeout_ms': timeout_ms,
3296 'expire_walk_interval_ms': expire_walk_interval_ms,
3297 'max_reassemblies': max_reassemblies})
3299 def ip_reassembly_get(self, is_ip6=0):
3300 """ Get IP reassembly parameters """
3301 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3303 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3305 """ Enable/disable IP reassembly """
3306 return self.api(self.papi.ip_reassembly_enable_disable,
3307 {'sw_if_index': sw_if_index,
3308 'enable_ip4': 1 if enable_ip4 else 0,
3309 'enable_ip6': 1 if enable_ip6 else 0,
3312 def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
3313 """ GBP endpoint Add/Del """
3314 return self.api(self.papi.gbp_endpoint_add_del,
3318 'sw_if_index': sw_if_index,
3322 def gbp_endpoint_dump(self):
3323 """ GBP endpoint Dump """
3324 return self.api(self.papi.gbp_endpoint_dump, {})
3326 def gbp_endpoint_group_add_del(self, is_add, epg, bd,
3329 uplink_sw_if_index):
3330 """ GBP endpoint group Add/Del """
3331 return self.api(self.papi.gbp_endpoint_group_add_del,
3334 'uplink_sw_if_index': uplink_sw_if_index,
3336 'ip4_table_id': ip4_rd,
3337 'ip6_table_id': ip6_rd,
3340 def gbp_endpoint_group_dump(self):
3341 """ GBP endpoint group Dump """
3342 return self.api(self.papi.gbp_endpoint_group_dump, {})
3344 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3345 """ GBP recirc Add/Del """
3346 return self.api(self.papi.gbp_recirc_add_del,
3350 'sw_if_index': sw_if_index,
3353 def gbp_recirc_dump(self):
3354 """ GBP recirc Dump """
3355 return self.api(self.papi.gbp_recirc_dump, {})
3357 def gbp_subnet_add_del(self, is_add, table_id,
3360 sw_if_index=0xffffffff,
3363 """ GBP Subnet Add/Del """
3364 return self.api(self.papi.gbp_subnet_add_del,
3367 'is_internal': is_internal,
3369 'sw_if_index': sw_if_index,
3372 'address_length': addr_len,
3373 'table_id': table_id}})
3375 def gbp_subnet_dump(self):
3376 """ GBP Subnet Dump """
3377 return self.api(self.papi.gbp_subnet_dump, {})
3379 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3380 """ GBP contract Add/Del """
3381 return self.api(self.papi.gbp_contract_add_del,
3384 'acl_index': acl_index,
3386 'dst_epg': dst_epg}})
3388 def gbp_contract_dump(self):
3389 """ GBP contract Dump """
3390 return self.api(self.papi.gbp_contract_dump, {})
3392 def ipip_6rd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len,
3393 ip4_prefix, ip4_prefix_len, ip4_src,
3395 """ 6RD tunnel Add """
3396 return self.api(self.papi.ipip_6rd_add_tunnel,
3397 {'fib_index': fib_index,
3398 'ip6_prefix': ip6_prefix,
3399 'ip6_prefix_len': ip6_prefix_len,
3400 'ip4_prefix': ip4_prefix,
3401 'ip4_prefix_len': ip4_prefix_len,
3403 'security_check': security_check})
3405 def ipip_6rd_del_tunnel(self, sw_if_index):
3406 """ 6RD tunnel Delete """
3407 return self.api(self.papi.ipip_6rd_del_tunnel,
3408 {'sw_if_index': sw_if_index})
3410 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3411 instance=0xFFFFFFFF, fib_index=0, tc_tos=0):
3412 """ IPIP tunnel Add/Del """
3413 return self.api(self.papi.ipip_add_tunnel,
3414 {'is_ipv6': is_ipv6,
3415 'instance': instance,
3416 'src_address': src_address,
3417 'dst_address': dst_address,
3418 'fib_index': fib_index,
3421 def ipip_del_tunnel(self, sw_if_index):
3422 """ IPIP tunnel Delete """
3423 return self.api(self.papi.ipip_del_tunnel,
3424 {'sw_if_index': sw_if_index})
3426 def qos_egress_map_update(self, id, outputs):
3427 """ QOS egress map update """
3428 return self.api(self.papi.qos_egress_map_update,
3432 def qos_egress_map_delete(self, id):
3433 """ QOS egress map delete """
3434 return self.api(self.papi.qos_egress_map_delete,
3437 def qos_mark_enable_disable(self, sw_if_index,
3441 """ QOS Mark Enable/Disable """
3442 return self.api(self.papi.qos_mark_enable_disable,
3444 'sw_if_index': sw_if_index,
3445 'output_source': output_source,
3448 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3449 """ IP QoS recording Enble/Disable """
3450 return self.api(self.papi.qos_record_enable_disable,
3451 {'sw_if_index': sw_if_index,
3452 'input_source': input_source,
3455 def igmp_listen(self, enable, sw_if_index, saddr, gaddr):
3456 """ Listen for new (S,G) on specified interface
3458 :param enable: add/del
3459 :param sw_if_index: interface sw index
3460 :param saddr: source ip4 addr
3461 :param gaddr: group ip4 addr
3463 return self.api(self.papi.igmp_listen,
3465 'sw_if_index': sw_if_index,
3469 def igmp_dump(self, sw_if_index=None):
3470 """ Dump all (S,G) interface configurations """
3471 if sw_if_index is None:
3476 return self.api(self.papi.igmp_dump, {'sw_if_index': sw_if_index,
3477 'dump_all': dump_all})
3479 def igmp_clear_interface(self, sw_if_index):
3480 """ Remove all (S,G)s from specified interface
3481 doesn't send IGMP report!
3484 self.papi.igmp_clear_interface, {
3485 'sw_if_index': sw_if_index})
3487 def want_igmp_events(self, enable=1):
3488 return self.api(self.papi.want_igmp_events, {'enable': enable,
3489 'pid': os.getpid()})
3499 :param lb: load balance
3500 :param use_custom_mac: use custom mac
3501 :param mac_address: mac address
3504 self.papi.bond_create,
3507 'use_custom_mac': use_custom_mac,
3508 'mac_address': mac_address
3515 :param sw_if_index: interface the operation is applied to
3517 return self.api(self.papi.bond_delete,
3518 {'sw_if_index': sw_if_index})
3527 :param sw_if_index: slave sw_if_index
3528 :param bond_sw_if_index: bond sw_if_index
3529 :param is_passive: is passive lacp speaker
3530 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3533 self.papi.bond_enslave,
3534 {'sw_if_index': sw_if_index,
3535 'bond_sw_if_index': bond_sw_if_index,
3536 'is_passive': is_passive,
3537 'is_long_timeout': is_long_timeout
3540 def bond_detach_slave(
3544 :param sw_if_index: slave interface the operation is applied to
3546 return self.api(self.papi.bond_detach_slave,
3547 {'sw_if_index': sw_if_index})
3549 def sw_interface_slave_dump(
3553 :param sw_if_index: bond sw_if_index
3555 return self.api(self.papi.sw_interface_slave_dump,
3556 {'sw_if_index': sw_if_index})
3558 def sw_interface_bond_dump(
3563 return self.api(self.papi.sw_interface_bond_dump,
3566 def create_vhost_user_if(
3571 custom_dev_instance,
3576 :param is_server: is server
3577 :param sock_filename: socket name
3578 :param renumber: renumber
3579 :param custom_dev_instance: custom dev instance
3580 :param use_custom_mac: use custom mac
3581 :param mac_address: mac address
3582 :param tag: tag (default ''
3585 self.papi.create_vhost_user_if,
3586 {'is_server': is_server,
3587 'sock_filename': sock_filename,
3588 'renumber': renumber,
3589 'custom_dev_instance': custom_dev_instance,
3590 'use_custom_mac': use_custom_mac,
3591 'mac_address': mac_address,
3595 def delete_vhost_user_if(
3599 :param sw_if_index: interface the operation is applied to
3601 return self.api(self.papi.delete_vhost_user_if,
3602 {'sw_if_index': sw_if_index, })
3604 def sw_interface_vhost_user_dump(
3609 return self.api(self.papi.sw_interface_vhost_user_dump,
3612 def abf_policy_add_del(self, is_add, policy):
3614 self.papi.abf_policy_add_del,
3618 def abf_itf_attach_add_del(self, is_add, attach):
3620 self.papi.abf_itf_attach_add_del,
3624 def abf_policy_dump(self):
3626 self.papi.abf_policy_dump, {})
3628 def abf_itf_attach_dump(self):
3630 self.papi.abf_itf_attach_dump, {})