5 from collections import deque
7 # Sphinx creates auto-generated documentation by importing the python source
8 # files and collecting the docstrings from them. The NO_VPP_PAPI flag allows
9 # the vpp_papi_provider.py file to be importable without having to build
10 # the whole vpp api if the user only wishes to generate the test documentation.
13 no_vpp_papi = os.getenv("NO_VPP_PAPI")
14 if no_vpp_papi == "1":
20 from vpp_papi import VPP
22 # from vnet/vnet/mpls/mpls_types.h
23 MPLS_IETF_MAX_LABEL = 0xfffff
24 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
46 class UnexpectedApiReturnValueError(Exception):
47 """ exception raised when the API return value is unexpected """
51 class VppPapiProvider(object):
52 """VPP-api provider using vpp-papi
54 @property hook: hook object providing before and after api/cli hooks
57 _zero, _negative = range(2)
59 def __init__(self, name, shm_prefix, test_class):
60 self.hook = Hook("vpp-papi-provider")
62 self.shm_prefix = shm_prefix
63 self.test_class = test_class
64 self._expect_api_retval = self._zero
65 self._expect_stack = []
68 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
69 for root, dirnames, filenames in os.walk(install_dir):
70 for filename in fnmatch.filter(filenames, '*.api.json'):
71 jsonfiles.append(os.path.join(root, filename))
73 self.vpp = VPP(jsonfiles, logger=test_class.logger, read_timeout=5)
74 self._events = deque()
79 def expect_negative_api_retval(self):
80 """ Expect API failure """
81 self._expect_stack.append(self._expect_api_retval)
82 self._expect_api_retval = self._negative
85 def expect_zero_api_retval(self):
86 """ Expect API success """
87 self._expect_stack.append(self._expect_api_retval)
88 self._expect_api_retval = self._zero
91 def __exit__(self, exc_type, exc_value, traceback):
92 self._expect_api_retval = self._expect_stack.pop()
94 def register_hook(self, hook):
95 """Replace hook registration with new hook
102 def collect_events(self):
103 """ Collect all events from the internal queue and clear the queue. """
105 self._events = deque()
108 def wait_for_event(self, timeout, name=None):
109 """ Wait for and return next event. """
111 self.test_class.logger.debug("Expecting event '%s' within %ss",
114 self.test_class.logger.debug("Expecting event within %ss",
117 self.test_class.logger.debug("Not waiting, event already queued")
118 limit = time.time() + timeout
119 while time.time() < limit:
121 e = self._events.popleft()
122 if name and type(e).__name__ != name:
124 "Unexpected event received: %s, expected: %s" %
125 (type(e).__name__, name))
126 self.test_class.logger.debug("Returning event %s:%s" %
129 time.sleep(0) # yield
130 raise Exception("Event did not occur within timeout")
132 def __call__(self, name, event):
133 """ Enqueue event in the internal event queue. """
134 # FIXME use the name instead of relying on type(e).__name__ ?
135 # FIXME #2 if this throws, it is eaten silently, Ole?
136 self.test_class.logger.debug("New event: %s: %s" % (name, event))
137 self._events.append(event)
140 """Connect the API to VPP"""
141 self.vpp.connect(self.name, self.shm_prefix)
142 self.papi = self.vpp.api
143 self.vpp.register_event_callback(self)
145 def disconnect(self):
146 """Disconnect the API from VPP"""
147 self.vpp.disconnect()
149 def api(self, api_fn, api_args, expected_retval=0):
150 """ Call API function and check it's return value.
151 Call the appropriate hooks before and after the API call
153 :param api_fn: API function to call
154 :param api_args: tuple of API function arguments
155 :param expected_retval: Expected return value (Default value = 0)
156 :returns: reply from the API
159 self.hook.before_api(api_fn.__name__, api_args)
160 reply = api_fn(**api_args)
161 if self._expect_api_retval == self._negative:
162 if hasattr(reply, 'retval') and reply.retval >= 0:
163 msg = "API call passed unexpectedly: expected negative "\
164 "return value instead of %d in %s" % \
165 (reply.retval, repr(reply))
166 self.test_class.logger.info(msg)
167 raise UnexpectedApiReturnValueError(msg)
168 elif self._expect_api_retval == self._zero:
169 if hasattr(reply, 'retval') and reply.retval != expected_retval:
170 msg = "API call failed, expected %d return value instead "\
171 "of %d in %s" % (expected_retval, reply.retval,
173 self.test_class.logger.info(msg)
174 raise UnexpectedApiReturnValueError(msg)
176 raise Exception("Internal error, unexpected value for "
177 "self._expect_api_retval %s" %
178 self._expect_api_retval)
179 self.hook.after_api(api_fn.__name__, api_args)
183 """ Execute a CLI, calling the before/after hooks appropriately.
185 :param cli: CLI to execute
189 self.hook.before_cli(cli)
191 r = self.papi.cli_inband(length=len(cli), cmd=cli)
192 self.hook.after_cli(cli)
193 if hasattr(r, 'reply'):
194 return r.reply.decode().rstrip('\x00')
196 def ppcli(self, cli):
197 """ Helper method to print CLI command in case of info logging level.
199 :param cli: CLI to execute
202 return cli + "\n" + str(self.cli(cli))
204 def _convert_mac(self, mac):
205 return mac.replace(':', '').decode('hex')
207 def show_version(self):
209 return self.api(self.papi.show_version, {})
211 def pg_create_interface(self, pg_index):
217 return self.api(self.papi.pg_create_interface,
218 {"interface_id": pg_index})
220 def sw_interface_dump(self, filter=None):
223 :param filter: (Default value = None)
226 if filter is not None:
227 args = {"name_filter_valid": 1, "name_filter": filter}
230 return self.api(self.papi.sw_interface_dump, args)
232 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
233 """ Set the IPvX Table-id for the Interface
240 return self.api(self.papi.sw_interface_set_table,
241 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
244 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
245 is_ipv6=0, is_add=1, del_all=0):
248 :param addr: param is_ipv6: (Default value = 0)
251 :param is_ipv6: (Default value = 0)
252 :param is_add: (Default value = 1)
253 :param del_all: (Default value = 0)
256 return self.api(self.papi.sw_interface_add_del_address,
257 {'sw_if_index': sw_if_index,
261 'address_length': addr_len,
264 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
266 """ Set the Interface to be unnumbered
268 :param is_add: (Default value = 1)
269 :param sw_if_index - interface That will be unnumbered
270 :param ip_sw_if_index - interface with an IP addres
273 return self.api(self.papi.sw_interface_set_unnumbered,
274 {'sw_if_index': ip_sw_if_index,
275 'unnumbered_sw_if_index': sw_if_index,
278 def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
279 return self.api(self.papi.ip_unnumbered_dump,
280 {'sw_if_index': sw_if_index})
282 def sw_interface_enable_disable_mpls(self, sw_if_index,
285 Enable/Disable MPLS on the interface
287 :param is_enable: (Default value = 1)
290 return self.api(self.papi.sw_interface_set_mpls_enable,
291 {'sw_if_index': sw_if_index,
292 'enable': is_enable})
294 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
295 return self.api(self.papi.sw_interface_ip6nd_ra_config,
296 {'sw_if_index': sw_if_index,
297 'suppress': suppress})
299 def set_ip_flow_hash(self,
308 return self.api(self.papi.set_ip_flow_hash,
318 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
319 return self.api(self.papi.ip6nd_proxy_add_del,
321 'sw_if_index': sw_if_index,
324 def ip6_sw_interface_ra_config(self, sw_if_index,
328 return self.api(self.papi.sw_interface_ip6nd_ra_config,
329 {'sw_if_index': sw_if_index,
331 'suppress': suppress,
332 'send_unicast': send_unicast})
334 def ip6_sw_interface_ra_prefix(self,
344 val_lifetime=0xffffffff,
345 pref_lifetime=0xffffffff):
346 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
347 {'sw_if_index': sw_if_index,
349 'address_length': address_length,
350 'use_default': use_default,
351 'no_advertise': no_advertise,
352 'off_link': off_link,
353 'no_autoconfig': no_autoconfig,
354 'no_onlink': no_onlink,
356 'val_lifetime': val_lifetime,
357 'pref_lifetime': pref_lifetime})
359 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
361 Enable/Disable An interface for IPv6
363 return self.api(self.papi.sw_interface_ip6_enable_disable,
364 {'sw_if_index': sw_if_index,
367 def vxlan_add_del_tunnel(
371 mcast_sw_if_index=0xFFFFFFFF,
375 decap_next_index=0xFFFFFFFF,
377 instance=0xFFFFFFFF):
382 :param is_add: (Default value = 1)
383 :param is_ipv6: (Default value = 0)
384 :param encap_vrf_id: (Default value = 0)
385 :param decap_next_index: (Default value = 0xFFFFFFFF)
386 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
387 :param vni: (Default value = 0)
388 :param instance: (Default value = 0xFFFFFFFF)
391 return self.api(self.papi.vxlan_add_del_tunnel,
394 'src_address': src_addr,
395 'dst_address': dst_addr,
396 'mcast_sw_if_index': mcast_sw_if_index,
397 'encap_vrf_id': encap_vrf_id,
398 'decap_next_index': decap_next_index,
400 'instance': instance})
402 def geneve_add_del_tunnel(
406 mcast_sw_if_index=0xFFFFFFFF,
410 decap_next_index=0xFFFFFFFF,
416 :param is_add: (Default value = 1)
417 :param is_ipv6: (Default value = 0)
418 :param encap_vrf_id: (Default value = 0)
419 :param decap_next_index: (Default value = 0xFFFFFFFF)
420 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
421 :param vni: (Default value = 0)
424 return self.api(self.papi.geneve_add_del_tunnel,
427 'local_address': local_addr,
428 'remote_address': remote_addr,
429 'mcast_sw_if_index': mcast_sw_if_index,
430 'encap_vrf_id': encap_vrf_id,
431 'decap_next_index': decap_next_index,
434 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
435 learn=1, arp_term=0, is_add=1):
436 """Create/delete bridge domain.
438 :param int bd_id: Bridge domain index.
439 :param int flood: Enable/disable bcast/mcast flooding in the BD.
441 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
443 :param int forward: Enable/disable forwarding on all interfaces in
444 the BD. (Default value = 1)
445 :param int learn: Enable/disable learning on all interfaces in the BD.
447 :param int arp_term: Enable/disable arp termination in the BD.
449 :param int is_add: Add or delete flag. (Default value = 1)
451 return self.api(self.papi.bridge_domain_add_del,
454 'uu_flood': uu_flood,
457 'arp_term': arp_term,
460 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
461 return self.api(self.papi.bd_ip_mac_add_del,
468 def want_ip4_arp_events(self, enable_disable=1, address=0):
469 return self.api(self.papi.want_ip4_arp_events,
470 {'enable_disable': enable_disable,
472 'pid': os.getpid(), })
474 def want_ip6_nd_events(self, enable_disable=1, address=0):
475 return self.api(self.papi.want_ip6_nd_events,
476 {'enable_disable': enable_disable,
478 'pid': os.getpid(), })
480 def want_ip6_ra_events(self, enable_disable=1):
481 return self.api(self.papi.want_ip6_ra_events,
482 {'enable_disable': enable_disable,
483 'pid': os.getpid(), })
485 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
487 return self.api(self.papi.ip6nd_send_router_solicitation,
492 'sw_if_index': sw_if_index})
494 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
495 install_default_routes):
496 return self.api(self.papi.ip6_nd_address_autoconfig,
497 {'sw_if_index': sw_if_index,
499 'install_default_routes': install_default_routes})
501 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
502 max_macs_in_event=0, learn_limit=0):
503 return self.api(self.papi.want_l2_macs_events,
504 {'enable_disable': enable_disable,
505 'scan_delay': scan_delay,
506 'max_macs_in_event': max_macs_in_event,
507 'learn_limit': learn_limit,
508 'pid': os.getpid(), })
510 def want_dhcp6_reply_events(self, enable_disable=1):
511 return self.api(self.papi.want_dhcp6_reply_events,
512 {'enable_disable': enable_disable,
515 def want_dhcp6_pd_reply_events(self, enable_disable=1):
516 return self.api(self.papi.want_dhcp6_pd_reply_events,
517 {'enable_disable': enable_disable,
520 def dhcp6_clients_enable_disable(self, enable=1):
521 return self.api(self.papi.dhcp6_clients_enable_disable,
524 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
525 addresses, server_index=0xFFFFFFFF,
526 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
528 return self.api(self.papi.dhcp6_send_client_message,
529 {'sw_if_index': sw_if_index,
530 'server_index': server_index,
536 'msg_type': msg_type,
539 'n_addresses': len(addresses),
540 'addresses': addresses})
542 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
543 prefixes, server_index=0xFFFFFFFF,
544 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
546 return self.api(self.papi.dhcp6_pd_send_client_message,
547 {'sw_if_index': sw_if_index,
548 'server_index': server_index,
554 'msg_type': msg_type,
557 'n_prefixes': len(prefixes),
558 'prefixes': prefixes})
560 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
562 return self.api(self.papi.dhcp6_client_enable_disable,
563 {'sw_if_index': sw_if_index,
566 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
568 return self.api(self.papi.dhcp6_pd_client_enable_disable,
569 {'sw_if_index': sw_if_index,
570 'prefix_group': prefix_group,
573 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
574 prefix_length, prefix_group,
576 return self.api(self.papi.ip6_add_del_address_using_prefix,
577 {'sw_if_index': sw_if_index,
578 'prefix_group': prefix_group,
580 'prefix_length': prefix_length,
583 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
584 filter_mac=0, bvi_mac=0):
585 """Create/delete L2 FIB entry.
587 :param str mac: MAC address to create FIB entry for.
588 :param int bd_id: Bridge domain index.
589 :param int sw_if_index: Software interface index of the interface.
590 :param int is_add: Add or delete flag. (Default value = 1)
591 :param int static_mac: Set to 1 to create static MAC entry.
593 :param int filter_mac: Set to 1 to drop packet that's source or
594 destination MAC address contains defined MAC address.
596 :param int bvi_mac: Set to 1 to create entry that points to BVI
597 interface. (Default value = 0)
599 return self.api(self.papi.l2fib_add_del,
600 {'mac': self._convert_mac(mac),
602 'sw_if_index': sw_if_index,
604 'static_mac': static_mac,
605 'filter_mac': filter_mac,
608 def l2fib_flush_int(self, sw_if_index):
609 """Flush L2 FIB entries for sw_if_index.
611 :param int sw_if_index: Software interface index of the interface.
613 return self.api(self.papi.l2fib_flush_int,
614 {'sw_if_index': sw_if_index})
616 def l2fib_flush_bd(self, bd_id):
617 """Flush L2 FIB entries for bd_id.
619 :param int sw_if_index: Bridge Domain id.
621 return self.api(self.papi.l2fib_flush_bd,
624 def l2fib_flush_all(self):
627 return self.api(self.papi.l2fib_flush_all, {})
629 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
630 shg=0, bvi=0, enable=1):
631 """Add/remove interface to/from bridge domain.
633 :param int sw_if_index: Software interface index of the interface.
634 :param int bd_id: Bridge domain index.
635 :param int shg: Split-horizon group index. (Default value = 0)
636 :param int bvi: Set interface as a bridge group virtual interface.
638 :param int enable: Add or remove interface. (Default value = 1)
640 return self.api(self.papi.sw_interface_set_l2_bridge,
641 {'rx_sw_if_index': sw_if_index,
647 def bridge_flags(self, bd_id, is_set, feature_bitmap):
648 """Enable/disable required feature of the bridge domain with defined
651 :param int bd_id: Bridge domain ID.
652 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
653 :param int feature_bitmap: Bitmap value of the feature to be set:
657 - uu-flood (1 << 3) or
660 return self.api(self.papi.bridge_flags,
663 'feature_bitmap': feature_bitmap})
665 def bridge_domain_dump(self, bd_id=0):
668 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
669 existing bridge domains returned)
670 :return: Dictionary of bridge domain(s) data.
672 return self.api(self.papi.bridge_domain_dump,
675 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
677 """Create or delete unidirectional cross-connect from Tx interface to
680 :param int rx_sw_if_index: Software interface index of Rx interface.
681 :param int tx_sw_if_index: Software interface index of Tx interface.
682 :param int enable: Create cross-connect if equal to 1, delete
683 cross-connect if equal to 0.
686 return self.api(self.papi.sw_interface_set_l2_xconnect,
687 {'rx_sw_if_index': rx_sw_if_index,
688 'tx_sw_if_index': tx_sw_if_index,
691 def sw_interface_set_l2_tag_rewrite(
698 """L2 interface vlan tag rewrite configure request
699 :param client_index - opaque cookie to identify the sender
700 :param context - sender context, to match reply w/ request
701 :param sw_if_index - interface the operation is applied to
702 :param vtr_op - Choose from l2_vtr_op_t enum values
703 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
704 :param tag1 - Needed for any push or translate vtr op
705 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
708 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
709 {'sw_if_index': sw_if_index,
715 def sw_interface_set_l2_emulation(
720 :param sw_if_index - interface the operation is applied to
723 return self.api(self.papi.l2_emulation,
724 {'sw_if_index': sw_if_index,
727 def sw_interface_set_ip_directed_broadcast(
731 """IP Directed broadcast
732 :param sw_if_index - interface the operation is applied to
735 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
736 {'sw_if_index': sw_if_index,
739 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
742 :param admin_up_down:
746 return self.api(self.papi.sw_interface_set_flags,
747 {'sw_if_index': sw_if_index,
748 'admin_up_down': admin_up_down})
750 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
756 return self.api(self.papi.sw_interface_set_mtu,
757 {'sw_if_index': sw_if_index,
760 def sw_interface_set_promiscuous(self, sw_if_index, enable):
766 return self.api(self.papi.sw_interface_set_promiscuous,
767 {'sw_if_index': sw_if_index,
770 def sw_interface_set_mac_address(self, sw_if_index, mac):
771 return self.api(self.papi.sw_interface_set_mac_address,
772 {'sw_if_index': sw_if_index,
775 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
776 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
777 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
778 """Create subinterface
779 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
781 :param sub_id: param inner_vlan:
785 :param no_tags: (Default value = 0)
786 :param one_tag: (Default value = 0)
787 :param two_tags: (Default value = 0)
788 :param dot1ad: (Default value = 0)
789 :param exact_match: (Default value = 0)
790 :param default_sub: (Default value = 0)
791 :param outer_vlan_id_any: (Default value = 0)
792 :param inner_vlan_id_any: (Default value = 0)
796 self.papi.create_subif,
797 {'sw_if_index': sw_if_index,
801 'two_tags': two_tags,
803 'exact_match': exact_match,
804 'default_sub': default_sub,
805 'outer_vlan_id_any': outer_vlan_id_any,
806 'inner_vlan_id_any': inner_vlan_id_any,
807 'outer_vlan_id': outer_vlan,
808 'inner_vlan_id': inner_vlan})
810 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
811 """Create p2p ethernet subinterface
813 :param sw_if_index: main (parent) interface
814 :param remote_mac: client (remote) mac address
818 self.papi.p2p_ethernet_add,
819 {'parent_if_index': sw_if_index,
820 'remote_mac': remote_mac,
821 'subif_id': subif_id})
823 def delete_subif(self, sw_if_index):
824 """Delete subinterface
828 return self.api(self.papi.delete_subif,
829 {'sw_if_index': sw_if_index})
831 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
832 """Delete p2p ethernet subinterface
834 :param sw_if_index: main (parent) interface
835 :param remote_mac: client (remote) mac address
839 self.papi.p2p_ethernet_del,
840 {'parent_if_index': sw_if_index,
841 'remote_mac': remote_mac})
843 def create_vlan_subif(self, sw_if_index, vlan):
850 return self.api(self.papi.create_vlan_subif,
851 {'sw_if_index': sw_if_index,
854 def create_loopback(self, mac=''):
857 :param mac: (Optional)
859 return self.api(self.papi.create_loopback,
860 {'mac_address': mac})
862 def delete_loopback(self, sw_if_index):
863 return self.api(self.papi.delete_loopback,
864 {'sw_if_index': sw_if_index, })
866 def ip_table_add_del(self,
873 :param is_add: (Default value = 1)
874 :param is_ipv6: (Default value = 0)
879 self.papi.ip_table_add_del,
880 {'table_id': table_id,
884 def ip_add_del_route(
889 next_hop_sw_if_index=0xFFFFFFFF,
893 next_hop_n_out_labels=0,
894 next_hop_out_label_stack=[],
895 next_hop_via_label=MPLS_LABEL_INVALID,
896 next_hop_id=0xFFFFFFFF,
898 is_resolve_attached=0,
899 classify_table_index=0xFFFFFFFF,
913 :param dst_address_length:
914 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
916 :param next_hop_address:
917 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
918 :param vrf_id: (Default value = 0)
919 :param lookup_in_vrf: (Default value = 0)
920 :param classify_table_index: (Default value = 0xFFFFFFFF)
921 :param is_add: (Default value = 1)
922 :param is_drop: (Default value = 0)
923 :param is_ipv6: (Default value = 0)
924 :param is_local: (Default value = 0)
925 :param is_classify: (Default value = 0)
926 :param is_multipath: (Default value = 0)
927 :param is_resolve_host: (Default value = 0)
928 :param is_resolve_attached: (Default value = 0)
929 :param is_dvr: (Default value = 0)
930 :param is_source_lookup: (Default value = 0)
931 :param next_hop_weight: (Default value = 1)
936 self.papi.ip_add_del_route,
937 {'next_hop_sw_if_index': next_hop_sw_if_index,
938 'table_id': table_id,
939 'classify_table_index': classify_table_index,
940 'next_hop_table_id': next_hop_table_id,
943 'is_unreach': is_unreach,
944 'is_prohibit': is_prohibit,
946 'is_local': is_local,
947 'is_classify': is_classify,
948 'is_multipath': is_multipath,
949 'is_resolve_host': is_resolve_host,
950 'is_resolve_attached': is_resolve_attached,
952 'is_source_lookup': is_source_lookup,
953 'is_udp_encap': is_udp_encap,
954 'next_hop_weight': next_hop_weight,
955 'dst_address_length': dst_address_length,
956 'dst_address': dst_address,
957 'next_hop_id': next_hop_id,
958 'next_hop_address': next_hop_address,
959 'next_hop_n_out_labels': next_hop_n_out_labels,
960 'next_hop_via_label': next_hop_via_label,
961 'next_hop_out_label_stack': next_hop_out_label_stack})
963 def ip_fib_dump(self):
964 return self.api(self.papi.ip_fib_dump, {})
966 def ip6_fib_dump(self):
967 return self.api(self.papi.ip6_fib_dump, {})
969 def ip_neighbor_add_del(self,
978 """ Add neighbor MAC to IPv4 or IPv6 address.
983 :param is_add: (Default value = 1)
984 :param is_ipv6: (Default value = 0)
985 :param is_static: (Default value = 0)
986 :param is_no_adj_fib: (Default value = 0)
990 self.papi.ip_neighbor_add_del,
991 {'sw_if_index': sw_if_index,
994 'is_static': is_static,
995 'is_no_adj_fib': is_no_adj_fib,
996 'mac_address': mac_address,
997 'dst_address': dst_address
1001 def ip_neighbor_dump(self,
1004 """ Return IP neighbor dump.
1007 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1011 self.papi.ip_neighbor_dump,
1012 {'is_ipv6': is_ipv6,
1013 'sw_if_index': sw_if_index
1017 def proxy_arp_add_del(self,
1022 """ Config Proxy Arp Range.
1024 :param low_address: Start address in the rnage to Proxy for
1025 :param hi_address: End address in the rnage to Proxy for
1026 :param vrf_id: The VRF/table in which to proxy
1030 self.papi.proxy_arp_add_del,
1034 'low_address': low_address,
1035 'hi_address': hi_address,
1039 def proxy_arp_intfc_enable_disable(self,
1042 """ Enable/Disable an interface for proxy ARP requests
1044 :param sw_if_index: Interface
1045 :param enable_disable: Enable/Disable
1049 self.papi.proxy_arp_intfc_enable_disable,
1050 {'sw_if_index': sw_if_index,
1051 'enable_disable': is_enable
1059 """ Reset VRF (remove all routes etc.) request.
1061 :param int vrf_id: ID of the FIB table / VRF to reset.
1062 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1066 self.papi.reset_vrf,
1076 """ Reset VRF (remove all routes etc.) request.
1078 :param int vrf_id: ID of the FIB table / VRF to reset.
1079 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1083 self.papi.reset_fib,
1094 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1099 {'is_ipv6': is_ipv6,
1103 def sw_interface_span_enable_disable(
1104 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1107 :param sw_if_index_from:
1108 :param sw_if_index_to:
1112 return self.api(self.papi.sw_interface_span_enable_disable,
1113 {'sw_if_index_from': sw_if_index_from,
1114 'sw_if_index_to': sw_if_index_to,
1119 def gre_tunnel_add_del(self,
1124 instance=0xFFFFFFFF,
1128 """ Add a GRE tunnel
1132 :param outer_fib_id: (Default value = 0)
1133 :param tunnel_type: (Default value = 0)
1134 :param instance: (Default value = 0xFFFFFFFF)
1135 :param session_id: (Defalt value = 0)
1136 :param is_add: (Default value = 1)
1137 :param is_ipv6: (Default value = 0)
1141 self.papi.gre_add_del_tunnel,
1144 'tunnel_type': tunnel_type,
1145 'instance': instance,
1146 'src_address': src_address,
1147 'dst_address': dst_address,
1148 'outer_fib_id': outer_fib_id,
1149 'session_id': session_id}
1152 def udp_encap_add(self,
1159 """ Add a GRE tunnel
1160 :param id: user provided ID
1165 :param outer_fib_id: (Default value = 0)
1169 self.papi.udp_encap_add,
1175 'src_port': src_port,
1176 'dst_port': dst_port,
1177 'table_id': table_id
1181 def udp_encap_del(self, id):
1182 return self.api(self.papi.udp_encap_del, {'id': id})
1184 def udp_encap_dump(self):
1185 return self.api(self.papi.udp_encap_dump, {})
1187 def want_udp_encap_stats(self, enable=1):
1188 return self.api(self.papi.want_udp_encap_stats,
1190 'pid': os.getpid()})
1192 def mpls_fib_dump(self):
1193 return self.api(self.papi.mpls_fib_dump, {})
1195 def mpls_table_add_del(
1202 :param is_add: (Default value = 1)
1207 self.papi.mpls_table_add_del,
1208 {'mt_table_id': table_id,
1209 'mt_is_add': is_add})
1211 def mpls_route_add_del(
1217 next_hop_sw_if_index=0xFFFFFFFF,
1219 next_hop_table_id=0,
1221 next_hop_n_out_labels=0,
1222 next_hop_out_label_stack=[],
1223 next_hop_via_label=MPLS_LABEL_INVALID,
1225 is_resolve_attached=0,
1232 classify_table_index=0xFFFFFFFF,
1236 :param dst_address_length:
1237 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1239 :param next_hop_address:
1240 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1241 :param vrf_id: (Default value = 0)
1242 :param lookup_in_vrf: (Default value = 0)
1243 :param classify_table_index: (Default value = 0xFFFFFFFF)
1244 :param is_add: (Default value = 1)
1245 :param is_drop: (Default value = 0)
1246 :param is_ipv6: (Default value = 0)
1247 :param is_local: (Default value = 0)
1248 :param is_classify: (Default value = 0)
1249 :param is_multipath: (Default value = 0)
1250 :param is_multicast: (Default value = 0)
1251 :param is_resolve_host: (Default value = 0)
1252 :param is_resolve_attached: (Default value = 0)
1253 :param next_hop_weight: (Default value = 1)
1257 self.papi.mpls_route_add_del,
1260 'mr_table_id': table_id,
1261 'mr_classify_table_index': classify_table_index,
1262 'mr_is_add': is_add,
1263 'mr_is_classify': is_classify,
1264 'mr_is_multipath': is_multipath,
1265 'mr_is_multicast': is_multicast,
1266 'mr_is_resolve_host': is_resolve_host,
1267 'mr_is_resolve_attached': is_resolve_attached,
1268 'mr_is_interface_rx': is_interface_rx,
1269 'mr_is_rpf_id': is_rpf_id,
1270 'mr_next_hop_proto': next_hop_proto,
1271 'mr_next_hop_weight': next_hop_weight,
1272 'mr_next_hop': next_hop_address,
1273 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1274 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1275 'mr_next_hop_table_id': next_hop_table_id,
1276 'mr_next_hop_via_label': next_hop_via_label,
1277 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1279 def mpls_ip_bind_unbind(
1291 self.papi.mpls_ip_bind_unbind,
1292 {'mb_mpls_table_id': table_id,
1294 'mb_ip_table_id': ip_table_id,
1295 'mb_is_bind': is_bind,
1296 'mb_is_ip4': is_ip4,
1297 'mb_address_length': dst_address_length,
1298 'mb_address': dst_address})
1300 def mpls_tunnel_add_del(
1303 next_hop_proto_is_ip4,
1305 next_hop_sw_if_index=0xFFFFFFFF,
1306 next_hop_table_id=0,
1308 next_hop_n_out_labels=0,
1309 next_hop_out_label_stack=[],
1310 next_hop_via_label=MPLS_LABEL_INVALID,
1316 :param dst_address_length:
1317 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1319 :param next_hop_address:
1320 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1321 :param vrf_id: (Default value = 0)
1322 :param lookup_in_vrf: (Default value = 0)
1323 :param classify_table_index: (Default value = 0xFFFFFFFF)
1324 :param is_add: (Default value = 1)
1325 :param is_drop: (Default value = 0)
1326 :param is_ipv6: (Default value = 0)
1327 :param is_local: (Default value = 0)
1328 :param is_classify: (Default value = 0)
1329 :param is_multipath: (Default value = 0)
1330 :param is_resolve_host: (Default value = 0)
1331 :param is_resolve_attached: (Default value = 0)
1332 :param next_hop_weight: (Default value = 1)
1333 :param is_multicast: (Default value = 0)
1337 self.papi.mpls_tunnel_add_del,
1338 {'mt_sw_if_index': tun_sw_if_index,
1339 'mt_is_add': is_add,
1340 'mt_l2_only': l2_only,
1341 'mt_is_multicast': is_multicast,
1342 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1343 'mt_next_hop_weight': next_hop_weight,
1344 'mt_next_hop': next_hop_address,
1345 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1346 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1347 'mt_next_hop_table_id': next_hop_table_id,
1348 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1350 def nat44_interface_add_del_feature(
1355 """Enable/disable NAT44 feature on the interface
1357 :param sw_if_index: Software index of the interface
1358 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1359 :param is_add: 1 if add, 0 if delete (Default value = 1)
1362 self.papi.nat44_interface_add_del_feature,
1364 'is_inside': is_inside,
1365 'sw_if_index': sw_if_index})
1367 def nat44_interface_add_del_output_feature(
1372 """Enable/disable NAT44 output feature on the interface
1374 :param sw_if_index: Software index of the interface
1375 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1376 :param is_add: 1 if add, 0 if delete (Default value = 1)
1379 self.papi.nat44_interface_add_del_output_feature,
1381 'is_inside': is_inside,
1382 'sw_if_index': sw_if_index})
1384 def nat44_add_del_static_mapping(
1388 external_sw_if_index=0xFFFFFFFF,
1399 """Add/delete NAT44 static mapping
1401 :param local_ip: Local IP address
1402 :param external_ip: External IP address
1403 :param external_sw_if_index: External interface instead of IP address
1404 :param local_port: Local port number (Default value = 0)
1405 :param external_port: External port number (Default value = 0)
1406 :param addr_only: 1 if address only mapping, 0 if address and port
1407 :param vrf_id: VRF ID
1408 :param protocol: IP protocol (Default value = 0)
1409 :param twice_nat: 1 if translate external host address and port
1410 :param self_twice_nat: 1 if translate external host address and port
1411 whenever external host address equals
1412 local address of internal host
1413 :param out2in_only: if 1 rule is matching only out2in direction
1414 :param tag: Opaque string tag
1415 :param is_add: 1 if add, 0 if delete (Default value = 1)
1418 self.papi.nat44_add_del_static_mapping,
1420 'addr_only': addr_only,
1421 'local_ip_address': local_ip,
1422 'external_ip_address': external_ip,
1423 'local_port': local_port,
1424 'external_port': external_port,
1425 'external_sw_if_index': external_sw_if_index,
1427 'protocol': protocol,
1428 'twice_nat': twice_nat,
1429 'self_twice_nat': self_twice_nat,
1430 'out2in_only': out2in_only,
1433 def nat44_add_del_identity_mapping(
1436 sw_if_index=0xFFFFFFFF,
1443 """Add/delete NAT44 identity mapping
1445 :param ip: IP address (Default value = 0)
1446 :param sw_if_index: Interface instead of IP address
1447 :param port: Port number (Default value = 0)
1448 :param addr_only: 1 if address only mapping, 0 if address and port
1449 :param vrf_id: VRF ID
1450 :param protocol: IP protocol (Default value = 0)
1451 :param tag: Opaque string tag
1452 :param is_add: 1 if add, 0 if delete (Default value = 1)
1455 self.papi.nat44_add_del_identity_mapping,
1457 'addr_only': addr_only,
1460 'sw_if_index': sw_if_index,
1463 'protocol': protocol})
1465 def nat44_add_del_address_range(
1472 """Add/del NAT44 address range
1474 :param first_ip_address: First IP address
1475 :param last_ip_address: Last IP address
1476 :param vrf_id: VRF id for the address range
1477 :param twice_nat: twice NAT address for extenal hosts
1478 :param is_add: 1 if add, 0 if delete (Default value = 1)
1481 self.papi.nat44_add_del_address_range,
1482 {'first_ip_address': first_ip_address,
1483 'last_ip_address': last_ip_address,
1485 'twice_nat': twice_nat,
1488 def nat44_address_dump(self):
1489 """Dump NAT44 addresses
1490 :return: Dictionary of NAT44 addresses
1492 return self.api(self.papi.nat44_address_dump, {})
1494 def nat44_interface_dump(self):
1495 """Dump interfaces with NAT44 feature
1496 :return: Dictionary of interfaces with NAT44 feature
1498 return self.api(self.papi.nat44_interface_dump, {})
1500 def nat44_interface_output_feature_dump(self):
1501 """Dump interfaces with NAT44 output feature
1502 :return: Dictionary of interfaces with NAT44 output feature
1504 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1506 def nat44_static_mapping_dump(self):
1507 """Dump NAT44 static mappings
1508 :return: Dictionary of NAT44 static mappings
1510 return self.api(self.papi.nat44_static_mapping_dump, {})
1512 def nat44_identity_mapping_dump(self):
1513 """Dump NAT44 identity mappings
1514 :return: Dictionary of NAT44 identity mappings
1516 return self.api(self.papi.nat44_identity_mapping_dump, {})
1518 def nat_show_config(self):
1519 """Show NAT plugin config
1520 :return: NAT plugin config parameters
1522 return self.api(self.papi.nat_show_config, {})
1524 def nat44_add_interface_addr(
1529 """Add/del NAT44 address from interface
1531 :param sw_if_index: Software index of the interface
1532 :param twice_nat: twice NAT address for extenal hosts
1533 :param is_add: 1 if add, 0 if delete (Default value = 1)
1536 self.papi.nat44_add_del_interface_addr,
1538 'sw_if_index': sw_if_index,
1539 'twice_nat': twice_nat})
1541 def nat44_interface_addr_dump(self):
1542 """Dump NAT44 addresses interfaces
1543 :return: Dictionary of NAT44 addresses interfaces
1545 return self.api(self.papi.nat44_interface_addr_dump, {})
1552 """Enable/disable NAT IPFIX logging
1554 :param domain_id: Observation domain ID (Default value = 1)
1555 :param src_port: Source port number (Default value = 4739)
1556 :param enable: 1 if enable, 0 if disable (Default value = 1)
1559 self.papi.nat_ipfix_enable_disable,
1560 {'domain_id': domain_id,
1561 'src_port': src_port,
1564 def nat44_user_session_dump(
1568 """Dump NAT44 user's sessions
1570 :param ip_address: ip adress of the user to be dumped
1571 :param cpu_index: cpu_index on which the user is
1572 :param vrf_id: VRF ID
1573 :return: Dictionary of S-NAT sessions
1576 self.papi.nat44_user_session_dump,
1577 {'ip_address': ip_address,
1580 def nat44_user_dump(self):
1583 :return: Dictionary of NAT44 users
1585 return self.api(self.papi.nat44_user_dump, {})
1587 def nat44_add_del_lb_static_mapping(
1599 """Add/delete NAT44 load balancing static mapping
1601 :param twice_nat: 1 if translate external host address and port
1602 :param tag: Opaque string tag
1603 :param is_add - 1 if add, 0 if delete
1606 self.papi.nat44_add_del_lb_static_mapping,
1608 'external_addr': external_addr,
1609 'external_port': external_port,
1610 'protocol': protocol,
1611 'twice_nat': twice_nat,
1612 'self_twice_nat': self_twice_nat,
1613 'out2in_only': out2in_only,
1615 'local_num': local_num,
1618 def nat44_lb_static_mapping_dump(self):
1619 """Dump NAT44 load balancing static mappings
1621 :return: Dictionary of NAT44 load balancing static mapping
1623 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1625 def nat44_del_session(
1632 ext_host_address=None,
1634 """Delete NAT44 session
1636 :param addr: IPv4 address
1637 :param por: port number
1638 :param protocol: IP protocol number
1639 :param vrf_id: VRF ID
1640 :param is_in: 1 if inside network addres and port pari, 0 if outside
1641 :param ext_host_address: external host IPv4 address
1642 :param ext_host_port: external host port
1644 if ext_host_address is None:
1646 self.papi.nat44_del_session,
1649 'protocol': protocol,
1654 self.papi.nat44_del_session,
1657 'protocol': protocol,
1660 'ext_host_valid': 1,
1661 'ext_host_address': ext_host_address,
1662 'ext_host_port': ext_host_port})
1664 def nat44_forwarding_enable_disable(
1667 """Enable/disable forwarding for NAT44
1669 :param enable: 1 for enable, 0 for disable
1672 self.papi.nat44_forwarding_enable_disable,
1682 """Set NAT virtual fragmentation reassembly
1684 :param timeout: reassembly timeout (Default 2sec)
1685 :param max_reass: maximum concurrent reassemblies (Default 1024)
1686 :param max_frag: maximum fragmets per reassembly (Default 5)
1687 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1688 :param is_ip6: 1 if IPv6, 0 if IPv4
1691 self.papi.nat_set_reass,
1692 {'timeout': timeout,
1693 'max_reass': max_reass,
1694 'max_frag': max_frag,
1695 'drop_frag': drop_frag,
1698 def nat_get_reass(self):
1699 """Get NAT virtual fragmentation reassembly configuration
1701 :return: NAT virtual fragmentation reassembly configuration
1703 return self.api(self.papi.nat_get_reass, {})
1705 def nat_reass_dump(self):
1706 """Dump NAT virtual fragmentation reassemblies
1708 :return: Dictionary of NAT virtual fragmentation reassemblies
1710 return self.api(self.papi.nat_reass_dump, {})
1712 def nat_det_add_del_map(
1719 """Add/delete deterministic NAT mapping
1721 :param is_add - 1 if add, 0 if delete
1722 :param in_addr - inside IP address
1723 :param in_plen - inside IP address prefix length
1724 :param out_addr - outside IP address
1725 :param out_plen - outside IP address prefix length
1728 self.papi.nat_det_add_del_map,
1733 'out_addr': out_addr,
1734 'out_plen': out_plen})
1736 def nat_det_forward(
1739 """Get outside address and port range from inside address
1741 :param in_addr - inside IP address
1744 self.papi.nat_det_forward,
1745 {'in_addr': in_addr,
1748 def nat_det_reverse(
1752 """Get inside address from outside address and port
1754 :param out_addr - outside IP address
1755 :param out_port - outside port
1758 self.papi.nat_det_reverse,
1759 {'out_addr': out_addr,
1760 'out_port': out_port})
1762 def nat_det_map_dump(self):
1763 """Dump deterministic NAT mappings
1765 :return: Dictionary of deterministic NAT mappings
1767 return self.api(self.papi.nat_det_map_dump, {})
1769 def nat_det_set_timeouts(
1772 tcp_established=7440,
1775 """Set values of timeouts for deterministic NAT (in seconds)
1777 :param udp - UDP timeout (Default value = 300)
1778 :param tcp_established - TCP established timeout (Default value = 7440)
1779 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1780 :param icmp - ICMP timeout (Default value = 60)
1783 self.papi.nat_det_set_timeouts,
1785 'tcp_established': tcp_established,
1786 'tcp_transitory': tcp_transitory,
1789 def nat_det_get_timeouts(self):
1790 """Get values of timeouts for deterministic NAT
1792 :return: Timeouts for deterministic NAT (in seconds)
1794 return self.api(self.papi.nat_det_get_timeouts, {})
1796 def nat_det_close_session_out(
1802 """Close deterministic NAT session using outside address and port
1804 :param out_addr - outside IP address
1805 :param out_port - outside port
1806 :param ext_addr - external host IP address
1807 :param ext_port - external host port
1810 self.papi.nat_det_close_session_out,
1811 {'out_addr': out_addr,
1812 'out_port': out_port,
1813 'ext_addr': ext_addr,
1814 'ext_port': ext_port})
1816 def nat_det_close_session_in(
1822 """Close deterministic NAT session using inside address and port
1824 :param in_addr - inside IP address
1825 :param in_port - inside port
1826 :param ext_addr - external host IP address
1827 :param ext_port - external host port
1830 self.papi.nat_det_close_session_in,
1831 {'in_addr': in_addr,
1833 'ext_addr': ext_addr,
1834 'ext_port': ext_port,
1837 def nat_det_session_dump(
1840 """Dump deterministic NAT sessions belonging to a user
1842 :param user_addr - inside IP address of the user
1843 :return: Dictionary of deterministic NAT sessions
1846 self.papi.nat_det_session_dump,
1848 'user_addr': user_addr})
1850 def nat64_add_del_pool_addr_range(
1856 """Add/del address range to NAT64 pool
1858 :param start_addr: First IP address
1859 :param end_addr: Last IP address
1860 :param vrf_id: VRF id for the address range
1861 :param is_add: 1 if add, 0 if delete (Default value = 1)
1864 self.papi.nat64_add_del_pool_addr_range,
1865 {'start_addr': start_addr,
1866 'end_addr': end_addr,
1870 def nat64_pool_addr_dump(self):
1871 """Dump NAT64 pool addresses
1872 :return: Dictionary of NAT64 pool addresses
1874 return self.api(self.papi.nat64_pool_addr_dump, {})
1876 def nat64_add_del_interface(
1881 """Enable/disable NAT64 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.nat64_add_del_interface,
1888 {'sw_if_index': sw_if_index,
1889 'is_inside': is_inside,
1892 def nat64_interface_dump(self):
1893 """Dump interfaces with NAT64 feature
1894 :return: Dictionary of interfaces with NAT64 feature
1896 return self.api(self.papi.nat64_interface_dump, {})
1898 def nat64_add_del_static_bib(
1907 """Add/delete S-NAT static BIB entry
1909 :param in_ip: Inside IPv6 address
1910 :param out_ip: Outside IPv4 address
1911 :param in_port: Inside port number
1912 :param out_port: Outside port number
1913 :param protocol: IP protocol
1914 :param vrf_id: VRF ID (Default value = 0)
1915 :param is_add: 1 if add, 0 if delete (Default value = 1)
1918 self.papi.nat64_add_del_static_bib,
1927 def nat64_bib_dump(self, protocol=255):
1930 :param protocol: IP protocol (Default value = 255, all BIBs)
1931 :returns: Dictionary of NAT64 BIB entries
1933 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1935 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1936 tcp_incoming_syn=6):
1937 """Set values of timeouts for NAT64 (in seconds)
1939 :param udpi: UDP timeout (Default value = 300)
1940 :param icmp: ICMP timeout (Default value = 60)
1941 :param tcp_trans: TCP transitory timeout (Default value = 240)
1942 :param tcp_est: TCP established timeout (Default value = 7440)
1943 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1946 self.papi.nat64_set_timeouts,
1949 'tcp_trans': tcp_trans,
1951 'tcp_incoming_syn': tcp_incoming_syn})
1953 def nat64_get_timeouts(self):
1954 """Get values of timeouts for NAT64
1956 :return: Timeouts for NAT64 (in seconds)
1958 return self.api(self.papi.nat64_get_timeouts, {})
1960 def nat64_st_dump(self, protocol=255):
1961 """Dump NAT64 session table
1963 :param protocol: IP protocol (Default value = 255, all STs)
1964 :returns: Dictionary of NAT64 sesstion table entries
1966 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1968 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1969 """Add/del NAT64 prefix
1971 :param prefix: NAT64 prefix
1972 :param plen: NAT64 prefix length
1973 :param vrf_id: VRF id of tenant (Default 0)
1974 :param is_add: 1 if add, 0 if delete (Default value = 1)
1977 self.papi.nat64_add_del_prefix,
1983 def nat64_prefix_dump(self):
1984 """Dump NAT64 prefix
1986 :returns: Dictionary of NAT64 prefixes
1988 return self.api(self.papi.nat64_prefix_dump, {})
1990 def nat64_add_interface_addr(
1994 """Add/del NAT64 address from interface
1996 :param sw_if_index: Software index of the interface
1997 :param is_add: 1 if add, 0 if delete (Default value = 1)
1999 return self.api(self.papi.nat64_add_del_interface_addr,
2000 {'is_add': is_add, 'sw_if_index': sw_if_index})
2002 def dslite_set_aftr_addr(self, ip6, ip4):
2003 """Set DS-Lite AFTR addresses
2005 :param ip4: IPv4 address
2006 :param ip6: IPv6 address
2009 self.papi.dslite_set_aftr_addr,
2013 def dslite_set_b4_addr(self, ip6, ip4):
2014 """Set DS-Lite B4 IPv6 address
2016 :param ip4: IPv4 address
2017 :param ip6: IPv6 address
2020 self.papi.dslite_set_b4_addr,
2024 def dslite_add_del_pool_addr_range(
2029 """Add/del address range to DS-Lite pool
2031 :param start_addr: First IP address
2032 :param end_addr: Last IP address
2033 :param is_add: 1 if add, 0 if delete (Default value = 1)
2036 self.papi.dslite_add_del_pool_addr_range,
2037 {'start_addr': start_addr,
2038 'end_addr': end_addr,
2041 def nat66_add_del_interface(
2046 """Enable/disable NAT66 feature on the interface
2047 :param sw_if_index: Index of the interface
2048 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2049 :param is_add: 1 if add, 0 if delete (Default value = 1)
2052 self.papi.nat66_add_del_interface,
2053 {'sw_if_index': sw_if_index,
2054 'is_inside': is_inside,
2057 def nat66_add_del_static_mapping(
2063 """Add/delete NAT66 static mapping
2065 :param in_ip: Inside IPv6 address
2066 :param out_ip: Outside IPv6 address
2067 :param vrf_id: VRF ID (Default value = 0)
2068 :param is_add: 1 if add, 0 if delete (Default value = 1)
2071 self.papi.nat66_add_del_static_mapping,
2072 {'local_ip_address': in_ip,
2073 'external_ip_address': out_ip,
2077 def nat66_interface_dump(self):
2078 """Dump interfaces with NAT66 feature
2079 :return: Dictionary of interfaces with NAT66 feature
2081 return self.api(self.papi.nat66_interface_dump, {})
2083 def nat66_static_mapping_dump(self):
2084 """Dump NAT66 static mappings
2085 :return: Dictionary of NAT66 static mappings
2087 return self.api(self.papi.nat66_static_mapping_dump, {})
2089 def control_ping(self):
2090 self.api(self.papi.control_ping)
2092 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2093 detect_mult, local_addr, peer_addr, is_ipv6=0,
2094 bfd_key_id=None, conf_key_id=None):
2095 if bfd_key_id is None:
2096 return self.api(self.papi.bfd_udp_add,
2098 'sw_if_index': sw_if_index,
2099 'desired_min_tx': desired_min_tx,
2100 'required_min_rx': required_min_rx,
2101 'local_addr': local_addr,
2102 'peer_addr': peer_addr,
2104 'detect_mult': detect_mult,
2107 return self.api(self.papi.bfd_udp_add,
2109 'sw_if_index': sw_if_index,
2110 'desired_min_tx': desired_min_tx,
2111 'required_min_rx': required_min_rx,
2112 'local_addr': local_addr,
2113 'peer_addr': peer_addr,
2115 'detect_mult': detect_mult,
2116 'is_authenticated': 1,
2117 'bfd_key_id': bfd_key_id,
2118 'conf_key_id': conf_key_id,
2121 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2122 detect_mult, local_addr, peer_addr, is_ipv6=0):
2123 return self.api(self.papi.bfd_udp_mod,
2125 'sw_if_index': sw_if_index,
2126 'desired_min_tx': desired_min_tx,
2127 'required_min_rx': required_min_rx,
2128 'local_addr': local_addr,
2129 'peer_addr': peer_addr,
2131 'detect_mult': detect_mult,
2134 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2135 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2137 return self.api(self.papi.bfd_udp_auth_activate,
2139 'sw_if_index': sw_if_index,
2140 'local_addr': local_addr,
2141 'peer_addr': peer_addr,
2143 'is_delayed': 1 if is_delayed else 0,
2144 'bfd_key_id': bfd_key_id,
2145 'conf_key_id': conf_key_id,
2148 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2149 is_ipv6=0, is_delayed=False):
2150 return self.api(self.papi.bfd_udp_auth_deactivate,
2152 'sw_if_index': sw_if_index,
2153 'local_addr': local_addr,
2154 'peer_addr': peer_addr,
2156 'is_delayed': 1 if is_delayed else 0,
2159 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2160 return self.api(self.papi.bfd_udp_del,
2162 'sw_if_index': sw_if_index,
2163 'local_addr': local_addr,
2164 'peer_addr': peer_addr,
2168 def bfd_udp_session_dump(self):
2169 return self.api(self.papi.bfd_udp_session_dump, {})
2171 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2172 peer_addr, is_ipv6=0):
2173 return self.api(self.papi.bfd_udp_session_set_flags, {
2174 'admin_up_down': admin_up_down,
2175 'sw_if_index': sw_if_index,
2176 'local_addr': local_addr,
2177 'peer_addr': peer_addr,
2181 def want_bfd_events(self, enable_disable=1):
2182 return self.api(self.papi.want_bfd_events, {
2183 'enable_disable': enable_disable,
2187 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2188 return self.api(self.papi.bfd_auth_set_key, {
2189 'conf_key_id': conf_key_id,
2190 'auth_type': auth_type,
2192 'key_len': len(key),
2195 def bfd_auth_del_key(self, conf_key_id):
2196 return self.api(self.papi.bfd_auth_del_key, {
2197 'conf_key_id': conf_key_id,
2200 def bfd_auth_keys_dump(self):
2201 return self.api(self.papi.bfd_auth_keys_dump, {})
2203 def bfd_udp_set_echo_source(self, sw_if_index):
2204 return self.api(self.papi.bfd_udp_set_echo_source,
2205 {'sw_if_index': sw_if_index})
2207 def bfd_udp_del_echo_source(self):
2208 return self.api(self.papi.bfd_udp_del_echo_source, {})
2210 def classify_add_del_table(
2215 table_index=0xFFFFFFFF,
2217 memory_size=2097152,
2219 next_table_index=0xFFFFFFFF,
2220 miss_next_index=0xFFFFFFFF,
2221 current_data_flag=0,
2222 current_data_offset=0):
2226 :param match_n_vectors: (Default value = 1)
2227 :param table_index: (Default value = 0xFFFFFFFF)
2228 :param nbuckets: (Default value = 2)
2229 :param memory_size: (Default value = 2097152)
2230 :param skip_n_vectors: (Default value = 0)
2231 :param next_table_index: (Default value = 0xFFFFFFFF)
2232 :param miss_next_index: (Default value = 0xFFFFFFFF)
2233 :param current_data_flag: (Default value = 0)
2234 :param current_data_offset: (Default value = 0)
2237 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2238 mask = mask + '\0' * (mask_len - len(mask))
2240 self.papi.classify_add_del_table,
2242 'table_index': table_index,
2243 'nbuckets': nbuckets,
2244 'memory_size': memory_size,
2245 'skip_n_vectors': skip_n_vectors,
2246 'match_n_vectors': match_n_vectors,
2247 'next_table_index': next_table_index,
2248 'miss_next_index': miss_next_index,
2249 'current_data_flag': current_data_flag,
2250 'current_data_offset': current_data_offset,
2251 'mask_len': mask_len,
2254 def classify_add_del_session(
2259 opaque_index=0xFFFFFFFF,
2260 hit_next_index=0xFFFFFFFF,
2268 :param opaque_index: (Default value = 0xFFFFFFFF)
2269 :param hit_next_index: (Default value = 0xFFFFFFFF)
2270 :param advance: (Default value = 0)
2271 :param action: (Default value = 0)
2272 :param metadata: (Default value = 0)
2275 match_len = ((len(match) - 1) / 16 + 1) * 16
2276 match = match + '\0' * (match_len - len(match))
2278 self.papi.classify_add_del_session,
2280 'table_index': table_index,
2281 'hit_next_index': hit_next_index,
2282 'opaque_index': opaque_index,
2285 'metadata': metadata,
2286 'match_len': match_len,
2289 def input_acl_set_interface(
2293 ip4_table_index=0xFFFFFFFF,
2294 ip6_table_index=0xFFFFFFFF,
2295 l2_table_index=0xFFFFFFFF):
2299 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2300 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2301 :param l2_table_index: (Default value = 0xFFFFFFFF)
2305 self.papi.input_acl_set_interface,
2306 {'sw_if_index': sw_if_index,
2307 'ip4_table_index': ip4_table_index,
2308 'ip6_table_index': ip6_table_index,
2309 'l2_table_index': l2_table_index,
2312 def output_acl_set_interface(
2316 ip4_table_index=0xFFFFFFFF,
2317 ip6_table_index=0xFFFFFFFF,
2318 l2_table_index=0xFFFFFFFF):
2322 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2323 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2324 :param l2_table_index: (Default value = 0xFFFFFFFF)
2328 self.papi.output_acl_set_interface,
2329 {'sw_if_index': sw_if_index,
2330 'ip4_table_index': ip4_table_index,
2331 'ip6_table_index': ip6_table_index,
2332 'l2_table_index': l2_table_index,
2335 def set_ipfix_exporter(
2342 collector_port=4739,
2345 self.papi.set_ipfix_exporter,
2347 'collector_address': collector_address,
2348 'collector_port': collector_port,
2349 'src_address': src_address,
2351 'path_mtu': path_mtu,
2352 'template_interval': template_interval,
2353 'udp_checksum': udp_checksum,
2356 def dhcp_proxy_config(self,
2364 self.papi.dhcp_proxy_config,
2366 'rx_vrf_id': rx_table_id,
2367 'server_vrf_id': server_table_id,
2370 'dhcp_server': dhcp_server,
2371 'dhcp_src_address': dhcp_src_address,
2374 def dhcp_proxy_set_vss(self,
2383 self.papi.dhcp_proxy_set_vss,
2386 'vss_type': vss_type,
2387 'vpn_ascii_id': vpn_ascii_id,
2389 'vpn_index': vpn_index,
2394 def dhcp_client_dump(self):
2395 return self.api(self.papi.dhcp_client_dump, {})
2397 def dhcp_client(self,
2402 set_broadcast_flag=1,
2403 want_dhcp_events=0):
2405 self.papi.dhcp_client_config,
2409 'sw_if_index': sw_if_index,
2410 'hostname': hostname,
2412 'want_dhcp_event': want_dhcp_events,
2413 'set_broadcast_flag': set_broadcast_flag,
2417 def ip_mroute_add_del(self,
2423 next_hop_sw_if_index,
2433 IP Multicast Route add/del
2436 self.papi.ip_mroute_add_del,
2437 {'next_hop_sw_if_index': next_hop_sw_if_index,
2438 'entry_flags': e_flags,
2439 'itf_flags': i_flags,
2440 'table_id': table_id,
2444 'is_local': is_local,
2445 'bier_imp': bier_imp,
2446 'next_hop_afi': next_hop_afi,
2447 'grp_address_length': grp_address_length,
2448 'grp_address': grp_address,
2449 'src_address': src_address,
2450 'nh_address': next_hop_address})
2452 def mfib_signal_dump(self):
2453 return self.api(self.papi.mfib_signal_dump, {})
2455 def ip_mfib_dump(self):
2456 return self.api(self.papi.ip_mfib_dump, {})
2458 def ip6_mfib_dump(self):
2459 return self.api(self.papi.ip6_mfib_dump, {})
2461 def lisp_enable_disable(self, is_enabled):
2463 self.papi.lisp_enable_disable,
2465 'is_en': is_enabled,
2468 def lisp_locator_set(self,
2472 self.papi.lisp_add_del_locator_set,
2475 'locator_set_name': ls_name
2478 def lisp_locator_set_dump(self):
2479 return self.api(self.papi.lisp_locator_set_dump, {})
2481 def lisp_locator(self,
2488 self.papi.lisp_add_del_locator,
2491 'locator_set_name': ls_name,
2492 'sw_if_index': sw_if_index,
2493 'priority': priority,
2497 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2499 self.papi.lisp_locator_dump,
2501 'is_index_set': is_index_set,
2503 'ls_index': ls_index,
2506 def lisp_local_mapping(self,
2516 self.papi.lisp_add_del_local_eid,
2518 'locator_set_name': ls_name,
2520 'eid_type': eid_type,
2522 'prefix_len': prefix_len,
2528 def lisp_eid_table_dump(self,
2536 self.papi.lisp_eid_table_dump,
2539 'prefix_length': prefix_length,
2541 'eid_type': eid_type,
2543 'filter': filter_opt,
2546 def lisp_remote_mapping(self,
2556 self.papi.lisp_add_del_remote_mapping,
2559 'eid_type': eid_type,
2561 'eid_len': eid_prefix_len,
2562 'rloc_num': rlocs_num,
2565 'is_src_dst': is_src_dst,
2568 def lisp_adjacency(self,
2577 self.papi.lisp_add_del_adjacency,
2581 'eid_type': eid_type,
2584 'leid_len': leid_len,
2585 'reid_len': reid_len,
2588 def lisp_adjacencies_get(self, vni=0):
2590 self.papi.lisp_adjacencies_get,
2595 def map_add_domain(self,
2609 self.papi.map_add_domain,
2611 'ip6_prefix': ip6_prefix,
2612 'ip6_prefix_len': ip6_prefix_len,
2613 'ip4_prefix': ip4_prefix,
2614 'ip4_prefix_len': ip4_prefix_len,
2616 'ip6_src_prefix_len': ip6_src_prefix_len,
2617 'ea_bits_len': ea_bits_len,
2618 'psid_offset': psid_offset,
2619 'psid_length': psid_length,
2620 'is_translation': is_translation,
2621 'is_rfc6052': is_rfc6052,
2625 def gtpu_add_del_tunnel(
2631 mcast_sw_if_index=0xFFFFFFFF,
2633 decap_next_index=0xFFFFFFFF,
2637 :param is_add: (Default value = 1)
2638 :param is_ipv6: (Default value = 0)
2641 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2642 :param encap_vrf_id: (Default value = 0)
2643 :param decap_next_index: (Default value = 0xFFFFFFFF)
2644 :param teid: (Default value = 0)
2647 return self.api(self.papi.gtpu_add_del_tunnel,
2650 'src_address': src_addr,
2651 'dst_address': dst_addr,
2652 'mcast_sw_if_index': mcast_sw_if_index,
2653 'encap_vrf_id': encap_vrf_id,
2654 'decap_next_index': decap_next_index,
2657 def vxlan_gpe_add_del_tunnel(
2661 mcast_sw_if_index=0xFFFFFFFF,
2672 :param is_add: (Default value = 1)
2673 :param is_ipv6: (Default value = 0)
2674 :param encap_vrf_id: (Default value = 0)
2675 :param decap_vrf_id: (Default value = 0)
2676 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2677 :param protocol: (Default value = 3)
2678 :param vni: (Default value = 0)
2681 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2686 'mcast_sw_if_index': mcast_sw_if_index,
2687 'encap_vrf_id': encap_vrf_id,
2688 'decap_vrf_id': decap_vrf_id,
2689 'protocol': protocol,
2692 def pppoe_add_del_session(
2702 :param is_add: (Default value = 1)
2703 :param is_ipv6: (Default value = 0)
2705 :param session_id: (Default value = 0)
2707 :param decap_vrf_id: (Default value = 0)
2710 return self.api(self.papi.pppoe_add_del_session,
2713 'session_id': session_id,
2714 'client_ip': client_ip,
2715 'decap_vrf_id': decap_vrf_id,
2716 'client_mac': client_mac})
2718 def sr_localsid_add_del(self,
2725 sw_if_index=0xFFFFFFFF,
2729 """ Add/del IPv6 SR local-SID.
2732 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2733 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2736 :param is_del: (Default value = 0)
2737 :param end_psp: (Default value = 0)
2738 :param sw_if_index: (Default value = 0xFFFFFFFF)
2739 :param vlan_index: (Default value = 0)
2740 :param fib_table: (Default value = 0)
2743 self.papi.sr_localsid_add_del,
2745 'localsid': localsid,
2747 'behavior': behavior,
2748 'sw_if_index': sw_if_index,
2749 'vlan_index': vlan_index,
2750 'fib_table': fib_table,
2751 'nh_addr4': nh_addr4,
2752 'nh_addr6': nh_addr6
2766 :param bsid_addr: bindingSID of the SR Policy
2767 :param weight: weight of the sid list. optional. (default: 1)
2768 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2770 :param type: type/behavior of the SR policy. (default or spray) \
2772 :param fib_table: VRF where to install the FIB entry for the BSID \
2774 :param n_segments: number of segments \
2776 :param segments: a vector of IPv6 address composing the segment list \
2780 self.papi.sr_policy_add,
2781 {'bsid_addr': bsid_addr,
2783 'is_encap': is_encap,
2785 'fib_table': fib_table,
2786 'n_segments': n_segments,
2787 'segments': segments
2796 :param bsid: bindingSID of the SR Policy
2797 :param sr_policy_index: index of the sr policy (default: 0)
2800 self.papi.sr_policy_del,
2801 {'bsid_addr': bsid_addr,
2802 'sr_policy_index': sr_policy_index
2805 def sr_steering_add_del(
2816 Steer traffic L2 and L3 traffic through a given SR policy
2818 :param is_del: delete or add
2819 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2820 :param sr_policy: is the index of the SR Policy (alt to bsid)
2821 :param table_id: is the VRF where to install the FIB entry for the BSID
2822 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2823 :param mask_width: is the mask for L3 traffic type
2824 :param sw_if_index: is the incoming interface for L2 traffic
2825 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2828 self.papi.sr_steering_add_del,
2830 'bsid_addr': bsid_addr,
2831 'sr_policy_index': sr_policy_index,
2832 'table_id': table_id,
2833 'prefix_addr': prefix_addr,
2834 'mask_width': mask_width,
2835 'sw_if_index': sw_if_index,
2836 'traffic_type': traffic_type
2839 def acl_add_replace(self, acl_index, r, tag='',
2841 """Add/replace an ACL
2842 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2843 :param acl_rule r: ACL rules array.
2844 :param str tag: symbolic tag (description) for this ACL.
2845 :param int count: number of rules.
2847 return self.api(self.papi.acl_add_replace,
2848 {'acl_index': acl_index,
2852 expected_retval=expected_retval)
2854 def acl_del(self, acl_index, expected_retval=0):
2860 return self.api(self.papi.acl_del,
2861 {'acl_index': acl_index},
2862 expected_retval=expected_retval)
2864 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2866 return self.api(self.papi.acl_interface_set_acl_list,
2867 {'sw_if_index': sw_if_index,
2871 expected_retval=expected_retval)
2873 def acl_interface_set_etype_whitelist(self, sw_if_index,
2876 return self.api(self.papi.acl_interface_set_etype_whitelist,
2877 {'sw_if_index': sw_if_index,
2878 'count': len(whitelist),
2880 'whitelist': whitelist},
2881 expected_retval=expected_retval)
2883 def acl_interface_add_del(self,
2887 """ Add/Delete ACL to/from interface
2891 :param is_add: (Default value = 1)
2894 return self.api(self.papi.acl_interface_add_del,
2897 'sw_if_index': sw_if_index,
2898 'acl_index': acl_index})
2900 def acl_dump(self, acl_index, expected_retval=0):
2901 return self.api(self.papi.acl_dump,
2902 {'acl_index': acl_index},
2903 expected_retval=expected_retval)
2905 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2907 return self.api(self.papi.acl_interface_list_dump,
2908 {'sw_if_index': sw_if_index},
2909 expected_retval=expected_retval)
2911 def macip_acl_add(self, rules, tag=""):
2914 :param rules: list of rules for given acl
2918 return self.api(self.papi.macip_acl_add,
2920 'count': len(rules),
2923 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2926 :param rules: list of rules for given acl
2930 return self.api(self.papi.macip_acl_add_replace,
2931 {'acl_index': acl_index,
2933 'count': len(rules),
2936 def macip_acl_del(self, acl_index):
2942 return self.api(self.papi.macip_acl_del,
2943 {'acl_index': acl_index})
2945 def macip_acl_interface_add_del(self,
2949 """ Add MACIP acl to interface
2953 :param is_add: (Default value = 1)
2956 return self.api(self.papi.macip_acl_interface_add_del,
2958 'sw_if_index': sw_if_index,
2959 'acl_index': acl_index})
2961 def macip_acl_interface_get(self):
2962 """ Return interface acls dump
2965 self.papi.macip_acl_interface_get, {})
2967 def macip_acl_dump(self, acl_index=4294967295):
2968 """ Return MACIP acl dump
2972 self.papi.macip_acl_dump, {'acl_index': acl_index})
2974 def policer_add_del(self,
2985 conform_action_type=1,
2987 exceed_action_type=0,
2989 violate_action_type=0,
2991 return self.api(self.papi.policer_add_del,
2998 'rate_type': rate_type,
2999 'round_type': round_type,
3001 'color_aware': color_aware,
3002 'conform_action_type': conform_action_type,
3003 'conform_dscp': conform_dscp,
3004 'exceed_action_type': exceed_action_type,
3005 'exceed_dscp': exceed_dscp,
3006 'violate_action_type': violate_action_type,
3007 'violate_dscp': violate_dscp})
3009 def ip_punt_police(self,
3013 return self.api(self.papi.ip_punt_police,
3014 {'policer_index': policer_index,
3018 def ip_punt_redirect(self,
3024 return self.api(self.papi.ip_punt_redirect,
3025 {'rx_sw_if_index': rx_sw_if_index,
3026 'tx_sw_if_index': tx_sw_if_index,
3031 def bier_table_add_del(self,
3035 """ BIER Table add/del """
3037 self.papi.bier_table_add_del,
3038 {'bt_tbl_id': {"bt_set": bti.set_id,
3039 "bt_sub_domain": bti.sub_domain_id,
3040 "bt_hdr_len_id": bti.hdr_len_id},
3041 'bt_label': mpls_label,
3042 'bt_is_add': is_add})
3044 def bier_table_dump(self):
3045 return self.api(self.papi.bier_table_dump, {})
3047 def bier_route_add_del(self,
3052 """ BIER Route add/del """
3054 self.papi.bier_route_add_del,
3055 {'br_tbl_id': {"bt_set": bti.set_id,
3056 "bt_sub_domain": bti.sub_domain_id,
3057 "bt_hdr_len_id": bti.hdr_len_id},
3059 'br_n_paths': len(paths),
3061 'br_is_add': is_add})
3063 def bier_route_dump(self, bti):
3065 self.papi.bier_route_dump,
3066 {'br_tbl_id': {"bt_set": bti.set_id,
3067 "bt_sub_domain": bti.sub_domain_id,
3068 "bt_hdr_len_id": bti.hdr_len_id}})
3070 def bier_imp_add(self,
3075 """ BIER Imposition Add """
3077 self.papi.bier_imp_add,
3078 {'bi_tbl_id': {"bt_set": bti.set_id,
3079 "bt_sub_domain": bti.sub_domain_id,
3080 "bt_hdr_len_id": bti.hdr_len_id},
3082 'bi_n_bytes': len(ibytes),
3083 'bi_bytes': ibytes})
3085 def bier_imp_del(self, bi_index):
3086 """ BIER Imposition del """
3088 self.papi.bier_imp_del,
3089 {'bi_index': bi_index})
3091 def bier_imp_dump(self):
3092 return self.api(self.papi.bier_imp_dump, {})
3094 def bier_disp_table_add_del(self,
3097 """ BIER Disposition Table add/del """
3099 self.papi.bier_disp_table_add_del,
3100 {'bdt_tbl_id': bdti,
3101 'bdt_is_add': is_add})
3103 def bier_disp_table_dump(self):
3104 return self.api(self.papi.bier_disp_table_dump, {})
3106 def bier_disp_entry_add_del(self,
3116 """ BIER Route add/del """
3118 while (len(lstack) < 16):
3121 self.papi.bier_disp_entry_add_del,
3122 {'bde_tbl_id': bdti,
3124 'bde_payload_proto': payload_proto,
3126 'bde_paths': [{'next_hop': next_hop,
3127 'table_id': next_hop_tbl_id,
3128 'afi': next_hop_afi,
3129 'rpf_id': next_hop_rpf_id,
3131 'label_stack': lstack}],
3132 'bde_is_add': is_add})
3134 def bier_disp_entry_dump(self, bdti):
3136 self.papi.bier_disp_entry_dump,
3137 {'bde_tbl_id': bdti})
3139 def add_node_next(self, node_name, next_name):
3140 """ Set the next node for a given node request
3145 return self.api(self.papi.add_node_next,
3146 {'node_name': node_name,
3147 'next_name': next_name})
3149 def session_enable_disable(self, is_enabled):
3151 self.papi.session_enable_disable,
3152 {'is_enable': is_enabled})
3154 def ipsec_spd_add_del(self, spd_id, is_add=1):
3155 """ SPD add/del - Wrapper to add or del ipsec SPD
3156 Sample CLI : 'ipsec spd add 1'
3158 :param spd_id - SPD ID to be created in the vpp . mandatory
3159 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3161 :returns: reply from the API
3164 self.papi.ipsec_spd_add_del, {
3165 'spd_id': spd_id, 'is_add': is_add})
3167 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3168 """ IPSEC interface SPD add/del - \
3169 Wrapper to associate/disassociate SPD to interface in VPP
3170 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3172 :param spd_id - SPD ID to associate with the interface . mandatory
3173 :param sw_if_index - Interface Index which needs to ipsec \
3174 association mandatory
3175 :param is_add - add(1) or del(0) association with interface \
3176 (Default 1 - add) . optional
3177 :returns: reply from the API
3180 self.papi.ipsec_interface_add_del_spd,
3181 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3183 def ipsec_sad_add_del_entry(self,
3186 integrity_algorithm,
3191 tunnel_src_address='',
3192 tunnel_dst_address='',
3196 """ IPSEC SA add/del
3197 :param sad_id: security association ID
3198 :param spi: security param index of the SA in decimal
3199 :param integrity_algorithm:
3200 :param integrity_key:
3201 :param crypto_algorithm:
3203 :param protocol: AH(0) or ESP(1) protocol
3204 :param tunnel_src_address: tunnel mode outer src address
3205 :param tunnel_dst_address: tunnel mode outer dst address
3208 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3209 crypto and ipsec algorithms
3212 self.papi.ipsec_sad_add_del_entry,
3215 'tunnel_src_address': tunnel_src_address,
3216 'tunnel_dst_address': tunnel_dst_address,
3217 'protocol': protocol,
3218 'integrity_algorithm': integrity_algorithm,
3219 'integrity_key_length': len(integrity_key),
3220 'integrity_key': integrity_key,
3221 'crypto_algorithm': crypto_algorithm,
3222 'crypto_key_length': len(crypto_key) if crypto_key is not None
3224 'crypto_key': crypto_key,
3226 'is_tunnel': is_tunnel,
3227 'udp_encap': udp_encap})
3229 def ipsec_spd_add_del_entry(self,
3232 local_address_start,
3234 remote_address_start,
3235 remote_address_stop,
3237 local_port_stop=65535,
3238 remote_port_start=0,
3239 remote_port_stop=65535,
3246 """ IPSEC policy SPD add/del -
3247 Wrapper to configure ipsec SPD policy entries in VPP
3248 :param spd_id: SPD ID for the policy
3249 :param local_address_start: local-ip-range start address
3250 :param local_address_stop : local-ip-range stop address
3251 :param remote_address_start: remote-ip-range start address
3252 :param remote_address_stop : remote-ip-range stop address
3253 :param local_port_start: (Default value = 0)
3254 :param local_port_stop: (Default value = 65535)
3255 :param remote_port_start: (Default value = 0)
3256 :param remote_port_stop: (Default value = 65535)
3257 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3258 :param sa_id: Security Association ID for mapping it to SPD
3259 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3261 :param priority: value for the spd action (Default value = 100)
3262 :param is_outbound: flag for inbound(0) or outbound(1)
3264 :param is_add: (Default value = 1)
3267 self.papi.ipsec_spd_add_del_entry,
3270 'local_address_start': local_address_start,
3271 'local_address_stop': local_address_stop,
3272 'remote_address_start': remote_address_start,
3273 'remote_address_stop': remote_address_stop,
3274 'local_port_start': local_port_start,
3275 'local_port_stop': local_port_stop,
3276 'remote_port_start': remote_port_start,
3277 'remote_port_stop': remote_port_stop,
3279 'protocol': protocol,
3281 'priority': priority,
3282 'is_outbound': is_outbound,
3283 'is_ip_any': is_ip_any})
3285 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3286 remote_spi, crypto_alg, local_crypto_key,
3287 remote_crypto_key, integ_alg, local_integ_key,
3288 remote_integ_key, is_add=1, esn=0,
3289 anti_replay=1, renumber=0, show_instance=0):
3291 self.papi.ipsec_tunnel_if_add_del,
3292 {'local_ip': local_ip, 'remote_ip': remote_ip,
3293 'local_spi': local_spi, 'remote_spi': remote_spi,
3294 'crypto_alg': crypto_alg,
3295 'local_crypto_key_len': len(local_crypto_key),
3296 'local_crypto_key': local_crypto_key,
3297 'remote_crypto_key_len': len(remote_crypto_key),
3298 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3299 'local_integ_key_len': len(local_integ_key),
3300 'local_integ_key': local_integ_key,
3301 'remote_integ_key_len': len(remote_integ_key),
3302 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3303 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3304 'show_instance': show_instance
3307 def app_namespace_add(self,
3311 sw_if_index=0xFFFFFFFF,
3314 self.papi.app_namespace_add_del,
3316 'sw_if_index': sw_if_index,
3317 'ip4_fib_id': ip4_fib_id,
3318 'ip6_fib_id': ip6_fib_id,
3319 'namespace_id': namespace_id,
3320 'namespace_id_len': len(namespace_id)})
3322 def punt_socket_register(self, l4_port, pathname, header_version=1,
3323 is_ip4=1, l4_protocol=0x11):
3324 """ Punt to socket """
3325 return self.api(self.papi.punt_socket_register,
3327 'l4_protocol': l4_protocol,
3329 'pathname': pathname,
3330 'header_version': header_version})
3332 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3333 expire_walk_interval_ms, is_ip6=0):
3334 """ Set IP reassembly parameters """
3335 return self.api(self.papi.ip_reassembly_set,
3337 'timeout_ms': timeout_ms,
3338 'expire_walk_interval_ms': expire_walk_interval_ms,
3339 'max_reassemblies': max_reassemblies})
3341 def ip_reassembly_get(self, is_ip6=0):
3342 """ Get IP reassembly parameters """
3343 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3345 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3347 """ Enable/disable IP reassembly """
3348 return self.api(self.papi.ip_reassembly_enable_disable,
3349 {'sw_if_index': sw_if_index,
3350 'enable_ip4': 1 if enable_ip4 else 0,
3351 'enable_ip6': 1 if enable_ip6 else 0,
3354 def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
3355 """ GBP endpoint Add/Del """
3356 return self.api(self.papi.gbp_endpoint_add_del,
3360 'sw_if_index': sw_if_index,
3364 def gbp_endpoint_dump(self):
3365 """ GBP endpoint Dump """
3366 return self.api(self.papi.gbp_endpoint_dump, {})
3368 def gbp_endpoint_group_add_del(self, is_add, epg, bd,
3371 uplink_sw_if_index):
3372 """ GBP endpoint group Add/Del """
3373 return self.api(self.papi.gbp_endpoint_group_add_del,
3376 'uplink_sw_if_index': uplink_sw_if_index,
3378 'ip4_table_id': ip4_rd,
3379 'ip6_table_id': ip6_rd,
3382 def gbp_endpoint_group_dump(self):
3383 """ GBP endpoint group Dump """
3384 return self.api(self.papi.gbp_endpoint_group_dump, {})
3386 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3387 """ GBP recirc Add/Del """
3388 return self.api(self.papi.gbp_recirc_add_del,
3392 'sw_if_index': sw_if_index,
3395 def gbp_recirc_dump(self):
3396 """ GBP recirc Dump """
3397 return self.api(self.papi.gbp_recirc_dump, {})
3399 def gbp_subnet_add_del(self, is_add, table_id,
3402 sw_if_index=0xffffffff,
3405 """ GBP Subnet Add/Del """
3406 return self.api(self.papi.gbp_subnet_add_del,
3409 'is_internal': is_internal,
3411 'sw_if_index': sw_if_index,
3414 'address_length': addr_len,
3415 'table_id': table_id}})
3417 def gbp_subnet_dump(self):
3418 """ GBP Subnet Dump """
3419 return self.api(self.papi.gbp_subnet_dump, {})
3421 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3422 """ GBP contract Add/Del """
3423 return self.api(self.papi.gbp_contract_add_del,
3426 'acl_index': acl_index,
3428 'dst_epg': dst_epg}})
3430 def gbp_contract_dump(self):
3431 """ GBP contract Dump """
3432 return self.api(self.papi.gbp_contract_dump, {})
3434 def ipip_6rd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len,
3435 ip4_prefix, ip4_prefix_len, ip4_src,
3437 """ 6RD tunnel Add """
3438 return self.api(self.papi.ipip_6rd_add_tunnel,
3439 {'fib_index': fib_index,
3440 'ip6_prefix': ip6_prefix,
3441 'ip6_prefix_len': ip6_prefix_len,
3442 'ip4_prefix': ip4_prefix,
3443 'ip4_prefix_len': ip4_prefix_len,
3445 'security_check': security_check})
3447 def ipip_6rd_del_tunnel(self, sw_if_index):
3448 """ 6RD tunnel Delete """
3449 return self.api(self.papi.ipip_6rd_del_tunnel,
3450 {'sw_if_index': sw_if_index})
3452 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3453 instance=0xFFFFFFFF, fib_index=0, tc_tos=0):
3454 """ IPIP tunnel Add/Del """
3455 return self.api(self.papi.ipip_add_tunnel,
3456 {'is_ipv6': is_ipv6,
3457 'instance': instance,
3458 'src_address': src_address,
3459 'dst_address': dst_address,
3460 'fib_index': fib_index,
3463 def ipip_del_tunnel(self, sw_if_index):
3464 """ IPIP tunnel Delete """
3465 return self.api(self.papi.ipip_del_tunnel,
3466 {'sw_if_index': sw_if_index})
3468 def qos_egress_map_update(self, id, outputs):
3469 """ QOS egress map update """
3470 return self.api(self.papi.qos_egress_map_update,
3474 def qos_egress_map_delete(self, id):
3475 """ QOS egress map delete """
3476 return self.api(self.papi.qos_egress_map_delete,
3479 def qos_mark_enable_disable(self, sw_if_index,
3483 """ QOS Mark Enable/Disable """
3484 return self.api(self.papi.qos_mark_enable_disable,
3486 'sw_if_index': sw_if_index,
3487 'output_source': output_source,
3490 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3491 """ IP QoS recording Enble/Disable """
3492 return self.api(self.papi.qos_record_enable_disable,
3493 {'sw_if_index': sw_if_index,
3494 'input_source': input_source,
3497 def igmp_enable_disable(self, sw_if_index, enable, host):
3498 """ Enable/disable IGMP on a given interface """
3499 return self.api(self.papi.igmp_enable_disable,
3502 'sw_if_index': sw_if_index})
3504 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3505 """ Listen for new (S,G) on specified interface
3507 :param enable: add/del
3508 :param sw_if_index: interface sw index
3509 :param saddr: source ip4 addr
3510 :param gaddr: group ip4 addr
3512 return self.api(self.papi.igmp_listen,
3517 'sw_if_index': sw_if_index,
3518 'n_srcs': len(saddrs),
3527 def igmp_dump(self, sw_if_index=None):
3528 """ Dump all (S,G) interface configurations """
3529 if sw_if_index is None:
3530 sw_if_index = 0xffffffff
3531 return self.api(self.papi.igmp_dump,
3532 {'sw_if_index': sw_if_index})
3534 def igmp_clear_interface(self, sw_if_index):
3535 """ Remove all (S,G)s from specified interface
3536 doesn't send IGMP report!
3539 self.papi.igmp_clear_interface, {
3540 'sw_if_index': sw_if_index})
3542 def want_igmp_events(self, enable=1):
3543 return self.api(self.papi.want_igmp_events, {'enable': enable,
3544 'pid': os.getpid()})
3554 :param lb: load balance
3555 :param use_custom_mac: use custom mac
3556 :param mac_address: mac address
3559 self.papi.bond_create,
3562 'use_custom_mac': use_custom_mac,
3563 'mac_address': mac_address
3570 :param sw_if_index: interface the operation is applied to
3572 return self.api(self.papi.bond_delete,
3573 {'sw_if_index': sw_if_index})
3582 :param sw_if_index: slave sw_if_index
3583 :param bond_sw_if_index: bond sw_if_index
3584 :param is_passive: is passive lacp speaker
3585 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3588 self.papi.bond_enslave,
3589 {'sw_if_index': sw_if_index,
3590 'bond_sw_if_index': bond_sw_if_index,
3591 'is_passive': is_passive,
3592 'is_long_timeout': is_long_timeout
3595 def bond_detach_slave(
3599 :param sw_if_index: slave interface the operation is applied to
3601 return self.api(self.papi.bond_detach_slave,
3602 {'sw_if_index': sw_if_index})
3604 def sw_interface_slave_dump(
3608 :param sw_if_index: bond sw_if_index
3610 return self.api(self.papi.sw_interface_slave_dump,
3611 {'sw_if_index': sw_if_index})
3613 def sw_interface_bond_dump(
3618 return self.api(self.papi.sw_interface_bond_dump,
3621 def create_vhost_user_if(
3626 custom_dev_instance,
3631 :param is_server: is server
3632 :param sock_filename: socket name
3633 :param renumber: renumber
3634 :param custom_dev_instance: custom dev instance
3635 :param use_custom_mac: use custom mac
3636 :param mac_address: mac address
3637 :param tag: tag (default ''
3640 self.papi.create_vhost_user_if,
3641 {'is_server': is_server,
3642 'sock_filename': sock_filename,
3643 'renumber': renumber,
3644 'custom_dev_instance': custom_dev_instance,
3645 'use_custom_mac': use_custom_mac,
3646 'mac_address': mac_address,
3650 def delete_vhost_user_if(
3654 :param sw_if_index: interface the operation is applied to
3656 return self.api(self.papi.delete_vhost_user_if,
3657 {'sw_if_index': sw_if_index, })
3659 def sw_interface_vhost_user_dump(
3664 return self.api(self.papi.sw_interface_vhost_user_dump,
3667 def abf_policy_add_del(self, is_add, policy):
3669 self.papi.abf_policy_add_del,
3673 def abf_itf_attach_add_del(self, is_add, attach):
3675 self.papi.abf_itf_attach_add_del,
3679 def abf_policy_dump(self):
3681 self.papi.abf_policy_dump, {})
3683 def abf_itf_attach_dump(self):
3685 self.papi.abf_itf_attach_dump, {})
3687 def pipe_create(self, is_specified, user_instance):
3688 return self.api(self.papi.pipe_create,
3689 {'is_specified': is_specified,
3690 'user_instance': user_instance})
3692 def pipe_delete(self, parent_sw_if_index):
3693 return self.api(self.papi.pipe_delete,
3694 {'parent_sw_if_index': parent_sw_if_index})
3696 def pipe_dump(self):
3697 return self.api(self.papi.pipe_dump, {})