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 ID.
573 :param int bd_id: Bridge domain ID.
574 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
575 :param int feature_bitmap: Bitmap value of the feature to be set:
579 - uu-flood (1 << 3) or
582 return self.api(self.papi.bridge_flags,
585 'feature_bitmap': feature_bitmap})
587 def bridge_domain_dump(self, bd_id=0):
590 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
591 existing bridge domains returned)
592 :return: Dictionary of bridge domain(s) data.
594 return self.api(self.papi.bridge_domain_dump,
597 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
599 """Create or delete unidirectional cross-connect from Tx interface to
602 :param int rx_sw_if_index: Software interface index of Rx interface.
603 :param int tx_sw_if_index: Software interface index of Tx interface.
604 :param int enable: Create cross-connect if equal to 1, delete
605 cross-connect if equal to 0.
608 return self.api(self.papi.sw_interface_set_l2_xconnect,
609 {'rx_sw_if_index': rx_sw_if_index,
610 'tx_sw_if_index': tx_sw_if_index,
613 def sw_interface_set_l2_tag_rewrite(
620 """L2 interface vlan tag rewrite configure request
621 :param client_index - opaque cookie to identify the sender
622 :param context - sender context, to match reply w/ request
623 :param sw_if_index - interface the operation is applied to
624 :param vtr_op - Choose from l2_vtr_op_t enum values
625 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
626 :param tag1 - Needed for any push or translate vtr op
627 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
630 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
631 {'sw_if_index': sw_if_index,
637 def sw_interface_set_l2_emulation(
642 :param sw_if_index - interface the operation is applied to
645 return self.api(self.papi.l2_emulation,
646 {'sw_if_index': sw_if_index,
649 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
652 :param admin_up_down:
656 return self.api(self.papi.sw_interface_set_flags,
657 {'sw_if_index': sw_if_index,
658 'admin_up_down': admin_up_down})
660 def sw_interface_set_mtu(self, sw_if_index, mtu):
666 return self.api(self.papi.sw_interface_set_mtu,
667 {'sw_if_index': sw_if_index,
670 def sw_interface_set_mac_address(self, sw_if_index, mac):
671 return self.api(self.papi.sw_interface_set_mac_address,
672 {'sw_if_index': sw_if_index,
675 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
676 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
677 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
678 """Create subinterface
679 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
681 :param sub_id: param inner_vlan:
685 :param no_tags: (Default value = 0)
686 :param one_tag: (Default value = 0)
687 :param two_tags: (Default value = 0)
688 :param dot1ad: (Default value = 0)
689 :param exact_match: (Default value = 0)
690 :param default_sub: (Default value = 0)
691 :param outer_vlan_id_any: (Default value = 0)
692 :param inner_vlan_id_any: (Default value = 0)
696 self.papi.create_subif,
697 {'sw_if_index': sw_if_index,
701 'two_tags': two_tags,
703 'exact_match': exact_match,
704 'default_sub': default_sub,
705 'outer_vlan_id_any': outer_vlan_id_any,
706 'inner_vlan_id_any': inner_vlan_id_any,
707 'outer_vlan_id': outer_vlan,
708 'inner_vlan_id': inner_vlan})
710 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
711 """Create p2p ethernet subinterface
713 :param sw_if_index: main (parent) interface
714 :param remote_mac: client (remote) mac address
718 self.papi.p2p_ethernet_add,
719 {'parent_if_index': sw_if_index,
720 'remote_mac': remote_mac,
721 'subif_id': subif_id})
723 def delete_subif(self, sw_if_index):
724 """Delete subinterface
728 return self.api(self.papi.delete_subif,
729 {'sw_if_index': sw_if_index})
731 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
732 """Delete p2p ethernet subinterface
734 :param sw_if_index: main (parent) interface
735 :param remote_mac: client (remote) mac address
739 self.papi.p2p_ethernet_del,
740 {'parent_if_index': sw_if_index,
741 'remote_mac': remote_mac})
743 def create_vlan_subif(self, sw_if_index, vlan):
750 return self.api(self.papi.create_vlan_subif,
751 {'sw_if_index': sw_if_index,
754 def create_loopback(self, mac=''):
757 :param mac: (Optional)
759 return self.api(self.papi.create_loopback,
760 {'mac_address': mac})
762 def delete_loopback(self, sw_if_index):
763 return self.api(self.papi.delete_loopback,
764 {'sw_if_index': sw_if_index, })
766 def ip_table_add_del(self,
773 :param is_add: (Default value = 1)
774 :param is_ipv6: (Default value = 0)
779 self.papi.ip_table_add_del,
780 {'table_id': table_id,
784 def ip_add_del_route(
789 next_hop_sw_if_index=0xFFFFFFFF,
793 next_hop_n_out_labels=0,
794 next_hop_out_label_stack=[],
795 next_hop_via_label=MPLS_LABEL_INVALID,
796 next_hop_id=0xFFFFFFFF,
798 is_resolve_attached=0,
799 classify_table_index=0xFFFFFFFF,
813 :param dst_address_length:
814 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
816 :param next_hop_address:
817 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
818 :param vrf_id: (Default value = 0)
819 :param lookup_in_vrf: (Default value = 0)
820 :param classify_table_index: (Default value = 0xFFFFFFFF)
821 :param is_add: (Default value = 1)
822 :param is_drop: (Default value = 0)
823 :param is_ipv6: (Default value = 0)
824 :param is_local: (Default value = 0)
825 :param is_classify: (Default value = 0)
826 :param is_multipath: (Default value = 0)
827 :param is_resolve_host: (Default value = 0)
828 :param is_resolve_attached: (Default value = 0)
829 :param is_dvr: (Default value = 0)
830 :param is_source_lookup: (Default value = 0)
831 :param next_hop_weight: (Default value = 1)
836 self.papi.ip_add_del_route,
837 {'next_hop_sw_if_index': next_hop_sw_if_index,
838 'table_id': table_id,
839 'classify_table_index': classify_table_index,
840 'next_hop_table_id': next_hop_table_id,
843 'is_unreach': is_unreach,
844 'is_prohibit': is_prohibit,
846 'is_local': is_local,
847 'is_classify': is_classify,
848 'is_multipath': is_multipath,
849 'is_resolve_host': is_resolve_host,
850 'is_resolve_attached': is_resolve_attached,
852 'is_source_lookup': is_source_lookup,
853 'is_udp_encap': is_udp_encap,
854 'next_hop_weight': next_hop_weight,
855 'dst_address_length': dst_address_length,
856 'dst_address': dst_address,
857 'next_hop_id': next_hop_id,
858 'next_hop_address': next_hop_address,
859 'next_hop_n_out_labels': next_hop_n_out_labels,
860 'next_hop_via_label': next_hop_via_label,
861 'next_hop_out_label_stack': next_hop_out_label_stack})
863 def ip_fib_dump(self):
864 return self.api(self.papi.ip_fib_dump, {})
866 def ip6_fib_dump(self):
867 return self.api(self.papi.ip6_fib_dump, {})
869 def ip_neighbor_add_del(self,
878 """ Add neighbor MAC to IPv4 or IPv6 address.
883 :param is_add: (Default value = 1)
884 :param is_ipv6: (Default value = 0)
885 :param is_static: (Default value = 0)
886 :param is_no_adj_fib: (Default value = 0)
890 self.papi.ip_neighbor_add_del,
891 {'sw_if_index': sw_if_index,
894 'is_static': is_static,
895 'is_no_adj_fib': is_no_adj_fib,
896 'mac_address': mac_address,
897 'dst_address': dst_address
901 def ip_neighbor_dump(self,
904 """ Return IP neighbor dump.
907 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
911 self.papi.ip_neighbor_dump,
913 'sw_if_index': sw_if_index
917 def proxy_arp_add_del(self,
922 """ Config Proxy Arp Range.
924 :param low_address: Start address in the rnage to Proxy for
925 :param hi_address: End address in the rnage to Proxy for
926 :param vrf_id: The VRF/table in which to proxy
930 self.papi.proxy_arp_add_del,
933 'low_address': low_address,
934 'hi_address': hi_address,
938 def proxy_arp_intfc_enable_disable(self,
941 """ Enable/Disable an interface for proxy ARP requests
943 :param sw_if_index: Interface
944 :param enable_disable: Enable/Disable
948 self.papi.proxy_arp_intfc_enable_disable,
949 {'sw_if_index': sw_if_index,
950 'enable_disable': is_enable
958 """ Reset VRF (remove all routes etc.) request.
960 :param int vrf_id: ID of the FIB table / VRF to reset.
961 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
975 """ Reset VRF (remove all routes etc.) request.
977 :param int vrf_id: ID of the FIB table / VRF to reset.
978 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
993 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1002 def sw_interface_span_enable_disable(
1003 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1006 :param sw_if_index_from:
1007 :param sw_if_index_to:
1011 return self.api(self.papi.sw_interface_span_enable_disable,
1012 {'sw_if_index_from': sw_if_index_from,
1013 'sw_if_index_to': sw_if_index_to,
1018 def gre_tunnel_add_del(self,
1023 instance=0xFFFFFFFF,
1027 """ Add a GRE tunnel
1031 :param outer_fib_id: (Default value = 0)
1032 :param tunnel_type: (Default value = 0)
1033 :param instance: (Default value = 0xFFFFFFFF)
1034 :param session_id: (Defalt value = 0)
1035 :param is_add: (Default value = 1)
1036 :param is_ipv6: (Default value = 0)
1040 self.papi.gre_add_del_tunnel,
1043 'tunnel_type': tunnel_type,
1044 'instance': instance,
1045 'src_address': src_address,
1046 'dst_address': dst_address,
1047 'outer_fib_id': outer_fib_id,
1048 'session_id': session_id}
1051 def udp_encap_add_del(self,
1060 """ Add a GRE tunnel
1061 :param id: user provided ID
1066 :param outer_fib_id: (Default value = 0)
1067 :param is_add: (Default value = 1)
1068 :param is_ipv6: (Default value = 0)
1072 self.papi.udp_encap_add_del,
1078 'src_port': src_port,
1079 'dst_port': dst_port,
1080 'table_id': table_id}
1083 def udp_encap_dump(self):
1084 return self.api(self.papi.udp_encap_dump, {})
1086 def want_udp_encap_stats(self, enable=1):
1087 return self.api(self.papi.want_udp_encap_stats,
1089 'pid': os.getpid()})
1091 def mpls_fib_dump(self):
1092 return self.api(self.papi.mpls_fib_dump, {})
1094 def mpls_table_add_del(
1101 :param is_add: (Default value = 1)
1106 self.papi.mpls_table_add_del,
1107 {'mt_table_id': table_id,
1108 'mt_is_add': is_add})
1110 def mpls_route_add_del(
1116 next_hop_sw_if_index=0xFFFFFFFF,
1118 next_hop_table_id=0,
1120 next_hop_n_out_labels=0,
1121 next_hop_out_label_stack=[],
1122 next_hop_via_label=MPLS_LABEL_INVALID,
1124 is_resolve_attached=0,
1131 classify_table_index=0xFFFFFFFF,
1135 :param dst_address_length:
1136 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1138 :param next_hop_address:
1139 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1140 :param vrf_id: (Default value = 0)
1141 :param lookup_in_vrf: (Default value = 0)
1142 :param classify_table_index: (Default value = 0xFFFFFFFF)
1143 :param is_add: (Default value = 1)
1144 :param is_drop: (Default value = 0)
1145 :param is_ipv6: (Default value = 0)
1146 :param is_local: (Default value = 0)
1147 :param is_classify: (Default value = 0)
1148 :param is_multipath: (Default value = 0)
1149 :param is_multicast: (Default value = 0)
1150 :param is_resolve_host: (Default value = 0)
1151 :param is_resolve_attached: (Default value = 0)
1152 :param next_hop_weight: (Default value = 1)
1156 self.papi.mpls_route_add_del,
1159 'mr_table_id': table_id,
1160 'mr_classify_table_index': classify_table_index,
1161 'mr_is_add': is_add,
1162 'mr_is_classify': is_classify,
1163 'mr_is_multipath': is_multipath,
1164 'mr_is_multicast': is_multicast,
1165 'mr_is_resolve_host': is_resolve_host,
1166 'mr_is_resolve_attached': is_resolve_attached,
1167 'mr_is_interface_rx': is_interface_rx,
1168 'mr_is_rpf_id': is_rpf_id,
1169 'mr_next_hop_proto': next_hop_proto,
1170 'mr_next_hop_weight': next_hop_weight,
1171 'mr_next_hop': next_hop_address,
1172 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1173 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1174 'mr_next_hop_table_id': next_hop_table_id,
1175 'mr_next_hop_via_label': next_hop_via_label,
1176 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1178 def mpls_ip_bind_unbind(
1190 self.papi.mpls_ip_bind_unbind,
1191 {'mb_mpls_table_id': table_id,
1193 'mb_ip_table_id': ip_table_id,
1194 'mb_is_bind': is_bind,
1195 'mb_is_ip4': is_ip4,
1196 'mb_address_length': dst_address_length,
1197 'mb_address': dst_address})
1199 def mpls_tunnel_add_del(
1202 next_hop_proto_is_ip4,
1204 next_hop_sw_if_index=0xFFFFFFFF,
1205 next_hop_table_id=0,
1207 next_hop_n_out_labels=0,
1208 next_hop_out_label_stack=[],
1209 next_hop_via_label=MPLS_LABEL_INVALID,
1215 :param dst_address_length:
1216 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1218 :param next_hop_address:
1219 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1220 :param vrf_id: (Default value = 0)
1221 :param lookup_in_vrf: (Default value = 0)
1222 :param classify_table_index: (Default value = 0xFFFFFFFF)
1223 :param is_add: (Default value = 1)
1224 :param is_drop: (Default value = 0)
1225 :param is_ipv6: (Default value = 0)
1226 :param is_local: (Default value = 0)
1227 :param is_classify: (Default value = 0)
1228 :param is_multipath: (Default value = 0)
1229 :param is_resolve_host: (Default value = 0)
1230 :param is_resolve_attached: (Default value = 0)
1231 :param next_hop_weight: (Default value = 1)
1232 :param is_multicast: (Default value = 0)
1236 self.papi.mpls_tunnel_add_del,
1237 {'mt_sw_if_index': tun_sw_if_index,
1238 'mt_is_add': is_add,
1239 'mt_l2_only': l2_only,
1240 'mt_is_multicast': is_multicast,
1241 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1242 'mt_next_hop_weight': next_hop_weight,
1243 'mt_next_hop': next_hop_address,
1244 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1245 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1246 'mt_next_hop_table_id': next_hop_table_id,
1247 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1249 def nat44_interface_add_del_feature(
1254 """Enable/disable NAT44 feature on the interface
1256 :param sw_if_index: Software index of the interface
1257 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1258 :param is_add: 1 if add, 0 if delete (Default value = 1)
1261 self.papi.nat44_interface_add_del_feature,
1263 'is_inside': is_inside,
1264 'sw_if_index': sw_if_index})
1266 def nat44_interface_add_del_output_feature(
1271 """Enable/disable NAT44 output feature on the interface
1273 :param sw_if_index: Software index of the interface
1274 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1275 :param is_add: 1 if add, 0 if delete (Default value = 1)
1278 self.papi.nat44_interface_add_del_output_feature,
1280 'is_inside': is_inside,
1281 'sw_if_index': sw_if_index})
1283 def nat44_add_del_static_mapping(
1287 external_sw_if_index=0xFFFFFFFF,
1297 """Add/delete NAT44 static mapping
1299 :param local_ip: Local IP address
1300 :param external_ip: External IP address
1301 :param external_sw_if_index: External interface instead of IP address
1302 :param local_port: Local port number (Default value = 0)
1303 :param external_port: External port number (Default value = 0)
1304 :param addr_only: 1 if address only mapping, 0 if address and port
1305 :param vrf_id: VRF ID
1306 :param protocol: IP protocol (Default value = 0)
1307 :param twice_nat: 1 if translate external host address and port
1308 :param out2in_only: if 1 rule is matching only out2in direction
1309 :param tag: Opaque string tag
1310 :param is_add: 1 if add, 0 if delete (Default value = 1)
1313 self.papi.nat44_add_del_static_mapping,
1315 'addr_only': addr_only,
1316 'local_ip_address': local_ip,
1317 'external_ip_address': external_ip,
1318 'local_port': local_port,
1319 'external_port': external_port,
1320 'external_sw_if_index': external_sw_if_index,
1322 'protocol': protocol,
1323 'twice_nat': twice_nat,
1324 'out2in_only': out2in_only,
1327 def nat44_add_del_identity_mapping(
1330 sw_if_index=0xFFFFFFFF,
1337 """Add/delete NAT44 identity mapping
1339 :param ip: IP address (Default value = 0)
1340 :param sw_if_index: Interface instead of IP address
1341 :param port: Port number (Default value = 0)
1342 :param addr_only: 1 if address only mapping, 0 if address and port
1343 :param vrf_id: VRF ID
1344 :param protocol: IP protocol (Default value = 0)
1345 :param tag: Opaque string tag
1346 :param is_add: 1 if add, 0 if delete (Default value = 1)
1349 self.papi.nat44_add_del_identity_mapping,
1351 'addr_only': addr_only,
1354 'sw_if_index': sw_if_index,
1357 'protocol': protocol})
1359 def nat44_add_del_address_range(
1366 """Add/del NAT44 address range
1368 :param first_ip_address: First IP address
1369 :param last_ip_address: Last IP address
1370 :param vrf_id: VRF id for the address range
1371 :param twice_nat: twice NAT address for extenal hosts
1372 :param is_add: 1 if add, 0 if delete (Default value = 1)
1375 self.papi.nat44_add_del_address_range,
1376 {'first_ip_address': first_ip_address,
1377 'last_ip_address': last_ip_address,
1379 'twice_nat': twice_nat,
1382 def nat44_address_dump(self):
1383 """Dump NAT44 addresses
1384 :return: Dictionary of NAT44 addresses
1386 return self.api(self.papi.nat44_address_dump, {})
1388 def nat44_interface_dump(self):
1389 """Dump interfaces with NAT44 feature
1390 :return: Dictionary of interfaces with NAT44 feature
1392 return self.api(self.papi.nat44_interface_dump, {})
1394 def nat44_interface_output_feature_dump(self):
1395 """Dump interfaces with NAT44 output feature
1396 :return: Dictionary of interfaces with NAT44 output feature
1398 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1400 def nat44_static_mapping_dump(self):
1401 """Dump NAT44 static mappings
1402 :return: Dictionary of NAT44 static mappings
1404 return self.api(self.papi.nat44_static_mapping_dump, {})
1406 def nat44_identity_mapping_dump(self):
1407 """Dump NAT44 identity mappings
1408 :return: Dictionary of NAT44 identity mappings
1410 return self.api(self.papi.nat44_identity_mapping_dump, {})
1412 def nat_show_config(self):
1413 """Show NAT plugin config
1414 :return: NAT plugin config parameters
1416 return self.api(self.papi.nat_show_config, {})
1418 def nat44_add_interface_addr(
1423 """Add/del NAT44 address from interface
1425 :param sw_if_index: Software index of the interface
1426 :param twice_nat: twice NAT address for extenal hosts
1427 :param is_add: 1 if add, 0 if delete (Default value = 1)
1430 self.papi.nat44_add_del_interface_addr,
1432 'sw_if_index': sw_if_index,
1433 'twice_nat': twice_nat})
1435 def nat44_interface_addr_dump(self):
1436 """Dump NAT44 addresses interfaces
1437 :return: Dictionary of NAT44 addresses interfaces
1439 return self.api(self.papi.nat44_interface_addr_dump, {})
1446 """Enable/disable NAT IPFIX logging
1448 :param domain_id: Observation domain ID (Default value = 1)
1449 :param src_port: Source port number (Default value = 4739)
1450 :param enable: 1 if enable, 0 if disable (Default value = 1)
1453 self.papi.nat_ipfix_enable_disable,
1454 {'domain_id': domain_id,
1455 'src_port': src_port,
1458 def nat44_user_session_dump(
1462 """Dump NAT44 user's sessions
1464 :param ip_address: ip adress of the user to be dumped
1465 :param cpu_index: cpu_index on which the user is
1466 :param vrf_id: VRF ID
1467 :return: Dictionary of S-NAT sessions
1470 self.papi.nat44_user_session_dump,
1471 {'ip_address': ip_address,
1474 def nat44_user_dump(self):
1477 :return: Dictionary of NAT44 users
1479 return self.api(self.papi.nat44_user_dump, {})
1481 def nat44_add_del_lb_static_mapping(
1493 """Add/delete NAT44 load balancing static mapping
1495 :param twice_nat: 1 if translate external host address and port
1496 :param tag: Opaque string tag
1497 :param is_add - 1 if add, 0 if delete
1500 self.papi.nat44_add_del_lb_static_mapping,
1502 'external_addr': external_addr,
1503 'external_port': external_port,
1504 'protocol': protocol,
1506 'twice_nat': twice_nat,
1507 'out2in_only': out2in_only,
1509 'local_num': local_num,
1512 def nat44_lb_static_mapping_dump(self):
1513 """Dump NAT44 load balancing static mappings
1515 :return: Dictionary of NAT44 load balancing static mapping
1517 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1519 def nat44_del_session(
1526 """Delete NAT44 session
1528 :param addr: IPv4 address
1529 :param por: port number
1530 :param protocol: IP protocol number
1531 :param vrf_id: VRF ID
1532 :param is_in: 1 if inside network addres and port pari, 0 if outside
1535 self.papi.nat44_del_session,
1538 'protocol': protocol,
1542 def nat44_forwarding_enable_disable(
1545 """Enable/disable forwarding for NAT44
1547 :param enable: 1 for enable, 0 for disable
1550 self.papi.nat44_forwarding_enable_disable,
1560 """Set NAT virtual fragmentation reassembly
1562 :param timeout: reassembly timeout (Default 2sec)
1563 :param max_reass: maximum concurrent reassemblies (Default 1024)
1564 :param max_frag: maximum fragmets per reassembly (Default 5)
1565 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1566 :param is_ip6: 1 if IPv6, 0 if IPv4
1569 self.papi.nat_set_reass,
1570 {'timeout': timeout,
1571 'max_reass': max_reass,
1572 'max_frag': max_frag,
1573 'drop_frag': drop_frag,
1576 def nat_get_reass(self):
1577 """Get NAT virtual fragmentation reassembly configuration
1579 :return: NAT virtual fragmentation reassembly configuration
1581 return self.api(self.papi.nat_get_reass, {})
1583 def nat_reass_dump(self):
1584 """Dump NAT virtual fragmentation reassemblies
1586 :return: Dictionary of NAT virtual fragmentation reassemblies
1588 return self.api(self.papi.nat_reass_dump, {})
1590 def nat_det_add_del_map(
1597 """Add/delete deterministic NAT mapping
1599 :param is_add - 1 if add, 0 if delete
1600 :param in_addr - inside IP address
1601 :param in_plen - inside IP address prefix length
1602 :param out_addr - outside IP address
1603 :param out_plen - outside IP address prefix length
1606 self.papi.nat_det_add_del_map,
1611 'out_addr': out_addr,
1612 'out_plen': out_plen})
1614 def nat_det_forward(
1617 """Get outside address and port range from inside address
1619 :param in_addr - inside IP address
1622 self.papi.nat_det_forward,
1623 {'in_addr': in_addr,
1626 def nat_det_reverse(
1630 """Get inside address from outside address and port
1632 :param out_addr - outside IP address
1633 :param out_port - outside port
1636 self.papi.nat_det_reverse,
1637 {'out_addr': out_addr,
1638 'out_port': out_port})
1640 def nat_det_map_dump(self):
1641 """Dump deterministic NAT mappings
1643 :return: Dictionary of deterministic NAT mappings
1645 return self.api(self.papi.nat_det_map_dump, {})
1647 def nat_det_set_timeouts(
1650 tcp_established=7440,
1653 """Set values of timeouts for deterministic NAT (in seconds)
1655 :param udp - UDP timeout (Default value = 300)
1656 :param tcp_established - TCP established timeout (Default value = 7440)
1657 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1658 :param icmp - ICMP timeout (Default value = 60)
1661 self.papi.nat_det_set_timeouts,
1663 'tcp_established': tcp_established,
1664 'tcp_transitory': tcp_transitory,
1667 def nat_det_get_timeouts(self):
1668 """Get values of timeouts for deterministic NAT
1670 :return: Timeouts for deterministic NAT (in seconds)
1672 return self.api(self.papi.nat_det_get_timeouts, {})
1674 def nat_det_close_session_out(
1680 """Close deterministic NAT session using outside address and port
1682 :param out_addr - outside IP address
1683 :param out_port - outside port
1684 :param ext_addr - external host IP address
1685 :param ext_port - external host port
1688 self.papi.nat_det_close_session_out,
1689 {'out_addr': out_addr,
1690 'out_port': out_port,
1691 'ext_addr': ext_addr,
1692 'ext_port': ext_port})
1694 def nat_det_close_session_in(
1700 """Close deterministic NAT session using inside address and port
1702 :param in_addr - inside IP address
1703 :param in_port - inside port
1704 :param ext_addr - external host IP address
1705 :param ext_port - external host port
1708 self.papi.nat_det_close_session_in,
1709 {'in_addr': in_addr,
1711 'ext_addr': ext_addr,
1712 'ext_port': ext_port,
1715 def nat_det_session_dump(
1718 """Dump deterministic NAT sessions belonging to a user
1720 :param user_addr - inside IP address of the user
1721 :return: Dictionary of deterministic NAT sessions
1724 self.papi.nat_det_session_dump,
1726 'user_addr': user_addr})
1728 def nat64_add_del_pool_addr_range(
1734 """Add/del address range to NAT64 pool
1736 :param start_addr: First IP address
1737 :param end_addr: Last IP address
1738 :param vrf_id: VRF id for the address range
1739 :param is_add: 1 if add, 0 if delete (Default value = 1)
1742 self.papi.nat64_add_del_pool_addr_range,
1743 {'start_addr': start_addr,
1744 'end_addr': end_addr,
1748 def nat64_pool_addr_dump(self):
1749 """Dump NAT64 pool addresses
1750 :return: Dictionary of NAT64 pool addresses
1752 return self.api(self.papi.nat64_pool_addr_dump, {})
1754 def nat64_add_del_interface(
1759 """Enable/disable NAT64 feature on the interface
1760 :param sw_if_index: Index of the interface
1761 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1762 :param is_add: 1 if add, 0 if delete (Default value = 1)
1765 self.papi.nat64_add_del_interface,
1766 {'sw_if_index': sw_if_index,
1767 'is_inside': is_inside,
1770 def nat64_interface_dump(self):
1771 """Dump interfaces with NAT64 feature
1772 :return: Dictionary of interfaces with NAT64 feature
1774 return self.api(self.papi.nat64_interface_dump, {})
1776 def nat64_add_del_static_bib(
1785 """Add/delete S-NAT static BIB entry
1787 :param in_ip: Inside IPv6 address
1788 :param out_ip: Outside IPv4 address
1789 :param in_port: Inside port number
1790 :param out_port: Outside port number
1791 :param protocol: IP protocol
1792 :param vrf_id: VRF ID (Default value = 0)
1793 :param is_add: 1 if add, 0 if delete (Default value = 1)
1796 self.papi.nat64_add_del_static_bib,
1805 def nat64_bib_dump(self, protocol=255):
1808 :param protocol: IP protocol (Default value = 255, all BIBs)
1809 :returns: Dictionary of NAT64 BIB entries
1811 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1813 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1814 tcp_incoming_syn=6):
1815 """Set values of timeouts for NAT64 (in seconds)
1817 :param udpi: UDP timeout (Default value = 300)
1818 :param icmp: ICMP timeout (Default value = 60)
1819 :param tcp_trans: TCP transitory timeout (Default value = 240)
1820 :param tcp_est: TCP established timeout (Default value = 7440)
1821 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1824 self.papi.nat64_set_timeouts,
1827 'tcp_trans': tcp_trans,
1829 'tcp_incoming_syn': tcp_incoming_syn})
1831 def nat64_get_timeouts(self):
1832 """Get values of timeouts for NAT64
1834 :return: Timeouts for NAT64 (in seconds)
1836 return self.api(self.papi.nat64_get_timeouts, {})
1838 def nat64_st_dump(self, protocol=255):
1839 """Dump NAT64 session table
1841 :param protocol: IP protocol (Default value = 255, all STs)
1842 :returns: Dictionary of NAT64 sesstion table entries
1844 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1846 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1847 """Add/del NAT64 prefix
1849 :param prefix: NAT64 prefix
1850 :param plen: NAT64 prefix length
1851 :param vrf_id: VRF id of tenant (Default 0)
1852 :param is_add: 1 if add, 0 if delete (Default value = 1)
1855 self.papi.nat64_add_del_prefix,
1861 def nat64_prefix_dump(self):
1862 """Dump NAT64 prefix
1864 :returns: Dictionary of NAT64 prefixes
1866 return self.api(self.papi.nat64_prefix_dump, {})
1868 def nat64_add_interface_addr(
1872 """Add/del NAT64 address from interface
1874 :param sw_if_index: Software index of the interface
1875 :param is_add: 1 if add, 0 if delete (Default value = 1)
1877 return self.api(self.papi.nat64_add_del_interface_addr,
1878 {'is_add': is_add, 'sw_if_index': sw_if_index})
1880 def dslite_set_aftr_addr(self, ip6, ip4):
1881 """Set DS-Lite AFTR addresses
1883 :param ip4: IPv4 address
1884 :param ip6: IPv6 address
1887 self.papi.dslite_set_aftr_addr,
1891 def dslite_set_b4_addr(self, ip6, ip4):
1892 """Set DS-Lite B4 IPv6 address
1894 :param ip4: IPv4 address
1895 :param ip6: IPv6 address
1898 self.papi.dslite_set_b4_addr,
1902 def dslite_add_del_pool_addr_range(
1907 """Add/del address range to DS-Lite pool
1909 :param start_addr: First IP address
1910 :param end_addr: Last IP address
1911 :param is_add: 1 if add, 0 if delete (Default value = 1)
1914 self.papi.dslite_add_del_pool_addr_range,
1915 {'start_addr': start_addr,
1916 'end_addr': end_addr,
1919 def nat66_add_del_interface(
1924 """Enable/disable NAT66 feature on the interface
1925 :param sw_if_index: Index of the interface
1926 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1927 :param is_add: 1 if add, 0 if delete (Default value = 1)
1930 self.papi.nat66_add_del_interface,
1931 {'sw_if_index': sw_if_index,
1932 'is_inside': is_inside,
1935 def nat66_add_del_static_mapping(
1941 """Add/delete NAT66 static mapping
1943 :param in_ip: Inside IPv6 address
1944 :param out_ip: Outside IPv6 address
1945 :param vrf_id: VRF ID (Default value = 0)
1946 :param is_add: 1 if add, 0 if delete (Default value = 1)
1949 self.papi.nat66_add_del_static_mapping,
1950 {'local_ip_address': in_ip,
1951 'external_ip_address': out_ip,
1955 def nat66_interface_dump(self):
1956 """Dump interfaces with NAT66 feature
1957 :return: Dictionary of interfaces with NAT66 feature
1959 return self.api(self.papi.nat66_interface_dump, {})
1961 def nat66_static_mapping_dump(self):
1962 """Dump NAT66 static mappings
1963 :return: Dictionary of NAT66 static mappings
1965 return self.api(self.papi.nat66_static_mapping_dump, {})
1967 def control_ping(self):
1968 self.api(self.papi.control_ping)
1970 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1971 detect_mult, local_addr, peer_addr, is_ipv6=0,
1972 bfd_key_id=None, conf_key_id=None):
1973 if bfd_key_id is None:
1974 return self.api(self.papi.bfd_udp_add,
1976 'sw_if_index': sw_if_index,
1977 'desired_min_tx': desired_min_tx,
1978 'required_min_rx': required_min_rx,
1979 'local_addr': local_addr,
1980 'peer_addr': peer_addr,
1982 'detect_mult': detect_mult,
1985 return self.api(self.papi.bfd_udp_add,
1987 'sw_if_index': sw_if_index,
1988 'desired_min_tx': desired_min_tx,
1989 'required_min_rx': required_min_rx,
1990 'local_addr': local_addr,
1991 'peer_addr': peer_addr,
1993 'detect_mult': detect_mult,
1994 'is_authenticated': 1,
1995 'bfd_key_id': bfd_key_id,
1996 'conf_key_id': conf_key_id,
1999 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2000 detect_mult, local_addr, peer_addr, is_ipv6=0):
2001 return self.api(self.papi.bfd_udp_mod,
2003 'sw_if_index': sw_if_index,
2004 'desired_min_tx': desired_min_tx,
2005 'required_min_rx': required_min_rx,
2006 'local_addr': local_addr,
2007 'peer_addr': peer_addr,
2009 'detect_mult': detect_mult,
2012 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2013 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2015 return self.api(self.papi.bfd_udp_auth_activate,
2017 'sw_if_index': sw_if_index,
2018 'local_addr': local_addr,
2019 'peer_addr': peer_addr,
2021 'is_delayed': 1 if is_delayed else 0,
2022 'bfd_key_id': bfd_key_id,
2023 'conf_key_id': conf_key_id,
2026 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2027 is_ipv6=0, is_delayed=False):
2028 return self.api(self.papi.bfd_udp_auth_deactivate,
2030 'sw_if_index': sw_if_index,
2031 'local_addr': local_addr,
2032 'peer_addr': peer_addr,
2034 'is_delayed': 1 if is_delayed else 0,
2037 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2038 return self.api(self.papi.bfd_udp_del,
2040 'sw_if_index': sw_if_index,
2041 'local_addr': local_addr,
2042 'peer_addr': peer_addr,
2046 def bfd_udp_session_dump(self):
2047 return self.api(self.papi.bfd_udp_session_dump, {})
2049 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2050 peer_addr, is_ipv6=0):
2051 return self.api(self.papi.bfd_udp_session_set_flags, {
2052 'admin_up_down': admin_up_down,
2053 'sw_if_index': sw_if_index,
2054 'local_addr': local_addr,
2055 'peer_addr': peer_addr,
2059 def want_bfd_events(self, enable_disable=1):
2060 return self.api(self.papi.want_bfd_events, {
2061 'enable_disable': enable_disable,
2065 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2066 return self.api(self.papi.bfd_auth_set_key, {
2067 'conf_key_id': conf_key_id,
2068 'auth_type': auth_type,
2070 'key_len': len(key),
2073 def bfd_auth_del_key(self, conf_key_id):
2074 return self.api(self.papi.bfd_auth_del_key, {
2075 'conf_key_id': conf_key_id,
2078 def bfd_auth_keys_dump(self):
2079 return self.api(self.papi.bfd_auth_keys_dump, {})
2081 def bfd_udp_set_echo_source(self, sw_if_index):
2082 return self.api(self.papi.bfd_udp_set_echo_source,
2083 {'sw_if_index': sw_if_index})
2085 def bfd_udp_del_echo_source(self):
2086 return self.api(self.papi.bfd_udp_del_echo_source, {})
2088 def classify_add_del_table(
2093 table_index=0xFFFFFFFF,
2095 memory_size=2097152,
2097 next_table_index=0xFFFFFFFF,
2098 miss_next_index=0xFFFFFFFF,
2099 current_data_flag=0,
2100 current_data_offset=0):
2104 :param match_n_vectors: (Default value = 1)
2105 :param table_index: (Default value = 0xFFFFFFFF)
2106 :param nbuckets: (Default value = 2)
2107 :param memory_size: (Default value = 2097152)
2108 :param skip_n_vectors: (Default value = 0)
2109 :param next_table_index: (Default value = 0xFFFFFFFF)
2110 :param miss_next_index: (Default value = 0xFFFFFFFF)
2111 :param current_data_flag: (Default value = 0)
2112 :param current_data_offset: (Default value = 0)
2116 self.papi.classify_add_del_table,
2118 'table_index': table_index,
2119 'nbuckets': nbuckets,
2120 'memory_size': memory_size,
2121 'skip_n_vectors': skip_n_vectors,
2122 'match_n_vectors': match_n_vectors,
2123 'next_table_index': next_table_index,
2124 'miss_next_index': miss_next_index,
2125 'current_data_flag': current_data_flag,
2126 'current_data_offset': current_data_offset,
2129 def classify_add_del_session(
2134 opaque_index=0xFFFFFFFF,
2135 hit_next_index=0xFFFFFFFF,
2143 :param opaque_index: (Default value = 0xFFFFFFFF)
2144 :param hit_next_index: (Default value = 0xFFFFFFFF)
2145 :param advance: (Default value = 0)
2146 :param action: (Default value = 0)
2147 :param metadata: (Default value = 0)
2151 self.papi.classify_add_del_session,
2153 'table_index': table_index,
2154 'hit_next_index': hit_next_index,
2155 'opaque_index': opaque_index,
2158 'metadata': metadata,
2161 def input_acl_set_interface(
2165 ip4_table_index=0xFFFFFFFF,
2166 ip6_table_index=0xFFFFFFFF,
2167 l2_table_index=0xFFFFFFFF):
2171 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2172 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2173 :param l2_table_index: (Default value = 0xFFFFFFFF)
2177 self.papi.input_acl_set_interface,
2178 {'sw_if_index': sw_if_index,
2179 'ip4_table_index': ip4_table_index,
2180 'ip6_table_index': ip6_table_index,
2181 'l2_table_index': l2_table_index,
2184 def output_acl_set_interface(
2188 ip4_table_index=0xFFFFFFFF,
2189 ip6_table_index=0xFFFFFFFF,
2190 l2_table_index=0xFFFFFFFF):
2194 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2195 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2196 :param l2_table_index: (Default value = 0xFFFFFFFF)
2200 self.papi.output_acl_set_interface,
2201 {'sw_if_index': sw_if_index,
2202 'ip4_table_index': ip4_table_index,
2203 'ip6_table_index': ip6_table_index,
2204 'l2_table_index': l2_table_index,
2207 def set_ipfix_exporter(
2214 collector_port=4739,
2217 self.papi.set_ipfix_exporter,
2219 'collector_address': collector_address,
2220 'collector_port': collector_port,
2221 'src_address': src_address,
2223 'path_mtu': path_mtu,
2224 'template_interval': template_interval,
2225 'udp_checksum': udp_checksum,
2228 def dhcp_proxy_config(self,
2236 self.papi.dhcp_proxy_config,
2238 'rx_vrf_id': rx_table_id,
2239 'server_vrf_id': server_table_id,
2242 'dhcp_server': dhcp_server,
2243 'dhcp_src_address': dhcp_src_address,
2246 def dhcp_proxy_set_vss(self,
2255 self.papi.dhcp_proxy_set_vss,
2258 'vss_type': vss_type,
2259 'vpn_ascii_id': vpn_ascii_id,
2261 'vpn_index': vpn_index,
2266 def dhcp_client(self,
2271 set_broadcast_flag=1,
2272 want_dhcp_events=0):
2274 self.papi.dhcp_client_config,
2276 'sw_if_index': sw_if_index,
2277 'hostname': hostname,
2278 'client_id': client_id,
2280 'want_dhcp_event': want_dhcp_events,
2281 'set_broadcast_flag': set_broadcast_flag,
2285 def ip_mroute_add_del(self,
2291 next_hop_sw_if_index,
2300 IP Multicast Route add/del
2303 self.papi.ip_mroute_add_del,
2304 {'next_hop_sw_if_index': next_hop_sw_if_index,
2305 'entry_flags': e_flags,
2306 'itf_flags': i_flags,
2307 'table_id': table_id,
2311 'is_local': is_local,
2312 'bier_imp': bier_imp,
2313 'next_hop_afi': next_hop_afi,
2314 'grp_address_length': grp_address_length,
2315 'grp_address': grp_address,
2316 'src_address': src_address})
2318 def mfib_signal_dump(self):
2319 return self.api(self.papi.mfib_signal_dump, {})
2321 def ip_mfib_dump(self):
2322 return self.api(self.papi.ip_mfib_dump, {})
2324 def ip6_mfib_dump(self):
2325 return self.api(self.papi.ip6_mfib_dump, {})
2327 def lisp_enable_disable(self, is_enabled):
2329 self.papi.lisp_enable_disable,
2331 'is_en': is_enabled,
2334 def lisp_locator_set(self,
2338 self.papi.lisp_add_del_locator_set,
2341 'locator_set_name': ls_name
2344 def lisp_locator_set_dump(self):
2345 return self.api(self.papi.lisp_locator_set_dump, {})
2347 def lisp_locator(self,
2354 self.papi.lisp_add_del_locator,
2357 'locator_set_name': ls_name,
2358 'sw_if_index': sw_if_index,
2359 'priority': priority,
2363 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2365 self.papi.lisp_locator_dump,
2367 'is_index_set': is_index_set,
2369 'ls_index': ls_index,
2372 def lisp_local_mapping(self,
2382 self.papi.lisp_add_del_local_eid,
2384 'locator_set_name': ls_name,
2386 'eid_type': eid_type,
2388 'prefix_len': prefix_len,
2394 def lisp_eid_table_dump(self,
2402 self.papi.lisp_eid_table_dump,
2405 'prefix_length': prefix_length,
2407 'eid_type': eid_type,
2409 'filter': filter_opt,
2412 def lisp_remote_mapping(self,
2422 self.papi.lisp_add_del_remote_mapping,
2425 'eid_type': eid_type,
2427 'eid_len': eid_prefix_len,
2428 'rloc_num': rlocs_num,
2431 'is_src_dst': is_src_dst,
2434 def lisp_adjacency(self,
2443 self.papi.lisp_add_del_adjacency,
2447 'eid_type': eid_type,
2450 'leid_len': leid_len,
2451 'reid_len': reid_len,
2454 def lisp_adjacencies_get(self, vni=0):
2456 self.papi.lisp_adjacencies_get,
2461 def map_add_domain(self,
2475 self.papi.map_add_domain,
2477 'ip6_prefix': ip6_prefix,
2478 'ip6_prefix_len': ip6_prefix_len,
2479 'ip4_prefix': ip4_prefix,
2480 'ip4_prefix_len': ip4_prefix_len,
2482 'ip6_src_prefix_len': ip6_src_prefix_len,
2483 'ea_bits_len': ea_bits_len,
2484 'psid_offset': psid_offset,
2485 'psid_length': psid_length,
2486 'is_translation': is_translation,
2487 'is_rfc6052': is_rfc6052,
2491 def gtpu_add_del_tunnel(
2497 mcast_sw_if_index=0xFFFFFFFF,
2499 decap_next_index=0xFFFFFFFF,
2503 :param is_add: (Default value = 1)
2504 :param is_ipv6: (Default value = 0)
2507 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2508 :param encap_vrf_id: (Default value = 0)
2509 :param decap_next_index: (Default value = 0xFFFFFFFF)
2510 :param teid: (Default value = 0)
2513 return self.api(self.papi.gtpu_add_del_tunnel,
2516 'src_address': src_addr,
2517 'dst_address': dst_addr,
2518 'mcast_sw_if_index': mcast_sw_if_index,
2519 'encap_vrf_id': encap_vrf_id,
2520 'decap_next_index': decap_next_index,
2523 def vxlan_gpe_add_del_tunnel(
2527 mcast_sw_if_index=0xFFFFFFFF,
2538 :param is_add: (Default value = 1)
2539 :param is_ipv6: (Default value = 0)
2540 :param encap_vrf_id: (Default value = 0)
2541 :param decap_vrf_id: (Default value = 0)
2542 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2543 :param protocol: (Default value = 3)
2544 :param vni: (Default value = 0)
2547 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2552 'mcast_sw_if_index': mcast_sw_if_index,
2553 'encap_vrf_id': encap_vrf_id,
2554 'decap_vrf_id': decap_vrf_id,
2555 'protocol': protocol,
2558 def pppoe_add_del_session(
2568 :param is_add: (Default value = 1)
2569 :param is_ipv6: (Default value = 0)
2571 :param session_id: (Default value = 0)
2573 :param decap_vrf_id: (Default value = 0)
2576 return self.api(self.papi.pppoe_add_del_session,
2579 'session_id': session_id,
2580 'client_ip': client_ip,
2581 'decap_vrf_id': decap_vrf_id,
2582 'client_mac': client_mac})
2584 def sr_localsid_add_del(self,
2590 sw_if_index=0xFFFFFFFF,
2594 """ Add/del IPv6 SR local-SID.
2596 :param localsid_addr:
2597 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2598 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2600 :param is_del: (Default value = 0)
2601 :param end_psp: (Default value = 0)
2602 :param sw_if_index: (Default value = 0xFFFFFFFF)
2603 :param vlan_index: (Default value = 0)
2604 :param fib_table: (Default value = 0)
2607 self.papi.sr_localsid_add_del,
2609 'localsid_addr': localsid_addr,
2611 'behavior': behavior,
2612 'sw_if_index': sw_if_index,
2613 'vlan_index': vlan_index,
2614 'fib_table': fib_table,
2629 :param bsid_addr: bindingSID of the SR Policy
2630 :param weight: weight of the sid list. optional. (default: 1)
2631 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2633 :param type: type/behavior of the SR policy. (default or spray) \
2635 :param fib_table: VRF where to install the FIB entry for the BSID \
2637 :param n_segments: number of segments \
2639 :param segments: a vector of IPv6 address composing the segment list \
2643 self.papi.sr_policy_add,
2644 {'bsid_addr': bsid_addr,
2646 'is_encap': is_encap,
2648 'fib_table': fib_table,
2649 'n_segments': n_segments,
2650 'segments': segments
2659 :param bsid: bindingSID of the SR Policy
2660 :param sr_policy_index: index of the sr policy (default: 0)
2663 self.papi.sr_policy_del,
2664 {'bsid_addr': bsid_addr,
2665 'sr_policy_index': sr_policy_index
2668 def sr_steering_add_del(
2679 Steer traffic L2 and L3 traffic through a given SR policy
2681 :param is_del: delete or add
2682 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2683 :param sr_policy: is the index of the SR Policy (alt to bsid)
2684 :param table_id: is the VRF where to install the FIB entry for the BSID
2685 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2686 :param mask_width: is the mask for L3 traffic type
2687 :param sw_if_index: is the incoming interface for L2 traffic
2688 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2691 self.papi.sr_steering_add_del,
2693 'bsid_addr': bsid_addr,
2694 'sr_policy_index': sr_policy_index,
2695 'table_id': table_id,
2696 'prefix_addr': prefix_addr,
2697 'mask_width': mask_width,
2698 'sw_if_index': sw_if_index,
2699 'traffic_type': traffic_type
2702 def acl_add_replace(self, acl_index, r, tag='',
2704 """Add/replace an ACL
2705 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2706 :param acl_rule r: ACL rules array.
2707 :param str tag: symbolic tag (description) for this ACL.
2708 :param int count: number of rules.
2710 return self.api(self.papi.acl_add_replace,
2711 {'acl_index': acl_index,
2715 expected_retval=expected_retval)
2717 def acl_del(self, acl_index, expected_retval=0):
2723 return self.api(self.papi.acl_del,
2724 {'acl_index': acl_index},
2725 expected_retval=expected_retval)
2727 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2729 return self.api(self.papi.acl_interface_set_acl_list,
2730 {'sw_if_index': sw_if_index,
2734 expected_retval=expected_retval)
2736 def acl_interface_set_etype_whitelist(self, sw_if_index,
2739 return self.api(self.papi.acl_interface_set_etype_whitelist,
2740 {'sw_if_index': sw_if_index,
2741 'count': len(whitelist),
2743 'whitelist': whitelist},
2744 expected_retval=expected_retval)
2746 def acl_interface_add_del(self,
2750 """ Add/Delete ACL to/from interface
2754 :param is_add: (Default value = 1)
2757 return self.api(self.papi.acl_interface_add_del,
2760 'sw_if_index': sw_if_index,
2761 'acl_index': acl_index})
2763 def acl_dump(self, acl_index, expected_retval=0):
2764 return self.api(self.papi.acl_dump,
2765 {'acl_index': acl_index},
2766 expected_retval=expected_retval)
2768 def macip_acl_add(self, rules, tag=""):
2771 :param rules: list of rules for given acl
2775 return self.api(self.papi.macip_acl_add,
2777 'count': len(rules),
2780 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2783 :param rules: list of rules for given acl
2787 return self.api(self.papi.macip_acl_add_replace,
2788 {'acl_index': acl_index,
2790 'count': len(rules),
2793 def macip_acl_del(self, acl_index):
2799 return self.api(self.papi.macip_acl_del,
2800 {'acl_index': acl_index})
2802 def macip_acl_interface_add_del(self,
2806 """ Add MACIP acl to interface
2810 :param is_add: (Default value = 1)
2813 return self.api(self.papi.macip_acl_interface_add_del,
2815 'sw_if_index': sw_if_index,
2816 'acl_index': acl_index})
2818 def macip_acl_interface_get(self):
2819 """ Return interface acls dump
2822 self.papi.macip_acl_interface_get, {})
2824 def macip_acl_dump(self, acl_index=4294967295):
2825 """ Return MACIP acl dump
2829 self.papi.macip_acl_dump, {'acl_index': acl_index})
2831 def policer_add_del(self,
2842 conform_action_type=1,
2844 exceed_action_type=0,
2846 violate_action_type=0,
2848 return self.api(self.papi.policer_add_del,
2855 'rate_type': rate_type,
2856 'round_type': round_type,
2858 'color_aware': color_aware,
2859 'conform_action_type': conform_action_type,
2860 'conform_dscp': conform_dscp,
2861 'exceed_action_type': exceed_action_type,
2862 'exceed_dscp': exceed_dscp,
2863 'violate_action_type': violate_action_type,
2864 'violate_dscp': violate_dscp})
2866 def ip_punt_police(self,
2870 return self.api(self.papi.ip_punt_police,
2871 {'policer_index': policer_index,
2875 def ip_punt_redirect(self,
2881 return self.api(self.papi.ip_punt_redirect,
2882 {'rx_sw_if_index': rx_sw_if_index,
2883 'tx_sw_if_index': tx_sw_if_index,
2888 def bier_table_add_del(self,
2892 """ BIER Table add/del """
2894 self.papi.bier_table_add_del,
2895 {'bt_tbl_id': {"bt_set": bti.set_id,
2896 "bt_sub_domain": bti.sub_domain_id,
2897 "bt_hdr_len_id": bti.hdr_len_id},
2898 'bt_label': mpls_label,
2899 'bt_is_add': is_add})
2901 def bier_table_dump(self):
2902 return self.api(self.papi.bier_table_dump, {})
2904 def bier_route_add_del(self,
2909 """ BIER Route add/del """
2911 self.papi.bier_route_add_del,
2912 {'br_tbl_id': {"bt_set": bti.set_id,
2913 "bt_sub_domain": bti.sub_domain_id,
2914 "bt_hdr_len_id": bti.hdr_len_id},
2916 'br_n_paths': len(paths),
2918 'br_is_add': is_add})
2920 def bier_route_dump(self, bti):
2922 self.papi.bier_route_dump,
2923 {'br_tbl_id': {"bt_set": bti.set_id,
2924 "bt_sub_domain": bti.sub_domain_id,
2925 "bt_hdr_len_id": bti.hdr_len_id}})
2927 def bier_imp_add(self,
2932 """ BIER Imposition Add """
2934 self.papi.bier_imp_add,
2935 {'bi_tbl_id': {"bt_set": bti.set_id,
2936 "bt_sub_domain": bti.sub_domain_id,
2937 "bt_hdr_len_id": bti.hdr_len_id},
2939 'bi_n_bytes': len(ibytes),
2940 'bi_bytes': ibytes})
2942 def bier_imp_del(self, bi_index):
2943 """ BIER Imposition del """
2945 self.papi.bier_imp_del,
2946 {'bi_index': bi_index})
2948 def bier_imp_dump(self):
2949 return self.api(self.papi.bier_imp_dump, {})
2951 def bier_disp_table_add_del(self,
2954 """ BIER Disposition Table add/del """
2956 self.papi.bier_disp_table_add_del,
2957 {'bdt_tbl_id': bdti,
2958 'bdt_is_add': is_add})
2960 def bier_disp_table_dump(self):
2961 return self.api(self.papi.bier_disp_table_dump, {})
2963 def bier_disp_entry_add_del(self,
2973 """ BIER Route add/del """
2975 while (len(lstack) < 16):
2978 self.papi.bier_disp_entry_add_del,
2979 {'bde_tbl_id': bdti,
2981 'bde_payload_proto': payload_proto,
2983 'bde_paths': [{'next_hop': next_hop,
2984 'table_id': next_hop_tbl_id,
2985 'afi': next_hop_afi,
2986 'rpf_id': next_hop_rpf_id,
2988 'label_stack': lstack}],
2989 'bde_is_add': is_add})
2991 def bier_disp_entry_dump(self, bdti):
2993 self.papi.bier_disp_entry_dump,
2994 {'bde_tbl_id': bdti})
2996 def add_node_next(self, node_name, next_name):
2997 """ Set the next node for a given node request
3002 return self.api(self.papi.add_node_next,
3003 {'node_name': node_name,
3004 'next_name': next_name})
3006 def session_enable_disable(self, is_enabled):
3008 self.papi.session_enable_disable,
3009 {'is_enable': is_enabled})
3011 def ipsec_spd_add_del(self, spd_id, is_add=1):
3012 """ SPD add/del - Wrapper to add or del ipsec SPD
3013 Sample CLI : 'ipsec spd add 1'
3015 :param spd_id - SPD ID to be created in the vpp . mandatory
3016 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3018 :returns: reply from the API
3021 self.papi.ipsec_spd_add_del, {
3022 'spd_id': spd_id, 'is_add': is_add})
3024 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3025 """ IPSEC interface SPD add/del - \
3026 Wrapper to associate/disassociate SPD to interface in VPP
3027 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3029 :param spd_id - SPD ID to associate with the interface . mandatory
3030 :param sw_if_index - Interface Index which needs to ipsec \
3031 association mandatory
3032 :param is_add - add(1) or del(0) association with interface \
3033 (Default 1 - add) . optional
3034 :returns: reply from the API
3037 self.papi.ipsec_interface_add_del_spd, {
3039 'sw_if_index': sw_if_index, 'is_add': is_add})
3041 def ipsec_sad_add_del_entry(self,
3044 tunnel_src_address='',
3045 tunnel_dst_address='',
3047 integrity_algorithm=2,
3048 integrity_key_length=0,
3049 integrity_key='C91KUR9GYMm5GfkEvNjX',
3051 crypto_key_length=0,
3052 crypto_key='JPjyOWBeVEQiMe7h',
3055 """ IPSEC SA add/del
3056 Sample CLI : 'ipsec sa add 10 spi 1001 esp \
3057 crypto-key 4a506a794f574265564551694d653768 \
3058 crypto-alg aes-cbc-128 \
3059 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3060 integ-alg sha1-96 tunnel-src 192.168.100.3 \
3061 tunnel-dst 192.168.100.2'
3062 Sample CLI : 'ipsec sa add 20 spi 2001 \
3063 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3066 :param sad_id - Security Association ID to be \
3067 created or deleted. mandatory
3068 :param spi - security param index of the SA in decimal. mandatory
3069 :param tunnel_src_address - incase of tunnel mode outer src address .\
3070 mandatory for tunnel mode
3071 :param tunnel_dst_address - incase of transport mode \
3072 outer dst address. mandatory for tunnel mode
3073 :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional
3074 :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\
3076 :param integrity_key - value in string \
3077 (Default C91KUR9GYMm5GfkEvNjX).optional
3078 :param integrity_key_length - length of the key string in bytes\
3079 (Default 0 - integrity disabled). optional
3080 :param crypto_algorithm - value range 1-11 Default \
3081 (1- AES_CBC_128).optional **
3082 :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional
3083 :param crypto_key_length - length of the key string in bytes\
3084 (Default 0 - crypto disabled). optional
3085 :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\
3087 :param is_tunnel - tunnel mode (1) or transport mode(0) \
3088 (Default 1 - tunnel). optional
3089 :returns: reply from the API
3090 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3091 crypto and ipsec algorithms
3094 self.papi.ipsec_sad_add_del_entry,
3097 'tunnel_src_address': tunnel_src_address,
3098 'tunnel_dst_address': tunnel_dst_address,
3099 'protocol': protocol,
3100 'integrity_algorithm': integrity_algorithm,
3101 'integrity_key_length': integrity_key_length,
3102 'integrity_key': integrity_key,
3103 'crypto_algorithm': crypto_algorithm,
3104 'crypto_key_length': crypto_key_length,
3105 'crypto_key': crypto_key,
3107 'is_tunnel': is_tunnel})
3109 def ipsec_spd_add_del_entry(self,
3111 local_address_start,
3113 remote_address_start,
3114 remote_address_stop,
3116 local_port_stop=65535,
3117 remote_port_start=0,
3118 remote_port_stop=65535,
3126 """ IPSEC policy SPD add/del -
3127 Wrapper to configure ipsec SPD policy entries in VPP
3128 Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \
3129 protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \
3130 remote-ip-range 192.168.3.3 - 192.168.3.3'
3132 :param spd_id - SPD ID for the policy . mandatory
3133 :param local_address_start - local-ip-range start address . mandatory
3134 :param local_address_stop - local-ip-range stop address . mandatory
3135 :param remote_address_start - remote-ip-range start address . mandatory
3136 :param remote_address_stop - remote-ip-range stop address . mandatory
3137 :param local_port_start - (Default 0) . optional
3138 :param local_port_stop - (Default 65535). optional
3139 :param remote_port_start - (Default 0). optional
3140 :param remote_port_stop - (Default 65535). optional
3141 :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any).
3143 :param sa_id - Security Association ID for mapping it to SPD
3144 (default 10). optional
3145 :param policy - bypass(0), discard(1), resolve(2) or protect(3)action
3146 (Default 0 - bypass). optional
3147 :param priotity - value for the spd action (Default 100). optional
3148 :param is_outbound - flag for inbound(0) or outbound(1)
3149 (Default 1 - outbound). optional
3150 :param is_add flag - for addition(1) or deletion(0) of the spd
3151 (Default 1 - addtion). optional
3152 :returns: reply from the API
3155 self.papi.ipsec_spd_add_del_entry,
3157 'local_address_start': local_address_start,
3158 'local_address_stop': local_address_stop,
3159 'remote_address_start': remote_address_start,
3160 'remote_address_stop': remote_address_stop,
3161 'local_port_start': local_port_start,
3162 'local_port_stop': local_port_stop,
3163 'remote_port_start': remote_port_start,
3164 'remote_port_stop': remote_port_stop,
3166 'protocol': protocol,
3168 'priority': priority,
3169 'is_outbound': is_outbound,
3171 'is_ip_any': is_ip_any})
3173 def app_namespace_add(self,
3177 sw_if_index=0xFFFFFFFF,
3180 self.papi.app_namespace_add_del,
3182 'sw_if_index': sw_if_index,
3183 'ip4_fib_id': ip4_fib_id,
3184 'ip6_fib_id': ip6_fib_id,
3185 'namespace_id': namespace_id,
3186 'namespace_id_len': len(namespace_id)})
3188 def punt_socket_register(self, l4_port, pathname, header_version=1,
3189 is_ip4=1, l4_protocol=0x11):
3190 """ Punt to socket """
3191 return self.api(self.papi.punt_socket_register,
3193 'l4_protocol': l4_protocol,
3195 'pathname': pathname,
3196 'header_version': header_version})
3198 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3199 expire_walk_interval_ms, is_ip6=0):
3200 """ Set IP reassembly parameters """
3201 return self.api(self.papi.ip_reassembly_set,
3203 'timeout_ms': timeout_ms,
3204 'expire_walk_interval_ms': expire_walk_interval_ms,
3205 'max_reassemblies': max_reassemblies})
3207 def ip_reassembly_get(self, is_ip6=0):
3208 """ Get IP reassembly parameters """
3209 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3211 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3213 """ Enable/disable IP reassembly """
3214 return self.api(self.papi.ip_reassembly_enable_disable,
3215 {'sw_if_index': sw_if_index,
3216 'enable_ip4': 1 if enable_ip4 else 0,
3217 'enable_ip6': 1 if enable_ip6 else 0,
3220 def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
3221 """ GBP endpoint Add/Del """
3222 return self.api(self.papi.gbp_endpoint_add_del,
3226 'sw_if_index': sw_if_index,
3230 def gbp_endpoint_dump(self):
3231 """ GBP endpoint Dump """
3232 return self.api(self.papi.gbp_endpoint_dump, {})
3234 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3235 """ GBP contract Add/Del """
3236 return self.api(self.papi.gbp_contract_add_del,
3239 'acl_index': acl_index,
3241 'dst_epg': dst_epg}})
3243 def gbp_contract_dump(self):
3244 """ GBP contract Dump """
3245 return self.api(self.papi.gbp_contract_dump, {})
3247 def ipip_6rd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len,
3248 ip4_prefix, ip4_prefix_len, ip4_src,
3250 """ 6RD tunnel Add """
3251 return self.api(self.papi.ipip_6rd_add_tunnel,
3252 {'fib_index': fib_index,
3253 'ip6_prefix': ip6_prefix,
3254 'ip6_prefix_len': ip6_prefix_len,
3255 'ip4_prefix': ip4_prefix,
3256 'ip4_prefix_len': ip4_prefix_len,
3258 'security_check': security_check})
3260 def ipip_6rd_del_tunnel(self, sw_if_index):
3261 """ 6RD tunnel Delete """
3262 return self.api(self.papi.ipip_6rd_del_tunnel,
3263 {'sw_if_index': sw_if_index})
3265 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3266 instance=0xFFFFFFFF, fib_index=0):
3267 """ IPIP tunnel Add/Del """
3268 return self.api(self.papi.ipip_add_tunnel,
3269 {'is_ipv6': is_ipv6,
3270 'instance': instance,
3271 'src_address': src_address,
3272 'dst_address': dst_address,
3273 'fib_index': fib_index})
3275 def ipip_del_tunnel(self, sw_if_index):
3276 """ IPIP tunnel Delete """
3277 return self.api(self.papi.ipip_del_tunnel,
3278 {'sw_if_index': sw_if_index})
3280 def qos_egress_map_update(self, id, outputs):
3281 """ QOS egress map update """
3282 return self.api(self.papi.qos_egress_map_update,
3286 def qos_egress_map_delete(self, id):
3287 """ QOS egress map delete """
3288 return self.api(self.papi.qos_egress_map_delete,
3291 def qos_mark_enable_disable(self, sw_if_index,
3295 """ QOS Mark Enable/Disable """
3296 return self.api(self.papi.qos_mark_enable_disable,
3298 'sw_if_index': sw_if_index,
3299 'output_source': output_source,
3302 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3303 """ IP QoS recording Enble/Disable """
3304 return self.api(self.papi.qos_record_enable_disable,
3305 {'sw_if_index': sw_if_index,
3306 'input_source': input_source,
3309 def igmp_listen(self, enable, sw_if_index, saddr, gaddr):
3310 """ Listen for new (S,G) on specified interface
3312 :param enable: add/del
3313 :param sw_if_index: interface sw index
3314 :param saddr: source ip4 addr
3315 :param gaddr: group ip4 addr
3317 return self.api(self.papi.igmp_listen,
3319 'sw_if_index': sw_if_index,
3323 def igmp_dump(self, sw_if_index=None):
3324 """ Dump all (S,G) interface configurations """
3325 if sw_if_index is None:
3330 return self.api(self.papi.igmp_dump, {'sw_if_index': sw_if_index,
3331 'dump_all': dump_all})
3333 def igmp_clear_interface(self, sw_if_index):
3334 """ Remove all (S,G)s from specified interface
3335 doesn't send IGMP report!
3338 self.papi.igmp_clear_interface, {
3339 'sw_if_index': sw_if_index})
3341 def want_igmp_events(self, enable=1):
3342 return self.api(self.papi.want_igmp_events, {'enable': enable,
3343 'pid': os.getpid()})
3353 :param lb: load balance
3354 :param use_custom_mac: use custom mac
3355 :param mac_address: mac address
3358 self.papi.bond_create,
3361 'use_custom_mac': use_custom_mac,
3362 'mac_address': mac_address
3369 :param sw_if_index: interface the operation is applied to
3371 return self.api(self.papi.bond_delete,
3372 {'sw_if_index': sw_if_index})
3381 :param sw_if_index: slave sw_if_index
3382 :param bond_sw_if_index: bond sw_if_index
3383 :param is_passive: is passive lacp speaker
3384 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3387 self.papi.bond_enslave,
3388 {'sw_if_index': sw_if_index,
3389 'bond_sw_if_index': bond_sw_if_index,
3390 'is_passive': is_passive,
3391 'is_long_timeout': is_long_timeout
3394 def bond_detach_slave(
3398 :param sw_if_index: slave interface the operation is applied to
3400 return self.api(self.papi.bond_detach_slave,
3401 {'sw_if_index': sw_if_index})
3403 def sw_interface_slave_dump(
3407 :param sw_if_index: bond sw_if_index
3409 return self.api(self.papi.sw_interface_slave_dump,
3410 {'sw_if_index': sw_if_index})
3412 def sw_interface_bond_dump(
3417 return self.api(self.papi.sw_interface_bond_dump,