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
39 class UnexpectedApiReturnValueError(Exception):
40 """ exception raised when the API return value is unexpected """
44 class VppPapiProvider(object):
45 """VPP-api provider using vpp-papi
47 @property hook: hook object providing before and after api/cli hooks
50 _zero, _negative = range(2)
52 def __init__(self, name, shm_prefix, test_class):
53 self.hook = Hook("vpp-papi-provider")
55 self.shm_prefix = shm_prefix
56 self.test_class = test_class
57 self._expect_api_retval = self._zero
58 self._expect_stack = []
61 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
62 for root, dirnames, filenames in os.walk(install_dir):
63 for filename in fnmatch.filter(filenames, '*.api.json'):
64 jsonfiles.append(os.path.join(root, filename))
66 self.vpp = VPP(jsonfiles, logger=test_class.logger)
67 self._events = deque()
72 def expect_negative_api_retval(self):
73 """ Expect API failure """
74 self._expect_stack.append(self._expect_api_retval)
75 self._expect_api_retval = self._negative
78 def expect_zero_api_retval(self):
79 """ Expect API success """
80 self._expect_stack.append(self._expect_api_retval)
81 self._expect_api_retval = self._zero
84 def __exit__(self, exc_type, exc_value, traceback):
85 self._expect_api_retval = self._expect_stack.pop()
87 def register_hook(self, hook):
88 """Replace hook registration with new hook
95 def collect_events(self):
96 """ Collect all events from the internal queue and clear the queue. """
98 self._events = deque()
101 def wait_for_event(self, timeout, name=None):
102 """ Wait for and return next event. """
104 self.test_class.logger.debug("Expecting event '%s' within %ss",
107 self.test_class.logger.debug("Expecting event within %ss",
110 self.test_class.logger.debug("Not waiting, event already queued")
111 limit = time.time() + timeout
112 while time.time() < limit:
114 e = self._events.popleft()
115 if name and type(e).__name__ != name:
117 "Unexpected event received: %s, expected: %s" %
118 (type(e).__name__, name))
119 self.test_class.logger.debug("Returning event %s:%s" %
122 time.sleep(0) # yield
123 raise Exception("Event did not occur within timeout")
125 def __call__(self, name, event):
126 """ Enqueue event in the internal event queue. """
127 # FIXME use the name instead of relying on type(e).__name__ ?
128 # FIXME #2 if this throws, it is eaten silently, Ole?
129 self.test_class.logger.debug("New event: %s: %s" % (name, event))
130 self._events.append(event)
133 """Connect the API to VPP"""
134 self.vpp.connect(self.name, self.shm_prefix)
135 self.papi = self.vpp.api
136 self.vpp.register_event_callback(self)
138 def disconnect(self):
139 """Disconnect the API from VPP"""
140 self.vpp.disconnect()
142 def api(self, api_fn, api_args, expected_retval=0):
143 """ Call API function and check it's return value.
144 Call the appropriate hooks before and after the API call
146 :param api_fn: API function to call
147 :param api_args: tuple of API function arguments
148 :param expected_retval: Expected return value (Default value = 0)
149 :returns: reply from the API
152 self.hook.before_api(api_fn.__name__, api_args)
153 reply = api_fn(**api_args)
154 if self._expect_api_retval == self._negative:
155 if hasattr(reply, 'retval') and reply.retval >= 0:
156 msg = "API call passed unexpectedly: expected negative "\
157 "return value instead of %d in %s" % \
158 (reply.retval, repr(reply))
159 self.test_class.logger.info(msg)
160 raise UnexpectedApiReturnValueError(msg)
161 elif self._expect_api_retval == self._zero:
162 if hasattr(reply, 'retval') and reply.retval != expected_retval:
163 msg = "API call failed, expected %d return value instead "\
164 "of %d in %s" % (expected_retval, reply.retval,
166 self.test_class.logger.info(msg)
167 raise UnexpectedApiReturnValueError(msg)
169 raise Exception("Internal error, unexpected value for "
170 "self._expect_api_retval %s" %
171 self._expect_api_retval)
172 self.hook.after_api(api_fn.__name__, api_args)
176 """ Execute a CLI, calling the before/after hooks appropriately.
178 :param cli: CLI to execute
182 self.hook.before_cli(cli)
184 r = self.papi.cli_inband(length=len(cli), cmd=cli)
185 self.hook.after_cli(cli)
186 if hasattr(r, 'reply'):
187 return r.reply.decode().rstrip('\x00')
189 def ppcli(self, cli):
190 """ Helper method to print CLI command in case of info logging level.
192 :param cli: CLI to execute
195 return cli + "\n" + str(self.cli(cli))
197 def _convert_mac(self, mac):
198 return mac.replace(':', '').decode('hex')
200 def show_version(self):
202 return self.api(self.papi.show_version, {})
204 def pg_create_interface(self, pg_index):
210 return self.api(self.papi.pg_create_interface,
211 {"interface_id": pg_index})
213 def sw_interface_dump(self, filter=None):
216 :param filter: (Default value = None)
219 if filter is not None:
220 args = {"name_filter_valid": 1, "name_filter": filter}
223 return self.api(self.papi.sw_interface_dump, args)
225 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
226 """ Set the IPvX Table-id for the Interface
233 return self.api(self.papi.sw_interface_set_table,
234 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
237 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
238 is_ipv6=0, is_add=1, del_all=0):
241 :param addr: param is_ipv6: (Default value = 0)
244 :param is_ipv6: (Default value = 0)
245 :param is_add: (Default value = 1)
246 :param del_all: (Default value = 0)
249 return self.api(self.papi.sw_interface_add_del_address,
250 {'sw_if_index': sw_if_index,
254 'address_length': addr_len,
257 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
259 """ Set the Interface to be unnumbered
261 :param is_add: (Default value = 1)
262 :param sw_if_index - interface That will be unnumbered
263 :param ip_sw_if_index - interface with an IP addres
266 return self.api(self.papi.sw_interface_set_unnumbered,
267 {'sw_if_index': ip_sw_if_index,
268 'unnumbered_sw_if_index': sw_if_index,
271 def sw_interface_enable_disable_mpls(self, sw_if_index,
274 Enable/Disable MPLS on the interface
276 :param is_enable: (Default value = 1)
279 return self.api(self.papi.sw_interface_set_mpls_enable,
280 {'sw_if_index': sw_if_index,
281 'enable': is_enable})
283 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
284 return self.api(self.papi.sw_interface_ip6nd_ra_config,
285 {'sw_if_index': sw_if_index,
286 'suppress': suppress})
288 def set_ip_flow_hash(self,
297 return self.api(self.papi.set_ip_flow_hash,
307 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
308 return self.api(self.papi.ip6nd_proxy_add_del,
310 'sw_if_index': sw_if_index,
313 def ip6_sw_interface_ra_config(self, sw_if_index,
317 return self.api(self.papi.sw_interface_ip6nd_ra_config,
318 {'sw_if_index': sw_if_index,
320 'suppress': suppress,
321 'send_unicast': send_unicast})
323 def ip6_sw_interface_ra_prefix(self,
333 val_lifetime=0xffffffff,
334 pref_lifetime=0xffffffff):
335 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
336 {'sw_if_index': sw_if_index,
338 'address_length': address_length,
339 'use_default': use_default,
340 'no_advertise': no_advertise,
341 'off_link': off_link,
342 'no_autoconfig': no_autoconfig,
343 'no_onlink': no_onlink,
345 'val_lifetime': val_lifetime,
346 'pref_lifetime': pref_lifetime})
348 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
350 Enable/Disable An interface for IPv6
352 return self.api(self.papi.sw_interface_ip6_enable_disable,
353 {'sw_if_index': sw_if_index,
356 def vxlan_add_del_tunnel(
360 mcast_sw_if_index=0xFFFFFFFF,
364 decap_next_index=0xFFFFFFFF,
366 instance=0xFFFFFFFF):
371 :param is_add: (Default value = 1)
372 :param is_ipv6: (Default value = 0)
373 :param encap_vrf_id: (Default value = 0)
374 :param decap_next_index: (Default value = 0xFFFFFFFF)
375 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
376 :param vni: (Default value = 0)
377 :param instance: (Default value = 0xFFFFFFFF)
380 return self.api(self.papi.vxlan_add_del_tunnel,
383 'src_address': src_addr,
384 'dst_address': dst_addr,
385 'mcast_sw_if_index': mcast_sw_if_index,
386 'encap_vrf_id': encap_vrf_id,
387 'decap_next_index': decap_next_index,
389 'instance': instance})
391 def geneve_add_del_tunnel(
395 mcast_sw_if_index=0xFFFFFFFF,
399 decap_next_index=0xFFFFFFFF,
405 :param is_add: (Default value = 1)
406 :param is_ipv6: (Default value = 0)
407 :param encap_vrf_id: (Default value = 0)
408 :param decap_next_index: (Default value = 0xFFFFFFFF)
409 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
410 :param vni: (Default value = 0)
413 return self.api(self.papi.geneve_add_del_tunnel,
416 'local_address': local_addr,
417 'remote_address': remote_addr,
418 'mcast_sw_if_index': mcast_sw_if_index,
419 'encap_vrf_id': encap_vrf_id,
420 'decap_next_index': decap_next_index,
423 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
424 learn=1, arp_term=0, is_add=1):
425 """Create/delete bridge domain.
427 :param int bd_id: Bridge domain index.
428 :param int flood: Enable/disable bcast/mcast flooding in the BD.
430 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
432 :param int forward: Enable/disable forwarding on all interfaces in
433 the BD. (Default value = 1)
434 :param int learn: Enable/disable learning on all interfaces in the BD.
436 :param int arp_term: Enable/disable arp termination in the BD.
438 :param int is_add: Add or delete flag. (Default value = 1)
440 return self.api(self.papi.bridge_domain_add_del,
443 'uu_flood': uu_flood,
446 'arp_term': arp_term,
449 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
450 return self.api(self.papi.bd_ip_mac_add_del,
457 def want_ip4_arp_events(self, enable_disable=1, address=0):
458 return self.api(self.papi.want_ip4_arp_events,
459 {'enable_disable': enable_disable,
461 'pid': os.getpid(), })
463 def want_ip6_nd_events(self, enable_disable=1, address=0):
464 return self.api(self.papi.want_ip6_nd_events,
465 {'enable_disable': enable_disable,
467 'pid': os.getpid(), })
469 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
470 max_macs_in_event=0, learn_limit=0):
471 return self.api(self.papi.want_l2_macs_events,
472 {'enable_disable': enable_disable,
473 'scan_delay': scan_delay,
474 'max_macs_in_event': max_macs_in_event,
475 'learn_limit': learn_limit,
476 'pid': os.getpid(), })
478 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
479 filter_mac=0, bvi_mac=0):
480 """Create/delete L2 FIB entry.
482 :param str mac: MAC address to create FIB entry for.
483 :param int bd_id: Bridge domain index.
484 :param int sw_if_index: Software interface index of the interface.
485 :param int is_add: Add or delete flag. (Default value = 1)
486 :param int static_mac: Set to 1 to create static MAC entry.
488 :param int filter_mac: Set to 1 to drop packet that's source or
489 destination MAC address contains defined MAC address.
491 :param int bvi_mac: Set to 1 to create entry that points to BVI
492 interface. (Default value = 0)
494 return self.api(self.papi.l2fib_add_del,
495 {'mac': self._convert_mac(mac),
497 'sw_if_index': sw_if_index,
499 'static_mac': static_mac,
500 'filter_mac': filter_mac,
503 def l2fib_flush_int(self, sw_if_index):
504 """Flush L2 FIB entries for sw_if_index.
506 :param int sw_if_index: Software interface index of the interface.
508 return self.api(self.papi.l2fib_flush_int,
509 {'sw_if_index': sw_if_index})
511 def l2fib_flush_bd(self, bd_id):
512 """Flush L2 FIB entries for bd_id.
514 :param int sw_if_index: Bridge Domain id.
516 return self.api(self.papi.l2fib_flush_bd,
519 def l2fib_flush_all(self):
522 return self.api(self.papi.l2fib_flush_all, {})
524 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
525 shg=0, bvi=0, enable=1):
526 """Add/remove interface to/from bridge domain.
528 :param int sw_if_index: Software interface index of the interface.
529 :param int bd_id: Bridge domain index.
530 :param int shg: Split-horizon group index. (Default value = 0)
531 :param int bvi: Set interface as a bridge group virtual interface.
533 :param int enable: Add or remove interface. (Default value = 1)
535 return self.api(self.papi.sw_interface_set_l2_bridge,
536 {'rx_sw_if_index': sw_if_index,
542 def bridge_flags(self, bd_id, is_set, feature_bitmap):
543 """Enable/disable required feature of the bridge domain with defined ID.
545 :param int bd_id: Bridge domain ID.
546 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
547 :param int feature_bitmap: Bitmap value of the feature to be set:
551 - uu-flood (1 << 3) or
554 return self.api(self.papi.bridge_flags,
557 'feature_bitmap': feature_bitmap})
559 def bridge_domain_dump(self, bd_id=0):
562 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
563 existing bridge domains returned)
564 :return: Dictionary of bridge domain(s) data.
566 return self.api(self.papi.bridge_domain_dump,
569 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
571 """Create or delete unidirectional cross-connect from Tx interface to
574 :param int rx_sw_if_index: Software interface index of Rx interface.
575 :param int tx_sw_if_index: Software interface index of Tx interface.
576 :param int enable: Create cross-connect if equal to 1, delete
577 cross-connect if equal to 0.
580 return self.api(self.papi.sw_interface_set_l2_xconnect,
581 {'rx_sw_if_index': rx_sw_if_index,
582 'tx_sw_if_index': tx_sw_if_index,
585 def sw_interface_set_l2_tag_rewrite(
592 """L2 interface vlan tag rewrite configure request
593 :param client_index - opaque cookie to identify the sender
594 :param context - sender context, to match reply w/ request
595 :param sw_if_index - interface the operation is applied to
596 :param vtr_op - Choose from l2_vtr_op_t enum values
597 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
598 :param tag1 - Needed for any push or translate vtr op
599 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
602 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
603 {'sw_if_index': sw_if_index,
609 def sw_interface_set_l2_emulation(
614 :param sw_if_index - interface the operation is applied to
617 return self.api(self.papi.l2_emulation,
618 {'sw_if_index': sw_if_index,
621 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
624 :param admin_up_down:
628 return self.api(self.papi.sw_interface_set_flags,
629 {'sw_if_index': sw_if_index,
630 'admin_up_down': admin_up_down})
632 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
633 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
634 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
635 """Create subinterface
636 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
638 :param sub_id: param inner_vlan:
642 :param no_tags: (Default value = 0)
643 :param one_tag: (Default value = 0)
644 :param two_tags: (Default value = 0)
645 :param dot1ad: (Default value = 0)
646 :param exact_match: (Default value = 0)
647 :param default_sub: (Default value = 0)
648 :param outer_vlan_id_any: (Default value = 0)
649 :param inner_vlan_id_any: (Default value = 0)
653 self.papi.create_subif,
654 {'sw_if_index': sw_if_index,
658 'two_tags': two_tags,
660 'exact_match': exact_match,
661 'default_sub': default_sub,
662 'outer_vlan_id_any': outer_vlan_id_any,
663 'inner_vlan_id_any': inner_vlan_id_any,
664 'outer_vlan_id': outer_vlan,
665 'inner_vlan_id': inner_vlan})
667 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
668 """Create p2p ethernet subinterface
670 :param sw_if_index: main (parent) interface
671 :param remote_mac: client (remote) mac address
675 self.papi.p2p_ethernet_add,
676 {'parent_if_index': sw_if_index,
677 'remote_mac': remote_mac,
678 'subif_id': subif_id})
680 def delete_subif(self, sw_if_index):
681 """Delete subinterface
685 return self.api(self.papi.delete_subif,
686 {'sw_if_index': sw_if_index})
688 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
689 """Delete p2p ethernet subinterface
691 :param sw_if_index: main (parent) interface
692 :param remote_mac: client (remote) mac address
696 self.papi.p2p_ethernet_del,
697 {'parent_if_index': sw_if_index,
698 'remote_mac': remote_mac})
700 def create_vlan_subif(self, sw_if_index, vlan):
707 return self.api(self.papi.create_vlan_subif,
708 {'sw_if_index': sw_if_index,
711 def create_loopback(self, mac=''):
714 :param mac: (Optional)
716 return self.api(self.papi.create_loopback,
717 {'mac_address': mac})
719 def delete_loopback(self, sw_if_index):
720 return self.api(self.papi.delete_loopback,
721 {'sw_if_index': sw_if_index, })
723 def ip_table_add_del(self,
730 :param is_add: (Default value = 1)
731 :param is_ipv6: (Default value = 0)
736 self.papi.ip_table_add_del,
737 {'table_id': table_id,
741 def ip_add_del_route(
746 next_hop_sw_if_index=0xFFFFFFFF,
750 next_hop_n_out_labels=0,
751 next_hop_out_label_stack=[],
752 next_hop_via_label=MPLS_LABEL_INVALID,
753 next_hop_id=0xFFFFFFFF,
755 is_resolve_attached=0,
756 classify_table_index=0xFFFFFFFF,
770 :param dst_address_length:
771 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
773 :param next_hop_address:
774 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
775 :param vrf_id: (Default value = 0)
776 :param lookup_in_vrf: (Default value = 0)
777 :param classify_table_index: (Default value = 0xFFFFFFFF)
778 :param is_add: (Default value = 1)
779 :param is_drop: (Default value = 0)
780 :param is_ipv6: (Default value = 0)
781 :param is_local: (Default value = 0)
782 :param is_classify: (Default value = 0)
783 :param is_multipath: (Default value = 0)
784 :param is_resolve_host: (Default value = 0)
785 :param is_resolve_attached: (Default value = 0)
786 :param is_dvr: (Default value = 0)
787 :param is_source_lookup: (Default value = 0)
788 :param next_hop_weight: (Default value = 1)
793 self.papi.ip_add_del_route,
794 {'next_hop_sw_if_index': next_hop_sw_if_index,
795 'table_id': table_id,
796 'classify_table_index': classify_table_index,
797 'next_hop_table_id': next_hop_table_id,
800 'is_unreach': is_unreach,
801 'is_prohibit': is_prohibit,
803 'is_local': is_local,
804 'is_classify': is_classify,
805 'is_multipath': is_multipath,
806 'is_resolve_host': is_resolve_host,
807 'is_resolve_attached': is_resolve_attached,
809 'is_source_lookup': is_source_lookup,
810 'is_udp_encap': is_udp_encap,
811 'next_hop_weight': next_hop_weight,
812 'dst_address_length': dst_address_length,
813 'dst_address': dst_address,
814 'next_hop_id': next_hop_id,
815 'next_hop_address': next_hop_address,
816 'next_hop_n_out_labels': next_hop_n_out_labels,
817 'next_hop_via_label': next_hop_via_label,
818 'next_hop_out_label_stack': next_hop_out_label_stack})
820 def ip_fib_dump(self):
821 return self.api(self.papi.ip_fib_dump, {})
823 def ip6_fib_dump(self):
824 return self.api(self.papi.ip6_fib_dump, {})
826 def ip_neighbor_add_del(self,
835 """ Add neighbor MAC to IPv4 or IPv6 address.
840 :param is_add: (Default value = 1)
841 :param is_ipv6: (Default value = 0)
842 :param is_static: (Default value = 0)
843 :param is_no_adj_fib: (Default value = 0)
847 self.papi.ip_neighbor_add_del,
848 {'sw_if_index': sw_if_index,
851 'is_static': is_static,
852 'is_no_adj_fib': is_no_adj_fib,
853 'mac_address': mac_address,
854 'dst_address': dst_address
858 def ip_neighbor_dump(self,
861 """ Return IP neighbor dump.
864 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
868 self.papi.ip_neighbor_dump,
870 'sw_if_index': sw_if_index
874 def proxy_arp_add_del(self,
879 """ Config Proxy Arp Range.
881 :param low_address: Start address in the rnage to Proxy for
882 :param hi_address: End address in the rnage to Proxy for
883 :param vrf_id: The VRF/table in which to proxy
887 self.papi.proxy_arp_add_del,
890 'low_address': low_address,
891 'hi_address': hi_address,
895 def proxy_arp_intfc_enable_disable(self,
898 """ Enable/Disable an interface for proxy ARP requests
900 :param sw_if_index: Interface
901 :param enable_disable: Enable/Disable
905 self.papi.proxy_arp_intfc_enable_disable,
906 {'sw_if_index': sw_if_index,
907 'enable_disable': is_enable
915 """ Reset VRF (remove all routes etc.) request.
917 :param int vrf_id: ID of the FIB table / VRF to reset.
918 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
932 """ Reset VRF (remove all routes etc.) request.
934 :param int vrf_id: ID of the FIB table / VRF to reset.
935 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
950 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
959 def sw_interface_span_enable_disable(
960 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
963 :param sw_if_index_from:
964 :param sw_if_index_to:
968 return self.api(self.papi.sw_interface_span_enable_disable,
969 {'sw_if_index_from': sw_if_index_from,
970 'sw_if_index_to': sw_if_index_to,
975 def gre_tunnel_add_del(self,
986 :param outer_fib_id: (Default value = 0)
987 :param is_add: (Default value = 1)
988 :param is_ipv6: (Default value = 0)
989 :param is_teb: (Default value = 0)
993 self.papi.gre_add_del_tunnel,
997 'src_address': src_address,
998 'dst_address': dst_address,
999 'outer_fib_id': outer_fib_id}
1002 def udp_encap_add_del(self,
1011 """ Add a GRE tunnel
1012 :param id: user provided ID
1017 :param outer_fib_id: (Default value = 0)
1018 :param is_add: (Default value = 1)
1019 :param is_ipv6: (Default value = 0)
1023 self.papi.udp_encap_add_del,
1029 'src_port': src_port,
1030 'dst_port': dst_port,
1031 'table_id': table_id}
1034 def udp_encap_dump(self):
1035 return self.api(self.papi.udp_encap_dump, {})
1037 def mpls_fib_dump(self):
1038 return self.api(self.papi.mpls_fib_dump, {})
1040 def mpls_table_add_del(
1047 :param is_add: (Default value = 1)
1052 self.papi.mpls_table_add_del,
1053 {'mt_table_id': table_id,
1054 'mt_is_add': is_add})
1056 def mpls_route_add_del(
1062 next_hop_sw_if_index=0xFFFFFFFF,
1064 next_hop_table_id=0,
1066 next_hop_n_out_labels=0,
1067 next_hop_out_label_stack=[],
1068 next_hop_via_label=MPLS_LABEL_INVALID,
1070 is_resolve_attached=0,
1077 classify_table_index=0xFFFFFFFF,
1081 :param dst_address_length:
1082 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1084 :param next_hop_address:
1085 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1086 :param vrf_id: (Default value = 0)
1087 :param lookup_in_vrf: (Default value = 0)
1088 :param classify_table_index: (Default value = 0xFFFFFFFF)
1089 :param is_add: (Default value = 1)
1090 :param is_drop: (Default value = 0)
1091 :param is_ipv6: (Default value = 0)
1092 :param is_local: (Default value = 0)
1093 :param is_classify: (Default value = 0)
1094 :param is_multipath: (Default value = 0)
1095 :param is_multicast: (Default value = 0)
1096 :param is_resolve_host: (Default value = 0)
1097 :param is_resolve_attached: (Default value = 0)
1098 :param next_hop_weight: (Default value = 1)
1103 self.papi.mpls_route_add_del,
1106 'mr_table_id': table_id,
1107 'mr_classify_table_index': classify_table_index,
1108 'mr_is_add': is_add,
1109 'mr_is_classify': is_classify,
1110 'mr_is_multipath': is_multipath,
1111 'mr_is_multicast': is_multicast,
1112 'mr_is_resolve_host': is_resolve_host,
1113 'mr_is_resolve_attached': is_resolve_attached,
1114 'mr_is_interface_rx': is_interface_rx,
1115 'mr_is_rpf_id': is_rpf_id,
1116 'mr_next_hop_proto': next_hop_proto,
1117 'mr_next_hop_weight': next_hop_weight,
1118 'mr_next_hop': next_hop_address,
1119 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1120 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1121 'mr_next_hop_table_id': next_hop_table_id,
1122 'mr_next_hop_via_label': next_hop_via_label,
1123 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1125 def mpls_ip_bind_unbind(
1137 self.papi.mpls_ip_bind_unbind,
1138 {'mb_mpls_table_id': table_id,
1140 'mb_ip_table_id': ip_table_id,
1141 'mb_is_bind': is_bind,
1142 'mb_is_ip4': is_ip4,
1143 'mb_address_length': dst_address_length,
1144 'mb_address': dst_address})
1146 def mpls_tunnel_add_del(
1149 next_hop_proto_is_ip4,
1151 next_hop_sw_if_index=0xFFFFFFFF,
1152 next_hop_table_id=0,
1154 next_hop_n_out_labels=0,
1155 next_hop_out_label_stack=[],
1156 next_hop_via_label=MPLS_LABEL_INVALID,
1162 :param dst_address_length:
1163 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1165 :param next_hop_address:
1166 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1167 :param vrf_id: (Default value = 0)
1168 :param lookup_in_vrf: (Default value = 0)
1169 :param classify_table_index: (Default value = 0xFFFFFFFF)
1170 :param is_add: (Default value = 1)
1171 :param is_drop: (Default value = 0)
1172 :param is_ipv6: (Default value = 0)
1173 :param is_local: (Default value = 0)
1174 :param is_classify: (Default value = 0)
1175 :param is_multipath: (Default value = 0)
1176 :param is_resolve_host: (Default value = 0)
1177 :param is_resolve_attached: (Default value = 0)
1178 :param next_hop_weight: (Default value = 1)
1179 :param is_multicast: (Default value = 0)
1183 self.papi.mpls_tunnel_add_del,
1184 {'mt_sw_if_index': tun_sw_if_index,
1185 'mt_is_add': is_add,
1186 'mt_l2_only': l2_only,
1187 'mt_is_multicast': is_multicast,
1188 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1189 'mt_next_hop_weight': next_hop_weight,
1190 'mt_next_hop': next_hop_address,
1191 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1192 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1193 'mt_next_hop_table_id': next_hop_table_id,
1194 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1196 def nat44_interface_add_del_feature(
1201 """Enable/disable NAT44 feature on the interface
1203 :param sw_if_index: Software index of the interface
1204 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1205 :param is_add: 1 if add, 0 if delete (Default value = 1)
1208 self.papi.nat44_interface_add_del_feature,
1210 'is_inside': is_inside,
1211 'sw_if_index': sw_if_index})
1213 def nat44_interface_add_del_output_feature(
1218 """Enable/disable NAT44 output feature on the interface
1220 :param sw_if_index: Software index of the interface
1221 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1222 :param is_add: 1 if add, 0 if delete (Default value = 1)
1225 self.papi.nat44_interface_add_del_output_feature,
1227 'is_inside': is_inside,
1228 'sw_if_index': sw_if_index})
1230 def nat44_add_del_static_mapping(
1234 external_sw_if_index=0xFFFFFFFF,
1244 """Add/delete NAT44 static mapping
1246 :param local_ip: Local IP address
1247 :param external_ip: External IP address
1248 :param external_sw_if_index: External interface instead of IP address
1249 :param local_port: Local port number (Default value = 0)
1250 :param external_port: External port number (Default value = 0)
1251 :param addr_only: 1 if address only mapping, 0 if address and port
1252 :param vrf_id: VRF ID
1253 :param protocol: IP protocol (Default value = 0)
1254 :param twice_nat: 1 if translate external host address and port
1255 :param out2in_only: if 1 rule is matching only out2in direction
1256 :param tag: Opaque string tag
1257 :param is_add: 1 if add, 0 if delete (Default value = 1)
1260 self.papi.nat44_add_del_static_mapping,
1262 'addr_only': addr_only,
1263 'local_ip_address': local_ip,
1264 'external_ip_address': external_ip,
1265 'local_port': local_port,
1266 'external_port': external_port,
1267 'external_sw_if_index': external_sw_if_index,
1269 'protocol': protocol,
1270 'twice_nat': twice_nat,
1271 'out2in_only': out2in_only,
1274 def nat44_add_del_identity_mapping(
1277 sw_if_index=0xFFFFFFFF,
1284 """Add/delete NAT44 identity mapping
1286 :param ip: IP address (Default value = 0)
1287 :param sw_if_index: Interface instead of IP address
1288 :param port: Port number (Default value = 0)
1289 :param addr_only: 1 if address only mapping, 0 if address and port
1290 :param vrf_id: VRF ID
1291 :param protocol: IP protocol (Default value = 0)
1292 :param tag: Opaque string tag
1293 :param is_add: 1 if add, 0 if delete (Default value = 1)
1296 self.papi.nat44_add_del_identity_mapping,
1298 'addr_only': addr_only,
1301 'sw_if_index': sw_if_index,
1304 'protocol': protocol})
1306 def nat44_add_del_address_range(
1313 """Add/del NAT44 address range
1315 :param first_ip_address: First IP address
1316 :param last_ip_address: Last IP address
1317 :param vrf_id: VRF id for the address range
1318 :param twice_nat: twice NAT address for extenal hosts
1319 :param is_add: 1 if add, 0 if delete (Default value = 1)
1322 self.papi.nat44_add_del_address_range,
1323 {'first_ip_address': first_ip_address,
1324 'last_ip_address': last_ip_address,
1326 'twice_nat': twice_nat,
1329 def nat44_address_dump(self):
1330 """Dump NAT44 addresses
1331 :return: Dictionary of NAT44 addresses
1333 return self.api(self.papi.nat44_address_dump, {})
1335 def nat44_interface_dump(self):
1336 """Dump interfaces with NAT44 feature
1337 :return: Dictionary of interfaces with NAT44 feature
1339 return self.api(self.papi.nat44_interface_dump, {})
1341 def nat44_interface_output_feature_dump(self):
1342 """Dump interfaces with NAT44 output feature
1343 :return: Dictionary of interfaces with NAT44 output feature
1345 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1347 def nat44_static_mapping_dump(self):
1348 """Dump NAT44 static mappings
1349 :return: Dictionary of NAT44 static mappings
1351 return self.api(self.papi.nat44_static_mapping_dump, {})
1353 def nat44_identity_mapping_dump(self):
1354 """Dump NAT44 identity mappings
1355 :return: Dictionary of NAT44 identity mappings
1357 return self.api(self.papi.nat44_identity_mapping_dump, {})
1359 def nat_show_config(self):
1360 """Show NAT plugin config
1361 :return: NAT plugin config parameters
1363 return self.api(self.papi.nat_show_config, {})
1365 def nat44_add_interface_addr(
1370 """Add/del NAT44 address from interface
1372 :param sw_if_index: Software index of the interface
1373 :param twice_nat: twice NAT address for extenal hosts
1374 :param is_add: 1 if add, 0 if delete (Default value = 1)
1377 self.papi.nat44_add_del_interface_addr,
1379 'sw_if_index': sw_if_index,
1380 'twice_nat': twice_nat})
1382 def nat44_interface_addr_dump(self):
1383 """Dump NAT44 addresses interfaces
1384 :return: Dictionary of NAT44 addresses interfaces
1386 return self.api(self.papi.nat44_interface_addr_dump, {})
1393 """Enable/disable NAT IPFIX logging
1395 :param domain_id: Observation domain ID (Default value = 1)
1396 :param src_port: Source port number (Default value = 4739)
1397 :param enable: 1 if enable, 0 if disable (Default value = 1)
1400 self.papi.nat_ipfix_enable_disable,
1401 {'domain_id': domain_id,
1402 'src_port': src_port,
1405 def nat44_user_session_dump(
1409 """Dump NAT44 user's sessions
1411 :param ip_address: ip adress of the user to be dumped
1412 :param cpu_index: cpu_index on which the user is
1413 :param vrf_id: VRF ID
1414 :return: Dictionary of S-NAT sessions
1417 self.papi.nat44_user_session_dump,
1418 {'ip_address': ip_address,
1421 def nat44_user_dump(self):
1424 :return: Dictionary of NAT44 users
1426 return self.api(self.papi.nat44_user_dump, {})
1428 def nat44_add_del_lb_static_mapping(
1440 """Add/delete NAT44 load balancing static mapping
1442 :param twice_nat: 1 if translate external host address and port
1443 :param tag: Opaque string tag
1444 :param is_add - 1 if add, 0 if delete
1447 self.papi.nat44_add_del_lb_static_mapping,
1449 'external_addr': external_addr,
1450 'external_port': external_port,
1451 'protocol': protocol,
1453 'twice_nat': twice_nat,
1454 'out2in_only': out2in_only,
1456 'local_num': local_num,
1459 def nat44_lb_static_mapping_dump(self):
1460 """Dump NAT44 load balancing static mappings
1462 :return: Dictionary of NAT44 load balancing static mapping
1464 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1466 def nat44_del_session(
1473 """Delete NAT44 session
1475 :param addr: IPv4 address
1476 :param por: port number
1477 :param protocol: IP protocol number
1478 :param vrf_id: VRF ID
1479 :param is_in: 1 if inside network addres and port pari, 0 if outside
1482 self.papi.nat44_del_session,
1485 'protocol': protocol,
1489 def nat44_forwarding_enable_disable(
1492 """Enable/disable forwarding for NAT44
1494 :param enable: 1 for enable, 0 for disable
1497 self.papi.nat44_forwarding_enable_disable,
1507 """Set NAT virtual fragmentation reassembly
1509 :param timeout: reassembly timeout (Default 2sec)
1510 :param max_reass: maximum concurrent reassemblies (Default 1024)
1511 :param max_frag: maximum fragmets per reassembly (Default 5)
1512 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1513 :param is_ip6: 1 if IPv6, 0 if IPv4
1516 self.papi.nat_set_reass,
1517 {'timeout': timeout,
1518 'max_reass': max_reass,
1519 'max_frag': max_frag,
1520 'drop_frag': drop_frag,
1523 def nat_get_reass(self):
1524 """Get NAT virtual fragmentation reassembly configuration
1526 :return: NAT virtual fragmentation reassembly configuration
1528 return self.api(self.papi.nat_get_reass, {})
1530 def nat_reass_dump(self):
1531 """Dump NAT virtual fragmentation reassemblies
1533 :return: Dictionary of NAT virtual fragmentation reassemblies
1535 return self.api(self.papi.nat_reass_dump, {})
1537 def nat_det_add_del_map(
1544 """Add/delete deterministic NAT mapping
1546 :param is_add - 1 if add, 0 if delete
1547 :param in_addr - inside IP address
1548 :param in_plen - inside IP address prefix length
1549 :param out_addr - outside IP address
1550 :param out_plen - outside IP address prefix length
1553 self.papi.nat_det_add_del_map,
1558 'out_addr': out_addr,
1559 'out_plen': out_plen})
1561 def nat_det_forward(
1564 """Get outside address and port range from inside address
1566 :param in_addr - inside IP address
1569 self.papi.nat_det_forward,
1570 {'in_addr': in_addr,
1573 def nat_det_reverse(
1577 """Get inside address from outside address and port
1579 :param out_addr - outside IP address
1580 :param out_port - outside port
1583 self.papi.nat_det_reverse,
1584 {'out_addr': out_addr,
1585 'out_port': out_port})
1587 def nat_det_map_dump(self):
1588 """Dump deterministic NAT mappings
1590 :return: Dictionary of deterministic NAT mappings
1592 return self.api(self.papi.nat_det_map_dump, {})
1594 def nat_det_set_timeouts(
1597 tcp_established=7440,
1600 """Set values of timeouts for deterministic NAT (in seconds)
1602 :param udp - UDP timeout (Default value = 300)
1603 :param tcp_established - TCP established timeout (Default value = 7440)
1604 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1605 :param icmp - ICMP timeout (Default value = 60)
1608 self.papi.nat_det_set_timeouts,
1610 'tcp_established': tcp_established,
1611 'tcp_transitory': tcp_transitory,
1614 def nat_det_get_timeouts(self):
1615 """Get values of timeouts for deterministic NAT
1617 :return: Timeouts for deterministic NAT (in seconds)
1619 return self.api(self.papi.nat_det_get_timeouts, {})
1621 def nat_det_close_session_out(
1627 """Close deterministic NAT session using outside address and port
1629 :param out_addr - outside IP address
1630 :param out_port - outside port
1631 :param ext_addr - external host IP address
1632 :param ext_port - external host port
1635 self.papi.nat_det_close_session_out,
1636 {'out_addr': out_addr,
1637 'out_port': out_port,
1638 'ext_addr': ext_addr,
1639 'ext_port': ext_port})
1641 def nat_det_close_session_in(
1647 """Close deterministic NAT session using inside address and port
1649 :param in_addr - inside IP address
1650 :param in_port - inside port
1651 :param ext_addr - external host IP address
1652 :param ext_port - external host port
1655 self.papi.nat_det_close_session_in,
1656 {'in_addr': in_addr,
1658 'ext_addr': ext_addr,
1659 'ext_port': ext_port,
1662 def nat_det_session_dump(
1665 """Dump deterministic NAT sessions belonging to a user
1667 :param user_addr - inside IP address of the user
1668 :return: Dictionary of deterministic NAT sessions
1671 self.papi.nat_det_session_dump,
1673 'user_addr': user_addr})
1675 def nat64_add_del_pool_addr_range(
1681 """Add/del address range to NAT64 pool
1683 :param start_addr: First IP address
1684 :param end_addr: Last IP address
1685 :param vrf_id: VRF id for the address range
1686 :param is_add: 1 if add, 0 if delete (Default value = 1)
1689 self.papi.nat64_add_del_pool_addr_range,
1690 {'start_addr': start_addr,
1691 'end_addr': end_addr,
1695 def nat64_pool_addr_dump(self):
1696 """Dump NAT64 pool addresses
1697 :return: Dictionary of NAT64 pool addresses
1699 return self.api(self.papi.nat64_pool_addr_dump, {})
1701 def nat64_add_del_interface(
1706 """Enable/disable NAT64 feature on the interface
1707 :param sw_if_index: Index of the interface
1708 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1709 :param is_add: 1 if add, 0 if delete (Default value = 1)
1712 self.papi.nat64_add_del_interface,
1713 {'sw_if_index': sw_if_index,
1714 'is_inside': is_inside,
1717 def nat64_interface_dump(self):
1718 """Dump interfaces with NAT64 feature
1719 :return: Dictionary of interfaces with NAT64 feature
1721 return self.api(self.papi.nat64_interface_dump, {})
1723 def nat64_add_del_static_bib(
1732 """Add/delete S-NAT static BIB entry
1734 :param in_ip: Inside IPv6 address
1735 :param out_ip: Outside IPv4 address
1736 :param in_port: Inside port number
1737 :param out_port: Outside port number
1738 :param protocol: IP protocol
1739 :param vrf_id: VRF ID (Default value = 0)
1740 :param is_add: 1 if add, 0 if delete (Default value = 1)
1743 self.papi.nat64_add_del_static_bib,
1752 def nat64_bib_dump(self, protocol=255):
1755 :param protocol: IP protocol (Default value = 255, all BIBs)
1756 :returns: Dictionary of NAT64 BIB entries
1758 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1760 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1761 tcp_incoming_syn=6):
1762 """Set values of timeouts for NAT64 (in seconds)
1764 :param udpi: UDP timeout (Default value = 300)
1765 :param icmp: ICMP timeout (Default value = 60)
1766 :param tcp_trans: TCP transitory timeout (Default value = 240)
1767 :param tcp_est: TCP established timeout (Default value = 7440)
1768 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1771 self.papi.nat64_set_timeouts,
1774 'tcp_trans': tcp_trans,
1776 'tcp_incoming_syn': tcp_incoming_syn})
1778 def nat64_get_timeouts(self):
1779 """Get values of timeouts for NAT64
1781 :return: Timeouts for NAT64 (in seconds)
1783 return self.api(self.papi.nat64_get_timeouts, {})
1785 def nat64_st_dump(self, protocol=255):
1786 """Dump NAT64 session table
1788 :param protocol: IP protocol (Default value = 255, all STs)
1789 :returns: Dictionary of NAT64 sesstion table entries
1791 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1793 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1794 """Add/del NAT64 prefix
1796 :param prefix: NAT64 prefix
1797 :param plen: NAT64 prefix length
1798 :param vrf_id: VRF id of tenant (Default 0)
1799 :param is_add: 1 if add, 0 if delete (Default value = 1)
1802 self.papi.nat64_add_del_prefix,
1808 def nat64_prefix_dump(self):
1809 """Dump NAT64 prefix
1811 :returns: Dictionary of NAT64 prefixes
1813 return self.api(self.papi.nat64_prefix_dump, {})
1815 def nat64_add_interface_addr(
1819 """Add/del NAT64 address from interface
1821 :param sw_if_index: Software index of the interface
1822 :param is_add: 1 if add, 0 if delete (Default value = 1)
1824 return self.api(self.papi.nat64_add_del_interface_addr,
1825 {'is_add': is_add, 'sw_if_index': sw_if_index})
1827 def dslite_set_aftr_addr(self, ip6, ip4):
1828 """Set DS-Lite AFTR addresses
1830 :param ip4: IPv4 address
1831 :param ip6: IPv6 address
1834 self.papi.dslite_set_aftr_addr,
1838 def dslite_set_b4_addr(self, ip6, ip4):
1839 """Set DS-Lite B4 IPv6 address
1841 :param ip4: IPv4 address
1842 :param ip6: IPv6 address
1845 self.papi.dslite_set_b4_addr,
1849 def dslite_add_del_pool_addr_range(
1854 """Add/del address range to DS-Lite pool
1856 :param start_addr: First IP address
1857 :param end_addr: Last IP address
1858 :param is_add: 1 if add, 0 if delete (Default value = 1)
1861 self.papi.dslite_add_del_pool_addr_range,
1862 {'start_addr': start_addr,
1863 'end_addr': end_addr,
1866 def nat66_add_del_interface(
1871 """Enable/disable NAT66 feature on the interface
1872 :param sw_if_index: Index of the interface
1873 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1874 :param is_add: 1 if add, 0 if delete (Default value = 1)
1877 self.papi.nat66_add_del_interface,
1878 {'sw_if_index': sw_if_index,
1879 'is_inside': is_inside,
1882 def nat66_add_del_static_mapping(
1888 """Add/delete NAT66 static mapping
1890 :param in_ip: Inside IPv6 address
1891 :param out_ip: Outside IPv6 address
1892 :param vrf_id: VRF ID (Default value = 0)
1893 :param is_add: 1 if add, 0 if delete (Default value = 1)
1896 self.papi.nat66_add_del_static_mapping,
1897 {'local_ip_address': in_ip,
1898 'external_ip_address': out_ip,
1902 def nat66_interface_dump(self):
1903 """Dump interfaces with NAT66 feature
1904 :return: Dictionary of interfaces with NAT66 feature
1906 return self.api(self.papi.nat66_interface_dump, {})
1908 def nat66_static_mapping_dump(self):
1909 """Dump NAT66 static mappings
1910 :return: Dictionary of NAT66 static mappings
1912 return self.api(self.papi.nat66_static_mapping_dump, {})
1914 def control_ping(self):
1915 self.api(self.papi.control_ping)
1917 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1918 detect_mult, local_addr, peer_addr, is_ipv6=0,
1919 bfd_key_id=None, conf_key_id=None):
1920 if bfd_key_id is None:
1921 return self.api(self.papi.bfd_udp_add,
1923 'sw_if_index': sw_if_index,
1924 'desired_min_tx': desired_min_tx,
1925 'required_min_rx': required_min_rx,
1926 'local_addr': local_addr,
1927 'peer_addr': peer_addr,
1929 'detect_mult': detect_mult,
1932 return self.api(self.papi.bfd_udp_add,
1934 'sw_if_index': sw_if_index,
1935 'desired_min_tx': desired_min_tx,
1936 'required_min_rx': required_min_rx,
1937 'local_addr': local_addr,
1938 'peer_addr': peer_addr,
1940 'detect_mult': detect_mult,
1941 'is_authenticated': 1,
1942 'bfd_key_id': bfd_key_id,
1943 'conf_key_id': conf_key_id,
1946 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1947 detect_mult, local_addr, peer_addr, is_ipv6=0):
1948 return self.api(self.papi.bfd_udp_mod,
1950 'sw_if_index': sw_if_index,
1951 'desired_min_tx': desired_min_tx,
1952 'required_min_rx': required_min_rx,
1953 'local_addr': local_addr,
1954 'peer_addr': peer_addr,
1956 'detect_mult': detect_mult,
1959 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1960 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1962 return self.api(self.papi.bfd_udp_auth_activate,
1964 'sw_if_index': sw_if_index,
1965 'local_addr': local_addr,
1966 'peer_addr': peer_addr,
1968 'is_delayed': 1 if is_delayed else 0,
1969 'bfd_key_id': bfd_key_id,
1970 'conf_key_id': conf_key_id,
1973 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1974 is_ipv6=0, is_delayed=False):
1975 return self.api(self.papi.bfd_udp_auth_deactivate,
1977 'sw_if_index': sw_if_index,
1978 'local_addr': local_addr,
1979 'peer_addr': peer_addr,
1981 'is_delayed': 1 if is_delayed else 0,
1984 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1985 return self.api(self.papi.bfd_udp_del,
1987 'sw_if_index': sw_if_index,
1988 'local_addr': local_addr,
1989 'peer_addr': peer_addr,
1993 def bfd_udp_session_dump(self):
1994 return self.api(self.papi.bfd_udp_session_dump, {})
1996 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1997 peer_addr, is_ipv6=0):
1998 return self.api(self.papi.bfd_udp_session_set_flags, {
1999 'admin_up_down': admin_up_down,
2000 'sw_if_index': sw_if_index,
2001 'local_addr': local_addr,
2002 'peer_addr': peer_addr,
2006 def want_bfd_events(self, enable_disable=1):
2007 return self.api(self.papi.want_bfd_events, {
2008 'enable_disable': enable_disable,
2012 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2013 return self.api(self.papi.bfd_auth_set_key, {
2014 'conf_key_id': conf_key_id,
2015 'auth_type': auth_type,
2017 'key_len': len(key),
2020 def bfd_auth_del_key(self, conf_key_id):
2021 return self.api(self.papi.bfd_auth_del_key, {
2022 'conf_key_id': conf_key_id,
2025 def bfd_auth_keys_dump(self):
2026 return self.api(self.papi.bfd_auth_keys_dump, {})
2028 def bfd_udp_set_echo_source(self, sw_if_index):
2029 return self.api(self.papi.bfd_udp_set_echo_source,
2030 {'sw_if_index': sw_if_index})
2032 def bfd_udp_del_echo_source(self):
2033 return self.api(self.papi.bfd_udp_del_echo_source, {})
2035 def classify_add_del_table(
2040 table_index=0xFFFFFFFF,
2042 memory_size=2097152,
2044 next_table_index=0xFFFFFFFF,
2045 miss_next_index=0xFFFFFFFF,
2046 current_data_flag=0,
2047 current_data_offset=0):
2051 :param match_n_vectors: (Default value = 1)
2052 :param table_index: (Default value = 0xFFFFFFFF)
2053 :param nbuckets: (Default value = 2)
2054 :param memory_size: (Default value = 2097152)
2055 :param skip_n_vectors: (Default value = 0)
2056 :param next_table_index: (Default value = 0xFFFFFFFF)
2057 :param miss_next_index: (Default value = 0xFFFFFFFF)
2058 :param current_data_flag: (Default value = 0)
2059 :param current_data_offset: (Default value = 0)
2063 self.papi.classify_add_del_table,
2065 'table_index': table_index,
2066 'nbuckets': nbuckets,
2067 'memory_size': memory_size,
2068 'skip_n_vectors': skip_n_vectors,
2069 'match_n_vectors': match_n_vectors,
2070 'next_table_index': next_table_index,
2071 'miss_next_index': miss_next_index,
2072 'current_data_flag': current_data_flag,
2073 'current_data_offset': current_data_offset,
2076 def classify_add_del_session(
2081 opaque_index=0xFFFFFFFF,
2082 hit_next_index=0xFFFFFFFF,
2090 :param opaque_index: (Default value = 0xFFFFFFFF)
2091 :param hit_next_index: (Default value = 0xFFFFFFFF)
2092 :param advance: (Default value = 0)
2093 :param action: (Default value = 0)
2094 :param metadata: (Default value = 0)
2098 self.papi.classify_add_del_session,
2100 'table_index': table_index,
2101 'hit_next_index': hit_next_index,
2102 'opaque_index': opaque_index,
2105 'metadata': metadata,
2108 def input_acl_set_interface(
2112 ip4_table_index=0xFFFFFFFF,
2113 ip6_table_index=0xFFFFFFFF,
2114 l2_table_index=0xFFFFFFFF):
2118 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2119 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2120 :param l2_table_index: (Default value = 0xFFFFFFFF)
2124 self.papi.input_acl_set_interface,
2125 {'sw_if_index': sw_if_index,
2126 'ip4_table_index': ip4_table_index,
2127 'ip6_table_index': ip6_table_index,
2128 'l2_table_index': l2_table_index,
2131 def output_acl_set_interface(
2135 ip4_table_index=0xFFFFFFFF,
2136 ip6_table_index=0xFFFFFFFF,
2137 l2_table_index=0xFFFFFFFF):
2141 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2142 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2143 :param l2_table_index: (Default value = 0xFFFFFFFF)
2147 self.papi.output_acl_set_interface,
2148 {'sw_if_index': sw_if_index,
2149 'ip4_table_index': ip4_table_index,
2150 'ip6_table_index': ip6_table_index,
2151 'l2_table_index': l2_table_index,
2154 def set_ipfix_exporter(
2161 collector_port=4739,
2164 self.papi.set_ipfix_exporter,
2166 'collector_address': collector_address,
2167 'collector_port': collector_port,
2168 'src_address': src_address,
2170 'path_mtu': path_mtu,
2171 'template_interval': template_interval,
2172 'udp_checksum': udp_checksum,
2175 def dhcp_proxy_config(self,
2183 self.papi.dhcp_proxy_config,
2185 'rx_vrf_id': rx_table_id,
2186 'server_vrf_id': server_table_id,
2189 'dhcp_server': dhcp_server,
2190 'dhcp_src_address': dhcp_src_address,
2193 def dhcp_proxy_set_vss(self,
2202 self.papi.dhcp_proxy_set_vss,
2205 'vss_type': vss_type,
2206 'vpn_ascii_id': vpn_ascii_id,
2208 'vpn_index': vpn_index,
2213 def dhcp_client(self,
2218 set_broadcast_flag=1,
2219 want_dhcp_events=0):
2221 self.papi.dhcp_client_config,
2223 'sw_if_index': sw_if_index,
2224 'hostname': hostname,
2225 'client_id': client_id,
2227 'want_dhcp_event': want_dhcp_events,
2228 'set_broadcast_flag': set_broadcast_flag,
2232 def ip_mroute_add_del(self,
2238 next_hop_sw_if_index,
2247 IP Multicast Route add/del
2250 self.papi.ip_mroute_add_del,
2251 {'next_hop_sw_if_index': next_hop_sw_if_index,
2252 'entry_flags': e_flags,
2253 'itf_flags': i_flags,
2254 'table_id': table_id,
2258 'is_local': is_local,
2259 'bier_imp': bier_imp,
2260 'next_hop_afi': next_hop_afi,
2261 'grp_address_length': grp_address_length,
2262 'grp_address': grp_address,
2263 'src_address': src_address})
2265 def mfib_signal_dump(self):
2266 return self.api(self.papi.mfib_signal_dump, {})
2268 def ip_mfib_dump(self):
2269 return self.api(self.papi.ip_mfib_dump, {})
2271 def ip6_mfib_dump(self):
2272 return self.api(self.papi.ip6_mfib_dump, {})
2274 def lisp_enable_disable(self, is_enabled):
2276 self.papi.lisp_enable_disable,
2278 'is_en': is_enabled,
2281 def lisp_locator_set(self,
2285 self.papi.lisp_add_del_locator_set,
2288 'locator_set_name': ls_name
2291 def lisp_locator_set_dump(self):
2292 return self.api(self.papi.lisp_locator_set_dump, {})
2294 def lisp_locator(self,
2301 self.papi.lisp_add_del_locator,
2304 'locator_set_name': ls_name,
2305 'sw_if_index': sw_if_index,
2306 'priority': priority,
2310 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2312 self.papi.lisp_locator_dump,
2314 'is_index_set': is_index_set,
2316 'ls_index': ls_index,
2319 def lisp_local_mapping(self,
2329 self.papi.lisp_add_del_local_eid,
2331 'locator_set_name': ls_name,
2333 'eid_type': eid_type,
2335 'prefix_len': prefix_len,
2341 def lisp_eid_table_dump(self,
2349 self.papi.lisp_eid_table_dump,
2352 'prefix_length': prefix_length,
2354 'eid_type': eid_type,
2356 'filter': filter_opt,
2359 def lisp_remote_mapping(self,
2369 self.papi.lisp_add_del_remote_mapping,
2372 'eid_type': eid_type,
2374 'eid_len': eid_prefix_len,
2375 'rloc_num': rlocs_num,
2378 'is_src_dst': is_src_dst,
2381 def lisp_adjacency(self,
2390 self.papi.lisp_add_del_adjacency,
2394 'eid_type': eid_type,
2397 'leid_len': leid_len,
2398 'reid_len': reid_len,
2401 def lisp_adjacencies_get(self, vni=0):
2403 self.papi.lisp_adjacencies_get,
2408 def map_add_domain(self,
2422 self.papi.map_add_domain,
2424 'ip6_prefix': ip6_prefix,
2425 'ip6_prefix_len': ip6_prefix_len,
2426 'ip4_prefix': ip4_prefix,
2427 'ip4_prefix_len': ip4_prefix_len,
2429 'ip6_src_prefix_len': ip6_src_prefix_len,
2430 'ea_bits_len': ea_bits_len,
2431 'psid_offset': psid_offset,
2432 'psid_length': psid_length,
2433 'is_translation': is_translation,
2434 'is_rfc6052': is_rfc6052,
2438 def gtpu_add_del_tunnel(
2444 mcast_sw_if_index=0xFFFFFFFF,
2446 decap_next_index=0xFFFFFFFF,
2450 :param is_add: (Default value = 1)
2451 :param is_ipv6: (Default value = 0)
2454 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2455 :param encap_vrf_id: (Default value = 0)
2456 :param decap_next_index: (Default value = 0xFFFFFFFF)
2457 :param teid: (Default value = 0)
2460 return self.api(self.papi.gtpu_add_del_tunnel,
2463 'src_address': src_addr,
2464 'dst_address': dst_addr,
2465 'mcast_sw_if_index': mcast_sw_if_index,
2466 'encap_vrf_id': encap_vrf_id,
2467 'decap_next_index': decap_next_index,
2470 def vxlan_gpe_add_del_tunnel(
2474 mcast_sw_if_index=0xFFFFFFFF,
2485 :param is_add: (Default value = 1)
2486 :param is_ipv6: (Default value = 0)
2487 :param encap_vrf_id: (Default value = 0)
2488 :param decap_vrf_id: (Default value = 0)
2489 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2490 :param protocol: (Default value = 3)
2491 :param vni: (Default value = 0)
2494 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2499 'mcast_sw_if_index': mcast_sw_if_index,
2500 'encap_vrf_id': encap_vrf_id,
2501 'decap_vrf_id': decap_vrf_id,
2502 'protocol': protocol,
2505 def pppoe_add_del_session(
2515 :param is_add: (Default value = 1)
2516 :param is_ipv6: (Default value = 0)
2518 :param session_id: (Default value = 0)
2520 :param decap_vrf_id: (Default value = 0)
2523 return self.api(self.papi.pppoe_add_del_session,
2526 'session_id': session_id,
2527 'client_ip': client_ip,
2528 'decap_vrf_id': decap_vrf_id,
2529 'client_mac': client_mac})
2531 def sr_localsid_add_del(self,
2537 sw_if_index=0xFFFFFFFF,
2541 """ Add/del IPv6 SR local-SID.
2543 :param localsid_addr:
2544 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2545 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2547 :param is_del: (Default value = 0)
2548 :param end_psp: (Default value = 0)
2549 :param sw_if_index: (Default value = 0xFFFFFFFF)
2550 :param vlan_index: (Default value = 0)
2551 :param fib_table: (Default value = 0)
2554 self.papi.sr_localsid_add_del,
2556 'localsid_addr': localsid_addr,
2558 'behavior': behavior,
2559 'sw_if_index': sw_if_index,
2560 'vlan_index': vlan_index,
2561 'fib_table': fib_table,
2576 :param bsid_addr: bindingSID of the SR Policy
2577 :param weight: weight of the sid list. optional. (default: 1)
2578 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2580 :param type: type/behavior of the SR policy. (default or spray) \
2582 :param fib_table: VRF where to install the FIB entry for the BSID \
2584 :param n_segments: number of segments \
2586 :param segments: a vector of IPv6 address composing the segment list \
2590 self.papi.sr_policy_add,
2591 {'bsid_addr': bsid_addr,
2593 'is_encap': is_encap,
2595 'fib_table': fib_table,
2596 'n_segments': n_segments,
2597 'segments': segments
2606 :param bsid: bindingSID of the SR Policy
2607 :param sr_policy_index: index of the sr policy (default: 0)
2610 self.papi.sr_policy_del,
2611 {'bsid_addr': bsid_addr,
2612 'sr_policy_index': sr_policy_index
2615 def sr_steering_add_del(
2626 Steer traffic L2 and L3 traffic through a given SR policy
2628 :param is_del: delete or add
2629 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2630 :param sr_policy: is the index of the SR Policy (alt to bsid)
2631 :param table_id: is the VRF where to install the FIB entry for the BSID
2632 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2633 :param mask_width: is the mask for L3 traffic type
2634 :param sw_if_index: is the incoming interface for L2 traffic
2635 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2638 self.papi.sr_steering_add_del,
2640 'bsid_addr': bsid_addr,
2641 'sr_policy_index': sr_policy_index,
2642 'table_id': table_id,
2643 'prefix_addr': prefix_addr,
2644 'mask_width': mask_width,
2645 'sw_if_index': sw_if_index,
2646 'traffic_type': traffic_type
2649 def acl_add_replace(self, acl_index, r, tag='',
2651 """Add/replace an ACL
2652 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2653 :param acl_rule r: ACL rules array.
2654 :param str tag: symbolic tag (description) for this ACL.
2655 :param int count: number of rules.
2657 return self.api(self.papi.acl_add_replace,
2658 {'acl_index': acl_index,
2662 expected_retval=expected_retval)
2664 def acl_del(self, acl_index, expected_retval=0):
2670 return self.api(self.papi.acl_del,
2671 {'acl_index': acl_index},
2672 expected_retval=expected_retval)
2674 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2676 return self.api(self.papi.acl_interface_set_acl_list,
2677 {'sw_if_index': sw_if_index,
2681 expected_retval=expected_retval)
2683 def acl_interface_add_del(self,
2687 """ Add/Delete ACL to/from interface
2691 :param is_add: (Default value = 1)
2694 return self.api(self.papi.acl_interface_add_del,
2697 'sw_if_index': sw_if_index,
2698 'acl_index': acl_index})
2700 def acl_dump(self, acl_index, expected_retval=0):
2701 return self.api(self.papi.acl_dump,
2702 {'acl_index': acl_index},
2703 expected_retval=expected_retval)
2705 def macip_acl_add(self, rules, tag=""):
2708 :param rules: list of rules for given acl
2712 return self.api(self.papi.macip_acl_add,
2714 'count': len(rules),
2717 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2720 :param rules: list of rules for given acl
2724 return self.api(self.papi.macip_acl_add_replace,
2725 {'acl_index': acl_index,
2727 'count': len(rules),
2730 def macip_acl_del(self, acl_index):
2736 return self.api(self.papi.macip_acl_del,
2737 {'acl_index': acl_index})
2739 def macip_acl_interface_add_del(self,
2743 """ Add MACIP acl to interface
2747 :param is_add: (Default value = 1)
2750 return self.api(self.papi.macip_acl_interface_add_del,
2752 'sw_if_index': sw_if_index,
2753 'acl_index': acl_index})
2755 def macip_acl_interface_get(self):
2756 """ Return interface acls dump
2759 self.papi.macip_acl_interface_get, {})
2761 def macip_acl_dump(self, acl_index=4294967295):
2762 """ Return MACIP acl dump
2766 self.papi.macip_acl_dump, {'acl_index': acl_index})
2768 def policer_add_del(self,
2779 conform_action_type=1,
2781 exceed_action_type=0,
2783 violate_action_type=0,
2785 return self.api(self.papi.policer_add_del,
2792 'rate_type': rate_type,
2793 'round_type': round_type,
2795 'color_aware': color_aware,
2796 'conform_action_type': conform_action_type,
2797 'conform_dscp': conform_dscp,
2798 'exceed_action_type': exceed_action_type,
2799 'exceed_dscp': exceed_dscp,
2800 'violate_action_type': violate_action_type,
2801 'violate_dscp': violate_dscp})
2803 def ip_punt_police(self,
2807 return self.api(self.papi.ip_punt_police,
2808 {'policer_index': policer_index,
2812 def ip_punt_redirect(self,
2818 return self.api(self.papi.ip_punt_redirect,
2819 {'rx_sw_if_index': rx_sw_if_index,
2820 'tx_sw_if_index': tx_sw_if_index,
2825 def bier_table_add_del(self,
2829 """ BIER Table add/del """
2831 self.papi.bier_table_add_del,
2832 {'bt_tbl_id': {"bt_set": bti.set_id,
2833 "bt_sub_domain": bti.sub_domain_id,
2834 "bt_hdr_len_id": bti.hdr_len_id},
2835 'bt_label': mpls_label,
2836 'bt_is_add': is_add})
2838 def bier_table_dump(self):
2839 return self.api(self.papi.bier_table_dump, {})
2841 def bier_route_add_del(self,
2846 """ BIER Route add/del """
2849 br_paths.append({'next_hop': p.nh_addr,
2853 'table_id': p.nh_table_id,
2854 'next_hop_id': p.next_hop_id,
2855 'is_udp_encap': p.is_udp_encap,
2856 'n_labels': len(p.nh_labels),
2857 'label_stack': p.nh_labels})
2859 self.papi.bier_route_add_del,
2860 {'br_tbl_id': {"bt_set": bti.set_id,
2861 "bt_sub_domain": bti.sub_domain_id,
2862 "bt_hdr_len_id": bti.hdr_len_id},
2864 'br_n_paths': len(br_paths),
2865 'br_paths': br_paths,
2866 'br_is_add': is_add})
2868 def bier_route_dump(self, bti):
2870 self.papi.bier_route_dump,
2871 {'br_tbl_id': {"bt_set": bti.set_id,
2872 "bt_sub_domain": bti.sub_domain_id,
2873 "bt_hdr_len_id": bti.hdr_len_id}})
2875 def bier_imp_add(self,
2880 """ BIER Imposition Add """
2882 self.papi.bier_imp_add,
2883 {'bi_tbl_id': {"bt_set": bti.set_id,
2884 "bt_sub_domain": bti.sub_domain_id,
2885 "bt_hdr_len_id": bti.hdr_len_id},
2887 'bi_n_bytes': len(ibytes),
2888 'bi_bytes': ibytes})
2890 def bier_imp_del(self, bi_index):
2891 """ BIER Imposition del """
2893 self.papi.bier_imp_del,
2894 {'bi_index': bi_index})
2896 def bier_imp_dump(self):
2897 return self.api(self.papi.bier_imp_dump, {})
2899 def bier_disp_table_add_del(self,
2902 """ BIER Disposition Table add/del """
2904 self.papi.bier_disp_table_add_del,
2905 {'bdt_tbl_id': bdti,
2906 'bdt_is_add': is_add})
2908 def bier_disp_table_dump(self):
2909 return self.api(self.papi.bier_disp_table_dump, {})
2911 def bier_disp_entry_add_del(self,
2921 """ BIER Route add/del """
2923 self.papi.bier_disp_entry_add_del,
2924 {'bde_tbl_id': bdti,
2926 'bde_payload_proto': payload_proto,
2928 'bde_paths': [{'next_hop': next_hop,
2929 'table_id': next_hop_tbl_id,
2930 'afi': next_hop_afi,
2931 'rpf_id': next_hop_rpf_id,
2933 'label_stack': [0]}],
2934 'bde_is_add': is_add})
2936 def bier_disp_entry_dump(self, bdti):
2938 self.papi.bier_disp_entry_dump,
2939 {'bde_tbl_id': bdti})
2941 def add_node_next(self, node_name, next_name):
2942 """ Set the next node for a given node request
2947 return self.api(self.papi.add_node_next,
2948 {'node_name': node_name,
2949 'next_name': next_name})
2951 def session_enable_disable(self, is_enabled):
2953 self.papi.session_enable_disable,
2954 {'is_enable': is_enabled})
2956 def ipsec_spd_add_del(self, spd_id, is_add=1):
2957 """ SPD add/del - Wrapper to add or del ipsec SPD
2958 Sample CLI : 'ipsec spd add 1'
2960 :param spd_id - SPD ID to be created in the vpp . mandatory
2961 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2963 :returns: reply from the API
2966 self.papi.ipsec_spd_add_del, {
2967 'spd_id': spd_id, 'is_add': is_add})
2969 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2970 """ IPSEC interface SPD add/del - \
2971 Wrapper to associate/disassociate SPD to interface in VPP
2972 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2974 :param spd_id - SPD ID to associate with the interface . mandatory
2975 :param sw_if_index - Interface Index which needs to ipsec \
2976 association mandatory
2977 :param is_add - add(1) or del(0) association with interface \
2978 (Default 1 - add) . optional
2979 :returns: reply from the API
2982 self.papi.ipsec_interface_add_del_spd, {
2984 'sw_if_index': sw_if_index, 'is_add': is_add})
2986 def ipsec_sad_add_del_entry(self,
2989 tunnel_src_address='',
2990 tunnel_dst_address='',
2992 integrity_algorithm=2,
2993 integrity_key_length=0,
2994 integrity_key='C91KUR9GYMm5GfkEvNjX',
2996 crypto_key_length=0,
2997 crypto_key='JPjyOWBeVEQiMe7h',
3000 """ IPSEC SA add/del
3001 Sample CLI : 'ipsec sa add 10 spi 1001 esp \
3002 crypto-key 4a506a794f574265564551694d653768 \
3003 crypto-alg aes-cbc-128 \
3004 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3005 integ-alg sha1-96 tunnel-src 192.168.100.3 \
3006 tunnel-dst 192.168.100.2'
3007 Sample CLI : 'ipsec sa add 20 spi 2001 \
3008 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3011 :param sad_id - Security Association ID to be \
3012 created or deleted. mandatory
3013 :param spi - security param index of the SA in decimal. mandatory
3014 :param tunnel_src_address - incase of tunnel mode outer src address .\
3015 mandatory for tunnel mode
3016 :param tunnel_dst_address - incase of transport mode \
3017 outer dst address. mandatory for tunnel mode
3018 :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional
3019 :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\
3021 :param integrity_key - value in string \
3022 (Default C91KUR9GYMm5GfkEvNjX).optional
3023 :param integrity_key_length - length of the key string in bytes\
3024 (Default 0 - integrity disabled). optional
3025 :param crypto_algorithm - value range 1-11 Default \
3026 (1- AES_CBC_128).optional **
3027 :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional
3028 :param crypto_key_length - length of the key string in bytes\
3029 (Default 0 - crypto disabled). optional
3030 :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\
3032 :param is_tunnel - tunnel mode (1) or transport mode(0) \
3033 (Default 1 - tunnel). optional
3034 :returns: reply from the API
3035 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3036 crypto and ipsec algorithms
3039 self.papi.ipsec_sad_add_del_entry,
3042 'tunnel_src_address': tunnel_src_address,
3043 'tunnel_dst_address': tunnel_dst_address,
3044 'protocol': protocol,
3045 'integrity_algorithm': integrity_algorithm,
3046 'integrity_key_length': integrity_key_length,
3047 'integrity_key': integrity_key,
3048 'crypto_algorithm': crypto_algorithm,
3049 'crypto_key_length': crypto_key_length,
3050 'crypto_key': crypto_key,
3052 'is_tunnel': is_tunnel})
3054 def ipsec_spd_add_del_entry(self,
3056 local_address_start,
3058 remote_address_start,
3059 remote_address_stop,
3061 local_port_stop=65535,
3062 remote_port_start=0,
3063 remote_port_stop=65535,
3071 """ IPSEC policy SPD add/del -
3072 Wrapper to configure ipsec SPD policy entries in VPP
3073 Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \
3074 protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \
3075 remote-ip-range 192.168.3.3 - 192.168.3.3'
3077 :param spd_id - SPD ID for the policy . mandatory
3078 :param local_address_start - local-ip-range start address . mandatory
3079 :param local_address_stop - local-ip-range stop address . mandatory
3080 :param remote_address_start - remote-ip-range start address . mandatory
3081 :param remote_address_stop - remote-ip-range stop address . mandatory
3082 :param local_port_start - (Default 0) . optional
3083 :param local_port_stop - (Default 65535). optional
3084 :param remote_port_start - (Default 0). optional
3085 :param remote_port_stop - (Default 65535). optional
3086 :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any).
3088 :param sa_id - Security Association ID for mapping it to SPD
3089 (default 10). optional
3090 :param policy - bypass(0), discard(1), resolve(2) or protect(3)action
3091 (Default 0 - bypass). optional
3092 :param priotity - value for the spd action (Default 100). optional
3093 :param is_outbound - flag for inbound(0) or outbound(1)
3094 (Default 1 - outbound). optional
3095 :param is_add flag - for addition(1) or deletion(0) of the spd
3096 (Default 1 - addtion). optional
3097 :returns: reply from the API
3100 self.papi.ipsec_spd_add_del_entry,
3102 'local_address_start': local_address_start,
3103 'local_address_stop': local_address_stop,
3104 'remote_address_start': remote_address_start,
3105 'remote_address_stop': remote_address_stop,
3106 'local_port_start': local_port_start,
3107 'local_port_stop': local_port_stop,
3108 'remote_port_start': remote_port_start,
3109 'remote_port_stop': remote_port_stop,
3111 'protocol': protocol,
3113 'priority': priority,
3114 'is_outbound': is_outbound,
3116 'is_ip_any': is_ip_any})
3118 def app_namespace_add(self,
3122 sw_if_index=0xFFFFFFFF,
3125 self.papi.app_namespace_add_del,
3127 'sw_if_index': sw_if_index,
3128 'ip4_fib_id': ip4_fib_id,
3129 'ip6_fib_id': ip6_fib_id,
3130 'namespace_id': namespace_id,
3131 'namespace_id_len': len(namespace_id)})
3133 def punt_socket_register(self, l4_port, pathname, header_version=1,
3134 is_ip4=1, l4_protocol=0x11):
3135 """ Punt to socket """
3136 return self.api(self.papi.punt_socket_register,
3138 'l4_protocol': l4_protocol,
3140 'pathname': pathname,
3141 'header_version': header_version})
3143 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3144 expire_walk_interval_ms, is_ip6=0):
3145 """ Set IP reassembly parameters """
3146 return self.api(self.papi.ip_reassembly_set,
3148 'timeout_ms': timeout_ms,
3149 'expire_walk_interval_ms': expire_walk_interval_ms,
3150 'max_reassemblies': max_reassemblies})
3152 def ip_reassembly_get(self, is_ip6=0):
3153 """ Get IP reassembly parameters """
3154 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})