5 from collections import deque
7 # Sphinx creates auto-generated documentation by importing the python source
8 # files and collecting the docstrings from them. The NO_VPP_PAPI flag allows
9 # the vpp_papi_provider.py file to be importable without having to build
10 # the whole vpp api if the user only wishes to generate the test documentation.
13 no_vpp_papi = os.getenv("NO_VPP_PAPI")
14 if no_vpp_papi == "1":
20 from vpp_papi import VPP
22 # from vnet/vnet/mpls/mpls_types.h
23 MPLS_IETF_MAX_LABEL = 0xfffff
24 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
46 class UnexpectedApiReturnValueError(Exception):
47 """ exception raised when the API return value is unexpected """
51 class VppPapiProvider(object):
52 """VPP-api provider using vpp-papi
54 @property hook: hook object providing before and after api/cli hooks
57 _zero, _negative = range(2)
59 def __init__(self, name, shm_prefix, test_class):
60 self.hook = Hook("vpp-papi-provider")
62 self.shm_prefix = shm_prefix
63 self.test_class = test_class
64 self._expect_api_retval = self._zero
65 self._expect_stack = []
68 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
69 for root, dirnames, filenames in os.walk(install_dir):
70 for filename in fnmatch.filter(filenames, '*.api.json'):
71 jsonfiles.append(os.path.join(root, filename))
73 self.vpp = VPP(jsonfiles, logger=test_class.logger)
74 self._events = deque()
79 def expect_negative_api_retval(self):
80 """ Expect API failure """
81 self._expect_stack.append(self._expect_api_retval)
82 self._expect_api_retval = self._negative
85 def expect_zero_api_retval(self):
86 """ Expect API success """
87 self._expect_stack.append(self._expect_api_retval)
88 self._expect_api_retval = self._zero
91 def __exit__(self, exc_type, exc_value, traceback):
92 self._expect_api_retval = self._expect_stack.pop()
94 def register_hook(self, hook):
95 """Replace hook registration with new hook
102 def collect_events(self):
103 """ Collect all events from the internal queue and clear the queue. """
105 self._events = deque()
108 def wait_for_event(self, timeout, name=None):
109 """ Wait for and return next event. """
111 self.test_class.logger.debug("Expecting event '%s' within %ss",
114 self.test_class.logger.debug("Expecting event within %ss",
117 self.test_class.logger.debug("Not waiting, event already queued")
118 limit = time.time() + timeout
119 while time.time() < limit:
121 e = self._events.popleft()
122 if name and type(e).__name__ != name:
124 "Unexpected event received: %s, expected: %s" %
125 (type(e).__name__, name))
126 self.test_class.logger.debug("Returning event %s:%s" %
129 time.sleep(0) # yield
130 raise Exception("Event did not occur within timeout")
132 def __call__(self, name, event):
133 """ Enqueue event in the internal event queue. """
134 # FIXME use the name instead of relying on type(e).__name__ ?
135 # FIXME #2 if this throws, it is eaten silently, Ole?
136 self.test_class.logger.debug("New event: %s: %s" % (name, event))
137 self._events.append(event)
140 """Connect the API to VPP"""
141 self.vpp.connect(self.name, self.shm_prefix)
142 self.papi = self.vpp.api
143 self.vpp.register_event_callback(self)
145 def disconnect(self):
146 """Disconnect the API from VPP"""
147 self.vpp.disconnect()
149 def api(self, api_fn, api_args, expected_retval=0):
150 """ Call API function and check it's return value.
151 Call the appropriate hooks before and after the API call
153 :param api_fn: API function to call
154 :param api_args: tuple of API function arguments
155 :param expected_retval: Expected return value (Default value = 0)
156 :returns: reply from the API
159 self.hook.before_api(api_fn.__name__, api_args)
160 reply = api_fn(**api_args)
161 if self._expect_api_retval == self._negative:
162 if hasattr(reply, 'retval') and reply.retval >= 0:
163 msg = "API call passed unexpectedly: expected negative "\
164 "return value instead of %d in %s" % \
165 (reply.retval, repr(reply))
166 self.test_class.logger.info(msg)
167 raise UnexpectedApiReturnValueError(msg)
168 elif self._expect_api_retval == self._zero:
169 if hasattr(reply, 'retval') and reply.retval != expected_retval:
170 msg = "API call failed, expected %d return value instead "\
171 "of %d in %s" % (expected_retval, reply.retval,
173 self.test_class.logger.info(msg)
174 raise UnexpectedApiReturnValueError(msg)
176 raise Exception("Internal error, unexpected value for "
177 "self._expect_api_retval %s" %
178 self._expect_api_retval)
179 self.hook.after_api(api_fn.__name__, api_args)
183 """ Execute a CLI, calling the before/after hooks appropriately.
185 :param cli: CLI to execute
189 self.hook.before_cli(cli)
191 r = self.papi.cli_inband(length=len(cli), cmd=cli)
192 self.hook.after_cli(cli)
193 if hasattr(r, 'reply'):
194 return r.reply.decode().rstrip('\x00')
196 def ppcli(self, cli):
197 """ Helper method to print CLI command in case of info logging level.
199 :param cli: CLI to execute
202 return cli + "\n" + str(self.cli(cli))
204 def _convert_mac(self, mac):
205 return mac.replace(':', '').decode('hex')
207 def show_version(self):
209 return self.api(self.papi.show_version, {})
211 def pg_create_interface(self, pg_index):
217 return self.api(self.papi.pg_create_interface,
218 {"interface_id": pg_index})
220 def sw_interface_dump(self, filter=None):
223 :param filter: (Default value = None)
226 if filter is not None:
227 args = {"name_filter_valid": 1, "name_filter": filter}
230 return self.api(self.papi.sw_interface_dump, args)
232 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
233 """ Set the IPvX Table-id for the Interface
240 return self.api(self.papi.sw_interface_set_table,
241 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
244 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
245 is_ipv6=0, is_add=1, del_all=0):
248 :param addr: param is_ipv6: (Default value = 0)
251 :param is_ipv6: (Default value = 0)
252 :param is_add: (Default value = 1)
253 :param del_all: (Default value = 0)
256 return self.api(self.papi.sw_interface_add_del_address,
257 {'sw_if_index': sw_if_index,
261 'address_length': addr_len,
264 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
266 """ Set the Interface to be unnumbered
268 :param is_add: (Default value = 1)
269 :param sw_if_index - interface That will be unnumbered
270 :param ip_sw_if_index - interface with an IP addres
273 return self.api(self.papi.sw_interface_set_unnumbered,
274 {'sw_if_index': ip_sw_if_index,
275 'unnumbered_sw_if_index': sw_if_index,
278 def sw_interface_enable_disable_mpls(self, sw_if_index,
281 Enable/Disable MPLS on the interface
283 :param is_enable: (Default value = 1)
286 return self.api(self.papi.sw_interface_set_mpls_enable,
287 {'sw_if_index': sw_if_index,
288 'enable': is_enable})
290 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
291 return self.api(self.papi.sw_interface_ip6nd_ra_config,
292 {'sw_if_index': sw_if_index,
293 'suppress': suppress})
295 def set_ip_flow_hash(self,
304 return self.api(self.papi.set_ip_flow_hash,
314 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
315 return self.api(self.papi.ip6nd_proxy_add_del,
317 'sw_if_index': sw_if_index,
320 def ip6_sw_interface_ra_config(self, sw_if_index,
324 return self.api(self.papi.sw_interface_ip6nd_ra_config,
325 {'sw_if_index': sw_if_index,
327 'suppress': suppress,
328 'send_unicast': send_unicast})
330 def ip6_sw_interface_ra_prefix(self,
340 val_lifetime=0xffffffff,
341 pref_lifetime=0xffffffff):
342 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
343 {'sw_if_index': sw_if_index,
345 'address_length': address_length,
346 'use_default': use_default,
347 'no_advertise': no_advertise,
348 'off_link': off_link,
349 'no_autoconfig': no_autoconfig,
350 'no_onlink': no_onlink,
352 'val_lifetime': val_lifetime,
353 'pref_lifetime': pref_lifetime})
355 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
357 Enable/Disable An interface for IPv6
359 return self.api(self.papi.sw_interface_ip6_enable_disable,
360 {'sw_if_index': sw_if_index,
363 def vxlan_add_del_tunnel(
367 mcast_sw_if_index=0xFFFFFFFF,
371 decap_next_index=0xFFFFFFFF,
373 instance=0xFFFFFFFF):
378 :param is_add: (Default value = 1)
379 :param is_ipv6: (Default value = 0)
380 :param encap_vrf_id: (Default value = 0)
381 :param decap_next_index: (Default value = 0xFFFFFFFF)
382 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
383 :param vni: (Default value = 0)
384 :param instance: (Default value = 0xFFFFFFFF)
387 return self.api(self.papi.vxlan_add_del_tunnel,
390 'src_address': src_addr,
391 'dst_address': dst_addr,
392 'mcast_sw_if_index': mcast_sw_if_index,
393 'encap_vrf_id': encap_vrf_id,
394 'decap_next_index': decap_next_index,
396 'instance': instance})
398 def geneve_add_del_tunnel(
402 mcast_sw_if_index=0xFFFFFFFF,
406 decap_next_index=0xFFFFFFFF,
412 :param is_add: (Default value = 1)
413 :param is_ipv6: (Default value = 0)
414 :param encap_vrf_id: (Default value = 0)
415 :param decap_next_index: (Default value = 0xFFFFFFFF)
416 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
417 :param vni: (Default value = 0)
420 return self.api(self.papi.geneve_add_del_tunnel,
423 'local_address': local_addr,
424 'remote_address': remote_addr,
425 'mcast_sw_if_index': mcast_sw_if_index,
426 'encap_vrf_id': encap_vrf_id,
427 'decap_next_index': decap_next_index,
430 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
431 learn=1, arp_term=0, is_add=1):
432 """Create/delete bridge domain.
434 :param int bd_id: Bridge domain index.
435 :param int flood: Enable/disable bcast/mcast flooding in the BD.
437 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
439 :param int forward: Enable/disable forwarding on all interfaces in
440 the BD. (Default value = 1)
441 :param int learn: Enable/disable learning on all interfaces in the BD.
443 :param int arp_term: Enable/disable arp termination in the BD.
445 :param int is_add: Add or delete flag. (Default value = 1)
447 return self.api(self.papi.bridge_domain_add_del,
450 'uu_flood': uu_flood,
453 'arp_term': arp_term,
456 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
457 return self.api(self.papi.bd_ip_mac_add_del,
464 def want_ip4_arp_events(self, enable_disable=1, address=0):
465 return self.api(self.papi.want_ip4_arp_events,
466 {'enable_disable': enable_disable,
468 'pid': os.getpid(), })
470 def want_ip6_nd_events(self, enable_disable=1, address=0):
471 return self.api(self.papi.want_ip6_nd_events,
472 {'enable_disable': enable_disable,
474 'pid': os.getpid(), })
476 def want_ip6_ra_events(self, enable_disable=1):
477 return self.api(self.papi.want_ip6_ra_events,
478 {'enable_disable': enable_disable,
479 'pid': os.getpid(), })
481 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
483 return self.api(self.papi.ip6nd_send_router_solicitation,
488 'sw_if_index': sw_if_index})
490 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
491 install_default_routes):
492 return self.api(self.papi.ip6_nd_address_autoconfig,
493 {'sw_if_index': sw_if_index,
495 'install_default_routes': install_default_routes})
497 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
498 max_macs_in_event=0, learn_limit=0):
499 return self.api(self.papi.want_l2_macs_events,
500 {'enable_disable': enable_disable,
501 'scan_delay': scan_delay,
502 'max_macs_in_event': max_macs_in_event,
503 'learn_limit': learn_limit,
504 'pid': os.getpid(), })
506 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
507 filter_mac=0, bvi_mac=0):
508 """Create/delete L2 FIB entry.
510 :param str mac: MAC address to create FIB entry for.
511 :param int bd_id: Bridge domain index.
512 :param int sw_if_index: Software interface index of the interface.
513 :param int is_add: Add or delete flag. (Default value = 1)
514 :param int static_mac: Set to 1 to create static MAC entry.
516 :param int filter_mac: Set to 1 to drop packet that's source or
517 destination MAC address contains defined MAC address.
519 :param int bvi_mac: Set to 1 to create entry that points to BVI
520 interface. (Default value = 0)
522 return self.api(self.papi.l2fib_add_del,
523 {'mac': self._convert_mac(mac),
525 'sw_if_index': sw_if_index,
527 'static_mac': static_mac,
528 'filter_mac': filter_mac,
531 def l2fib_flush_int(self, sw_if_index):
532 """Flush L2 FIB entries for sw_if_index.
534 :param int sw_if_index: Software interface index of the interface.
536 return self.api(self.papi.l2fib_flush_int,
537 {'sw_if_index': sw_if_index})
539 def l2fib_flush_bd(self, bd_id):
540 """Flush L2 FIB entries for bd_id.
542 :param int sw_if_index: Bridge Domain id.
544 return self.api(self.papi.l2fib_flush_bd,
547 def l2fib_flush_all(self):
550 return self.api(self.papi.l2fib_flush_all, {})
552 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
553 shg=0, bvi=0, enable=1):
554 """Add/remove interface to/from bridge domain.
556 :param int sw_if_index: Software interface index of the interface.
557 :param int bd_id: Bridge domain index.
558 :param int shg: Split-horizon group index. (Default value = 0)
559 :param int bvi: Set interface as a bridge group virtual interface.
561 :param int enable: Add or remove interface. (Default value = 1)
563 return self.api(self.papi.sw_interface_set_l2_bridge,
564 {'rx_sw_if_index': sw_if_index,
570 def bridge_flags(self, bd_id, is_set, feature_bitmap):
571 """Enable/disable required feature of the bridge domain with defined
574 :param int bd_id: Bridge domain ID.
575 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
576 :param int feature_bitmap: Bitmap value of the feature to be set:
580 - uu-flood (1 << 3) or
583 return self.api(self.papi.bridge_flags,
586 'feature_bitmap': feature_bitmap})
588 def bridge_domain_dump(self, bd_id=0):
591 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
592 existing bridge domains returned)
593 :return: Dictionary of bridge domain(s) data.
595 return self.api(self.papi.bridge_domain_dump,
598 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
600 """Create or delete unidirectional cross-connect from Tx interface to
603 :param int rx_sw_if_index: Software interface index of Rx interface.
604 :param int tx_sw_if_index: Software interface index of Tx interface.
605 :param int enable: Create cross-connect if equal to 1, delete
606 cross-connect if equal to 0.
609 return self.api(self.papi.sw_interface_set_l2_xconnect,
610 {'rx_sw_if_index': rx_sw_if_index,
611 'tx_sw_if_index': tx_sw_if_index,
614 def sw_interface_set_l2_tag_rewrite(
621 """L2 interface vlan tag rewrite configure request
622 :param client_index - opaque cookie to identify the sender
623 :param context - sender context, to match reply w/ request
624 :param sw_if_index - interface the operation is applied to
625 :param vtr_op - Choose from l2_vtr_op_t enum values
626 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
627 :param tag1 - Needed for any push or translate vtr op
628 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
631 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
632 {'sw_if_index': sw_if_index,
638 def sw_interface_set_l2_emulation(
643 :param sw_if_index - interface the operation is applied to
646 return self.api(self.papi.l2_emulation,
647 {'sw_if_index': sw_if_index,
650 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
653 :param admin_up_down:
657 return self.api(self.papi.sw_interface_set_flags,
658 {'sw_if_index': sw_if_index,
659 'admin_up_down': admin_up_down})
661 def sw_interface_set_mtu(self, sw_if_index, mtu):
667 return self.api(self.papi.sw_interface_set_mtu,
668 {'sw_if_index': sw_if_index,
671 def sw_interface_set_promiscuous(self, sw_if_index, enable):
677 return self.api(self.papi.sw_interface_set_promiscuous,
678 {'sw_if_index': sw_if_index,
681 def sw_interface_set_mac_address(self, sw_if_index, mac):
682 return self.api(self.papi.sw_interface_set_mac_address,
683 {'sw_if_index': sw_if_index,
686 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
687 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
688 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
689 """Create subinterface
690 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
692 :param sub_id: param inner_vlan:
696 :param no_tags: (Default value = 0)
697 :param one_tag: (Default value = 0)
698 :param two_tags: (Default value = 0)
699 :param dot1ad: (Default value = 0)
700 :param exact_match: (Default value = 0)
701 :param default_sub: (Default value = 0)
702 :param outer_vlan_id_any: (Default value = 0)
703 :param inner_vlan_id_any: (Default value = 0)
707 self.papi.create_subif,
708 {'sw_if_index': sw_if_index,
712 'two_tags': two_tags,
714 'exact_match': exact_match,
715 'default_sub': default_sub,
716 'outer_vlan_id_any': outer_vlan_id_any,
717 'inner_vlan_id_any': inner_vlan_id_any,
718 'outer_vlan_id': outer_vlan,
719 'inner_vlan_id': inner_vlan})
721 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
722 """Create p2p ethernet subinterface
724 :param sw_if_index: main (parent) interface
725 :param remote_mac: client (remote) mac address
729 self.papi.p2p_ethernet_add,
730 {'parent_if_index': sw_if_index,
731 'remote_mac': remote_mac,
732 'subif_id': subif_id})
734 def delete_subif(self, sw_if_index):
735 """Delete subinterface
739 return self.api(self.papi.delete_subif,
740 {'sw_if_index': sw_if_index})
742 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
743 """Delete p2p ethernet subinterface
745 :param sw_if_index: main (parent) interface
746 :param remote_mac: client (remote) mac address
750 self.papi.p2p_ethernet_del,
751 {'parent_if_index': sw_if_index,
752 'remote_mac': remote_mac})
754 def create_vlan_subif(self, sw_if_index, vlan):
761 return self.api(self.papi.create_vlan_subif,
762 {'sw_if_index': sw_if_index,
765 def create_loopback(self, mac=''):
768 :param mac: (Optional)
770 return self.api(self.papi.create_loopback,
771 {'mac_address': mac})
773 def delete_loopback(self, sw_if_index):
774 return self.api(self.papi.delete_loopback,
775 {'sw_if_index': sw_if_index, })
777 def ip_table_add_del(self,
784 :param is_add: (Default value = 1)
785 :param is_ipv6: (Default value = 0)
790 self.papi.ip_table_add_del,
791 {'table_id': table_id,
795 def ip_add_del_route(
800 next_hop_sw_if_index=0xFFFFFFFF,
804 next_hop_n_out_labels=0,
805 next_hop_out_label_stack=[],
806 next_hop_via_label=MPLS_LABEL_INVALID,
807 next_hop_id=0xFFFFFFFF,
809 is_resolve_attached=0,
810 classify_table_index=0xFFFFFFFF,
824 :param dst_address_length:
825 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
827 :param next_hop_address:
828 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
829 :param vrf_id: (Default value = 0)
830 :param lookup_in_vrf: (Default value = 0)
831 :param classify_table_index: (Default value = 0xFFFFFFFF)
832 :param is_add: (Default value = 1)
833 :param is_drop: (Default value = 0)
834 :param is_ipv6: (Default value = 0)
835 :param is_local: (Default value = 0)
836 :param is_classify: (Default value = 0)
837 :param is_multipath: (Default value = 0)
838 :param is_resolve_host: (Default value = 0)
839 :param is_resolve_attached: (Default value = 0)
840 :param is_dvr: (Default value = 0)
841 :param is_source_lookup: (Default value = 0)
842 :param next_hop_weight: (Default value = 1)
847 self.papi.ip_add_del_route,
848 {'next_hop_sw_if_index': next_hop_sw_if_index,
849 'table_id': table_id,
850 'classify_table_index': classify_table_index,
851 'next_hop_table_id': next_hop_table_id,
854 'is_unreach': is_unreach,
855 'is_prohibit': is_prohibit,
857 'is_local': is_local,
858 'is_classify': is_classify,
859 'is_multipath': is_multipath,
860 'is_resolve_host': is_resolve_host,
861 'is_resolve_attached': is_resolve_attached,
863 'is_source_lookup': is_source_lookup,
864 'is_udp_encap': is_udp_encap,
865 'next_hop_weight': next_hop_weight,
866 'dst_address_length': dst_address_length,
867 'dst_address': dst_address,
868 'next_hop_id': next_hop_id,
869 'next_hop_address': next_hop_address,
870 'next_hop_n_out_labels': next_hop_n_out_labels,
871 'next_hop_via_label': next_hop_via_label,
872 'next_hop_out_label_stack': next_hop_out_label_stack})
874 def ip_fib_dump(self):
875 return self.api(self.papi.ip_fib_dump, {})
877 def ip6_fib_dump(self):
878 return self.api(self.papi.ip6_fib_dump, {})
880 def ip_neighbor_add_del(self,
889 """ Add neighbor MAC to IPv4 or IPv6 address.
894 :param is_add: (Default value = 1)
895 :param is_ipv6: (Default value = 0)
896 :param is_static: (Default value = 0)
897 :param is_no_adj_fib: (Default value = 0)
901 self.papi.ip_neighbor_add_del,
902 {'sw_if_index': sw_if_index,
905 'is_static': is_static,
906 'is_no_adj_fib': is_no_adj_fib,
907 'mac_address': mac_address,
908 'dst_address': dst_address
912 def ip_neighbor_dump(self,
915 """ Return IP neighbor dump.
918 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
922 self.papi.ip_neighbor_dump,
924 'sw_if_index': sw_if_index
928 def proxy_arp_add_del(self,
933 """ Config Proxy Arp Range.
935 :param low_address: Start address in the rnage to Proxy for
936 :param hi_address: End address in the rnage to Proxy for
937 :param vrf_id: The VRF/table in which to proxy
941 self.papi.proxy_arp_add_del,
944 'low_address': low_address,
945 'hi_address': hi_address,
949 def proxy_arp_intfc_enable_disable(self,
952 """ Enable/Disable an interface for proxy ARP requests
954 :param sw_if_index: Interface
955 :param enable_disable: Enable/Disable
959 self.papi.proxy_arp_intfc_enable_disable,
960 {'sw_if_index': sw_if_index,
961 'enable_disable': is_enable
969 """ Reset VRF (remove all routes etc.) request.
971 :param int vrf_id: ID of the FIB table / VRF to reset.
972 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
986 """ Reset VRF (remove all routes etc.) request.
988 :param int vrf_id: ID of the FIB table / VRF to reset.
989 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1004 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1009 {'is_ipv6': is_ipv6,
1013 def sw_interface_span_enable_disable(
1014 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1017 :param sw_if_index_from:
1018 :param sw_if_index_to:
1022 return self.api(self.papi.sw_interface_span_enable_disable,
1023 {'sw_if_index_from': sw_if_index_from,
1024 'sw_if_index_to': sw_if_index_to,
1029 def gre_tunnel_add_del(self,
1034 instance=0xFFFFFFFF,
1038 """ Add a GRE tunnel
1042 :param outer_fib_id: (Default value = 0)
1043 :param tunnel_type: (Default value = 0)
1044 :param instance: (Default value = 0xFFFFFFFF)
1045 :param session_id: (Defalt value = 0)
1046 :param is_add: (Default value = 1)
1047 :param is_ipv6: (Default value = 0)
1051 self.papi.gre_add_del_tunnel,
1054 'tunnel_type': tunnel_type,
1055 'instance': instance,
1056 'src_address': src_address,
1057 'dst_address': dst_address,
1058 'outer_fib_id': outer_fib_id,
1059 'session_id': session_id}
1062 def udp_encap_add_del(self,
1071 """ Add a GRE tunnel
1072 :param id: user provided ID
1077 :param outer_fib_id: (Default value = 0)
1078 :param is_add: (Default value = 1)
1079 :param is_ipv6: (Default value = 0)
1083 self.papi.udp_encap_add_del,
1089 'src_port': src_port,
1090 'dst_port': dst_port,
1091 'table_id': table_id}
1094 def udp_encap_dump(self):
1095 return self.api(self.papi.udp_encap_dump, {})
1097 def want_udp_encap_stats(self, enable=1):
1098 return self.api(self.papi.want_udp_encap_stats,
1100 'pid': os.getpid()})
1102 def mpls_fib_dump(self):
1103 return self.api(self.papi.mpls_fib_dump, {})
1105 def mpls_table_add_del(
1112 :param is_add: (Default value = 1)
1117 self.papi.mpls_table_add_del,
1118 {'mt_table_id': table_id,
1119 'mt_is_add': is_add})
1121 def mpls_route_add_del(
1127 next_hop_sw_if_index=0xFFFFFFFF,
1129 next_hop_table_id=0,
1131 next_hop_n_out_labels=0,
1132 next_hop_out_label_stack=[],
1133 next_hop_via_label=MPLS_LABEL_INVALID,
1135 is_resolve_attached=0,
1142 classify_table_index=0xFFFFFFFF,
1146 :param dst_address_length:
1147 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1149 :param next_hop_address:
1150 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1151 :param vrf_id: (Default value = 0)
1152 :param lookup_in_vrf: (Default value = 0)
1153 :param classify_table_index: (Default value = 0xFFFFFFFF)
1154 :param is_add: (Default value = 1)
1155 :param is_drop: (Default value = 0)
1156 :param is_ipv6: (Default value = 0)
1157 :param is_local: (Default value = 0)
1158 :param is_classify: (Default value = 0)
1159 :param is_multipath: (Default value = 0)
1160 :param is_multicast: (Default value = 0)
1161 :param is_resolve_host: (Default value = 0)
1162 :param is_resolve_attached: (Default value = 0)
1163 :param next_hop_weight: (Default value = 1)
1167 self.papi.mpls_route_add_del,
1170 'mr_table_id': table_id,
1171 'mr_classify_table_index': classify_table_index,
1172 'mr_is_add': is_add,
1173 'mr_is_classify': is_classify,
1174 'mr_is_multipath': is_multipath,
1175 'mr_is_multicast': is_multicast,
1176 'mr_is_resolve_host': is_resolve_host,
1177 'mr_is_resolve_attached': is_resolve_attached,
1178 'mr_is_interface_rx': is_interface_rx,
1179 'mr_is_rpf_id': is_rpf_id,
1180 'mr_next_hop_proto': next_hop_proto,
1181 'mr_next_hop_weight': next_hop_weight,
1182 'mr_next_hop': next_hop_address,
1183 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1184 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1185 'mr_next_hop_table_id': next_hop_table_id,
1186 'mr_next_hop_via_label': next_hop_via_label,
1187 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1189 def mpls_ip_bind_unbind(
1201 self.papi.mpls_ip_bind_unbind,
1202 {'mb_mpls_table_id': table_id,
1204 'mb_ip_table_id': ip_table_id,
1205 'mb_is_bind': is_bind,
1206 'mb_is_ip4': is_ip4,
1207 'mb_address_length': dst_address_length,
1208 'mb_address': dst_address})
1210 def mpls_tunnel_add_del(
1213 next_hop_proto_is_ip4,
1215 next_hop_sw_if_index=0xFFFFFFFF,
1216 next_hop_table_id=0,
1218 next_hop_n_out_labels=0,
1219 next_hop_out_label_stack=[],
1220 next_hop_via_label=MPLS_LABEL_INVALID,
1226 :param dst_address_length:
1227 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1229 :param next_hop_address:
1230 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1231 :param vrf_id: (Default value = 0)
1232 :param lookup_in_vrf: (Default value = 0)
1233 :param classify_table_index: (Default value = 0xFFFFFFFF)
1234 :param is_add: (Default value = 1)
1235 :param is_drop: (Default value = 0)
1236 :param is_ipv6: (Default value = 0)
1237 :param is_local: (Default value = 0)
1238 :param is_classify: (Default value = 0)
1239 :param is_multipath: (Default value = 0)
1240 :param is_resolve_host: (Default value = 0)
1241 :param is_resolve_attached: (Default value = 0)
1242 :param next_hop_weight: (Default value = 1)
1243 :param is_multicast: (Default value = 0)
1247 self.papi.mpls_tunnel_add_del,
1248 {'mt_sw_if_index': tun_sw_if_index,
1249 'mt_is_add': is_add,
1250 'mt_l2_only': l2_only,
1251 'mt_is_multicast': is_multicast,
1252 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1253 'mt_next_hop_weight': next_hop_weight,
1254 'mt_next_hop': next_hop_address,
1255 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1256 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1257 'mt_next_hop_table_id': next_hop_table_id,
1258 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1260 def nat44_interface_add_del_feature(
1265 """Enable/disable NAT44 feature on the interface
1267 :param sw_if_index: Software index of the interface
1268 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1269 :param is_add: 1 if add, 0 if delete (Default value = 1)
1272 self.papi.nat44_interface_add_del_feature,
1274 'is_inside': is_inside,
1275 'sw_if_index': sw_if_index})
1277 def nat44_interface_add_del_output_feature(
1282 """Enable/disable NAT44 output feature on the interface
1284 :param sw_if_index: Software index of the interface
1285 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1286 :param is_add: 1 if add, 0 if delete (Default value = 1)
1289 self.papi.nat44_interface_add_del_output_feature,
1291 'is_inside': is_inside,
1292 'sw_if_index': sw_if_index})
1294 def nat44_add_del_static_mapping(
1298 external_sw_if_index=0xFFFFFFFF,
1309 """Add/delete NAT44 static mapping
1311 :param local_ip: Local IP address
1312 :param external_ip: External IP address
1313 :param external_sw_if_index: External interface instead of IP address
1314 :param local_port: Local port number (Default value = 0)
1315 :param external_port: External port number (Default value = 0)
1316 :param addr_only: 1 if address only mapping, 0 if address and port
1317 :param vrf_id: VRF ID
1318 :param protocol: IP protocol (Default value = 0)
1319 :param twice_nat: 1 if translate external host address and port
1320 :param self_twice_nat: 1 if translate external host address and port
1321 whenever external host address equals
1322 local address of internal host
1323 :param out2in_only: if 1 rule is matching only out2in direction
1324 :param tag: Opaque string tag
1325 :param is_add: 1 if add, 0 if delete (Default value = 1)
1328 self.papi.nat44_add_del_static_mapping,
1330 'addr_only': addr_only,
1331 'local_ip_address': local_ip,
1332 'external_ip_address': external_ip,
1333 'local_port': local_port,
1334 'external_port': external_port,
1335 'external_sw_if_index': external_sw_if_index,
1337 'protocol': protocol,
1338 'twice_nat': twice_nat,
1339 'self_twice_nat': self_twice_nat,
1340 'out2in_only': out2in_only,
1343 def nat44_add_del_identity_mapping(
1346 sw_if_index=0xFFFFFFFF,
1353 """Add/delete NAT44 identity mapping
1355 :param ip: IP address (Default value = 0)
1356 :param sw_if_index: Interface instead of IP address
1357 :param port: Port number (Default value = 0)
1358 :param addr_only: 1 if address only mapping, 0 if address and port
1359 :param vrf_id: VRF ID
1360 :param protocol: IP protocol (Default value = 0)
1361 :param tag: Opaque string tag
1362 :param is_add: 1 if add, 0 if delete (Default value = 1)
1365 self.papi.nat44_add_del_identity_mapping,
1367 'addr_only': addr_only,
1370 'sw_if_index': sw_if_index,
1373 'protocol': protocol})
1375 def nat44_add_del_address_range(
1382 """Add/del NAT44 address range
1384 :param first_ip_address: First IP address
1385 :param last_ip_address: Last IP address
1386 :param vrf_id: VRF id for the address range
1387 :param twice_nat: twice NAT address for extenal hosts
1388 :param is_add: 1 if add, 0 if delete (Default value = 1)
1391 self.papi.nat44_add_del_address_range,
1392 {'first_ip_address': first_ip_address,
1393 'last_ip_address': last_ip_address,
1395 'twice_nat': twice_nat,
1398 def nat44_address_dump(self):
1399 """Dump NAT44 addresses
1400 :return: Dictionary of NAT44 addresses
1402 return self.api(self.papi.nat44_address_dump, {})
1404 def nat44_interface_dump(self):
1405 """Dump interfaces with NAT44 feature
1406 :return: Dictionary of interfaces with NAT44 feature
1408 return self.api(self.papi.nat44_interface_dump, {})
1410 def nat44_interface_output_feature_dump(self):
1411 """Dump interfaces with NAT44 output feature
1412 :return: Dictionary of interfaces with NAT44 output feature
1414 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1416 def nat44_static_mapping_dump(self):
1417 """Dump NAT44 static mappings
1418 :return: Dictionary of NAT44 static mappings
1420 return self.api(self.papi.nat44_static_mapping_dump, {})
1422 def nat44_identity_mapping_dump(self):
1423 """Dump NAT44 identity mappings
1424 :return: Dictionary of NAT44 identity mappings
1426 return self.api(self.papi.nat44_identity_mapping_dump, {})
1428 def nat_show_config(self):
1429 """Show NAT plugin config
1430 :return: NAT plugin config parameters
1432 return self.api(self.papi.nat_show_config, {})
1434 def nat44_add_interface_addr(
1439 """Add/del NAT44 address from interface
1441 :param sw_if_index: Software index of the interface
1442 :param twice_nat: twice NAT address for extenal hosts
1443 :param is_add: 1 if add, 0 if delete (Default value = 1)
1446 self.papi.nat44_add_del_interface_addr,
1448 'sw_if_index': sw_if_index,
1449 'twice_nat': twice_nat})
1451 def nat44_interface_addr_dump(self):
1452 """Dump NAT44 addresses interfaces
1453 :return: Dictionary of NAT44 addresses interfaces
1455 return self.api(self.papi.nat44_interface_addr_dump, {})
1462 """Enable/disable NAT IPFIX logging
1464 :param domain_id: Observation domain ID (Default value = 1)
1465 :param src_port: Source port number (Default value = 4739)
1466 :param enable: 1 if enable, 0 if disable (Default value = 1)
1469 self.papi.nat_ipfix_enable_disable,
1470 {'domain_id': domain_id,
1471 'src_port': src_port,
1474 def nat44_user_session_dump(
1478 """Dump NAT44 user's sessions
1480 :param ip_address: ip adress of the user to be dumped
1481 :param cpu_index: cpu_index on which the user is
1482 :param vrf_id: VRF ID
1483 :return: Dictionary of S-NAT sessions
1486 self.papi.nat44_user_session_dump,
1487 {'ip_address': ip_address,
1490 def nat44_user_dump(self):
1493 :return: Dictionary of NAT44 users
1495 return self.api(self.papi.nat44_user_dump, {})
1497 def nat44_add_del_lb_static_mapping(
1510 """Add/delete NAT44 load balancing static mapping
1512 :param twice_nat: 1 if translate external host address and port
1513 :param tag: Opaque string tag
1514 :param is_add - 1 if add, 0 if delete
1517 self.papi.nat44_add_del_lb_static_mapping,
1519 'external_addr': external_addr,
1520 'external_port': external_port,
1521 'protocol': protocol,
1523 'twice_nat': twice_nat,
1524 'self_twice_nat': self_twice_nat,
1525 'out2in_only': out2in_only,
1527 'local_num': local_num,
1530 def nat44_lb_static_mapping_dump(self):
1531 """Dump NAT44 load balancing static mappings
1533 :return: Dictionary of NAT44 load balancing static mapping
1535 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1537 def nat44_del_session(
1544 """Delete NAT44 session
1546 :param addr: IPv4 address
1547 :param por: port number
1548 :param protocol: IP protocol number
1549 :param vrf_id: VRF ID
1550 :param is_in: 1 if inside network addres and port pari, 0 if outside
1553 self.papi.nat44_del_session,
1556 'protocol': protocol,
1560 def nat44_forwarding_enable_disable(
1563 """Enable/disable forwarding for NAT44
1565 :param enable: 1 for enable, 0 for disable
1568 self.papi.nat44_forwarding_enable_disable,
1578 """Set NAT virtual fragmentation reassembly
1580 :param timeout: reassembly timeout (Default 2sec)
1581 :param max_reass: maximum concurrent reassemblies (Default 1024)
1582 :param max_frag: maximum fragmets per reassembly (Default 5)
1583 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1584 :param is_ip6: 1 if IPv6, 0 if IPv4
1587 self.papi.nat_set_reass,
1588 {'timeout': timeout,
1589 'max_reass': max_reass,
1590 'max_frag': max_frag,
1591 'drop_frag': drop_frag,
1594 def nat_get_reass(self):
1595 """Get NAT virtual fragmentation reassembly configuration
1597 :return: NAT virtual fragmentation reassembly configuration
1599 return self.api(self.papi.nat_get_reass, {})
1601 def nat_reass_dump(self):
1602 """Dump NAT virtual fragmentation reassemblies
1604 :return: Dictionary of NAT virtual fragmentation reassemblies
1606 return self.api(self.papi.nat_reass_dump, {})
1608 def nat_det_add_del_map(
1615 """Add/delete deterministic NAT mapping
1617 :param is_add - 1 if add, 0 if delete
1618 :param in_addr - inside IP address
1619 :param in_plen - inside IP address prefix length
1620 :param out_addr - outside IP address
1621 :param out_plen - outside IP address prefix length
1624 self.papi.nat_det_add_del_map,
1629 'out_addr': out_addr,
1630 'out_plen': out_plen})
1632 def nat_det_forward(
1635 """Get outside address and port range from inside address
1637 :param in_addr - inside IP address
1640 self.papi.nat_det_forward,
1641 {'in_addr': in_addr,
1644 def nat_det_reverse(
1648 """Get inside address from outside address and port
1650 :param out_addr - outside IP address
1651 :param out_port - outside port
1654 self.papi.nat_det_reverse,
1655 {'out_addr': out_addr,
1656 'out_port': out_port})
1658 def nat_det_map_dump(self):
1659 """Dump deterministic NAT mappings
1661 :return: Dictionary of deterministic NAT mappings
1663 return self.api(self.papi.nat_det_map_dump, {})
1665 def nat_det_set_timeouts(
1668 tcp_established=7440,
1671 """Set values of timeouts for deterministic NAT (in seconds)
1673 :param udp - UDP timeout (Default value = 300)
1674 :param tcp_established - TCP established timeout (Default value = 7440)
1675 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1676 :param icmp - ICMP timeout (Default value = 60)
1679 self.papi.nat_det_set_timeouts,
1681 'tcp_established': tcp_established,
1682 'tcp_transitory': tcp_transitory,
1685 def nat_det_get_timeouts(self):
1686 """Get values of timeouts for deterministic NAT
1688 :return: Timeouts for deterministic NAT (in seconds)
1690 return self.api(self.papi.nat_det_get_timeouts, {})
1692 def nat_det_close_session_out(
1698 """Close deterministic NAT session using outside address and port
1700 :param out_addr - outside IP address
1701 :param out_port - outside port
1702 :param ext_addr - external host IP address
1703 :param ext_port - external host port
1706 self.papi.nat_det_close_session_out,
1707 {'out_addr': out_addr,
1708 'out_port': out_port,
1709 'ext_addr': ext_addr,
1710 'ext_port': ext_port})
1712 def nat_det_close_session_in(
1718 """Close deterministic NAT session using inside address and port
1720 :param in_addr - inside IP address
1721 :param in_port - inside port
1722 :param ext_addr - external host IP address
1723 :param ext_port - external host port
1726 self.papi.nat_det_close_session_in,
1727 {'in_addr': in_addr,
1729 'ext_addr': ext_addr,
1730 'ext_port': ext_port,
1733 def nat_det_session_dump(
1736 """Dump deterministic NAT sessions belonging to a user
1738 :param user_addr - inside IP address of the user
1739 :return: Dictionary of deterministic NAT sessions
1742 self.papi.nat_det_session_dump,
1744 'user_addr': user_addr})
1746 def nat64_add_del_pool_addr_range(
1752 """Add/del address range to NAT64 pool
1754 :param start_addr: First IP address
1755 :param end_addr: Last IP address
1756 :param vrf_id: VRF id for the address range
1757 :param is_add: 1 if add, 0 if delete (Default value = 1)
1760 self.papi.nat64_add_del_pool_addr_range,
1761 {'start_addr': start_addr,
1762 'end_addr': end_addr,
1766 def nat64_pool_addr_dump(self):
1767 """Dump NAT64 pool addresses
1768 :return: Dictionary of NAT64 pool addresses
1770 return self.api(self.papi.nat64_pool_addr_dump, {})
1772 def nat64_add_del_interface(
1777 """Enable/disable NAT64 feature on the interface
1778 :param sw_if_index: Index of the interface
1779 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1780 :param is_add: 1 if add, 0 if delete (Default value = 1)
1783 self.papi.nat64_add_del_interface,
1784 {'sw_if_index': sw_if_index,
1785 'is_inside': is_inside,
1788 def nat64_interface_dump(self):
1789 """Dump interfaces with NAT64 feature
1790 :return: Dictionary of interfaces with NAT64 feature
1792 return self.api(self.papi.nat64_interface_dump, {})
1794 def nat64_add_del_static_bib(
1803 """Add/delete S-NAT static BIB entry
1805 :param in_ip: Inside IPv6 address
1806 :param out_ip: Outside IPv4 address
1807 :param in_port: Inside port number
1808 :param out_port: Outside port number
1809 :param protocol: IP protocol
1810 :param vrf_id: VRF ID (Default value = 0)
1811 :param is_add: 1 if add, 0 if delete (Default value = 1)
1814 self.papi.nat64_add_del_static_bib,
1823 def nat64_bib_dump(self, protocol=255):
1826 :param protocol: IP protocol (Default value = 255, all BIBs)
1827 :returns: Dictionary of NAT64 BIB entries
1829 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1831 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1832 tcp_incoming_syn=6):
1833 """Set values of timeouts for NAT64 (in seconds)
1835 :param udpi: UDP timeout (Default value = 300)
1836 :param icmp: ICMP timeout (Default value = 60)
1837 :param tcp_trans: TCP transitory timeout (Default value = 240)
1838 :param tcp_est: TCP established timeout (Default value = 7440)
1839 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1842 self.papi.nat64_set_timeouts,
1845 'tcp_trans': tcp_trans,
1847 'tcp_incoming_syn': tcp_incoming_syn})
1849 def nat64_get_timeouts(self):
1850 """Get values of timeouts for NAT64
1852 :return: Timeouts for NAT64 (in seconds)
1854 return self.api(self.papi.nat64_get_timeouts, {})
1856 def nat64_st_dump(self, protocol=255):
1857 """Dump NAT64 session table
1859 :param protocol: IP protocol (Default value = 255, all STs)
1860 :returns: Dictionary of NAT64 sesstion table entries
1862 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1864 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1865 """Add/del NAT64 prefix
1867 :param prefix: NAT64 prefix
1868 :param plen: NAT64 prefix length
1869 :param vrf_id: VRF id of tenant (Default 0)
1870 :param is_add: 1 if add, 0 if delete (Default value = 1)
1873 self.papi.nat64_add_del_prefix,
1879 def nat64_prefix_dump(self):
1880 """Dump NAT64 prefix
1882 :returns: Dictionary of NAT64 prefixes
1884 return self.api(self.papi.nat64_prefix_dump, {})
1886 def nat64_add_interface_addr(
1890 """Add/del NAT64 address from interface
1892 :param sw_if_index: Software index of the interface
1893 :param is_add: 1 if add, 0 if delete (Default value = 1)
1895 return self.api(self.papi.nat64_add_del_interface_addr,
1896 {'is_add': is_add, 'sw_if_index': sw_if_index})
1898 def dslite_set_aftr_addr(self, ip6, ip4):
1899 """Set DS-Lite AFTR addresses
1901 :param ip4: IPv4 address
1902 :param ip6: IPv6 address
1905 self.papi.dslite_set_aftr_addr,
1909 def dslite_set_b4_addr(self, ip6, ip4):
1910 """Set DS-Lite B4 IPv6 address
1912 :param ip4: IPv4 address
1913 :param ip6: IPv6 address
1916 self.papi.dslite_set_b4_addr,
1920 def dslite_add_del_pool_addr_range(
1925 """Add/del address range to DS-Lite pool
1927 :param start_addr: First IP address
1928 :param end_addr: Last IP address
1929 :param is_add: 1 if add, 0 if delete (Default value = 1)
1932 self.papi.dslite_add_del_pool_addr_range,
1933 {'start_addr': start_addr,
1934 'end_addr': end_addr,
1937 def nat66_add_del_interface(
1942 """Enable/disable NAT66 feature on the interface
1943 :param sw_if_index: Index of the interface
1944 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1945 :param is_add: 1 if add, 0 if delete (Default value = 1)
1948 self.papi.nat66_add_del_interface,
1949 {'sw_if_index': sw_if_index,
1950 'is_inside': is_inside,
1953 def nat66_add_del_static_mapping(
1959 """Add/delete NAT66 static mapping
1961 :param in_ip: Inside IPv6 address
1962 :param out_ip: Outside IPv6 address
1963 :param vrf_id: VRF ID (Default value = 0)
1964 :param is_add: 1 if add, 0 if delete (Default value = 1)
1967 self.papi.nat66_add_del_static_mapping,
1968 {'local_ip_address': in_ip,
1969 'external_ip_address': out_ip,
1973 def nat66_interface_dump(self):
1974 """Dump interfaces with NAT66 feature
1975 :return: Dictionary of interfaces with NAT66 feature
1977 return self.api(self.papi.nat66_interface_dump, {})
1979 def nat66_static_mapping_dump(self):
1980 """Dump NAT66 static mappings
1981 :return: Dictionary of NAT66 static mappings
1983 return self.api(self.papi.nat66_static_mapping_dump, {})
1985 def control_ping(self):
1986 self.api(self.papi.control_ping)
1988 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1989 detect_mult, local_addr, peer_addr, is_ipv6=0,
1990 bfd_key_id=None, conf_key_id=None):
1991 if bfd_key_id is None:
1992 return self.api(self.papi.bfd_udp_add,
1994 'sw_if_index': sw_if_index,
1995 'desired_min_tx': desired_min_tx,
1996 'required_min_rx': required_min_rx,
1997 'local_addr': local_addr,
1998 'peer_addr': peer_addr,
2000 'detect_mult': detect_mult,
2003 return self.api(self.papi.bfd_udp_add,
2005 'sw_if_index': sw_if_index,
2006 'desired_min_tx': desired_min_tx,
2007 'required_min_rx': required_min_rx,
2008 'local_addr': local_addr,
2009 'peer_addr': peer_addr,
2011 'detect_mult': detect_mult,
2012 'is_authenticated': 1,
2013 'bfd_key_id': bfd_key_id,
2014 'conf_key_id': conf_key_id,
2017 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2018 detect_mult, local_addr, peer_addr, is_ipv6=0):
2019 return self.api(self.papi.bfd_udp_mod,
2021 'sw_if_index': sw_if_index,
2022 'desired_min_tx': desired_min_tx,
2023 'required_min_rx': required_min_rx,
2024 'local_addr': local_addr,
2025 'peer_addr': peer_addr,
2027 'detect_mult': detect_mult,
2030 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2031 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2033 return self.api(self.papi.bfd_udp_auth_activate,
2035 'sw_if_index': sw_if_index,
2036 'local_addr': local_addr,
2037 'peer_addr': peer_addr,
2039 'is_delayed': 1 if is_delayed else 0,
2040 'bfd_key_id': bfd_key_id,
2041 'conf_key_id': conf_key_id,
2044 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2045 is_ipv6=0, is_delayed=False):
2046 return self.api(self.papi.bfd_udp_auth_deactivate,
2048 'sw_if_index': sw_if_index,
2049 'local_addr': local_addr,
2050 'peer_addr': peer_addr,
2052 'is_delayed': 1 if is_delayed else 0,
2055 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2056 return self.api(self.papi.bfd_udp_del,
2058 'sw_if_index': sw_if_index,
2059 'local_addr': local_addr,
2060 'peer_addr': peer_addr,
2064 def bfd_udp_session_dump(self):
2065 return self.api(self.papi.bfd_udp_session_dump, {})
2067 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2068 peer_addr, is_ipv6=0):
2069 return self.api(self.papi.bfd_udp_session_set_flags, {
2070 'admin_up_down': admin_up_down,
2071 'sw_if_index': sw_if_index,
2072 'local_addr': local_addr,
2073 'peer_addr': peer_addr,
2077 def want_bfd_events(self, enable_disable=1):
2078 return self.api(self.papi.want_bfd_events, {
2079 'enable_disable': enable_disable,
2083 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2084 return self.api(self.papi.bfd_auth_set_key, {
2085 'conf_key_id': conf_key_id,
2086 'auth_type': auth_type,
2088 'key_len': len(key),
2091 def bfd_auth_del_key(self, conf_key_id):
2092 return self.api(self.papi.bfd_auth_del_key, {
2093 'conf_key_id': conf_key_id,
2096 def bfd_auth_keys_dump(self):
2097 return self.api(self.papi.bfd_auth_keys_dump, {})
2099 def bfd_udp_set_echo_source(self, sw_if_index):
2100 return self.api(self.papi.bfd_udp_set_echo_source,
2101 {'sw_if_index': sw_if_index})
2103 def bfd_udp_del_echo_source(self):
2104 return self.api(self.papi.bfd_udp_del_echo_source, {})
2106 def classify_add_del_table(
2111 table_index=0xFFFFFFFF,
2113 memory_size=2097152,
2115 next_table_index=0xFFFFFFFF,
2116 miss_next_index=0xFFFFFFFF,
2117 current_data_flag=0,
2118 current_data_offset=0):
2122 :param match_n_vectors: (Default value = 1)
2123 :param table_index: (Default value = 0xFFFFFFFF)
2124 :param nbuckets: (Default value = 2)
2125 :param memory_size: (Default value = 2097152)
2126 :param skip_n_vectors: (Default value = 0)
2127 :param next_table_index: (Default value = 0xFFFFFFFF)
2128 :param miss_next_index: (Default value = 0xFFFFFFFF)
2129 :param current_data_flag: (Default value = 0)
2130 :param current_data_offset: (Default value = 0)
2134 self.papi.classify_add_del_table,
2136 'table_index': table_index,
2137 'nbuckets': nbuckets,
2138 'memory_size': memory_size,
2139 'skip_n_vectors': skip_n_vectors,
2140 'match_n_vectors': match_n_vectors,
2141 'next_table_index': next_table_index,
2142 'miss_next_index': miss_next_index,
2143 'current_data_flag': current_data_flag,
2144 'current_data_offset': current_data_offset,
2147 def classify_add_del_session(
2152 opaque_index=0xFFFFFFFF,
2153 hit_next_index=0xFFFFFFFF,
2161 :param opaque_index: (Default value = 0xFFFFFFFF)
2162 :param hit_next_index: (Default value = 0xFFFFFFFF)
2163 :param advance: (Default value = 0)
2164 :param action: (Default value = 0)
2165 :param metadata: (Default value = 0)
2169 self.papi.classify_add_del_session,
2171 'table_index': table_index,
2172 'hit_next_index': hit_next_index,
2173 'opaque_index': opaque_index,
2176 'metadata': metadata,
2179 def input_acl_set_interface(
2183 ip4_table_index=0xFFFFFFFF,
2184 ip6_table_index=0xFFFFFFFF,
2185 l2_table_index=0xFFFFFFFF):
2189 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2190 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2191 :param l2_table_index: (Default value = 0xFFFFFFFF)
2195 self.papi.input_acl_set_interface,
2196 {'sw_if_index': sw_if_index,
2197 'ip4_table_index': ip4_table_index,
2198 'ip6_table_index': ip6_table_index,
2199 'l2_table_index': l2_table_index,
2202 def output_acl_set_interface(
2206 ip4_table_index=0xFFFFFFFF,
2207 ip6_table_index=0xFFFFFFFF,
2208 l2_table_index=0xFFFFFFFF):
2212 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2213 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2214 :param l2_table_index: (Default value = 0xFFFFFFFF)
2218 self.papi.output_acl_set_interface,
2219 {'sw_if_index': sw_if_index,
2220 'ip4_table_index': ip4_table_index,
2221 'ip6_table_index': ip6_table_index,
2222 'l2_table_index': l2_table_index,
2225 def set_ipfix_exporter(
2232 collector_port=4739,
2235 self.papi.set_ipfix_exporter,
2237 'collector_address': collector_address,
2238 'collector_port': collector_port,
2239 'src_address': src_address,
2241 'path_mtu': path_mtu,
2242 'template_interval': template_interval,
2243 'udp_checksum': udp_checksum,
2246 def dhcp_proxy_config(self,
2254 self.papi.dhcp_proxy_config,
2256 'rx_vrf_id': rx_table_id,
2257 'server_vrf_id': server_table_id,
2260 'dhcp_server': dhcp_server,
2261 'dhcp_src_address': dhcp_src_address,
2264 def dhcp_proxy_set_vss(self,
2273 self.papi.dhcp_proxy_set_vss,
2276 'vss_type': vss_type,
2277 'vpn_ascii_id': vpn_ascii_id,
2279 'vpn_index': vpn_index,
2284 def dhcp_client(self,
2289 set_broadcast_flag=1,
2290 want_dhcp_events=0):
2292 self.papi.dhcp_client_config,
2294 'sw_if_index': sw_if_index,
2295 'hostname': hostname,
2296 'client_id': client_id,
2298 'want_dhcp_event': want_dhcp_events,
2299 'set_broadcast_flag': set_broadcast_flag,
2303 def ip_mroute_add_del(self,
2309 next_hop_sw_if_index,
2319 IP Multicast Route add/del
2322 self.papi.ip_mroute_add_del,
2323 {'next_hop_sw_if_index': next_hop_sw_if_index,
2324 'entry_flags': e_flags,
2325 'itf_flags': i_flags,
2326 'table_id': table_id,
2330 'is_local': is_local,
2331 'bier_imp': bier_imp,
2332 'next_hop_afi': next_hop_afi,
2333 'grp_address_length': grp_address_length,
2334 'grp_address': grp_address,
2335 'src_address': src_address,
2336 'nh_address': next_hop_address})
2338 def mfib_signal_dump(self):
2339 return self.api(self.papi.mfib_signal_dump, {})
2341 def ip_mfib_dump(self):
2342 return self.api(self.papi.ip_mfib_dump, {})
2344 def ip6_mfib_dump(self):
2345 return self.api(self.papi.ip6_mfib_dump, {})
2347 def lisp_enable_disable(self, is_enabled):
2349 self.papi.lisp_enable_disable,
2351 'is_en': is_enabled,
2354 def lisp_locator_set(self,
2358 self.papi.lisp_add_del_locator_set,
2361 'locator_set_name': ls_name
2364 def lisp_locator_set_dump(self):
2365 return self.api(self.papi.lisp_locator_set_dump, {})
2367 def lisp_locator(self,
2374 self.papi.lisp_add_del_locator,
2377 'locator_set_name': ls_name,
2378 'sw_if_index': sw_if_index,
2379 'priority': priority,
2383 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2385 self.papi.lisp_locator_dump,
2387 'is_index_set': is_index_set,
2389 'ls_index': ls_index,
2392 def lisp_local_mapping(self,
2402 self.papi.lisp_add_del_local_eid,
2404 'locator_set_name': ls_name,
2406 'eid_type': eid_type,
2408 'prefix_len': prefix_len,
2414 def lisp_eid_table_dump(self,
2422 self.papi.lisp_eid_table_dump,
2425 'prefix_length': prefix_length,
2427 'eid_type': eid_type,
2429 'filter': filter_opt,
2432 def lisp_remote_mapping(self,
2442 self.papi.lisp_add_del_remote_mapping,
2445 'eid_type': eid_type,
2447 'eid_len': eid_prefix_len,
2448 'rloc_num': rlocs_num,
2451 'is_src_dst': is_src_dst,
2454 def lisp_adjacency(self,
2463 self.papi.lisp_add_del_adjacency,
2467 'eid_type': eid_type,
2470 'leid_len': leid_len,
2471 'reid_len': reid_len,
2474 def lisp_adjacencies_get(self, vni=0):
2476 self.papi.lisp_adjacencies_get,
2481 def map_add_domain(self,
2495 self.papi.map_add_domain,
2497 'ip6_prefix': ip6_prefix,
2498 'ip6_prefix_len': ip6_prefix_len,
2499 'ip4_prefix': ip4_prefix,
2500 'ip4_prefix_len': ip4_prefix_len,
2502 'ip6_src_prefix_len': ip6_src_prefix_len,
2503 'ea_bits_len': ea_bits_len,
2504 'psid_offset': psid_offset,
2505 'psid_length': psid_length,
2506 'is_translation': is_translation,
2507 'is_rfc6052': is_rfc6052,
2511 def gtpu_add_del_tunnel(
2517 mcast_sw_if_index=0xFFFFFFFF,
2519 decap_next_index=0xFFFFFFFF,
2523 :param is_add: (Default value = 1)
2524 :param is_ipv6: (Default value = 0)
2527 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2528 :param encap_vrf_id: (Default value = 0)
2529 :param decap_next_index: (Default value = 0xFFFFFFFF)
2530 :param teid: (Default value = 0)
2533 return self.api(self.papi.gtpu_add_del_tunnel,
2536 'src_address': src_addr,
2537 'dst_address': dst_addr,
2538 'mcast_sw_if_index': mcast_sw_if_index,
2539 'encap_vrf_id': encap_vrf_id,
2540 'decap_next_index': decap_next_index,
2543 def vxlan_gpe_add_del_tunnel(
2547 mcast_sw_if_index=0xFFFFFFFF,
2558 :param is_add: (Default value = 1)
2559 :param is_ipv6: (Default value = 0)
2560 :param encap_vrf_id: (Default value = 0)
2561 :param decap_vrf_id: (Default value = 0)
2562 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2563 :param protocol: (Default value = 3)
2564 :param vni: (Default value = 0)
2567 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2572 'mcast_sw_if_index': mcast_sw_if_index,
2573 'encap_vrf_id': encap_vrf_id,
2574 'decap_vrf_id': decap_vrf_id,
2575 'protocol': protocol,
2578 def pppoe_add_del_session(
2588 :param is_add: (Default value = 1)
2589 :param is_ipv6: (Default value = 0)
2591 :param session_id: (Default value = 0)
2593 :param decap_vrf_id: (Default value = 0)
2596 return self.api(self.papi.pppoe_add_del_session,
2599 'session_id': session_id,
2600 'client_ip': client_ip,
2601 'decap_vrf_id': decap_vrf_id,
2602 'client_mac': client_mac})
2604 def sr_localsid_add_del(self,
2610 sw_if_index=0xFFFFFFFF,
2614 """ Add/del IPv6 SR local-SID.
2616 :param localsid_addr:
2617 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2618 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2620 :param is_del: (Default value = 0)
2621 :param end_psp: (Default value = 0)
2622 :param sw_if_index: (Default value = 0xFFFFFFFF)
2623 :param vlan_index: (Default value = 0)
2624 :param fib_table: (Default value = 0)
2627 self.papi.sr_localsid_add_del,
2629 'localsid_addr': localsid_addr,
2631 'behavior': behavior,
2632 'sw_if_index': sw_if_index,
2633 'vlan_index': vlan_index,
2634 'fib_table': fib_table,
2649 :param bsid_addr: bindingSID of the SR Policy
2650 :param weight: weight of the sid list. optional. (default: 1)
2651 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2653 :param type: type/behavior of the SR policy. (default or spray) \
2655 :param fib_table: VRF where to install the FIB entry for the BSID \
2657 :param n_segments: number of segments \
2659 :param segments: a vector of IPv6 address composing the segment list \
2663 self.papi.sr_policy_add,
2664 {'bsid_addr': bsid_addr,
2666 'is_encap': is_encap,
2668 'fib_table': fib_table,
2669 'n_segments': n_segments,
2670 'segments': segments
2679 :param bsid: bindingSID of the SR Policy
2680 :param sr_policy_index: index of the sr policy (default: 0)
2683 self.papi.sr_policy_del,
2684 {'bsid_addr': bsid_addr,
2685 'sr_policy_index': sr_policy_index
2688 def sr_steering_add_del(
2699 Steer traffic L2 and L3 traffic through a given SR policy
2701 :param is_del: delete or add
2702 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2703 :param sr_policy: is the index of the SR Policy (alt to bsid)
2704 :param table_id: is the VRF where to install the FIB entry for the BSID
2705 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2706 :param mask_width: is the mask for L3 traffic type
2707 :param sw_if_index: is the incoming interface for L2 traffic
2708 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2711 self.papi.sr_steering_add_del,
2713 'bsid_addr': bsid_addr,
2714 'sr_policy_index': sr_policy_index,
2715 'table_id': table_id,
2716 'prefix_addr': prefix_addr,
2717 'mask_width': mask_width,
2718 'sw_if_index': sw_if_index,
2719 'traffic_type': traffic_type
2722 def acl_add_replace(self, acl_index, r, tag='',
2724 """Add/replace an ACL
2725 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2726 :param acl_rule r: ACL rules array.
2727 :param str tag: symbolic tag (description) for this ACL.
2728 :param int count: number of rules.
2730 return self.api(self.papi.acl_add_replace,
2731 {'acl_index': acl_index,
2735 expected_retval=expected_retval)
2737 def acl_del(self, acl_index, expected_retval=0):
2743 return self.api(self.papi.acl_del,
2744 {'acl_index': acl_index},
2745 expected_retval=expected_retval)
2747 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2749 return self.api(self.papi.acl_interface_set_acl_list,
2750 {'sw_if_index': sw_if_index,
2754 expected_retval=expected_retval)
2756 def acl_interface_set_etype_whitelist(self, sw_if_index,
2759 return self.api(self.papi.acl_interface_set_etype_whitelist,
2760 {'sw_if_index': sw_if_index,
2761 'count': len(whitelist),
2763 'whitelist': whitelist},
2764 expected_retval=expected_retval)
2766 def acl_interface_add_del(self,
2770 """ Add/Delete ACL to/from interface
2774 :param is_add: (Default value = 1)
2777 return self.api(self.papi.acl_interface_add_del,
2780 'sw_if_index': sw_if_index,
2781 'acl_index': acl_index})
2783 def acl_dump(self, acl_index, expected_retval=0):
2784 return self.api(self.papi.acl_dump,
2785 {'acl_index': acl_index},
2786 expected_retval=expected_retval)
2788 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2790 return self.api(self.papi.acl_interface_list_dump,
2791 {'sw_if_index': sw_if_index},
2792 expected_retval=expected_retval)
2794 def macip_acl_add(self, rules, tag=""):
2797 :param rules: list of rules for given acl
2801 return self.api(self.papi.macip_acl_add,
2803 'count': len(rules),
2806 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2809 :param rules: list of rules for given acl
2813 return self.api(self.papi.macip_acl_add_replace,
2814 {'acl_index': acl_index,
2816 'count': len(rules),
2819 def macip_acl_del(self, acl_index):
2825 return self.api(self.papi.macip_acl_del,
2826 {'acl_index': acl_index})
2828 def macip_acl_interface_add_del(self,
2832 """ Add MACIP acl to interface
2836 :param is_add: (Default value = 1)
2839 return self.api(self.papi.macip_acl_interface_add_del,
2841 'sw_if_index': sw_if_index,
2842 'acl_index': acl_index})
2844 def macip_acl_interface_get(self):
2845 """ Return interface acls dump
2848 self.papi.macip_acl_interface_get, {})
2850 def macip_acl_dump(self, acl_index=4294967295):
2851 """ Return MACIP acl dump
2855 self.papi.macip_acl_dump, {'acl_index': acl_index})
2857 def policer_add_del(self,
2868 conform_action_type=1,
2870 exceed_action_type=0,
2872 violate_action_type=0,
2874 return self.api(self.papi.policer_add_del,
2881 'rate_type': rate_type,
2882 'round_type': round_type,
2884 'color_aware': color_aware,
2885 'conform_action_type': conform_action_type,
2886 'conform_dscp': conform_dscp,
2887 'exceed_action_type': exceed_action_type,
2888 'exceed_dscp': exceed_dscp,
2889 'violate_action_type': violate_action_type,
2890 'violate_dscp': violate_dscp})
2892 def ip_punt_police(self,
2896 return self.api(self.papi.ip_punt_police,
2897 {'policer_index': policer_index,
2901 def ip_punt_redirect(self,
2907 return self.api(self.papi.ip_punt_redirect,
2908 {'rx_sw_if_index': rx_sw_if_index,
2909 'tx_sw_if_index': tx_sw_if_index,
2914 def bier_table_add_del(self,
2918 """ BIER Table add/del """
2920 self.papi.bier_table_add_del,
2921 {'bt_tbl_id': {"bt_set": bti.set_id,
2922 "bt_sub_domain": bti.sub_domain_id,
2923 "bt_hdr_len_id": bti.hdr_len_id},
2924 'bt_label': mpls_label,
2925 'bt_is_add': is_add})
2927 def bier_table_dump(self):
2928 return self.api(self.papi.bier_table_dump, {})
2930 def bier_route_add_del(self,
2935 """ BIER Route add/del """
2937 self.papi.bier_route_add_del,
2938 {'br_tbl_id': {"bt_set": bti.set_id,
2939 "bt_sub_domain": bti.sub_domain_id,
2940 "bt_hdr_len_id": bti.hdr_len_id},
2942 'br_n_paths': len(paths),
2944 'br_is_add': is_add})
2946 def bier_route_dump(self, bti):
2948 self.papi.bier_route_dump,
2949 {'br_tbl_id': {"bt_set": bti.set_id,
2950 "bt_sub_domain": bti.sub_domain_id,
2951 "bt_hdr_len_id": bti.hdr_len_id}})
2953 def bier_imp_add(self,
2958 """ BIER Imposition Add """
2960 self.papi.bier_imp_add,
2961 {'bi_tbl_id': {"bt_set": bti.set_id,
2962 "bt_sub_domain": bti.sub_domain_id,
2963 "bt_hdr_len_id": bti.hdr_len_id},
2965 'bi_n_bytes': len(ibytes),
2966 'bi_bytes': ibytes})
2968 def bier_imp_del(self, bi_index):
2969 """ BIER Imposition del """
2971 self.papi.bier_imp_del,
2972 {'bi_index': bi_index})
2974 def bier_imp_dump(self):
2975 return self.api(self.papi.bier_imp_dump, {})
2977 def bier_disp_table_add_del(self,
2980 """ BIER Disposition Table add/del """
2982 self.papi.bier_disp_table_add_del,
2983 {'bdt_tbl_id': bdti,
2984 'bdt_is_add': is_add})
2986 def bier_disp_table_dump(self):
2987 return self.api(self.papi.bier_disp_table_dump, {})
2989 def bier_disp_entry_add_del(self,
2999 """ BIER Route add/del """
3001 while (len(lstack) < 16):
3004 self.papi.bier_disp_entry_add_del,
3005 {'bde_tbl_id': bdti,
3007 'bde_payload_proto': payload_proto,
3009 'bde_paths': [{'next_hop': next_hop,
3010 'table_id': next_hop_tbl_id,
3011 'afi': next_hop_afi,
3012 'rpf_id': next_hop_rpf_id,
3014 'label_stack': lstack}],
3015 'bde_is_add': is_add})
3017 def bier_disp_entry_dump(self, bdti):
3019 self.papi.bier_disp_entry_dump,
3020 {'bde_tbl_id': bdti})
3022 def add_node_next(self, node_name, next_name):
3023 """ Set the next node for a given node request
3028 return self.api(self.papi.add_node_next,
3029 {'node_name': node_name,
3030 'next_name': next_name})
3032 def session_enable_disable(self, is_enabled):
3034 self.papi.session_enable_disable,
3035 {'is_enable': is_enabled})
3037 def ipsec_spd_add_del(self, spd_id, is_add=1):
3038 """ SPD add/del - Wrapper to add or del ipsec SPD
3039 Sample CLI : 'ipsec spd add 1'
3041 :param spd_id - SPD ID to be created in the vpp . mandatory
3042 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3044 :returns: reply from the API
3047 self.papi.ipsec_spd_add_del, {
3048 'spd_id': spd_id, 'is_add': is_add})
3050 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3051 """ IPSEC interface SPD add/del - \
3052 Wrapper to associate/disassociate SPD to interface in VPP
3053 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3055 :param spd_id - SPD ID to associate with the interface . mandatory
3056 :param sw_if_index - Interface Index which needs to ipsec \
3057 association mandatory
3058 :param is_add - add(1) or del(0) association with interface \
3059 (Default 1 - add) . optional
3060 :returns: reply from the API
3063 self.papi.ipsec_interface_add_del_spd,
3064 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3066 def ipsec_sad_add_del_entry(self,
3069 tunnel_src_address='',
3070 tunnel_dst_address='',
3072 integrity_algorithm=2,
3073 integrity_key_length=0,
3074 integrity_key='C91KUR9GYMm5GfkEvNjX',
3076 crypto_key_length=0,
3077 crypto_key='JPjyOWBeVEQiMe7h',
3081 """ IPSEC SA add/del
3082 Sample CLI : 'ipsec sa add 10 spi 1001 esp \
3083 crypto-key 4a506a794f574265564551694d653768 \
3084 crypto-alg aes-cbc-128 \
3085 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3086 integ-alg sha1-96 tunnel-src 192.168.100.3 \
3087 tunnel-dst 192.168.100.2'
3088 Sample CLI : 'ipsec sa add 20 spi 2001 \
3089 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3092 :param sad_id - Security Association ID to be \
3093 created or deleted. mandatory
3094 :param spi - security param index of the SA in decimal. mandatory
3095 :param tunnel_src_address - incase of tunnel mode outer src address .\
3096 mandatory for tunnel mode
3097 :param tunnel_dst_address - incase of transport mode \
3098 outer dst address. mandatory for tunnel mode
3099 :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional
3100 :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\
3102 :param integrity_key - value in string \
3103 (Default C91KUR9GYMm5GfkEvNjX).optional
3104 :param integrity_key_length - length of the key string in bytes\
3105 (Default 0 - integrity disabled). optional
3106 :param crypto_algorithm - value range 1-11 Default \
3107 (1- AES_CBC_128).optional **
3108 :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional
3109 :param crypto_key_length - length of the key string in bytes\
3110 (Default 0 - crypto disabled). optional
3111 :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\
3113 :param is_tunnel - tunnel mode (1) or transport mode(0) \
3114 (Default 1 - tunnel). optional
3115 :returns: reply from the API
3116 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3117 crypto and ipsec algorithms
3120 self.papi.ipsec_sad_add_del_entry,
3123 'tunnel_src_address': tunnel_src_address,
3124 'tunnel_dst_address': tunnel_dst_address,
3125 'protocol': protocol,
3126 'integrity_algorithm': integrity_algorithm,
3127 'integrity_key_length': integrity_key_length,
3128 'integrity_key': integrity_key,
3129 'crypto_algorithm': crypto_algorithm,
3130 'crypto_key_length': crypto_key_length,
3131 'crypto_key': crypto_key,
3133 'is_tunnel': is_tunnel,
3134 'udp_encap': udp_encap})
3136 def ipsec_spd_add_del_entry(self,
3138 local_address_start,
3140 remote_address_start,
3141 remote_address_stop,
3143 local_port_stop=65535,
3144 remote_port_start=0,
3145 remote_port_stop=65535,
3153 """ IPSEC policy SPD add/del -
3154 Wrapper to configure ipsec SPD policy entries in VPP
3155 Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \
3156 protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \
3157 remote-ip-range 192.168.3.3 - 192.168.3.3'
3159 :param spd_id - SPD ID for the policy . mandatory
3160 :param local_address_start - local-ip-range start address . mandatory
3161 :param local_address_stop - local-ip-range stop address . mandatory
3162 :param remote_address_start - remote-ip-range start address . mandatory
3163 :param remote_address_stop - remote-ip-range stop address . mandatory
3164 :param local_port_start - (Default 0) . optional
3165 :param local_port_stop - (Default 65535). optional
3166 :param remote_port_start - (Default 0). optional
3167 :param remote_port_stop - (Default 65535). optional
3168 :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any).
3170 :param sa_id - Security Association ID for mapping it to SPD
3171 (default 10). optional
3172 :param policy - bypass(0), discard(1), resolve(2) or protect(3)action
3173 (Default 0 - bypass). optional
3174 :param priotity - value for the spd action (Default 100). optional
3175 :param is_outbound - flag for inbound(0) or outbound(1)
3176 (Default 1 - outbound). optional
3177 :param is_add flag - for addition(1) or deletion(0) of the spd
3178 (Default 1 - addtion). optional
3179 :returns: reply from the API
3182 self.papi.ipsec_spd_add_del_entry,
3184 'local_address_start': local_address_start,
3185 'local_address_stop': local_address_stop,
3186 'remote_address_start': remote_address_start,
3187 'remote_address_stop': remote_address_stop,
3188 'local_port_start': local_port_start,
3189 'local_port_stop': local_port_stop,
3190 'remote_port_start': remote_port_start,
3191 'remote_port_stop': remote_port_stop,
3193 'protocol': protocol,
3195 'priority': priority,
3196 'is_outbound': is_outbound,
3198 'is_ip_any': is_ip_any})
3200 def app_namespace_add(self,
3204 sw_if_index=0xFFFFFFFF,
3207 self.papi.app_namespace_add_del,
3209 'sw_if_index': sw_if_index,
3210 'ip4_fib_id': ip4_fib_id,
3211 'ip6_fib_id': ip6_fib_id,
3212 'namespace_id': namespace_id,
3213 'namespace_id_len': len(namespace_id)})
3215 def punt_socket_register(self, l4_port, pathname, header_version=1,
3216 is_ip4=1, l4_protocol=0x11):
3217 """ Punt to socket """
3218 return self.api(self.papi.punt_socket_register,
3220 'l4_protocol': l4_protocol,
3222 'pathname': pathname,
3223 'header_version': header_version})
3225 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3226 expire_walk_interval_ms, is_ip6=0):
3227 """ Set IP reassembly parameters """
3228 return self.api(self.papi.ip_reassembly_set,
3230 'timeout_ms': timeout_ms,
3231 'expire_walk_interval_ms': expire_walk_interval_ms,
3232 'max_reassemblies': max_reassemblies})
3234 def ip_reassembly_get(self, is_ip6=0):
3235 """ Get IP reassembly parameters """
3236 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3238 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3240 """ Enable/disable IP reassembly """
3241 return self.api(self.papi.ip_reassembly_enable_disable,
3242 {'sw_if_index': sw_if_index,
3243 'enable_ip4': 1 if enable_ip4 else 0,
3244 'enable_ip6': 1 if enable_ip6 else 0,
3247 def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
3248 """ GBP endpoint Add/Del """
3249 return self.api(self.papi.gbp_endpoint_add_del,
3253 'sw_if_index': sw_if_index,
3257 def gbp_endpoint_dump(self):
3258 """ GBP endpoint Dump """
3259 return self.api(self.papi.gbp_endpoint_dump, {})
3261 def gbp_endpoint_group_add_del(self, is_add, epg, bd,
3264 uplink_sw_if_index):
3265 """ GBP endpoint group Add/Del """
3266 return self.api(self.papi.gbp_endpoint_group_add_del,
3269 'uplink_sw_if_index': uplink_sw_if_index,
3271 'ip4_table_id': ip4_rd,
3272 'ip6_table_id': ip6_rd,
3275 def gbp_endpoint_group_dump(self):
3276 """ GBP endpoint group Dump """
3277 return self.api(self.papi.gbp_endpoint_group_dump, {})
3279 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3280 """ GBP recirc Add/Del """
3281 return self.api(self.papi.gbp_recirc_add_del,
3285 'sw_if_index': sw_if_index,
3288 def gbp_recirc_dump(self):
3289 """ GBP recirc Dump """
3290 return self.api(self.papi.gbp_recirc_dump, {})
3292 def gbp_subnet_add_del(self, is_add, table_id,
3295 sw_if_index=0xffffffff,
3298 """ GBP Subnet Add/Del """
3299 return self.api(self.papi.gbp_subnet_add_del,
3302 'is_internal': is_internal,
3304 'sw_if_index': sw_if_index,
3307 'address_length': addr_len,
3308 'table_id': table_id}})
3310 def gbp_subnet_dump(self):
3311 """ GBP Subnet Dump """
3312 return self.api(self.papi.gbp_subnet_dump, {})
3314 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3315 """ GBP contract Add/Del """
3316 return self.api(self.papi.gbp_contract_add_del,
3319 'acl_index': acl_index,
3321 'dst_epg': dst_epg}})
3323 def gbp_contract_dump(self):
3324 """ GBP contract Dump """
3325 return self.api(self.papi.gbp_contract_dump, {})
3327 def ipip_6rd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len,
3328 ip4_prefix, ip4_prefix_len, ip4_src,
3330 """ 6RD tunnel Add """
3331 return self.api(self.papi.ipip_6rd_add_tunnel,
3332 {'fib_index': fib_index,
3333 'ip6_prefix': ip6_prefix,
3334 'ip6_prefix_len': ip6_prefix_len,
3335 'ip4_prefix': ip4_prefix,
3336 'ip4_prefix_len': ip4_prefix_len,
3338 'security_check': security_check})
3340 def ipip_6rd_del_tunnel(self, sw_if_index):
3341 """ 6RD tunnel Delete """
3342 return self.api(self.papi.ipip_6rd_del_tunnel,
3343 {'sw_if_index': sw_if_index})
3345 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3346 instance=0xFFFFFFFF, fib_index=0):
3347 """ IPIP tunnel Add/Del """
3348 return self.api(self.papi.ipip_add_tunnel,
3349 {'is_ipv6': is_ipv6,
3350 'instance': instance,
3351 'src_address': src_address,
3352 'dst_address': dst_address,
3353 'fib_index': fib_index})
3355 def ipip_del_tunnel(self, sw_if_index):
3356 """ IPIP tunnel Delete """
3357 return self.api(self.papi.ipip_del_tunnel,
3358 {'sw_if_index': sw_if_index})
3360 def qos_egress_map_update(self, id, outputs):
3361 """ QOS egress map update """
3362 return self.api(self.papi.qos_egress_map_update,
3366 def qos_egress_map_delete(self, id):
3367 """ QOS egress map delete """
3368 return self.api(self.papi.qos_egress_map_delete,
3371 def qos_mark_enable_disable(self, sw_if_index,
3375 """ QOS Mark Enable/Disable """
3376 return self.api(self.papi.qos_mark_enable_disable,
3378 'sw_if_index': sw_if_index,
3379 'output_source': output_source,
3382 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3383 """ IP QoS recording Enble/Disable """
3384 return self.api(self.papi.qos_record_enable_disable,
3385 {'sw_if_index': sw_if_index,
3386 'input_source': input_source,
3389 def igmp_listen(self, enable, sw_if_index, saddr, gaddr):
3390 """ Listen for new (S,G) on specified interface
3392 :param enable: add/del
3393 :param sw_if_index: interface sw index
3394 :param saddr: source ip4 addr
3395 :param gaddr: group ip4 addr
3397 return self.api(self.papi.igmp_listen,
3399 'sw_if_index': sw_if_index,
3403 def igmp_dump(self, sw_if_index=None):
3404 """ Dump all (S,G) interface configurations """
3405 if sw_if_index is None:
3410 return self.api(self.papi.igmp_dump, {'sw_if_index': sw_if_index,
3411 'dump_all': dump_all})
3413 def igmp_clear_interface(self, sw_if_index):
3414 """ Remove all (S,G)s from specified interface
3415 doesn't send IGMP report!
3418 self.papi.igmp_clear_interface, {
3419 'sw_if_index': sw_if_index})
3421 def want_igmp_events(self, enable=1):
3422 return self.api(self.papi.want_igmp_events, {'enable': enable,
3423 'pid': os.getpid()})
3433 :param lb: load balance
3434 :param use_custom_mac: use custom mac
3435 :param mac_address: mac address
3438 self.papi.bond_create,
3441 'use_custom_mac': use_custom_mac,
3442 'mac_address': mac_address
3449 :param sw_if_index: interface the operation is applied to
3451 return self.api(self.papi.bond_delete,
3452 {'sw_if_index': sw_if_index})
3461 :param sw_if_index: slave sw_if_index
3462 :param bond_sw_if_index: bond sw_if_index
3463 :param is_passive: is passive lacp speaker
3464 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3467 self.papi.bond_enslave,
3468 {'sw_if_index': sw_if_index,
3469 'bond_sw_if_index': bond_sw_if_index,
3470 'is_passive': is_passive,
3471 'is_long_timeout': is_long_timeout
3474 def bond_detach_slave(
3478 :param sw_if_index: slave interface the operation is applied to
3480 return self.api(self.papi.bond_detach_slave,
3481 {'sw_if_index': sw_if_index})
3483 def sw_interface_slave_dump(
3487 :param sw_if_index: bond sw_if_index
3489 return self.api(self.papi.sw_interface_slave_dump,
3490 {'sw_if_index': sw_if_index})
3492 def sw_interface_bond_dump(
3497 return self.api(self.papi.sw_interface_bond_dump,
3500 def create_vhost_user_if(
3505 custom_dev_instance,
3510 :param is_server: is server
3511 :param sock_filename: socket name
3512 :param renumber: renumber
3513 :param custom_dev_instance: custom dev instance
3514 :param use_custom_mac: use custom mac
3515 :param mac_address: mac address
3516 :param tag: tag (default ''
3519 self.papi.create_vhost_user_if,
3520 {'is_server': is_server,
3521 'sock_filename': sock_filename,
3522 'renumber': renumber,
3523 'custom_dev_instance': custom_dev_instance,
3524 'use_custom_mac': use_custom_mac,
3525 'mac_address': mac_address,
3529 def delete_vhost_user_if(
3533 :param sw_if_index: interface the operation is applied to
3535 return self.api(self.papi.delete_vhost_user_if,
3536 {'sw_if_index': sw_if_index, })
3538 def sw_interface_vhost_user_dump(
3543 return self.api(self.papi.sw_interface_vhost_user_dump,
3546 def abf_policy_add_del(self, is_add, policy):
3548 self.papi.abf_policy_add_del,
3552 def abf_itf_attach_add_del(self, is_add, attach):
3554 self.papi.abf_itf_attach_add_del,
3558 def abf_policy_dump(self):
3560 self.papi.abf_policy_dump, {})
3562 def abf_itf_attach_dump(self):
3564 self.papi.abf_itf_attach_dump, {})