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_via_label': next_hop_via_label,
1349 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1351 def nat44_interface_add_del_feature(
1356 """Enable/disable NAT44 feature on the interface
1358 :param sw_if_index: Software index of the interface
1359 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1360 :param is_add: 1 if add, 0 if delete (Default value = 1)
1363 self.papi.nat44_interface_add_del_feature,
1365 'is_inside': is_inside,
1366 'sw_if_index': sw_if_index})
1368 def nat44_interface_add_del_output_feature(
1373 """Enable/disable NAT44 output feature on the interface
1375 :param sw_if_index: Software index of the interface
1376 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1377 :param is_add: 1 if add, 0 if delete (Default value = 1)
1380 self.papi.nat44_interface_add_del_output_feature,
1382 'is_inside': is_inside,
1383 'sw_if_index': sw_if_index})
1385 def nat44_add_del_static_mapping(
1389 external_sw_if_index=0xFFFFFFFF,
1400 """Add/delete NAT44 static mapping
1402 :param local_ip: Local IP address
1403 :param external_ip: External IP address
1404 :param external_sw_if_index: External interface instead of IP address
1405 :param local_port: Local port number (Default value = 0)
1406 :param external_port: External port number (Default value = 0)
1407 :param addr_only: 1 if address only mapping, 0 if address and port
1408 :param vrf_id: VRF ID
1409 :param protocol: IP protocol (Default value = 0)
1410 :param twice_nat: 1 if translate external host address and port
1411 :param self_twice_nat: 1 if translate external host address and port
1412 whenever external host address equals
1413 local address of internal host
1414 :param out2in_only: if 1 rule is matching only out2in direction
1415 :param tag: Opaque string tag
1416 :param is_add: 1 if add, 0 if delete (Default value = 1)
1419 self.papi.nat44_add_del_static_mapping,
1421 'addr_only': addr_only,
1422 'local_ip_address': local_ip,
1423 'external_ip_address': external_ip,
1424 'local_port': local_port,
1425 'external_port': external_port,
1426 'external_sw_if_index': external_sw_if_index,
1428 'protocol': protocol,
1429 'twice_nat': twice_nat,
1430 'self_twice_nat': self_twice_nat,
1431 'out2in_only': out2in_only,
1434 def nat44_add_del_identity_mapping(
1437 sw_if_index=0xFFFFFFFF,
1444 """Add/delete NAT44 identity mapping
1446 :param ip: IP address (Default value = 0)
1447 :param sw_if_index: Interface instead of IP address
1448 :param port: Port number (Default value = 0)
1449 :param addr_only: 1 if address only mapping, 0 if address and port
1450 :param vrf_id: VRF ID
1451 :param protocol: IP protocol (Default value = 0)
1452 :param tag: Opaque string tag
1453 :param is_add: 1 if add, 0 if delete (Default value = 1)
1456 self.papi.nat44_add_del_identity_mapping,
1458 'addr_only': addr_only,
1461 'sw_if_index': sw_if_index,
1464 'protocol': protocol})
1466 def nat44_add_del_address_range(
1473 """Add/del NAT44 address range
1475 :param first_ip_address: First IP address
1476 :param last_ip_address: Last IP address
1477 :param vrf_id: VRF id for the address range
1478 :param twice_nat: twice NAT address for extenal hosts
1479 :param is_add: 1 if add, 0 if delete (Default value = 1)
1482 self.papi.nat44_add_del_address_range,
1483 {'first_ip_address': first_ip_address,
1484 'last_ip_address': last_ip_address,
1486 'twice_nat': twice_nat,
1489 def nat44_address_dump(self):
1490 """Dump NAT44 addresses
1491 :return: Dictionary of NAT44 addresses
1493 return self.api(self.papi.nat44_address_dump, {})
1495 def nat44_interface_dump(self):
1496 """Dump interfaces with NAT44 feature
1497 :return: Dictionary of interfaces with NAT44 feature
1499 return self.api(self.papi.nat44_interface_dump, {})
1501 def nat44_interface_output_feature_dump(self):
1502 """Dump interfaces with NAT44 output feature
1503 :return: Dictionary of interfaces with NAT44 output feature
1505 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1507 def nat44_static_mapping_dump(self):
1508 """Dump NAT44 static mappings
1509 :return: Dictionary of NAT44 static mappings
1511 return self.api(self.papi.nat44_static_mapping_dump, {})
1513 def nat44_identity_mapping_dump(self):
1514 """Dump NAT44 identity mappings
1515 :return: Dictionary of NAT44 identity mappings
1517 return self.api(self.papi.nat44_identity_mapping_dump, {})
1519 def nat_show_config(self):
1520 """Show NAT plugin config
1521 :return: NAT plugin config parameters
1523 return self.api(self.papi.nat_show_config, {})
1525 def nat44_add_interface_addr(
1530 """Add/del NAT44 address from interface
1532 :param sw_if_index: Software index of the interface
1533 :param twice_nat: twice NAT address for extenal hosts
1534 :param is_add: 1 if add, 0 if delete (Default value = 1)
1537 self.papi.nat44_add_del_interface_addr,
1539 'sw_if_index': sw_if_index,
1540 'twice_nat': twice_nat})
1542 def nat44_interface_addr_dump(self):
1543 """Dump NAT44 addresses interfaces
1544 :return: Dictionary of NAT44 addresses interfaces
1546 return self.api(self.papi.nat44_interface_addr_dump, {})
1553 """Enable/disable NAT IPFIX logging
1555 :param domain_id: Observation domain ID (Default value = 1)
1556 :param src_port: Source port number (Default value = 4739)
1557 :param enable: 1 if enable, 0 if disable (Default value = 1)
1560 self.papi.nat_ipfix_enable_disable,
1561 {'domain_id': domain_id,
1562 'src_port': src_port,
1565 def nat44_user_session_dump(
1569 """Dump NAT44 user's sessions
1571 :param ip_address: ip adress of the user to be dumped
1572 :param cpu_index: cpu_index on which the user is
1573 :param vrf_id: VRF ID
1574 :return: Dictionary of S-NAT sessions
1577 self.papi.nat44_user_session_dump,
1578 {'ip_address': ip_address,
1581 def nat44_user_dump(self):
1584 :return: Dictionary of NAT44 users
1586 return self.api(self.papi.nat44_user_dump, {})
1588 def nat44_add_del_lb_static_mapping(
1601 """Add/delete NAT44 load balancing static mapping
1603 :param twice_nat: 1 if translate external host address and port
1604 :param tag: Opaque string tag
1605 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1606 :param is_add - 1 if add, 0 if delete
1609 self.papi.nat44_add_del_lb_static_mapping,
1611 'external_addr': external_addr,
1612 'external_port': external_port,
1613 'protocol': protocol,
1614 'twice_nat': twice_nat,
1615 'self_twice_nat': self_twice_nat,
1616 'out2in_only': out2in_only,
1618 'affinity': affinity,
1619 'local_num': local_num,
1622 def nat44_lb_static_mapping_dump(self):
1623 """Dump NAT44 load balancing static mappings
1625 :return: Dictionary of NAT44 load balancing static mapping
1627 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1629 def nat44_del_session(
1636 ext_host_address=None,
1638 """Delete NAT44 session
1640 :param addr: IPv4 address
1641 :param por: port number
1642 :param protocol: IP protocol number
1643 :param vrf_id: VRF ID
1644 :param is_in: 1 if inside network addres and port pari, 0 if outside
1645 :param ext_host_address: external host IPv4 address
1646 :param ext_host_port: external host port
1648 if ext_host_address is None:
1650 self.papi.nat44_del_session,
1653 'protocol': protocol,
1658 self.papi.nat44_del_session,
1661 'protocol': protocol,
1664 'ext_host_valid': 1,
1665 'ext_host_address': ext_host_address,
1666 'ext_host_port': ext_host_port})
1668 def nat44_forwarding_enable_disable(
1671 """Enable/disable forwarding for NAT44
1673 :param enable: 1 for enable, 0 for disable
1676 self.papi.nat44_forwarding_enable_disable,
1686 """Set NAT virtual fragmentation reassembly
1688 :param timeout: reassembly timeout (Default 2sec)
1689 :param max_reass: maximum concurrent reassemblies (Default 1024)
1690 :param max_frag: maximum fragmets per reassembly (Default 5)
1691 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1692 :param is_ip6: 1 if IPv6, 0 if IPv4
1695 self.papi.nat_set_reass,
1696 {'timeout': timeout,
1697 'max_reass': max_reass,
1698 'max_frag': max_frag,
1699 'drop_frag': drop_frag,
1702 def nat_get_reass(self):
1703 """Get NAT virtual fragmentation reassembly configuration
1705 :return: NAT virtual fragmentation reassembly configuration
1707 return self.api(self.papi.nat_get_reass, {})
1709 def nat_reass_dump(self):
1710 """Dump NAT virtual fragmentation reassemblies
1712 :return: Dictionary of NAT virtual fragmentation reassemblies
1714 return self.api(self.papi.nat_reass_dump, {})
1716 def nat_det_add_del_map(
1723 """Add/delete deterministic NAT mapping
1725 :param is_add - 1 if add, 0 if delete
1726 :param in_addr - inside IP address
1727 :param in_plen - inside IP address prefix length
1728 :param out_addr - outside IP address
1729 :param out_plen - outside IP address prefix length
1732 self.papi.nat_det_add_del_map,
1737 'out_addr': out_addr,
1738 'out_plen': out_plen})
1740 def nat_det_forward(
1743 """Get outside address and port range from inside address
1745 :param in_addr - inside IP address
1748 self.papi.nat_det_forward,
1749 {'in_addr': in_addr,
1752 def nat_det_reverse(
1756 """Get inside address from outside address and port
1758 :param out_addr - outside IP address
1759 :param out_port - outside port
1762 self.papi.nat_det_reverse,
1763 {'out_addr': out_addr,
1764 'out_port': out_port})
1766 def nat_det_map_dump(self):
1767 """Dump deterministic NAT mappings
1769 :return: Dictionary of deterministic NAT mappings
1771 return self.api(self.papi.nat_det_map_dump, {})
1773 def nat_set_timeouts(
1776 tcp_established=7440,
1779 """Set values of timeouts for NAT sessions (in seconds)
1781 :param udp - UDP timeout (Default value = 300)
1782 :param tcp_established - TCP established timeout (Default value = 7440)
1783 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1784 :param icmp - ICMP timeout (Default value = 60)
1787 self.papi.nat_set_timeouts,
1789 'tcp_established': tcp_established,
1790 'tcp_transitory': tcp_transitory,
1793 def nat_get_timeouts(self):
1794 """Get values of timeouts for NAT sessions
1796 :return: Timeouts for NAT sessions (in seconds)
1798 return self.api(self.papi.nat_get_timeouts, {})
1800 def nat_set_addr_and_port_alloc_alg(
1808 """Set address and port assignment algorithm
1810 :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1811 :param psid_offset: number of offset bits (valid only for MAP-E alg)
1812 :param psid_length: length of PSID (valid only for MAP-E alg)
1813 :param psid: Port Set Identifier value (valid only for MAP-E alg)
1814 :param start_port: beginning of the port range
1815 :param end_port: end of the port range
1818 self.papi.nat_set_addr_and_port_alloc_alg,
1820 'psid_offset': psid_offset,
1821 'psid_length': psid_length,
1823 'start_port': start_port,
1824 'end_port': end_port})
1826 def nat_get_addr_and_port_alloc_alg(self):
1827 """Get address and port assignment algorithm"""
1828 return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1830 def nat_det_close_session_out(
1836 """Close deterministic NAT session using outside address and port
1838 :param out_addr - outside IP address
1839 :param out_port - outside port
1840 :param ext_addr - external host IP address
1841 :param ext_port - external host port
1844 self.papi.nat_det_close_session_out,
1845 {'out_addr': out_addr,
1846 'out_port': out_port,
1847 'ext_addr': ext_addr,
1848 'ext_port': ext_port})
1850 def nat_det_close_session_in(
1856 """Close deterministic NAT session using inside address and port
1858 :param in_addr - inside IP address
1859 :param in_port - inside port
1860 :param ext_addr - external host IP address
1861 :param ext_port - external host port
1864 self.papi.nat_det_close_session_in,
1865 {'in_addr': in_addr,
1867 'ext_addr': ext_addr,
1868 'ext_port': ext_port,
1871 def nat_det_session_dump(
1874 """Dump deterministic NAT sessions belonging to a user
1876 :param user_addr - inside IP address of the user
1877 :return: Dictionary of deterministic NAT sessions
1880 self.papi.nat_det_session_dump,
1882 'user_addr': user_addr})
1884 def nat64_add_del_pool_addr_range(
1890 """Add/del address range to NAT64 pool
1892 :param start_addr: First IP address
1893 :param end_addr: Last IP address
1894 :param vrf_id: VRF id for the address range
1895 :param is_add: 1 if add, 0 if delete (Default value = 1)
1898 self.papi.nat64_add_del_pool_addr_range,
1899 {'start_addr': start_addr,
1900 'end_addr': end_addr,
1904 def nat64_pool_addr_dump(self):
1905 """Dump NAT64 pool addresses
1906 :return: Dictionary of NAT64 pool addresses
1908 return self.api(self.papi.nat64_pool_addr_dump, {})
1910 def nat64_add_del_interface(
1915 """Enable/disable NAT64 feature on the interface
1916 :param sw_if_index: Index of the interface
1917 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1918 :param is_add: 1 if add, 0 if delete (Default value = 1)
1921 self.papi.nat64_add_del_interface,
1922 {'sw_if_index': sw_if_index,
1923 'is_inside': is_inside,
1926 def nat64_interface_dump(self):
1927 """Dump interfaces with NAT64 feature
1928 :return: Dictionary of interfaces with NAT64 feature
1930 return self.api(self.papi.nat64_interface_dump, {})
1932 def nat64_add_del_static_bib(
1941 """Add/delete S-NAT static BIB entry
1943 :param in_ip: Inside IPv6 address
1944 :param out_ip: Outside IPv4 address
1945 :param in_port: Inside port number
1946 :param out_port: Outside port number
1947 :param protocol: IP protocol
1948 :param vrf_id: VRF ID (Default value = 0)
1949 :param is_add: 1 if add, 0 if delete (Default value = 1)
1952 self.papi.nat64_add_del_static_bib,
1961 def nat64_bib_dump(self, protocol=255):
1964 :param protocol: IP protocol (Default value = 255, all BIBs)
1965 :returns: Dictionary of NAT64 BIB entries
1967 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1969 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1970 tcp_incoming_syn=6):
1971 """Set values of timeouts for NAT64 (in seconds)
1973 :param udpi: UDP timeout (Default value = 300)
1974 :param icmp: ICMP timeout (Default value = 60)
1975 :param tcp_trans: TCP transitory timeout (Default value = 240)
1976 :param tcp_est: TCP established timeout (Default value = 7440)
1977 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1980 self.papi.nat64_set_timeouts,
1983 'tcp_trans': tcp_trans,
1985 'tcp_incoming_syn': tcp_incoming_syn})
1987 def nat64_get_timeouts(self):
1988 """Get values of timeouts for NAT64
1990 :return: Timeouts for NAT64 (in seconds)
1992 return self.api(self.papi.nat64_get_timeouts, {})
1994 def nat64_st_dump(self, protocol=255):
1995 """Dump NAT64 session table
1997 :param protocol: IP protocol (Default value = 255, all STs)
1998 :returns: Dictionary of NAT64 sesstion table entries
2000 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2002 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2003 """Add/del NAT64 prefix
2005 :param prefix: NAT64 prefix
2006 :param plen: NAT64 prefix length
2007 :param vrf_id: VRF id of tenant (Default 0)
2008 :param is_add: 1 if add, 0 if delete (Default value = 1)
2011 self.papi.nat64_add_del_prefix,
2017 def nat64_prefix_dump(self):
2018 """Dump NAT64 prefix
2020 :returns: Dictionary of NAT64 prefixes
2022 return self.api(self.papi.nat64_prefix_dump, {})
2024 def nat64_add_interface_addr(
2028 """Add/del NAT64 address from interface
2030 :param sw_if_index: Software index of the interface
2031 :param is_add: 1 if add, 0 if delete (Default value = 1)
2033 return self.api(self.papi.nat64_add_del_interface_addr,
2034 {'is_add': is_add, 'sw_if_index': sw_if_index})
2036 def dslite_set_aftr_addr(self, ip6, ip4):
2037 """Set DS-Lite AFTR addresses
2039 :param ip4: IPv4 address
2040 :param ip6: IPv6 address
2043 self.papi.dslite_set_aftr_addr,
2047 def dslite_set_b4_addr(self, ip6, ip4):
2048 """Set DS-Lite B4 IPv6 address
2050 :param ip4: IPv4 address
2051 :param ip6: IPv6 address
2054 self.papi.dslite_set_b4_addr,
2058 def dslite_add_del_pool_addr_range(
2063 """Add/del address range to DS-Lite pool
2065 :param start_addr: First IP address
2066 :param end_addr: Last IP address
2067 :param is_add: 1 if add, 0 if delete (Default value = 1)
2070 self.papi.dslite_add_del_pool_addr_range,
2071 {'start_addr': start_addr,
2072 'end_addr': end_addr,
2075 def nat66_add_del_interface(
2080 """Enable/disable NAT66 feature on the interface
2081 :param sw_if_index: Index of the interface
2082 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2083 :param is_add: 1 if add, 0 if delete (Default value = 1)
2086 self.papi.nat66_add_del_interface,
2087 {'sw_if_index': sw_if_index,
2088 'is_inside': is_inside,
2091 def nat66_add_del_static_mapping(
2097 """Add/delete NAT66 static mapping
2099 :param in_ip: Inside IPv6 address
2100 :param out_ip: Outside IPv6 address
2101 :param vrf_id: VRF ID (Default value = 0)
2102 :param is_add: 1 if add, 0 if delete (Default value = 1)
2105 self.papi.nat66_add_del_static_mapping,
2106 {'local_ip_address': in_ip,
2107 'external_ip_address': out_ip,
2111 def nat66_interface_dump(self):
2112 """Dump interfaces with NAT66 feature
2113 :return: Dictionary of interfaces with NAT66 feature
2115 return self.api(self.papi.nat66_interface_dump, {})
2117 def nat66_static_mapping_dump(self):
2118 """Dump NAT66 static mappings
2119 :return: Dictionary of NAT66 static mappings
2121 return self.api(self.papi.nat66_static_mapping_dump, {})
2123 def control_ping(self):
2124 self.api(self.papi.control_ping)
2126 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2127 detect_mult, local_addr, peer_addr, is_ipv6=0,
2128 bfd_key_id=None, conf_key_id=None):
2129 if bfd_key_id is None:
2130 return self.api(self.papi.bfd_udp_add,
2132 'sw_if_index': sw_if_index,
2133 'desired_min_tx': desired_min_tx,
2134 'required_min_rx': required_min_rx,
2135 'local_addr': local_addr,
2136 'peer_addr': peer_addr,
2138 'detect_mult': detect_mult,
2141 return self.api(self.papi.bfd_udp_add,
2143 'sw_if_index': sw_if_index,
2144 'desired_min_tx': desired_min_tx,
2145 'required_min_rx': required_min_rx,
2146 'local_addr': local_addr,
2147 'peer_addr': peer_addr,
2149 'detect_mult': detect_mult,
2150 'is_authenticated': 1,
2151 'bfd_key_id': bfd_key_id,
2152 'conf_key_id': conf_key_id,
2155 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2156 detect_mult, local_addr, peer_addr, is_ipv6=0):
2157 return self.api(self.papi.bfd_udp_mod,
2159 'sw_if_index': sw_if_index,
2160 'desired_min_tx': desired_min_tx,
2161 'required_min_rx': required_min_rx,
2162 'local_addr': local_addr,
2163 'peer_addr': peer_addr,
2165 'detect_mult': detect_mult,
2168 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2169 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2171 return self.api(self.papi.bfd_udp_auth_activate,
2173 'sw_if_index': sw_if_index,
2174 'local_addr': local_addr,
2175 'peer_addr': peer_addr,
2177 'is_delayed': 1 if is_delayed else 0,
2178 'bfd_key_id': bfd_key_id,
2179 'conf_key_id': conf_key_id,
2182 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2183 is_ipv6=0, is_delayed=False):
2184 return self.api(self.papi.bfd_udp_auth_deactivate,
2186 'sw_if_index': sw_if_index,
2187 'local_addr': local_addr,
2188 'peer_addr': peer_addr,
2190 'is_delayed': 1 if is_delayed else 0,
2193 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2194 return self.api(self.papi.bfd_udp_del,
2196 'sw_if_index': sw_if_index,
2197 'local_addr': local_addr,
2198 'peer_addr': peer_addr,
2202 def bfd_udp_session_dump(self):
2203 return self.api(self.papi.bfd_udp_session_dump, {})
2205 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2206 peer_addr, is_ipv6=0):
2207 return self.api(self.papi.bfd_udp_session_set_flags, {
2208 'admin_up_down': admin_up_down,
2209 'sw_if_index': sw_if_index,
2210 'local_addr': local_addr,
2211 'peer_addr': peer_addr,
2215 def want_bfd_events(self, enable_disable=1):
2216 return self.api(self.papi.want_bfd_events, {
2217 'enable_disable': enable_disable,
2221 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2222 return self.api(self.papi.bfd_auth_set_key, {
2223 'conf_key_id': conf_key_id,
2224 'auth_type': auth_type,
2226 'key_len': len(key),
2229 def bfd_auth_del_key(self, conf_key_id):
2230 return self.api(self.papi.bfd_auth_del_key, {
2231 'conf_key_id': conf_key_id,
2234 def bfd_auth_keys_dump(self):
2235 return self.api(self.papi.bfd_auth_keys_dump, {})
2237 def bfd_udp_set_echo_source(self, sw_if_index):
2238 return self.api(self.papi.bfd_udp_set_echo_source,
2239 {'sw_if_index': sw_if_index})
2241 def bfd_udp_del_echo_source(self):
2242 return self.api(self.papi.bfd_udp_del_echo_source, {})
2244 def classify_add_del_table(
2249 table_index=0xFFFFFFFF,
2251 memory_size=2097152,
2253 next_table_index=0xFFFFFFFF,
2254 miss_next_index=0xFFFFFFFF,
2255 current_data_flag=0,
2256 current_data_offset=0):
2260 :param match_n_vectors: (Default value = 1)
2261 :param table_index: (Default value = 0xFFFFFFFF)
2262 :param nbuckets: (Default value = 2)
2263 :param memory_size: (Default value = 2097152)
2264 :param skip_n_vectors: (Default value = 0)
2265 :param next_table_index: (Default value = 0xFFFFFFFF)
2266 :param miss_next_index: (Default value = 0xFFFFFFFF)
2267 :param current_data_flag: (Default value = 0)
2268 :param current_data_offset: (Default value = 0)
2271 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2272 mask = mask + '\0' * (mask_len - len(mask))
2274 self.papi.classify_add_del_table,
2276 'table_index': table_index,
2277 'nbuckets': nbuckets,
2278 'memory_size': memory_size,
2279 'skip_n_vectors': skip_n_vectors,
2280 'match_n_vectors': match_n_vectors,
2281 'next_table_index': next_table_index,
2282 'miss_next_index': miss_next_index,
2283 'current_data_flag': current_data_flag,
2284 'current_data_offset': current_data_offset,
2285 'mask_len': mask_len,
2288 def classify_add_del_session(
2293 opaque_index=0xFFFFFFFF,
2294 hit_next_index=0xFFFFFFFF,
2302 :param opaque_index: (Default value = 0xFFFFFFFF)
2303 :param hit_next_index: (Default value = 0xFFFFFFFF)
2304 :param advance: (Default value = 0)
2305 :param action: (Default value = 0)
2306 :param metadata: (Default value = 0)
2309 match_len = ((len(match) - 1) / 16 + 1) * 16
2310 match = match + '\0' * (match_len - len(match))
2312 self.papi.classify_add_del_session,
2314 'table_index': table_index,
2315 'hit_next_index': hit_next_index,
2316 'opaque_index': opaque_index,
2319 'metadata': metadata,
2320 'match_len': match_len,
2323 def input_acl_set_interface(
2327 ip4_table_index=0xFFFFFFFF,
2328 ip6_table_index=0xFFFFFFFF,
2329 l2_table_index=0xFFFFFFFF):
2333 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2334 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2335 :param l2_table_index: (Default value = 0xFFFFFFFF)
2339 self.papi.input_acl_set_interface,
2340 {'sw_if_index': sw_if_index,
2341 'ip4_table_index': ip4_table_index,
2342 'ip6_table_index': ip6_table_index,
2343 'l2_table_index': l2_table_index,
2346 def output_acl_set_interface(
2350 ip4_table_index=0xFFFFFFFF,
2351 ip6_table_index=0xFFFFFFFF,
2352 l2_table_index=0xFFFFFFFF):
2356 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2357 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2358 :param l2_table_index: (Default value = 0xFFFFFFFF)
2362 self.papi.output_acl_set_interface,
2363 {'sw_if_index': sw_if_index,
2364 'ip4_table_index': ip4_table_index,
2365 'ip6_table_index': ip6_table_index,
2366 'l2_table_index': l2_table_index,
2369 def set_ipfix_exporter(
2376 collector_port=4739,
2379 self.papi.set_ipfix_exporter,
2381 'collector_address': collector_address,
2382 'collector_port': collector_port,
2383 'src_address': src_address,
2385 'path_mtu': path_mtu,
2386 'template_interval': template_interval,
2387 'udp_checksum': udp_checksum,
2390 def dhcp_proxy_config(self,
2398 self.papi.dhcp_proxy_config,
2400 'rx_vrf_id': rx_table_id,
2401 'server_vrf_id': server_table_id,
2404 'dhcp_server': dhcp_server,
2405 'dhcp_src_address': dhcp_src_address,
2408 def dhcp_proxy_set_vss(self,
2417 self.papi.dhcp_proxy_set_vss,
2420 'vss_type': vss_type,
2421 'vpn_ascii_id': vpn_ascii_id,
2423 'vpn_index': vpn_index,
2428 def dhcp_client_dump(self):
2429 return self.api(self.papi.dhcp_client_dump, {})
2431 def dhcp_client(self,
2436 set_broadcast_flag=1,
2437 want_dhcp_events=0):
2439 self.papi.dhcp_client_config,
2443 'sw_if_index': sw_if_index,
2444 'hostname': hostname,
2446 'want_dhcp_event': want_dhcp_events,
2447 'set_broadcast_flag': set_broadcast_flag,
2451 def ip_mroute_add_del(self,
2457 next_hop_sw_if_index,
2467 IP Multicast Route add/del
2470 self.papi.ip_mroute_add_del,
2471 {'next_hop_sw_if_index': next_hop_sw_if_index,
2472 'entry_flags': e_flags,
2473 'itf_flags': i_flags,
2474 'table_id': table_id,
2478 'is_local': is_local,
2479 'bier_imp': bier_imp,
2480 'next_hop_afi': next_hop_afi,
2481 'grp_address_length': grp_address_length,
2482 'grp_address': grp_address,
2483 'src_address': src_address,
2484 'nh_address': next_hop_address})
2486 def mfib_signal_dump(self):
2487 return self.api(self.papi.mfib_signal_dump, {})
2489 def ip_mfib_dump(self):
2490 return self.api(self.papi.ip_mfib_dump, {})
2492 def ip6_mfib_dump(self):
2493 return self.api(self.papi.ip6_mfib_dump, {})
2495 def lisp_enable_disable(self, is_enabled):
2497 self.papi.lisp_enable_disable,
2499 'is_en': is_enabled,
2502 def lisp_locator_set(self,
2506 self.papi.lisp_add_del_locator_set,
2509 'locator_set_name': ls_name
2512 def lisp_locator_set_dump(self):
2513 return self.api(self.papi.lisp_locator_set_dump, {})
2515 def lisp_locator(self,
2522 self.papi.lisp_add_del_locator,
2525 'locator_set_name': ls_name,
2526 'sw_if_index': sw_if_index,
2527 'priority': priority,
2531 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2533 self.papi.lisp_locator_dump,
2535 'is_index_set': is_index_set,
2537 'ls_index': ls_index,
2540 def lisp_local_mapping(self,
2550 self.papi.lisp_add_del_local_eid,
2552 'locator_set_name': ls_name,
2554 'eid_type': eid_type,
2556 'prefix_len': prefix_len,
2562 def lisp_eid_table_dump(self,
2570 self.papi.lisp_eid_table_dump,
2573 'prefix_length': prefix_length,
2575 'eid_type': eid_type,
2577 'filter': filter_opt,
2580 def lisp_remote_mapping(self,
2590 self.papi.lisp_add_del_remote_mapping,
2593 'eid_type': eid_type,
2595 'eid_len': eid_prefix_len,
2596 'rloc_num': rlocs_num,
2599 'is_src_dst': is_src_dst,
2602 def lisp_adjacency(self,
2611 self.papi.lisp_add_del_adjacency,
2615 'eid_type': eid_type,
2618 'leid_len': leid_len,
2619 'reid_len': reid_len,
2622 def lisp_adjacencies_get(self, vni=0):
2624 self.papi.lisp_adjacencies_get,
2629 def map_add_domain(self,
2643 self.papi.map_add_domain,
2645 'ip6_prefix': ip6_prefix,
2646 'ip6_prefix_len': ip6_prefix_len,
2647 'ip4_prefix': ip4_prefix,
2648 'ip4_prefix_len': ip4_prefix_len,
2650 'ip6_src_prefix_len': ip6_src_prefix_len,
2651 'ea_bits_len': ea_bits_len,
2652 'psid_offset': psid_offset,
2653 'psid_length': psid_length,
2654 'is_translation': is_translation,
2655 'is_rfc6052': is_rfc6052,
2659 def gtpu_add_del_tunnel(
2665 mcast_sw_if_index=0xFFFFFFFF,
2667 decap_next_index=0xFFFFFFFF,
2671 :param is_add: (Default value = 1)
2672 :param is_ipv6: (Default value = 0)
2675 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2676 :param encap_vrf_id: (Default value = 0)
2677 :param decap_next_index: (Default value = 0xFFFFFFFF)
2678 :param teid: (Default value = 0)
2681 return self.api(self.papi.gtpu_add_del_tunnel,
2684 'src_address': src_addr,
2685 'dst_address': dst_addr,
2686 'mcast_sw_if_index': mcast_sw_if_index,
2687 'encap_vrf_id': encap_vrf_id,
2688 'decap_next_index': decap_next_index,
2691 def vxlan_gpe_add_del_tunnel(
2695 mcast_sw_if_index=0xFFFFFFFF,
2706 :param is_add: (Default value = 1)
2707 :param is_ipv6: (Default value = 0)
2708 :param encap_vrf_id: (Default value = 0)
2709 :param decap_vrf_id: (Default value = 0)
2710 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2711 :param protocol: (Default value = 3)
2712 :param vni: (Default value = 0)
2715 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2720 'mcast_sw_if_index': mcast_sw_if_index,
2721 'encap_vrf_id': encap_vrf_id,
2722 'decap_vrf_id': decap_vrf_id,
2723 'protocol': protocol,
2726 def vxlan_gbp_tunnel_add_del(
2730 mcast_sw_if_index=0xFFFFFFFF,
2734 decap_next_index=0xFFFFFFFF,
2736 instance=0xFFFFFFFF):
2741 :param is_add: (Default value = 1)
2742 :param is_ipv6: (Default value = 0)
2743 :param encap_table_id: (Default value = 0)
2744 :param decap_next_index: (Default value = 0xFFFFFFFF)
2745 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2746 :param vni: (Default value = 0)
2747 :param instance: (Default value = 0xFFFFFFFF)
2750 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2755 'mcast_sw_if_index': mcast_sw_if_index,
2756 'encap_table_id': encap_table_id,
2757 'decap_next_index': decap_next_index,
2759 'instance': instance}})
2761 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2762 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2763 {'sw_if_index': sw_if_index})
2765 def pppoe_add_del_session(
2775 :param is_add: (Default value = 1)
2776 :param is_ipv6: (Default value = 0)
2778 :param session_id: (Default value = 0)
2780 :param decap_vrf_id: (Default value = 0)
2783 return self.api(self.papi.pppoe_add_del_session,
2786 'session_id': session_id,
2787 'client_ip': client_ip,
2788 'decap_vrf_id': decap_vrf_id,
2789 'client_mac': client_mac})
2791 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2792 return self.api(self.papi.sr_mpls_policy_add,
2796 'n_segments': len(segments),
2797 'segments': segments})
2799 def sr_mpls_policy_del(self, bsid):
2800 return self.api(self.papi.sr_mpls_policy_del,
2803 def sr_localsid_add_del(self,
2810 sw_if_index=0xFFFFFFFF,
2814 """ Add/del IPv6 SR local-SID.
2817 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2818 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2821 :param is_del: (Default value = 0)
2822 :param end_psp: (Default value = 0)
2823 :param sw_if_index: (Default value = 0xFFFFFFFF)
2824 :param vlan_index: (Default value = 0)
2825 :param fib_table: (Default value = 0)
2828 self.papi.sr_localsid_add_del,
2830 'localsid': localsid,
2832 'behavior': behavior,
2833 'sw_if_index': sw_if_index,
2834 'vlan_index': vlan_index,
2835 'fib_table': fib_table,
2836 'nh_addr4': nh_addr4,
2837 'nh_addr6': nh_addr6
2851 :param bsid_addr: bindingSID of the SR Policy
2852 :param weight: weight of the sid list. optional. (default: 1)
2853 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2855 :param type: type/behavior of the SR policy. (default or spray) \
2857 :param fib_table: VRF where to install the FIB entry for the BSID \
2859 :param n_segments: number of segments \
2861 :param segments: a vector of IPv6 address composing the segment list \
2865 self.papi.sr_policy_add,
2866 {'bsid_addr': bsid_addr,
2868 'is_encap': is_encap,
2870 'fib_table': fib_table,
2871 'n_segments': n_segments,
2872 'segments': segments
2881 :param bsid: bindingSID of the SR Policy
2882 :param sr_policy_index: index of the sr policy (default: 0)
2885 self.papi.sr_policy_del,
2886 {'bsid_addr': bsid_addr,
2887 'sr_policy_index': sr_policy_index
2890 def sr_steering_add_del(
2901 Steer traffic L2 and L3 traffic through a given SR policy
2903 :param is_del: delete or add
2904 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2905 :param sr_policy: is the index of the SR Policy (alt to bsid)
2906 :param table_id: is the VRF where to install the FIB entry for the BSID
2907 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2908 :param mask_width: is the mask for L3 traffic type
2909 :param sw_if_index: is the incoming interface for L2 traffic
2910 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2913 self.papi.sr_steering_add_del,
2915 'bsid_addr': bsid_addr,
2916 'sr_policy_index': sr_policy_index,
2917 'table_id': table_id,
2918 'prefix_addr': prefix_addr,
2919 'mask_width': mask_width,
2920 'sw_if_index': sw_if_index,
2921 'traffic_type': traffic_type
2924 def acl_add_replace(self, acl_index, r, tag='',
2926 """Add/replace an ACL
2927 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2928 :param acl_rule r: ACL rules array.
2929 :param str tag: symbolic tag (description) for this ACL.
2930 :param int count: number of rules.
2932 return self.api(self.papi.acl_add_replace,
2933 {'acl_index': acl_index,
2937 expected_retval=expected_retval)
2939 def acl_del(self, acl_index, expected_retval=0):
2945 return self.api(self.papi.acl_del,
2946 {'acl_index': acl_index},
2947 expected_retval=expected_retval)
2949 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2951 return self.api(self.papi.acl_interface_set_acl_list,
2952 {'sw_if_index': sw_if_index,
2956 expected_retval=expected_retval)
2958 def acl_interface_set_etype_whitelist(self, sw_if_index,
2961 return self.api(self.papi.acl_interface_set_etype_whitelist,
2962 {'sw_if_index': sw_if_index,
2963 'count': len(whitelist),
2965 'whitelist': whitelist},
2966 expected_retval=expected_retval)
2968 def acl_interface_add_del(self,
2972 """ Add/Delete ACL to/from interface
2976 :param is_add: (Default value = 1)
2979 return self.api(self.papi.acl_interface_add_del,
2982 'sw_if_index': sw_if_index,
2983 'acl_index': acl_index})
2985 def acl_dump(self, acl_index, expected_retval=0):
2986 return self.api(self.papi.acl_dump,
2987 {'acl_index': acl_index},
2988 expected_retval=expected_retval)
2990 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2992 return self.api(self.papi.acl_interface_list_dump,
2993 {'sw_if_index': sw_if_index},
2994 expected_retval=expected_retval)
2996 def macip_acl_add(self, rules, tag=""):
2999 :param rules: list of rules for given acl
3003 return self.api(self.papi.macip_acl_add,
3005 'count': len(rules),
3008 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3011 :param rules: list of rules for given acl
3015 return self.api(self.papi.macip_acl_add_replace,
3016 {'acl_index': acl_index,
3018 'count': len(rules),
3021 def macip_acl_del(self, acl_index):
3027 return self.api(self.papi.macip_acl_del,
3028 {'acl_index': acl_index})
3030 def macip_acl_interface_add_del(self,
3034 """ Add MACIP acl to interface
3038 :param is_add: (Default value = 1)
3041 return self.api(self.papi.macip_acl_interface_add_del,
3043 'sw_if_index': sw_if_index,
3044 'acl_index': acl_index})
3046 def macip_acl_interface_get(self):
3047 """ Return interface acls dump
3050 self.papi.macip_acl_interface_get, {})
3052 def macip_acl_dump(self, acl_index=4294967295):
3053 """ Return MACIP acl dump
3057 self.papi.macip_acl_dump, {'acl_index': acl_index})
3059 def policer_add_del(self,
3070 conform_action_type=1,
3072 exceed_action_type=0,
3074 violate_action_type=0,
3076 return self.api(self.papi.policer_add_del,
3083 'rate_type': rate_type,
3084 'round_type': round_type,
3086 'color_aware': color_aware,
3087 'conform_action_type': conform_action_type,
3088 'conform_dscp': conform_dscp,
3089 'exceed_action_type': exceed_action_type,
3090 'exceed_dscp': exceed_dscp,
3091 'violate_action_type': violate_action_type,
3092 'violate_dscp': violate_dscp})
3094 def ip_punt_police(self,
3098 return self.api(self.papi.ip_punt_police,
3099 {'policer_index': policer_index,
3103 def ip_punt_redirect(self,
3109 return self.api(self.papi.ip_punt_redirect,
3110 {'rx_sw_if_index': rx_sw_if_index,
3111 'tx_sw_if_index': tx_sw_if_index,
3116 def bier_table_add_del(self,
3120 """ BIER Table add/del """
3122 self.papi.bier_table_add_del,
3123 {'bt_tbl_id': {"bt_set": bti.set_id,
3124 "bt_sub_domain": bti.sub_domain_id,
3125 "bt_hdr_len_id": bti.hdr_len_id},
3126 'bt_label': mpls_label,
3127 'bt_is_add': is_add})
3129 def bier_table_dump(self):
3130 return self.api(self.papi.bier_table_dump, {})
3132 def bier_route_add_del(self,
3137 """ BIER Route add/del """
3139 self.papi.bier_route_add_del,
3140 {'br_tbl_id': {"bt_set": bti.set_id,
3141 "bt_sub_domain": bti.sub_domain_id,
3142 "bt_hdr_len_id": bti.hdr_len_id},
3144 'br_n_paths': len(paths),
3146 'br_is_add': is_add})
3148 def bier_route_dump(self, bti):
3150 self.papi.bier_route_dump,
3151 {'br_tbl_id': {"bt_set": bti.set_id,
3152 "bt_sub_domain": bti.sub_domain_id,
3153 "bt_hdr_len_id": bti.hdr_len_id}})
3155 def bier_imp_add(self,
3160 """ BIER Imposition Add """
3162 self.papi.bier_imp_add,
3163 {'bi_tbl_id': {"bt_set": bti.set_id,
3164 "bt_sub_domain": bti.sub_domain_id,
3165 "bt_hdr_len_id": bti.hdr_len_id},
3167 'bi_n_bytes': len(ibytes),
3168 'bi_bytes': ibytes})
3170 def bier_imp_del(self, bi_index):
3171 """ BIER Imposition del """
3173 self.papi.bier_imp_del,
3174 {'bi_index': bi_index})
3176 def bier_imp_dump(self):
3177 return self.api(self.papi.bier_imp_dump, {})
3179 def bier_disp_table_add_del(self,
3182 """ BIER Disposition Table add/del """
3184 self.papi.bier_disp_table_add_del,
3185 {'bdt_tbl_id': bdti,
3186 'bdt_is_add': is_add})
3188 def bier_disp_table_dump(self):
3189 return self.api(self.papi.bier_disp_table_dump, {})
3191 def bier_disp_entry_add_del(self,
3201 """ BIER Route add/del """
3203 while (len(lstack) < 16):
3206 self.papi.bier_disp_entry_add_del,
3207 {'bde_tbl_id': bdti,
3209 'bde_payload_proto': payload_proto,
3211 'bde_paths': [{'next_hop': next_hop,
3212 'table_id': next_hop_tbl_id,
3213 'afi': next_hop_afi,
3214 'rpf_id': next_hop_rpf_id,
3216 'label_stack': lstack}],
3217 'bde_is_add': is_add})
3219 def bier_disp_entry_dump(self, bdti):
3221 self.papi.bier_disp_entry_dump,
3222 {'bde_tbl_id': bdti})
3224 def add_node_next(self, node_name, next_name):
3225 """ Set the next node for a given node request
3230 return self.api(self.papi.add_node_next,
3231 {'node_name': node_name,
3232 'next_name': next_name})
3234 def session_enable_disable(self, is_enabled):
3236 self.papi.session_enable_disable,
3237 {'is_enable': is_enabled})
3239 def ipsec_spd_add_del(self, spd_id, is_add=1):
3240 """ SPD add/del - Wrapper to add or del ipsec SPD
3241 Sample CLI : 'ipsec spd add 1'
3243 :param spd_id - SPD ID to be created in the vpp . mandatory
3244 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3246 :returns: reply from the API
3249 self.papi.ipsec_spd_add_del, {
3250 'spd_id': spd_id, 'is_add': is_add})
3252 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3253 """ IPSEC interface SPD add/del - \
3254 Wrapper to associate/disassociate SPD to interface in VPP
3255 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3257 :param spd_id - SPD ID to associate with the interface . mandatory
3258 :param sw_if_index - Interface Index which needs to ipsec \
3259 association mandatory
3260 :param is_add - add(1) or del(0) association with interface \
3261 (Default 1 - add) . optional
3262 :returns: reply from the API
3265 self.papi.ipsec_interface_add_del_spd,
3266 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3268 def ipsec_sad_add_del_entry(self,
3271 integrity_algorithm,
3276 tunnel_src_address='',
3277 tunnel_dst_address='',
3281 """ IPSEC SA add/del
3282 :param sad_id: security association ID
3283 :param spi: security param index of the SA in decimal
3284 :param integrity_algorithm:
3285 :param integrity_key:
3286 :param crypto_algorithm:
3288 :param protocol: AH(0) or ESP(1) protocol
3289 :param tunnel_src_address: tunnel mode outer src address
3290 :param tunnel_dst_address: tunnel mode outer dst address
3293 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3294 crypto and ipsec algorithms
3297 self.papi.ipsec_sad_add_del_entry,
3300 'tunnel_src_address': tunnel_src_address,
3301 'tunnel_dst_address': tunnel_dst_address,
3302 'protocol': protocol,
3303 'integrity_algorithm': integrity_algorithm,
3304 'integrity_key_length': len(integrity_key),
3305 'integrity_key': integrity_key,
3306 'crypto_algorithm': crypto_algorithm,
3307 'crypto_key_length': len(crypto_key) if crypto_key is not None
3309 'crypto_key': crypto_key,
3311 'is_tunnel': is_tunnel,
3312 'udp_encap': udp_encap})
3314 def ipsec_spd_add_del_entry(self,
3317 local_address_start,
3319 remote_address_start,
3320 remote_address_stop,
3322 local_port_stop=65535,
3323 remote_port_start=0,
3324 remote_port_stop=65535,
3331 """ IPSEC policy SPD add/del -
3332 Wrapper to configure ipsec SPD policy entries in VPP
3333 :param spd_id: SPD ID for the policy
3334 :param local_address_start: local-ip-range start address
3335 :param local_address_stop : local-ip-range stop address
3336 :param remote_address_start: remote-ip-range start address
3337 :param remote_address_stop : remote-ip-range stop address
3338 :param local_port_start: (Default value = 0)
3339 :param local_port_stop: (Default value = 65535)
3340 :param remote_port_start: (Default value = 0)
3341 :param remote_port_stop: (Default value = 65535)
3342 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3343 :param sa_id: Security Association ID for mapping it to SPD
3344 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3346 :param priority: value for the spd action (Default value = 100)
3347 :param is_outbound: flag for inbound(0) or outbound(1)
3349 :param is_add: (Default value = 1)
3352 self.papi.ipsec_spd_add_del_entry,
3355 'local_address_start': local_address_start,
3356 'local_address_stop': local_address_stop,
3357 'remote_address_start': remote_address_start,
3358 'remote_address_stop': remote_address_stop,
3359 'local_port_start': local_port_start,
3360 'local_port_stop': local_port_stop,
3361 'remote_port_start': remote_port_start,
3362 'remote_port_stop': remote_port_stop,
3364 'protocol': protocol,
3366 'priority': priority,
3367 'is_outbound': is_outbound,
3368 'is_ip_any': is_ip_any})
3370 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3371 remote_spi, crypto_alg, local_crypto_key,
3372 remote_crypto_key, integ_alg, local_integ_key,
3373 remote_integ_key, is_add=1, esn=0,
3374 anti_replay=1, renumber=0, show_instance=0):
3376 self.papi.ipsec_tunnel_if_add_del,
3377 {'local_ip': local_ip, 'remote_ip': remote_ip,
3378 'local_spi': local_spi, 'remote_spi': remote_spi,
3379 'crypto_alg': crypto_alg,
3380 'local_crypto_key_len': len(local_crypto_key),
3381 'local_crypto_key': local_crypto_key,
3382 'remote_crypto_key_len': len(remote_crypto_key),
3383 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3384 'local_integ_key_len': len(local_integ_key),
3385 'local_integ_key': local_integ_key,
3386 'remote_integ_key_len': len(remote_integ_key),
3387 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3388 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3389 'show_instance': show_instance
3392 def app_namespace_add(self,
3396 sw_if_index=0xFFFFFFFF,
3399 self.papi.app_namespace_add_del,
3401 'sw_if_index': sw_if_index,
3402 'ip4_fib_id': ip4_fib_id,
3403 'ip6_fib_id': ip6_fib_id,
3404 'namespace_id': namespace_id,
3405 'namespace_id_len': len(namespace_id)})
3407 def punt_socket_register(self, l4_port, pathname, header_version=1,
3408 is_ip4=1, l4_protocol=0x11):
3409 """ Punt to socket """
3410 return self.api(self.papi.punt_socket_register,
3412 'l4_protocol': l4_protocol,
3414 'pathname': pathname,
3415 'header_version': header_version})
3417 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3418 expire_walk_interval_ms, is_ip6=0):
3419 """ Set IP reassembly parameters """
3420 return self.api(self.papi.ip_reassembly_set,
3422 'timeout_ms': timeout_ms,
3423 'expire_walk_interval_ms': expire_walk_interval_ms,
3424 'max_reassemblies': max_reassemblies})
3426 def ip_reassembly_get(self, is_ip6=0):
3427 """ Get IP reassembly parameters """
3428 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3430 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3432 """ Enable/disable IP reassembly """
3433 return self.api(self.papi.ip_reassembly_enable_disable,
3434 {'sw_if_index': sw_if_index,
3435 'enable_ip4': 1 if enable_ip4 else 0,
3436 'enable_ip6': 1 if enable_ip6 else 0,
3439 def gbp_endpoint_add(self, sw_if_index, ips, mac, epg):
3440 """ GBP endpoint Add """
3441 return self.api(self.papi.gbp_endpoint_add,
3443 'sw_if_index': sw_if_index,
3449 def gbp_endpoint_del(self, handle):
3450 """ GBP endpoint Del """
3451 return self.api(self.papi.gbp_endpoint_del,
3454 def gbp_endpoint_dump(self):
3455 """ GBP endpoint Dump """
3456 return self.api(self.papi.gbp_endpoint_dump, {})
3458 def gbp_endpoint_group_add_del(self, is_add, epg, bd,
3461 uplink_sw_if_index):
3462 """ GBP endpoint group Add/Del """
3463 return self.api(self.papi.gbp_endpoint_group_add_del,
3466 'uplink_sw_if_index': uplink_sw_if_index,
3468 'ip4_table_id': ip4_rd,
3469 'ip6_table_id': ip6_rd,
3472 def gbp_endpoint_group_dump(self):
3473 """ GBP endpoint group Dump """
3474 return self.api(self.papi.gbp_endpoint_group_dump, {})
3476 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3477 """ GBP recirc Add/Del """
3478 return self.api(self.papi.gbp_recirc_add_del,
3482 'sw_if_index': sw_if_index,
3485 def gbp_recirc_dump(self):
3486 """ GBP recirc Dump """
3487 return self.api(self.papi.gbp_recirc_dump, {})
3489 def gbp_subnet_add_del(self, is_add, table_id,
3492 sw_if_index=0xffffffff,
3495 """ GBP Subnet Add/Del """
3496 return self.api(self.papi.gbp_subnet_add_del,
3499 'is_internal': is_internal,
3501 'sw_if_index': sw_if_index,
3504 'table_id': table_id}})
3506 def gbp_subnet_dump(self):
3507 """ GBP Subnet Dump """
3508 return self.api(self.papi.gbp_subnet_dump, {})
3510 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3511 """ GBP contract Add/Del """
3512 return self.api(self.papi.gbp_contract_add_del,
3515 'acl_index': acl_index,
3517 'dst_epg': dst_epg}})
3519 def gbp_contract_dump(self):
3520 """ GBP contract Dump """
3521 return self.api(self.papi.gbp_contract_dump, {})
3523 def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3524 ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3526 """ 6RD tunnel Add """
3527 return self.api(self.papi.ipip_6rd_add_tunnel,
3528 {'ip4_table_id': ip4_table_id,
3529 'ip6_table_id': ip6_table_id,
3530 'ip6_prefix': ip6_prefix,
3531 'ip6_prefix_len': ip6_prefix_len,
3532 'ip4_prefix': ip4_prefix,
3533 'ip4_prefix_len': ip4_prefix_len,
3535 'security_check': security_check})
3537 def ipip_6rd_del_tunnel(self, sw_if_index):
3538 """ 6RD tunnel Delete """
3539 return self.api(self.papi.ipip_6rd_del_tunnel,
3540 {'sw_if_index': sw_if_index})
3542 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3543 instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3544 """ IPIP tunnel Add/Del """
3545 return self.api(self.papi.ipip_add_tunnel,
3546 {'is_ipv6': is_ipv6,
3547 'instance': instance,
3548 'src_address': src_address,
3549 'dst_address': dst_address,
3550 'table_id': table_id,
3553 def ipip_del_tunnel(self, sw_if_index):
3554 """ IPIP tunnel Delete """
3555 return self.api(self.papi.ipip_del_tunnel,
3556 {'sw_if_index': sw_if_index})
3558 def qos_egress_map_update(self, id, outputs):
3559 """ QOS egress map update """
3560 return self.api(self.papi.qos_egress_map_update,
3564 def qos_egress_map_delete(self, id):
3565 """ QOS egress map delete """
3566 return self.api(self.papi.qos_egress_map_delete,
3569 def qos_mark_enable_disable(self, sw_if_index,
3573 """ QOS Mark Enable/Disable """
3574 return self.api(self.papi.qos_mark_enable_disable,
3576 'sw_if_index': sw_if_index,
3577 'output_source': output_source,
3580 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3581 """ IP QoS recording Enble/Disable """
3582 return self.api(self.papi.qos_record_enable_disable,
3583 {'sw_if_index': sw_if_index,
3584 'input_source': input_source,
3587 def igmp_enable_disable(self, sw_if_index, enable, host):
3588 """ Enable/disable IGMP on a given interface """
3589 return self.api(self.papi.igmp_enable_disable,
3592 'sw_if_index': sw_if_index})
3594 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3595 """ Listen for new (S,G) on specified interface
3597 :param enable: add/del
3598 :param sw_if_index: interface sw index
3599 :param saddr: source ip4 addr
3600 :param gaddr: group ip4 addr
3602 return self.api(self.papi.igmp_listen,
3607 'sw_if_index': sw_if_index,
3608 'n_srcs': len(saddrs),
3617 def igmp_dump(self, sw_if_index=None):
3618 """ Dump all (S,G) interface configurations """
3619 if sw_if_index is None:
3620 sw_if_index = 0xffffffff
3621 return self.api(self.papi.igmp_dump,
3622 {'sw_if_index': sw_if_index})
3624 def igmp_clear_interface(self, sw_if_index):
3625 """ Remove all (S,G)s from specified interface
3626 doesn't send IGMP report!
3629 self.papi.igmp_clear_interface, {
3630 'sw_if_index': sw_if_index})
3632 def want_igmp_events(self, enable=1):
3633 return self.api(self.papi.want_igmp_events, {'enable': enable,
3634 'pid': os.getpid()})
3644 :param lb: load balance
3645 :param use_custom_mac: use custom mac
3646 :param mac_address: mac address
3649 self.papi.bond_create,
3652 'use_custom_mac': use_custom_mac,
3653 'mac_address': mac_address
3660 :param sw_if_index: interface the operation is applied to
3662 return self.api(self.papi.bond_delete,
3663 {'sw_if_index': sw_if_index})
3672 :param sw_if_index: slave sw_if_index
3673 :param bond_sw_if_index: bond sw_if_index
3674 :param is_passive: is passive lacp speaker
3675 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3678 self.papi.bond_enslave,
3679 {'sw_if_index': sw_if_index,
3680 'bond_sw_if_index': bond_sw_if_index,
3681 'is_passive': is_passive,
3682 'is_long_timeout': is_long_timeout
3685 def bond_detach_slave(
3689 :param sw_if_index: slave interface the operation is applied to
3691 return self.api(self.papi.bond_detach_slave,
3692 {'sw_if_index': sw_if_index})
3694 def sw_interface_slave_dump(
3698 :param sw_if_index: bond sw_if_index
3700 return self.api(self.papi.sw_interface_slave_dump,
3701 {'sw_if_index': sw_if_index})
3703 def sw_interface_bond_dump(
3708 return self.api(self.papi.sw_interface_bond_dump,
3711 def create_vhost_user_if(
3716 custom_dev_instance,
3721 :param is_server: is server
3722 :param sock_filename: socket name
3723 :param renumber: renumber
3724 :param custom_dev_instance: custom dev instance
3725 :param use_custom_mac: use custom mac
3726 :param mac_address: mac address
3727 :param tag: tag (default ''
3730 self.papi.create_vhost_user_if,
3731 {'is_server': is_server,
3732 'sock_filename': sock_filename,
3733 'renumber': renumber,
3734 'custom_dev_instance': custom_dev_instance,
3735 'use_custom_mac': use_custom_mac,
3736 'mac_address': mac_address,
3740 def delete_vhost_user_if(
3744 :param sw_if_index: interface the operation is applied to
3746 return self.api(self.papi.delete_vhost_user_if,
3747 {'sw_if_index': sw_if_index, })
3749 def sw_interface_vhost_user_dump(
3754 return self.api(self.papi.sw_interface_vhost_user_dump,
3757 def abf_policy_add_del(self, is_add, policy):
3759 self.papi.abf_policy_add_del,
3763 def abf_itf_attach_add_del(self, is_add, attach):
3765 self.papi.abf_itf_attach_add_del,
3769 def abf_policy_dump(self):
3771 self.papi.abf_policy_dump, {})
3773 def abf_itf_attach_dump(self):
3775 self.papi.abf_itf_attach_dump, {})
3777 def pipe_create(self, is_specified, user_instance):
3778 return self.api(self.papi.pipe_create,
3779 {'is_specified': is_specified,
3780 'user_instance': user_instance})
3782 def pipe_delete(self, parent_sw_if_index):
3783 return self.api(self.papi.pipe_delete,
3784 {'parent_sw_if_index': parent_sw_if_index})
3786 def pipe_dump(self):
3787 return self.api(self.papi.pipe_dump, {})