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 sw_interface_set_mac_address(self, sw_if_index, mac):
643 return self.api(self.papi.sw_interface_set_mac_address,
644 {'sw_if_index': sw_if_index,
647 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
648 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
649 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
650 """Create subinterface
651 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
653 :param sub_id: param inner_vlan:
657 :param no_tags: (Default value = 0)
658 :param one_tag: (Default value = 0)
659 :param two_tags: (Default value = 0)
660 :param dot1ad: (Default value = 0)
661 :param exact_match: (Default value = 0)
662 :param default_sub: (Default value = 0)
663 :param outer_vlan_id_any: (Default value = 0)
664 :param inner_vlan_id_any: (Default value = 0)
668 self.papi.create_subif,
669 {'sw_if_index': sw_if_index,
673 'two_tags': two_tags,
675 'exact_match': exact_match,
676 'default_sub': default_sub,
677 'outer_vlan_id_any': outer_vlan_id_any,
678 'inner_vlan_id_any': inner_vlan_id_any,
679 'outer_vlan_id': outer_vlan,
680 'inner_vlan_id': inner_vlan})
682 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
683 """Create p2p ethernet subinterface
685 :param sw_if_index: main (parent) interface
686 :param remote_mac: client (remote) mac address
690 self.papi.p2p_ethernet_add,
691 {'parent_if_index': sw_if_index,
692 'remote_mac': remote_mac,
693 'subif_id': subif_id})
695 def delete_subif(self, sw_if_index):
696 """Delete subinterface
700 return self.api(self.papi.delete_subif,
701 {'sw_if_index': sw_if_index})
703 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
704 """Delete p2p ethernet subinterface
706 :param sw_if_index: main (parent) interface
707 :param remote_mac: client (remote) mac address
711 self.papi.p2p_ethernet_del,
712 {'parent_if_index': sw_if_index,
713 'remote_mac': remote_mac})
715 def create_vlan_subif(self, sw_if_index, vlan):
722 return self.api(self.papi.create_vlan_subif,
723 {'sw_if_index': sw_if_index,
726 def create_loopback(self, mac=''):
729 :param mac: (Optional)
731 return self.api(self.papi.create_loopback,
732 {'mac_address': mac})
734 def delete_loopback(self, sw_if_index):
735 return self.api(self.papi.delete_loopback,
736 {'sw_if_index': sw_if_index, })
738 def ip_table_add_del(self,
745 :param is_add: (Default value = 1)
746 :param is_ipv6: (Default value = 0)
751 self.papi.ip_table_add_del,
752 {'table_id': table_id,
756 def ip_add_del_route(
761 next_hop_sw_if_index=0xFFFFFFFF,
765 next_hop_n_out_labels=0,
766 next_hop_out_label_stack=[],
767 next_hop_via_label=MPLS_LABEL_INVALID,
768 next_hop_id=0xFFFFFFFF,
770 is_resolve_attached=0,
771 classify_table_index=0xFFFFFFFF,
785 :param dst_address_length:
786 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
788 :param next_hop_address:
789 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
790 :param vrf_id: (Default value = 0)
791 :param lookup_in_vrf: (Default value = 0)
792 :param classify_table_index: (Default value = 0xFFFFFFFF)
793 :param is_add: (Default value = 1)
794 :param is_drop: (Default value = 0)
795 :param is_ipv6: (Default value = 0)
796 :param is_local: (Default value = 0)
797 :param is_classify: (Default value = 0)
798 :param is_multipath: (Default value = 0)
799 :param is_resolve_host: (Default value = 0)
800 :param is_resolve_attached: (Default value = 0)
801 :param is_dvr: (Default value = 0)
802 :param is_source_lookup: (Default value = 0)
803 :param next_hop_weight: (Default value = 1)
808 self.papi.ip_add_del_route,
809 {'next_hop_sw_if_index': next_hop_sw_if_index,
810 'table_id': table_id,
811 'classify_table_index': classify_table_index,
812 'next_hop_table_id': next_hop_table_id,
815 'is_unreach': is_unreach,
816 'is_prohibit': is_prohibit,
818 'is_local': is_local,
819 'is_classify': is_classify,
820 'is_multipath': is_multipath,
821 'is_resolve_host': is_resolve_host,
822 'is_resolve_attached': is_resolve_attached,
824 'is_source_lookup': is_source_lookup,
825 'is_udp_encap': is_udp_encap,
826 'next_hop_weight': next_hop_weight,
827 'dst_address_length': dst_address_length,
828 'dst_address': dst_address,
829 'next_hop_id': next_hop_id,
830 'next_hop_address': next_hop_address,
831 'next_hop_n_out_labels': next_hop_n_out_labels,
832 'next_hop_via_label': next_hop_via_label,
833 'next_hop_out_label_stack': next_hop_out_label_stack})
835 def ip_fib_dump(self):
836 return self.api(self.papi.ip_fib_dump, {})
838 def ip6_fib_dump(self):
839 return self.api(self.papi.ip6_fib_dump, {})
841 def ip_neighbor_add_del(self,
850 """ Add neighbor MAC to IPv4 or IPv6 address.
855 :param is_add: (Default value = 1)
856 :param is_ipv6: (Default value = 0)
857 :param is_static: (Default value = 0)
858 :param is_no_adj_fib: (Default value = 0)
862 self.papi.ip_neighbor_add_del,
863 {'sw_if_index': sw_if_index,
866 'is_static': is_static,
867 'is_no_adj_fib': is_no_adj_fib,
868 'mac_address': mac_address,
869 'dst_address': dst_address
873 def ip_neighbor_dump(self,
876 """ Return IP neighbor dump.
879 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
883 self.papi.ip_neighbor_dump,
885 'sw_if_index': sw_if_index
889 def proxy_arp_add_del(self,
894 """ Config Proxy Arp Range.
896 :param low_address: Start address in the rnage to Proxy for
897 :param hi_address: End address in the rnage to Proxy for
898 :param vrf_id: The VRF/table in which to proxy
902 self.papi.proxy_arp_add_del,
905 'low_address': low_address,
906 'hi_address': hi_address,
910 def proxy_arp_intfc_enable_disable(self,
913 """ Enable/Disable an interface for proxy ARP requests
915 :param sw_if_index: Interface
916 :param enable_disable: Enable/Disable
920 self.papi.proxy_arp_intfc_enable_disable,
921 {'sw_if_index': sw_if_index,
922 'enable_disable': is_enable
930 """ Reset VRF (remove all routes etc.) request.
932 :param int vrf_id: ID of the FIB table / VRF to reset.
933 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
947 """ Reset VRF (remove all routes etc.) request.
949 :param int vrf_id: ID of the FIB table / VRF to reset.
950 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
965 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
974 def sw_interface_span_enable_disable(
975 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
978 :param sw_if_index_from:
979 :param sw_if_index_to:
983 return self.api(self.papi.sw_interface_span_enable_disable,
984 {'sw_if_index_from': sw_if_index_from,
985 'sw_if_index_to': sw_if_index_to,
990 def gre_tunnel_add_del(self,
1003 :param outer_fib_id: (Default value = 0)
1004 :param tunnel_type: (Default value = 0)
1005 :param instance: (Default value = 0xFFFFFFFF)
1006 :param session_id: (Defalt value = 0)
1007 :param is_add: (Default value = 1)
1008 :param is_ipv6: (Default value = 0)
1012 self.papi.gre_add_del_tunnel,
1015 'tunnel_type': tunnel_type,
1016 'instance': instance,
1017 'src_address': src_address,
1018 'dst_address': dst_address,
1019 'outer_fib_id': outer_fib_id,
1020 'session_id': session_id}
1023 def udp_encap_add_del(self,
1032 """ Add a GRE tunnel
1033 :param id: user provided ID
1038 :param outer_fib_id: (Default value = 0)
1039 :param is_add: (Default value = 1)
1040 :param is_ipv6: (Default value = 0)
1044 self.papi.udp_encap_add_del,
1050 'src_port': src_port,
1051 'dst_port': dst_port,
1052 'table_id': table_id}
1055 def udp_encap_dump(self):
1056 return self.api(self.papi.udp_encap_dump, {})
1058 def mpls_fib_dump(self):
1059 return self.api(self.papi.mpls_fib_dump, {})
1061 def mpls_table_add_del(
1068 :param is_add: (Default value = 1)
1073 self.papi.mpls_table_add_del,
1074 {'mt_table_id': table_id,
1075 'mt_is_add': is_add})
1077 def mpls_route_add_del(
1083 next_hop_sw_if_index=0xFFFFFFFF,
1085 next_hop_table_id=0,
1087 next_hop_n_out_labels=0,
1088 next_hop_out_label_stack=[],
1089 next_hop_via_label=MPLS_LABEL_INVALID,
1091 is_resolve_attached=0,
1098 classify_table_index=0xFFFFFFFF,
1102 :param dst_address_length:
1103 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1105 :param next_hop_address:
1106 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1107 :param vrf_id: (Default value = 0)
1108 :param lookup_in_vrf: (Default value = 0)
1109 :param classify_table_index: (Default value = 0xFFFFFFFF)
1110 :param is_add: (Default value = 1)
1111 :param is_drop: (Default value = 0)
1112 :param is_ipv6: (Default value = 0)
1113 :param is_local: (Default value = 0)
1114 :param is_classify: (Default value = 0)
1115 :param is_multipath: (Default value = 0)
1116 :param is_multicast: (Default value = 0)
1117 :param is_resolve_host: (Default value = 0)
1118 :param is_resolve_attached: (Default value = 0)
1119 :param next_hop_weight: (Default value = 1)
1124 self.papi.mpls_route_add_del,
1127 'mr_table_id': table_id,
1128 'mr_classify_table_index': classify_table_index,
1129 'mr_is_add': is_add,
1130 'mr_is_classify': is_classify,
1131 'mr_is_multipath': is_multipath,
1132 'mr_is_multicast': is_multicast,
1133 'mr_is_resolve_host': is_resolve_host,
1134 'mr_is_resolve_attached': is_resolve_attached,
1135 'mr_is_interface_rx': is_interface_rx,
1136 'mr_is_rpf_id': is_rpf_id,
1137 'mr_next_hop_proto': next_hop_proto,
1138 'mr_next_hop_weight': next_hop_weight,
1139 'mr_next_hop': next_hop_address,
1140 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1141 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1142 'mr_next_hop_table_id': next_hop_table_id,
1143 'mr_next_hop_via_label': next_hop_via_label,
1144 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1146 def mpls_ip_bind_unbind(
1158 self.papi.mpls_ip_bind_unbind,
1159 {'mb_mpls_table_id': table_id,
1161 'mb_ip_table_id': ip_table_id,
1162 'mb_is_bind': is_bind,
1163 'mb_is_ip4': is_ip4,
1164 'mb_address_length': dst_address_length,
1165 'mb_address': dst_address})
1167 def mpls_tunnel_add_del(
1170 next_hop_proto_is_ip4,
1172 next_hop_sw_if_index=0xFFFFFFFF,
1173 next_hop_table_id=0,
1175 next_hop_n_out_labels=0,
1176 next_hop_out_label_stack=[],
1177 next_hop_via_label=MPLS_LABEL_INVALID,
1183 :param dst_address_length:
1184 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1186 :param next_hop_address:
1187 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1188 :param vrf_id: (Default value = 0)
1189 :param lookup_in_vrf: (Default value = 0)
1190 :param classify_table_index: (Default value = 0xFFFFFFFF)
1191 :param is_add: (Default value = 1)
1192 :param is_drop: (Default value = 0)
1193 :param is_ipv6: (Default value = 0)
1194 :param is_local: (Default value = 0)
1195 :param is_classify: (Default value = 0)
1196 :param is_multipath: (Default value = 0)
1197 :param is_resolve_host: (Default value = 0)
1198 :param is_resolve_attached: (Default value = 0)
1199 :param next_hop_weight: (Default value = 1)
1200 :param is_multicast: (Default value = 0)
1204 self.papi.mpls_tunnel_add_del,
1205 {'mt_sw_if_index': tun_sw_if_index,
1206 'mt_is_add': is_add,
1207 'mt_l2_only': l2_only,
1208 'mt_is_multicast': is_multicast,
1209 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1210 'mt_next_hop_weight': next_hop_weight,
1211 'mt_next_hop': next_hop_address,
1212 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1213 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1214 'mt_next_hop_table_id': next_hop_table_id,
1215 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1217 def nat44_interface_add_del_feature(
1222 """Enable/disable NAT44 feature on the interface
1224 :param sw_if_index: Software index of the interface
1225 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1226 :param is_add: 1 if add, 0 if delete (Default value = 1)
1229 self.papi.nat44_interface_add_del_feature,
1231 'is_inside': is_inside,
1232 'sw_if_index': sw_if_index})
1234 def nat44_interface_add_del_output_feature(
1239 """Enable/disable NAT44 output feature on the interface
1241 :param sw_if_index: Software index of the interface
1242 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1243 :param is_add: 1 if add, 0 if delete (Default value = 1)
1246 self.papi.nat44_interface_add_del_output_feature,
1248 'is_inside': is_inside,
1249 'sw_if_index': sw_if_index})
1251 def nat44_add_del_static_mapping(
1255 external_sw_if_index=0xFFFFFFFF,
1265 """Add/delete NAT44 static mapping
1267 :param local_ip: Local IP address
1268 :param external_ip: External IP address
1269 :param external_sw_if_index: External interface instead of IP address
1270 :param local_port: Local port number (Default value = 0)
1271 :param external_port: External port number (Default value = 0)
1272 :param addr_only: 1 if address only mapping, 0 if address and port
1273 :param vrf_id: VRF ID
1274 :param protocol: IP protocol (Default value = 0)
1275 :param twice_nat: 1 if translate external host address and port
1276 :param out2in_only: if 1 rule is matching only out2in direction
1277 :param tag: Opaque string tag
1278 :param is_add: 1 if add, 0 if delete (Default value = 1)
1281 self.papi.nat44_add_del_static_mapping,
1283 'addr_only': addr_only,
1284 'local_ip_address': local_ip,
1285 'external_ip_address': external_ip,
1286 'local_port': local_port,
1287 'external_port': external_port,
1288 'external_sw_if_index': external_sw_if_index,
1290 'protocol': protocol,
1291 'twice_nat': twice_nat,
1292 'out2in_only': out2in_only,
1295 def nat44_add_del_identity_mapping(
1298 sw_if_index=0xFFFFFFFF,
1305 """Add/delete NAT44 identity mapping
1307 :param ip: IP address (Default value = 0)
1308 :param sw_if_index: Interface instead of IP address
1309 :param port: Port number (Default value = 0)
1310 :param addr_only: 1 if address only mapping, 0 if address and port
1311 :param vrf_id: VRF ID
1312 :param protocol: IP protocol (Default value = 0)
1313 :param tag: Opaque string tag
1314 :param is_add: 1 if add, 0 if delete (Default value = 1)
1317 self.papi.nat44_add_del_identity_mapping,
1319 'addr_only': addr_only,
1322 'sw_if_index': sw_if_index,
1325 'protocol': protocol})
1327 def nat44_add_del_address_range(
1334 """Add/del NAT44 address range
1336 :param first_ip_address: First IP address
1337 :param last_ip_address: Last IP address
1338 :param vrf_id: VRF id for the address range
1339 :param twice_nat: twice NAT address for extenal hosts
1340 :param is_add: 1 if add, 0 if delete (Default value = 1)
1343 self.papi.nat44_add_del_address_range,
1344 {'first_ip_address': first_ip_address,
1345 'last_ip_address': last_ip_address,
1347 'twice_nat': twice_nat,
1350 def nat44_address_dump(self):
1351 """Dump NAT44 addresses
1352 :return: Dictionary of NAT44 addresses
1354 return self.api(self.papi.nat44_address_dump, {})
1356 def nat44_interface_dump(self):
1357 """Dump interfaces with NAT44 feature
1358 :return: Dictionary of interfaces with NAT44 feature
1360 return self.api(self.papi.nat44_interface_dump, {})
1362 def nat44_interface_output_feature_dump(self):
1363 """Dump interfaces with NAT44 output feature
1364 :return: Dictionary of interfaces with NAT44 output feature
1366 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1368 def nat44_static_mapping_dump(self):
1369 """Dump NAT44 static mappings
1370 :return: Dictionary of NAT44 static mappings
1372 return self.api(self.papi.nat44_static_mapping_dump, {})
1374 def nat44_identity_mapping_dump(self):
1375 """Dump NAT44 identity mappings
1376 :return: Dictionary of NAT44 identity mappings
1378 return self.api(self.papi.nat44_identity_mapping_dump, {})
1380 def nat_show_config(self):
1381 """Show NAT plugin config
1382 :return: NAT plugin config parameters
1384 return self.api(self.papi.nat_show_config, {})
1386 def nat44_add_interface_addr(
1391 """Add/del NAT44 address from interface
1393 :param sw_if_index: Software index of the interface
1394 :param twice_nat: twice NAT address for extenal hosts
1395 :param is_add: 1 if add, 0 if delete (Default value = 1)
1398 self.papi.nat44_add_del_interface_addr,
1400 'sw_if_index': sw_if_index,
1401 'twice_nat': twice_nat})
1403 def nat44_interface_addr_dump(self):
1404 """Dump NAT44 addresses interfaces
1405 :return: Dictionary of NAT44 addresses interfaces
1407 return self.api(self.papi.nat44_interface_addr_dump, {})
1414 """Enable/disable NAT IPFIX logging
1416 :param domain_id: Observation domain ID (Default value = 1)
1417 :param src_port: Source port number (Default value = 4739)
1418 :param enable: 1 if enable, 0 if disable (Default value = 1)
1421 self.papi.nat_ipfix_enable_disable,
1422 {'domain_id': domain_id,
1423 'src_port': src_port,
1426 def nat44_user_session_dump(
1430 """Dump NAT44 user's sessions
1432 :param ip_address: ip adress of the user to be dumped
1433 :param cpu_index: cpu_index on which the user is
1434 :param vrf_id: VRF ID
1435 :return: Dictionary of S-NAT sessions
1438 self.papi.nat44_user_session_dump,
1439 {'ip_address': ip_address,
1442 def nat44_user_dump(self):
1445 :return: Dictionary of NAT44 users
1447 return self.api(self.papi.nat44_user_dump, {})
1449 def nat44_add_del_lb_static_mapping(
1461 """Add/delete NAT44 load balancing static mapping
1463 :param twice_nat: 1 if translate external host address and port
1464 :param tag: Opaque string tag
1465 :param is_add - 1 if add, 0 if delete
1468 self.papi.nat44_add_del_lb_static_mapping,
1470 'external_addr': external_addr,
1471 'external_port': external_port,
1472 'protocol': protocol,
1474 'twice_nat': twice_nat,
1475 'out2in_only': out2in_only,
1477 'local_num': local_num,
1480 def nat44_lb_static_mapping_dump(self):
1481 """Dump NAT44 load balancing static mappings
1483 :return: Dictionary of NAT44 load balancing static mapping
1485 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1487 def nat44_del_session(
1494 """Delete NAT44 session
1496 :param addr: IPv4 address
1497 :param por: port number
1498 :param protocol: IP protocol number
1499 :param vrf_id: VRF ID
1500 :param is_in: 1 if inside network addres and port pari, 0 if outside
1503 self.papi.nat44_del_session,
1506 'protocol': protocol,
1510 def nat44_forwarding_enable_disable(
1513 """Enable/disable forwarding for NAT44
1515 :param enable: 1 for enable, 0 for disable
1518 self.papi.nat44_forwarding_enable_disable,
1528 """Set NAT virtual fragmentation reassembly
1530 :param timeout: reassembly timeout (Default 2sec)
1531 :param max_reass: maximum concurrent reassemblies (Default 1024)
1532 :param max_frag: maximum fragmets per reassembly (Default 5)
1533 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1534 :param is_ip6: 1 if IPv6, 0 if IPv4
1537 self.papi.nat_set_reass,
1538 {'timeout': timeout,
1539 'max_reass': max_reass,
1540 'max_frag': max_frag,
1541 'drop_frag': drop_frag,
1544 def nat_get_reass(self):
1545 """Get NAT virtual fragmentation reassembly configuration
1547 :return: NAT virtual fragmentation reassembly configuration
1549 return self.api(self.papi.nat_get_reass, {})
1551 def nat_reass_dump(self):
1552 """Dump NAT virtual fragmentation reassemblies
1554 :return: Dictionary of NAT virtual fragmentation reassemblies
1556 return self.api(self.papi.nat_reass_dump, {})
1558 def nat_det_add_del_map(
1565 """Add/delete deterministic NAT mapping
1567 :param is_add - 1 if add, 0 if delete
1568 :param in_addr - inside IP address
1569 :param in_plen - inside IP address prefix length
1570 :param out_addr - outside IP address
1571 :param out_plen - outside IP address prefix length
1574 self.papi.nat_det_add_del_map,
1579 'out_addr': out_addr,
1580 'out_plen': out_plen})
1582 def nat_det_forward(
1585 """Get outside address and port range from inside address
1587 :param in_addr - inside IP address
1590 self.papi.nat_det_forward,
1591 {'in_addr': in_addr,
1594 def nat_det_reverse(
1598 """Get inside address from outside address and port
1600 :param out_addr - outside IP address
1601 :param out_port - outside port
1604 self.papi.nat_det_reverse,
1605 {'out_addr': out_addr,
1606 'out_port': out_port})
1608 def nat_det_map_dump(self):
1609 """Dump deterministic NAT mappings
1611 :return: Dictionary of deterministic NAT mappings
1613 return self.api(self.papi.nat_det_map_dump, {})
1615 def nat_det_set_timeouts(
1618 tcp_established=7440,
1621 """Set values of timeouts for deterministic NAT (in seconds)
1623 :param udp - UDP timeout (Default value = 300)
1624 :param tcp_established - TCP established timeout (Default value = 7440)
1625 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1626 :param icmp - ICMP timeout (Default value = 60)
1629 self.papi.nat_det_set_timeouts,
1631 'tcp_established': tcp_established,
1632 'tcp_transitory': tcp_transitory,
1635 def nat_det_get_timeouts(self):
1636 """Get values of timeouts for deterministic NAT
1638 :return: Timeouts for deterministic NAT (in seconds)
1640 return self.api(self.papi.nat_det_get_timeouts, {})
1642 def nat_det_close_session_out(
1648 """Close deterministic NAT session using outside address and port
1650 :param out_addr - outside IP address
1651 :param out_port - outside port
1652 :param ext_addr - external host IP address
1653 :param ext_port - external host port
1656 self.papi.nat_det_close_session_out,
1657 {'out_addr': out_addr,
1658 'out_port': out_port,
1659 'ext_addr': ext_addr,
1660 'ext_port': ext_port})
1662 def nat_det_close_session_in(
1668 """Close deterministic NAT session using inside address and port
1670 :param in_addr - inside IP address
1671 :param in_port - inside port
1672 :param ext_addr - external host IP address
1673 :param ext_port - external host port
1676 self.papi.nat_det_close_session_in,
1677 {'in_addr': in_addr,
1679 'ext_addr': ext_addr,
1680 'ext_port': ext_port,
1683 def nat_det_session_dump(
1686 """Dump deterministic NAT sessions belonging to a user
1688 :param user_addr - inside IP address of the user
1689 :return: Dictionary of deterministic NAT sessions
1692 self.papi.nat_det_session_dump,
1694 'user_addr': user_addr})
1696 def nat64_add_del_pool_addr_range(
1702 """Add/del address range to NAT64 pool
1704 :param start_addr: First IP address
1705 :param end_addr: Last IP address
1706 :param vrf_id: VRF id for the address range
1707 :param is_add: 1 if add, 0 if delete (Default value = 1)
1710 self.papi.nat64_add_del_pool_addr_range,
1711 {'start_addr': start_addr,
1712 'end_addr': end_addr,
1716 def nat64_pool_addr_dump(self):
1717 """Dump NAT64 pool addresses
1718 :return: Dictionary of NAT64 pool addresses
1720 return self.api(self.papi.nat64_pool_addr_dump, {})
1722 def nat64_add_del_interface(
1727 """Enable/disable NAT64 feature on the interface
1728 :param sw_if_index: Index of the interface
1729 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1730 :param is_add: 1 if add, 0 if delete (Default value = 1)
1733 self.papi.nat64_add_del_interface,
1734 {'sw_if_index': sw_if_index,
1735 'is_inside': is_inside,
1738 def nat64_interface_dump(self):
1739 """Dump interfaces with NAT64 feature
1740 :return: Dictionary of interfaces with NAT64 feature
1742 return self.api(self.papi.nat64_interface_dump, {})
1744 def nat64_add_del_static_bib(
1753 """Add/delete S-NAT static BIB entry
1755 :param in_ip: Inside IPv6 address
1756 :param out_ip: Outside IPv4 address
1757 :param in_port: Inside port number
1758 :param out_port: Outside port number
1759 :param protocol: IP protocol
1760 :param vrf_id: VRF ID (Default value = 0)
1761 :param is_add: 1 if add, 0 if delete (Default value = 1)
1764 self.papi.nat64_add_del_static_bib,
1773 def nat64_bib_dump(self, protocol=255):
1776 :param protocol: IP protocol (Default value = 255, all BIBs)
1777 :returns: Dictionary of NAT64 BIB entries
1779 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1781 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1782 tcp_incoming_syn=6):
1783 """Set values of timeouts for NAT64 (in seconds)
1785 :param udpi: UDP timeout (Default value = 300)
1786 :param icmp: ICMP timeout (Default value = 60)
1787 :param tcp_trans: TCP transitory timeout (Default value = 240)
1788 :param tcp_est: TCP established timeout (Default value = 7440)
1789 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1792 self.papi.nat64_set_timeouts,
1795 'tcp_trans': tcp_trans,
1797 'tcp_incoming_syn': tcp_incoming_syn})
1799 def nat64_get_timeouts(self):
1800 """Get values of timeouts for NAT64
1802 :return: Timeouts for NAT64 (in seconds)
1804 return self.api(self.papi.nat64_get_timeouts, {})
1806 def nat64_st_dump(self, protocol=255):
1807 """Dump NAT64 session table
1809 :param protocol: IP protocol (Default value = 255, all STs)
1810 :returns: Dictionary of NAT64 sesstion table entries
1812 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1814 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1815 """Add/del NAT64 prefix
1817 :param prefix: NAT64 prefix
1818 :param plen: NAT64 prefix length
1819 :param vrf_id: VRF id of tenant (Default 0)
1820 :param is_add: 1 if add, 0 if delete (Default value = 1)
1823 self.papi.nat64_add_del_prefix,
1829 def nat64_prefix_dump(self):
1830 """Dump NAT64 prefix
1832 :returns: Dictionary of NAT64 prefixes
1834 return self.api(self.papi.nat64_prefix_dump, {})
1836 def nat64_add_interface_addr(
1840 """Add/del NAT64 address from interface
1842 :param sw_if_index: Software index of the interface
1843 :param is_add: 1 if add, 0 if delete (Default value = 1)
1845 return self.api(self.papi.nat64_add_del_interface_addr,
1846 {'is_add': is_add, 'sw_if_index': sw_if_index})
1848 def dslite_set_aftr_addr(self, ip6, ip4):
1849 """Set DS-Lite AFTR addresses
1851 :param ip4: IPv4 address
1852 :param ip6: IPv6 address
1855 self.papi.dslite_set_aftr_addr,
1859 def dslite_set_b4_addr(self, ip6, ip4):
1860 """Set DS-Lite B4 IPv6 address
1862 :param ip4: IPv4 address
1863 :param ip6: IPv6 address
1866 self.papi.dslite_set_b4_addr,
1870 def dslite_add_del_pool_addr_range(
1875 """Add/del address range to DS-Lite pool
1877 :param start_addr: First IP address
1878 :param end_addr: Last IP address
1879 :param is_add: 1 if add, 0 if delete (Default value = 1)
1882 self.papi.dslite_add_del_pool_addr_range,
1883 {'start_addr': start_addr,
1884 'end_addr': end_addr,
1887 def nat66_add_del_interface(
1892 """Enable/disable NAT66 feature on the interface
1893 :param sw_if_index: Index of the interface
1894 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1895 :param is_add: 1 if add, 0 if delete (Default value = 1)
1898 self.papi.nat66_add_del_interface,
1899 {'sw_if_index': sw_if_index,
1900 'is_inside': is_inside,
1903 def nat66_add_del_static_mapping(
1909 """Add/delete NAT66 static mapping
1911 :param in_ip: Inside IPv6 address
1912 :param out_ip: Outside IPv6 address
1913 :param vrf_id: VRF ID (Default value = 0)
1914 :param is_add: 1 if add, 0 if delete (Default value = 1)
1917 self.papi.nat66_add_del_static_mapping,
1918 {'local_ip_address': in_ip,
1919 'external_ip_address': out_ip,
1923 def nat66_interface_dump(self):
1924 """Dump interfaces with NAT66 feature
1925 :return: Dictionary of interfaces with NAT66 feature
1927 return self.api(self.papi.nat66_interface_dump, {})
1929 def nat66_static_mapping_dump(self):
1930 """Dump NAT66 static mappings
1931 :return: Dictionary of NAT66 static mappings
1933 return self.api(self.papi.nat66_static_mapping_dump, {})
1935 def control_ping(self):
1936 self.api(self.papi.control_ping)
1938 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1939 detect_mult, local_addr, peer_addr, is_ipv6=0,
1940 bfd_key_id=None, conf_key_id=None):
1941 if bfd_key_id is None:
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,
1953 return self.api(self.papi.bfd_udp_add,
1955 'sw_if_index': sw_if_index,
1956 'desired_min_tx': desired_min_tx,
1957 'required_min_rx': required_min_rx,
1958 'local_addr': local_addr,
1959 'peer_addr': peer_addr,
1961 'detect_mult': detect_mult,
1962 'is_authenticated': 1,
1963 'bfd_key_id': bfd_key_id,
1964 'conf_key_id': conf_key_id,
1967 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1968 detect_mult, local_addr, peer_addr, is_ipv6=0):
1969 return self.api(self.papi.bfd_udp_mod,
1971 'sw_if_index': sw_if_index,
1972 'desired_min_tx': desired_min_tx,
1973 'required_min_rx': required_min_rx,
1974 'local_addr': local_addr,
1975 'peer_addr': peer_addr,
1977 'detect_mult': detect_mult,
1980 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1981 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1983 return self.api(self.papi.bfd_udp_auth_activate,
1985 'sw_if_index': sw_if_index,
1986 'local_addr': local_addr,
1987 'peer_addr': peer_addr,
1989 'is_delayed': 1 if is_delayed else 0,
1990 'bfd_key_id': bfd_key_id,
1991 'conf_key_id': conf_key_id,
1994 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1995 is_ipv6=0, is_delayed=False):
1996 return self.api(self.papi.bfd_udp_auth_deactivate,
1998 'sw_if_index': sw_if_index,
1999 'local_addr': local_addr,
2000 'peer_addr': peer_addr,
2002 'is_delayed': 1 if is_delayed else 0,
2005 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2006 return self.api(self.papi.bfd_udp_del,
2008 'sw_if_index': sw_if_index,
2009 'local_addr': local_addr,
2010 'peer_addr': peer_addr,
2014 def bfd_udp_session_dump(self):
2015 return self.api(self.papi.bfd_udp_session_dump, {})
2017 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2018 peer_addr, is_ipv6=0):
2019 return self.api(self.papi.bfd_udp_session_set_flags, {
2020 'admin_up_down': admin_up_down,
2021 'sw_if_index': sw_if_index,
2022 'local_addr': local_addr,
2023 'peer_addr': peer_addr,
2027 def want_bfd_events(self, enable_disable=1):
2028 return self.api(self.papi.want_bfd_events, {
2029 'enable_disable': enable_disable,
2033 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2034 return self.api(self.papi.bfd_auth_set_key, {
2035 'conf_key_id': conf_key_id,
2036 'auth_type': auth_type,
2038 'key_len': len(key),
2041 def bfd_auth_del_key(self, conf_key_id):
2042 return self.api(self.papi.bfd_auth_del_key, {
2043 'conf_key_id': conf_key_id,
2046 def bfd_auth_keys_dump(self):
2047 return self.api(self.papi.bfd_auth_keys_dump, {})
2049 def bfd_udp_set_echo_source(self, sw_if_index):
2050 return self.api(self.papi.bfd_udp_set_echo_source,
2051 {'sw_if_index': sw_if_index})
2053 def bfd_udp_del_echo_source(self):
2054 return self.api(self.papi.bfd_udp_del_echo_source, {})
2056 def classify_add_del_table(
2061 table_index=0xFFFFFFFF,
2063 memory_size=2097152,
2065 next_table_index=0xFFFFFFFF,
2066 miss_next_index=0xFFFFFFFF,
2067 current_data_flag=0,
2068 current_data_offset=0):
2072 :param match_n_vectors: (Default value = 1)
2073 :param table_index: (Default value = 0xFFFFFFFF)
2074 :param nbuckets: (Default value = 2)
2075 :param memory_size: (Default value = 2097152)
2076 :param skip_n_vectors: (Default value = 0)
2077 :param next_table_index: (Default value = 0xFFFFFFFF)
2078 :param miss_next_index: (Default value = 0xFFFFFFFF)
2079 :param current_data_flag: (Default value = 0)
2080 :param current_data_offset: (Default value = 0)
2084 self.papi.classify_add_del_table,
2086 'table_index': table_index,
2087 'nbuckets': nbuckets,
2088 'memory_size': memory_size,
2089 'skip_n_vectors': skip_n_vectors,
2090 'match_n_vectors': match_n_vectors,
2091 'next_table_index': next_table_index,
2092 'miss_next_index': miss_next_index,
2093 'current_data_flag': current_data_flag,
2094 'current_data_offset': current_data_offset,
2097 def classify_add_del_session(
2102 opaque_index=0xFFFFFFFF,
2103 hit_next_index=0xFFFFFFFF,
2111 :param opaque_index: (Default value = 0xFFFFFFFF)
2112 :param hit_next_index: (Default value = 0xFFFFFFFF)
2113 :param advance: (Default value = 0)
2114 :param action: (Default value = 0)
2115 :param metadata: (Default value = 0)
2119 self.papi.classify_add_del_session,
2121 'table_index': table_index,
2122 'hit_next_index': hit_next_index,
2123 'opaque_index': opaque_index,
2126 'metadata': metadata,
2129 def input_acl_set_interface(
2133 ip4_table_index=0xFFFFFFFF,
2134 ip6_table_index=0xFFFFFFFF,
2135 l2_table_index=0xFFFFFFFF):
2139 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2140 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2141 :param l2_table_index: (Default value = 0xFFFFFFFF)
2145 self.papi.input_acl_set_interface,
2146 {'sw_if_index': sw_if_index,
2147 'ip4_table_index': ip4_table_index,
2148 'ip6_table_index': ip6_table_index,
2149 'l2_table_index': l2_table_index,
2152 def output_acl_set_interface(
2156 ip4_table_index=0xFFFFFFFF,
2157 ip6_table_index=0xFFFFFFFF,
2158 l2_table_index=0xFFFFFFFF):
2162 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2163 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2164 :param l2_table_index: (Default value = 0xFFFFFFFF)
2168 self.papi.output_acl_set_interface,
2169 {'sw_if_index': sw_if_index,
2170 'ip4_table_index': ip4_table_index,
2171 'ip6_table_index': ip6_table_index,
2172 'l2_table_index': l2_table_index,
2175 def set_ipfix_exporter(
2182 collector_port=4739,
2185 self.papi.set_ipfix_exporter,
2187 'collector_address': collector_address,
2188 'collector_port': collector_port,
2189 'src_address': src_address,
2191 'path_mtu': path_mtu,
2192 'template_interval': template_interval,
2193 'udp_checksum': udp_checksum,
2196 def dhcp_proxy_config(self,
2204 self.papi.dhcp_proxy_config,
2206 'rx_vrf_id': rx_table_id,
2207 'server_vrf_id': server_table_id,
2210 'dhcp_server': dhcp_server,
2211 'dhcp_src_address': dhcp_src_address,
2214 def dhcp_proxy_set_vss(self,
2223 self.papi.dhcp_proxy_set_vss,
2226 'vss_type': vss_type,
2227 'vpn_ascii_id': vpn_ascii_id,
2229 'vpn_index': vpn_index,
2234 def dhcp_client(self,
2239 set_broadcast_flag=1,
2240 want_dhcp_events=0):
2242 self.papi.dhcp_client_config,
2244 'sw_if_index': sw_if_index,
2245 'hostname': hostname,
2246 'client_id': client_id,
2248 'want_dhcp_event': want_dhcp_events,
2249 'set_broadcast_flag': set_broadcast_flag,
2253 def ip_mroute_add_del(self,
2259 next_hop_sw_if_index,
2268 IP Multicast Route add/del
2271 self.papi.ip_mroute_add_del,
2272 {'next_hop_sw_if_index': next_hop_sw_if_index,
2273 'entry_flags': e_flags,
2274 'itf_flags': i_flags,
2275 'table_id': table_id,
2279 'is_local': is_local,
2280 'bier_imp': bier_imp,
2281 'next_hop_afi': next_hop_afi,
2282 'grp_address_length': grp_address_length,
2283 'grp_address': grp_address,
2284 'src_address': src_address})
2286 def mfib_signal_dump(self):
2287 return self.api(self.papi.mfib_signal_dump, {})
2289 def ip_mfib_dump(self):
2290 return self.api(self.papi.ip_mfib_dump, {})
2292 def ip6_mfib_dump(self):
2293 return self.api(self.papi.ip6_mfib_dump, {})
2295 def lisp_enable_disable(self, is_enabled):
2297 self.papi.lisp_enable_disable,
2299 'is_en': is_enabled,
2302 def lisp_locator_set(self,
2306 self.papi.lisp_add_del_locator_set,
2309 'locator_set_name': ls_name
2312 def lisp_locator_set_dump(self):
2313 return self.api(self.papi.lisp_locator_set_dump, {})
2315 def lisp_locator(self,
2322 self.papi.lisp_add_del_locator,
2325 'locator_set_name': ls_name,
2326 'sw_if_index': sw_if_index,
2327 'priority': priority,
2331 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2333 self.papi.lisp_locator_dump,
2335 'is_index_set': is_index_set,
2337 'ls_index': ls_index,
2340 def lisp_local_mapping(self,
2350 self.papi.lisp_add_del_local_eid,
2352 'locator_set_name': ls_name,
2354 'eid_type': eid_type,
2356 'prefix_len': prefix_len,
2362 def lisp_eid_table_dump(self,
2370 self.papi.lisp_eid_table_dump,
2373 'prefix_length': prefix_length,
2375 'eid_type': eid_type,
2377 'filter': filter_opt,
2380 def lisp_remote_mapping(self,
2390 self.papi.lisp_add_del_remote_mapping,
2393 'eid_type': eid_type,
2395 'eid_len': eid_prefix_len,
2396 'rloc_num': rlocs_num,
2399 'is_src_dst': is_src_dst,
2402 def lisp_adjacency(self,
2411 self.papi.lisp_add_del_adjacency,
2415 'eid_type': eid_type,
2418 'leid_len': leid_len,
2419 'reid_len': reid_len,
2422 def lisp_adjacencies_get(self, vni=0):
2424 self.papi.lisp_adjacencies_get,
2429 def map_add_domain(self,
2443 self.papi.map_add_domain,
2445 'ip6_prefix': ip6_prefix,
2446 'ip6_prefix_len': ip6_prefix_len,
2447 'ip4_prefix': ip4_prefix,
2448 'ip4_prefix_len': ip4_prefix_len,
2450 'ip6_src_prefix_len': ip6_src_prefix_len,
2451 'ea_bits_len': ea_bits_len,
2452 'psid_offset': psid_offset,
2453 'psid_length': psid_length,
2454 'is_translation': is_translation,
2455 'is_rfc6052': is_rfc6052,
2459 def gtpu_add_del_tunnel(
2465 mcast_sw_if_index=0xFFFFFFFF,
2467 decap_next_index=0xFFFFFFFF,
2471 :param is_add: (Default value = 1)
2472 :param is_ipv6: (Default value = 0)
2475 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2476 :param encap_vrf_id: (Default value = 0)
2477 :param decap_next_index: (Default value = 0xFFFFFFFF)
2478 :param teid: (Default value = 0)
2481 return self.api(self.papi.gtpu_add_del_tunnel,
2484 'src_address': src_addr,
2485 'dst_address': dst_addr,
2486 'mcast_sw_if_index': mcast_sw_if_index,
2487 'encap_vrf_id': encap_vrf_id,
2488 'decap_next_index': decap_next_index,
2491 def vxlan_gpe_add_del_tunnel(
2495 mcast_sw_if_index=0xFFFFFFFF,
2506 :param is_add: (Default value = 1)
2507 :param is_ipv6: (Default value = 0)
2508 :param encap_vrf_id: (Default value = 0)
2509 :param decap_vrf_id: (Default value = 0)
2510 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2511 :param protocol: (Default value = 3)
2512 :param vni: (Default value = 0)
2515 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2520 'mcast_sw_if_index': mcast_sw_if_index,
2521 'encap_vrf_id': encap_vrf_id,
2522 'decap_vrf_id': decap_vrf_id,
2523 'protocol': protocol,
2526 def pppoe_add_del_session(
2536 :param is_add: (Default value = 1)
2537 :param is_ipv6: (Default value = 0)
2539 :param session_id: (Default value = 0)
2541 :param decap_vrf_id: (Default value = 0)
2544 return self.api(self.papi.pppoe_add_del_session,
2547 'session_id': session_id,
2548 'client_ip': client_ip,
2549 'decap_vrf_id': decap_vrf_id,
2550 'client_mac': client_mac})
2552 def sr_localsid_add_del(self,
2558 sw_if_index=0xFFFFFFFF,
2562 """ Add/del IPv6 SR local-SID.
2564 :param localsid_addr:
2565 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2566 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2568 :param is_del: (Default value = 0)
2569 :param end_psp: (Default value = 0)
2570 :param sw_if_index: (Default value = 0xFFFFFFFF)
2571 :param vlan_index: (Default value = 0)
2572 :param fib_table: (Default value = 0)
2575 self.papi.sr_localsid_add_del,
2577 'localsid_addr': localsid_addr,
2579 'behavior': behavior,
2580 'sw_if_index': sw_if_index,
2581 'vlan_index': vlan_index,
2582 'fib_table': fib_table,
2597 :param bsid_addr: bindingSID of the SR Policy
2598 :param weight: weight of the sid list. optional. (default: 1)
2599 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2601 :param type: type/behavior of the SR policy. (default or spray) \
2603 :param fib_table: VRF where to install the FIB entry for the BSID \
2605 :param n_segments: number of segments \
2607 :param segments: a vector of IPv6 address composing the segment list \
2611 self.papi.sr_policy_add,
2612 {'bsid_addr': bsid_addr,
2614 'is_encap': is_encap,
2616 'fib_table': fib_table,
2617 'n_segments': n_segments,
2618 'segments': segments
2627 :param bsid: bindingSID of the SR Policy
2628 :param sr_policy_index: index of the sr policy (default: 0)
2631 self.papi.sr_policy_del,
2632 {'bsid_addr': bsid_addr,
2633 'sr_policy_index': sr_policy_index
2636 def sr_steering_add_del(
2647 Steer traffic L2 and L3 traffic through a given SR policy
2649 :param is_del: delete or add
2650 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2651 :param sr_policy: is the index of the SR Policy (alt to bsid)
2652 :param table_id: is the VRF where to install the FIB entry for the BSID
2653 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2654 :param mask_width: is the mask for L3 traffic type
2655 :param sw_if_index: is the incoming interface for L2 traffic
2656 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2659 self.papi.sr_steering_add_del,
2661 'bsid_addr': bsid_addr,
2662 'sr_policy_index': sr_policy_index,
2663 'table_id': table_id,
2664 'prefix_addr': prefix_addr,
2665 'mask_width': mask_width,
2666 'sw_if_index': sw_if_index,
2667 'traffic_type': traffic_type
2670 def acl_add_replace(self, acl_index, r, tag='',
2672 """Add/replace an ACL
2673 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2674 :param acl_rule r: ACL rules array.
2675 :param str tag: symbolic tag (description) for this ACL.
2676 :param int count: number of rules.
2678 return self.api(self.papi.acl_add_replace,
2679 {'acl_index': acl_index,
2683 expected_retval=expected_retval)
2685 def acl_del(self, acl_index, expected_retval=0):
2691 return self.api(self.papi.acl_del,
2692 {'acl_index': acl_index},
2693 expected_retval=expected_retval)
2695 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2697 return self.api(self.papi.acl_interface_set_acl_list,
2698 {'sw_if_index': sw_if_index,
2702 expected_retval=expected_retval)
2704 def acl_interface_set_etype_whitelist(self, sw_if_index,
2707 return self.api(self.papi.acl_interface_set_etype_whitelist,
2708 {'sw_if_index': sw_if_index,
2709 'count': len(whitelist),
2711 'whitelist': whitelist},
2712 expected_retval=expected_retval)
2714 def acl_interface_add_del(self,
2718 """ Add/Delete ACL to/from interface
2722 :param is_add: (Default value = 1)
2725 return self.api(self.papi.acl_interface_add_del,
2728 'sw_if_index': sw_if_index,
2729 'acl_index': acl_index})
2731 def acl_dump(self, acl_index, expected_retval=0):
2732 return self.api(self.papi.acl_dump,
2733 {'acl_index': acl_index},
2734 expected_retval=expected_retval)
2736 def macip_acl_add(self, rules, tag=""):
2739 :param rules: list of rules for given acl
2743 return self.api(self.papi.macip_acl_add,
2745 'count': len(rules),
2748 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2751 :param rules: list of rules for given acl
2755 return self.api(self.papi.macip_acl_add_replace,
2756 {'acl_index': acl_index,
2758 'count': len(rules),
2761 def macip_acl_del(self, acl_index):
2767 return self.api(self.papi.macip_acl_del,
2768 {'acl_index': acl_index})
2770 def macip_acl_interface_add_del(self,
2774 """ Add MACIP acl to interface
2778 :param is_add: (Default value = 1)
2781 return self.api(self.papi.macip_acl_interface_add_del,
2783 'sw_if_index': sw_if_index,
2784 'acl_index': acl_index})
2786 def macip_acl_interface_get(self):
2787 """ Return interface acls dump
2790 self.papi.macip_acl_interface_get, {})
2792 def macip_acl_dump(self, acl_index=4294967295):
2793 """ Return MACIP acl dump
2797 self.papi.macip_acl_dump, {'acl_index': acl_index})
2799 def policer_add_del(self,
2810 conform_action_type=1,
2812 exceed_action_type=0,
2814 violate_action_type=0,
2816 return self.api(self.papi.policer_add_del,
2823 'rate_type': rate_type,
2824 'round_type': round_type,
2826 'color_aware': color_aware,
2827 'conform_action_type': conform_action_type,
2828 'conform_dscp': conform_dscp,
2829 'exceed_action_type': exceed_action_type,
2830 'exceed_dscp': exceed_dscp,
2831 'violate_action_type': violate_action_type,
2832 'violate_dscp': violate_dscp})
2834 def ip_punt_police(self,
2838 return self.api(self.papi.ip_punt_police,
2839 {'policer_index': policer_index,
2843 def ip_punt_redirect(self,
2849 return self.api(self.papi.ip_punt_redirect,
2850 {'rx_sw_if_index': rx_sw_if_index,
2851 'tx_sw_if_index': tx_sw_if_index,
2856 def bier_table_add_del(self,
2860 """ BIER Table add/del """
2862 self.papi.bier_table_add_del,
2863 {'bt_tbl_id': {"bt_set": bti.set_id,
2864 "bt_sub_domain": bti.sub_domain_id,
2865 "bt_hdr_len_id": bti.hdr_len_id},
2866 'bt_label': mpls_label,
2867 'bt_is_add': is_add})
2869 def bier_table_dump(self):
2870 return self.api(self.papi.bier_table_dump, {})
2872 def bier_route_add_del(self,
2877 """ BIER Route add/del """
2880 br_paths.append({'next_hop': p.nh_addr,
2884 'table_id': p.nh_table_id,
2885 'next_hop_id': p.next_hop_id,
2886 'is_udp_encap': p.is_udp_encap,
2887 'n_labels': len(p.nh_labels),
2888 'label_stack': p.nh_labels})
2890 self.papi.bier_route_add_del,
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 'br_n_paths': len(br_paths),
2896 'br_paths': br_paths,
2897 'br_is_add': is_add})
2899 def bier_route_dump(self, bti):
2901 self.papi.bier_route_dump,
2902 {'br_tbl_id': {"bt_set": bti.set_id,
2903 "bt_sub_domain": bti.sub_domain_id,
2904 "bt_hdr_len_id": bti.hdr_len_id}})
2906 def bier_imp_add(self,
2911 """ BIER Imposition Add """
2913 self.papi.bier_imp_add,
2914 {'bi_tbl_id': {"bt_set": bti.set_id,
2915 "bt_sub_domain": bti.sub_domain_id,
2916 "bt_hdr_len_id": bti.hdr_len_id},
2918 'bi_n_bytes': len(ibytes),
2919 'bi_bytes': ibytes})
2921 def bier_imp_del(self, bi_index):
2922 """ BIER Imposition del """
2924 self.papi.bier_imp_del,
2925 {'bi_index': bi_index})
2927 def bier_imp_dump(self):
2928 return self.api(self.papi.bier_imp_dump, {})
2930 def bier_disp_table_add_del(self,
2933 """ BIER Disposition Table add/del """
2935 self.papi.bier_disp_table_add_del,
2936 {'bdt_tbl_id': bdti,
2937 'bdt_is_add': is_add})
2939 def bier_disp_table_dump(self):
2940 return self.api(self.papi.bier_disp_table_dump, {})
2942 def bier_disp_entry_add_del(self,
2952 """ BIER Route add/del """
2954 self.papi.bier_disp_entry_add_del,
2955 {'bde_tbl_id': bdti,
2957 'bde_payload_proto': payload_proto,
2959 'bde_paths': [{'next_hop': next_hop,
2960 'table_id': next_hop_tbl_id,
2961 'afi': next_hop_afi,
2962 'rpf_id': next_hop_rpf_id,
2964 'label_stack': [0]}],
2965 'bde_is_add': is_add})
2967 def bier_disp_entry_dump(self, bdti):
2969 self.papi.bier_disp_entry_dump,
2970 {'bde_tbl_id': bdti})
2972 def add_node_next(self, node_name, next_name):
2973 """ Set the next node for a given node request
2978 return self.api(self.papi.add_node_next,
2979 {'node_name': node_name,
2980 'next_name': next_name})
2982 def session_enable_disable(self, is_enabled):
2984 self.papi.session_enable_disable,
2985 {'is_enable': is_enabled})
2987 def ipsec_spd_add_del(self, spd_id, is_add=1):
2988 """ SPD add/del - Wrapper to add or del ipsec SPD
2989 Sample CLI : 'ipsec spd add 1'
2991 :param spd_id - SPD ID to be created in the vpp . mandatory
2992 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2994 :returns: reply from the API
2997 self.papi.ipsec_spd_add_del, {
2998 'spd_id': spd_id, 'is_add': is_add})
3000 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3001 """ IPSEC interface SPD add/del - \
3002 Wrapper to associate/disassociate SPD to interface in VPP
3003 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3005 :param spd_id - SPD ID to associate with the interface . mandatory
3006 :param sw_if_index - Interface Index which needs to ipsec \
3007 association mandatory
3008 :param is_add - add(1) or del(0) association with interface \
3009 (Default 1 - add) . optional
3010 :returns: reply from the API
3013 self.papi.ipsec_interface_add_del_spd, {
3015 'sw_if_index': sw_if_index, 'is_add': is_add})
3017 def ipsec_sad_add_del_entry(self,
3020 tunnel_src_address='',
3021 tunnel_dst_address='',
3023 integrity_algorithm=2,
3024 integrity_key_length=0,
3025 integrity_key='C91KUR9GYMm5GfkEvNjX',
3027 crypto_key_length=0,
3028 crypto_key='JPjyOWBeVEQiMe7h',
3031 """ IPSEC SA add/del
3032 Sample CLI : 'ipsec sa add 10 spi 1001 esp \
3033 crypto-key 4a506a794f574265564551694d653768 \
3034 crypto-alg aes-cbc-128 \
3035 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3036 integ-alg sha1-96 tunnel-src 192.168.100.3 \
3037 tunnel-dst 192.168.100.2'
3038 Sample CLI : 'ipsec sa add 20 spi 2001 \
3039 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
3042 :param sad_id - Security Association ID to be \
3043 created or deleted. mandatory
3044 :param spi - security param index of the SA in decimal. mandatory
3045 :param tunnel_src_address - incase of tunnel mode outer src address .\
3046 mandatory for tunnel mode
3047 :param tunnel_dst_address - incase of transport mode \
3048 outer dst address. mandatory for tunnel mode
3049 :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional
3050 :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\
3052 :param integrity_key - value in string \
3053 (Default C91KUR9GYMm5GfkEvNjX).optional
3054 :param integrity_key_length - length of the key string in bytes\
3055 (Default 0 - integrity disabled). optional
3056 :param crypto_algorithm - value range 1-11 Default \
3057 (1- AES_CBC_128).optional **
3058 :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional
3059 :param crypto_key_length - length of the key string in bytes\
3060 (Default 0 - crypto disabled). optional
3061 :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\
3063 :param is_tunnel - tunnel mode (1) or transport mode(0) \
3064 (Default 1 - tunnel). optional
3065 :returns: reply from the API
3066 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3067 crypto and ipsec algorithms
3070 self.papi.ipsec_sad_add_del_entry,
3073 'tunnel_src_address': tunnel_src_address,
3074 'tunnel_dst_address': tunnel_dst_address,
3075 'protocol': protocol,
3076 'integrity_algorithm': integrity_algorithm,
3077 'integrity_key_length': integrity_key_length,
3078 'integrity_key': integrity_key,
3079 'crypto_algorithm': crypto_algorithm,
3080 'crypto_key_length': crypto_key_length,
3081 'crypto_key': crypto_key,
3083 'is_tunnel': is_tunnel})
3085 def ipsec_spd_add_del_entry(self,
3087 local_address_start,
3089 remote_address_start,
3090 remote_address_stop,
3092 local_port_stop=65535,
3093 remote_port_start=0,
3094 remote_port_stop=65535,
3102 """ IPSEC policy SPD add/del -
3103 Wrapper to configure ipsec SPD policy entries in VPP
3104 Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \
3105 protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \
3106 remote-ip-range 192.168.3.3 - 192.168.3.3'
3108 :param spd_id - SPD ID for the policy . mandatory
3109 :param local_address_start - local-ip-range start address . mandatory
3110 :param local_address_stop - local-ip-range stop address . mandatory
3111 :param remote_address_start - remote-ip-range start address . mandatory
3112 :param remote_address_stop - remote-ip-range stop address . mandatory
3113 :param local_port_start - (Default 0) . optional
3114 :param local_port_stop - (Default 65535). optional
3115 :param remote_port_start - (Default 0). optional
3116 :param remote_port_stop - (Default 65535). optional
3117 :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any).
3119 :param sa_id - Security Association ID for mapping it to SPD
3120 (default 10). optional
3121 :param policy - bypass(0), discard(1), resolve(2) or protect(3)action
3122 (Default 0 - bypass). optional
3123 :param priotity - value for the spd action (Default 100). optional
3124 :param is_outbound - flag for inbound(0) or outbound(1)
3125 (Default 1 - outbound). optional
3126 :param is_add flag - for addition(1) or deletion(0) of the spd
3127 (Default 1 - addtion). optional
3128 :returns: reply from the API
3131 self.papi.ipsec_spd_add_del_entry,
3133 'local_address_start': local_address_start,
3134 'local_address_stop': local_address_stop,
3135 'remote_address_start': remote_address_start,
3136 'remote_address_stop': remote_address_stop,
3137 'local_port_start': local_port_start,
3138 'local_port_stop': local_port_stop,
3139 'remote_port_start': remote_port_start,
3140 'remote_port_stop': remote_port_stop,
3142 'protocol': protocol,
3144 'priority': priority,
3145 'is_outbound': is_outbound,
3147 'is_ip_any': is_ip_any})
3149 def app_namespace_add(self,
3153 sw_if_index=0xFFFFFFFF,
3156 self.papi.app_namespace_add_del,
3158 'sw_if_index': sw_if_index,
3159 'ip4_fib_id': ip4_fib_id,
3160 'ip6_fib_id': ip6_fib_id,
3161 'namespace_id': namespace_id,
3162 'namespace_id_len': len(namespace_id)})
3164 def punt_socket_register(self, l4_port, pathname, header_version=1,
3165 is_ip4=1, l4_protocol=0x11):
3166 """ Punt to socket """
3167 return self.api(self.papi.punt_socket_register,
3169 'l4_protocol': l4_protocol,
3171 'pathname': pathname,
3172 'header_version': header_version})
3174 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3175 expire_walk_interval_ms, is_ip6=0):
3176 """ Set IP reassembly parameters """
3177 return self.api(self.papi.ip_reassembly_set,
3179 'timeout_ms': timeout_ms,
3180 'expire_walk_interval_ms': expire_walk_interval_ms,
3181 'max_reassemblies': max_reassemblies})
3183 def ip_reassembly_get(self, is_ip6=0):
3184 """ Get IP reassembly parameters """
3185 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3187 def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
3188 """ GBP endpoint Add/Del """
3189 return self.api(self.papi.gbp_endpoint_add_del,
3193 'sw_if_index': sw_if_index,
3197 def gbp_endpoint_dump(self):
3198 """ GBP endpoint Dump """
3199 return self.api(self.papi.gbp_endpoint_dump, {})
3201 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3202 """ GBP contract Add/Del """
3203 return self.api(self.papi.gbp_contract_add_del,
3206 'acl_index': acl_index,
3208 'dst_epg': dst_epg}})
3210 def gbp_contract_dump(self):
3211 """ GBP contract Dump """
3212 return self.api(self.papi.gbp_contract_dump, {})
3214 def sixrd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len,
3215 ip4_prefix, ip4_prefix_len, ip4_src, mtu,
3217 """ 6RD tunnel Add """
3218 return self.api(self.papi.sixrd_add_tunnel,
3219 {'fib_index': fib_index,
3220 'ip6_prefix': ip6_prefix,
3221 'ip6_prefix_len': ip6_prefix_len,
3222 'ip4_prefix': ip4_prefix,
3223 'ip4_prefix_len': ip4_prefix_len,
3226 'security_check': security_check})
3228 def sixrd_del_tunnel(self, sw_if_index):
3229 """ 6RD tunnel Delete """
3230 return self.api(self.papi.sixrd_del_tunnel,
3231 {'sw_if_index': sw_if_index})