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):
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, read_timeout=5)
89 self._events = deque()
94 def expect_negative_api_retval(self):
95 """ Expect API failure """
96 self._expect_stack.append(self._expect_api_retval)
97 self._expect_api_retval = self._negative
100 def expect_zero_api_retval(self):
101 """ Expect API success """
102 self._expect_stack.append(self._expect_api_retval)
103 self._expect_api_retval = self._zero
106 def __exit__(self, exc_type, exc_value, traceback):
107 self._expect_api_retval = self._expect_stack.pop()
109 def register_hook(self, hook):
110 """Replace hook registration with new hook
117 def collect_events(self):
118 """ Collect all events from the internal queue and clear the queue. """
120 self._events = deque()
123 def wait_for_event(self, timeout, name=None):
124 """ Wait for and return next event. """
126 self.test_class.logger.debug("Expecting event '%s' within %ss",
129 self.test_class.logger.debug("Expecting event within %ss",
132 self.test_class.logger.debug("Not waiting, event already queued")
133 limit = time.time() + timeout
134 while time.time() < limit:
136 e = self._events.popleft()
137 if name and type(e).__name__ != name:
139 "Unexpected event received: %s, expected: %s" %
140 (type(e).__name__, name))
141 self.test_class.logger.debug("Returning event %s:%s" %
144 time.sleep(0) # yield
145 raise Exception("Event did not occur within timeout")
147 def __call__(self, name, event):
148 """ Enqueue event in the internal event queue. """
149 # FIXME use the name instead of relying on type(e).__name__ ?
150 # FIXME #2 if this throws, it is eaten silently, Ole?
151 self.test_class.logger.debug("New event: %s: %s" % (name, event))
152 self._events.append(event)
155 """Connect the API to VPP"""
156 self.vpp.connect(self.name, self.shm_prefix)
157 self.papi = self.vpp.api
158 self.vpp.register_event_callback(self)
160 def disconnect(self):
161 """Disconnect the API from VPP"""
162 self.vpp.disconnect()
164 def api(self, api_fn, api_args, expected_retval=0):
165 """ Call API function and check it's return value.
166 Call the appropriate hooks before and after the API call
168 :param api_fn: API function to call
169 :param api_args: tuple of API function arguments
170 :param expected_retval: Expected return value (Default value = 0)
171 :returns: reply from the API
174 self.hook.before_api(api_fn.__name__, api_args)
175 reply = api_fn(**api_args)
176 if self._expect_api_retval == self._negative:
177 if hasattr(reply, 'retval') and reply.retval >= 0:
178 msg = "API call passed unexpectedly: expected negative "\
179 "return value instead of %d in %s" % \
180 (reply.retval, repr(reply))
181 self.test_class.logger.info(msg)
182 raise UnexpectedApiReturnValueError(msg)
183 elif self._expect_api_retval == self._zero:
184 if hasattr(reply, 'retval') and reply.retval != expected_retval:
185 msg = "API call failed, expected %d return value instead "\
186 "of %d in %s" % (expected_retval, reply.retval,
188 self.test_class.logger.info(msg)
189 raise UnexpectedApiReturnValueError(msg)
191 raise Exception("Internal error, unexpected value for "
192 "self._expect_api_retval %s" %
193 self._expect_api_retval)
194 self.hook.after_api(api_fn.__name__, api_args)
198 """ Execute a CLI, calling the before/after hooks appropriately.
200 :param cli: CLI to execute
204 self.hook.before_cli(cli)
206 r = self.papi.cli_inband(length=len(cli), cmd=cli)
207 self.hook.after_cli(cli)
208 if hasattr(r, 'reply'):
209 return r.reply.decode().rstrip('\x00')
211 def ppcli(self, cli):
212 """ Helper method to print CLI command in case of info logging level.
214 :param cli: CLI to execute
217 return cli + "\n" + str(self.cli(cli))
219 def _convert_mac(self, mac):
220 return mac.replace(':', '').decode('hex')
222 def show_version(self):
224 return self.api(self.papi.show_version, {})
226 def pg_create_interface(self, pg_index):
232 return self.api(self.papi.pg_create_interface,
233 {"interface_id": pg_index})
235 def sw_interface_dump(self, filter=None):
238 :param filter: (Default value = None)
241 if filter is not None:
242 args = {"name_filter_valid": 1, "name_filter": filter}
245 return self.api(self.papi.sw_interface_dump, args)
247 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
248 """ Set the IPvX Table-id for the Interface
255 return self.api(self.papi.sw_interface_set_table,
256 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
259 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
260 is_ipv6=0, is_add=1, del_all=0):
263 :param addr: param is_ipv6: (Default value = 0)
266 :param is_ipv6: (Default value = 0)
267 :param is_add: (Default value = 1)
268 :param del_all: (Default value = 0)
271 return self.api(self.papi.sw_interface_add_del_address,
272 {'sw_if_index': sw_if_index,
276 'address_length': addr_len,
279 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
281 """ Set the Interface to be unnumbered
283 :param is_add: (Default value = 1)
284 :param sw_if_index - interface That will be unnumbered
285 :param ip_sw_if_index - interface with an IP addres
288 return self.api(self.papi.sw_interface_set_unnumbered,
289 {'sw_if_index': ip_sw_if_index,
290 'unnumbered_sw_if_index': sw_if_index,
293 def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
294 return self.api(self.papi.ip_unnumbered_dump,
295 {'sw_if_index': sw_if_index})
297 def sw_interface_enable_disable_mpls(self, sw_if_index,
300 Enable/Disable MPLS on the interface
302 :param is_enable: (Default value = 1)
305 return self.api(self.papi.sw_interface_set_mpls_enable,
306 {'sw_if_index': sw_if_index,
307 'enable': is_enable})
309 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
310 return self.api(self.papi.sw_interface_ip6nd_ra_config,
311 {'sw_if_index': sw_if_index,
312 'suppress': suppress})
314 def set_ip_flow_hash(self,
323 return self.api(self.papi.set_ip_flow_hash,
333 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
334 return self.api(self.papi.ip6nd_proxy_add_del,
336 'sw_if_index': sw_if_index,
339 def ip6_sw_interface_ra_config(self, sw_if_index,
343 return self.api(self.papi.sw_interface_ip6nd_ra_config,
344 {'sw_if_index': sw_if_index,
346 'suppress': suppress,
347 'send_unicast': send_unicast})
349 def ip6_sw_interface_ra_prefix(self,
359 val_lifetime=0xffffffff,
360 pref_lifetime=0xffffffff):
361 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
362 {'sw_if_index': sw_if_index,
364 'address_length': address_length,
365 'use_default': use_default,
366 'no_advertise': no_advertise,
367 'off_link': off_link,
368 'no_autoconfig': no_autoconfig,
369 'no_onlink': no_onlink,
371 'val_lifetime': val_lifetime,
372 'pref_lifetime': pref_lifetime})
374 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
376 Enable/Disable An interface for IPv6
378 return self.api(self.papi.sw_interface_ip6_enable_disable,
379 {'sw_if_index': sw_if_index,
382 def vxlan_add_del_tunnel(
386 mcast_sw_if_index=0xFFFFFFFF,
390 decap_next_index=0xFFFFFFFF,
392 instance=0xFFFFFFFF):
397 :param is_add: (Default value = 1)
398 :param is_ipv6: (Default value = 0)
399 :param encap_vrf_id: (Default value = 0)
400 :param decap_next_index: (Default value = 0xFFFFFFFF)
401 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
402 :param vni: (Default value = 0)
403 :param instance: (Default value = 0xFFFFFFFF)
406 return self.api(self.papi.vxlan_add_del_tunnel,
409 'src_address': src_addr,
410 'dst_address': dst_addr,
411 'mcast_sw_if_index': mcast_sw_if_index,
412 'encap_vrf_id': encap_vrf_id,
413 'decap_next_index': decap_next_index,
415 'instance': instance})
417 def geneve_add_del_tunnel(
421 mcast_sw_if_index=0xFFFFFFFF,
425 decap_next_index=0xFFFFFFFF,
431 :param is_add: (Default value = 1)
432 :param is_ipv6: (Default value = 0)
433 :param encap_vrf_id: (Default value = 0)
434 :param decap_next_index: (Default value = 0xFFFFFFFF)
435 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
436 :param vni: (Default value = 0)
439 return self.api(self.papi.geneve_add_del_tunnel,
442 'local_address': local_addr,
443 'remote_address': remote_addr,
444 'mcast_sw_if_index': mcast_sw_if_index,
445 'encap_vrf_id': encap_vrf_id,
446 'decap_next_index': decap_next_index,
449 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
450 learn=1, arp_term=0, is_add=1):
451 """Create/delete bridge domain.
453 :param int bd_id: Bridge domain index.
454 :param int flood: Enable/disable bcast/mcast flooding in the BD.
456 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
458 :param int forward: Enable/disable forwarding on all interfaces in
459 the BD. (Default value = 1)
460 :param int learn: Enable/disable learning on all interfaces in the BD.
462 :param int arp_term: Enable/disable arp termination in the BD.
464 :param int is_add: Add or delete flag. (Default value = 1)
466 return self.api(self.papi.bridge_domain_add_del,
469 'uu_flood': uu_flood,
472 'arp_term': arp_term,
475 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
476 return self.api(self.papi.bd_ip_mac_add_del,
483 def want_ip4_arp_events(self, enable_disable=1, address=0):
484 return self.api(self.papi.want_ip4_arp_events,
485 {'enable_disable': enable_disable,
487 'pid': os.getpid(), })
489 def want_ip6_nd_events(self, enable_disable=1, address=0):
490 return self.api(self.papi.want_ip6_nd_events,
491 {'enable_disable': enable_disable,
493 'pid': os.getpid(), })
495 def want_ip6_ra_events(self, enable_disable=1):
496 return self.api(self.papi.want_ip6_ra_events,
497 {'enable_disable': enable_disable,
498 'pid': os.getpid(), })
500 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
502 return self.api(self.papi.ip6nd_send_router_solicitation,
507 'sw_if_index': sw_if_index})
509 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
510 install_default_routes):
511 return self.api(self.papi.ip6_nd_address_autoconfig,
512 {'sw_if_index': sw_if_index,
514 'install_default_routes': install_default_routes})
516 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
517 max_macs_in_event=0, learn_limit=0):
518 return self.api(self.papi.want_l2_macs_events,
519 {'enable_disable': enable_disable,
520 'scan_delay': scan_delay,
521 'max_macs_in_event': max_macs_in_event,
522 'learn_limit': learn_limit,
523 'pid': os.getpid(), })
525 def want_dhcp6_reply_events(self, enable_disable=1):
526 return self.api(self.papi.want_dhcp6_reply_events,
527 {'enable_disable': enable_disable,
530 def want_dhcp6_pd_reply_events(self, enable_disable=1):
531 return self.api(self.papi.want_dhcp6_pd_reply_events,
532 {'enable_disable': enable_disable,
535 def dhcp6_clients_enable_disable(self, enable=1):
536 return self.api(self.papi.dhcp6_clients_enable_disable,
539 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
540 addresses, server_index=0xFFFFFFFF,
541 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
543 return self.api(self.papi.dhcp6_send_client_message,
544 {'sw_if_index': sw_if_index,
545 'server_index': server_index,
551 'msg_type': msg_type,
554 'n_addresses': len(addresses),
555 'addresses': addresses})
557 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
558 prefixes, server_index=0xFFFFFFFF,
559 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
561 return self.api(self.papi.dhcp6_pd_send_client_message,
562 {'sw_if_index': sw_if_index,
563 'server_index': server_index,
569 'msg_type': msg_type,
572 'n_prefixes': len(prefixes),
573 'prefixes': prefixes})
575 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
577 return self.api(self.papi.dhcp6_client_enable_disable,
578 {'sw_if_index': sw_if_index,
581 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
583 return self.api(self.papi.dhcp6_pd_client_enable_disable,
584 {'sw_if_index': sw_if_index,
585 'prefix_group': prefix_group,
588 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
589 prefix_length, prefix_group,
591 return self.api(self.papi.ip6_add_del_address_using_prefix,
592 {'sw_if_index': sw_if_index,
593 'prefix_group': prefix_group,
595 'prefix_length': prefix_length,
598 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
599 filter_mac=0, bvi_mac=0):
600 """Create/delete L2 FIB entry.
602 :param str mac: MAC address to create FIB entry for.
603 :param int bd_id: Bridge domain index.
604 :param int sw_if_index: Software interface index of the interface.
605 :param int is_add: Add or delete flag. (Default value = 1)
606 :param int static_mac: Set to 1 to create static MAC entry.
608 :param int filter_mac: Set to 1 to drop packet that's source or
609 destination MAC address contains defined MAC address.
611 :param int bvi_mac: Set to 1 to create entry that points to BVI
612 interface. (Default value = 0)
614 return self.api(self.papi.l2fib_add_del,
615 {'mac': self._convert_mac(mac),
617 'sw_if_index': sw_if_index,
619 'static_mac': static_mac,
620 'filter_mac': filter_mac,
623 def l2fib_flush_int(self, sw_if_index):
624 """Flush L2 FIB entries for sw_if_index.
626 :param int sw_if_index: Software interface index of the interface.
628 return self.api(self.papi.l2fib_flush_int,
629 {'sw_if_index': sw_if_index})
631 def l2fib_flush_bd(self, bd_id):
632 """Flush L2 FIB entries for bd_id.
634 :param int sw_if_index: Bridge Domain id.
636 return self.api(self.papi.l2fib_flush_bd,
639 def l2fib_flush_all(self):
642 return self.api(self.papi.l2fib_flush_all, {})
644 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
645 shg=0, port_type=L2_PORT_TYPE.NORMAL,
647 """Add/remove interface to/from bridge domain.
649 :param int sw_if_index: Software interface index of the interface.
650 :param int bd_id: Bridge domain index.
651 :param int shg: Split-horizon group index. (Default value = 0)
652 :param int bvi: Set interface as a bridge group virtual interface.
654 :param int enable: Add or remove interface. (Default value = 1)
656 return self.api(self.papi.sw_interface_set_l2_bridge,
657 {'rx_sw_if_index': sw_if_index,
660 'port_type': port_type,
663 def bridge_flags(self, bd_id, is_set, feature_bitmap):
664 """Enable/disable required feature of the bridge domain with defined
667 :param int bd_id: Bridge domain ID.
668 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
669 :param int flags: Bitmap value of the feature to be set:
673 - uu-flood (1 << 3) or
676 return self.api(self.papi.bridge_flags,
679 'flags': feature_bitmap})
681 def bridge_domain_dump(self, bd_id=0):
684 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
685 existing bridge domains returned)
686 :return: Dictionary of bridge domain(s) data.
688 return self.api(self.papi.bridge_domain_dump,
691 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
693 """Create or delete unidirectional cross-connect from Tx interface to
696 :param int rx_sw_if_index: Software interface index of Rx interface.
697 :param int tx_sw_if_index: Software interface index of Tx interface.
698 :param int enable: Create cross-connect if equal to 1, delete
699 cross-connect if equal to 0.
702 return self.api(self.papi.sw_interface_set_l2_xconnect,
703 {'rx_sw_if_index': rx_sw_if_index,
704 'tx_sw_if_index': tx_sw_if_index,
707 def sw_interface_set_l2_tag_rewrite(
714 """L2 interface vlan tag rewrite configure request
715 :param client_index - opaque cookie to identify the sender
716 :param context - sender context, to match reply w/ request
717 :param sw_if_index - interface the operation is applied to
718 :param vtr_op - Choose from l2_vtr_op_t enum values
719 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
720 :param tag1 - Needed for any push or translate vtr op
721 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
724 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
725 {'sw_if_index': sw_if_index,
731 def sw_interface_set_l2_emulation(
736 :param sw_if_index - interface the operation is applied to
739 return self.api(self.papi.l2_emulation,
740 {'sw_if_index': sw_if_index,
743 def sw_interface_set_ip_directed_broadcast(
747 """IP Directed broadcast
748 :param sw_if_index - interface the operation is applied to
751 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
752 {'sw_if_index': sw_if_index,
755 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
758 :param admin_up_down:
762 return self.api(self.papi.sw_interface_set_flags,
763 {'sw_if_index': sw_if_index,
764 'admin_up_down': admin_up_down})
766 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
772 return self.api(self.papi.sw_interface_set_mtu,
773 {'sw_if_index': sw_if_index,
776 def sw_interface_set_promiscuous(self, sw_if_index, enable):
782 return self.api(self.papi.sw_interface_set_promiscuous,
783 {'sw_if_index': sw_if_index,
786 def sw_interface_set_mac_address(self, sw_if_index, mac):
787 return self.api(self.papi.sw_interface_set_mac_address,
788 {'sw_if_index': sw_if_index,
791 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
792 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
793 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
794 """Create subinterface
795 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
797 :param sub_id: param inner_vlan:
801 :param no_tags: (Default value = 0)
802 :param one_tag: (Default value = 0)
803 :param two_tags: (Default value = 0)
804 :param dot1ad: (Default value = 0)
805 :param exact_match: (Default value = 0)
806 :param default_sub: (Default value = 0)
807 :param outer_vlan_id_any: (Default value = 0)
808 :param inner_vlan_id_any: (Default value = 0)
812 self.papi.create_subif,
813 {'sw_if_index': sw_if_index,
817 'two_tags': two_tags,
819 'exact_match': exact_match,
820 'default_sub': default_sub,
821 'outer_vlan_id_any': outer_vlan_id_any,
822 'inner_vlan_id_any': inner_vlan_id_any,
823 'outer_vlan_id': outer_vlan,
824 'inner_vlan_id': inner_vlan})
826 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
827 """Create p2p ethernet subinterface
829 :param sw_if_index: main (parent) interface
830 :param remote_mac: client (remote) mac address
834 self.papi.p2p_ethernet_add,
835 {'parent_if_index': sw_if_index,
836 'remote_mac': remote_mac,
837 'subif_id': subif_id})
839 def delete_subif(self, sw_if_index):
840 """Delete subinterface
844 return self.api(self.papi.delete_subif,
845 {'sw_if_index': sw_if_index})
847 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
848 """Delete p2p ethernet subinterface
850 :param sw_if_index: main (parent) interface
851 :param remote_mac: client (remote) mac address
855 self.papi.p2p_ethernet_del,
856 {'parent_if_index': sw_if_index,
857 'remote_mac': remote_mac})
859 def create_vlan_subif(self, sw_if_index, vlan):
866 return self.api(self.papi.create_vlan_subif,
867 {'sw_if_index': sw_if_index,
870 def create_loopback(self, mac=''):
873 :param mac: (Optional)
875 return self.api(self.papi.create_loopback,
876 {'mac_address': mac})
878 def delete_loopback(self, sw_if_index):
879 return self.api(self.papi.delete_loopback,
880 {'sw_if_index': sw_if_index, })
882 def ip_table_add_del(self,
889 :param is_add: (Default value = 1)
890 :param is_ipv6: (Default value = 0)
895 self.papi.ip_table_add_del,
896 {'table_id': table_id,
900 def ip_add_del_route(
905 next_hop_sw_if_index=0xFFFFFFFF,
909 next_hop_n_out_labels=0,
910 next_hop_out_label_stack=[],
911 next_hop_via_label=MPLS_LABEL_INVALID,
912 next_hop_id=0xFFFFFFFF,
914 is_resolve_attached=0,
915 classify_table_index=0xFFFFFFFF,
929 :param dst_address_length:
930 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
932 :param next_hop_address:
933 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
934 :param vrf_id: (Default value = 0)
935 :param lookup_in_vrf: (Default value = 0)
936 :param classify_table_index: (Default value = 0xFFFFFFFF)
937 :param is_add: (Default value = 1)
938 :param is_drop: (Default value = 0)
939 :param is_ipv6: (Default value = 0)
940 :param is_local: (Default value = 0)
941 :param is_classify: (Default value = 0)
942 :param is_multipath: (Default value = 0)
943 :param is_resolve_host: (Default value = 0)
944 :param is_resolve_attached: (Default value = 0)
945 :param is_dvr: (Default value = 0)
946 :param is_source_lookup: (Default value = 0)
947 :param next_hop_weight: (Default value = 1)
952 self.papi.ip_add_del_route,
953 {'next_hop_sw_if_index': next_hop_sw_if_index,
954 'table_id': table_id,
955 'classify_table_index': classify_table_index,
956 'next_hop_table_id': next_hop_table_id,
959 'is_unreach': is_unreach,
960 'is_prohibit': is_prohibit,
962 'is_local': is_local,
963 'is_classify': is_classify,
964 'is_multipath': is_multipath,
965 'is_resolve_host': is_resolve_host,
966 'is_resolve_attached': is_resolve_attached,
968 'is_source_lookup': is_source_lookup,
969 'is_udp_encap': is_udp_encap,
970 'next_hop_weight': next_hop_weight,
971 'dst_address_length': dst_address_length,
972 'dst_address': dst_address,
973 'next_hop_id': next_hop_id,
974 'next_hop_address': next_hop_address,
975 'next_hop_n_out_labels': next_hop_n_out_labels,
976 'next_hop_via_label': next_hop_via_label,
977 'next_hop_out_label_stack': next_hop_out_label_stack})
979 def ip_fib_dump(self):
980 return self.api(self.papi.ip_fib_dump, {})
982 def ip6_fib_dump(self):
983 return self.api(self.papi.ip6_fib_dump, {})
985 def ip_neighbor_add_del(self,
994 """ Add neighbor MAC to IPv4 or IPv6 address.
999 :param is_add: (Default value = 1)
1000 :param is_ipv6: (Default value = 0)
1001 :param is_static: (Default value = 0)
1002 :param is_no_adj_fib: (Default value = 0)
1006 self.papi.ip_neighbor_add_del,
1007 {'sw_if_index': sw_if_index,
1010 'is_static': is_static,
1011 'is_no_adj_fib': is_no_adj_fib,
1012 'mac_address': mac_address,
1013 'dst_address': dst_address
1017 def ip_neighbor_dump(self,
1020 """ Return IP neighbor dump.
1023 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1027 self.papi.ip_neighbor_dump,
1028 {'is_ipv6': is_ipv6,
1029 'sw_if_index': sw_if_index
1033 def proxy_arp_add_del(self,
1038 """ Config Proxy Arp Range.
1040 :param low_address: Start address in the rnage to Proxy for
1041 :param hi_address: End address in the rnage to Proxy for
1042 :param vrf_id: The VRF/table in which to proxy
1046 self.papi.proxy_arp_add_del,
1050 'low_address': low_address,
1051 'hi_address': hi_address,
1055 def proxy_arp_intfc_enable_disable(self,
1058 """ Enable/Disable an interface for proxy ARP requests
1060 :param sw_if_index: Interface
1061 :param enable_disable: Enable/Disable
1065 self.papi.proxy_arp_intfc_enable_disable,
1066 {'sw_if_index': sw_if_index,
1067 'enable_disable': is_enable
1075 """ Reset VRF (remove all routes etc.) request.
1077 :param int vrf_id: ID of the FIB table / VRF to reset.
1078 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1082 self.papi.reset_vrf,
1092 """ Reset VRF (remove all routes etc.) request.
1094 :param int vrf_id: ID of the FIB table / VRF to reset.
1095 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1099 self.papi.reset_fib,
1110 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1115 {'is_ipv6': is_ipv6,
1119 def sw_interface_span_enable_disable(
1120 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1123 :param sw_if_index_from:
1124 :param sw_if_index_to:
1128 return self.api(self.papi.sw_interface_span_enable_disable,
1129 {'sw_if_index_from': sw_if_index_from,
1130 'sw_if_index_to': sw_if_index_to,
1135 def gre_tunnel_add_del(self,
1140 instance=0xFFFFFFFF,
1144 """ Add a GRE tunnel
1148 :param outer_fib_id: (Default value = 0)
1149 :param tunnel_type: (Default value = 0)
1150 :param instance: (Default value = 0xFFFFFFFF)
1151 :param session_id: (Defalt value = 0)
1152 :param is_add: (Default value = 1)
1153 :param is_ipv6: (Default value = 0)
1157 self.papi.gre_add_del_tunnel,
1160 'tunnel_type': tunnel_type,
1161 'instance': instance,
1162 'src_address': src_address,
1163 'dst_address': dst_address,
1164 'outer_fib_id': outer_fib_id,
1165 'session_id': session_id}
1168 def udp_encap_add(self,
1174 """ Add a GRE tunnel
1179 :param outer_fib_id: (Default value = 0)
1183 self.papi.udp_encap_add,
1188 'src_port': src_port,
1189 'dst_port': dst_port,
1190 'table_id': table_id
1194 def udp_encap_del(self, id):
1195 return self.api(self.papi.udp_encap_del, {'id': id})
1197 def udp_encap_dump(self):
1198 return self.api(self.papi.udp_encap_dump, {})
1200 def want_udp_encap_stats(self, enable=1):
1201 return self.api(self.papi.want_udp_encap_stats,
1203 'pid': os.getpid()})
1205 def mpls_fib_dump(self):
1206 return self.api(self.papi.mpls_fib_dump, {})
1208 def mpls_table_add_del(
1215 :param is_add: (Default value = 1)
1220 self.papi.mpls_table_add_del,
1221 {'mt_table_id': table_id,
1222 'mt_is_add': is_add})
1224 def mpls_route_add_del(
1230 next_hop_sw_if_index=0xFFFFFFFF,
1232 next_hop_table_id=0,
1234 next_hop_n_out_labels=0,
1235 next_hop_out_label_stack=[],
1236 next_hop_via_label=MPLS_LABEL_INVALID,
1238 is_resolve_attached=0,
1245 classify_table_index=0xFFFFFFFF,
1249 :param dst_address_length:
1250 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1252 :param next_hop_address:
1253 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1254 :param vrf_id: (Default value = 0)
1255 :param lookup_in_vrf: (Default value = 0)
1256 :param classify_table_index: (Default value = 0xFFFFFFFF)
1257 :param is_add: (Default value = 1)
1258 :param is_drop: (Default value = 0)
1259 :param is_ipv6: (Default value = 0)
1260 :param is_local: (Default value = 0)
1261 :param is_classify: (Default value = 0)
1262 :param is_multipath: (Default value = 0)
1263 :param is_multicast: (Default value = 0)
1264 :param is_resolve_host: (Default value = 0)
1265 :param is_resolve_attached: (Default value = 0)
1266 :param next_hop_weight: (Default value = 1)
1270 self.papi.mpls_route_add_del,
1273 'mr_table_id': table_id,
1274 'mr_classify_table_index': classify_table_index,
1275 'mr_is_add': is_add,
1276 'mr_is_classify': is_classify,
1277 'mr_is_multipath': is_multipath,
1278 'mr_is_multicast': is_multicast,
1279 'mr_is_resolve_host': is_resolve_host,
1280 'mr_is_resolve_attached': is_resolve_attached,
1281 'mr_is_interface_rx': is_interface_rx,
1282 'mr_is_rpf_id': is_rpf_id,
1283 'mr_next_hop_proto': next_hop_proto,
1284 'mr_next_hop_weight': next_hop_weight,
1285 'mr_next_hop': next_hop_address,
1286 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1287 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1288 'mr_next_hop_table_id': next_hop_table_id,
1289 'mr_next_hop_via_label': next_hop_via_label,
1290 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1292 def mpls_ip_bind_unbind(
1304 self.papi.mpls_ip_bind_unbind,
1305 {'mb_mpls_table_id': table_id,
1307 'mb_ip_table_id': ip_table_id,
1308 'mb_is_bind': is_bind,
1309 'mb_is_ip4': is_ip4,
1310 'mb_address_length': dst_address_length,
1311 'mb_address': dst_address})
1313 def mpls_tunnel_add_del(
1316 next_hop_proto_is_ip4,
1318 next_hop_sw_if_index=0xFFFFFFFF,
1319 next_hop_table_id=0,
1321 next_hop_n_out_labels=0,
1322 next_hop_out_label_stack=[],
1323 next_hop_via_label=MPLS_LABEL_INVALID,
1329 :param dst_address_length:
1330 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1332 :param next_hop_address:
1333 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1334 :param vrf_id: (Default value = 0)
1335 :param lookup_in_vrf: (Default value = 0)
1336 :param classify_table_index: (Default value = 0xFFFFFFFF)
1337 :param is_add: (Default value = 1)
1338 :param is_drop: (Default value = 0)
1339 :param is_ipv6: (Default value = 0)
1340 :param is_local: (Default value = 0)
1341 :param is_classify: (Default value = 0)
1342 :param is_multipath: (Default value = 0)
1343 :param is_resolve_host: (Default value = 0)
1344 :param is_resolve_attached: (Default value = 0)
1345 :param next_hop_weight: (Default value = 1)
1346 :param is_multicast: (Default value = 0)
1350 self.papi.mpls_tunnel_add_del,
1351 {'mt_sw_if_index': tun_sw_if_index,
1352 'mt_is_add': is_add,
1353 'mt_l2_only': l2_only,
1354 'mt_is_multicast': is_multicast,
1355 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1356 'mt_next_hop_weight': next_hop_weight,
1357 'mt_next_hop': next_hop_address,
1358 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1359 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1360 'mt_next_hop_table_id': next_hop_table_id,
1361 'mt_next_hop_via_label': next_hop_via_label,
1362 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1364 def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
1365 return self.api(self.papi.mpls_tunnel_dump,
1366 {'sw_if_index': sw_if_index})
1368 def nat44_interface_add_del_feature(
1373 """Enable/disable NAT44 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_feature,
1382 'is_inside': is_inside,
1383 'sw_if_index': sw_if_index})
1385 def nat44_interface_add_del_output_feature(
1390 """Enable/disable NAT44 output feature on the interface
1392 :param sw_if_index: Software index of the interface
1393 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1394 :param is_add: 1 if add, 0 if delete (Default value = 1)
1397 self.papi.nat44_interface_add_del_output_feature,
1399 'is_inside': is_inside,
1400 'sw_if_index': sw_if_index})
1402 def nat44_add_del_static_mapping(
1406 external_sw_if_index=0xFFFFFFFF,
1417 """Add/delete NAT44 static mapping
1419 :param local_ip: Local IP address
1420 :param external_ip: External IP address
1421 :param external_sw_if_index: External interface instead of IP address
1422 :param local_port: Local port number (Default value = 0)
1423 :param external_port: External port number (Default value = 0)
1424 :param addr_only: 1 if address only mapping, 0 if address and port
1425 :param vrf_id: VRF ID
1426 :param protocol: IP protocol (Default value = 0)
1427 :param twice_nat: 1 if translate external host address and port
1428 :param self_twice_nat: 1 if translate external host address and port
1429 whenever external host address equals
1430 local address of internal host
1431 :param out2in_only: if 1 rule is matching only out2in direction
1432 :param tag: Opaque string tag
1433 :param is_add: 1 if add, 0 if delete (Default value = 1)
1436 self.papi.nat44_add_del_static_mapping,
1438 'addr_only': addr_only,
1439 'local_ip_address': local_ip,
1440 'external_ip_address': external_ip,
1441 'local_port': local_port,
1442 'external_port': external_port,
1443 'external_sw_if_index': external_sw_if_index,
1445 'protocol': protocol,
1446 'twice_nat': twice_nat,
1447 'self_twice_nat': self_twice_nat,
1448 'out2in_only': out2in_only,
1451 def nat44_add_del_identity_mapping(
1454 sw_if_index=0xFFFFFFFF,
1461 """Add/delete NAT44 identity mapping
1463 :param ip: IP address (Default value = 0)
1464 :param sw_if_index: Interface instead of IP address
1465 :param port: Port number (Default value = 0)
1466 :param addr_only: 1 if address only mapping, 0 if address and port
1467 :param vrf_id: VRF ID
1468 :param protocol: IP protocol (Default value = 0)
1469 :param tag: Opaque string tag
1470 :param is_add: 1 if add, 0 if delete (Default value = 1)
1473 self.papi.nat44_add_del_identity_mapping,
1475 'addr_only': addr_only,
1478 'sw_if_index': sw_if_index,
1481 'protocol': protocol})
1483 def nat44_add_del_address_range(
1490 """Add/del NAT44 address range
1492 :param first_ip_address: First IP address
1493 :param last_ip_address: Last IP address
1494 :param vrf_id: VRF id for the address range
1495 :param twice_nat: twice NAT address for extenal hosts
1496 :param is_add: 1 if add, 0 if delete (Default value = 1)
1499 self.papi.nat44_add_del_address_range,
1500 {'first_ip_address': first_ip_address,
1501 'last_ip_address': last_ip_address,
1503 'twice_nat': twice_nat,
1506 def nat44_address_dump(self):
1507 """Dump NAT44 addresses
1508 :return: Dictionary of NAT44 addresses
1510 return self.api(self.papi.nat44_address_dump, {})
1512 def nat44_interface_dump(self):
1513 """Dump interfaces with NAT44 feature
1514 :return: Dictionary of interfaces with NAT44 feature
1516 return self.api(self.papi.nat44_interface_dump, {})
1518 def nat44_interface_output_feature_dump(self):
1519 """Dump interfaces with NAT44 output feature
1520 :return: Dictionary of interfaces with NAT44 output feature
1522 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1524 def nat44_static_mapping_dump(self):
1525 """Dump NAT44 static mappings
1526 :return: Dictionary of NAT44 static mappings
1528 return self.api(self.papi.nat44_static_mapping_dump, {})
1530 def nat44_identity_mapping_dump(self):
1531 """Dump NAT44 identity mappings
1532 :return: Dictionary of NAT44 identity mappings
1534 return self.api(self.papi.nat44_identity_mapping_dump, {})
1536 def nat_show_config(self):
1537 """Show NAT plugin config
1538 :return: NAT plugin config parameters
1540 return self.api(self.papi.nat_show_config, {})
1542 def nat44_add_interface_addr(
1547 """Add/del NAT44 address from interface
1549 :param sw_if_index: Software index of the interface
1550 :param twice_nat: twice NAT address for extenal hosts
1551 :param is_add: 1 if add, 0 if delete (Default value = 1)
1554 self.papi.nat44_add_del_interface_addr,
1556 'sw_if_index': sw_if_index,
1557 'twice_nat': twice_nat})
1559 def nat44_interface_addr_dump(self):
1560 """Dump NAT44 addresses interfaces
1561 :return: Dictionary of NAT44 addresses interfaces
1563 return self.api(self.papi.nat44_interface_addr_dump, {})
1570 """Enable/disable NAT IPFIX logging
1572 :param domain_id: Observation domain ID (Default value = 1)
1573 :param src_port: Source port number (Default value = 4739)
1574 :param enable: 1 if enable, 0 if disable (Default value = 1)
1577 self.papi.nat_ipfix_enable_disable,
1578 {'domain_id': domain_id,
1579 'src_port': src_port,
1582 def nat44_user_session_dump(
1586 """Dump NAT44 user's sessions
1588 :param ip_address: ip adress of the user to be dumped
1589 :param cpu_index: cpu_index on which the user is
1590 :param vrf_id: VRF ID
1591 :return: Dictionary of S-NAT sessions
1594 self.papi.nat44_user_session_dump,
1595 {'ip_address': ip_address,
1598 def nat44_user_dump(self):
1601 :return: Dictionary of NAT44 users
1603 return self.api(self.papi.nat44_user_dump, {})
1605 def nat44_add_del_lb_static_mapping(
1618 """Add/delete NAT44 load balancing static mapping
1620 :param twice_nat: 1 if translate external host address and port
1621 :param tag: Opaque string tag
1622 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1623 :param is_add - 1 if add, 0 if delete
1626 self.papi.nat44_add_del_lb_static_mapping,
1628 'external_addr': external_addr,
1629 'external_port': external_port,
1630 'protocol': protocol,
1631 'twice_nat': twice_nat,
1632 'self_twice_nat': self_twice_nat,
1633 'out2in_only': out2in_only,
1635 'affinity': affinity,
1636 'local_num': local_num,
1639 def nat44_lb_static_mapping_dump(self):
1640 """Dump NAT44 load balancing static mappings
1642 :return: Dictionary of NAT44 load balancing static mapping
1644 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1646 def nat44_del_session(
1653 ext_host_address=None,
1655 """Delete NAT44 session
1657 :param addr: IPv4 address
1658 :param por: port number
1659 :param protocol: IP protocol number
1660 :param vrf_id: VRF ID
1661 :param is_in: 1 if inside network addres and port pari, 0 if outside
1662 :param ext_host_address: external host IPv4 address
1663 :param ext_host_port: external host port
1665 if ext_host_address is None:
1667 self.papi.nat44_del_session,
1670 'protocol': protocol,
1675 self.papi.nat44_del_session,
1678 'protocol': protocol,
1681 'ext_host_valid': 1,
1682 'ext_host_address': ext_host_address,
1683 'ext_host_port': ext_host_port})
1685 def nat44_forwarding_enable_disable(
1688 """Enable/disable forwarding for NAT44
1690 :param enable: 1 for enable, 0 for disable
1693 self.papi.nat44_forwarding_enable_disable,
1703 """Set NAT virtual fragmentation reassembly
1705 :param timeout: reassembly timeout (Default 2sec)
1706 :param max_reass: maximum concurrent reassemblies (Default 1024)
1707 :param max_frag: maximum fragmets per reassembly (Default 5)
1708 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1709 :param is_ip6: 1 if IPv6, 0 if IPv4
1712 self.papi.nat_set_reass,
1713 {'timeout': timeout,
1714 'max_reass': max_reass,
1715 'max_frag': max_frag,
1716 'drop_frag': drop_frag,
1719 def nat_get_reass(self):
1720 """Get NAT virtual fragmentation reassembly configuration
1722 :return: NAT virtual fragmentation reassembly configuration
1724 return self.api(self.papi.nat_get_reass, {})
1726 def nat_reass_dump(self):
1727 """Dump NAT virtual fragmentation reassemblies
1729 :return: Dictionary of NAT virtual fragmentation reassemblies
1731 return self.api(self.papi.nat_reass_dump, {})
1733 def nat_det_add_del_map(
1740 """Add/delete deterministic NAT mapping
1742 :param is_add - 1 if add, 0 if delete
1743 :param in_addr - inside IP address
1744 :param in_plen - inside IP address prefix length
1745 :param out_addr - outside IP address
1746 :param out_plen - outside IP address prefix length
1749 self.papi.nat_det_add_del_map,
1754 'out_addr': out_addr,
1755 'out_plen': out_plen})
1757 def nat_det_forward(
1760 """Get outside address and port range from inside address
1762 :param in_addr - inside IP address
1765 self.papi.nat_det_forward,
1766 {'in_addr': in_addr,
1769 def nat_det_reverse(
1773 """Get inside address from outside address and port
1775 :param out_addr - outside IP address
1776 :param out_port - outside port
1779 self.papi.nat_det_reverse,
1780 {'out_addr': out_addr,
1781 'out_port': out_port})
1783 def nat_det_map_dump(self):
1784 """Dump deterministic NAT mappings
1786 :return: Dictionary of deterministic NAT mappings
1788 return self.api(self.papi.nat_det_map_dump, {})
1790 def nat_set_timeouts(
1793 tcp_established=7440,
1796 """Set values of timeouts for NAT sessions (in seconds)
1798 :param udp - UDP timeout (Default value = 300)
1799 :param tcp_established - TCP established timeout (Default value = 7440)
1800 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1801 :param icmp - ICMP timeout (Default value = 60)
1804 self.papi.nat_set_timeouts,
1806 'tcp_established': tcp_established,
1807 'tcp_transitory': tcp_transitory,
1810 def nat_get_timeouts(self):
1811 """Get values of timeouts for NAT sessions
1813 :return: Timeouts for NAT sessions (in seconds)
1815 return self.api(self.papi.nat_get_timeouts, {})
1817 def nat_set_addr_and_port_alloc_alg(
1825 """Set address and port assignment algorithm
1827 :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1828 :param psid_offset: number of offset bits (valid only for MAP-E alg)
1829 :param psid_length: length of PSID (valid only for MAP-E alg)
1830 :param psid: Port Set Identifier value (valid only for MAP-E alg)
1831 :param start_port: beginning of the port range
1832 :param end_port: end of the port range
1835 self.papi.nat_set_addr_and_port_alloc_alg,
1837 'psid_offset': psid_offset,
1838 'psid_length': psid_length,
1840 'start_port': start_port,
1841 'end_port': end_port})
1843 def nat_get_addr_and_port_alloc_alg(self):
1844 """Get address and port assignment algorithm"""
1845 return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1847 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1848 """Set TCP MSS rewriting configuration
1850 :param enable: disable(0)/enable(1) MSS rewriting feature
1851 :param mss_value: MSS value to be used for MSS rewriting
1854 self.papi.nat_set_mss_clamping,
1855 {'enable': enable, 'mss_value': mss_value})
1857 def nat_get_mss_clamping(self):
1858 """Get TCP MSS rewriting configuration"""
1859 return self.api(self.papi.nat_get_mss_clamping, {})
1861 def nat_det_close_session_out(
1867 """Close deterministic NAT session using outside address and port
1869 :param out_addr - outside IP address
1870 :param out_port - outside port
1871 :param ext_addr - external host IP address
1872 :param ext_port - external host port
1875 self.papi.nat_det_close_session_out,
1876 {'out_addr': out_addr,
1877 'out_port': out_port,
1878 'ext_addr': ext_addr,
1879 'ext_port': ext_port})
1881 def nat_det_close_session_in(
1887 """Close deterministic NAT session using inside address and port
1889 :param in_addr - inside IP address
1890 :param in_port - inside port
1891 :param ext_addr - external host IP address
1892 :param ext_port - external host port
1895 self.papi.nat_det_close_session_in,
1896 {'in_addr': in_addr,
1898 'ext_addr': ext_addr,
1899 'ext_port': ext_port,
1902 def nat_det_session_dump(
1905 """Dump deterministic NAT sessions belonging to a user
1907 :param user_addr - inside IP address of the user
1908 :return: Dictionary of deterministic NAT sessions
1911 self.papi.nat_det_session_dump,
1913 'user_addr': user_addr})
1915 def nat64_add_del_pool_addr_range(
1921 """Add/del address range to NAT64 pool
1923 :param start_addr: First IP address
1924 :param end_addr: Last IP address
1925 :param vrf_id: VRF id for the address range
1926 :param is_add: 1 if add, 0 if delete (Default value = 1)
1929 self.papi.nat64_add_del_pool_addr_range,
1930 {'start_addr': start_addr,
1931 'end_addr': end_addr,
1935 def nat64_pool_addr_dump(self):
1936 """Dump NAT64 pool addresses
1937 :return: Dictionary of NAT64 pool addresses
1939 return self.api(self.papi.nat64_pool_addr_dump, {})
1941 def nat64_add_del_interface(
1946 """Enable/disable NAT64 feature on the interface
1947 :param sw_if_index: Index of the interface
1948 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1949 :param is_add: 1 if add, 0 if delete (Default value = 1)
1952 self.papi.nat64_add_del_interface,
1953 {'sw_if_index': sw_if_index,
1954 'is_inside': is_inside,
1957 def nat64_interface_dump(self):
1958 """Dump interfaces with NAT64 feature
1959 :return: Dictionary of interfaces with NAT64 feature
1961 return self.api(self.papi.nat64_interface_dump, {})
1963 def nat64_add_del_static_bib(
1972 """Add/delete S-NAT static BIB entry
1974 :param in_ip: Inside IPv6 address
1975 :param out_ip: Outside IPv4 address
1976 :param in_port: Inside port number
1977 :param out_port: Outside port number
1978 :param protocol: IP protocol
1979 :param vrf_id: VRF ID (Default value = 0)
1980 :param is_add: 1 if add, 0 if delete (Default value = 1)
1983 self.papi.nat64_add_del_static_bib,
1992 def nat64_bib_dump(self, protocol=255):
1995 :param protocol: IP protocol (Default value = 255, all BIBs)
1996 :returns: Dictionary of NAT64 BIB entries
1998 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
2000 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
2001 tcp_incoming_syn=6):
2002 """Set values of timeouts for NAT64 (in seconds)
2004 :param udpi: UDP timeout (Default value = 300)
2005 :param icmp: ICMP timeout (Default value = 60)
2006 :param tcp_trans: TCP transitory timeout (Default value = 240)
2007 :param tcp_est: TCP established timeout (Default value = 7440)
2008 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
2011 self.papi.nat64_set_timeouts,
2014 'tcp_trans': tcp_trans,
2016 'tcp_incoming_syn': tcp_incoming_syn})
2018 def nat64_get_timeouts(self):
2019 """Get values of timeouts for NAT64
2021 :return: Timeouts for NAT64 (in seconds)
2023 return self.api(self.papi.nat64_get_timeouts, {})
2025 def nat64_st_dump(self, protocol=255):
2026 """Dump NAT64 session table
2028 :param protocol: IP protocol (Default value = 255, all STs)
2029 :returns: Dictionary of NAT64 sesstion table entries
2031 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2033 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2034 """Add/del NAT64 prefix
2036 :param prefix: NAT64 prefix
2037 :param plen: NAT64 prefix length
2038 :param vrf_id: VRF id of tenant (Default 0)
2039 :param is_add: 1 if add, 0 if delete (Default value = 1)
2042 self.papi.nat64_add_del_prefix,
2048 def nat64_prefix_dump(self):
2049 """Dump NAT64 prefix
2051 :returns: Dictionary of NAT64 prefixes
2053 return self.api(self.papi.nat64_prefix_dump, {})
2055 def nat64_add_interface_addr(
2059 """Add/del NAT64 address from interface
2061 :param sw_if_index: Software index of the interface
2062 :param is_add: 1 if add, 0 if delete (Default value = 1)
2064 return self.api(self.papi.nat64_add_del_interface_addr,
2065 {'is_add': is_add, 'sw_if_index': sw_if_index})
2067 def dslite_set_aftr_addr(self, ip6, ip4):
2068 """Set DS-Lite AFTR addresses
2070 :param ip4: IPv4 address
2071 :param ip6: IPv6 address
2074 self.papi.dslite_set_aftr_addr,
2078 def dslite_set_b4_addr(self, ip6, ip4):
2079 """Set DS-Lite B4 IPv6 address
2081 :param ip4: IPv4 address
2082 :param ip6: IPv6 address
2085 self.papi.dslite_set_b4_addr,
2089 def dslite_add_del_pool_addr_range(
2094 """Add/del address range to DS-Lite pool
2096 :param start_addr: First IP address
2097 :param end_addr: Last IP address
2098 :param is_add: 1 if add, 0 if delete (Default value = 1)
2101 self.papi.dslite_add_del_pool_addr_range,
2102 {'start_addr': start_addr,
2103 'end_addr': end_addr,
2106 def nat66_add_del_interface(
2111 """Enable/disable NAT66 feature on the interface
2112 :param sw_if_index: Index of the interface
2113 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2114 :param is_add: 1 if add, 0 if delete (Default value = 1)
2117 self.papi.nat66_add_del_interface,
2118 {'sw_if_index': sw_if_index,
2119 'is_inside': is_inside,
2122 def nat66_add_del_static_mapping(
2128 """Add/delete NAT66 static mapping
2130 :param in_ip: Inside IPv6 address
2131 :param out_ip: Outside IPv6 address
2132 :param vrf_id: VRF ID (Default value = 0)
2133 :param is_add: 1 if add, 0 if delete (Default value = 1)
2136 self.papi.nat66_add_del_static_mapping,
2137 {'local_ip_address': in_ip,
2138 'external_ip_address': out_ip,
2142 def nat66_interface_dump(self):
2143 """Dump interfaces with NAT66 feature
2144 :return: Dictionary of interfaces with NAT66 feature
2146 return self.api(self.papi.nat66_interface_dump, {})
2148 def nat66_static_mapping_dump(self):
2149 """Dump NAT66 static mappings
2150 :return: Dictionary of NAT66 static mappings
2152 return self.api(self.papi.nat66_static_mapping_dump, {})
2154 def control_ping(self):
2155 self.api(self.papi.control_ping)
2157 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2158 detect_mult, local_addr, peer_addr, is_ipv6=0,
2159 bfd_key_id=None, conf_key_id=None):
2160 if bfd_key_id is None:
2161 return self.api(self.papi.bfd_udp_add,
2163 'sw_if_index': sw_if_index,
2164 'desired_min_tx': desired_min_tx,
2165 'required_min_rx': required_min_rx,
2166 'local_addr': local_addr,
2167 'peer_addr': peer_addr,
2169 'detect_mult': detect_mult,
2172 return self.api(self.papi.bfd_udp_add,
2174 'sw_if_index': sw_if_index,
2175 'desired_min_tx': desired_min_tx,
2176 'required_min_rx': required_min_rx,
2177 'local_addr': local_addr,
2178 'peer_addr': peer_addr,
2180 'detect_mult': detect_mult,
2181 'is_authenticated': 1,
2182 'bfd_key_id': bfd_key_id,
2183 'conf_key_id': conf_key_id,
2186 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2187 detect_mult, local_addr, peer_addr, is_ipv6=0):
2188 return self.api(self.papi.bfd_udp_mod,
2190 'sw_if_index': sw_if_index,
2191 'desired_min_tx': desired_min_tx,
2192 'required_min_rx': required_min_rx,
2193 'local_addr': local_addr,
2194 'peer_addr': peer_addr,
2196 'detect_mult': detect_mult,
2199 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2200 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2202 return self.api(self.papi.bfd_udp_auth_activate,
2204 'sw_if_index': sw_if_index,
2205 'local_addr': local_addr,
2206 'peer_addr': peer_addr,
2208 'is_delayed': 1 if is_delayed else 0,
2209 'bfd_key_id': bfd_key_id,
2210 'conf_key_id': conf_key_id,
2213 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2214 is_ipv6=0, is_delayed=False):
2215 return self.api(self.papi.bfd_udp_auth_deactivate,
2217 'sw_if_index': sw_if_index,
2218 'local_addr': local_addr,
2219 'peer_addr': peer_addr,
2221 'is_delayed': 1 if is_delayed else 0,
2224 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2225 return self.api(self.papi.bfd_udp_del,
2227 'sw_if_index': sw_if_index,
2228 'local_addr': local_addr,
2229 'peer_addr': peer_addr,
2233 def bfd_udp_session_dump(self):
2234 return self.api(self.papi.bfd_udp_session_dump, {})
2236 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2237 peer_addr, is_ipv6=0):
2238 return self.api(self.papi.bfd_udp_session_set_flags, {
2239 'admin_up_down': admin_up_down,
2240 'sw_if_index': sw_if_index,
2241 'local_addr': local_addr,
2242 'peer_addr': peer_addr,
2246 def want_bfd_events(self, enable_disable=1):
2247 return self.api(self.papi.want_bfd_events, {
2248 'enable_disable': enable_disable,
2252 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2253 return self.api(self.papi.bfd_auth_set_key, {
2254 'conf_key_id': conf_key_id,
2255 'auth_type': auth_type,
2257 'key_len': len(key),
2260 def bfd_auth_del_key(self, conf_key_id):
2261 return self.api(self.papi.bfd_auth_del_key, {
2262 'conf_key_id': conf_key_id,
2265 def bfd_auth_keys_dump(self):
2266 return self.api(self.papi.bfd_auth_keys_dump, {})
2268 def bfd_udp_set_echo_source(self, sw_if_index):
2269 return self.api(self.papi.bfd_udp_set_echo_source,
2270 {'sw_if_index': sw_if_index})
2272 def bfd_udp_del_echo_source(self):
2273 return self.api(self.papi.bfd_udp_del_echo_source, {})
2275 def bfd_udp_get_echo_source(self):
2276 return self.api(self.papi.bfd_udp_get_echo_source, {})
2278 def classify_add_del_table(
2283 table_index=0xFFFFFFFF,
2285 memory_size=2097152,
2287 next_table_index=0xFFFFFFFF,
2288 miss_next_index=0xFFFFFFFF,
2289 current_data_flag=0,
2290 current_data_offset=0):
2294 :param match_n_vectors: (Default value = 1)
2295 :param table_index: (Default value = 0xFFFFFFFF)
2296 :param nbuckets: (Default value = 2)
2297 :param memory_size: (Default value = 2097152)
2298 :param skip_n_vectors: (Default value = 0)
2299 :param next_table_index: (Default value = 0xFFFFFFFF)
2300 :param miss_next_index: (Default value = 0xFFFFFFFF)
2301 :param current_data_flag: (Default value = 0)
2302 :param current_data_offset: (Default value = 0)
2305 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2306 mask = mask + '\0' * (mask_len - len(mask))
2308 self.papi.classify_add_del_table,
2310 'table_index': table_index,
2311 'nbuckets': nbuckets,
2312 'memory_size': memory_size,
2313 'skip_n_vectors': skip_n_vectors,
2314 'match_n_vectors': match_n_vectors,
2315 'next_table_index': next_table_index,
2316 'miss_next_index': miss_next_index,
2317 'current_data_flag': current_data_flag,
2318 'current_data_offset': current_data_offset,
2319 'mask_len': mask_len,
2322 def classify_add_del_session(
2327 opaque_index=0xFFFFFFFF,
2328 hit_next_index=0xFFFFFFFF,
2336 :param opaque_index: (Default value = 0xFFFFFFFF)
2337 :param hit_next_index: (Default value = 0xFFFFFFFF)
2338 :param advance: (Default value = 0)
2339 :param action: (Default value = 0)
2340 :param metadata: (Default value = 0)
2343 match_len = ((len(match) - 1) / 16 + 1) * 16
2344 match = match + '\0' * (match_len - len(match))
2346 self.papi.classify_add_del_session,
2348 'table_index': table_index,
2349 'hit_next_index': hit_next_index,
2350 'opaque_index': opaque_index,
2353 'metadata': metadata,
2354 'match_len': match_len,
2357 def input_acl_set_interface(
2361 ip4_table_index=0xFFFFFFFF,
2362 ip6_table_index=0xFFFFFFFF,
2363 l2_table_index=0xFFFFFFFF):
2367 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2368 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2369 :param l2_table_index: (Default value = 0xFFFFFFFF)
2373 self.papi.input_acl_set_interface,
2374 {'sw_if_index': sw_if_index,
2375 'ip4_table_index': ip4_table_index,
2376 'ip6_table_index': ip6_table_index,
2377 'l2_table_index': l2_table_index,
2380 def output_acl_set_interface(
2384 ip4_table_index=0xFFFFFFFF,
2385 ip6_table_index=0xFFFFFFFF,
2386 l2_table_index=0xFFFFFFFF):
2390 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2391 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2392 :param l2_table_index: (Default value = 0xFFFFFFFF)
2396 self.papi.output_acl_set_interface,
2397 {'sw_if_index': sw_if_index,
2398 'ip4_table_index': ip4_table_index,
2399 'ip6_table_index': ip6_table_index,
2400 'l2_table_index': l2_table_index,
2403 def set_ipfix_exporter(
2410 collector_port=4739,
2413 self.papi.set_ipfix_exporter,
2415 'collector_address': collector_address,
2416 'collector_port': collector_port,
2417 'src_address': src_address,
2419 'path_mtu': path_mtu,
2420 'template_interval': template_interval,
2421 'udp_checksum': udp_checksum,
2424 def dhcp_proxy_config(self,
2432 self.papi.dhcp_proxy_config,
2434 'rx_vrf_id': rx_table_id,
2435 'server_vrf_id': server_table_id,
2438 'dhcp_server': dhcp_server,
2439 'dhcp_src_address': dhcp_src_address,
2442 def dhcp_proxy_set_vss(self,
2451 self.papi.dhcp_proxy_set_vss,
2454 'vss_type': vss_type,
2455 'vpn_ascii_id': vpn_ascii_id,
2457 'vpn_index': vpn_index,
2462 def dhcp_client_dump(self):
2463 return self.api(self.papi.dhcp_client_dump, {})
2465 def dhcp_client(self,
2470 set_broadcast_flag=1,
2471 want_dhcp_events=0):
2473 self.papi.dhcp_client_config,
2477 'sw_if_index': sw_if_index,
2478 'hostname': hostname,
2480 'want_dhcp_event': want_dhcp_events,
2481 'set_broadcast_flag': set_broadcast_flag,
2485 def ip_mroute_add_del(self,
2491 next_hop_sw_if_index,
2501 IP Multicast Route add/del
2504 self.papi.ip_mroute_add_del,
2505 {'next_hop_sw_if_index': next_hop_sw_if_index,
2506 'entry_flags': e_flags,
2507 'itf_flags': i_flags,
2508 'table_id': table_id,
2512 'is_local': is_local,
2513 'bier_imp': bier_imp,
2514 'next_hop_afi': next_hop_afi,
2515 'grp_address_length': grp_address_length,
2516 'grp_address': grp_address,
2517 'src_address': src_address,
2518 'nh_address': next_hop_address})
2520 def mfib_signal_dump(self):
2521 return self.api(self.papi.mfib_signal_dump, {})
2523 def ip_mfib_dump(self):
2524 return self.api(self.papi.ip_mfib_dump, {})
2526 def ip6_mfib_dump(self):
2527 return self.api(self.papi.ip6_mfib_dump, {})
2529 def lisp_enable_disable(self, is_enabled):
2531 self.papi.lisp_enable_disable,
2533 'is_en': is_enabled,
2536 def lisp_locator_set(self,
2540 self.papi.lisp_add_del_locator_set,
2543 'locator_set_name': ls_name
2546 def lisp_locator_set_dump(self):
2547 return self.api(self.papi.lisp_locator_set_dump, {})
2549 def lisp_locator(self,
2556 self.papi.lisp_add_del_locator,
2559 'locator_set_name': ls_name,
2560 'sw_if_index': sw_if_index,
2561 'priority': priority,
2565 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2567 self.papi.lisp_locator_dump,
2569 'is_index_set': is_index_set,
2571 'ls_index': ls_index,
2574 def lisp_local_mapping(self,
2584 self.papi.lisp_add_del_local_eid,
2586 'locator_set_name': ls_name,
2588 'eid_type': eid_type,
2590 'prefix_len': prefix_len,
2596 def lisp_eid_table_dump(self,
2604 self.papi.lisp_eid_table_dump,
2607 'prefix_length': prefix_length,
2609 'eid_type': eid_type,
2611 'filter': filter_opt,
2614 def lisp_remote_mapping(self,
2624 self.papi.lisp_add_del_remote_mapping,
2627 'eid_type': eid_type,
2629 'eid_len': eid_prefix_len,
2630 'rloc_num': rlocs_num,
2633 'is_src_dst': is_src_dst,
2636 def lisp_adjacency(self,
2645 self.papi.lisp_add_del_adjacency,
2649 'eid_type': eid_type,
2652 'leid_len': leid_len,
2653 'reid_len': reid_len,
2656 def lisp_adjacencies_get(self, vni=0):
2658 self.papi.lisp_adjacencies_get,
2663 def map_add_domain(self,
2677 self.papi.map_add_domain,
2679 'ip6_prefix': ip6_prefix,
2680 'ip6_prefix_len': ip6_prefix_len,
2681 'ip4_prefix': ip4_prefix,
2682 'ip4_prefix_len': ip4_prefix_len,
2684 'ip6_src_prefix_len': ip6_src_prefix_len,
2685 'ea_bits_len': ea_bits_len,
2686 'psid_offset': psid_offset,
2687 'psid_length': psid_length,
2688 'is_translation': is_translation,
2689 'is_rfc6052': is_rfc6052,
2693 def gtpu_add_del_tunnel(
2699 mcast_sw_if_index=0xFFFFFFFF,
2701 decap_next_index=0xFFFFFFFF,
2705 :param is_add: (Default value = 1)
2706 :param is_ipv6: (Default value = 0)
2709 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2710 :param encap_vrf_id: (Default value = 0)
2711 :param decap_next_index: (Default value = 0xFFFFFFFF)
2712 :param teid: (Default value = 0)
2715 return self.api(self.papi.gtpu_add_del_tunnel,
2718 'src_address': src_addr,
2719 'dst_address': dst_addr,
2720 'mcast_sw_if_index': mcast_sw_if_index,
2721 'encap_vrf_id': encap_vrf_id,
2722 'decap_next_index': decap_next_index,
2725 def vxlan_gpe_add_del_tunnel(
2729 mcast_sw_if_index=0xFFFFFFFF,
2740 :param is_add: (Default value = 1)
2741 :param is_ipv6: (Default value = 0)
2742 :param encap_vrf_id: (Default value = 0)
2743 :param decap_vrf_id: (Default value = 0)
2744 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2745 :param protocol: (Default value = 3)
2746 :param vni: (Default value = 0)
2749 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2754 'mcast_sw_if_index': mcast_sw_if_index,
2755 'encap_vrf_id': encap_vrf_id,
2756 'decap_vrf_id': decap_vrf_id,
2757 'protocol': protocol,
2760 def vxlan_gbp_tunnel_add_del(
2764 mcast_sw_if_index=0xFFFFFFFF,
2768 decap_next_index=0xFFFFFFFF,
2770 instance=0xFFFFFFFF):
2775 :param is_add: (Default value = 1)
2776 :param is_ipv6: (Default value = 0)
2777 :param encap_table_id: (Default value = 0)
2778 :param decap_next_index: (Default value = 0xFFFFFFFF)
2779 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2780 :param vni: (Default value = 0)
2781 :param instance: (Default value = 0xFFFFFFFF)
2784 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2789 'mcast_sw_if_index': mcast_sw_if_index,
2790 'encap_table_id': encap_table_id,
2791 'decap_next_index': decap_next_index,
2793 'instance': instance}})
2795 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2796 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2797 {'sw_if_index': sw_if_index})
2799 def pppoe_add_del_session(
2809 :param is_add: (Default value = 1)
2810 :param is_ipv6: (Default value = 0)
2812 :param session_id: (Default value = 0)
2814 :param decap_vrf_id: (Default value = 0)
2817 return self.api(self.papi.pppoe_add_del_session,
2820 'session_id': session_id,
2821 'client_ip': client_ip,
2822 'decap_vrf_id': decap_vrf_id,
2823 'client_mac': client_mac})
2825 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2826 return self.api(self.papi.sr_mpls_policy_add,
2830 'n_segments': len(segments),
2831 'segments': segments})
2833 def sr_mpls_policy_del(self, bsid):
2834 return self.api(self.papi.sr_mpls_policy_del,
2837 def sr_localsid_add_del(self,
2844 sw_if_index=0xFFFFFFFF,
2848 """ Add/del IPv6 SR local-SID.
2851 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2852 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2855 :param is_del: (Default value = 0)
2856 :param end_psp: (Default value = 0)
2857 :param sw_if_index: (Default value = 0xFFFFFFFF)
2858 :param vlan_index: (Default value = 0)
2859 :param fib_table: (Default value = 0)
2862 self.papi.sr_localsid_add_del,
2864 'localsid': localsid,
2866 'behavior': behavior,
2867 'sw_if_index': sw_if_index,
2868 'vlan_index': vlan_index,
2869 'fib_table': fib_table,
2870 'nh_addr4': nh_addr4,
2871 'nh_addr6': nh_addr6
2885 :param bsid_addr: bindingSID of the SR Policy
2886 :param weight: weight of the sid list. optional. (default: 1)
2887 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2889 :param type: type/behavior of the SR policy. (default or spray) \
2891 :param fib_table: VRF where to install the FIB entry for the BSID \
2893 :param n_segments: number of segments \
2895 :param segments: a vector of IPv6 address composing the segment list \
2899 self.papi.sr_policy_add,
2900 {'bsid_addr': bsid_addr,
2902 'is_encap': is_encap,
2904 'fib_table': fib_table,
2905 'n_segments': n_segments,
2906 'segments': segments
2915 :param bsid: bindingSID of the SR Policy
2916 :param sr_policy_index: index of the sr policy (default: 0)
2919 self.papi.sr_policy_del,
2920 {'bsid_addr': bsid_addr,
2921 'sr_policy_index': sr_policy_index
2924 def sr_steering_add_del(
2935 Steer traffic L2 and L3 traffic through a given SR policy
2937 :param is_del: delete or add
2938 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2939 :param sr_policy: is the index of the SR Policy (alt to bsid)
2940 :param table_id: is the VRF where to install the FIB entry for the BSID
2941 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2942 :param mask_width: is the mask for L3 traffic type
2943 :param sw_if_index: is the incoming interface for L2 traffic
2944 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2947 self.papi.sr_steering_add_del,
2949 'bsid_addr': bsid_addr,
2950 'sr_policy_index': sr_policy_index,
2951 'table_id': table_id,
2952 'prefix_addr': prefix_addr,
2953 'mask_width': mask_width,
2954 'sw_if_index': sw_if_index,
2955 'traffic_type': traffic_type
2958 def acl_add_replace(self, acl_index, r, tag='',
2960 """Add/replace an ACL
2961 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2962 :param acl_rule r: ACL rules array.
2963 :param str tag: symbolic tag (description) for this ACL.
2964 :param int count: number of rules.
2966 return self.api(self.papi.acl_add_replace,
2967 {'acl_index': acl_index,
2971 expected_retval=expected_retval)
2973 def acl_del(self, acl_index, expected_retval=0):
2979 return self.api(self.papi.acl_del,
2980 {'acl_index': acl_index},
2981 expected_retval=expected_retval)
2983 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2985 return self.api(self.papi.acl_interface_set_acl_list,
2986 {'sw_if_index': sw_if_index,
2990 expected_retval=expected_retval)
2992 def acl_interface_set_etype_whitelist(self, sw_if_index,
2995 return self.api(self.papi.acl_interface_set_etype_whitelist,
2996 {'sw_if_index': sw_if_index,
2997 'count': len(whitelist),
2999 'whitelist': whitelist},
3000 expected_retval=expected_retval)
3002 def acl_interface_add_del(self,
3006 """ Add/Delete ACL to/from interface
3010 :param is_add: (Default value = 1)
3013 return self.api(self.papi.acl_interface_add_del,
3016 'sw_if_index': sw_if_index,
3017 'acl_index': acl_index})
3019 def acl_dump(self, acl_index, expected_retval=0):
3020 return self.api(self.papi.acl_dump,
3021 {'acl_index': acl_index},
3022 expected_retval=expected_retval)
3024 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3026 return self.api(self.papi.acl_interface_list_dump,
3027 {'sw_if_index': sw_if_index},
3028 expected_retval=expected_retval)
3030 def macip_acl_add(self, rules, tag=""):
3033 :param rules: list of rules for given acl
3037 return self.api(self.papi.macip_acl_add,
3039 'count': len(rules),
3042 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3045 :param rules: list of rules for given acl
3049 return self.api(self.papi.macip_acl_add_replace,
3050 {'acl_index': acl_index,
3052 'count': len(rules),
3055 def macip_acl_del(self, acl_index):
3061 return self.api(self.papi.macip_acl_del,
3062 {'acl_index': acl_index})
3064 def macip_acl_interface_add_del(self,
3068 """ Add MACIP acl to interface
3072 :param is_add: (Default value = 1)
3075 return self.api(self.papi.macip_acl_interface_add_del,
3077 'sw_if_index': sw_if_index,
3078 'acl_index': acl_index})
3080 def macip_acl_interface_get(self):
3081 """ Return interface acls dump
3084 self.papi.macip_acl_interface_get, {})
3086 def macip_acl_dump(self, acl_index=4294967295):
3087 """ Return MACIP acl dump
3091 self.papi.macip_acl_dump, {'acl_index': acl_index})
3093 def policer_add_del(self,
3104 conform_action_type=1,
3106 exceed_action_type=0,
3108 violate_action_type=0,
3110 return self.api(self.papi.policer_add_del,
3117 'rate_type': rate_type,
3118 'round_type': round_type,
3120 'color_aware': color_aware,
3121 'conform_action_type': conform_action_type,
3122 'conform_dscp': conform_dscp,
3123 'exceed_action_type': exceed_action_type,
3124 'exceed_dscp': exceed_dscp,
3125 'violate_action_type': violate_action_type,
3126 'violate_dscp': violate_dscp})
3128 def ip_punt_police(self,
3132 return self.api(self.papi.ip_punt_police,
3133 {'policer_index': policer_index,
3137 def ip_punt_redirect(self,
3143 return self.api(self.papi.ip_punt_redirect,
3144 {'rx_sw_if_index': rx_sw_if_index,
3145 'tx_sw_if_index': tx_sw_if_index,
3150 def bier_table_add_del(self,
3154 """ BIER Table add/del """
3156 self.papi.bier_table_add_del,
3157 {'bt_tbl_id': {"bt_set": bti.set_id,
3158 "bt_sub_domain": bti.sub_domain_id,
3159 "bt_hdr_len_id": bti.hdr_len_id},
3160 'bt_label': mpls_label,
3161 'bt_is_add': is_add})
3163 def bier_table_dump(self):
3164 return self.api(self.papi.bier_table_dump, {})
3166 def bier_route_add_del(self,
3172 """ BIER Route add/del """
3174 self.papi.bier_route_add_del,
3175 {'br_tbl_id': {"bt_set": bti.set_id,
3176 "bt_sub_domain": bti.sub_domain_id,
3177 "bt_hdr_len_id": bti.hdr_len_id},
3179 'br_n_paths': len(paths),
3181 'br_is_add': is_add,
3182 'br_is_replace': is_replace})
3184 def bier_route_dump(self, bti):
3186 self.papi.bier_route_dump,
3187 {'br_tbl_id': {"bt_set": bti.set_id,
3188 "bt_sub_domain": bti.sub_domain_id,
3189 "bt_hdr_len_id": bti.hdr_len_id}})
3191 def bier_imp_add(self,
3196 """ BIER Imposition Add """
3198 self.papi.bier_imp_add,
3199 {'bi_tbl_id': {"bt_set": bti.set_id,
3200 "bt_sub_domain": bti.sub_domain_id,
3201 "bt_hdr_len_id": bti.hdr_len_id},
3203 'bi_n_bytes': len(ibytes),
3204 'bi_bytes': ibytes})
3206 def bier_imp_del(self, bi_index):
3207 """ BIER Imposition del """
3209 self.papi.bier_imp_del,
3210 {'bi_index': bi_index})
3212 def bier_imp_dump(self):
3213 return self.api(self.papi.bier_imp_dump, {})
3215 def bier_disp_table_add_del(self,
3218 """ BIER Disposition Table add/del """
3220 self.papi.bier_disp_table_add_del,
3221 {'bdt_tbl_id': bdti,
3222 'bdt_is_add': is_add})
3224 def bier_disp_table_dump(self):
3225 return self.api(self.papi.bier_disp_table_dump, {})
3227 def bier_disp_entry_add_del(self,
3237 """ BIER Route add/del """
3239 while (len(lstack) < 16):
3242 self.papi.bier_disp_entry_add_del,
3243 {'bde_tbl_id': bdti,
3245 'bde_payload_proto': payload_proto,
3247 'bde_paths': [{'next_hop': next_hop,
3248 'table_id': next_hop_tbl_id,
3249 'afi': next_hop_afi,
3250 'rpf_id': next_hop_rpf_id,
3252 'label_stack': lstack}],
3253 'bde_is_add': is_add})
3255 def bier_disp_entry_dump(self, bdti):
3257 self.papi.bier_disp_entry_dump,
3258 {'bde_tbl_id': bdti})
3260 def add_node_next(self, node_name, next_name):
3261 """ Set the next node for a given node request
3266 return self.api(self.papi.add_node_next,
3267 {'node_name': node_name,
3268 'next_name': next_name})
3270 def session_enable_disable(self, is_enabled):
3272 self.papi.session_enable_disable,
3273 {'is_enable': is_enabled})
3275 def ipsec_spd_add_del(self, spd_id, is_add=1):
3276 """ SPD add/del - Wrapper to add or del ipsec SPD
3277 Sample CLI : 'ipsec spd add 1'
3279 :param spd_id - SPD ID to be created in the vpp . mandatory
3280 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3282 :returns: reply from the API
3285 self.papi.ipsec_spd_add_del, {
3286 'spd_id': spd_id, 'is_add': is_add})
3288 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3289 """ IPSEC interface SPD add/del - \
3290 Wrapper to associate/disassociate SPD to interface in VPP
3291 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3293 :param spd_id - SPD ID to associate with the interface . mandatory
3294 :param sw_if_index - Interface Index which needs to ipsec \
3295 association mandatory
3296 :param is_add - add(1) or del(0) association with interface \
3297 (Default 1 - add) . optional
3298 :returns: reply from the API
3301 self.papi.ipsec_interface_add_del_spd,
3302 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3304 def ipsec_sad_add_del_entry(self,
3307 integrity_algorithm,
3312 tunnel_src_address='',
3313 tunnel_dst_address='',
3317 """ IPSEC SA add/del
3318 :param sad_id: security association ID
3319 :param spi: security param index of the SA in decimal
3320 :param integrity_algorithm:
3321 :param integrity_key:
3322 :param crypto_algorithm:
3324 :param protocol: AH(0) or ESP(1) protocol
3325 :param tunnel_src_address: tunnel mode outer src address
3326 :param tunnel_dst_address: tunnel mode outer dst address
3329 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3330 crypto and ipsec algorithms
3333 self.papi.ipsec_sad_add_del_entry,
3336 'tunnel_src_address': tunnel_src_address,
3337 'tunnel_dst_address': tunnel_dst_address,
3338 'protocol': protocol,
3339 'integrity_algorithm': integrity_algorithm,
3340 'integrity_key_length': len(integrity_key),
3341 'integrity_key': integrity_key,
3342 'crypto_algorithm': crypto_algorithm,
3343 'crypto_key_length': len(crypto_key) if crypto_key is not None
3345 'crypto_key': crypto_key,
3347 'is_tunnel': is_tunnel,
3348 'udp_encap': udp_encap})
3350 def ipsec_spd_add_del_entry(self,
3353 local_address_start,
3355 remote_address_start,
3356 remote_address_stop,
3358 local_port_stop=65535,
3359 remote_port_start=0,
3360 remote_port_stop=65535,
3367 """ IPSEC policy SPD add/del -
3368 Wrapper to configure ipsec SPD policy entries in VPP
3369 :param spd_id: SPD ID for the policy
3370 :param local_address_start: local-ip-range start address
3371 :param local_address_stop : local-ip-range stop address
3372 :param remote_address_start: remote-ip-range start address
3373 :param remote_address_stop : remote-ip-range stop address
3374 :param local_port_start: (Default value = 0)
3375 :param local_port_stop: (Default value = 65535)
3376 :param remote_port_start: (Default value = 0)
3377 :param remote_port_stop: (Default value = 65535)
3378 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3379 :param sa_id: Security Association ID for mapping it to SPD
3380 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3382 :param priority: value for the spd action (Default value = 100)
3383 :param is_outbound: flag for inbound(0) or outbound(1)
3385 :param is_add: (Default value = 1)
3388 self.papi.ipsec_spd_add_del_entry,
3391 'local_address_start': local_address_start,
3392 'local_address_stop': local_address_stop,
3393 'remote_address_start': remote_address_start,
3394 'remote_address_stop': remote_address_stop,
3395 'local_port_start': local_port_start,
3396 'local_port_stop': local_port_stop,
3397 'remote_port_start': remote_port_start,
3398 'remote_port_stop': remote_port_stop,
3400 'protocol': protocol,
3402 'priority': priority,
3403 'is_outbound': is_outbound,
3404 'is_ip_any': is_ip_any})
3406 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3407 remote_spi, crypto_alg, local_crypto_key,
3408 remote_crypto_key, integ_alg, local_integ_key,
3409 remote_integ_key, is_add=1, esn=0,
3410 anti_replay=1, renumber=0, show_instance=0):
3412 self.papi.ipsec_tunnel_if_add_del,
3413 {'local_ip': local_ip, 'remote_ip': remote_ip,
3414 'local_spi': local_spi, 'remote_spi': remote_spi,
3415 'crypto_alg': crypto_alg,
3416 'local_crypto_key_len': len(local_crypto_key),
3417 'local_crypto_key': local_crypto_key,
3418 'remote_crypto_key_len': len(remote_crypto_key),
3419 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3420 'local_integ_key_len': len(local_integ_key),
3421 'local_integ_key': local_integ_key,
3422 'remote_integ_key_len': len(remote_integ_key),
3423 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3424 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3425 'show_instance': show_instance
3428 def app_namespace_add(self,
3432 sw_if_index=0xFFFFFFFF,
3435 self.papi.app_namespace_add_del,
3437 'sw_if_index': sw_if_index,
3438 'ip4_fib_id': ip4_fib_id,
3439 'ip6_fib_id': ip6_fib_id,
3440 'namespace_id': namespace_id,
3441 'namespace_id_len': len(namespace_id)})
3443 def punt_socket_register(self, l4_port, pathname, header_version=1,
3444 is_ip4=1, l4_protocol=0x11):
3445 """ Punt to socket """
3446 return self.api(self.papi.punt_socket_register,
3448 'l4_protocol': l4_protocol,
3450 'pathname': pathname,
3451 'header_version': header_version})
3453 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3454 expire_walk_interval_ms, is_ip6=0):
3455 """ Set IP reassembly parameters """
3456 return self.api(self.papi.ip_reassembly_set,
3458 'timeout_ms': timeout_ms,
3459 'expire_walk_interval_ms': expire_walk_interval_ms,
3460 'max_reassemblies': max_reassemblies})
3462 def ip_reassembly_get(self, is_ip6=0):
3463 """ Get IP reassembly parameters """
3464 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3466 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3468 """ Enable/disable IP reassembly """
3469 return self.api(self.papi.ip_reassembly_enable_disable,
3470 {'sw_if_index': sw_if_index,
3471 'enable_ip4': 1 if enable_ip4 else 0,
3472 'enable_ip6': 1 if enable_ip6 else 0,
3475 def gbp_endpoint_add(self, sw_if_index, ips, mac, epg):
3476 """ GBP endpoint Add """
3477 return self.api(self.papi.gbp_endpoint_add,
3479 'sw_if_index': sw_if_index,
3485 def gbp_endpoint_del(self, handle):
3486 """ GBP endpoint Del """
3487 return self.api(self.papi.gbp_endpoint_del,
3490 def gbp_endpoint_dump(self):
3491 """ GBP endpoint Dump """
3492 return self.api(self.papi.gbp_endpoint_dump, {})
3494 def gbp_endpoint_group_add_del(self, is_add, epg, bd,
3497 uplink_sw_if_index):
3498 """ GBP endpoint group Add/Del """
3499 return self.api(self.papi.gbp_endpoint_group_add_del,
3502 'uplink_sw_if_index': uplink_sw_if_index,
3504 'ip4_table_id': ip4_rd,
3505 'ip6_table_id': ip6_rd,
3508 def gbp_endpoint_group_dump(self):
3509 """ GBP endpoint group Dump """
3510 return self.api(self.papi.gbp_endpoint_group_dump, {})
3512 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3513 """ GBP recirc Add/Del """
3514 return self.api(self.papi.gbp_recirc_add_del,
3518 'sw_if_index': sw_if_index,
3521 def gbp_recirc_dump(self):
3522 """ GBP recirc Dump """
3523 return self.api(self.papi.gbp_recirc_dump, {})
3525 def gbp_subnet_add_del(self, is_add, table_id,
3528 sw_if_index=0xffffffff,
3531 """ GBP Subnet Add/Del """
3532 return self.api(self.papi.gbp_subnet_add_del,
3535 'is_internal': is_internal,
3537 'sw_if_index': sw_if_index,
3540 'table_id': table_id}})
3542 def gbp_subnet_dump(self):
3543 """ GBP Subnet Dump """
3544 return self.api(self.papi.gbp_subnet_dump, {})
3546 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3547 """ GBP contract Add/Del """
3548 return self.api(self.papi.gbp_contract_add_del,
3551 'acl_index': acl_index,
3553 'dst_epg': dst_epg}})
3555 def gbp_contract_dump(self):
3556 """ GBP contract Dump """
3557 return self.api(self.papi.gbp_contract_dump, {})
3559 def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3560 ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3562 """ 6RD tunnel Add """
3563 return self.api(self.papi.ipip_6rd_add_tunnel,
3564 {'ip4_table_id': ip4_table_id,
3565 'ip6_table_id': ip6_table_id,
3566 'ip6_prefix': ip6_prefix,
3567 'ip6_prefix_len': ip6_prefix_len,
3568 'ip4_prefix': ip4_prefix,
3569 'ip4_prefix_len': ip4_prefix_len,
3571 'security_check': security_check})
3573 def ipip_6rd_del_tunnel(self, sw_if_index):
3574 """ 6RD tunnel Delete """
3575 return self.api(self.papi.ipip_6rd_del_tunnel,
3576 {'sw_if_index': sw_if_index})
3578 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3579 instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3580 """ IPIP tunnel Add/Del """
3581 return self.api(self.papi.ipip_add_tunnel,
3582 {'is_ipv6': is_ipv6,
3583 'instance': instance,
3584 'src_address': src_address,
3585 'dst_address': dst_address,
3586 'table_id': table_id,
3589 def ipip_del_tunnel(self, sw_if_index):
3590 """ IPIP tunnel Delete """
3591 return self.api(self.papi.ipip_del_tunnel,
3592 {'sw_if_index': sw_if_index})
3594 def qos_egress_map_update(self, id, outputs):
3595 """ QOS egress map update """
3596 return self.api(self.papi.qos_egress_map_update,
3600 def qos_egress_map_delete(self, id):
3601 """ QOS egress map delete """
3602 return self.api(self.papi.qos_egress_map_delete,
3605 def qos_mark_enable_disable(self, sw_if_index,
3609 """ QOS Mark Enable/Disable """
3610 return self.api(self.papi.qos_mark_enable_disable,
3612 'sw_if_index': sw_if_index,
3613 'output_source': output_source,
3616 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3617 """ IP QoS recording Enble/Disable """
3618 return self.api(self.papi.qos_record_enable_disable,
3619 {'sw_if_index': sw_if_index,
3620 'input_source': input_source,
3623 def igmp_enable_disable(self, sw_if_index, enable, host):
3624 """ Enable/disable IGMP on a given interface """
3625 return self.api(self.papi.igmp_enable_disable,
3628 'sw_if_index': sw_if_index})
3630 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3631 """ Listen for new (S,G) on specified interface
3633 :param enable: add/del
3634 :param sw_if_index: interface sw index
3635 :param saddr: source ip4 addr
3636 :param gaddr: group ip4 addr
3638 return self.api(self.papi.igmp_listen,
3643 'sw_if_index': sw_if_index,
3644 'n_srcs': len(saddrs),
3653 def igmp_dump(self, sw_if_index=None):
3654 """ Dump all (S,G) interface configurations """
3655 if sw_if_index is None:
3656 sw_if_index = 0xffffffff
3657 return self.api(self.papi.igmp_dump,
3658 {'sw_if_index': sw_if_index})
3660 def igmp_clear_interface(self, sw_if_index):
3661 """ Remove all (S,G)s from specified interface
3662 doesn't send IGMP report!
3665 self.papi.igmp_clear_interface, {
3666 'sw_if_index': sw_if_index})
3668 def want_igmp_events(self, enable=1):
3669 return self.api(self.papi.want_igmp_events, {'enable': enable,
3670 'pid': os.getpid()})
3680 :param lb: load balance
3681 :param use_custom_mac: use custom mac
3682 :param mac_address: mac address
3685 self.papi.bond_create,
3688 'use_custom_mac': use_custom_mac,
3689 'mac_address': mac_address
3696 :param sw_if_index: interface the operation is applied to
3698 return self.api(self.papi.bond_delete,
3699 {'sw_if_index': sw_if_index})
3708 :param sw_if_index: slave sw_if_index
3709 :param bond_sw_if_index: bond sw_if_index
3710 :param is_passive: is passive lacp speaker
3711 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3714 self.papi.bond_enslave,
3715 {'sw_if_index': sw_if_index,
3716 'bond_sw_if_index': bond_sw_if_index,
3717 'is_passive': is_passive,
3718 'is_long_timeout': is_long_timeout
3721 def bond_detach_slave(
3725 :param sw_if_index: slave interface the operation is applied to
3727 return self.api(self.papi.bond_detach_slave,
3728 {'sw_if_index': sw_if_index})
3730 def sw_interface_slave_dump(
3734 :param sw_if_index: bond sw_if_index
3736 return self.api(self.papi.sw_interface_slave_dump,
3737 {'sw_if_index': sw_if_index})
3739 def sw_interface_bond_dump(
3744 return self.api(self.papi.sw_interface_bond_dump,
3747 def create_vhost_user_if(
3753 disable_indirect_desc,
3754 custom_dev_instance,
3759 :param is_server: is server
3760 :param sock_filename: socket name
3761 :param renumber: renumber
3762 :param disable_mrg_rxbuf: disable mergable rx buffers
3763 :param disable_indirect_desc: disable indirect descriptors
3764 :param custom_dev_instance: custom dev instance
3765 :param use_custom_mac: use custom mac
3766 :param mac_address: mac address
3767 :param tag: tag (default '')
3770 self.papi.create_vhost_user_if,
3771 {'is_server': is_server,
3772 'sock_filename': sock_filename,
3773 'renumber': renumber,
3774 'disable_mrg_rxbuf': disable_mrg_rxbuf,
3775 'disable_indirect_desc': disable_indirect_desc,
3776 'custom_dev_instance': custom_dev_instance,
3777 'use_custom_mac': use_custom_mac,
3778 'mac_address': mac_address,
3782 def delete_vhost_user_if(
3786 :param sw_if_index: interface the operation is applied to
3788 return self.api(self.papi.delete_vhost_user_if,
3789 {'sw_if_index': sw_if_index, })
3791 def sw_interface_vhost_user_dump(
3796 return self.api(self.papi.sw_interface_vhost_user_dump,
3799 def abf_policy_add_del(self, is_add, policy):
3801 self.papi.abf_policy_add_del,
3805 def abf_itf_attach_add_del(self, is_add, attach):
3807 self.papi.abf_itf_attach_add_del,
3811 def abf_policy_dump(self):
3813 self.papi.abf_policy_dump, {})
3815 def abf_itf_attach_dump(self):
3817 self.papi.abf_itf_attach_dump, {})
3819 def pipe_create(self, is_specified, user_instance):
3820 return self.api(self.papi.pipe_create,
3821 {'is_specified': is_specified,
3822 'user_instance': user_instance})
3824 def pipe_delete(self, parent_sw_if_index):
3825 return self.api(self.papi.pipe_delete,
3826 {'parent_sw_if_index': parent_sw_if_index})
3828 def pipe_dump(self):
3829 return self.api(self.papi.pipe_dump, {})
3843 return self.api(self.papi.memif_create,
3846 'rx_queues': rx_queues,
3847 'tx_queues': tx_queues,
3849 'socket_id': socket_id,
3851 'ring_size': ring_size,
3852 'buffer_size': buffer_size,
3853 'hw_addr': hw_addr})
3855 def memif_delete(self, sw_if_index):
3856 return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index})
3858 def memif_dump(self):
3859 return self.api(self.papi.memif_dump, {})
3861 def memif_socket_filename_add_del(
3862 self, is_add, socket_id, socket_filename):
3864 self.papi.memif_socket_filename_add_del,
3866 'socket_id': socket_id,
3867 'socket_filename': socket_filename})
3869 def memif_socket_filename_dump(self):
3870 return self.api(self.papi.memif_socket_filename_dump, {})
3872 def svs_table_add_del(self, af, table_id, is_add=1):
3873 return self.api(self.papi.svs_table_add_del,
3875 'table_id': table_id,
3880 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
3881 return self.api(self.papi.svs_route_add_del,
3883 'table_id': table_id,
3884 'source_table_id': src_table_id,
3889 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
3890 return self.api(self.papi.svs_enable_disable,
3893 'table_id': table_id,
3894 'sw_if_index': sw_if_index,
3895 'is_enable': is_enable,
3899 return self.api(self.papi.svs_dump, {})