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 mpls_fib_dump(self):
1087 return self.api(self.papi.mpls_fib_dump, {})
1089 def mpls_table_add_del(
1096 :param is_add: (Default value = 1)
1101 self.papi.mpls_table_add_del,
1102 {'mt_table_id': table_id,
1103 'mt_is_add': is_add})
1105 def mpls_route_add_del(
1111 next_hop_sw_if_index=0xFFFFFFFF,
1113 next_hop_table_id=0,
1115 next_hop_n_out_labels=0,
1116 next_hop_out_label_stack=[],
1117 next_hop_via_label=MPLS_LABEL_INVALID,
1119 is_resolve_attached=0,
1126 classify_table_index=0xFFFFFFFF,
1130 :param dst_address_length:
1131 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1133 :param next_hop_address:
1134 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1135 :param vrf_id: (Default value = 0)
1136 :param lookup_in_vrf: (Default value = 0)
1137 :param classify_table_index: (Default value = 0xFFFFFFFF)
1138 :param is_add: (Default value = 1)
1139 :param is_drop: (Default value = 0)
1140 :param is_ipv6: (Default value = 0)
1141 :param is_local: (Default value = 0)
1142 :param is_classify: (Default value = 0)
1143 :param is_multipath: (Default value = 0)
1144 :param is_multicast: (Default value = 0)
1145 :param is_resolve_host: (Default value = 0)
1146 :param is_resolve_attached: (Default value = 0)
1147 :param next_hop_weight: (Default value = 1)
1151 self.papi.mpls_route_add_del,
1154 'mr_table_id': table_id,
1155 'mr_classify_table_index': classify_table_index,
1156 'mr_is_add': is_add,
1157 'mr_is_classify': is_classify,
1158 'mr_is_multipath': is_multipath,
1159 'mr_is_multicast': is_multicast,
1160 'mr_is_resolve_host': is_resolve_host,
1161 'mr_is_resolve_attached': is_resolve_attached,
1162 'mr_is_interface_rx': is_interface_rx,
1163 'mr_is_rpf_id': is_rpf_id,
1164 'mr_next_hop_proto': next_hop_proto,
1165 'mr_next_hop_weight': next_hop_weight,
1166 'mr_next_hop': next_hop_address,
1167 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1168 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1169 'mr_next_hop_table_id': next_hop_table_id,
1170 'mr_next_hop_via_label': next_hop_via_label,
1171 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1173 def mpls_ip_bind_unbind(
1185 self.papi.mpls_ip_bind_unbind,
1186 {'mb_mpls_table_id': table_id,
1188 'mb_ip_table_id': ip_table_id,
1189 'mb_is_bind': is_bind,
1190 'mb_is_ip4': is_ip4,
1191 'mb_address_length': dst_address_length,
1192 'mb_address': dst_address})
1194 def mpls_tunnel_add_del(
1197 next_hop_proto_is_ip4,
1199 next_hop_sw_if_index=0xFFFFFFFF,
1200 next_hop_table_id=0,
1202 next_hop_n_out_labels=0,
1203 next_hop_out_label_stack=[],
1204 next_hop_via_label=MPLS_LABEL_INVALID,
1210 :param dst_address_length:
1211 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1213 :param next_hop_address:
1214 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1215 :param vrf_id: (Default value = 0)
1216 :param lookup_in_vrf: (Default value = 0)
1217 :param classify_table_index: (Default value = 0xFFFFFFFF)
1218 :param is_add: (Default value = 1)
1219 :param is_drop: (Default value = 0)
1220 :param is_ipv6: (Default value = 0)
1221 :param is_local: (Default value = 0)
1222 :param is_classify: (Default value = 0)
1223 :param is_multipath: (Default value = 0)
1224 :param is_resolve_host: (Default value = 0)
1225 :param is_resolve_attached: (Default value = 0)
1226 :param next_hop_weight: (Default value = 1)
1227 :param is_multicast: (Default value = 0)
1231 self.papi.mpls_tunnel_add_del,
1232 {'mt_sw_if_index': tun_sw_if_index,
1233 'mt_is_add': is_add,
1234 'mt_l2_only': l2_only,
1235 'mt_is_multicast': is_multicast,
1236 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1237 'mt_next_hop_weight': next_hop_weight,
1238 'mt_next_hop': next_hop_address,
1239 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1240 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1241 'mt_next_hop_table_id': next_hop_table_id,
1242 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1244 def nat44_interface_add_del_feature(
1249 """Enable/disable NAT44 feature on the interface
1251 :param sw_if_index: Software index of the interface
1252 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1253 :param is_add: 1 if add, 0 if delete (Default value = 1)
1256 self.papi.nat44_interface_add_del_feature,
1258 'is_inside': is_inside,
1259 'sw_if_index': sw_if_index})
1261 def nat44_interface_add_del_output_feature(
1266 """Enable/disable NAT44 output feature on the interface
1268 :param sw_if_index: Software index of the interface
1269 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1270 :param is_add: 1 if add, 0 if delete (Default value = 1)
1273 self.papi.nat44_interface_add_del_output_feature,
1275 'is_inside': is_inside,
1276 'sw_if_index': sw_if_index})
1278 def nat44_add_del_static_mapping(
1282 external_sw_if_index=0xFFFFFFFF,
1292 """Add/delete NAT44 static mapping
1294 :param local_ip: Local IP address
1295 :param external_ip: External IP address
1296 :param external_sw_if_index: External interface instead of IP address
1297 :param local_port: Local port number (Default value = 0)
1298 :param external_port: External port number (Default value = 0)
1299 :param addr_only: 1 if address only mapping, 0 if address and port
1300 :param vrf_id: VRF ID
1301 :param protocol: IP protocol (Default value = 0)
1302 :param twice_nat: 1 if translate external host address and port
1303 :param out2in_only: if 1 rule is matching only out2in direction
1304 :param tag: Opaque string tag
1305 :param is_add: 1 if add, 0 if delete (Default value = 1)
1308 self.papi.nat44_add_del_static_mapping,
1310 'addr_only': addr_only,
1311 'local_ip_address': local_ip,
1312 'external_ip_address': external_ip,
1313 'local_port': local_port,
1314 'external_port': external_port,
1315 'external_sw_if_index': external_sw_if_index,
1317 'protocol': protocol,
1318 'twice_nat': twice_nat,
1319 'out2in_only': out2in_only,
1322 def nat44_add_del_identity_mapping(
1325 sw_if_index=0xFFFFFFFF,
1332 """Add/delete NAT44 identity mapping
1334 :param ip: IP address (Default value = 0)
1335 :param sw_if_index: Interface instead of IP address
1336 :param port: Port number (Default value = 0)
1337 :param addr_only: 1 if address only mapping, 0 if address and port
1338 :param vrf_id: VRF ID
1339 :param protocol: IP protocol (Default value = 0)
1340 :param tag: Opaque string tag
1341 :param is_add: 1 if add, 0 if delete (Default value = 1)
1344 self.papi.nat44_add_del_identity_mapping,
1346 'addr_only': addr_only,
1349 'sw_if_index': sw_if_index,
1352 'protocol': protocol})
1354 def nat44_add_del_address_range(
1361 """Add/del NAT44 address range
1363 :param first_ip_address: First IP address
1364 :param last_ip_address: Last IP address
1365 :param vrf_id: VRF id for the address range
1366 :param twice_nat: twice NAT address for extenal hosts
1367 :param is_add: 1 if add, 0 if delete (Default value = 1)
1370 self.papi.nat44_add_del_address_range,
1371 {'first_ip_address': first_ip_address,
1372 'last_ip_address': last_ip_address,
1374 'twice_nat': twice_nat,
1377 def nat44_address_dump(self):
1378 """Dump NAT44 addresses
1379 :return: Dictionary of NAT44 addresses
1381 return self.api(self.papi.nat44_address_dump, {})
1383 def nat44_interface_dump(self):
1384 """Dump interfaces with NAT44 feature
1385 :return: Dictionary of interfaces with NAT44 feature
1387 return self.api(self.papi.nat44_interface_dump, {})
1389 def nat44_interface_output_feature_dump(self):
1390 """Dump interfaces with NAT44 output feature
1391 :return: Dictionary of interfaces with NAT44 output feature
1393 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1395 def nat44_static_mapping_dump(self):
1396 """Dump NAT44 static mappings
1397 :return: Dictionary of NAT44 static mappings
1399 return self.api(self.papi.nat44_static_mapping_dump, {})
1401 def nat44_identity_mapping_dump(self):
1402 """Dump NAT44 identity mappings
1403 :return: Dictionary of NAT44 identity mappings
1405 return self.api(self.papi.nat44_identity_mapping_dump, {})
1407 def nat_show_config(self):
1408 """Show NAT plugin config
1409 :return: NAT plugin config parameters
1411 return self.api(self.papi.nat_show_config, {})
1413 def nat44_add_interface_addr(
1418 """Add/del NAT44 address from interface
1420 :param sw_if_index: Software index of the interface
1421 :param twice_nat: twice NAT address for extenal hosts
1422 :param is_add: 1 if add, 0 if delete (Default value = 1)
1425 self.papi.nat44_add_del_interface_addr,
1427 'sw_if_index': sw_if_index,
1428 'twice_nat': twice_nat})
1430 def nat44_interface_addr_dump(self):
1431 """Dump NAT44 addresses interfaces
1432 :return: Dictionary of NAT44 addresses interfaces
1434 return self.api(self.papi.nat44_interface_addr_dump, {})
1441 """Enable/disable NAT IPFIX logging
1443 :param domain_id: Observation domain ID (Default value = 1)
1444 :param src_port: Source port number (Default value = 4739)
1445 :param enable: 1 if enable, 0 if disable (Default value = 1)
1448 self.papi.nat_ipfix_enable_disable,
1449 {'domain_id': domain_id,
1450 'src_port': src_port,
1453 def nat44_user_session_dump(
1457 """Dump NAT44 user's sessions
1459 :param ip_address: ip adress of the user to be dumped
1460 :param cpu_index: cpu_index on which the user is
1461 :param vrf_id: VRF ID
1462 :return: Dictionary of S-NAT sessions
1465 self.papi.nat44_user_session_dump,
1466 {'ip_address': ip_address,
1469 def nat44_user_dump(self):
1472 :return: Dictionary of NAT44 users
1474 return self.api(self.papi.nat44_user_dump, {})
1476 def nat44_add_del_lb_static_mapping(
1488 """Add/delete NAT44 load balancing static mapping
1490 :param twice_nat: 1 if translate external host address and port
1491 :param tag: Opaque string tag
1492 :param is_add - 1 if add, 0 if delete
1495 self.papi.nat44_add_del_lb_static_mapping,
1497 'external_addr': external_addr,
1498 'external_port': external_port,
1499 'protocol': protocol,
1501 'twice_nat': twice_nat,
1502 'out2in_only': out2in_only,
1504 'local_num': local_num,
1507 def nat44_lb_static_mapping_dump(self):
1508 """Dump NAT44 load balancing static mappings
1510 :return: Dictionary of NAT44 load balancing static mapping
1512 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1514 def nat44_del_session(
1521 """Delete NAT44 session
1523 :param addr: IPv4 address
1524 :param por: port number
1525 :param protocol: IP protocol number
1526 :param vrf_id: VRF ID
1527 :param is_in: 1 if inside network addres and port pari, 0 if outside
1530 self.papi.nat44_del_session,
1533 'protocol': protocol,
1537 def nat44_forwarding_enable_disable(
1540 """Enable/disable forwarding for NAT44
1542 :param enable: 1 for enable, 0 for disable
1545 self.papi.nat44_forwarding_enable_disable,
1555 """Set NAT virtual fragmentation reassembly
1557 :param timeout: reassembly timeout (Default 2sec)
1558 :param max_reass: maximum concurrent reassemblies (Default 1024)
1559 :param max_frag: maximum fragmets per reassembly (Default 5)
1560 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1561 :param is_ip6: 1 if IPv6, 0 if IPv4
1564 self.papi.nat_set_reass,
1565 {'timeout': timeout,
1566 'max_reass': max_reass,
1567 'max_frag': max_frag,
1568 'drop_frag': drop_frag,
1571 def nat_get_reass(self):
1572 """Get NAT virtual fragmentation reassembly configuration
1574 :return: NAT virtual fragmentation reassembly configuration
1576 return self.api(self.papi.nat_get_reass, {})
1578 def nat_reass_dump(self):
1579 """Dump NAT virtual fragmentation reassemblies
1581 :return: Dictionary of NAT virtual fragmentation reassemblies
1583 return self.api(self.papi.nat_reass_dump, {})
1585 def nat_det_add_del_map(
1592 """Add/delete deterministic NAT mapping
1594 :param is_add - 1 if add, 0 if delete
1595 :param in_addr - inside IP address
1596 :param in_plen - inside IP address prefix length
1597 :param out_addr - outside IP address
1598 :param out_plen - outside IP address prefix length
1601 self.papi.nat_det_add_del_map,
1606 'out_addr': out_addr,
1607 'out_plen': out_plen})
1609 def nat_det_forward(
1612 """Get outside address and port range from inside address
1614 :param in_addr - inside IP address
1617 self.papi.nat_det_forward,
1618 {'in_addr': in_addr,
1621 def nat_det_reverse(
1625 """Get inside address from outside address and port
1627 :param out_addr - outside IP address
1628 :param out_port - outside port
1631 self.papi.nat_det_reverse,
1632 {'out_addr': out_addr,
1633 'out_port': out_port})
1635 def nat_det_map_dump(self):
1636 """Dump deterministic NAT mappings
1638 :return: Dictionary of deterministic NAT mappings
1640 return self.api(self.papi.nat_det_map_dump, {})
1642 def nat_det_set_timeouts(
1645 tcp_established=7440,
1648 """Set values of timeouts for deterministic NAT (in seconds)
1650 :param udp - UDP timeout (Default value = 300)
1651 :param tcp_established - TCP established timeout (Default value = 7440)
1652 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1653 :param icmp - ICMP timeout (Default value = 60)
1656 self.papi.nat_det_set_timeouts,
1658 'tcp_established': tcp_established,
1659 'tcp_transitory': tcp_transitory,
1662 def nat_det_get_timeouts(self):
1663 """Get values of timeouts for deterministic NAT
1665 :return: Timeouts for deterministic NAT (in seconds)
1667 return self.api(self.papi.nat_det_get_timeouts, {})
1669 def nat_det_close_session_out(
1675 """Close deterministic NAT session using outside address and port
1677 :param out_addr - outside IP address
1678 :param out_port - outside port
1679 :param ext_addr - external host IP address
1680 :param ext_port - external host port
1683 self.papi.nat_det_close_session_out,
1684 {'out_addr': out_addr,
1685 'out_port': out_port,
1686 'ext_addr': ext_addr,
1687 'ext_port': ext_port})
1689 def nat_det_close_session_in(
1695 """Close deterministic NAT session using inside address and port
1697 :param in_addr - inside IP address
1698 :param in_port - inside port
1699 :param ext_addr - external host IP address
1700 :param ext_port - external host port
1703 self.papi.nat_det_close_session_in,
1704 {'in_addr': in_addr,
1706 'ext_addr': ext_addr,
1707 'ext_port': ext_port,
1710 def nat_det_session_dump(
1713 """Dump deterministic NAT sessions belonging to a user
1715 :param user_addr - inside IP address of the user
1716 :return: Dictionary of deterministic NAT sessions
1719 self.papi.nat_det_session_dump,
1721 'user_addr': user_addr})
1723 def nat64_add_del_pool_addr_range(
1729 """Add/del address range to NAT64 pool
1731 :param start_addr: First IP address
1732 :param end_addr: Last IP address
1733 :param vrf_id: VRF id for the address range
1734 :param is_add: 1 if add, 0 if delete (Default value = 1)
1737 self.papi.nat64_add_del_pool_addr_range,
1738 {'start_addr': start_addr,
1739 'end_addr': end_addr,
1743 def nat64_pool_addr_dump(self):
1744 """Dump NAT64 pool addresses
1745 :return: Dictionary of NAT64 pool addresses
1747 return self.api(self.papi.nat64_pool_addr_dump, {})
1749 def nat64_add_del_interface(
1754 """Enable/disable NAT64 feature on the interface
1755 :param sw_if_index: Index of the interface
1756 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1757 :param is_add: 1 if add, 0 if delete (Default value = 1)
1760 self.papi.nat64_add_del_interface,
1761 {'sw_if_index': sw_if_index,
1762 'is_inside': is_inside,
1765 def nat64_interface_dump(self):
1766 """Dump interfaces with NAT64 feature
1767 :return: Dictionary of interfaces with NAT64 feature
1769 return self.api(self.papi.nat64_interface_dump, {})
1771 def nat64_add_del_static_bib(
1780 """Add/delete S-NAT static BIB entry
1782 :param in_ip: Inside IPv6 address
1783 :param out_ip: Outside IPv4 address
1784 :param in_port: Inside port number
1785 :param out_port: Outside port number
1786 :param protocol: IP protocol
1787 :param vrf_id: VRF ID (Default value = 0)
1788 :param is_add: 1 if add, 0 if delete (Default value = 1)
1791 self.papi.nat64_add_del_static_bib,
1800 def nat64_bib_dump(self, protocol=255):
1803 :param protocol: IP protocol (Default value = 255, all BIBs)
1804 :returns: Dictionary of NAT64 BIB entries
1806 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1808 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1809 tcp_incoming_syn=6):
1810 """Set values of timeouts for NAT64 (in seconds)
1812 :param udpi: UDP timeout (Default value = 300)
1813 :param icmp: ICMP timeout (Default value = 60)
1814 :param tcp_trans: TCP transitory timeout (Default value = 240)
1815 :param tcp_est: TCP established timeout (Default value = 7440)
1816 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1819 self.papi.nat64_set_timeouts,
1822 'tcp_trans': tcp_trans,
1824 'tcp_incoming_syn': tcp_incoming_syn})
1826 def nat64_get_timeouts(self):
1827 """Get values of timeouts for NAT64
1829 :return: Timeouts for NAT64 (in seconds)
1831 return self.api(self.papi.nat64_get_timeouts, {})
1833 def nat64_st_dump(self, protocol=255):
1834 """Dump NAT64 session table
1836 :param protocol: IP protocol (Default value = 255, all STs)
1837 :returns: Dictionary of NAT64 sesstion table entries
1839 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1841 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1842 """Add/del NAT64 prefix
1844 :param prefix: NAT64 prefix
1845 :param plen: NAT64 prefix length
1846 :param vrf_id: VRF id of tenant (Default 0)
1847 :param is_add: 1 if add, 0 if delete (Default value = 1)
1850 self.papi.nat64_add_del_prefix,
1856 def nat64_prefix_dump(self):
1857 """Dump NAT64 prefix
1859 :returns: Dictionary of NAT64 prefixes
1861 return self.api(self.papi.nat64_prefix_dump, {})
1863 def nat64_add_interface_addr(
1867 """Add/del NAT64 address from interface
1869 :param sw_if_index: Software index of the interface
1870 :param is_add: 1 if add, 0 if delete (Default value = 1)
1872 return self.api(self.papi.nat64_add_del_interface_addr,
1873 {'is_add': is_add, 'sw_if_index': sw_if_index})
1875 def dslite_set_aftr_addr(self, ip6, ip4):
1876 """Set DS-Lite AFTR addresses
1878 :param ip4: IPv4 address
1879 :param ip6: IPv6 address
1882 self.papi.dslite_set_aftr_addr,
1886 def dslite_set_b4_addr(self, ip6, ip4):
1887 """Set DS-Lite B4 IPv6 address
1889 :param ip4: IPv4 address
1890 :param ip6: IPv6 address
1893 self.papi.dslite_set_b4_addr,
1897 def dslite_add_del_pool_addr_range(
1902 """Add/del address range to DS-Lite pool
1904 :param start_addr: First IP address
1905 :param end_addr: Last IP address
1906 :param is_add: 1 if add, 0 if delete (Default value = 1)
1909 self.papi.dslite_add_del_pool_addr_range,
1910 {'start_addr': start_addr,
1911 'end_addr': end_addr,
1914 def nat66_add_del_interface(
1919 """Enable/disable NAT66 feature on the interface
1920 :param sw_if_index: Index of the interface
1921 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1922 :param is_add: 1 if add, 0 if delete (Default value = 1)
1925 self.papi.nat66_add_del_interface,
1926 {'sw_if_index': sw_if_index,
1927 'is_inside': is_inside,
1930 def nat66_add_del_static_mapping(
1936 """Add/delete NAT66 static mapping
1938 :param in_ip: Inside IPv6 address
1939 :param out_ip: Outside IPv6 address
1940 :param vrf_id: VRF ID (Default value = 0)
1941 :param is_add: 1 if add, 0 if delete (Default value = 1)
1944 self.papi.nat66_add_del_static_mapping,
1945 {'local_ip_address': in_ip,
1946 'external_ip_address': out_ip,
1950 def nat66_interface_dump(self):
1951 """Dump interfaces with NAT66 feature
1952 :return: Dictionary of interfaces with NAT66 feature
1954 return self.api(self.papi.nat66_interface_dump, {})
1956 def nat66_static_mapping_dump(self):
1957 """Dump NAT66 static mappings
1958 :return: Dictionary of NAT66 static mappings
1960 return self.api(self.papi.nat66_static_mapping_dump, {})
1962 def control_ping(self):
1963 self.api(self.papi.control_ping)
1965 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1966 detect_mult, local_addr, peer_addr, is_ipv6=0,
1967 bfd_key_id=None, conf_key_id=None):
1968 if bfd_key_id is None:
1969 return self.api(self.papi.bfd_udp_add,
1971 'sw_if_index': sw_if_index,
1972 'desired_min_tx': desired_min_tx,
1973 'required_min_rx': required_min_rx,
1974 'local_addr': local_addr,
1975 'peer_addr': peer_addr,
1977 'detect_mult': detect_mult,
1980 return self.api(self.papi.bfd_udp_add,
1982 'sw_if_index': sw_if_index,
1983 'desired_min_tx': desired_min_tx,
1984 'required_min_rx': required_min_rx,
1985 'local_addr': local_addr,
1986 'peer_addr': peer_addr,
1988 'detect_mult': detect_mult,
1989 'is_authenticated': 1,
1990 'bfd_key_id': bfd_key_id,
1991 'conf_key_id': conf_key_id,
1994 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1995 detect_mult, local_addr, peer_addr, is_ipv6=0):
1996 return self.api(self.papi.bfd_udp_mod,
1998 'sw_if_index': sw_if_index,
1999 'desired_min_tx': desired_min_tx,
2000 'required_min_rx': required_min_rx,
2001 'local_addr': local_addr,
2002 'peer_addr': peer_addr,
2004 'detect_mult': detect_mult,
2007 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2008 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2010 return self.api(self.papi.bfd_udp_auth_activate,
2012 'sw_if_index': sw_if_index,
2013 'local_addr': local_addr,
2014 'peer_addr': peer_addr,
2016 'is_delayed': 1 if is_delayed else 0,
2017 'bfd_key_id': bfd_key_id,
2018 'conf_key_id': conf_key_id,
2021 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2022 is_ipv6=0, is_delayed=False):
2023 return self.api(self.papi.bfd_udp_auth_deactivate,
2025 'sw_if_index': sw_if_index,
2026 'local_addr': local_addr,
2027 'peer_addr': peer_addr,
2029 'is_delayed': 1 if is_delayed else 0,
2032 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2033 return self.api(self.papi.bfd_udp_del,
2035 'sw_if_index': sw_if_index,
2036 'local_addr': local_addr,
2037 'peer_addr': peer_addr,
2041 def bfd_udp_session_dump(self):
2042 return self.api(self.papi.bfd_udp_session_dump, {})
2044 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2045 peer_addr, is_ipv6=0):
2046 return self.api(self.papi.bfd_udp_session_set_flags, {
2047 'admin_up_down': admin_up_down,
2048 'sw_if_index': sw_if_index,
2049 'local_addr': local_addr,
2050 'peer_addr': peer_addr,
2054 def want_bfd_events(self, enable_disable=1):
2055 return self.api(self.papi.want_bfd_events, {
2056 'enable_disable': enable_disable,
2060 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2061 return self.api(self.papi.bfd_auth_set_key, {
2062 'conf_key_id': conf_key_id,
2063 'auth_type': auth_type,
2065 'key_len': len(key),
2068 def bfd_auth_del_key(self, conf_key_id):
2069 return self.api(self.papi.bfd_auth_del_key, {
2070 'conf_key_id': conf_key_id,
2073 def bfd_auth_keys_dump(self):
2074 return self.api(self.papi.bfd_auth_keys_dump, {})
2076 def bfd_udp_set_echo_source(self, sw_if_index):
2077 return self.api(self.papi.bfd_udp_set_echo_source,
2078 {'sw_if_index': sw_if_index})
2080 def bfd_udp_del_echo_source(self):
2081 return self.api(self.papi.bfd_udp_del_echo_source, {})
2083 def classify_add_del_table(
2088 table_index=0xFFFFFFFF,
2090 memory_size=2097152,
2092 next_table_index=0xFFFFFFFF,
2093 miss_next_index=0xFFFFFFFF,
2094 current_data_flag=0,
2095 current_data_offset=0):
2099 :param match_n_vectors: (Default value = 1)
2100 :param table_index: (Default value = 0xFFFFFFFF)
2101 :param nbuckets: (Default value = 2)
2102 :param memory_size: (Default value = 2097152)
2103 :param skip_n_vectors: (Default value = 0)
2104 :param next_table_index: (Default value = 0xFFFFFFFF)
2105 :param miss_next_index: (Default value = 0xFFFFFFFF)
2106 :param current_data_flag: (Default value = 0)
2107 :param current_data_offset: (Default value = 0)
2111 self.papi.classify_add_del_table,
2113 'table_index': table_index,
2114 'nbuckets': nbuckets,
2115 'memory_size': memory_size,
2116 'skip_n_vectors': skip_n_vectors,
2117 'match_n_vectors': match_n_vectors,
2118 'next_table_index': next_table_index,
2119 'miss_next_index': miss_next_index,
2120 'current_data_flag': current_data_flag,
2121 'current_data_offset': current_data_offset,
2124 def classify_add_del_session(
2129 opaque_index=0xFFFFFFFF,
2130 hit_next_index=0xFFFFFFFF,
2138 :param opaque_index: (Default value = 0xFFFFFFFF)
2139 :param hit_next_index: (Default value = 0xFFFFFFFF)
2140 :param advance: (Default value = 0)
2141 :param action: (Default value = 0)
2142 :param metadata: (Default value = 0)
2146 self.papi.classify_add_del_session,
2148 'table_index': table_index,
2149 'hit_next_index': hit_next_index,
2150 'opaque_index': opaque_index,
2153 'metadata': metadata,
2156 def input_acl_set_interface(
2160 ip4_table_index=0xFFFFFFFF,
2161 ip6_table_index=0xFFFFFFFF,
2162 l2_table_index=0xFFFFFFFF):
2166 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2167 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2168 :param l2_table_index: (Default value = 0xFFFFFFFF)
2172 self.papi.input_acl_set_interface,
2173 {'sw_if_index': sw_if_index,
2174 'ip4_table_index': ip4_table_index,
2175 'ip6_table_index': ip6_table_index,
2176 'l2_table_index': l2_table_index,
2179 def output_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.output_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 set_ipfix_exporter(
2209 collector_port=4739,
2212 self.papi.set_ipfix_exporter,
2214 'collector_address': collector_address,
2215 'collector_port': collector_port,
2216 'src_address': src_address,
2218 'path_mtu': path_mtu,
2219 'template_interval': template_interval,
2220 'udp_checksum': udp_checksum,
2223 def dhcp_proxy_config(self,
2231 self.papi.dhcp_proxy_config,
2233 'rx_vrf_id': rx_table_id,
2234 'server_vrf_id': server_table_id,
2237 'dhcp_server': dhcp_server,
2238 'dhcp_src_address': dhcp_src_address,
2241 def dhcp_proxy_set_vss(self,
2250 self.papi.dhcp_proxy_set_vss,
2253 'vss_type': vss_type,
2254 'vpn_ascii_id': vpn_ascii_id,
2256 'vpn_index': vpn_index,
2261 def dhcp_client(self,
2266 set_broadcast_flag=1,
2267 want_dhcp_events=0):
2269 self.papi.dhcp_client_config,
2271 'sw_if_index': sw_if_index,
2272 'hostname': hostname,
2273 'client_id': client_id,
2275 'want_dhcp_event': want_dhcp_events,
2276 'set_broadcast_flag': set_broadcast_flag,
2280 def ip_mroute_add_del(self,
2286 next_hop_sw_if_index,
2295 IP Multicast Route add/del
2298 self.papi.ip_mroute_add_del,
2299 {'next_hop_sw_if_index': next_hop_sw_if_index,
2300 'entry_flags': e_flags,
2301 'itf_flags': i_flags,
2302 'table_id': table_id,
2306 'is_local': is_local,
2307 'bier_imp': bier_imp,
2308 'next_hop_afi': next_hop_afi,
2309 'grp_address_length': grp_address_length,
2310 'grp_address': grp_address,
2311 'src_address': src_address})
2313 def mfib_signal_dump(self):
2314 return self.api(self.papi.mfib_signal_dump, {})
2316 def ip_mfib_dump(self):
2317 return self.api(self.papi.ip_mfib_dump, {})
2319 def ip6_mfib_dump(self):
2320 return self.api(self.papi.ip6_mfib_dump, {})
2322 def lisp_enable_disable(self, is_enabled):
2324 self.papi.lisp_enable_disable,
2326 'is_en': is_enabled,
2329 def lisp_locator_set(self,
2333 self.papi.lisp_add_del_locator_set,
2336 'locator_set_name': ls_name
2339 def lisp_locator_set_dump(self):
2340 return self.api(self.papi.lisp_locator_set_dump, {})
2342 def lisp_locator(self,
2349 self.papi.lisp_add_del_locator,
2352 'locator_set_name': ls_name,
2353 'sw_if_index': sw_if_index,
2354 'priority': priority,
2358 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2360 self.papi.lisp_locator_dump,
2362 'is_index_set': is_index_set,
2364 'ls_index': ls_index,
2367 def lisp_local_mapping(self,
2377 self.papi.lisp_add_del_local_eid,
2379 'locator_set_name': ls_name,
2381 'eid_type': eid_type,
2383 'prefix_len': prefix_len,
2389 def lisp_eid_table_dump(self,
2397 self.papi.lisp_eid_table_dump,
2400 'prefix_length': prefix_length,
2402 'eid_type': eid_type,
2404 'filter': filter_opt,
2407 def lisp_remote_mapping(self,
2417 self.papi.lisp_add_del_remote_mapping,
2420 'eid_type': eid_type,
2422 'eid_len': eid_prefix_len,
2423 'rloc_num': rlocs_num,
2426 'is_src_dst': is_src_dst,
2429 def lisp_adjacency(self,
2438 self.papi.lisp_add_del_adjacency,
2442 'eid_type': eid_type,
2445 'leid_len': leid_len,
2446 'reid_len': reid_len,
2449 def lisp_adjacencies_get(self, vni=0):
2451 self.papi.lisp_adjacencies_get,
2456 def map_add_domain(self,
2470 self.papi.map_add_domain,
2472 'ip6_prefix': ip6_prefix,
2473 'ip6_prefix_len': ip6_prefix_len,
2474 'ip4_prefix': ip4_prefix,
2475 'ip4_prefix_len': ip4_prefix_len,
2477 'ip6_src_prefix_len': ip6_src_prefix_len,
2478 'ea_bits_len': ea_bits_len,
2479 'psid_offset': psid_offset,
2480 'psid_length': psid_length,
2481 'is_translation': is_translation,
2482 'is_rfc6052': is_rfc6052,
2486 def gtpu_add_del_tunnel(
2492 mcast_sw_if_index=0xFFFFFFFF,
2494 decap_next_index=0xFFFFFFFF,
2498 :param is_add: (Default value = 1)
2499 :param is_ipv6: (Default value = 0)
2502 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2503 :param encap_vrf_id: (Default value = 0)
2504 :param decap_next_index: (Default value = 0xFFFFFFFF)
2505 :param teid: (Default value = 0)
2508 return self.api(self.papi.gtpu_add_del_tunnel,
2511 'src_address': src_addr,
2512 'dst_address': dst_addr,
2513 'mcast_sw_if_index': mcast_sw_if_index,
2514 'encap_vrf_id': encap_vrf_id,
2515 'decap_next_index': decap_next_index,
2518 def vxlan_gpe_add_del_tunnel(
2522 mcast_sw_if_index=0xFFFFFFFF,
2533 :param is_add: (Default value = 1)
2534 :param is_ipv6: (Default value = 0)
2535 :param encap_vrf_id: (Default value = 0)
2536 :param decap_vrf_id: (Default value = 0)
2537 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2538 :param protocol: (Default value = 3)
2539 :param vni: (Default value = 0)
2542 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2547 'mcast_sw_if_index': mcast_sw_if_index,
2548 'encap_vrf_id': encap_vrf_id,
2549 'decap_vrf_id': decap_vrf_id,
2550 'protocol': protocol,
2553 def pppoe_add_del_session(
2563 :param is_add: (Default value = 1)
2564 :param is_ipv6: (Default value = 0)
2566 :param session_id: (Default value = 0)
2568 :param decap_vrf_id: (Default value = 0)
2571 return self.api(self.papi.pppoe_add_del_session,
2574 'session_id': session_id,
2575 'client_ip': client_ip,
2576 'decap_vrf_id': decap_vrf_id,
2577 'client_mac': client_mac})
2579 def sr_localsid_add_del(self,
2585 sw_if_index=0xFFFFFFFF,
2589 """ Add/del IPv6 SR local-SID.
2591 :param localsid_addr:
2592 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2593 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2595 :param is_del: (Default value = 0)
2596 :param end_psp: (Default value = 0)
2597 :param sw_if_index: (Default value = 0xFFFFFFFF)
2598 :param vlan_index: (Default value = 0)
2599 :param fib_table: (Default value = 0)
2602 self.papi.sr_localsid_add_del,
2604 'localsid_addr': localsid_addr,
2606 'behavior': behavior,
2607 'sw_if_index': sw_if_index,
2608 'vlan_index': vlan_index,
2609 'fib_table': fib_table,
2624 :param bsid_addr: bindingSID of the SR Policy
2625 :param weight: weight of the sid list. optional. (default: 1)
2626 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2628 :param type: type/behavior of the SR policy. (default or spray) \
2630 :param fib_table: VRF where to install the FIB entry for the BSID \
2632 :param n_segments: number of segments \
2634 :param segments: a vector of IPv6 address composing the segment list \
2638 self.papi.sr_policy_add,
2639 {'bsid_addr': bsid_addr,
2641 'is_encap': is_encap,
2643 'fib_table': fib_table,
2644 'n_segments': n_segments,
2645 'segments': segments
2654 :param bsid: bindingSID of the SR Policy
2655 :param sr_policy_index: index of the sr policy (default: 0)
2658 self.papi.sr_policy_del,
2659 {'bsid_addr': bsid_addr,
2660 'sr_policy_index': sr_policy_index
2663 def sr_steering_add_del(
2674 Steer traffic L2 and L3 traffic through a given SR policy
2676 :param is_del: delete or add
2677 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2678 :param sr_policy: is the index of the SR Policy (alt to bsid)
2679 :param table_id: is the VRF where to install the FIB entry for the BSID
2680 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2681 :param mask_width: is the mask for L3 traffic type
2682 :param sw_if_index: is the incoming interface for L2 traffic
2683 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2686 self.papi.sr_steering_add_del,
2688 'bsid_addr': bsid_addr,
2689 'sr_policy_index': sr_policy_index,
2690 'table_id': table_id,
2691 'prefix_addr': prefix_addr,
2692 'mask_width': mask_width,
2693 'sw_if_index': sw_if_index,
2694 'traffic_type': traffic_type
2697 def acl_add_replace(self, acl_index, r, tag='',
2699 """Add/replace an ACL
2700 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2701 :param acl_rule r: ACL rules array.
2702 :param str tag: symbolic tag (description) for this ACL.
2703 :param int count: number of rules.
2705 return self.api(self.papi.acl_add_replace,
2706 {'acl_index': acl_index,
2710 expected_retval=expected_retval)
2712 def acl_del(self, acl_index, expected_retval=0):
2718 return self.api(self.papi.acl_del,
2719 {'acl_index': acl_index},
2720 expected_retval=expected_retval)
2722 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2724 return self.api(self.papi.acl_interface_set_acl_list,
2725 {'sw_if_index': sw_if_index,
2729 expected_retval=expected_retval)
2731 def acl_interface_set_etype_whitelist(self, sw_if_index,
2734 return self.api(self.papi.acl_interface_set_etype_whitelist,
2735 {'sw_if_index': sw_if_index,
2736 'count': len(whitelist),
2738 'whitelist': whitelist},
2739 expected_retval=expected_retval)
2741 def acl_interface_add_del(self,
2745 """ Add/Delete ACL to/from interface
2749 :param is_add: (Default value = 1)
2752 return self.api(self.papi.acl_interface_add_del,
2755 'sw_if_index': sw_if_index,
2756 'acl_index': acl_index})
2758 def acl_dump(self, acl_index, expected_retval=0):
2759 return self.api(self.papi.acl_dump,
2760 {'acl_index': acl_index},
2761 expected_retval=expected_retval)
2763 def macip_acl_add(self, rules, tag=""):
2766 :param rules: list of rules for given acl
2770 return self.api(self.papi.macip_acl_add,
2772 'count': len(rules),
2775 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2778 :param rules: list of rules for given acl
2782 return self.api(self.papi.macip_acl_add_replace,
2783 {'acl_index': acl_index,
2785 'count': len(rules),
2788 def macip_acl_del(self, acl_index):
2794 return self.api(self.papi.macip_acl_del,
2795 {'acl_index': acl_index})
2797 def macip_acl_interface_add_del(self,
2801 """ Add MACIP acl to interface
2805 :param is_add: (Default value = 1)
2808 return self.api(self.papi.macip_acl_interface_add_del,
2810 'sw_if_index': sw_if_index,
2811 'acl_index': acl_index})
2813 def macip_acl_interface_get(self):
2814 """ Return interface acls dump
2817 self.papi.macip_acl_interface_get, {})
2819 def macip_acl_dump(self, acl_index=4294967295):
2820 """ Return MACIP acl dump
2824 self.papi.macip_acl_dump, {'acl_index': acl_index})
2826 def policer_add_del(self,
2837 conform_action_type=1,
2839 exceed_action_type=0,
2841 violate_action_type=0,
2843 return self.api(self.papi.policer_add_del,
2850 'rate_type': rate_type,
2851 'round_type': round_type,
2853 'color_aware': color_aware,
2854 'conform_action_type': conform_action_type,
2855 'conform_dscp': conform_dscp,
2856 'exceed_action_type': exceed_action_type,
2857 'exceed_dscp': exceed_dscp,
2858 'violate_action_type': violate_action_type,
2859 'violate_dscp': violate_dscp})
2861 def ip_punt_police(self,
2865 return self.api(self.papi.ip_punt_police,
2866 {'policer_index': policer_index,
2870 def ip_punt_redirect(self,
2876 return self.api(self.papi.ip_punt_redirect,
2877 {'rx_sw_if_index': rx_sw_if_index,
2878 'tx_sw_if_index': tx_sw_if_index,
2883 def bier_table_add_del(self,
2887 """ BIER Table add/del """
2889 self.papi.bier_table_add_del,
2890 {'bt_tbl_id': {"bt_set": bti.set_id,
2891 "bt_sub_domain": bti.sub_domain_id,
2892 "bt_hdr_len_id": bti.hdr_len_id},
2893 'bt_label': mpls_label,
2894 'bt_is_add': is_add})
2896 def bier_table_dump(self):
2897 return self.api(self.papi.bier_table_dump, {})
2899 def bier_route_add_del(self,
2904 """ BIER Route add/del """
2906 self.papi.bier_route_add_del,
2907 {'br_tbl_id': {"bt_set": bti.set_id,
2908 "bt_sub_domain": bti.sub_domain_id,
2909 "bt_hdr_len_id": bti.hdr_len_id},
2911 'br_n_paths': len(paths),
2913 'br_is_add': is_add})
2915 def bier_route_dump(self, bti):
2917 self.papi.bier_route_dump,
2918 {'br_tbl_id': {"bt_set": bti.set_id,
2919 "bt_sub_domain": bti.sub_domain_id,
2920 "bt_hdr_len_id": bti.hdr_len_id}})
2922 def bier_imp_add(self,
2927 """ BIER Imposition Add """
2929 self.papi.bier_imp_add,
2930 {'bi_tbl_id': {"bt_set": bti.set_id,
2931 "bt_sub_domain": bti.sub_domain_id,
2932 "bt_hdr_len_id": bti.hdr_len_id},
2934 'bi_n_bytes': len(ibytes),
2935 'bi_bytes': ibytes})
2937 def bier_imp_del(self, bi_index):
2938 """ BIER Imposition del """
2940 self.papi.bier_imp_del,
2941 {'bi_index': bi_index})
2943 def bier_imp_dump(self):
2944 return self.api(self.papi.bier_imp_dump, {})
2946 def bier_disp_table_add_del(self,
2949 """ BIER Disposition Table add/del """
2951 self.papi.bier_disp_table_add_del,
2952 {'bdt_tbl_id': bdti,
2953 'bdt_is_add': is_add})
2955 def bier_disp_table_dump(self):
2956 return self.api(self.papi.bier_disp_table_dump, {})
2958 def bier_disp_entry_add_del(self,
2968 """ BIER Route add/del """
2970 while (len(lstack) < 16):
2973 self.papi.bier_disp_entry_add_del,
2974 {'bde_tbl_id': bdti,
2976 'bde_payload_proto': payload_proto,
2978 'bde_paths': [{'next_hop': next_hop,
2979 'table_id': next_hop_tbl_id,
2980 'afi': next_hop_afi,
2981 'rpf_id': next_hop_rpf_id,
2983 'label_stack': lstack}],
2984 'bde_is_add': is_add})
2986 def bier_disp_entry_dump(self, bdti):
2988 self.papi.bier_disp_entry_dump,
2989 {'bde_tbl_id': bdti})
2991 def add_node_next(self, node_name, next_name):
2992 """ Set the next node for a given node request
2997 return self.api(self.papi.add_node_next,
2998 {'node_name': node_name,
2999 'next_name': next_name})
3001 def session_enable_disable(self, is_enabled):
3003 self.papi.session_enable_disable,
3004 {'is_enable': is_enabled})
3006 def ipsec_spd_add_del(self, spd_id, is_add=1):
3007 """ SPD add/del - Wrapper to add or del ipsec SPD
3008 Sample CLI : 'ipsec spd add 1'
3010 :param spd_id - SPD ID to be created in the vpp . mandatory
3011 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3013 :returns: reply from the API
3016 self.papi.ipsec_spd_add_del, {
3017 'spd_id': spd_id, 'is_add': is_add})
3019 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3020 """ IPSEC interface SPD add/del - \
3021 Wrapper to associate/disassociate SPD to interface in VPP
3022 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3024 :param spd_id - SPD ID to associate with the interface . mandatory
3025 :param sw_if_index - Interface Index which needs to ipsec \
3026 association mandatory
3027 :param is_add - add(1) or del(0) association with interface \
3028 (Default 1 - add) . optional
3029 :returns: reply from the API
3032 self.papi.ipsec_interface_add_del_spd, {
3034 'sw_if_index': sw_if_index, 'is_add': is_add})
3036 def ipsec_sad_add_del_entry(self,
3039 tunnel_src_address='',
3040 tunnel_dst_address='',
3042 integrity_algorithm=2,
3043 integrity_key_length=0,
3044 integrity_key='C91KUR9GYMm5GfkEvNjX',
3046 crypto_key_length=0,
3047 crypto_key='JPjyOWBeVEQiMe7h',
3050 """ IPSEC SA add/del
3051 Sample CLI : 'ipsec sa add 10 spi 1001 esp \
3052 crypto-key 4a506a794f574265564551694d653768 \
3053 crypto-alg aes-cbc-128 \
3054 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3055 integ-alg sha1-96 tunnel-src 192.168.100.3 \
3056 tunnel-dst 192.168.100.2'
3057 Sample CLI : 'ipsec sa add 20 spi 2001 \
3058 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3061 :param sad_id - Security Association ID to be \
3062 created or deleted. mandatory
3063 :param spi - security param index of the SA in decimal. mandatory
3064 :param tunnel_src_address - incase of tunnel mode outer src address .\
3065 mandatory for tunnel mode
3066 :param tunnel_dst_address - incase of transport mode \
3067 outer dst address. mandatory for tunnel mode
3068 :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional
3069 :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\
3071 :param integrity_key - value in string \
3072 (Default C91KUR9GYMm5GfkEvNjX).optional
3073 :param integrity_key_length - length of the key string in bytes\
3074 (Default 0 - integrity disabled). optional
3075 :param crypto_algorithm - value range 1-11 Default \
3076 (1- AES_CBC_128).optional **
3077 :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional
3078 :param crypto_key_length - length of the key string in bytes\
3079 (Default 0 - crypto disabled). optional
3080 :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\
3082 :param is_tunnel - tunnel mode (1) or transport mode(0) \
3083 (Default 1 - tunnel). optional
3084 :returns: reply from the API
3085 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3086 crypto and ipsec algorithms
3089 self.papi.ipsec_sad_add_del_entry,
3092 'tunnel_src_address': tunnel_src_address,
3093 'tunnel_dst_address': tunnel_dst_address,
3094 'protocol': protocol,
3095 'integrity_algorithm': integrity_algorithm,
3096 'integrity_key_length': integrity_key_length,
3097 'integrity_key': integrity_key,
3098 'crypto_algorithm': crypto_algorithm,
3099 'crypto_key_length': crypto_key_length,
3100 'crypto_key': crypto_key,
3102 'is_tunnel': is_tunnel})
3104 def ipsec_spd_add_del_entry(self,
3106 local_address_start,
3108 remote_address_start,
3109 remote_address_stop,
3111 local_port_stop=65535,
3112 remote_port_start=0,
3113 remote_port_stop=65535,
3121 """ IPSEC policy SPD add/del -
3122 Wrapper to configure ipsec SPD policy entries in VPP
3123 Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \
3124 protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \
3125 remote-ip-range 192.168.3.3 - 192.168.3.3'
3127 :param spd_id - SPD ID for the policy . mandatory
3128 :param local_address_start - local-ip-range start address . mandatory
3129 :param local_address_stop - local-ip-range stop address . mandatory
3130 :param remote_address_start - remote-ip-range start address . mandatory
3131 :param remote_address_stop - remote-ip-range stop address . mandatory
3132 :param local_port_start - (Default 0) . optional
3133 :param local_port_stop - (Default 65535). optional
3134 :param remote_port_start - (Default 0). optional
3135 :param remote_port_stop - (Default 65535). optional
3136 :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any).
3138 :param sa_id - Security Association ID for mapping it to SPD
3139 (default 10). optional
3140 :param policy - bypass(0), discard(1), resolve(2) or protect(3)action
3141 (Default 0 - bypass). optional
3142 :param priotity - value for the spd action (Default 100). optional
3143 :param is_outbound - flag for inbound(0) or outbound(1)
3144 (Default 1 - outbound). optional
3145 :param is_add flag - for addition(1) or deletion(0) of the spd
3146 (Default 1 - addtion). optional
3147 :returns: reply from the API
3150 self.papi.ipsec_spd_add_del_entry,
3152 'local_address_start': local_address_start,
3153 'local_address_stop': local_address_stop,
3154 'remote_address_start': remote_address_start,
3155 'remote_address_stop': remote_address_stop,
3156 'local_port_start': local_port_start,
3157 'local_port_stop': local_port_stop,
3158 'remote_port_start': remote_port_start,
3159 'remote_port_stop': remote_port_stop,
3161 'protocol': protocol,
3163 'priority': priority,
3164 'is_outbound': is_outbound,
3166 'is_ip_any': is_ip_any})
3168 def app_namespace_add(self,
3172 sw_if_index=0xFFFFFFFF,
3175 self.papi.app_namespace_add_del,
3177 'sw_if_index': sw_if_index,
3178 'ip4_fib_id': ip4_fib_id,
3179 'ip6_fib_id': ip6_fib_id,
3180 'namespace_id': namespace_id,
3181 'namespace_id_len': len(namespace_id)})
3183 def punt_socket_register(self, l4_port, pathname, header_version=1,
3184 is_ip4=1, l4_protocol=0x11):
3185 """ Punt to socket """
3186 return self.api(self.papi.punt_socket_register,
3188 'l4_protocol': l4_protocol,
3190 'pathname': pathname,
3191 'header_version': header_version})
3193 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3194 expire_walk_interval_ms, is_ip6=0):
3195 """ Set IP reassembly parameters """
3196 return self.api(self.papi.ip_reassembly_set,
3198 'timeout_ms': timeout_ms,
3199 'expire_walk_interval_ms': expire_walk_interval_ms,
3200 'max_reassemblies': max_reassemblies})
3202 def ip_reassembly_get(self, is_ip6=0):
3203 """ Get IP reassembly parameters """
3204 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3206 def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
3207 """ GBP endpoint Add/Del """
3208 return self.api(self.papi.gbp_endpoint_add_del,
3212 'sw_if_index': sw_if_index,
3216 def gbp_endpoint_dump(self):
3217 """ GBP endpoint Dump """
3218 return self.api(self.papi.gbp_endpoint_dump, {})
3220 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3221 """ GBP contract Add/Del """
3222 return self.api(self.papi.gbp_contract_add_del,
3225 'acl_index': acl_index,
3227 'dst_epg': dst_epg}})
3229 def gbp_contract_dump(self):
3230 """ GBP contract Dump """
3231 return self.api(self.papi.gbp_contract_dump, {})
3233 def ipip_6rd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len,
3234 ip4_prefix, ip4_prefix_len, ip4_src,
3236 """ 6RD tunnel Add """
3237 return self.api(self.papi.ipip_6rd_add_tunnel,
3238 {'fib_index': fib_index,
3239 'ip6_prefix': ip6_prefix,
3240 'ip6_prefix_len': ip6_prefix_len,
3241 'ip4_prefix': ip4_prefix,
3242 'ip4_prefix_len': ip4_prefix_len,
3244 'security_check': security_check})
3246 def ipip_6rd_del_tunnel(self, sw_if_index):
3247 """ 6RD tunnel Delete """
3248 return self.api(self.papi.ipip_6rd_del_tunnel,
3249 {'sw_if_index': sw_if_index})
3251 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3252 instance=0xFFFFFFFF, fib_index=0):
3253 """ IPIP tunnel Add/Del """
3254 return self.api(self.papi.ipip_add_tunnel,
3255 {'is_ipv6': is_ipv6,
3256 'instance': instance,
3257 'src_address': src_address,
3258 'dst_address': dst_address,
3259 'fib_index': fib_index})
3261 def ipip_del_tunnel(self, sw_if_index):
3262 """ IPIP tunnel Delete """
3263 return self.api(self.papi.ipip_del_tunnel,
3264 {'sw_if_index': sw_if_index})
3266 def qos_egress_map_update(self, id, outputs):
3267 """ QOS egress map update """
3268 return self.api(self.papi.qos_egress_map_update,
3272 def qos_egress_map_delete(self, id):
3273 """ QOS egress map delete """
3274 return self.api(self.papi.qos_egress_map_delete,
3277 def qos_mark_enable_disable(self, sw_if_index,
3281 """ QOS Mark Enable/Disable """
3282 return self.api(self.papi.qos_mark_enable_disable,
3284 'sw_if_index': sw_if_index,
3285 'output_source': output_source,
3288 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3289 """ IP QoS recording Enble/Disable """
3290 return self.api(self.papi.qos_record_enable_disable,
3291 {'sw_if_index': sw_if_index,
3292 'input_source': input_source,
3295 def igmp_listen(self, enable, sw_if_index, saddr, gaddr):
3296 """ Listen for new (S,G) on specified interface
3298 :param enable: add/del
3299 :param sw_if_index: interface sw index
3300 :param saddr: source ip4 addr
3301 :param gaddr: group ip4 addr
3303 return self.api(self.papi.igmp_listen,
3305 'sw_if_index': sw_if_index,
3309 def igmp_dump(self, sw_if_index=None):
3310 """ Dump all (S,G) interface configurations """
3311 if sw_if_index is None:
3316 return self.api(self.papi.igmp_dump, {'sw_if_index': sw_if_index,
3317 'dump_all': dump_all})
3319 def igmp_clear_interface(self, sw_if_index):
3320 """ Remove all (S,G)s from specified interface
3321 doesn't send IGMP report!
3324 self.papi.igmp_clear_interface, {
3325 'sw_if_index': sw_if_index})
3327 def want_igmp_events(self, enable=1):
3328 return self.api(self.papi.want_igmp_events, {'enable': enable,
3329 'pid': os.getpid()})