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
61 class UnexpectedApiReturnValueError(Exception):
62 """ exception raised when the API return value is unexpected """
66 class VppPapiProvider(object):
67 """VPP-api provider using vpp-papi
69 @property hook: hook object providing before and after api/cli hooks
72 _zero, _negative = range(2)
74 def __init__(self, name, shm_prefix, test_class, read_timeout):
75 self.hook = Hook("vpp-papi-provider")
77 self.shm_prefix = shm_prefix
78 self.test_class = test_class
79 self._expect_api_retval = self._zero
80 self._expect_stack = []
83 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
84 for root, dirnames, filenames in os.walk(install_dir):
85 for filename in fnmatch.filter(filenames, '*.api.json'):
86 jsonfiles.append(os.path.join(root, filename))
88 self.vpp = VPP(jsonfiles, logger=test_class.logger,
89 read_timeout=read_timeout)
90 self._events = deque()
95 def expect_negative_api_retval(self):
96 """ Expect API failure """
97 self._expect_stack.append(self._expect_api_retval)
98 self._expect_api_retval = self._negative
101 def expect_zero_api_retval(self):
102 """ Expect API success """
103 self._expect_stack.append(self._expect_api_retval)
104 self._expect_api_retval = self._zero
107 def __exit__(self, exc_type, exc_value, traceback):
108 self._expect_api_retval = self._expect_stack.pop()
110 def register_hook(self, hook):
111 """Replace hook registration with new hook
118 def collect_events(self):
119 """ Collect all events from the internal queue and clear the queue. """
121 self._events = deque()
124 def wait_for_event(self, timeout, name=None):
125 """ Wait for and return next event. """
127 self.test_class.logger.debug("Expecting event '%s' within %ss",
130 self.test_class.logger.debug("Expecting event within %ss",
133 self.test_class.logger.debug("Not waiting, event already queued")
134 limit = time.time() + timeout
135 while time.time() < limit:
137 e = self._events.popleft()
138 if name and type(e).__name__ != name:
140 "Unexpected event received: %s, expected: %s" %
141 (type(e).__name__, name))
142 self.test_class.logger.debug("Returning event %s:%s" %
145 time.sleep(0) # yield
146 raise Exception("Event did not occur within timeout")
148 def __call__(self, name, event):
149 """ Enqueue event in the internal event queue. """
150 # FIXME use the name instead of relying on type(e).__name__ ?
151 # FIXME #2 if this throws, it is eaten silently, Ole?
152 self.test_class.logger.debug("New event: %s: %s" % (name, event))
153 self._events.append(event)
156 """Connect the API to VPP"""
157 self.vpp.connect(self.name, self.shm_prefix)
158 self.papi = self.vpp.api
159 self.vpp.register_event_callback(self)
161 def disconnect(self):
162 """Disconnect the API from VPP"""
163 self.vpp.disconnect()
165 def api(self, api_fn, api_args, expected_retval=0):
166 """ Call API function and check it's return value.
167 Call the appropriate hooks before and after the API call
169 :param api_fn: API function to call
170 :param api_args: tuple of API function arguments
171 :param expected_retval: Expected return value (Default value = 0)
172 :returns: reply from the API
175 self.hook.before_api(api_fn.__name__, api_args)
176 reply = api_fn(**api_args)
177 if self._expect_api_retval == self._negative:
178 if hasattr(reply, 'retval') and reply.retval >= 0:
179 msg = "API call passed unexpectedly: expected negative "\
180 "return value instead of %d in %s" % \
181 (reply.retval, repr(reply))
182 self.test_class.logger.info(msg)
183 raise UnexpectedApiReturnValueError(msg)
184 elif self._expect_api_retval == self._zero:
185 if hasattr(reply, 'retval') and reply.retval != expected_retval:
186 msg = "API call failed, expected %d return value instead "\
187 "of %d in %s" % (expected_retval, reply.retval,
189 self.test_class.logger.info(msg)
190 raise UnexpectedApiReturnValueError(msg)
192 raise Exception("Internal error, unexpected value for "
193 "self._expect_api_retval %s" %
194 self._expect_api_retval)
195 self.hook.after_api(api_fn.__name__, api_args)
199 """ Execute a CLI, calling the before/after hooks appropriately.
201 :param cli: CLI to execute
205 self.hook.before_cli(cli)
207 r = self.papi.cli_inband(length=len(cli), cmd=cli)
208 self.hook.after_cli(cli)
209 if hasattr(r, 'reply'):
210 return r.reply.decode().rstrip('\x00')
212 def ppcli(self, cli):
213 """ Helper method to print CLI command in case of info logging level.
215 :param cli: CLI to execute
218 return cli + "\n" + str(self.cli(cli))
220 def _convert_mac(self, mac):
221 return mac.replace(':', '').decode('hex')
223 def show_version(self):
225 return self.api(self.papi.show_version, {})
227 def pg_create_interface(self, pg_index):
233 return self.api(self.papi.pg_create_interface,
234 {"interface_id": pg_index})
236 def sw_interface_dump(self, filter=None):
239 :param filter: (Default value = None)
242 if filter is not None:
243 args = {"name_filter_valid": 1, "name_filter": filter}
246 return self.api(self.papi.sw_interface_dump, args)
248 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
249 """ Set the IPvX Table-id for the Interface
256 return self.api(self.papi.sw_interface_set_table,
257 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
260 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
261 is_ipv6=0, is_add=1, del_all=0):
264 :param addr: param is_ipv6: (Default value = 0)
267 :param is_ipv6: (Default value = 0)
268 :param is_add: (Default value = 1)
269 :param del_all: (Default value = 0)
272 return self.api(self.papi.sw_interface_add_del_address,
273 {'sw_if_index': sw_if_index,
277 'address_length': addr_len,
280 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
282 """ Set the Interface to be unnumbered
284 :param is_add: (Default value = 1)
285 :param sw_if_index - interface That will be unnumbered
286 :param ip_sw_if_index - interface with an IP addres
289 return self.api(self.papi.sw_interface_set_unnumbered,
290 {'sw_if_index': ip_sw_if_index,
291 'unnumbered_sw_if_index': sw_if_index,
294 def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
295 return self.api(self.papi.ip_unnumbered_dump,
296 {'sw_if_index': sw_if_index})
298 def sw_interface_enable_disable_mpls(self, sw_if_index,
301 Enable/Disable MPLS on the interface
303 :param is_enable: (Default value = 1)
306 return self.api(self.papi.sw_interface_set_mpls_enable,
307 {'sw_if_index': sw_if_index,
308 'enable': is_enable})
310 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
311 return self.api(self.papi.sw_interface_ip6nd_ra_config,
312 {'sw_if_index': sw_if_index,
313 'suppress': suppress})
315 def set_ip_flow_hash(self,
324 return self.api(self.papi.set_ip_flow_hash,
334 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
335 return self.api(self.papi.ip6nd_proxy_add_del,
337 'sw_if_index': sw_if_index,
340 def ip6_sw_interface_ra_config(self, sw_if_index,
344 return self.api(self.papi.sw_interface_ip6nd_ra_config,
345 {'sw_if_index': sw_if_index,
347 'suppress': suppress,
348 'send_unicast': send_unicast})
350 def ip6_sw_interface_ra_prefix(self,
360 val_lifetime=0xffffffff,
361 pref_lifetime=0xffffffff):
362 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
363 {'sw_if_index': sw_if_index,
365 'address_length': address_length,
366 'use_default': use_default,
367 'no_advertise': no_advertise,
368 'off_link': off_link,
369 'no_autoconfig': no_autoconfig,
370 'no_onlink': no_onlink,
372 'val_lifetime': val_lifetime,
373 'pref_lifetime': pref_lifetime})
375 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
377 Enable/Disable An interface for IPv6
379 return self.api(self.papi.sw_interface_ip6_enable_disable,
380 {'sw_if_index': sw_if_index,
383 def vxlan_add_del_tunnel(
387 mcast_sw_if_index=0xFFFFFFFF,
391 decap_next_index=0xFFFFFFFF,
393 instance=0xFFFFFFFF):
398 :param is_add: (Default value = 1)
399 :param is_ipv6: (Default value = 0)
400 :param encap_vrf_id: (Default value = 0)
401 :param decap_next_index: (Default value = 0xFFFFFFFF)
402 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
403 :param vni: (Default value = 0)
404 :param instance: (Default value = 0xFFFFFFFF)
407 return self.api(self.papi.vxlan_add_del_tunnel,
410 'src_address': src_addr,
411 'dst_address': dst_addr,
412 'mcast_sw_if_index': mcast_sw_if_index,
413 'encap_vrf_id': encap_vrf_id,
414 'decap_next_index': decap_next_index,
416 'instance': instance})
418 def geneve_add_del_tunnel(
422 mcast_sw_if_index=0xFFFFFFFF,
426 decap_next_index=0xFFFFFFFF,
432 :param is_add: (Default value = 1)
433 :param is_ipv6: (Default value = 0)
434 :param encap_vrf_id: (Default value = 0)
435 :param decap_next_index: (Default value = 0xFFFFFFFF)
436 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
437 :param vni: (Default value = 0)
440 return self.api(self.papi.geneve_add_del_tunnel,
443 'local_address': local_addr,
444 'remote_address': remote_addr,
445 'mcast_sw_if_index': mcast_sw_if_index,
446 'encap_vrf_id': encap_vrf_id,
447 'decap_next_index': decap_next_index,
450 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
451 learn=1, arp_term=0, is_add=1):
452 """Create/delete bridge domain.
454 :param int bd_id: Bridge domain index.
455 :param int flood: Enable/disable bcast/mcast flooding in the BD.
457 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
459 :param int forward: Enable/disable forwarding on all interfaces in
460 the BD. (Default value = 1)
461 :param int learn: Enable/disable learning on all interfaces in the BD.
463 :param int arp_term: Enable/disable arp termination in the BD.
465 :param int is_add: Add or delete flag. (Default value = 1)
467 return self.api(self.papi.bridge_domain_add_del,
470 'uu_flood': uu_flood,
473 'arp_term': arp_term,
476 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
477 return self.api(self.papi.bd_ip_mac_add_del,
484 def want_ip4_arp_events(self, enable_disable=1, address=0):
485 return self.api(self.papi.want_ip4_arp_events,
486 {'enable_disable': enable_disable,
488 'pid': os.getpid(), })
490 def want_ip6_nd_events(self, enable_disable=1, address=0):
491 return self.api(self.papi.want_ip6_nd_events,
492 {'enable_disable': enable_disable,
494 'pid': os.getpid(), })
496 def want_ip6_ra_events(self, enable_disable=1):
497 return self.api(self.papi.want_ip6_ra_events,
498 {'enable_disable': enable_disable,
499 'pid': os.getpid(), })
501 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
503 return self.api(self.papi.ip6nd_send_router_solicitation,
508 'sw_if_index': sw_if_index})
510 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
511 install_default_routes):
512 return self.api(self.papi.ip6_nd_address_autoconfig,
513 {'sw_if_index': sw_if_index,
515 'install_default_routes': install_default_routes})
517 def want_interface_events(self, enable_disable=1):
518 return self.api(self.papi.want_interface_events,
519 {'enable_disable': enable_disable,
520 'pid': os.getpid(), })
522 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
523 max_macs_in_event=0, learn_limit=0):
524 return self.api(self.papi.want_l2_macs_events,
525 {'enable_disable': enable_disable,
526 'scan_delay': scan_delay,
527 'max_macs_in_event': max_macs_in_event,
528 'learn_limit': learn_limit,
529 'pid': os.getpid(), })
531 def want_dhcp6_reply_events(self, enable_disable=1):
532 return self.api(self.papi.want_dhcp6_reply_events,
533 {'enable_disable': enable_disable,
536 def want_dhcp6_pd_reply_events(self, enable_disable=1):
537 return self.api(self.papi.want_dhcp6_pd_reply_events,
538 {'enable_disable': enable_disable,
541 def dhcp6_clients_enable_disable(self, enable=1):
542 return self.api(self.papi.dhcp6_clients_enable_disable,
545 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
546 addresses, server_index=0xFFFFFFFF,
547 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
549 return self.api(self.papi.dhcp6_send_client_message,
550 {'sw_if_index': sw_if_index,
551 'server_index': server_index,
557 'msg_type': msg_type,
560 'n_addresses': len(addresses),
561 'addresses': addresses})
563 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
564 prefixes, server_index=0xFFFFFFFF,
565 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
567 return self.api(self.papi.dhcp6_pd_send_client_message,
568 {'sw_if_index': sw_if_index,
569 'server_index': server_index,
575 'msg_type': msg_type,
578 'n_prefixes': len(prefixes),
579 'prefixes': prefixes})
581 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
583 return self.api(self.papi.dhcp6_client_enable_disable,
584 {'sw_if_index': sw_if_index,
587 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
589 return self.api(self.papi.dhcp6_pd_client_enable_disable,
590 {'sw_if_index': sw_if_index,
591 'prefix_group': prefix_group,
594 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
595 prefix_length, prefix_group,
597 return self.api(self.papi.ip6_add_del_address_using_prefix,
598 {'sw_if_index': sw_if_index,
599 'prefix_group': prefix_group,
601 'prefix_length': prefix_length,
604 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
605 filter_mac=0, bvi_mac=0):
606 """Create/delete L2 FIB entry.
608 :param str mac: MAC address to create FIB entry for.
609 :param int bd_id: Bridge domain index.
610 :param int sw_if_index: Software interface index of the interface.
611 :param int is_add: Add or delete flag. (Default value = 1)
612 :param int static_mac: Set to 1 to create static MAC entry.
614 :param int filter_mac: Set to 1 to drop packet that's source or
615 destination MAC address contains defined MAC address.
617 :param int bvi_mac: Set to 1 to create entry that points to BVI
618 interface. (Default value = 0)
620 return self.api(self.papi.l2fib_add_del,
621 {'mac': self._convert_mac(mac),
623 'sw_if_index': sw_if_index,
625 'static_mac': static_mac,
626 'filter_mac': filter_mac,
629 def l2fib_flush_int(self, sw_if_index):
630 """Flush L2 FIB entries for sw_if_index.
632 :param int sw_if_index: Software interface index of the interface.
634 return self.api(self.papi.l2fib_flush_int,
635 {'sw_if_index': sw_if_index})
637 def l2fib_flush_bd(self, bd_id):
638 """Flush L2 FIB entries for bd_id.
640 :param int sw_if_index: Bridge Domain id.
642 return self.api(self.papi.l2fib_flush_bd,
645 def l2fib_flush_all(self):
648 return self.api(self.papi.l2fib_flush_all, {})
650 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
651 shg=0, port_type=L2_PORT_TYPE.NORMAL,
653 """Add/remove interface to/from bridge domain.
655 :param int sw_if_index: Software interface index of the interface.
656 :param int bd_id: Bridge domain index.
657 :param int shg: Split-horizon group index. (Default value = 0)
658 :param int bvi: Set interface as a bridge group virtual interface.
660 :param int enable: Add or remove interface. (Default value = 1)
662 return self.api(self.papi.sw_interface_set_l2_bridge,
663 {'rx_sw_if_index': sw_if_index,
666 'port_type': port_type,
669 def bridge_flags(self, bd_id, is_set, feature_bitmap):
670 """Enable/disable required feature of the bridge domain with defined
673 :param int bd_id: Bridge domain ID.
674 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
675 :param int flags: Bitmap value of the feature to be set:
679 - uu-flood (1 << 3) or
682 return self.api(self.papi.bridge_flags,
685 'flags': feature_bitmap})
687 def bridge_domain_dump(self, bd_id=0):
690 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
691 existing bridge domains returned)
692 :return: Dictionary of bridge domain(s) data.
694 return self.api(self.papi.bridge_domain_dump,
697 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
699 """Create or delete unidirectional cross-connect from Tx interface to
702 :param int rx_sw_if_index: Software interface index of Rx interface.
703 :param int tx_sw_if_index: Software interface index of Tx interface.
704 :param int enable: Create cross-connect if equal to 1, delete
705 cross-connect if equal to 0.
708 return self.api(self.papi.sw_interface_set_l2_xconnect,
709 {'rx_sw_if_index': rx_sw_if_index,
710 'tx_sw_if_index': tx_sw_if_index,
713 def sw_interface_set_l2_tag_rewrite(
720 """L2 interface vlan tag rewrite configure request
721 :param client_index - opaque cookie to identify the sender
722 :param context - sender context, to match reply w/ request
723 :param sw_if_index - interface the operation is applied to
724 :param vtr_op - Choose from l2_vtr_op_t enum values
725 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
726 :param tag1 - Needed for any push or translate vtr op
727 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
730 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
731 {'sw_if_index': sw_if_index,
737 def sw_interface_set_l2_emulation(
742 :param sw_if_index - interface the operation is applied to
745 return self.api(self.papi.l2_emulation,
746 {'sw_if_index': sw_if_index,
749 def sw_interface_set_ip_directed_broadcast(
753 """IP Directed broadcast
754 :param sw_if_index - interface the operation is applied to
757 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
758 {'sw_if_index': sw_if_index,
761 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
764 :param admin_up_down:
768 return self.api(self.papi.sw_interface_set_flags,
769 {'sw_if_index': sw_if_index,
770 'admin_up_down': admin_up_down})
772 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
778 return self.api(self.papi.sw_interface_set_mtu,
779 {'sw_if_index': sw_if_index,
782 def sw_interface_set_promiscuous(self, sw_if_index, enable):
788 return self.api(self.papi.sw_interface_set_promiscuous,
789 {'sw_if_index': sw_if_index,
792 def sw_interface_set_mac_address(self, sw_if_index, mac):
793 return self.api(self.papi.sw_interface_set_mac_address,
794 {'sw_if_index': sw_if_index,
797 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
798 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
799 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
800 """Create subinterface
801 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
803 :param sub_id: param inner_vlan:
807 :param no_tags: (Default value = 0)
808 :param one_tag: (Default value = 0)
809 :param two_tags: (Default value = 0)
810 :param dot1ad: (Default value = 0)
811 :param exact_match: (Default value = 0)
812 :param default_sub: (Default value = 0)
813 :param outer_vlan_id_any: (Default value = 0)
814 :param inner_vlan_id_any: (Default value = 0)
818 self.papi.create_subif,
819 {'sw_if_index': sw_if_index,
823 'two_tags': two_tags,
825 'exact_match': exact_match,
826 'default_sub': default_sub,
827 'outer_vlan_id_any': outer_vlan_id_any,
828 'inner_vlan_id_any': inner_vlan_id_any,
829 'outer_vlan_id': outer_vlan,
830 'inner_vlan_id': inner_vlan})
832 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
833 """Create p2p ethernet subinterface
835 :param sw_if_index: main (parent) interface
836 :param remote_mac: client (remote) mac address
840 self.papi.p2p_ethernet_add,
841 {'parent_if_index': sw_if_index,
842 'remote_mac': remote_mac,
843 'subif_id': subif_id})
845 def delete_subif(self, sw_if_index):
846 """Delete subinterface
850 return self.api(self.papi.delete_subif,
851 {'sw_if_index': sw_if_index})
853 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
854 """Delete p2p ethernet subinterface
856 :param sw_if_index: main (parent) interface
857 :param remote_mac: client (remote) mac address
861 self.papi.p2p_ethernet_del,
862 {'parent_if_index': sw_if_index,
863 'remote_mac': remote_mac})
865 def create_vlan_subif(self, sw_if_index, vlan):
872 return self.api(self.papi.create_vlan_subif,
873 {'sw_if_index': sw_if_index,
876 def create_loopback(self, mac=''):
879 :param mac: (Optional)
881 return self.api(self.papi.create_loopback,
882 {'mac_address': mac})
884 def delete_loopback(self, sw_if_index):
885 return self.api(self.papi.delete_loopback,
886 {'sw_if_index': sw_if_index, })
888 def ip_table_add_del(self,
895 :param is_add: (Default value = 1)
896 :param is_ipv6: (Default value = 0)
901 self.papi.ip_table_add_del,
902 {'table_id': table_id,
906 def ip_add_del_route(
911 next_hop_sw_if_index=0xFFFFFFFF,
915 next_hop_n_out_labels=0,
916 next_hop_out_label_stack=[],
917 next_hop_via_label=MPLS_LABEL_INVALID,
918 next_hop_id=0xFFFFFFFF,
920 is_resolve_attached=0,
921 classify_table_index=0xFFFFFFFF,
935 :param dst_address_length:
936 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
938 :param next_hop_address:
939 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
940 :param vrf_id: (Default value = 0)
941 :param lookup_in_vrf: (Default value = 0)
942 :param classify_table_index: (Default value = 0xFFFFFFFF)
943 :param is_add: (Default value = 1)
944 :param is_drop: (Default value = 0)
945 :param is_ipv6: (Default value = 0)
946 :param is_local: (Default value = 0)
947 :param is_classify: (Default value = 0)
948 :param is_multipath: (Default value = 0)
949 :param is_resolve_host: (Default value = 0)
950 :param is_resolve_attached: (Default value = 0)
951 :param is_dvr: (Default value = 0)
952 :param is_source_lookup: (Default value = 0)
953 :param next_hop_weight: (Default value = 1)
958 self.papi.ip_add_del_route,
959 {'next_hop_sw_if_index': next_hop_sw_if_index,
960 'table_id': table_id,
961 'classify_table_index': classify_table_index,
962 'next_hop_table_id': next_hop_table_id,
965 'is_unreach': is_unreach,
966 'is_prohibit': is_prohibit,
968 'is_local': is_local,
969 'is_classify': is_classify,
970 'is_multipath': is_multipath,
971 'is_resolve_host': is_resolve_host,
972 'is_resolve_attached': is_resolve_attached,
974 'is_source_lookup': is_source_lookup,
975 'is_udp_encap': is_udp_encap,
976 'next_hop_weight': next_hop_weight,
977 'dst_address_length': dst_address_length,
978 'dst_address': dst_address,
979 'next_hop_id': next_hop_id,
980 'next_hop_address': next_hop_address,
981 'next_hop_n_out_labels': next_hop_n_out_labels,
982 'next_hop_via_label': next_hop_via_label,
983 'next_hop_out_label_stack': next_hop_out_label_stack})
985 def ip_fib_dump(self):
986 return self.api(self.papi.ip_fib_dump, {})
988 def ip6_fib_dump(self):
989 return self.api(self.papi.ip6_fib_dump, {})
991 def ip_neighbor_add_del(self,
1000 """ Add neighbor MAC to IPv4 or IPv6 address.
1005 :param is_add: (Default value = 1)
1006 :param is_ipv6: (Default value = 0)
1007 :param is_static: (Default value = 0)
1008 :param is_no_adj_fib: (Default value = 0)
1012 self.papi.ip_neighbor_add_del,
1013 {'sw_if_index': sw_if_index,
1016 'is_static': is_static,
1017 'is_no_adj_fib': is_no_adj_fib,
1018 'mac_address': mac_address,
1019 'dst_address': dst_address
1023 def ip_neighbor_dump(self,
1026 """ Return IP neighbor dump.
1029 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1033 self.papi.ip_neighbor_dump,
1034 {'is_ipv6': is_ipv6,
1035 'sw_if_index': sw_if_index
1039 def proxy_arp_add_del(self,
1044 """ Config Proxy Arp Range.
1046 :param low_address: Start address in the rnage to Proxy for
1047 :param hi_address: End address in the rnage to Proxy for
1048 :param vrf_id: The VRF/table in which to proxy
1052 self.papi.proxy_arp_add_del,
1056 'low_address': low_address,
1057 'hi_address': hi_address,
1061 def proxy_arp_intfc_enable_disable(self,
1064 """ Enable/Disable an interface for proxy ARP requests
1066 :param sw_if_index: Interface
1067 :param enable_disable: Enable/Disable
1071 self.papi.proxy_arp_intfc_enable_disable,
1072 {'sw_if_index': sw_if_index,
1073 'enable_disable': is_enable
1081 """ Reset VRF (remove all routes etc.) request.
1083 :param int vrf_id: ID of the FIB table / VRF to reset.
1084 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1088 self.papi.reset_vrf,
1098 """ Reset VRF (remove all routes etc.) request.
1100 :param int vrf_id: ID of the FIB table / VRF to reset.
1101 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1105 self.papi.reset_fib,
1116 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1121 {'is_ipv6': is_ipv6,
1125 def sw_interface_span_enable_disable(
1126 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1129 :param sw_if_index_from:
1130 :param sw_if_index_to:
1134 return self.api(self.papi.sw_interface_span_enable_disable,
1135 {'sw_if_index_from': sw_if_index_from,
1136 'sw_if_index_to': sw_if_index_to,
1141 def gre_tunnel_add_del(self,
1146 instance=0xFFFFFFFF,
1150 """ Add a GRE tunnel
1154 :param outer_fib_id: (Default value = 0)
1155 :param tunnel_type: (Default value = 0)
1156 :param instance: (Default value = 0xFFFFFFFF)
1157 :param session_id: (Defalt value = 0)
1158 :param is_add: (Default value = 1)
1159 :param is_ipv6: (Default value = 0)
1163 self.papi.gre_add_del_tunnel,
1166 'tunnel_type': tunnel_type,
1167 'instance': instance,
1168 'src_address': src_address,
1169 'dst_address': dst_address,
1170 'outer_fib_id': outer_fib_id,
1171 'session_id': session_id}
1174 def udp_encap_add(self,
1180 """ Add a GRE tunnel
1185 :param outer_fib_id: (Default value = 0)
1189 self.papi.udp_encap_add,
1194 'src_port': src_port,
1195 'dst_port': dst_port,
1196 'table_id': table_id
1200 def udp_encap_del(self, id):
1201 return self.api(self.papi.udp_encap_del, {'id': id})
1203 def udp_encap_dump(self):
1204 return self.api(self.papi.udp_encap_dump, {})
1206 def want_udp_encap_stats(self, enable=1):
1207 return self.api(self.papi.want_udp_encap_stats,
1209 'pid': os.getpid()})
1211 def mpls_fib_dump(self):
1212 return self.api(self.papi.mpls_fib_dump, {})
1214 def mpls_table_add_del(
1221 :param is_add: (Default value = 1)
1226 self.papi.mpls_table_add_del,
1227 {'mt_table_id': table_id,
1228 'mt_is_add': is_add})
1230 def mpls_route_add_del(
1236 next_hop_sw_if_index=0xFFFFFFFF,
1238 next_hop_table_id=0,
1240 next_hop_n_out_labels=0,
1241 next_hop_out_label_stack=[],
1242 next_hop_via_label=MPLS_LABEL_INVALID,
1244 is_resolve_attached=0,
1251 classify_table_index=0xFFFFFFFF,
1255 :param dst_address_length:
1256 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1258 :param next_hop_address:
1259 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1260 :param vrf_id: (Default value = 0)
1261 :param lookup_in_vrf: (Default value = 0)
1262 :param classify_table_index: (Default value = 0xFFFFFFFF)
1263 :param is_add: (Default value = 1)
1264 :param is_drop: (Default value = 0)
1265 :param is_ipv6: (Default value = 0)
1266 :param is_local: (Default value = 0)
1267 :param is_classify: (Default value = 0)
1268 :param is_multipath: (Default value = 0)
1269 :param is_multicast: (Default value = 0)
1270 :param is_resolve_host: (Default value = 0)
1271 :param is_resolve_attached: (Default value = 0)
1272 :param next_hop_weight: (Default value = 1)
1276 self.papi.mpls_route_add_del,
1279 'mr_table_id': table_id,
1280 'mr_classify_table_index': classify_table_index,
1281 'mr_is_add': is_add,
1282 'mr_is_classify': is_classify,
1283 'mr_is_multipath': is_multipath,
1284 'mr_is_multicast': is_multicast,
1285 'mr_is_resolve_host': is_resolve_host,
1286 'mr_is_resolve_attached': is_resolve_attached,
1287 'mr_is_interface_rx': is_interface_rx,
1288 'mr_is_rpf_id': is_rpf_id,
1289 'mr_next_hop_proto': next_hop_proto,
1290 'mr_next_hop_weight': next_hop_weight,
1291 'mr_next_hop': next_hop_address,
1292 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1293 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1294 'mr_next_hop_table_id': next_hop_table_id,
1295 'mr_next_hop_via_label': next_hop_via_label,
1296 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1298 def mpls_ip_bind_unbind(
1310 self.papi.mpls_ip_bind_unbind,
1311 {'mb_mpls_table_id': table_id,
1313 'mb_ip_table_id': ip_table_id,
1314 'mb_is_bind': is_bind,
1315 'mb_is_ip4': is_ip4,
1316 'mb_address_length': dst_address_length,
1317 'mb_address': dst_address})
1319 def mpls_tunnel_add_del(
1322 next_hop_proto_is_ip4,
1324 next_hop_sw_if_index=0xFFFFFFFF,
1325 next_hop_table_id=0,
1327 next_hop_n_out_labels=0,
1328 next_hop_out_label_stack=[],
1329 next_hop_via_label=MPLS_LABEL_INVALID,
1335 :param dst_address_length:
1336 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1338 :param next_hop_address:
1339 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1340 :param vrf_id: (Default value = 0)
1341 :param lookup_in_vrf: (Default value = 0)
1342 :param classify_table_index: (Default value = 0xFFFFFFFF)
1343 :param is_add: (Default value = 1)
1344 :param is_drop: (Default value = 0)
1345 :param is_ipv6: (Default value = 0)
1346 :param is_local: (Default value = 0)
1347 :param is_classify: (Default value = 0)
1348 :param is_multipath: (Default value = 0)
1349 :param is_resolve_host: (Default value = 0)
1350 :param is_resolve_attached: (Default value = 0)
1351 :param next_hop_weight: (Default value = 1)
1352 :param is_multicast: (Default value = 0)
1356 self.papi.mpls_tunnel_add_del,
1357 {'mt_sw_if_index': tun_sw_if_index,
1358 'mt_is_add': is_add,
1359 'mt_l2_only': l2_only,
1360 'mt_is_multicast': is_multicast,
1361 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1362 'mt_next_hop_weight': next_hop_weight,
1363 'mt_next_hop': next_hop_address,
1364 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1365 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1366 'mt_next_hop_table_id': next_hop_table_id,
1367 'mt_next_hop_via_label': next_hop_via_label,
1368 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1370 def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
1371 return self.api(self.papi.mpls_tunnel_dump,
1372 {'sw_if_index': sw_if_index})
1374 def nat44_interface_add_del_feature(
1379 """Enable/disable NAT44 feature on the interface
1381 :param sw_if_index: Software index of the interface
1382 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1383 :param is_add: 1 if add, 0 if delete (Default value = 1)
1386 self.papi.nat44_interface_add_del_feature,
1388 'is_inside': is_inside,
1389 'sw_if_index': sw_if_index})
1391 def nat44_interface_add_del_output_feature(
1396 """Enable/disable NAT44 output feature on the interface
1398 :param sw_if_index: Software index of the interface
1399 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1400 :param is_add: 1 if add, 0 if delete (Default value = 1)
1403 self.papi.nat44_interface_add_del_output_feature,
1405 'is_inside': is_inside,
1406 'sw_if_index': sw_if_index})
1408 def nat44_add_del_static_mapping(
1412 external_sw_if_index=0xFFFFFFFF,
1423 """Add/delete NAT44 static mapping
1425 :param local_ip: Local IP address
1426 :param external_ip: External IP address
1427 :param external_sw_if_index: External interface instead of IP address
1428 :param local_port: Local port number (Default value = 0)
1429 :param external_port: External port number (Default value = 0)
1430 :param addr_only: 1 if address only mapping, 0 if address and port
1431 :param vrf_id: VRF ID
1432 :param protocol: IP protocol (Default value = 0)
1433 :param twice_nat: 1 if translate external host address and port
1434 :param self_twice_nat: 1 if translate external host address and port
1435 whenever external host address equals
1436 local address of internal host
1437 :param out2in_only: if 1 rule is matching only out2in direction
1438 :param tag: Opaque string tag
1439 :param is_add: 1 if add, 0 if delete (Default value = 1)
1442 self.papi.nat44_add_del_static_mapping,
1444 'addr_only': addr_only,
1445 'local_ip_address': local_ip,
1446 'external_ip_address': external_ip,
1447 'local_port': local_port,
1448 'external_port': external_port,
1449 'external_sw_if_index': external_sw_if_index,
1451 'protocol': protocol,
1452 'twice_nat': twice_nat,
1453 'self_twice_nat': self_twice_nat,
1454 'out2in_only': out2in_only,
1457 def nat44_add_del_identity_mapping(
1460 sw_if_index=0xFFFFFFFF,
1467 """Add/delete NAT44 identity mapping
1469 :param ip: IP address (Default value = 0)
1470 :param sw_if_index: Interface instead of IP address
1471 :param port: Port number (Default value = 0)
1472 :param addr_only: 1 if address only mapping, 0 if address and port
1473 :param vrf_id: VRF ID
1474 :param protocol: IP protocol (Default value = 0)
1475 :param tag: Opaque string tag
1476 :param is_add: 1 if add, 0 if delete (Default value = 1)
1479 self.papi.nat44_add_del_identity_mapping,
1481 'addr_only': addr_only,
1484 'sw_if_index': sw_if_index,
1487 'protocol': protocol})
1489 def nat44_add_del_address_range(
1496 """Add/del NAT44 address range
1498 :param first_ip_address: First IP address
1499 :param last_ip_address: Last IP address
1500 :param vrf_id: VRF id for the address range
1501 :param twice_nat: twice NAT address for extenal hosts
1502 :param is_add: 1 if add, 0 if delete (Default value = 1)
1505 self.papi.nat44_add_del_address_range,
1506 {'first_ip_address': first_ip_address,
1507 'last_ip_address': last_ip_address,
1509 'twice_nat': twice_nat,
1512 def nat44_address_dump(self):
1513 """Dump NAT44 addresses
1514 :return: Dictionary of NAT44 addresses
1516 return self.api(self.papi.nat44_address_dump, {})
1518 def nat44_interface_dump(self):
1519 """Dump interfaces with NAT44 feature
1520 :return: Dictionary of interfaces with NAT44 feature
1522 return self.api(self.papi.nat44_interface_dump, {})
1524 def nat44_interface_output_feature_dump(self):
1525 """Dump interfaces with NAT44 output feature
1526 :return: Dictionary of interfaces with NAT44 output feature
1528 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1530 def nat44_static_mapping_dump(self):
1531 """Dump NAT44 static mappings
1532 :return: Dictionary of NAT44 static mappings
1534 return self.api(self.papi.nat44_static_mapping_dump, {})
1536 def nat44_identity_mapping_dump(self):
1537 """Dump NAT44 identity mappings
1538 :return: Dictionary of NAT44 identity mappings
1540 return self.api(self.papi.nat44_identity_mapping_dump, {})
1542 def nat_show_config(self):
1543 """Show NAT plugin config
1544 :return: NAT plugin config parameters
1546 return self.api(self.papi.nat_show_config, {})
1548 def nat44_add_interface_addr(
1553 """Add/del NAT44 address from interface
1555 :param sw_if_index: Software index of the interface
1556 :param twice_nat: twice NAT address for extenal hosts
1557 :param is_add: 1 if add, 0 if delete (Default value = 1)
1560 self.papi.nat44_add_del_interface_addr,
1562 'sw_if_index': sw_if_index,
1563 'twice_nat': twice_nat})
1565 def nat44_interface_addr_dump(self):
1566 """Dump NAT44 addresses interfaces
1567 :return: Dictionary of NAT44 addresses interfaces
1569 return self.api(self.papi.nat44_interface_addr_dump, {})
1576 """Enable/disable NAT IPFIX logging
1578 :param domain_id: Observation domain ID (Default value = 1)
1579 :param src_port: Source port number (Default value = 4739)
1580 :param enable: 1 if enable, 0 if disable (Default value = 1)
1583 self.papi.nat_ipfix_enable_disable,
1584 {'domain_id': domain_id,
1585 'src_port': src_port,
1588 def nat44_user_session_dump(
1592 """Dump NAT44 user's sessions
1594 :param ip_address: ip adress of the user to be dumped
1595 :param cpu_index: cpu_index on which the user is
1596 :param vrf_id: VRF ID
1597 :return: Dictionary of S-NAT sessions
1600 self.papi.nat44_user_session_dump,
1601 {'ip_address': ip_address,
1604 def nat44_user_dump(self):
1607 :return: Dictionary of NAT44 users
1609 return self.api(self.papi.nat44_user_dump, {})
1611 def nat44_add_del_lb_static_mapping(
1624 """Add/delete NAT44 load balancing static mapping
1626 :param twice_nat: 1 if translate external host address and port
1627 :param tag: Opaque string tag
1628 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1629 :param is_add - 1 if add, 0 if delete
1632 self.papi.nat44_add_del_lb_static_mapping,
1634 'external_addr': external_addr,
1635 'external_port': external_port,
1636 'protocol': protocol,
1637 'twice_nat': twice_nat,
1638 'self_twice_nat': self_twice_nat,
1639 'out2in_only': out2in_only,
1641 'affinity': affinity,
1642 'local_num': local_num,
1645 def nat44_lb_static_mapping_dump(self):
1646 """Dump NAT44 load balancing static mappings
1648 :return: Dictionary of NAT44 load balancing static mapping
1650 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1652 def nat44_del_session(
1659 ext_host_address=None,
1661 """Delete NAT44 session
1663 :param addr: IPv4 address
1664 :param por: port number
1665 :param protocol: IP protocol number
1666 :param vrf_id: VRF ID
1667 :param is_in: 1 if inside network addres and port pari, 0 if outside
1668 :param ext_host_address: external host IPv4 address
1669 :param ext_host_port: external host port
1671 if ext_host_address is None:
1673 self.papi.nat44_del_session,
1676 'protocol': protocol,
1681 self.papi.nat44_del_session,
1684 'protocol': protocol,
1687 'ext_host_valid': 1,
1688 'ext_host_address': ext_host_address,
1689 'ext_host_port': ext_host_port})
1691 def nat44_forwarding_enable_disable(
1694 """Enable/disable forwarding for NAT44
1696 :param enable: 1 for enable, 0 for disable
1699 self.papi.nat44_forwarding_enable_disable,
1709 """Set NAT virtual fragmentation reassembly
1711 :param timeout: reassembly timeout (Default 2sec)
1712 :param max_reass: maximum concurrent reassemblies (Default 1024)
1713 :param max_frag: maximum fragmets per reassembly (Default 5)
1714 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1715 :param is_ip6: 1 if IPv6, 0 if IPv4
1718 self.papi.nat_set_reass,
1719 {'timeout': timeout,
1720 'max_reass': max_reass,
1721 'max_frag': max_frag,
1722 'drop_frag': drop_frag,
1725 def nat_get_reass(self):
1726 """Get NAT virtual fragmentation reassembly configuration
1728 :return: NAT virtual fragmentation reassembly configuration
1730 return self.api(self.papi.nat_get_reass, {})
1732 def nat_reass_dump(self):
1733 """Dump NAT virtual fragmentation reassemblies
1735 :return: Dictionary of NAT virtual fragmentation reassemblies
1737 return self.api(self.papi.nat_reass_dump, {})
1739 def nat_det_add_del_map(
1746 """Add/delete deterministic NAT mapping
1748 :param is_add - 1 if add, 0 if delete
1749 :param in_addr - inside IP address
1750 :param in_plen - inside IP address prefix length
1751 :param out_addr - outside IP address
1752 :param out_plen - outside IP address prefix length
1755 self.papi.nat_det_add_del_map,
1760 'out_addr': out_addr,
1761 'out_plen': out_plen})
1763 def nat_det_forward(
1766 """Get outside address and port range from inside address
1768 :param in_addr - inside IP address
1771 self.papi.nat_det_forward,
1772 {'in_addr': in_addr,
1775 def nat_det_reverse(
1779 """Get inside address from outside address and port
1781 :param out_addr - outside IP address
1782 :param out_port - outside port
1785 self.papi.nat_det_reverse,
1786 {'out_addr': out_addr,
1787 'out_port': out_port})
1789 def nat_det_map_dump(self):
1790 """Dump deterministic NAT mappings
1792 :return: Dictionary of deterministic NAT mappings
1794 return self.api(self.papi.nat_det_map_dump, {})
1796 def nat_set_timeouts(
1799 tcp_established=7440,
1802 """Set values of timeouts for NAT sessions (in seconds)
1804 :param udp - UDP timeout (Default value = 300)
1805 :param tcp_established - TCP established timeout (Default value = 7440)
1806 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1807 :param icmp - ICMP timeout (Default value = 60)
1810 self.papi.nat_set_timeouts,
1812 'tcp_established': tcp_established,
1813 'tcp_transitory': tcp_transitory,
1816 def nat_get_timeouts(self):
1817 """Get values of timeouts for NAT sessions
1819 :return: Timeouts for NAT sessions (in seconds)
1821 return self.api(self.papi.nat_get_timeouts, {})
1823 def nat_set_addr_and_port_alloc_alg(
1831 """Set address and port assignment algorithm
1833 :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1834 :param psid_offset: number of offset bits (valid only for MAP-E alg)
1835 :param psid_length: length of PSID (valid only for MAP-E alg)
1836 :param psid: Port Set Identifier value (valid only for MAP-E alg)
1837 :param start_port: beginning of the port range
1838 :param end_port: end of the port range
1841 self.papi.nat_set_addr_and_port_alloc_alg,
1843 'psid_offset': psid_offset,
1844 'psid_length': psid_length,
1846 'start_port': start_port,
1847 'end_port': end_port})
1849 def nat_get_addr_and_port_alloc_alg(self):
1850 """Get address and port assignment algorithm"""
1851 return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1853 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1854 """Set TCP MSS rewriting configuration
1856 :param enable: disable(0)/enable(1) MSS rewriting feature
1857 :param mss_value: MSS value to be used for MSS rewriting
1860 self.papi.nat_set_mss_clamping,
1861 {'enable': enable, 'mss_value': mss_value})
1863 def nat_get_mss_clamping(self):
1864 """Get TCP MSS rewriting configuration"""
1865 return self.api(self.papi.nat_get_mss_clamping, {})
1867 def nat_det_close_session_out(
1873 """Close deterministic NAT session using outside address and port
1875 :param out_addr - outside IP address
1876 :param out_port - outside port
1877 :param ext_addr - external host IP address
1878 :param ext_port - external host port
1881 self.papi.nat_det_close_session_out,
1882 {'out_addr': out_addr,
1883 'out_port': out_port,
1884 'ext_addr': ext_addr,
1885 'ext_port': ext_port})
1887 def nat_det_close_session_in(
1893 """Close deterministic NAT session using inside address and port
1895 :param in_addr - inside IP address
1896 :param in_port - inside port
1897 :param ext_addr - external host IP address
1898 :param ext_port - external host port
1901 self.papi.nat_det_close_session_in,
1902 {'in_addr': in_addr,
1904 'ext_addr': ext_addr,
1905 'ext_port': ext_port,
1908 def nat_det_session_dump(
1911 """Dump deterministic NAT sessions belonging to a user
1913 :param user_addr - inside IP address of the user
1914 :return: Dictionary of deterministic NAT sessions
1917 self.papi.nat_det_session_dump,
1919 'user_addr': user_addr})
1921 def nat64_add_del_pool_addr_range(
1927 """Add/del address range to NAT64 pool
1929 :param start_addr: First IP address
1930 :param end_addr: Last IP address
1931 :param vrf_id: VRF id for the address range
1932 :param is_add: 1 if add, 0 if delete (Default value = 1)
1935 self.papi.nat64_add_del_pool_addr_range,
1936 {'start_addr': start_addr,
1937 'end_addr': end_addr,
1941 def nat64_pool_addr_dump(self):
1942 """Dump NAT64 pool addresses
1943 :return: Dictionary of NAT64 pool addresses
1945 return self.api(self.papi.nat64_pool_addr_dump, {})
1947 def nat64_add_del_interface(
1952 """Enable/disable NAT64 feature on the interface
1953 :param sw_if_index: Index of the interface
1954 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1955 :param is_add: 1 if add, 0 if delete (Default value = 1)
1958 self.papi.nat64_add_del_interface,
1959 {'sw_if_index': sw_if_index,
1960 'is_inside': is_inside,
1963 def nat64_interface_dump(self):
1964 """Dump interfaces with NAT64 feature
1965 :return: Dictionary of interfaces with NAT64 feature
1967 return self.api(self.papi.nat64_interface_dump, {})
1969 def nat64_add_del_static_bib(
1978 """Add/delete S-NAT static BIB entry
1980 :param in_ip: Inside IPv6 address
1981 :param out_ip: Outside IPv4 address
1982 :param in_port: Inside port number
1983 :param out_port: Outside port number
1984 :param protocol: IP protocol
1985 :param vrf_id: VRF ID (Default value = 0)
1986 :param is_add: 1 if add, 0 if delete (Default value = 1)
1989 self.papi.nat64_add_del_static_bib,
1998 def nat64_bib_dump(self, protocol=255):
2001 :param protocol: IP protocol (Default value = 255, all BIBs)
2002 :returns: Dictionary of NAT64 BIB entries
2004 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
2006 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
2007 tcp_incoming_syn=6):
2008 """Set values of timeouts for NAT64 (in seconds)
2010 :param udpi: UDP timeout (Default value = 300)
2011 :param icmp: ICMP timeout (Default value = 60)
2012 :param tcp_trans: TCP transitory timeout (Default value = 240)
2013 :param tcp_est: TCP established timeout (Default value = 7440)
2014 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
2017 self.papi.nat64_set_timeouts,
2020 'tcp_trans': tcp_trans,
2022 'tcp_incoming_syn': tcp_incoming_syn})
2024 def nat64_get_timeouts(self):
2025 """Get values of timeouts for NAT64
2027 :return: Timeouts for NAT64 (in seconds)
2029 return self.api(self.papi.nat64_get_timeouts, {})
2031 def nat64_st_dump(self, protocol=255):
2032 """Dump NAT64 session table
2034 :param protocol: IP protocol (Default value = 255, all STs)
2035 :returns: Dictionary of NAT64 sesstion table entries
2037 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2039 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2040 """Add/del NAT64 prefix
2042 :param prefix: NAT64 prefix
2043 :param plen: NAT64 prefix length
2044 :param vrf_id: VRF id of tenant (Default 0)
2045 :param is_add: 1 if add, 0 if delete (Default value = 1)
2048 self.papi.nat64_add_del_prefix,
2054 def nat64_prefix_dump(self):
2055 """Dump NAT64 prefix
2057 :returns: Dictionary of NAT64 prefixes
2059 return self.api(self.papi.nat64_prefix_dump, {})
2061 def nat64_add_interface_addr(
2065 """Add/del NAT64 address from interface
2067 :param sw_if_index: Software index of the interface
2068 :param is_add: 1 if add, 0 if delete (Default value = 1)
2070 return self.api(self.papi.nat64_add_del_interface_addr,
2071 {'is_add': is_add, 'sw_if_index': sw_if_index})
2073 def dslite_set_aftr_addr(self, ip6, ip4):
2074 """Set DS-Lite AFTR addresses
2076 :param ip4: IPv4 address
2077 :param ip6: IPv6 address
2080 self.papi.dslite_set_aftr_addr,
2084 def dslite_set_b4_addr(self, ip6, ip4):
2085 """Set DS-Lite B4 IPv6 address
2087 :param ip4: IPv4 address
2088 :param ip6: IPv6 address
2091 self.papi.dslite_set_b4_addr,
2095 def dslite_add_del_pool_addr_range(
2100 """Add/del address range to DS-Lite pool
2102 :param start_addr: First IP address
2103 :param end_addr: Last IP address
2104 :param is_add: 1 if add, 0 if delete (Default value = 1)
2107 self.papi.dslite_add_del_pool_addr_range,
2108 {'start_addr': start_addr,
2109 'end_addr': end_addr,
2112 def nat66_add_del_interface(
2117 """Enable/disable NAT66 feature on the interface
2118 :param sw_if_index: Index of the interface
2119 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2120 :param is_add: 1 if add, 0 if delete (Default value = 1)
2123 self.papi.nat66_add_del_interface,
2124 {'sw_if_index': sw_if_index,
2125 'is_inside': is_inside,
2128 def nat66_add_del_static_mapping(
2134 """Add/delete NAT66 static mapping
2136 :param in_ip: Inside IPv6 address
2137 :param out_ip: Outside IPv6 address
2138 :param vrf_id: VRF ID (Default value = 0)
2139 :param is_add: 1 if add, 0 if delete (Default value = 1)
2142 self.papi.nat66_add_del_static_mapping,
2143 {'local_ip_address': in_ip,
2144 'external_ip_address': out_ip,
2148 def nat66_interface_dump(self):
2149 """Dump interfaces with NAT66 feature
2150 :return: Dictionary of interfaces with NAT66 feature
2152 return self.api(self.papi.nat66_interface_dump, {})
2154 def nat66_static_mapping_dump(self):
2155 """Dump NAT66 static mappings
2156 :return: Dictionary of NAT66 static mappings
2158 return self.api(self.papi.nat66_static_mapping_dump, {})
2160 def control_ping(self):
2161 self.api(self.papi.control_ping)
2163 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2164 detect_mult, local_addr, peer_addr, is_ipv6=0,
2165 bfd_key_id=None, conf_key_id=None):
2166 if bfd_key_id is None:
2167 return self.api(self.papi.bfd_udp_add,
2169 'sw_if_index': sw_if_index,
2170 'desired_min_tx': desired_min_tx,
2171 'required_min_rx': required_min_rx,
2172 'local_addr': local_addr,
2173 'peer_addr': peer_addr,
2175 'detect_mult': detect_mult,
2178 return self.api(self.papi.bfd_udp_add,
2180 'sw_if_index': sw_if_index,
2181 'desired_min_tx': desired_min_tx,
2182 'required_min_rx': required_min_rx,
2183 'local_addr': local_addr,
2184 'peer_addr': peer_addr,
2186 'detect_mult': detect_mult,
2187 'is_authenticated': 1,
2188 'bfd_key_id': bfd_key_id,
2189 'conf_key_id': conf_key_id,
2192 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2193 detect_mult, local_addr, peer_addr, is_ipv6=0):
2194 return self.api(self.papi.bfd_udp_mod,
2196 'sw_if_index': sw_if_index,
2197 'desired_min_tx': desired_min_tx,
2198 'required_min_rx': required_min_rx,
2199 'local_addr': local_addr,
2200 'peer_addr': peer_addr,
2202 'detect_mult': detect_mult,
2205 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2206 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2208 return self.api(self.papi.bfd_udp_auth_activate,
2210 'sw_if_index': sw_if_index,
2211 'local_addr': local_addr,
2212 'peer_addr': peer_addr,
2214 'is_delayed': 1 if is_delayed else 0,
2215 'bfd_key_id': bfd_key_id,
2216 'conf_key_id': conf_key_id,
2219 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2220 is_ipv6=0, is_delayed=False):
2221 return self.api(self.papi.bfd_udp_auth_deactivate,
2223 'sw_if_index': sw_if_index,
2224 'local_addr': local_addr,
2225 'peer_addr': peer_addr,
2227 'is_delayed': 1 if is_delayed else 0,
2230 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2231 return self.api(self.papi.bfd_udp_del,
2233 'sw_if_index': sw_if_index,
2234 'local_addr': local_addr,
2235 'peer_addr': peer_addr,
2239 def bfd_udp_session_dump(self):
2240 return self.api(self.papi.bfd_udp_session_dump, {})
2242 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2243 peer_addr, is_ipv6=0):
2244 return self.api(self.papi.bfd_udp_session_set_flags, {
2245 'admin_up_down': admin_up_down,
2246 'sw_if_index': sw_if_index,
2247 'local_addr': local_addr,
2248 'peer_addr': peer_addr,
2252 def want_bfd_events(self, enable_disable=1):
2253 return self.api(self.papi.want_bfd_events, {
2254 'enable_disable': enable_disable,
2258 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2259 return self.api(self.papi.bfd_auth_set_key, {
2260 'conf_key_id': conf_key_id,
2261 'auth_type': auth_type,
2263 'key_len': len(key),
2266 def bfd_auth_del_key(self, conf_key_id):
2267 return self.api(self.papi.bfd_auth_del_key, {
2268 'conf_key_id': conf_key_id,
2271 def bfd_auth_keys_dump(self):
2272 return self.api(self.papi.bfd_auth_keys_dump, {})
2274 def bfd_udp_set_echo_source(self, sw_if_index):
2275 return self.api(self.papi.bfd_udp_set_echo_source,
2276 {'sw_if_index': sw_if_index})
2278 def bfd_udp_del_echo_source(self):
2279 return self.api(self.papi.bfd_udp_del_echo_source, {})
2281 def bfd_udp_get_echo_source(self):
2282 return self.api(self.papi.bfd_udp_get_echo_source, {})
2284 def classify_add_del_table(
2289 table_index=0xFFFFFFFF,
2291 memory_size=2097152,
2293 next_table_index=0xFFFFFFFF,
2294 miss_next_index=0xFFFFFFFF,
2295 current_data_flag=0,
2296 current_data_offset=0):
2300 :param match_n_vectors: (Default value = 1)
2301 :param table_index: (Default value = 0xFFFFFFFF)
2302 :param nbuckets: (Default value = 2)
2303 :param memory_size: (Default value = 2097152)
2304 :param skip_n_vectors: (Default value = 0)
2305 :param next_table_index: (Default value = 0xFFFFFFFF)
2306 :param miss_next_index: (Default value = 0xFFFFFFFF)
2307 :param current_data_flag: (Default value = 0)
2308 :param current_data_offset: (Default value = 0)
2311 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2312 mask = mask + '\0' * (mask_len - len(mask))
2314 self.papi.classify_add_del_table,
2316 'table_index': table_index,
2317 'nbuckets': nbuckets,
2318 'memory_size': memory_size,
2319 'skip_n_vectors': skip_n_vectors,
2320 'match_n_vectors': match_n_vectors,
2321 'next_table_index': next_table_index,
2322 'miss_next_index': miss_next_index,
2323 'current_data_flag': current_data_flag,
2324 'current_data_offset': current_data_offset,
2325 'mask_len': mask_len,
2328 def classify_add_del_session(
2333 opaque_index=0xFFFFFFFF,
2334 hit_next_index=0xFFFFFFFF,
2342 :param opaque_index: (Default value = 0xFFFFFFFF)
2343 :param hit_next_index: (Default value = 0xFFFFFFFF)
2344 :param advance: (Default value = 0)
2345 :param action: (Default value = 0)
2346 :param metadata: (Default value = 0)
2349 match_len = ((len(match) - 1) / 16 + 1) * 16
2350 match = match + '\0' * (match_len - len(match))
2352 self.papi.classify_add_del_session,
2354 'table_index': table_index,
2355 'hit_next_index': hit_next_index,
2356 'opaque_index': opaque_index,
2359 'metadata': metadata,
2360 'match_len': match_len,
2363 def input_acl_set_interface(
2367 ip4_table_index=0xFFFFFFFF,
2368 ip6_table_index=0xFFFFFFFF,
2369 l2_table_index=0xFFFFFFFF):
2373 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2374 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2375 :param l2_table_index: (Default value = 0xFFFFFFFF)
2379 self.papi.input_acl_set_interface,
2380 {'sw_if_index': sw_if_index,
2381 'ip4_table_index': ip4_table_index,
2382 'ip6_table_index': ip6_table_index,
2383 'l2_table_index': l2_table_index,
2386 def output_acl_set_interface(
2390 ip4_table_index=0xFFFFFFFF,
2391 ip6_table_index=0xFFFFFFFF,
2392 l2_table_index=0xFFFFFFFF):
2396 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2397 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2398 :param l2_table_index: (Default value = 0xFFFFFFFF)
2402 self.papi.output_acl_set_interface,
2403 {'sw_if_index': sw_if_index,
2404 'ip4_table_index': ip4_table_index,
2405 'ip6_table_index': ip6_table_index,
2406 'l2_table_index': l2_table_index,
2409 def set_ipfix_exporter(
2416 collector_port=4739,
2419 self.papi.set_ipfix_exporter,
2421 'collector_address': collector_address,
2422 'collector_port': collector_port,
2423 'src_address': src_address,
2425 'path_mtu': path_mtu,
2426 'template_interval': template_interval,
2427 'udp_checksum': udp_checksum,
2430 def dhcp_proxy_config(self,
2438 self.papi.dhcp_proxy_config,
2440 'rx_vrf_id': rx_table_id,
2441 'server_vrf_id': server_table_id,
2444 'dhcp_server': dhcp_server,
2445 'dhcp_src_address': dhcp_src_address,
2448 def dhcp_proxy_set_vss(self,
2457 self.papi.dhcp_proxy_set_vss,
2460 'vss_type': vss_type,
2461 'vpn_ascii_id': vpn_ascii_id,
2463 'vpn_index': vpn_index,
2468 def dhcp_client_dump(self):
2469 return self.api(self.papi.dhcp_client_dump, {})
2471 def dhcp_client(self,
2476 set_broadcast_flag=1,
2477 want_dhcp_events=0):
2479 self.papi.dhcp_client_config,
2483 'sw_if_index': sw_if_index,
2484 'hostname': hostname,
2486 'want_dhcp_event': want_dhcp_events,
2487 'set_broadcast_flag': set_broadcast_flag,
2491 def ip_mroute_add_del(self,
2497 next_hop_sw_if_index,
2507 IP Multicast Route add/del
2510 self.papi.ip_mroute_add_del,
2511 {'next_hop_sw_if_index': next_hop_sw_if_index,
2512 'entry_flags': e_flags,
2513 'itf_flags': i_flags,
2514 'table_id': table_id,
2518 'is_local': is_local,
2519 'bier_imp': bier_imp,
2520 'next_hop_afi': next_hop_afi,
2521 'grp_address_length': grp_address_length,
2522 'grp_address': grp_address,
2523 'src_address': src_address,
2524 'nh_address': next_hop_address})
2526 def mfib_signal_dump(self):
2527 return self.api(self.papi.mfib_signal_dump, {})
2529 def ip_mfib_dump(self):
2530 return self.api(self.papi.ip_mfib_dump, {})
2532 def ip6_mfib_dump(self):
2533 return self.api(self.papi.ip6_mfib_dump, {})
2535 def lisp_enable_disable(self, is_enabled):
2537 self.papi.lisp_enable_disable,
2539 'is_en': is_enabled,
2542 def lisp_locator_set(self,
2546 self.papi.lisp_add_del_locator_set,
2549 'locator_set_name': ls_name
2552 def lisp_locator_set_dump(self):
2553 return self.api(self.papi.lisp_locator_set_dump, {})
2555 def lisp_locator(self,
2562 self.papi.lisp_add_del_locator,
2565 'locator_set_name': ls_name,
2566 'sw_if_index': sw_if_index,
2567 'priority': priority,
2571 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2573 self.papi.lisp_locator_dump,
2575 'is_index_set': is_index_set,
2577 'ls_index': ls_index,
2580 def lisp_local_mapping(self,
2590 self.papi.lisp_add_del_local_eid,
2592 'locator_set_name': ls_name,
2594 'eid_type': eid_type,
2596 'prefix_len': prefix_len,
2602 def lisp_eid_table_dump(self,
2610 self.papi.lisp_eid_table_dump,
2613 'prefix_length': prefix_length,
2615 'eid_type': eid_type,
2617 'filter': filter_opt,
2620 def lisp_remote_mapping(self,
2630 self.papi.lisp_add_del_remote_mapping,
2633 'eid_type': eid_type,
2635 'eid_len': eid_prefix_len,
2636 'rloc_num': rlocs_num,
2639 'is_src_dst': is_src_dst,
2642 def lisp_adjacency(self,
2651 self.papi.lisp_add_del_adjacency,
2655 'eid_type': eid_type,
2658 'leid_len': leid_len,
2659 'reid_len': reid_len,
2662 def lisp_adjacencies_get(self, vni=0):
2664 self.papi.lisp_adjacencies_get,
2669 def map_add_domain(self,
2683 self.papi.map_add_domain,
2685 'ip6_prefix': ip6_prefix,
2686 'ip6_prefix_len': ip6_prefix_len,
2687 'ip4_prefix': ip4_prefix,
2688 'ip4_prefix_len': ip4_prefix_len,
2690 'ip6_src_prefix_len': ip6_src_prefix_len,
2691 'ea_bits_len': ea_bits_len,
2692 'psid_offset': psid_offset,
2693 'psid_length': psid_length,
2694 'is_translation': is_translation,
2695 'is_rfc6052': is_rfc6052,
2699 def gtpu_add_del_tunnel(
2705 mcast_sw_if_index=0xFFFFFFFF,
2707 decap_next_index=0xFFFFFFFF,
2711 :param is_add: (Default value = 1)
2712 :param is_ipv6: (Default value = 0)
2715 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2716 :param encap_vrf_id: (Default value = 0)
2717 :param decap_next_index: (Default value = 0xFFFFFFFF)
2718 :param teid: (Default value = 0)
2721 return self.api(self.papi.gtpu_add_del_tunnel,
2724 'src_address': src_addr,
2725 'dst_address': dst_addr,
2726 'mcast_sw_if_index': mcast_sw_if_index,
2727 'encap_vrf_id': encap_vrf_id,
2728 'decap_next_index': decap_next_index,
2731 def vxlan_gpe_add_del_tunnel(
2735 mcast_sw_if_index=0xFFFFFFFF,
2746 :param is_add: (Default value = 1)
2747 :param is_ipv6: (Default value = 0)
2748 :param encap_vrf_id: (Default value = 0)
2749 :param decap_vrf_id: (Default value = 0)
2750 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2751 :param protocol: (Default value = 3)
2752 :param vni: (Default value = 0)
2755 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2760 'mcast_sw_if_index': mcast_sw_if_index,
2761 'encap_vrf_id': encap_vrf_id,
2762 'decap_vrf_id': decap_vrf_id,
2763 'protocol': protocol,
2766 def vxlan_gbp_tunnel_add_del(
2770 mcast_sw_if_index=0xFFFFFFFF,
2774 decap_next_index=0xFFFFFFFF,
2776 instance=0xFFFFFFFF):
2781 :param is_add: (Default value = 1)
2782 :param is_ipv6: (Default value = 0)
2783 :param encap_table_id: (Default value = 0)
2784 :param decap_next_index: (Default value = 0xFFFFFFFF)
2785 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2786 :param vni: (Default value = 0)
2787 :param instance: (Default value = 0xFFFFFFFF)
2790 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2795 'mcast_sw_if_index': mcast_sw_if_index,
2796 'encap_table_id': encap_table_id,
2797 'decap_next_index': decap_next_index,
2799 'instance': instance}})
2801 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2802 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2803 {'sw_if_index': sw_if_index})
2805 def pppoe_add_del_session(
2815 :param is_add: (Default value = 1)
2816 :param is_ipv6: (Default value = 0)
2818 :param session_id: (Default value = 0)
2820 :param decap_vrf_id: (Default value = 0)
2823 return self.api(self.papi.pppoe_add_del_session,
2826 'session_id': session_id,
2827 'client_ip': client_ip,
2828 'decap_vrf_id': decap_vrf_id,
2829 'client_mac': client_mac})
2831 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2832 return self.api(self.papi.sr_mpls_policy_add,
2836 'n_segments': len(segments),
2837 'segments': segments})
2839 def sr_mpls_policy_del(self, bsid):
2840 return self.api(self.papi.sr_mpls_policy_del,
2843 def sr_localsid_add_del(self,
2850 sw_if_index=0xFFFFFFFF,
2854 """ Add/del IPv6 SR local-SID.
2857 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2858 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2861 :param is_del: (Default value = 0)
2862 :param end_psp: (Default value = 0)
2863 :param sw_if_index: (Default value = 0xFFFFFFFF)
2864 :param vlan_index: (Default value = 0)
2865 :param fib_table: (Default value = 0)
2868 self.papi.sr_localsid_add_del,
2870 'localsid': localsid,
2872 'behavior': behavior,
2873 'sw_if_index': sw_if_index,
2874 'vlan_index': vlan_index,
2875 'fib_table': fib_table,
2876 'nh_addr4': nh_addr4,
2877 'nh_addr6': nh_addr6
2891 :param bsid_addr: bindingSID of the SR Policy
2892 :param weight: weight of the sid list. optional. (default: 1)
2893 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2895 :param type: type/behavior of the SR policy. (default or spray) \
2897 :param fib_table: VRF where to install the FIB entry for the BSID \
2899 :param n_segments: number of segments \
2901 :param segments: a vector of IPv6 address composing the segment list \
2905 self.papi.sr_policy_add,
2906 {'bsid_addr': bsid_addr,
2908 'is_encap': is_encap,
2910 'fib_table': fib_table,
2911 'n_segments': n_segments,
2912 'segments': segments
2921 :param bsid: bindingSID of the SR Policy
2922 :param sr_policy_index: index of the sr policy (default: 0)
2925 self.papi.sr_policy_del,
2926 {'bsid_addr': bsid_addr,
2927 'sr_policy_index': sr_policy_index
2930 def sr_steering_add_del(
2941 Steer traffic L2 and L3 traffic through a given SR policy
2943 :param is_del: delete or add
2944 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2945 :param sr_policy: is the index of the SR Policy (alt to bsid)
2946 :param table_id: is the VRF where to install the FIB entry for the BSID
2947 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2948 :param mask_width: is the mask for L3 traffic type
2949 :param sw_if_index: is the incoming interface for L2 traffic
2950 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2953 self.papi.sr_steering_add_del,
2955 'bsid_addr': bsid_addr,
2956 'sr_policy_index': sr_policy_index,
2957 'table_id': table_id,
2958 'prefix_addr': prefix_addr,
2959 'mask_width': mask_width,
2960 'sw_if_index': sw_if_index,
2961 'traffic_type': traffic_type
2964 def acl_add_replace(self, acl_index, r, tag='',
2966 """Add/replace an ACL
2967 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2968 :param acl_rule r: ACL rules array.
2969 :param str tag: symbolic tag (description) for this ACL.
2970 :param int count: number of rules.
2972 return self.api(self.papi.acl_add_replace,
2973 {'acl_index': acl_index,
2977 expected_retval=expected_retval)
2979 def acl_del(self, acl_index, expected_retval=0):
2985 return self.api(self.papi.acl_del,
2986 {'acl_index': acl_index},
2987 expected_retval=expected_retval)
2989 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2991 return self.api(self.papi.acl_interface_set_acl_list,
2992 {'sw_if_index': sw_if_index,
2996 expected_retval=expected_retval)
2998 def acl_interface_set_etype_whitelist(self, sw_if_index,
3001 return self.api(self.papi.acl_interface_set_etype_whitelist,
3002 {'sw_if_index': sw_if_index,
3003 'count': len(whitelist),
3005 'whitelist': whitelist},
3006 expected_retval=expected_retval)
3008 def acl_interface_add_del(self,
3012 """ Add/Delete ACL to/from interface
3016 :param is_add: (Default value = 1)
3019 return self.api(self.papi.acl_interface_add_del,
3022 'sw_if_index': sw_if_index,
3023 'acl_index': acl_index})
3025 def acl_dump(self, acl_index, expected_retval=0):
3026 return self.api(self.papi.acl_dump,
3027 {'acl_index': acl_index},
3028 expected_retval=expected_retval)
3030 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3032 return self.api(self.papi.acl_interface_list_dump,
3033 {'sw_if_index': sw_if_index},
3034 expected_retval=expected_retval)
3036 def macip_acl_add(self, rules, tag=""):
3039 :param rules: list of rules for given acl
3043 return self.api(self.papi.macip_acl_add,
3045 'count': len(rules),
3048 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3051 :param rules: list of rules for given acl
3055 return self.api(self.papi.macip_acl_add_replace,
3056 {'acl_index': acl_index,
3058 'count': len(rules),
3061 def macip_acl_del(self, acl_index):
3067 return self.api(self.papi.macip_acl_del,
3068 {'acl_index': acl_index})
3070 def macip_acl_interface_add_del(self,
3074 """ Add MACIP acl to interface
3078 :param is_add: (Default value = 1)
3081 return self.api(self.papi.macip_acl_interface_add_del,
3083 'sw_if_index': sw_if_index,
3084 'acl_index': acl_index})
3086 def macip_acl_interface_get(self):
3087 """ Return interface acls dump
3090 self.papi.macip_acl_interface_get, {})
3092 def macip_acl_dump(self, acl_index=4294967295):
3093 """ Return MACIP acl dump
3097 self.papi.macip_acl_dump, {'acl_index': acl_index})
3099 def policer_add_del(self,
3110 conform_action_type=1,
3112 exceed_action_type=0,
3114 violate_action_type=0,
3116 return self.api(self.papi.policer_add_del,
3123 'rate_type': rate_type,
3124 'round_type': round_type,
3126 'color_aware': color_aware,
3127 'conform_action_type': conform_action_type,
3128 'conform_dscp': conform_dscp,
3129 'exceed_action_type': exceed_action_type,
3130 'exceed_dscp': exceed_dscp,
3131 'violate_action_type': violate_action_type,
3132 'violate_dscp': violate_dscp})
3134 def ip_punt_police(self,
3138 return self.api(self.papi.ip_punt_police,
3139 {'policer_index': policer_index,
3143 def ip_punt_redirect(self,
3149 return self.api(self.papi.ip_punt_redirect,
3150 {'rx_sw_if_index': rx_sw_if_index,
3151 'tx_sw_if_index': tx_sw_if_index,
3156 def bier_table_add_del(self,
3160 """ BIER Table add/del """
3162 self.papi.bier_table_add_del,
3163 {'bt_tbl_id': {"bt_set": bti.set_id,
3164 "bt_sub_domain": bti.sub_domain_id,
3165 "bt_hdr_len_id": bti.hdr_len_id},
3166 'bt_label': mpls_label,
3167 'bt_is_add': is_add})
3169 def bier_table_dump(self):
3170 return self.api(self.papi.bier_table_dump, {})
3172 def bier_route_add_del(self,
3178 """ BIER Route add/del """
3180 self.papi.bier_route_add_del,
3181 {'br_tbl_id': {"bt_set": bti.set_id,
3182 "bt_sub_domain": bti.sub_domain_id,
3183 "bt_hdr_len_id": bti.hdr_len_id},
3185 'br_n_paths': len(paths),
3187 'br_is_add': is_add,
3188 'br_is_replace': is_replace})
3190 def bier_route_dump(self, bti):
3192 self.papi.bier_route_dump,
3193 {'br_tbl_id': {"bt_set": bti.set_id,
3194 "bt_sub_domain": bti.sub_domain_id,
3195 "bt_hdr_len_id": bti.hdr_len_id}})
3197 def bier_imp_add(self,
3202 """ BIER Imposition Add """
3204 self.papi.bier_imp_add,
3205 {'bi_tbl_id': {"bt_set": bti.set_id,
3206 "bt_sub_domain": bti.sub_domain_id,
3207 "bt_hdr_len_id": bti.hdr_len_id},
3209 'bi_n_bytes': len(ibytes),
3210 'bi_bytes': ibytes})
3212 def bier_imp_del(self, bi_index):
3213 """ BIER Imposition del """
3215 self.papi.bier_imp_del,
3216 {'bi_index': bi_index})
3218 def bier_imp_dump(self):
3219 return self.api(self.papi.bier_imp_dump, {})
3221 def bier_disp_table_add_del(self,
3224 """ BIER Disposition Table add/del """
3226 self.papi.bier_disp_table_add_del,
3227 {'bdt_tbl_id': bdti,
3228 'bdt_is_add': is_add})
3230 def bier_disp_table_dump(self):
3231 return self.api(self.papi.bier_disp_table_dump, {})
3233 def bier_disp_entry_add_del(self,
3243 """ BIER Route add/del """
3245 while (len(lstack) < 16):
3248 self.papi.bier_disp_entry_add_del,
3249 {'bde_tbl_id': bdti,
3251 'bde_payload_proto': payload_proto,
3253 'bde_paths': [{'next_hop': next_hop,
3254 'table_id': next_hop_tbl_id,
3255 'afi': next_hop_afi,
3256 'rpf_id': next_hop_rpf_id,
3258 'label_stack': lstack}],
3259 'bde_is_add': is_add})
3261 def bier_disp_entry_dump(self, bdti):
3263 self.papi.bier_disp_entry_dump,
3264 {'bde_tbl_id': bdti})
3266 def add_node_next(self, node_name, next_name):
3267 """ Set the next node for a given node request
3272 return self.api(self.papi.add_node_next,
3273 {'node_name': node_name,
3274 'next_name': next_name})
3276 def session_enable_disable(self, is_enabled):
3278 self.papi.session_enable_disable,
3279 {'is_enable': is_enabled})
3281 def ipsec_spd_add_del(self, spd_id, is_add=1):
3282 """ SPD add/del - Wrapper to add or del ipsec SPD
3283 Sample CLI : 'ipsec spd add 1'
3285 :param spd_id - SPD ID to be created in the vpp . mandatory
3286 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3288 :returns: reply from the API
3291 self.papi.ipsec_spd_add_del, {
3292 'spd_id': spd_id, 'is_add': is_add})
3294 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3295 """ IPSEC interface SPD add/del - \
3296 Wrapper to associate/disassociate SPD to interface in VPP
3297 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3299 :param spd_id - SPD ID to associate with the interface . mandatory
3300 :param sw_if_index - Interface Index which needs to ipsec \
3301 association mandatory
3302 :param is_add - add(1) or del(0) association with interface \
3303 (Default 1 - add) . optional
3304 :returns: reply from the API
3307 self.papi.ipsec_interface_add_del_spd,
3308 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3310 def ipsec_sad_add_del_entry(self,
3313 integrity_algorithm,
3318 tunnel_src_address='',
3319 tunnel_dst_address='',
3324 """ IPSEC SA add/del
3325 :param sad_id: security association ID
3326 :param spi: security param index of the SA in decimal
3327 :param integrity_algorithm:
3328 :param integrity_key:
3329 :param crypto_algorithm:
3331 :param protocol: AH(0) or ESP(1) protocol
3332 :param tunnel_src_address: tunnel mode outer src address
3333 :param tunnel_dst_address: tunnel mode outer dst address
3336 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3337 crypto and ipsec algorithms
3340 self.papi.ipsec_sad_add_del_entry,
3343 'tunnel_src_address': tunnel_src_address,
3344 'tunnel_dst_address': tunnel_dst_address,
3345 'protocol': protocol,
3346 'integrity_algorithm': integrity_algorithm,
3347 'integrity_key_length': len(integrity_key),
3348 'integrity_key': integrity_key,
3349 'crypto_algorithm': crypto_algorithm,
3350 'crypto_key_length': len(crypto_key) if crypto_key is not None
3352 'crypto_key': crypto_key,
3354 'is_tunnel': is_tunnel,
3355 'is_tunnel_ipv6': is_tunnel_ipv6,
3356 'udp_encap': udp_encap})
3358 def ipsec_spd_add_del_entry(self,
3361 local_address_start,
3363 remote_address_start,
3364 remote_address_stop,
3366 local_port_stop=65535,
3367 remote_port_start=0,
3368 remote_port_stop=65535,
3376 """ IPSEC policy SPD add/del -
3377 Wrapper to configure ipsec SPD policy entries in VPP
3378 :param spd_id: SPD ID for the policy
3379 :param local_address_start: local-ip-range start address
3380 :param local_address_stop : local-ip-range stop address
3381 :param remote_address_start: remote-ip-range start address
3382 :param remote_address_stop : remote-ip-range stop address
3383 :param local_port_start: (Default value = 0)
3384 :param local_port_stop: (Default value = 65535)
3385 :param remote_port_start: (Default value = 0)
3386 :param remote_port_stop: (Default value = 65535)
3387 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3388 :param sa_id: Security Association ID for mapping it to SPD
3389 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3391 :param priority: value for the spd action (Default value = 100)
3392 :param is_outbound: flag for inbound(0) or outbound(1)
3394 :param is_add: (Default value = 1)
3397 self.papi.ipsec_spd_add_del_entry,
3400 'local_address_start': local_address_start,
3401 'local_address_stop': local_address_stop,
3402 'remote_address_start': remote_address_start,
3403 'remote_address_stop': remote_address_stop,
3404 'local_port_start': local_port_start,
3405 'local_port_stop': local_port_stop,
3406 'remote_port_start': remote_port_start,
3407 'remote_port_stop': remote_port_stop,
3409 'protocol': protocol,
3411 'priority': priority,
3412 'is_outbound': is_outbound,
3414 'is_ip_any': is_ip_any})
3416 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3417 remote_spi, crypto_alg, local_crypto_key,
3418 remote_crypto_key, integ_alg, local_integ_key,
3419 remote_integ_key, is_add=1, esn=0,
3420 anti_replay=1, renumber=0, show_instance=0):
3422 self.papi.ipsec_tunnel_if_add_del,
3423 {'local_ip': local_ip, 'remote_ip': remote_ip,
3424 'local_spi': local_spi, 'remote_spi': remote_spi,
3425 'crypto_alg': crypto_alg,
3426 'local_crypto_key_len': len(local_crypto_key),
3427 'local_crypto_key': local_crypto_key,
3428 'remote_crypto_key_len': len(remote_crypto_key),
3429 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3430 'local_integ_key_len': len(local_integ_key),
3431 'local_integ_key': local_integ_key,
3432 'remote_integ_key_len': len(remote_integ_key),
3433 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3434 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3435 'show_instance': show_instance
3438 def app_namespace_add(self,
3442 sw_if_index=0xFFFFFFFF,
3445 self.papi.app_namespace_add_del,
3447 'sw_if_index': sw_if_index,
3448 'ip4_fib_id': ip4_fib_id,
3449 'ip6_fib_id': ip6_fib_id,
3450 'namespace_id': namespace_id,
3451 'namespace_id_len': len(namespace_id)})
3453 def punt_socket_register(self, l4_port, pathname, header_version=1,
3454 is_ip4=1, l4_protocol=0x11):
3455 """ Punt to socket """
3456 return self.api(self.papi.punt_socket_register,
3458 'l4_protocol': l4_protocol,
3460 'pathname': pathname,
3461 'header_version': header_version})
3463 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3464 expire_walk_interval_ms, is_ip6=0):
3465 """ Set IP reassembly parameters """
3466 return self.api(self.papi.ip_reassembly_set,
3468 'timeout_ms': timeout_ms,
3469 'expire_walk_interval_ms': expire_walk_interval_ms,
3470 'max_reassemblies': max_reassemblies})
3472 def ip_reassembly_get(self, is_ip6=0):
3473 """ Get IP reassembly parameters """
3474 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3476 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3478 """ Enable/disable IP reassembly """
3479 return self.api(self.papi.ip_reassembly_enable_disable,
3480 {'sw_if_index': sw_if_index,
3481 'enable_ip4': 1 if enable_ip4 else 0,
3482 'enable_ip6': 1 if enable_ip6 else 0,
3485 def gbp_endpoint_add(self, sw_if_index, ips, mac, epg):
3486 """ GBP endpoint Add """
3487 return self.api(self.papi.gbp_endpoint_add,
3489 'sw_if_index': sw_if_index,
3495 def gbp_endpoint_del(self, handle):
3496 """ GBP endpoint Del """
3497 return self.api(self.papi.gbp_endpoint_del,
3500 def gbp_endpoint_dump(self):
3501 """ GBP endpoint Dump """
3502 return self.api(self.papi.gbp_endpoint_dump, {})
3504 def gbp_endpoint_group_add_del(self, is_add, epg, bd,
3507 uplink_sw_if_index):
3508 """ GBP endpoint group Add/Del """
3509 return self.api(self.papi.gbp_endpoint_group_add_del,
3512 'uplink_sw_if_index': uplink_sw_if_index,
3514 'ip4_table_id': ip4_rd,
3515 'ip6_table_id': ip6_rd,
3518 def gbp_endpoint_group_dump(self):
3519 """ GBP endpoint group Dump """
3520 return self.api(self.papi.gbp_endpoint_group_dump, {})
3522 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3523 """ GBP recirc Add/Del """
3524 return self.api(self.papi.gbp_recirc_add_del,
3528 'sw_if_index': sw_if_index,
3531 def gbp_recirc_dump(self):
3532 """ GBP recirc Dump """
3533 return self.api(self.papi.gbp_recirc_dump, {})
3535 def gbp_subnet_add_del(self, is_add, table_id,
3538 sw_if_index=0xffffffff,
3541 """ GBP Subnet Add/Del """
3542 return self.api(self.papi.gbp_subnet_add_del,
3545 'is_internal': is_internal,
3547 'sw_if_index': sw_if_index,
3550 'table_id': table_id}})
3552 def gbp_subnet_dump(self):
3553 """ GBP Subnet Dump """
3554 return self.api(self.papi.gbp_subnet_dump, {})
3556 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3557 """ GBP contract Add/Del """
3558 return self.api(self.papi.gbp_contract_add_del,
3561 'acl_index': acl_index,
3563 'dst_epg': dst_epg}})
3565 def gbp_contract_dump(self):
3566 """ GBP contract Dump """
3567 return self.api(self.papi.gbp_contract_dump, {})
3569 def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3570 ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3572 """ 6RD tunnel Add """
3573 return self.api(self.papi.ipip_6rd_add_tunnel,
3574 {'ip4_table_id': ip4_table_id,
3575 'ip6_table_id': ip6_table_id,
3576 'ip6_prefix': ip6_prefix,
3577 'ip6_prefix_len': ip6_prefix_len,
3578 'ip4_prefix': ip4_prefix,
3579 'ip4_prefix_len': ip4_prefix_len,
3581 'security_check': security_check})
3583 def ipip_6rd_del_tunnel(self, sw_if_index):
3584 """ 6RD tunnel Delete """
3585 return self.api(self.papi.ipip_6rd_del_tunnel,
3586 {'sw_if_index': sw_if_index})
3588 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3589 instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3590 """ IPIP tunnel Add/Del """
3591 return self.api(self.papi.ipip_add_tunnel,
3592 {'is_ipv6': is_ipv6,
3593 'instance': instance,
3594 'src_address': src_address,
3595 'dst_address': dst_address,
3596 'table_id': table_id,
3599 def ipip_del_tunnel(self, sw_if_index):
3600 """ IPIP tunnel Delete """
3601 return self.api(self.papi.ipip_del_tunnel,
3602 {'sw_if_index': sw_if_index})
3604 def qos_egress_map_update(self, id, outputs):
3605 """ QOS egress map update """
3606 return self.api(self.papi.qos_egress_map_update,
3610 def qos_egress_map_delete(self, id):
3611 """ QOS egress map delete """
3612 return self.api(self.papi.qos_egress_map_delete,
3615 def qos_mark_enable_disable(self, sw_if_index,
3619 """ QOS Mark Enable/Disable """
3620 return self.api(self.papi.qos_mark_enable_disable,
3622 'sw_if_index': sw_if_index,
3623 'output_source': output_source,
3626 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3627 """ IP QoS recording Enble/Disable """
3628 return self.api(self.papi.qos_record_enable_disable,
3629 {'sw_if_index': sw_if_index,
3630 'input_source': input_source,
3633 def igmp_enable_disable(self, sw_if_index, enable, host):
3634 """ Enable/disable IGMP on a given interface """
3635 return self.api(self.papi.igmp_enable_disable,
3638 'sw_if_index': sw_if_index})
3640 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
3641 """ Add/del IGMP proxy device """
3642 return self.api(self.papi.igmp_proxy_device_add_del,
3643 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3646 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
3647 """ Add/del interface to/from IGMP proxy device """
3648 return self.api(self.papi.igmp_proxy_device_add_del_interface,
3649 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3652 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3653 """ Listen for new (S,G) on specified interface
3655 :param enable: add/del
3656 :param sw_if_index: interface sw index
3657 :param saddr: source ip4 addr
3658 :param gaddr: group ip4 addr
3660 return self.api(self.papi.igmp_listen,
3665 'sw_if_index': sw_if_index,
3666 'n_srcs': len(saddrs),
3675 def igmp_dump(self, sw_if_index=None):
3676 """ Dump all (S,G) interface configurations """
3677 if sw_if_index is None:
3678 sw_if_index = 0xffffffff
3679 return self.api(self.papi.igmp_dump,
3680 {'sw_if_index': sw_if_index})
3682 def igmp_clear_interface(self, sw_if_index):
3683 """ Remove all (S,G)s from specified interface
3684 doesn't send IGMP report!
3687 self.papi.igmp_clear_interface, {
3688 'sw_if_index': sw_if_index})
3690 def want_igmp_events(self, enable=1):
3691 return self.api(self.papi.want_igmp_events, {'enable': enable,
3692 'pid': os.getpid()})
3702 :param lb: load balance
3703 :param use_custom_mac: use custom mac
3704 :param mac_address: mac address
3707 self.papi.bond_create,
3710 'use_custom_mac': use_custom_mac,
3711 'mac_address': mac_address
3718 :param sw_if_index: interface the operation is applied to
3720 return self.api(self.papi.bond_delete,
3721 {'sw_if_index': sw_if_index})
3730 :param sw_if_index: slave sw_if_index
3731 :param bond_sw_if_index: bond sw_if_index
3732 :param is_passive: is passive lacp speaker
3733 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3736 self.papi.bond_enslave,
3737 {'sw_if_index': sw_if_index,
3738 'bond_sw_if_index': bond_sw_if_index,
3739 'is_passive': is_passive,
3740 'is_long_timeout': is_long_timeout
3743 def bond_detach_slave(
3747 :param sw_if_index: slave interface the operation is applied to
3749 return self.api(self.papi.bond_detach_slave,
3750 {'sw_if_index': sw_if_index})
3752 def sw_interface_slave_dump(
3756 :param sw_if_index: bond sw_if_index
3758 return self.api(self.papi.sw_interface_slave_dump,
3759 {'sw_if_index': sw_if_index})
3761 def sw_interface_bond_dump(
3766 return self.api(self.papi.sw_interface_bond_dump,
3769 def create_vhost_user_if(
3775 disable_indirect_desc,
3776 custom_dev_instance,
3781 :param is_server: is server
3782 :param sock_filename: socket name
3783 :param renumber: renumber
3784 :param disable_mrg_rxbuf: disable mergable rx buffers
3785 :param disable_indirect_desc: disable indirect descriptors
3786 :param custom_dev_instance: custom dev instance
3787 :param use_custom_mac: use custom mac
3788 :param mac_address: mac address
3789 :param tag: tag (default '')
3792 self.papi.create_vhost_user_if,
3793 {'is_server': is_server,
3794 'sock_filename': sock_filename,
3795 'renumber': renumber,
3796 'disable_mrg_rxbuf': disable_mrg_rxbuf,
3797 'disable_indirect_desc': disable_indirect_desc,
3798 'custom_dev_instance': custom_dev_instance,
3799 'use_custom_mac': use_custom_mac,
3800 'mac_address': mac_address,
3804 def delete_vhost_user_if(
3808 :param sw_if_index: interface the operation is applied to
3810 return self.api(self.papi.delete_vhost_user_if,
3811 {'sw_if_index': sw_if_index, })
3813 def sw_interface_vhost_user_dump(
3818 return self.api(self.papi.sw_interface_vhost_user_dump,
3821 def abf_policy_add_del(self, is_add, policy):
3823 self.papi.abf_policy_add_del,
3827 def abf_itf_attach_add_del(self, is_add, attach):
3829 self.papi.abf_itf_attach_add_del,
3833 def abf_policy_dump(self):
3835 self.papi.abf_policy_dump, {})
3837 def abf_itf_attach_dump(self):
3839 self.papi.abf_itf_attach_dump, {})
3841 def pipe_create(self, is_specified, user_instance):
3842 return self.api(self.papi.pipe_create,
3843 {'is_specified': is_specified,
3844 'user_instance': user_instance})
3846 def pipe_delete(self, parent_sw_if_index):
3847 return self.api(self.papi.pipe_delete,
3848 {'parent_sw_if_index': parent_sw_if_index})
3850 def pipe_dump(self):
3851 return self.api(self.papi.pipe_dump, {})
3865 return self.api(self.papi.memif_create,
3868 'rx_queues': rx_queues,
3869 'tx_queues': tx_queues,
3871 'socket_id': socket_id,
3873 'ring_size': ring_size,
3874 'buffer_size': buffer_size,
3875 'hw_addr': hw_addr})
3877 def memif_delete(self, sw_if_index):
3878 return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index})
3880 def memif_dump(self):
3881 return self.api(self.papi.memif_dump, {})
3883 def memif_socket_filename_add_del(
3884 self, is_add, socket_id, socket_filename):
3886 self.papi.memif_socket_filename_add_del,
3888 'socket_id': socket_id,
3889 'socket_filename': socket_filename})
3891 def memif_socket_filename_dump(self):
3892 return self.api(self.papi.memif_socket_filename_dump, {})
3894 def svs_table_add_del(self, af, table_id, is_add=1):
3895 return self.api(self.papi.svs_table_add_del,
3897 'table_id': table_id,
3902 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
3903 return self.api(self.papi.svs_route_add_del,
3905 'table_id': table_id,
3906 'source_table_id': src_table_id,
3911 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
3912 return self.api(self.papi.svs_enable_disable,
3915 'table_id': table_id,
3916 'sw_if_index': sw_if_index,
3917 'is_enable': is_enable,
3921 return self.api(self.papi.svs_dump, {})