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 sw_interface_set_mtu(self, sw_if_index, mtu):
638 return self.api(self.papi.sw_interface_set_mtu,
639 {'sw_if_index': sw_if_index,
642 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
643 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
644 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
645 """Create subinterface
646 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
648 :param sub_id: param inner_vlan:
652 :param no_tags: (Default value = 0)
653 :param one_tag: (Default value = 0)
654 :param two_tags: (Default value = 0)
655 :param dot1ad: (Default value = 0)
656 :param exact_match: (Default value = 0)
657 :param default_sub: (Default value = 0)
658 :param outer_vlan_id_any: (Default value = 0)
659 :param inner_vlan_id_any: (Default value = 0)
663 self.papi.create_subif,
664 {'sw_if_index': sw_if_index,
668 'two_tags': two_tags,
670 'exact_match': exact_match,
671 'default_sub': default_sub,
672 'outer_vlan_id_any': outer_vlan_id_any,
673 'inner_vlan_id_any': inner_vlan_id_any,
674 'outer_vlan_id': outer_vlan,
675 'inner_vlan_id': inner_vlan})
677 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
678 """Create p2p ethernet subinterface
680 :param sw_if_index: main (parent) interface
681 :param remote_mac: client (remote) mac address
685 self.papi.p2p_ethernet_add,
686 {'parent_if_index': sw_if_index,
687 'remote_mac': remote_mac,
688 'subif_id': subif_id})
690 def delete_subif(self, sw_if_index):
691 """Delete subinterface
695 return self.api(self.papi.delete_subif,
696 {'sw_if_index': sw_if_index})
698 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
699 """Delete p2p ethernet subinterface
701 :param sw_if_index: main (parent) interface
702 :param remote_mac: client (remote) mac address
706 self.papi.p2p_ethernet_del,
707 {'parent_if_index': sw_if_index,
708 'remote_mac': remote_mac})
710 def create_vlan_subif(self, sw_if_index, vlan):
717 return self.api(self.papi.create_vlan_subif,
718 {'sw_if_index': sw_if_index,
721 def create_loopback(self, mac=''):
724 :param mac: (Optional)
726 return self.api(self.papi.create_loopback,
727 {'mac_address': mac})
729 def delete_loopback(self, sw_if_index):
730 return self.api(self.papi.delete_loopback,
731 {'sw_if_index': sw_if_index, })
733 def ip_table_add_del(self,
740 :param is_add: (Default value = 1)
741 :param is_ipv6: (Default value = 0)
746 self.papi.ip_table_add_del,
747 {'table_id': table_id,
751 def ip_add_del_route(
756 next_hop_sw_if_index=0xFFFFFFFF,
760 next_hop_n_out_labels=0,
761 next_hop_out_label_stack=[],
762 next_hop_via_label=MPLS_LABEL_INVALID,
763 next_hop_id=0xFFFFFFFF,
765 is_resolve_attached=0,
766 classify_table_index=0xFFFFFFFF,
780 :param dst_address_length:
781 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
783 :param next_hop_address:
784 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
785 :param vrf_id: (Default value = 0)
786 :param lookup_in_vrf: (Default value = 0)
787 :param classify_table_index: (Default value = 0xFFFFFFFF)
788 :param is_add: (Default value = 1)
789 :param is_drop: (Default value = 0)
790 :param is_ipv6: (Default value = 0)
791 :param is_local: (Default value = 0)
792 :param is_classify: (Default value = 0)
793 :param is_multipath: (Default value = 0)
794 :param is_resolve_host: (Default value = 0)
795 :param is_resolve_attached: (Default value = 0)
796 :param is_dvr: (Default value = 0)
797 :param is_source_lookup: (Default value = 0)
798 :param next_hop_weight: (Default value = 1)
803 self.papi.ip_add_del_route,
804 {'next_hop_sw_if_index': next_hop_sw_if_index,
805 'table_id': table_id,
806 'classify_table_index': classify_table_index,
807 'next_hop_table_id': next_hop_table_id,
810 'is_unreach': is_unreach,
811 'is_prohibit': is_prohibit,
813 'is_local': is_local,
814 'is_classify': is_classify,
815 'is_multipath': is_multipath,
816 'is_resolve_host': is_resolve_host,
817 'is_resolve_attached': is_resolve_attached,
819 'is_source_lookup': is_source_lookup,
820 'is_udp_encap': is_udp_encap,
821 'next_hop_weight': next_hop_weight,
822 'dst_address_length': dst_address_length,
823 'dst_address': dst_address,
824 'next_hop_id': next_hop_id,
825 'next_hop_address': next_hop_address,
826 'next_hop_n_out_labels': next_hop_n_out_labels,
827 'next_hop_via_label': next_hop_via_label,
828 'next_hop_out_label_stack': next_hop_out_label_stack})
830 def ip_fib_dump(self):
831 return self.api(self.papi.ip_fib_dump, {})
833 def ip6_fib_dump(self):
834 return self.api(self.papi.ip6_fib_dump, {})
836 def ip_neighbor_add_del(self,
845 """ Add neighbor MAC to IPv4 or IPv6 address.
850 :param is_add: (Default value = 1)
851 :param is_ipv6: (Default value = 0)
852 :param is_static: (Default value = 0)
853 :param is_no_adj_fib: (Default value = 0)
857 self.papi.ip_neighbor_add_del,
858 {'sw_if_index': sw_if_index,
861 'is_static': is_static,
862 'is_no_adj_fib': is_no_adj_fib,
863 'mac_address': mac_address,
864 'dst_address': dst_address
868 def ip_neighbor_dump(self,
871 """ Return IP neighbor dump.
874 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
878 self.papi.ip_neighbor_dump,
880 'sw_if_index': sw_if_index
884 def proxy_arp_add_del(self,
889 """ Config Proxy Arp Range.
891 :param low_address: Start address in the rnage to Proxy for
892 :param hi_address: End address in the rnage to Proxy for
893 :param vrf_id: The VRF/table in which to proxy
897 self.papi.proxy_arp_add_del,
900 'low_address': low_address,
901 'hi_address': hi_address,
905 def proxy_arp_intfc_enable_disable(self,
908 """ Enable/Disable an interface for proxy ARP requests
910 :param sw_if_index: Interface
911 :param enable_disable: Enable/Disable
915 self.papi.proxy_arp_intfc_enable_disable,
916 {'sw_if_index': sw_if_index,
917 'enable_disable': is_enable
925 """ Reset VRF (remove all routes etc.) request.
927 :param int vrf_id: ID of the FIB table / VRF to reset.
928 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
942 """ Reset VRF (remove all routes etc.) request.
944 :param int vrf_id: ID of the FIB table / VRF to reset.
945 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
960 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
969 def sw_interface_span_enable_disable(
970 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
973 :param sw_if_index_from:
974 :param sw_if_index_to:
978 return self.api(self.papi.sw_interface_span_enable_disable,
979 {'sw_if_index_from': sw_if_index_from,
980 'sw_if_index_to': sw_if_index_to,
985 def gre_tunnel_add_del(self,
996 :param outer_fib_id: (Default value = 0)
997 :param is_add: (Default value = 1)
998 :param is_ipv6: (Default value = 0)
999 :param is_teb: (Default value = 0)
1003 self.papi.gre_add_del_tunnel,
1007 'src_address': src_address,
1008 'dst_address': dst_address,
1009 'outer_fib_id': outer_fib_id}
1012 def udp_encap_add_del(self,
1021 """ Add a GRE tunnel
1022 :param id: user provided ID
1027 :param outer_fib_id: (Default value = 0)
1028 :param is_add: (Default value = 1)
1029 :param is_ipv6: (Default value = 0)
1033 self.papi.udp_encap_add_del,
1039 'src_port': src_port,
1040 'dst_port': dst_port,
1041 'table_id': table_id}
1044 def udp_encap_dump(self):
1045 return self.api(self.papi.udp_encap_dump, {})
1047 def mpls_fib_dump(self):
1048 return self.api(self.papi.mpls_fib_dump, {})
1050 def mpls_table_add_del(
1057 :param is_add: (Default value = 1)
1062 self.papi.mpls_table_add_del,
1063 {'mt_table_id': table_id,
1064 'mt_is_add': is_add})
1066 def mpls_route_add_del(
1072 next_hop_sw_if_index=0xFFFFFFFF,
1074 next_hop_table_id=0,
1076 next_hop_n_out_labels=0,
1077 next_hop_out_label_stack=[],
1078 next_hop_via_label=MPLS_LABEL_INVALID,
1080 is_resolve_attached=0,
1087 classify_table_index=0xFFFFFFFF,
1091 :param dst_address_length:
1092 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1094 :param next_hop_address:
1095 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1096 :param vrf_id: (Default value = 0)
1097 :param lookup_in_vrf: (Default value = 0)
1098 :param classify_table_index: (Default value = 0xFFFFFFFF)
1099 :param is_add: (Default value = 1)
1100 :param is_drop: (Default value = 0)
1101 :param is_ipv6: (Default value = 0)
1102 :param is_local: (Default value = 0)
1103 :param is_classify: (Default value = 0)
1104 :param is_multipath: (Default value = 0)
1105 :param is_multicast: (Default value = 0)
1106 :param is_resolve_host: (Default value = 0)
1107 :param is_resolve_attached: (Default value = 0)
1108 :param next_hop_weight: (Default value = 1)
1113 self.papi.mpls_route_add_del,
1116 'mr_table_id': table_id,
1117 'mr_classify_table_index': classify_table_index,
1118 'mr_is_add': is_add,
1119 'mr_is_classify': is_classify,
1120 'mr_is_multipath': is_multipath,
1121 'mr_is_multicast': is_multicast,
1122 'mr_is_resolve_host': is_resolve_host,
1123 'mr_is_resolve_attached': is_resolve_attached,
1124 'mr_is_interface_rx': is_interface_rx,
1125 'mr_is_rpf_id': is_rpf_id,
1126 'mr_next_hop_proto': next_hop_proto,
1127 'mr_next_hop_weight': next_hop_weight,
1128 'mr_next_hop': next_hop_address,
1129 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1130 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1131 'mr_next_hop_table_id': next_hop_table_id,
1132 'mr_next_hop_via_label': next_hop_via_label,
1133 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1135 def mpls_ip_bind_unbind(
1147 self.papi.mpls_ip_bind_unbind,
1148 {'mb_mpls_table_id': table_id,
1150 'mb_ip_table_id': ip_table_id,
1151 'mb_is_bind': is_bind,
1152 'mb_is_ip4': is_ip4,
1153 'mb_address_length': dst_address_length,
1154 'mb_address': dst_address})
1156 def mpls_tunnel_add_del(
1159 next_hop_proto_is_ip4,
1161 next_hop_sw_if_index=0xFFFFFFFF,
1162 next_hop_table_id=0,
1164 next_hop_n_out_labels=0,
1165 next_hop_out_label_stack=[],
1166 next_hop_via_label=MPLS_LABEL_INVALID,
1172 :param dst_address_length:
1173 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1175 :param next_hop_address:
1176 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1177 :param vrf_id: (Default value = 0)
1178 :param lookup_in_vrf: (Default value = 0)
1179 :param classify_table_index: (Default value = 0xFFFFFFFF)
1180 :param is_add: (Default value = 1)
1181 :param is_drop: (Default value = 0)
1182 :param is_ipv6: (Default value = 0)
1183 :param is_local: (Default value = 0)
1184 :param is_classify: (Default value = 0)
1185 :param is_multipath: (Default value = 0)
1186 :param is_resolve_host: (Default value = 0)
1187 :param is_resolve_attached: (Default value = 0)
1188 :param next_hop_weight: (Default value = 1)
1189 :param is_multicast: (Default value = 0)
1193 self.papi.mpls_tunnel_add_del,
1194 {'mt_sw_if_index': tun_sw_if_index,
1195 'mt_is_add': is_add,
1196 'mt_l2_only': l2_only,
1197 'mt_is_multicast': is_multicast,
1198 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1199 'mt_next_hop_weight': next_hop_weight,
1200 'mt_next_hop': next_hop_address,
1201 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1202 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1203 'mt_next_hop_table_id': next_hop_table_id,
1204 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1206 def nat44_interface_add_del_feature(
1211 """Enable/disable NAT44 feature on the interface
1213 :param sw_if_index: Software index of the interface
1214 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1215 :param is_add: 1 if add, 0 if delete (Default value = 1)
1218 self.papi.nat44_interface_add_del_feature,
1220 'is_inside': is_inside,
1221 'sw_if_index': sw_if_index})
1223 def nat44_interface_add_del_output_feature(
1228 """Enable/disable NAT44 output feature on the interface
1230 :param sw_if_index: Software index of the interface
1231 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1232 :param is_add: 1 if add, 0 if delete (Default value = 1)
1235 self.papi.nat44_interface_add_del_output_feature,
1237 'is_inside': is_inside,
1238 'sw_if_index': sw_if_index})
1240 def nat44_add_del_static_mapping(
1244 external_sw_if_index=0xFFFFFFFF,
1254 """Add/delete NAT44 static mapping
1256 :param local_ip: Local IP address
1257 :param external_ip: External IP address
1258 :param external_sw_if_index: External interface instead of IP address
1259 :param local_port: Local port number (Default value = 0)
1260 :param external_port: External port number (Default value = 0)
1261 :param addr_only: 1 if address only mapping, 0 if address and port
1262 :param vrf_id: VRF ID
1263 :param protocol: IP protocol (Default value = 0)
1264 :param twice_nat: 1 if translate external host address and port
1265 :param out2in_only: if 1 rule is matching only out2in direction
1266 :param tag: Opaque string tag
1267 :param is_add: 1 if add, 0 if delete (Default value = 1)
1270 self.papi.nat44_add_del_static_mapping,
1272 'addr_only': addr_only,
1273 'local_ip_address': local_ip,
1274 'external_ip_address': external_ip,
1275 'local_port': local_port,
1276 'external_port': external_port,
1277 'external_sw_if_index': external_sw_if_index,
1279 'protocol': protocol,
1280 'twice_nat': twice_nat,
1281 'out2in_only': out2in_only,
1284 def nat44_add_del_identity_mapping(
1287 sw_if_index=0xFFFFFFFF,
1294 """Add/delete NAT44 identity mapping
1296 :param ip: IP address (Default value = 0)
1297 :param sw_if_index: Interface instead of IP address
1298 :param port: 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 tag: Opaque string tag
1303 :param is_add: 1 if add, 0 if delete (Default value = 1)
1306 self.papi.nat44_add_del_identity_mapping,
1308 'addr_only': addr_only,
1311 'sw_if_index': sw_if_index,
1314 'protocol': protocol})
1316 def nat44_add_del_address_range(
1323 """Add/del NAT44 address range
1325 :param first_ip_address: First IP address
1326 :param last_ip_address: Last IP address
1327 :param vrf_id: VRF id for the address range
1328 :param twice_nat: twice NAT address for extenal hosts
1329 :param is_add: 1 if add, 0 if delete (Default value = 1)
1332 self.papi.nat44_add_del_address_range,
1333 {'first_ip_address': first_ip_address,
1334 'last_ip_address': last_ip_address,
1336 'twice_nat': twice_nat,
1339 def nat44_address_dump(self):
1340 """Dump NAT44 addresses
1341 :return: Dictionary of NAT44 addresses
1343 return self.api(self.papi.nat44_address_dump, {})
1345 def nat44_interface_dump(self):
1346 """Dump interfaces with NAT44 feature
1347 :return: Dictionary of interfaces with NAT44 feature
1349 return self.api(self.papi.nat44_interface_dump, {})
1351 def nat44_interface_output_feature_dump(self):
1352 """Dump interfaces with NAT44 output feature
1353 :return: Dictionary of interfaces with NAT44 output feature
1355 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1357 def nat44_static_mapping_dump(self):
1358 """Dump NAT44 static mappings
1359 :return: Dictionary of NAT44 static mappings
1361 return self.api(self.papi.nat44_static_mapping_dump, {})
1363 def nat44_identity_mapping_dump(self):
1364 """Dump NAT44 identity mappings
1365 :return: Dictionary of NAT44 identity mappings
1367 return self.api(self.papi.nat44_identity_mapping_dump, {})
1369 def nat_show_config(self):
1370 """Show NAT plugin config
1371 :return: NAT plugin config parameters
1373 return self.api(self.papi.nat_show_config, {})
1375 def nat44_add_interface_addr(
1380 """Add/del NAT44 address from interface
1382 :param sw_if_index: Software index of the interface
1383 :param twice_nat: twice NAT address for extenal hosts
1384 :param is_add: 1 if add, 0 if delete (Default value = 1)
1387 self.papi.nat44_add_del_interface_addr,
1389 'sw_if_index': sw_if_index,
1390 'twice_nat': twice_nat})
1392 def nat44_interface_addr_dump(self):
1393 """Dump NAT44 addresses interfaces
1394 :return: Dictionary of NAT44 addresses interfaces
1396 return self.api(self.papi.nat44_interface_addr_dump, {})
1403 """Enable/disable NAT IPFIX logging
1405 :param domain_id: Observation domain ID (Default value = 1)
1406 :param src_port: Source port number (Default value = 4739)
1407 :param enable: 1 if enable, 0 if disable (Default value = 1)
1410 self.papi.nat_ipfix_enable_disable,
1411 {'domain_id': domain_id,
1412 'src_port': src_port,
1415 def nat44_user_session_dump(
1419 """Dump NAT44 user's sessions
1421 :param ip_address: ip adress of the user to be dumped
1422 :param cpu_index: cpu_index on which the user is
1423 :param vrf_id: VRF ID
1424 :return: Dictionary of S-NAT sessions
1427 self.papi.nat44_user_session_dump,
1428 {'ip_address': ip_address,
1431 def nat44_user_dump(self):
1434 :return: Dictionary of NAT44 users
1436 return self.api(self.papi.nat44_user_dump, {})
1438 def nat44_add_del_lb_static_mapping(
1450 """Add/delete NAT44 load balancing static mapping
1452 :param twice_nat: 1 if translate external host address and port
1453 :param tag: Opaque string tag
1454 :param is_add - 1 if add, 0 if delete
1457 self.papi.nat44_add_del_lb_static_mapping,
1459 'external_addr': external_addr,
1460 'external_port': external_port,
1461 'protocol': protocol,
1463 'twice_nat': twice_nat,
1464 'out2in_only': out2in_only,
1466 'local_num': local_num,
1469 def nat44_lb_static_mapping_dump(self):
1470 """Dump NAT44 load balancing static mappings
1472 :return: Dictionary of NAT44 load balancing static mapping
1474 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1476 def nat44_del_session(
1483 """Delete NAT44 session
1485 :param addr: IPv4 address
1486 :param por: port number
1487 :param protocol: IP protocol number
1488 :param vrf_id: VRF ID
1489 :param is_in: 1 if inside network addres and port pari, 0 if outside
1492 self.papi.nat44_del_session,
1495 'protocol': protocol,
1499 def nat44_forwarding_enable_disable(
1502 """Enable/disable forwarding for NAT44
1504 :param enable: 1 for enable, 0 for disable
1507 self.papi.nat44_forwarding_enable_disable,
1517 """Set NAT virtual fragmentation reassembly
1519 :param timeout: reassembly timeout (Default 2sec)
1520 :param max_reass: maximum concurrent reassemblies (Default 1024)
1521 :param max_frag: maximum fragmets per reassembly (Default 5)
1522 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1523 :param is_ip6: 1 if IPv6, 0 if IPv4
1526 self.papi.nat_set_reass,
1527 {'timeout': timeout,
1528 'max_reass': max_reass,
1529 'max_frag': max_frag,
1530 'drop_frag': drop_frag,
1533 def nat_get_reass(self):
1534 """Get NAT virtual fragmentation reassembly configuration
1536 :return: NAT virtual fragmentation reassembly configuration
1538 return self.api(self.papi.nat_get_reass, {})
1540 def nat_reass_dump(self):
1541 """Dump NAT virtual fragmentation reassemblies
1543 :return: Dictionary of NAT virtual fragmentation reassemblies
1545 return self.api(self.papi.nat_reass_dump, {})
1547 def nat_det_add_del_map(
1554 """Add/delete deterministic NAT mapping
1556 :param is_add - 1 if add, 0 if delete
1557 :param in_addr - inside IP address
1558 :param in_plen - inside IP address prefix length
1559 :param out_addr - outside IP address
1560 :param out_plen - outside IP address prefix length
1563 self.papi.nat_det_add_del_map,
1568 'out_addr': out_addr,
1569 'out_plen': out_plen})
1571 def nat_det_forward(
1574 """Get outside address and port range from inside address
1576 :param in_addr - inside IP address
1579 self.papi.nat_det_forward,
1580 {'in_addr': in_addr,
1583 def nat_det_reverse(
1587 """Get inside address from outside address and port
1589 :param out_addr - outside IP address
1590 :param out_port - outside port
1593 self.papi.nat_det_reverse,
1594 {'out_addr': out_addr,
1595 'out_port': out_port})
1597 def nat_det_map_dump(self):
1598 """Dump deterministic NAT mappings
1600 :return: Dictionary of deterministic NAT mappings
1602 return self.api(self.papi.nat_det_map_dump, {})
1604 def nat_det_set_timeouts(
1607 tcp_established=7440,
1610 """Set values of timeouts for deterministic NAT (in seconds)
1612 :param udp - UDP timeout (Default value = 300)
1613 :param tcp_established - TCP established timeout (Default value = 7440)
1614 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1615 :param icmp - ICMP timeout (Default value = 60)
1618 self.papi.nat_det_set_timeouts,
1620 'tcp_established': tcp_established,
1621 'tcp_transitory': tcp_transitory,
1624 def nat_det_get_timeouts(self):
1625 """Get values of timeouts for deterministic NAT
1627 :return: Timeouts for deterministic NAT (in seconds)
1629 return self.api(self.papi.nat_det_get_timeouts, {})
1631 def nat_det_close_session_out(
1637 """Close deterministic NAT session using outside address and port
1639 :param out_addr - outside IP address
1640 :param out_port - outside port
1641 :param ext_addr - external host IP address
1642 :param ext_port - external host port
1645 self.papi.nat_det_close_session_out,
1646 {'out_addr': out_addr,
1647 'out_port': out_port,
1648 'ext_addr': ext_addr,
1649 'ext_port': ext_port})
1651 def nat_det_close_session_in(
1657 """Close deterministic NAT session using inside address and port
1659 :param in_addr - inside IP address
1660 :param in_port - inside port
1661 :param ext_addr - external host IP address
1662 :param ext_port - external host port
1665 self.papi.nat_det_close_session_in,
1666 {'in_addr': in_addr,
1668 'ext_addr': ext_addr,
1669 'ext_port': ext_port,
1672 def nat_det_session_dump(
1675 """Dump deterministic NAT sessions belonging to a user
1677 :param user_addr - inside IP address of the user
1678 :return: Dictionary of deterministic NAT sessions
1681 self.papi.nat_det_session_dump,
1683 'user_addr': user_addr})
1685 def nat64_add_del_pool_addr_range(
1691 """Add/del address range to NAT64 pool
1693 :param start_addr: First IP address
1694 :param end_addr: Last IP address
1695 :param vrf_id: VRF id for the address range
1696 :param is_add: 1 if add, 0 if delete (Default value = 1)
1699 self.papi.nat64_add_del_pool_addr_range,
1700 {'start_addr': start_addr,
1701 'end_addr': end_addr,
1705 def nat64_pool_addr_dump(self):
1706 """Dump NAT64 pool addresses
1707 :return: Dictionary of NAT64 pool addresses
1709 return self.api(self.papi.nat64_pool_addr_dump, {})
1711 def nat64_add_del_interface(
1716 """Enable/disable NAT64 feature on the interface
1717 :param sw_if_index: Index of the interface
1718 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1719 :param is_add: 1 if add, 0 if delete (Default value = 1)
1722 self.papi.nat64_add_del_interface,
1723 {'sw_if_index': sw_if_index,
1724 'is_inside': is_inside,
1727 def nat64_interface_dump(self):
1728 """Dump interfaces with NAT64 feature
1729 :return: Dictionary of interfaces with NAT64 feature
1731 return self.api(self.papi.nat64_interface_dump, {})
1733 def nat64_add_del_static_bib(
1742 """Add/delete S-NAT static BIB entry
1744 :param in_ip: Inside IPv6 address
1745 :param out_ip: Outside IPv4 address
1746 :param in_port: Inside port number
1747 :param out_port: Outside port number
1748 :param protocol: IP protocol
1749 :param vrf_id: VRF ID (Default value = 0)
1750 :param is_add: 1 if add, 0 if delete (Default value = 1)
1753 self.papi.nat64_add_del_static_bib,
1762 def nat64_bib_dump(self, protocol=255):
1765 :param protocol: IP protocol (Default value = 255, all BIBs)
1766 :returns: Dictionary of NAT64 BIB entries
1768 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1770 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1771 tcp_incoming_syn=6):
1772 """Set values of timeouts for NAT64 (in seconds)
1774 :param udpi: UDP timeout (Default value = 300)
1775 :param icmp: ICMP timeout (Default value = 60)
1776 :param tcp_trans: TCP transitory timeout (Default value = 240)
1777 :param tcp_est: TCP established timeout (Default value = 7440)
1778 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1781 self.papi.nat64_set_timeouts,
1784 'tcp_trans': tcp_trans,
1786 'tcp_incoming_syn': tcp_incoming_syn})
1788 def nat64_get_timeouts(self):
1789 """Get values of timeouts for NAT64
1791 :return: Timeouts for NAT64 (in seconds)
1793 return self.api(self.papi.nat64_get_timeouts, {})
1795 def nat64_st_dump(self, protocol=255):
1796 """Dump NAT64 session table
1798 :param protocol: IP protocol (Default value = 255, all STs)
1799 :returns: Dictionary of NAT64 sesstion table entries
1801 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1803 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1804 """Add/del NAT64 prefix
1806 :param prefix: NAT64 prefix
1807 :param plen: NAT64 prefix length
1808 :param vrf_id: VRF id of tenant (Default 0)
1809 :param is_add: 1 if add, 0 if delete (Default value = 1)
1812 self.papi.nat64_add_del_prefix,
1818 def nat64_prefix_dump(self):
1819 """Dump NAT64 prefix
1821 :returns: Dictionary of NAT64 prefixes
1823 return self.api(self.papi.nat64_prefix_dump, {})
1825 def nat64_add_interface_addr(
1829 """Add/del NAT64 address from interface
1831 :param sw_if_index: Software index of the interface
1832 :param is_add: 1 if add, 0 if delete (Default value = 1)
1834 return self.api(self.papi.nat64_add_del_interface_addr,
1835 {'is_add': is_add, 'sw_if_index': sw_if_index})
1837 def dslite_set_aftr_addr(self, ip6, ip4):
1838 """Set DS-Lite AFTR addresses
1840 :param ip4: IPv4 address
1841 :param ip6: IPv6 address
1844 self.papi.dslite_set_aftr_addr,
1848 def dslite_set_b4_addr(self, ip6, ip4):
1849 """Set DS-Lite B4 IPv6 address
1851 :param ip4: IPv4 address
1852 :param ip6: IPv6 address
1855 self.papi.dslite_set_b4_addr,
1859 def dslite_add_del_pool_addr_range(
1864 """Add/del address range to DS-Lite pool
1866 :param start_addr: First IP address
1867 :param end_addr: Last IP address
1868 :param is_add: 1 if add, 0 if delete (Default value = 1)
1871 self.papi.dslite_add_del_pool_addr_range,
1872 {'start_addr': start_addr,
1873 'end_addr': end_addr,
1876 def nat66_add_del_interface(
1881 """Enable/disable NAT66 feature on the interface
1882 :param sw_if_index: Index of the interface
1883 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1884 :param is_add: 1 if add, 0 if delete (Default value = 1)
1887 self.papi.nat66_add_del_interface,
1888 {'sw_if_index': sw_if_index,
1889 'is_inside': is_inside,
1892 def nat66_add_del_static_mapping(
1898 """Add/delete NAT66 static mapping
1900 :param in_ip: Inside IPv6 address
1901 :param out_ip: Outside IPv6 address
1902 :param vrf_id: VRF ID (Default value = 0)
1903 :param is_add: 1 if add, 0 if delete (Default value = 1)
1906 self.papi.nat66_add_del_static_mapping,
1907 {'local_ip_address': in_ip,
1908 'external_ip_address': out_ip,
1912 def nat66_interface_dump(self):
1913 """Dump interfaces with NAT66 feature
1914 :return: Dictionary of interfaces with NAT66 feature
1916 return self.api(self.papi.nat66_interface_dump, {})
1918 def nat66_static_mapping_dump(self):
1919 """Dump NAT66 static mappings
1920 :return: Dictionary of NAT66 static mappings
1922 return self.api(self.papi.nat66_static_mapping_dump, {})
1924 def control_ping(self):
1925 self.api(self.papi.control_ping)
1927 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1928 detect_mult, local_addr, peer_addr, is_ipv6=0,
1929 bfd_key_id=None, conf_key_id=None):
1930 if bfd_key_id is None:
1931 return self.api(self.papi.bfd_udp_add,
1933 'sw_if_index': sw_if_index,
1934 'desired_min_tx': desired_min_tx,
1935 'required_min_rx': required_min_rx,
1936 'local_addr': local_addr,
1937 'peer_addr': peer_addr,
1939 'detect_mult': detect_mult,
1942 return self.api(self.papi.bfd_udp_add,
1944 'sw_if_index': sw_if_index,
1945 'desired_min_tx': desired_min_tx,
1946 'required_min_rx': required_min_rx,
1947 'local_addr': local_addr,
1948 'peer_addr': peer_addr,
1950 'detect_mult': detect_mult,
1951 'is_authenticated': 1,
1952 'bfd_key_id': bfd_key_id,
1953 'conf_key_id': conf_key_id,
1956 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1957 detect_mult, local_addr, peer_addr, is_ipv6=0):
1958 return self.api(self.papi.bfd_udp_mod,
1960 'sw_if_index': sw_if_index,
1961 'desired_min_tx': desired_min_tx,
1962 'required_min_rx': required_min_rx,
1963 'local_addr': local_addr,
1964 'peer_addr': peer_addr,
1966 'detect_mult': detect_mult,
1969 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1970 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1972 return self.api(self.papi.bfd_udp_auth_activate,
1974 'sw_if_index': sw_if_index,
1975 'local_addr': local_addr,
1976 'peer_addr': peer_addr,
1978 'is_delayed': 1 if is_delayed else 0,
1979 'bfd_key_id': bfd_key_id,
1980 'conf_key_id': conf_key_id,
1983 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1984 is_ipv6=0, is_delayed=False):
1985 return self.api(self.papi.bfd_udp_auth_deactivate,
1987 'sw_if_index': sw_if_index,
1988 'local_addr': local_addr,
1989 'peer_addr': peer_addr,
1991 'is_delayed': 1 if is_delayed else 0,
1994 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1995 return self.api(self.papi.bfd_udp_del,
1997 'sw_if_index': sw_if_index,
1998 'local_addr': local_addr,
1999 'peer_addr': peer_addr,
2003 def bfd_udp_session_dump(self):
2004 return self.api(self.papi.bfd_udp_session_dump, {})
2006 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2007 peer_addr, is_ipv6=0):
2008 return self.api(self.papi.bfd_udp_session_set_flags, {
2009 'admin_up_down': admin_up_down,
2010 'sw_if_index': sw_if_index,
2011 'local_addr': local_addr,
2012 'peer_addr': peer_addr,
2016 def want_bfd_events(self, enable_disable=1):
2017 return self.api(self.papi.want_bfd_events, {
2018 'enable_disable': enable_disable,
2022 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2023 return self.api(self.papi.bfd_auth_set_key, {
2024 'conf_key_id': conf_key_id,
2025 'auth_type': auth_type,
2027 'key_len': len(key),
2030 def bfd_auth_del_key(self, conf_key_id):
2031 return self.api(self.papi.bfd_auth_del_key, {
2032 'conf_key_id': conf_key_id,
2035 def bfd_auth_keys_dump(self):
2036 return self.api(self.papi.bfd_auth_keys_dump, {})
2038 def bfd_udp_set_echo_source(self, sw_if_index):
2039 return self.api(self.papi.bfd_udp_set_echo_source,
2040 {'sw_if_index': sw_if_index})
2042 def bfd_udp_del_echo_source(self):
2043 return self.api(self.papi.bfd_udp_del_echo_source, {})
2045 def classify_add_del_table(
2050 table_index=0xFFFFFFFF,
2052 memory_size=2097152,
2054 next_table_index=0xFFFFFFFF,
2055 miss_next_index=0xFFFFFFFF,
2056 current_data_flag=0,
2057 current_data_offset=0):
2061 :param match_n_vectors: (Default value = 1)
2062 :param table_index: (Default value = 0xFFFFFFFF)
2063 :param nbuckets: (Default value = 2)
2064 :param memory_size: (Default value = 2097152)
2065 :param skip_n_vectors: (Default value = 0)
2066 :param next_table_index: (Default value = 0xFFFFFFFF)
2067 :param miss_next_index: (Default value = 0xFFFFFFFF)
2068 :param current_data_flag: (Default value = 0)
2069 :param current_data_offset: (Default value = 0)
2073 self.papi.classify_add_del_table,
2075 'table_index': table_index,
2076 'nbuckets': nbuckets,
2077 'memory_size': memory_size,
2078 'skip_n_vectors': skip_n_vectors,
2079 'match_n_vectors': match_n_vectors,
2080 'next_table_index': next_table_index,
2081 'miss_next_index': miss_next_index,
2082 'current_data_flag': current_data_flag,
2083 'current_data_offset': current_data_offset,
2086 def classify_add_del_session(
2091 opaque_index=0xFFFFFFFF,
2092 hit_next_index=0xFFFFFFFF,
2100 :param opaque_index: (Default value = 0xFFFFFFFF)
2101 :param hit_next_index: (Default value = 0xFFFFFFFF)
2102 :param advance: (Default value = 0)
2103 :param action: (Default value = 0)
2104 :param metadata: (Default value = 0)
2108 self.papi.classify_add_del_session,
2110 'table_index': table_index,
2111 'hit_next_index': hit_next_index,
2112 'opaque_index': opaque_index,
2115 'metadata': metadata,
2118 def input_acl_set_interface(
2122 ip4_table_index=0xFFFFFFFF,
2123 ip6_table_index=0xFFFFFFFF,
2124 l2_table_index=0xFFFFFFFF):
2128 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2129 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2130 :param l2_table_index: (Default value = 0xFFFFFFFF)
2134 self.papi.input_acl_set_interface,
2135 {'sw_if_index': sw_if_index,
2136 'ip4_table_index': ip4_table_index,
2137 'ip6_table_index': ip6_table_index,
2138 'l2_table_index': l2_table_index,
2141 def output_acl_set_interface(
2145 ip4_table_index=0xFFFFFFFF,
2146 ip6_table_index=0xFFFFFFFF,
2147 l2_table_index=0xFFFFFFFF):
2151 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2152 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2153 :param l2_table_index: (Default value = 0xFFFFFFFF)
2157 self.papi.output_acl_set_interface,
2158 {'sw_if_index': sw_if_index,
2159 'ip4_table_index': ip4_table_index,
2160 'ip6_table_index': ip6_table_index,
2161 'l2_table_index': l2_table_index,
2164 def set_ipfix_exporter(
2171 collector_port=4739,
2174 self.papi.set_ipfix_exporter,
2176 'collector_address': collector_address,
2177 'collector_port': collector_port,
2178 'src_address': src_address,
2180 'path_mtu': path_mtu,
2181 'template_interval': template_interval,
2182 'udp_checksum': udp_checksum,
2185 def dhcp_proxy_config(self,
2193 self.papi.dhcp_proxy_config,
2195 'rx_vrf_id': rx_table_id,
2196 'server_vrf_id': server_table_id,
2199 'dhcp_server': dhcp_server,
2200 'dhcp_src_address': dhcp_src_address,
2203 def dhcp_proxy_set_vss(self,
2212 self.papi.dhcp_proxy_set_vss,
2215 'vss_type': vss_type,
2216 'vpn_ascii_id': vpn_ascii_id,
2218 'vpn_index': vpn_index,
2223 def dhcp_client(self,
2228 set_broadcast_flag=1,
2229 want_dhcp_events=0):
2231 self.papi.dhcp_client_config,
2233 'sw_if_index': sw_if_index,
2234 'hostname': hostname,
2235 'client_id': client_id,
2237 'want_dhcp_event': want_dhcp_events,
2238 'set_broadcast_flag': set_broadcast_flag,
2242 def ip_mroute_add_del(self,
2248 next_hop_sw_if_index,
2257 IP Multicast Route add/del
2260 self.papi.ip_mroute_add_del,
2261 {'next_hop_sw_if_index': next_hop_sw_if_index,
2262 'entry_flags': e_flags,
2263 'itf_flags': i_flags,
2264 'table_id': table_id,
2268 'is_local': is_local,
2269 'bier_imp': bier_imp,
2270 'next_hop_afi': next_hop_afi,
2271 'grp_address_length': grp_address_length,
2272 'grp_address': grp_address,
2273 'src_address': src_address})
2275 def mfib_signal_dump(self):
2276 return self.api(self.papi.mfib_signal_dump, {})
2278 def ip_mfib_dump(self):
2279 return self.api(self.papi.ip_mfib_dump, {})
2281 def ip6_mfib_dump(self):
2282 return self.api(self.papi.ip6_mfib_dump, {})
2284 def lisp_enable_disable(self, is_enabled):
2286 self.papi.lisp_enable_disable,
2288 'is_en': is_enabled,
2291 def lisp_locator_set(self,
2295 self.papi.lisp_add_del_locator_set,
2298 'locator_set_name': ls_name
2301 def lisp_locator_set_dump(self):
2302 return self.api(self.papi.lisp_locator_set_dump, {})
2304 def lisp_locator(self,
2311 self.papi.lisp_add_del_locator,
2314 'locator_set_name': ls_name,
2315 'sw_if_index': sw_if_index,
2316 'priority': priority,
2320 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2322 self.papi.lisp_locator_dump,
2324 'is_index_set': is_index_set,
2326 'ls_index': ls_index,
2329 def lisp_local_mapping(self,
2339 self.papi.lisp_add_del_local_eid,
2341 'locator_set_name': ls_name,
2343 'eid_type': eid_type,
2345 'prefix_len': prefix_len,
2351 def lisp_eid_table_dump(self,
2359 self.papi.lisp_eid_table_dump,
2362 'prefix_length': prefix_length,
2364 'eid_type': eid_type,
2366 'filter': filter_opt,
2369 def lisp_remote_mapping(self,
2379 self.papi.lisp_add_del_remote_mapping,
2382 'eid_type': eid_type,
2384 'eid_len': eid_prefix_len,
2385 'rloc_num': rlocs_num,
2388 'is_src_dst': is_src_dst,
2391 def lisp_adjacency(self,
2400 self.papi.lisp_add_del_adjacency,
2404 'eid_type': eid_type,
2407 'leid_len': leid_len,
2408 'reid_len': reid_len,
2411 def lisp_adjacencies_get(self, vni=0):
2413 self.papi.lisp_adjacencies_get,
2418 def map_add_domain(self,
2432 self.papi.map_add_domain,
2434 'ip6_prefix': ip6_prefix,
2435 'ip6_prefix_len': ip6_prefix_len,
2436 'ip4_prefix': ip4_prefix,
2437 'ip4_prefix_len': ip4_prefix_len,
2439 'ip6_src_prefix_len': ip6_src_prefix_len,
2440 'ea_bits_len': ea_bits_len,
2441 'psid_offset': psid_offset,
2442 'psid_length': psid_length,
2443 'is_translation': is_translation,
2444 'is_rfc6052': is_rfc6052,
2448 def gtpu_add_del_tunnel(
2454 mcast_sw_if_index=0xFFFFFFFF,
2456 decap_next_index=0xFFFFFFFF,
2460 :param is_add: (Default value = 1)
2461 :param is_ipv6: (Default value = 0)
2464 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2465 :param encap_vrf_id: (Default value = 0)
2466 :param decap_next_index: (Default value = 0xFFFFFFFF)
2467 :param teid: (Default value = 0)
2470 return self.api(self.papi.gtpu_add_del_tunnel,
2473 'src_address': src_addr,
2474 'dst_address': dst_addr,
2475 'mcast_sw_if_index': mcast_sw_if_index,
2476 'encap_vrf_id': encap_vrf_id,
2477 'decap_next_index': decap_next_index,
2480 def vxlan_gpe_add_del_tunnel(
2484 mcast_sw_if_index=0xFFFFFFFF,
2495 :param is_add: (Default value = 1)
2496 :param is_ipv6: (Default value = 0)
2497 :param encap_vrf_id: (Default value = 0)
2498 :param decap_vrf_id: (Default value = 0)
2499 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2500 :param protocol: (Default value = 3)
2501 :param vni: (Default value = 0)
2504 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2509 'mcast_sw_if_index': mcast_sw_if_index,
2510 'encap_vrf_id': encap_vrf_id,
2511 'decap_vrf_id': decap_vrf_id,
2512 'protocol': protocol,
2515 def pppoe_add_del_session(
2525 :param is_add: (Default value = 1)
2526 :param is_ipv6: (Default value = 0)
2528 :param session_id: (Default value = 0)
2530 :param decap_vrf_id: (Default value = 0)
2533 return self.api(self.papi.pppoe_add_del_session,
2536 'session_id': session_id,
2537 'client_ip': client_ip,
2538 'decap_vrf_id': decap_vrf_id,
2539 'client_mac': client_mac})
2541 def sr_localsid_add_del(self,
2547 sw_if_index=0xFFFFFFFF,
2551 """ Add/del IPv6 SR local-SID.
2553 :param localsid_addr:
2554 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2555 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2557 :param is_del: (Default value = 0)
2558 :param end_psp: (Default value = 0)
2559 :param sw_if_index: (Default value = 0xFFFFFFFF)
2560 :param vlan_index: (Default value = 0)
2561 :param fib_table: (Default value = 0)
2564 self.papi.sr_localsid_add_del,
2566 'localsid_addr': localsid_addr,
2568 'behavior': behavior,
2569 'sw_if_index': sw_if_index,
2570 'vlan_index': vlan_index,
2571 'fib_table': fib_table,
2586 :param bsid_addr: bindingSID of the SR Policy
2587 :param weight: weight of the sid list. optional. (default: 1)
2588 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2590 :param type: type/behavior of the SR policy. (default or spray) \
2592 :param fib_table: VRF where to install the FIB entry for the BSID \
2594 :param n_segments: number of segments \
2596 :param segments: a vector of IPv6 address composing the segment list \
2600 self.papi.sr_policy_add,
2601 {'bsid_addr': bsid_addr,
2603 'is_encap': is_encap,
2605 'fib_table': fib_table,
2606 'n_segments': n_segments,
2607 'segments': segments
2616 :param bsid: bindingSID of the SR Policy
2617 :param sr_policy_index: index of the sr policy (default: 0)
2620 self.papi.sr_policy_del,
2621 {'bsid_addr': bsid_addr,
2622 'sr_policy_index': sr_policy_index
2625 def sr_steering_add_del(
2636 Steer traffic L2 and L3 traffic through a given SR policy
2638 :param is_del: delete or add
2639 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2640 :param sr_policy: is the index of the SR Policy (alt to bsid)
2641 :param table_id: is the VRF where to install the FIB entry for the BSID
2642 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2643 :param mask_width: is the mask for L3 traffic type
2644 :param sw_if_index: is the incoming interface for L2 traffic
2645 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2648 self.papi.sr_steering_add_del,
2650 'bsid_addr': bsid_addr,
2651 'sr_policy_index': sr_policy_index,
2652 'table_id': table_id,
2653 'prefix_addr': prefix_addr,
2654 'mask_width': mask_width,
2655 'sw_if_index': sw_if_index,
2656 'traffic_type': traffic_type
2659 def acl_add_replace(self, acl_index, r, tag='',
2661 """Add/replace an ACL
2662 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2663 :param acl_rule r: ACL rules array.
2664 :param str tag: symbolic tag (description) for this ACL.
2665 :param int count: number of rules.
2667 return self.api(self.papi.acl_add_replace,
2668 {'acl_index': acl_index,
2672 expected_retval=expected_retval)
2674 def acl_del(self, acl_index, expected_retval=0):
2680 return self.api(self.papi.acl_del,
2681 {'acl_index': acl_index},
2682 expected_retval=expected_retval)
2684 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2686 return self.api(self.papi.acl_interface_set_acl_list,
2687 {'sw_if_index': sw_if_index,
2691 expected_retval=expected_retval)
2693 def acl_interface_set_etype_whitelist(self, sw_if_index,
2696 return self.api(self.papi.acl_interface_set_etype_whitelist,
2697 {'sw_if_index': sw_if_index,
2698 'count': len(whitelist),
2700 'whitelist': whitelist},
2701 expected_retval=expected_retval)
2703 def acl_interface_add_del(self,
2707 """ Add/Delete ACL to/from interface
2711 :param is_add: (Default value = 1)
2714 return self.api(self.papi.acl_interface_add_del,
2717 'sw_if_index': sw_if_index,
2718 'acl_index': acl_index})
2720 def acl_dump(self, acl_index, expected_retval=0):
2721 return self.api(self.papi.acl_dump,
2722 {'acl_index': acl_index},
2723 expected_retval=expected_retval)
2725 def macip_acl_add(self, rules, tag=""):
2728 :param rules: list of rules for given acl
2732 return self.api(self.papi.macip_acl_add,
2734 'count': len(rules),
2737 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2740 :param rules: list of rules for given acl
2744 return self.api(self.papi.macip_acl_add_replace,
2745 {'acl_index': acl_index,
2747 'count': len(rules),
2750 def macip_acl_del(self, acl_index):
2756 return self.api(self.papi.macip_acl_del,
2757 {'acl_index': acl_index})
2759 def macip_acl_interface_add_del(self,
2763 """ Add MACIP acl to interface
2767 :param is_add: (Default value = 1)
2770 return self.api(self.papi.macip_acl_interface_add_del,
2772 'sw_if_index': sw_if_index,
2773 'acl_index': acl_index})
2775 def macip_acl_interface_get(self):
2776 """ Return interface acls dump
2779 self.papi.macip_acl_interface_get, {})
2781 def macip_acl_dump(self, acl_index=4294967295):
2782 """ Return MACIP acl dump
2786 self.papi.macip_acl_dump, {'acl_index': acl_index})
2788 def policer_add_del(self,
2799 conform_action_type=1,
2801 exceed_action_type=0,
2803 violate_action_type=0,
2805 return self.api(self.papi.policer_add_del,
2812 'rate_type': rate_type,
2813 'round_type': round_type,
2815 'color_aware': color_aware,
2816 'conform_action_type': conform_action_type,
2817 'conform_dscp': conform_dscp,
2818 'exceed_action_type': exceed_action_type,
2819 'exceed_dscp': exceed_dscp,
2820 'violate_action_type': violate_action_type,
2821 'violate_dscp': violate_dscp})
2823 def ip_punt_police(self,
2827 return self.api(self.papi.ip_punt_police,
2828 {'policer_index': policer_index,
2832 def ip_punt_redirect(self,
2838 return self.api(self.papi.ip_punt_redirect,
2839 {'rx_sw_if_index': rx_sw_if_index,
2840 'tx_sw_if_index': tx_sw_if_index,
2845 def bier_table_add_del(self,
2849 """ BIER Table add/del """
2851 self.papi.bier_table_add_del,
2852 {'bt_tbl_id': {"bt_set": bti.set_id,
2853 "bt_sub_domain": bti.sub_domain_id,
2854 "bt_hdr_len_id": bti.hdr_len_id},
2855 'bt_label': mpls_label,
2856 'bt_is_add': is_add})
2858 def bier_table_dump(self):
2859 return self.api(self.papi.bier_table_dump, {})
2861 def bier_route_add_del(self,
2866 """ BIER Route add/del """
2869 br_paths.append({'next_hop': p.nh_addr,
2873 'table_id': p.nh_table_id,
2874 'next_hop_id': p.next_hop_id,
2875 'is_udp_encap': p.is_udp_encap,
2876 'n_labels': len(p.nh_labels),
2877 'label_stack': p.nh_labels})
2879 self.papi.bier_route_add_del,
2880 {'br_tbl_id': {"bt_set": bti.set_id,
2881 "bt_sub_domain": bti.sub_domain_id,
2882 "bt_hdr_len_id": bti.hdr_len_id},
2884 'br_n_paths': len(br_paths),
2885 'br_paths': br_paths,
2886 'br_is_add': is_add})
2888 def bier_route_dump(self, bti):
2890 self.papi.bier_route_dump,
2891 {'br_tbl_id': {"bt_set": bti.set_id,
2892 "bt_sub_domain": bti.sub_domain_id,
2893 "bt_hdr_len_id": bti.hdr_len_id}})
2895 def bier_imp_add(self,
2900 """ BIER Imposition Add """
2902 self.papi.bier_imp_add,
2903 {'bi_tbl_id': {"bt_set": bti.set_id,
2904 "bt_sub_domain": bti.sub_domain_id,
2905 "bt_hdr_len_id": bti.hdr_len_id},
2907 'bi_n_bytes': len(ibytes),
2908 'bi_bytes': ibytes})
2910 def bier_imp_del(self, bi_index):
2911 """ BIER Imposition del """
2913 self.papi.bier_imp_del,
2914 {'bi_index': bi_index})
2916 def bier_imp_dump(self):
2917 return self.api(self.papi.bier_imp_dump, {})
2919 def bier_disp_table_add_del(self,
2922 """ BIER Disposition Table add/del """
2924 self.papi.bier_disp_table_add_del,
2925 {'bdt_tbl_id': bdti,
2926 'bdt_is_add': is_add})
2928 def bier_disp_table_dump(self):
2929 return self.api(self.papi.bier_disp_table_dump, {})
2931 def bier_disp_entry_add_del(self,
2941 """ BIER Route add/del """
2943 self.papi.bier_disp_entry_add_del,
2944 {'bde_tbl_id': bdti,
2946 'bde_payload_proto': payload_proto,
2948 'bde_paths': [{'next_hop': next_hop,
2949 'table_id': next_hop_tbl_id,
2950 'afi': next_hop_afi,
2951 'rpf_id': next_hop_rpf_id,
2953 'label_stack': [0]}],
2954 'bde_is_add': is_add})
2956 def bier_disp_entry_dump(self, bdti):
2958 self.papi.bier_disp_entry_dump,
2959 {'bde_tbl_id': bdti})
2961 def add_node_next(self, node_name, next_name):
2962 """ Set the next node for a given node request
2967 return self.api(self.papi.add_node_next,
2968 {'node_name': node_name,
2969 'next_name': next_name})
2971 def session_enable_disable(self, is_enabled):
2973 self.papi.session_enable_disable,
2974 {'is_enable': is_enabled})
2976 def ipsec_spd_add_del(self, spd_id, is_add=1):
2977 """ SPD add/del - Wrapper to add or del ipsec SPD
2978 Sample CLI : 'ipsec spd add 1'
2980 :param spd_id - SPD ID to be created in the vpp . mandatory
2981 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2983 :returns: reply from the API
2986 self.papi.ipsec_spd_add_del, {
2987 'spd_id': spd_id, 'is_add': is_add})
2989 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2990 """ IPSEC interface SPD add/del - \
2991 Wrapper to associate/disassociate SPD to interface in VPP
2992 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2994 :param spd_id - SPD ID to associate with the interface . mandatory
2995 :param sw_if_index - Interface Index which needs to ipsec \
2996 association mandatory
2997 :param is_add - add(1) or del(0) association with interface \
2998 (Default 1 - add) . optional
2999 :returns: reply from the API
3002 self.papi.ipsec_interface_add_del_spd, {
3004 'sw_if_index': sw_if_index, 'is_add': is_add})
3006 def ipsec_sad_add_del_entry(self,
3009 tunnel_src_address='',
3010 tunnel_dst_address='',
3012 integrity_algorithm=2,
3013 integrity_key_length=0,
3014 integrity_key='C91KUR9GYMm5GfkEvNjX',
3016 crypto_key_length=0,
3017 crypto_key='JPjyOWBeVEQiMe7h',
3020 """ IPSEC SA add/del
3021 Sample CLI : 'ipsec sa add 10 spi 1001 esp \
3022 crypto-key 4a506a794f574265564551694d653768 \
3023 crypto-alg aes-cbc-128 \
3024 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3025 integ-alg sha1-96 tunnel-src 192.168.100.3 \
3026 tunnel-dst 192.168.100.2'
3027 Sample CLI : 'ipsec sa add 20 spi 2001 \
3028 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3031 :param sad_id - Security Association ID to be \
3032 created or deleted. mandatory
3033 :param spi - security param index of the SA in decimal. mandatory
3034 :param tunnel_src_address - incase of tunnel mode outer src address .\
3035 mandatory for tunnel mode
3036 :param tunnel_dst_address - incase of transport mode \
3037 outer dst address. mandatory for tunnel mode
3038 :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional
3039 :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\
3041 :param integrity_key - value in string \
3042 (Default C91KUR9GYMm5GfkEvNjX).optional
3043 :param integrity_key_length - length of the key string in bytes\
3044 (Default 0 - integrity disabled). optional
3045 :param crypto_algorithm - value range 1-11 Default \
3046 (1- AES_CBC_128).optional **
3047 :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional
3048 :param crypto_key_length - length of the key string in bytes\
3049 (Default 0 - crypto disabled). optional
3050 :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\
3052 :param is_tunnel - tunnel mode (1) or transport mode(0) \
3053 (Default 1 - tunnel). optional
3054 :returns: reply from the API
3055 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3056 crypto and ipsec algorithms
3059 self.papi.ipsec_sad_add_del_entry,
3062 'tunnel_src_address': tunnel_src_address,
3063 'tunnel_dst_address': tunnel_dst_address,
3064 'protocol': protocol,
3065 'integrity_algorithm': integrity_algorithm,
3066 'integrity_key_length': integrity_key_length,
3067 'integrity_key': integrity_key,
3068 'crypto_algorithm': crypto_algorithm,
3069 'crypto_key_length': crypto_key_length,
3070 'crypto_key': crypto_key,
3072 'is_tunnel': is_tunnel})
3074 def ipsec_spd_add_del_entry(self,
3076 local_address_start,
3078 remote_address_start,
3079 remote_address_stop,
3081 local_port_stop=65535,
3082 remote_port_start=0,
3083 remote_port_stop=65535,
3091 """ IPSEC policy SPD add/del -
3092 Wrapper to configure ipsec SPD policy entries in VPP
3093 Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \
3094 protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \
3095 remote-ip-range 192.168.3.3 - 192.168.3.3'
3097 :param spd_id - SPD ID for the policy . mandatory
3098 :param local_address_start - local-ip-range start address . mandatory
3099 :param local_address_stop - local-ip-range stop address . mandatory
3100 :param remote_address_start - remote-ip-range start address . mandatory
3101 :param remote_address_stop - remote-ip-range stop address . mandatory
3102 :param local_port_start - (Default 0) . optional
3103 :param local_port_stop - (Default 65535). optional
3104 :param remote_port_start - (Default 0). optional
3105 :param remote_port_stop - (Default 65535). optional
3106 :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any).
3108 :param sa_id - Security Association ID for mapping it to SPD
3109 (default 10). optional
3110 :param policy - bypass(0), discard(1), resolve(2) or protect(3)action
3111 (Default 0 - bypass). optional
3112 :param priotity - value for the spd action (Default 100). optional
3113 :param is_outbound - flag for inbound(0) or outbound(1)
3114 (Default 1 - outbound). optional
3115 :param is_add flag - for addition(1) or deletion(0) of the spd
3116 (Default 1 - addtion). optional
3117 :returns: reply from the API
3120 self.papi.ipsec_spd_add_del_entry,
3122 'local_address_start': local_address_start,
3123 'local_address_stop': local_address_stop,
3124 'remote_address_start': remote_address_start,
3125 'remote_address_stop': remote_address_stop,
3126 'local_port_start': local_port_start,
3127 'local_port_stop': local_port_stop,
3128 'remote_port_start': remote_port_start,
3129 'remote_port_stop': remote_port_stop,
3131 'protocol': protocol,
3133 'priority': priority,
3134 'is_outbound': is_outbound,
3136 'is_ip_any': is_ip_any})
3138 def app_namespace_add(self,
3142 sw_if_index=0xFFFFFFFF,
3145 self.papi.app_namespace_add_del,
3147 'sw_if_index': sw_if_index,
3148 'ip4_fib_id': ip4_fib_id,
3149 'ip6_fib_id': ip6_fib_id,
3150 'namespace_id': namespace_id,
3151 'namespace_id_len': len(namespace_id)})
3153 def punt_socket_register(self, l4_port, pathname, header_version=1,
3154 is_ip4=1, l4_protocol=0x11):
3155 """ Punt to socket """
3156 return self.api(self.papi.punt_socket_register,
3158 'l4_protocol': l4_protocol,
3160 'pathname': pathname,
3161 'header_version': header_version})
3163 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3164 expire_walk_interval_ms, is_ip6=0):
3165 """ Set IP reassembly parameters """
3166 return self.api(self.papi.ip_reassembly_set,
3168 'timeout_ms': timeout_ms,
3169 'expire_walk_interval_ms': expire_walk_interval_ms,
3170 'max_reassemblies': max_reassemblies})
3172 def ip_reassembly_get(self, is_ip6=0):
3173 """ Get IP reassembly parameters """
3174 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3176 def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
3177 """ GBP endpoint Add/Del """
3178 return self.api(self.papi.gbp_endpoint_add_del,
3182 'sw_if_index': sw_if_index,
3186 def gbp_endpoint_dump(self):
3187 """ GBP endpoint Dump """
3188 return self.api(self.papi.gbp_endpoint_dump, {})
3190 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3191 """ GBP contract Add/Del """
3192 return self.api(self.papi.gbp_contract_add_del,
3195 'acl_index': acl_index,
3197 'dst_epg': dst_epg}})
3199 def gbp_contract_dump(self):
3200 """ GBP contract Dump """
3201 return self.api(self.papi.gbp_contract_dump, {})