4 from collections import deque
10 # Sphinx creates auto-generated documentation by importing the python source
11 # files and collecting the docstrings from them. The NO_VPP_PAPI flag allows
12 # the vpp_papi_provider.py file to be importable without having to build
13 # the whole vpp api if the user only wishes to generate the test documentation.
16 no_vpp_papi = os.getenv("NO_VPP_PAPI")
17 if no_vpp_papi == "1":
23 from vpp_papi import VPP
24 from vpp_l2 import L2_PORT_TYPE
26 # from vnet/vnet/mpls/mpls_types.h
27 MPLS_IETF_MAX_LABEL = 0xfffff
28 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
50 class SYSLOG_SEVERITY:
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 assert_negative_api_retval(self):
96 """ Expect API failure - used with with, e.g.:
97 with self.vapi.assert_negative_api_retval():
98 self.vapi.<api call expected to fail>
100 self._expect_stack.append(self._expect_api_retval)
101 self._expect_api_retval = self._negative
104 def assert_zero_api_retval(self):
105 """ Expect API success - used with with, e.g.:
106 with self.vapi.assert_negative_api_retval():
107 self.vapi.<api call expected to succeed>
109 note: this is useful only inside another with block
110 as success is the default expected value
112 self._expect_stack.append(self._expect_api_retval)
113 self._expect_api_retval = self._zero
116 def __exit__(self, exc_type, exc_value, traceback):
117 self._expect_api_retval = self._expect_stack.pop()
119 def register_hook(self, hook):
120 """Replace hook registration with new hook
127 def collect_events(self):
128 """ Collect all events from the internal queue and clear the queue. """
130 self._events = deque()
133 def wait_for_event(self, timeout, name=None):
134 """ Wait for and return next event. """
136 self.test_class.logger.debug("Expecting event '%s' within %ss",
139 self.test_class.logger.debug("Expecting event within %ss",
142 self.test_class.logger.debug("Not waiting, event already queued")
143 limit = time.time() + timeout
144 while time.time() < limit:
146 e = self._events.popleft()
147 if name and type(e).__name__ != name:
149 "Unexpected event received: %s, expected: %s" %
150 (type(e).__name__, name))
151 self.test_class.logger.debug("Returning event %s:%s" %
154 time.sleep(0) # yield
155 raise Exception("Event did not occur within timeout")
157 def __call__(self, name, event):
158 """ Enqueue event in the internal event queue. """
159 # FIXME use the name instead of relying on type(e).__name__ ?
160 # FIXME #2 if this throws, it is eaten silently, Ole?
161 self.test_class.logger.debug("New event: %s: %s" % (name, event))
162 self._events.append(event)
165 """Connect the API to VPP"""
166 self.vpp.connect(self.name, self.shm_prefix)
167 self.papi = self.vpp.api
168 self.vpp.register_event_callback(self)
170 def disconnect(self):
171 """Disconnect the API from VPP"""
172 self.vpp.disconnect()
174 def api(self, api_fn, api_args, expected_retval=0):
175 """ Call API function and check it's return value.
176 Call the appropriate hooks before and after the API call
178 :param api_fn: API function to call
179 :param api_args: tuple of API function arguments
180 :param expected_retval: Expected return value (Default value = 0)
181 :returns: reply from the API
184 self.hook.before_api(api_fn.__name__, api_args)
185 reply = api_fn(**api_args)
186 if self._expect_api_retval == self._negative:
187 if hasattr(reply, 'retval') and reply.retval >= 0:
188 msg = "API call passed unexpectedly: expected negative "\
189 "return value instead of %d in %s" % \
190 (reply.retval, six.reprlib(reply))
191 self.test_class.logger.info(msg)
192 raise UnexpectedApiReturnValueError(msg)
193 elif self._expect_api_retval == self._zero:
194 if hasattr(reply, 'retval') and reply.retval != expected_retval:
195 msg = "API call failed, expected %d return value instead "\
196 "of %d in %s" % (expected_retval, reply.retval,
198 self.test_class.logger.info(msg)
199 raise UnexpectedApiReturnValueError(msg)
201 raise Exception("Internal error, unexpected value for "
202 "self._expect_api_retval %s" %
203 self._expect_api_retval)
204 self.hook.after_api(api_fn.__name__, api_args)
208 """ Execute a CLI, calling the before/after hooks appropriately.
210 :param cli: CLI to execute
214 self.hook.before_cli(cli)
216 r = self.papi.cli_inband(length=len(cli), cmd=cli)
217 self.hook.after_cli(cli)
218 if hasattr(r, 'reply'):
219 return r.reply.decode().rstrip('\x00')
221 def ppcli(self, cli):
222 """ Helper method to print CLI command in case of info logging level.
224 :param cli: CLI to execute
227 return cli + "\n" + str(self.cli(cli))
229 def _convert_mac(self, mac):
230 return mac.replace(':', '').decode('hex')
232 def show_version(self):
234 return self.api(self.papi.show_version, {})
236 def pg_create_interface(self, pg_index):
242 return self.api(self.papi.pg_create_interface,
243 {"interface_id": pg_index})
245 def sw_interface_dump(self, filter=None):
248 :param filter: (Default value = None)
251 if filter is not None:
252 args = {"name_filter_valid": 1, "name_filter": filter}
255 return self.api(self.papi.sw_interface_dump, args)
257 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
258 """ Set the IPvX Table-id for the Interface
265 return self.api(self.papi.sw_interface_set_table,
266 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
269 def sw_interface_get_table(self, sw_if_index, is_ipv6):
270 """ Get the IPvX Table-id for the Interface
277 return self.api(self.papi.sw_interface_get_table,
278 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6})
280 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
281 is_ipv6=0, is_add=1, del_all=0):
284 :param addr: param is_ipv6: (Default value = 0)
287 :param is_ipv6: (Default value = 0)
288 :param is_add: (Default value = 1)
289 :param del_all: (Default value = 0)
292 return self.api(self.papi.sw_interface_add_del_address,
293 {'sw_if_index': sw_if_index,
297 'address_length': addr_len,
300 def ip_address_dump(self, sw_if_index, is_ipv6=0):
301 return self.api(self.papi.ip_address_dump,
302 {'sw_if_index': sw_if_index,
305 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
307 """ Set the Interface to be unnumbered
309 :param is_add: (Default value = 1)
310 :param sw_if_index - interface That will be unnumbered
311 :param ip_sw_if_index - interface with an IP addres
314 return self.api(self.papi.sw_interface_set_unnumbered,
315 {'sw_if_index': ip_sw_if_index,
316 'unnumbered_sw_if_index': sw_if_index,
319 def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
320 return self.api(self.papi.ip_unnumbered_dump,
321 {'sw_if_index': sw_if_index})
323 def sw_interface_enable_disable_mpls(self, sw_if_index,
326 Enable/Disable MPLS on the interface
328 :param is_enable: (Default value = 1)
331 return self.api(self.papi.sw_interface_set_mpls_enable,
332 {'sw_if_index': sw_if_index,
333 'enable': is_enable})
335 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
336 return self.api(self.papi.sw_interface_ip6nd_ra_config,
337 {'sw_if_index': sw_if_index,
338 'suppress': suppress})
340 def set_ip_flow_hash(self,
349 return self.api(self.papi.set_ip_flow_hash,
359 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
360 return self.api(self.papi.ip6nd_proxy_add_del,
362 'sw_if_index': sw_if_index,
365 def ip6_sw_interface_ra_config(self, sw_if_index,
369 return self.api(self.papi.sw_interface_ip6nd_ra_config,
370 {'sw_if_index': sw_if_index,
372 'suppress': suppress,
373 'send_unicast': send_unicast})
375 def ip6_sw_interface_ra_prefix(self,
385 val_lifetime=0xffffffff,
386 pref_lifetime=0xffffffff):
387 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
388 {'sw_if_index': sw_if_index,
390 'address_length': address_length,
391 'use_default': use_default,
392 'no_advertise': no_advertise,
393 'off_link': off_link,
394 'no_autoconfig': no_autoconfig,
395 'no_onlink': no_onlink,
397 'val_lifetime': val_lifetime,
398 'pref_lifetime': pref_lifetime})
400 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
402 Enable/Disable An interface for IPv6
404 return self.api(self.papi.sw_interface_ip6_enable_disable,
405 {'sw_if_index': sw_if_index,
408 def vxlan_add_del_tunnel(
412 mcast_sw_if_index=0xFFFFFFFF,
416 decap_next_index=0xFFFFFFFF,
418 instance=0xFFFFFFFF):
423 :param is_add: (Default value = 1)
424 :param is_ipv6: (Default value = 0)
425 :param encap_vrf_id: (Default value = 0)
426 :param decap_next_index: (Default value = 0xFFFFFFFF)
427 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
428 :param vni: (Default value = 0)
429 :param instance: (Default value = 0xFFFFFFFF)
432 return self.api(self.papi.vxlan_add_del_tunnel,
435 'src_address': src_addr,
436 'dst_address': dst_addr,
437 'mcast_sw_if_index': mcast_sw_if_index,
438 'encap_vrf_id': encap_vrf_id,
439 'decap_next_index': decap_next_index,
441 'instance': instance})
443 def geneve_add_del_tunnel(
447 mcast_sw_if_index=0xFFFFFFFF,
451 decap_next_index=0xFFFFFFFF,
457 :param is_add: (Default value = 1)
458 :param is_ipv6: (Default value = 0)
459 :param encap_vrf_id: (Default value = 0)
460 :param decap_next_index: (Default value = 0xFFFFFFFF)
461 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
462 :param vni: (Default value = 0)
465 return self.api(self.papi.geneve_add_del_tunnel,
468 'local_address': local_addr,
469 'remote_address': remote_addr,
470 'mcast_sw_if_index': mcast_sw_if_index,
471 'encap_vrf_id': encap_vrf_id,
472 'decap_next_index': decap_next_index,
475 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
476 learn=1, arp_term=0, is_add=1):
477 """Create/delete bridge domain.
479 :param int bd_id: Bridge domain index.
480 :param int flood: Enable/disable bcast/mcast flooding in the BD.
482 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
484 :param int forward: Enable/disable forwarding on all interfaces in
485 the BD. (Default value = 1)
486 :param int learn: Enable/disable learning on all interfaces in the BD.
488 :param int arp_term: Enable/disable arp termination in the BD.
490 :param int is_add: Add or delete flag. (Default value = 1)
492 return self.api(self.papi.bridge_domain_add_del,
495 'uu_flood': uu_flood,
498 'arp_term': arp_term,
501 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
502 return self.api(self.papi.bd_ip_mac_add_del,
508 def bd_ip_mac_dump(self, bd_id):
509 return self.api(self.papi.bd_ip_mac_dump,
512 def want_ip4_arp_events(self, enable_disable=1, address=0):
513 return self.api(self.papi.want_ip4_arp_events,
514 {'enable_disable': enable_disable,
516 'pid': os.getpid(), })
518 def want_ip6_nd_events(self, enable_disable=1, address=0):
519 return self.api(self.papi.want_ip6_nd_events,
520 {'enable_disable': enable_disable,
522 'pid': os.getpid(), })
524 def want_ip6_ra_events(self, enable_disable=1):
525 return self.api(self.papi.want_ip6_ra_events,
526 {'enable_disable': enable_disable,
527 'pid': os.getpid(), })
529 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
531 return self.api(self.papi.ip6nd_send_router_solicitation,
536 'sw_if_index': sw_if_index})
538 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
539 install_default_routes):
540 return self.api(self.papi.ip6_nd_address_autoconfig,
541 {'sw_if_index': sw_if_index,
543 'install_default_routes': install_default_routes})
545 def want_interface_events(self, enable_disable=1):
546 return self.api(self.papi.want_interface_events,
547 {'enable_disable': enable_disable,
548 'pid': os.getpid(), })
550 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
551 max_macs_in_event=0, learn_limit=0):
552 return self.api(self.papi.want_l2_macs_events,
553 {'enable_disable': enable_disable,
554 'scan_delay': scan_delay,
555 'max_macs_in_event': max_macs_in_event,
556 'learn_limit': learn_limit,
557 'pid': os.getpid(), })
559 def want_dhcp6_reply_events(self, enable_disable=1):
560 return self.api(self.papi.want_dhcp6_reply_events,
561 {'enable_disable': enable_disable,
564 def want_dhcp6_pd_reply_events(self, enable_disable=1):
565 return self.api(self.papi.want_dhcp6_pd_reply_events,
566 {'enable_disable': enable_disable,
569 def dhcp6_clients_enable_disable(self, enable=1):
570 return self.api(self.papi.dhcp6_clients_enable_disable,
573 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
574 addresses, server_index=0xFFFFFFFF,
575 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
577 return self.api(self.papi.dhcp6_send_client_message,
578 {'sw_if_index': sw_if_index,
579 'server_index': server_index,
585 'msg_type': msg_type,
588 'n_addresses': len(addresses),
589 'addresses': addresses})
591 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
592 prefixes, server_index=0xFFFFFFFF,
593 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
595 return self.api(self.papi.dhcp6_pd_send_client_message,
596 {'sw_if_index': sw_if_index,
597 'server_index': server_index,
603 'msg_type': msg_type,
606 'n_prefixes': len(prefixes),
607 'prefixes': prefixes})
609 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
611 return self.api(self.papi.dhcp6_client_enable_disable,
612 {'sw_if_index': sw_if_index,
615 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
617 return self.api(self.papi.dhcp6_pd_client_enable_disable,
618 {'sw_if_index': sw_if_index,
619 'prefix_group': prefix_group,
622 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
623 prefix_length, prefix_group,
625 return self.api(self.papi.ip6_add_del_address_using_prefix,
626 {'sw_if_index': sw_if_index,
627 'prefix_group': prefix_group,
629 'prefix_length': prefix_length,
632 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
633 filter_mac=0, bvi_mac=0):
634 """Create/delete L2 FIB entry.
636 :param str mac: MAC address to create FIB entry for.
637 :param int bd_id: Bridge domain index.
638 :param int sw_if_index: Software interface index of the interface.
639 :param int is_add: Add or delete flag. (Default value = 1)
640 :param int static_mac: Set to 1 to create static MAC entry.
642 :param int filter_mac: Set to 1 to drop packet that's source or
643 destination MAC address contains defined MAC address.
645 :param int bvi_mac: Set to 1 to create entry that points to BVI
646 interface. (Default value = 0)
648 return self.api(self.papi.l2fib_add_del,
649 {'mac': self._convert_mac(mac),
651 'sw_if_index': sw_if_index,
653 'static_mac': static_mac,
654 'filter_mac': filter_mac,
657 def l2fib_flush_int(self, sw_if_index):
658 """Flush L2 FIB entries for sw_if_index.
660 :param int sw_if_index: Software interface index of the interface.
662 return self.api(self.papi.l2fib_flush_int,
663 {'sw_if_index': sw_if_index})
665 def l2fib_flush_bd(self, bd_id):
666 """Flush L2 FIB entries for bd_id.
668 :param int sw_if_index: Bridge Domain id.
670 return self.api(self.papi.l2fib_flush_bd,
673 def l2fib_flush_all(self):
676 return self.api(self.papi.l2fib_flush_all, {})
678 def l2_fib_table_dump(self, bd_id):
679 """ Dump the L2 FIB """
680 return self.api(self.papi.l2_fib_table_dump,
683 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
684 shg=0, port_type=L2_PORT_TYPE.NORMAL,
686 """Add/remove interface to/from bridge domain.
688 :param int sw_if_index: Software interface index of the interface.
689 :param int bd_id: Bridge domain index.
690 :param int shg: Split-horizon group index. (Default value = 0)
691 :param int bvi: Set interface as a bridge group virtual interface.
693 :param int enable: Add or remove interface. (Default value = 1)
695 return self.api(self.papi.sw_interface_set_l2_bridge,
696 {'rx_sw_if_index': sw_if_index,
699 'port_type': port_type,
702 def bridge_flags(self, bd_id, is_set, feature_bitmap):
703 """Enable/disable required feature of the bridge domain with defined
706 :param int bd_id: Bridge domain ID.
707 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
708 :param int flags: Bitmap value of the feature to be set:
712 - uu-flood (1 << 3) or
715 return self.api(self.papi.bridge_flags,
718 'flags': feature_bitmap})
720 def bridge_domain_dump(self, bd_id=0):
723 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
724 existing bridge domains returned)
725 :return: Dictionary of bridge domain(s) data.
727 return self.api(self.papi.bridge_domain_dump,
730 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
732 """Create or delete unidirectional cross-connect from Tx interface to
735 :param int rx_sw_if_index: Software interface index of Rx interface.
736 :param int tx_sw_if_index: Software interface index of Tx interface.
737 :param int enable: Create cross-connect if equal to 1, delete
738 cross-connect if equal to 0.
741 return self.api(self.papi.sw_interface_set_l2_xconnect,
742 {'rx_sw_if_index': rx_sw_if_index,
743 'tx_sw_if_index': tx_sw_if_index,
746 def sw_interface_set_l2_tag_rewrite(
753 """L2 interface vlan tag rewrite configure request
754 :param client_index - opaque cookie to identify the sender
755 :param context - sender context, to match reply w/ request
756 :param sw_if_index - interface the operation is applied to
757 :param vtr_op - Choose from l2_vtr_op_t enum values
758 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
759 :param tag1 - Needed for any push or translate vtr op
760 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
763 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
764 {'sw_if_index': sw_if_index,
770 def sw_interface_set_l2_emulation(
775 :param sw_if_index - interface the operation is applied to
778 return self.api(self.papi.l2_emulation,
779 {'sw_if_index': sw_if_index,
782 def sw_interface_set_ip_directed_broadcast(
786 """IP Directed broadcast
787 :param sw_if_index - interface the operation is applied to
790 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
791 {'sw_if_index': sw_if_index,
794 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
797 :param admin_up_down:
801 return self.api(self.papi.sw_interface_set_flags,
802 {'sw_if_index': sw_if_index,
803 'admin_up_down': admin_up_down})
805 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
811 return self.api(self.papi.sw_interface_set_mtu,
812 {'sw_if_index': sw_if_index,
815 def sw_interface_set_promiscuous(self, sw_if_index, enable):
821 return self.api(self.papi.sw_interface_set_promiscuous,
822 {'sw_if_index': sw_if_index,
825 def sw_interface_set_mac_address(self, sw_if_index, mac):
826 return self.api(self.papi.sw_interface_set_mac_address,
827 {'sw_if_index': sw_if_index,
830 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
831 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
832 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
833 """Create subinterface
834 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
836 :param sub_id: param inner_vlan:
840 :param no_tags: (Default value = 0)
841 :param one_tag: (Default value = 0)
842 :param two_tags: (Default value = 0)
843 :param dot1ad: (Default value = 0)
844 :param exact_match: (Default value = 0)
845 :param default_sub: (Default value = 0)
846 :param outer_vlan_id_any: (Default value = 0)
847 :param inner_vlan_id_any: (Default value = 0)
851 self.papi.create_subif,
852 {'sw_if_index': sw_if_index,
856 'two_tags': two_tags,
858 'exact_match': exact_match,
859 'default_sub': default_sub,
860 'outer_vlan_id_any': outer_vlan_id_any,
861 'inner_vlan_id_any': inner_vlan_id_any,
862 'outer_vlan_id': outer_vlan,
863 'inner_vlan_id': inner_vlan})
865 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
866 """Create p2p ethernet subinterface
868 :param sw_if_index: main (parent) interface
869 :param remote_mac: client (remote) mac address
873 self.papi.p2p_ethernet_add,
874 {'parent_if_index': sw_if_index,
875 'remote_mac': remote_mac,
876 'subif_id': subif_id})
878 def delete_subif(self, sw_if_index):
879 """Delete subinterface
883 return self.api(self.papi.delete_subif,
884 {'sw_if_index': sw_if_index})
886 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
887 """Delete p2p ethernet subinterface
889 :param sw_if_index: main (parent) interface
890 :param remote_mac: client (remote) mac address
894 self.papi.p2p_ethernet_del,
895 {'parent_if_index': sw_if_index,
896 'remote_mac': remote_mac})
898 def create_vlan_subif(self, sw_if_index, vlan):
905 return self.api(self.papi.create_vlan_subif,
906 {'sw_if_index': sw_if_index,
909 def create_loopback(self, mac=''):
912 :param mac: (Optional)
914 return self.api(self.papi.create_loopback,
915 {'mac_address': mac})
917 def delete_loopback(self, sw_if_index):
918 return self.api(self.papi.delete_loopback,
919 {'sw_if_index': sw_if_index, })
921 def ip_table_add_del(self,
928 :param is_add: (Default value = 1)
929 :param is_ipv6: (Default value = 0)
934 self.papi.ip_table_add_del,
935 {'table_id': table_id,
939 def ip_add_del_route(
944 next_hop_sw_if_index=0xFFFFFFFF,
948 next_hop_n_out_labels=0,
949 next_hop_out_label_stack=[],
950 next_hop_via_label=MPLS_LABEL_INVALID,
951 next_hop_id=0xFFFFFFFF,
953 is_resolve_attached=0,
954 classify_table_index=0xFFFFFFFF,
968 :param dst_address_length:
969 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
971 :param next_hop_address:
972 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
973 :param vrf_id: (Default value = 0)
974 :param lookup_in_vrf: (Default value = 0)
975 :param classify_table_index: (Default value = 0xFFFFFFFF)
976 :param is_add: (Default value = 1)
977 :param is_drop: (Default value = 0)
978 :param is_ipv6: (Default value = 0)
979 :param is_local: (Default value = 0)
980 :param is_classify: (Default value = 0)
981 :param is_multipath: (Default value = 0)
982 :param is_resolve_host: (Default value = 0)
983 :param is_resolve_attached: (Default value = 0)
984 :param is_dvr: (Default value = 0)
985 :param is_source_lookup: (Default value = 0)
986 :param next_hop_weight: (Default value = 1)
991 self.papi.ip_add_del_route,
992 {'next_hop_sw_if_index': next_hop_sw_if_index,
993 'table_id': table_id,
994 'classify_table_index': classify_table_index,
995 'next_hop_table_id': next_hop_table_id,
998 'is_unreach': is_unreach,
999 'is_prohibit': is_prohibit,
1001 'is_local': is_local,
1002 'is_classify': is_classify,
1003 'is_multipath': is_multipath,
1004 'is_resolve_host': is_resolve_host,
1005 'is_resolve_attached': is_resolve_attached,
1007 'is_source_lookup': is_source_lookup,
1008 'is_udp_encap': is_udp_encap,
1009 'next_hop_weight': next_hop_weight,
1010 'dst_address_length': dst_address_length,
1011 'dst_address': dst_address,
1012 'next_hop_id': next_hop_id,
1013 'next_hop_address': next_hop_address,
1014 'next_hop_n_out_labels': next_hop_n_out_labels,
1015 'next_hop_via_label': next_hop_via_label,
1016 'next_hop_out_label_stack': next_hop_out_label_stack})
1018 def ip_fib_dump(self):
1019 return self.api(self.papi.ip_fib_dump, {})
1021 def ip6_fib_dump(self):
1022 return self.api(self.papi.ip6_fib_dump, {})
1024 def ip_neighbor_add_del(self,
1033 """ Add neighbor MAC to IPv4 or IPv6 address.
1038 :param is_add: (Default value = 1)
1039 :param is_ipv6: (Default value = 0)
1040 :param is_static: (Default value = 0)
1041 :param is_no_adj_fib: (Default value = 0)
1045 self.papi.ip_neighbor_add_del,
1046 {'sw_if_index': sw_if_index,
1049 'is_static': is_static,
1050 'is_no_adj_fib': is_no_adj_fib,
1051 'mac_address': mac_address,
1052 'dst_address': dst_address
1056 def ip_neighbor_dump(self,
1059 """ Return IP neighbor dump.
1062 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1066 self.papi.ip_neighbor_dump,
1067 {'is_ipv6': is_ipv6,
1068 'sw_if_index': sw_if_index
1072 def proxy_arp_add_del(self,
1077 """ Config Proxy Arp Range.
1079 :param low_address: Start address in the rnage to Proxy for
1080 :param hi_address: End address in the rnage to Proxy for
1081 :param vrf_id: The VRF/table in which to proxy
1085 self.papi.proxy_arp_add_del,
1089 'low_address': low_address,
1090 'hi_address': hi_address,
1094 def proxy_arp_intfc_enable_disable(self,
1097 """ Enable/Disable an interface for proxy ARP requests
1099 :param sw_if_index: Interface
1100 :param enable_disable: Enable/Disable
1104 self.papi.proxy_arp_intfc_enable_disable,
1105 {'sw_if_index': sw_if_index,
1106 'enable_disable': is_enable
1114 """ Reset VRF (remove all routes etc.) request.
1116 :param int vrf_id: ID of the FIB table / VRF to reset.
1117 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1121 self.papi.reset_vrf,
1131 """ Reset VRF (remove all routes etc.) request.
1133 :param int vrf_id: ID of the FIB table / VRF to reset.
1134 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1138 self.papi.reset_fib,
1149 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1154 {'is_ipv6': is_ipv6,
1158 def sw_interface_span_enable_disable(
1159 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1162 :param sw_if_index_from:
1163 :param sw_if_index_to:
1167 return self.api(self.papi.sw_interface_span_enable_disable,
1168 {'sw_if_index_from': sw_if_index_from,
1169 'sw_if_index_to': sw_if_index_to,
1174 def gre_tunnel_add_del(self,
1179 instance=0xFFFFFFFF,
1183 """ Add a GRE tunnel
1187 :param outer_fib_id: (Default value = 0)
1188 :param tunnel_type: (Default value = 0)
1189 :param instance: (Default value = 0xFFFFFFFF)
1190 :param session_id: (Defalt value = 0)
1191 :param is_add: (Default value = 1)
1192 :param is_ipv6: (Default value = 0)
1196 self.papi.gre_add_del_tunnel,
1199 'tunnel_type': tunnel_type,
1200 'instance': instance,
1201 'src_address': src_address,
1202 'dst_address': dst_address,
1203 'outer_fib_id': outer_fib_id,
1204 'session_id': session_id}
1207 def udp_encap_add(self,
1213 """ Add a GRE tunnel
1218 :param outer_fib_id: (Default value = 0)
1222 self.papi.udp_encap_add,
1227 'src_port': src_port,
1228 'dst_port': dst_port,
1229 'table_id': table_id
1233 def udp_encap_del(self, id):
1234 return self.api(self.papi.udp_encap_del, {'id': id})
1236 def udp_encap_dump(self):
1237 return self.api(self.papi.udp_encap_dump, {})
1239 def want_udp_encap_stats(self, enable=1):
1240 return self.api(self.papi.want_udp_encap_stats,
1242 'pid': os.getpid()})
1244 def mpls_fib_dump(self):
1245 return self.api(self.papi.mpls_fib_dump, {})
1247 def mpls_table_add_del(
1254 :param is_add: (Default value = 1)
1259 self.papi.mpls_table_add_del,
1260 {'mt_table_id': table_id,
1261 'mt_is_add': is_add})
1263 def mpls_route_add_del(
1269 next_hop_sw_if_index=0xFFFFFFFF,
1271 next_hop_table_id=0,
1273 next_hop_n_out_labels=0,
1274 next_hop_out_label_stack=[],
1275 next_hop_via_label=MPLS_LABEL_INVALID,
1277 is_resolve_attached=0,
1284 classify_table_index=0xFFFFFFFF,
1288 :param dst_address_length:
1289 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1291 :param next_hop_address:
1292 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1293 :param vrf_id: (Default value = 0)
1294 :param lookup_in_vrf: (Default value = 0)
1295 :param classify_table_index: (Default value = 0xFFFFFFFF)
1296 :param is_add: (Default value = 1)
1297 :param is_drop: (Default value = 0)
1298 :param is_ipv6: (Default value = 0)
1299 :param is_local: (Default value = 0)
1300 :param is_classify: (Default value = 0)
1301 :param is_multipath: (Default value = 0)
1302 :param is_multicast: (Default value = 0)
1303 :param is_resolve_host: (Default value = 0)
1304 :param is_resolve_attached: (Default value = 0)
1305 :param next_hop_weight: (Default value = 1)
1309 self.papi.mpls_route_add_del,
1312 'mr_table_id': table_id,
1313 'mr_classify_table_index': classify_table_index,
1314 'mr_is_add': is_add,
1315 'mr_is_classify': is_classify,
1316 'mr_is_multipath': is_multipath,
1317 'mr_is_multicast': is_multicast,
1318 'mr_is_resolve_host': is_resolve_host,
1319 'mr_is_resolve_attached': is_resolve_attached,
1320 'mr_is_interface_rx': is_interface_rx,
1321 'mr_is_rpf_id': is_rpf_id,
1322 'mr_next_hop_proto': next_hop_proto,
1323 'mr_next_hop_weight': next_hop_weight,
1324 'mr_next_hop': next_hop_address,
1325 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1326 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1327 'mr_next_hop_table_id': next_hop_table_id,
1328 'mr_next_hop_via_label': next_hop_via_label,
1329 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1331 def mpls_ip_bind_unbind(
1343 self.papi.mpls_ip_bind_unbind,
1344 {'mb_mpls_table_id': table_id,
1346 'mb_ip_table_id': ip_table_id,
1347 'mb_is_bind': is_bind,
1348 'mb_is_ip4': is_ip4,
1349 'mb_address_length': dst_address_length,
1350 'mb_address': dst_address})
1352 def mpls_tunnel_add_del(
1355 next_hop_proto_is_ip4,
1357 next_hop_sw_if_index=0xFFFFFFFF,
1358 next_hop_table_id=0,
1360 next_hop_n_out_labels=0,
1361 next_hop_out_label_stack=[],
1362 next_hop_via_label=MPLS_LABEL_INVALID,
1368 :param dst_address_length:
1369 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1371 :param next_hop_address:
1372 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1373 :param vrf_id: (Default value = 0)
1374 :param lookup_in_vrf: (Default value = 0)
1375 :param classify_table_index: (Default value = 0xFFFFFFFF)
1376 :param is_add: (Default value = 1)
1377 :param is_drop: (Default value = 0)
1378 :param is_ipv6: (Default value = 0)
1379 :param is_local: (Default value = 0)
1380 :param is_classify: (Default value = 0)
1381 :param is_multipath: (Default value = 0)
1382 :param is_resolve_host: (Default value = 0)
1383 :param is_resolve_attached: (Default value = 0)
1384 :param next_hop_weight: (Default value = 1)
1385 :param is_multicast: (Default value = 0)
1389 self.papi.mpls_tunnel_add_del,
1390 {'mt_sw_if_index': tun_sw_if_index,
1391 'mt_is_add': is_add,
1392 'mt_l2_only': l2_only,
1393 'mt_is_multicast': is_multicast,
1394 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1395 'mt_next_hop_weight': next_hop_weight,
1396 'mt_next_hop': next_hop_address,
1397 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1398 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1399 'mt_next_hop_table_id': next_hop_table_id,
1400 'mt_next_hop_via_label': next_hop_via_label,
1401 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1403 def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
1404 return self.api(self.papi.mpls_tunnel_dump,
1405 {'sw_if_index': sw_if_index})
1407 def nat44_interface_add_del_feature(
1412 """Enable/disable NAT44 feature on the interface
1414 :param sw_if_index: Software index of the interface
1415 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1416 :param is_add: 1 if add, 0 if delete (Default value = 1)
1419 self.papi.nat44_interface_add_del_feature,
1421 'is_inside': is_inside,
1422 'sw_if_index': sw_if_index})
1424 def nat44_interface_add_del_output_feature(
1429 """Enable/disable NAT44 output feature on the interface
1431 :param sw_if_index: Software index of the interface
1432 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1433 :param is_add: 1 if add, 0 if delete (Default value = 1)
1436 self.papi.nat44_interface_add_del_output_feature,
1438 'is_inside': is_inside,
1439 'sw_if_index': sw_if_index})
1441 def nat44_add_del_static_mapping(
1445 external_sw_if_index=0xFFFFFFFF,
1456 """Add/delete NAT44 static mapping
1458 :param local_ip: Local IP address
1459 :param external_ip: External IP address
1460 :param external_sw_if_index: External interface instead of IP address
1461 :param local_port: Local port number (Default value = 0)
1462 :param external_port: External port number (Default value = 0)
1463 :param addr_only: 1 if address only mapping, 0 if address and port
1464 :param vrf_id: VRF ID
1465 :param protocol: IP protocol (Default value = 0)
1466 :param twice_nat: 1 if translate external host address and port
1467 :param self_twice_nat: 1 if translate external host address and port
1468 whenever external host address equals
1469 local address of internal host
1470 :param out2in_only: if 1 rule is matching only out2in direction
1471 :param tag: Opaque string tag
1472 :param is_add: 1 if add, 0 if delete (Default value = 1)
1475 self.papi.nat44_add_del_static_mapping,
1477 'addr_only': addr_only,
1478 'local_ip_address': local_ip,
1479 'external_ip_address': external_ip,
1480 'local_port': local_port,
1481 'external_port': external_port,
1482 'external_sw_if_index': external_sw_if_index,
1484 'protocol': protocol,
1485 'twice_nat': twice_nat,
1486 'self_twice_nat': self_twice_nat,
1487 'out2in_only': out2in_only,
1490 def nat44_add_del_identity_mapping(
1493 sw_if_index=0xFFFFFFFF,
1500 """Add/delete NAT44 identity mapping
1502 :param ip: IP address (Default value = 0)
1503 :param sw_if_index: Interface instead of IP address
1504 :param port: Port number (Default value = 0)
1505 :param addr_only: 1 if address only mapping, 0 if address and port
1506 :param vrf_id: VRF ID
1507 :param protocol: IP protocol (Default value = 0)
1508 :param tag: Opaque string tag
1509 :param is_add: 1 if add, 0 if delete (Default value = 1)
1512 self.papi.nat44_add_del_identity_mapping,
1514 'addr_only': addr_only,
1517 'sw_if_index': sw_if_index,
1520 'protocol': protocol})
1522 def nat44_add_del_address_range(
1529 """Add/del NAT44 address range
1531 :param first_ip_address: First IP address
1532 :param last_ip_address: Last IP address
1533 :param vrf_id: VRF id for the address range
1534 :param twice_nat: twice NAT address for extenal hosts
1535 :param is_add: 1 if add, 0 if delete (Default value = 1)
1538 self.papi.nat44_add_del_address_range,
1539 {'first_ip_address': first_ip_address,
1540 'last_ip_address': last_ip_address,
1542 'twice_nat': twice_nat,
1545 def nat44_address_dump(self):
1546 """Dump NAT44 addresses
1547 :return: Dictionary of NAT44 addresses
1549 return self.api(self.papi.nat44_address_dump, {})
1551 def nat44_interface_dump(self):
1552 """Dump interfaces with NAT44 feature
1553 :return: Dictionary of interfaces with NAT44 feature
1555 return self.api(self.papi.nat44_interface_dump, {})
1557 def nat44_interface_output_feature_dump(self):
1558 """Dump interfaces with NAT44 output feature
1559 :return: Dictionary of interfaces with NAT44 output feature
1561 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1563 def nat44_static_mapping_dump(self):
1564 """Dump NAT44 static mappings
1565 :return: Dictionary of NAT44 static mappings
1567 return self.api(self.papi.nat44_static_mapping_dump, {})
1569 def nat44_identity_mapping_dump(self):
1570 """Dump NAT44 identity mappings
1571 :return: Dictionary of NAT44 identity mappings
1573 return self.api(self.papi.nat44_identity_mapping_dump, {})
1575 def nat_show_config(self):
1576 """Show NAT plugin config
1577 :return: NAT plugin config parameters
1579 return self.api(self.papi.nat_show_config, {})
1581 def nat44_add_interface_addr(
1586 """Add/del NAT44 address from interface
1588 :param sw_if_index: Software index of the interface
1589 :param twice_nat: twice NAT address for extenal hosts
1590 :param is_add: 1 if add, 0 if delete (Default value = 1)
1593 self.papi.nat44_add_del_interface_addr,
1595 'sw_if_index': sw_if_index,
1596 'twice_nat': twice_nat})
1598 def nat44_interface_addr_dump(self):
1599 """Dump NAT44 addresses interfaces
1600 :return: Dictionary of NAT44 addresses interfaces
1602 return self.api(self.papi.nat44_interface_addr_dump, {})
1609 """Enable/disable NAT IPFIX logging
1611 :param domain_id: Observation domain ID (Default value = 1)
1612 :param src_port: Source port number (Default value = 4739)
1613 :param enable: 1 if enable, 0 if disable (Default value = 1)
1616 self.papi.nat_ipfix_enable_disable,
1617 {'domain_id': domain_id,
1618 'src_port': src_port,
1621 def nat44_user_session_dump(
1625 """Dump NAT44 user's sessions
1627 :param ip_address: ip adress of the user to be dumped
1628 :param cpu_index: cpu_index on which the user is
1629 :param vrf_id: VRF ID
1630 :return: Dictionary of S-NAT sessions
1633 self.papi.nat44_user_session_dump,
1634 {'ip_address': ip_address,
1637 def nat44_user_dump(self):
1640 :return: Dictionary of NAT44 users
1642 return self.api(self.papi.nat44_user_dump, {})
1644 def nat44_add_del_lb_static_mapping(
1657 """Add/delete NAT44 load balancing static mapping
1659 :param twice_nat: 1 if translate external host address and port
1660 :param tag: Opaque string tag
1661 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1662 :param is_add - 1 if add, 0 if delete
1665 self.papi.nat44_add_del_lb_static_mapping,
1667 'external_addr': external_addr,
1668 'external_port': external_port,
1669 'protocol': protocol,
1670 'twice_nat': twice_nat,
1671 'self_twice_nat': self_twice_nat,
1672 'out2in_only': out2in_only,
1674 'affinity': affinity,
1675 'local_num': local_num,
1678 def nat44_lb_static_mapping_dump(self):
1679 """Dump NAT44 load balancing static mappings
1681 :return: Dictionary of NAT44 load balancing static mapping
1683 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1685 def nat44_del_session(
1692 ext_host_address=None,
1694 """Delete NAT44 session
1696 :param addr: IPv4 address
1697 :param por: port number
1698 :param protocol: IP protocol number
1699 :param vrf_id: VRF ID
1700 :param is_in: 1 if inside network addres and port pari, 0 if outside
1701 :param ext_host_address: external host IPv4 address
1702 :param ext_host_port: external host port
1704 if ext_host_address is None:
1706 self.papi.nat44_del_session,
1709 'protocol': protocol,
1714 self.papi.nat44_del_session,
1717 'protocol': protocol,
1720 'ext_host_valid': 1,
1721 'ext_host_address': ext_host_address,
1722 'ext_host_port': ext_host_port})
1724 def nat44_forwarding_enable_disable(
1727 """Enable/disable forwarding for NAT44
1729 :param enable: 1 for enable, 0 for disable
1732 self.papi.nat44_forwarding_enable_disable,
1742 """Set NAT virtual fragmentation reassembly
1744 :param timeout: reassembly timeout (Default 2sec)
1745 :param max_reass: maximum concurrent reassemblies (Default 1024)
1746 :param max_frag: maximum fragmets per reassembly (Default 5)
1747 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1748 :param is_ip6: 1 if IPv6, 0 if IPv4
1751 self.papi.nat_set_reass,
1752 {'timeout': timeout,
1753 'max_reass': max_reass,
1754 'max_frag': max_frag,
1755 'drop_frag': drop_frag,
1758 def nat_get_reass(self):
1759 """Get NAT virtual fragmentation reassembly configuration
1761 :return: NAT virtual fragmentation reassembly configuration
1763 return self.api(self.papi.nat_get_reass, {})
1765 def nat_reass_dump(self):
1766 """Dump NAT virtual fragmentation reassemblies
1768 :return: Dictionary of NAT virtual fragmentation reassemblies
1770 return self.api(self.papi.nat_reass_dump, {})
1772 def nat_det_add_del_map(
1779 """Add/delete deterministic NAT mapping
1781 :param is_add - 1 if add, 0 if delete
1782 :param in_addr - inside IP address
1783 :param in_plen - inside IP address prefix length
1784 :param out_addr - outside IP address
1785 :param out_plen - outside IP address prefix length
1788 self.papi.nat_det_add_del_map,
1793 'out_addr': out_addr,
1794 'out_plen': out_plen})
1796 def nat_det_forward(
1799 """Get outside address and port range from inside address
1801 :param in_addr - inside IP address
1804 self.papi.nat_det_forward,
1805 {'in_addr': in_addr,
1808 def nat_det_reverse(
1812 """Get inside address from outside address and port
1814 :param out_addr - outside IP address
1815 :param out_port - outside port
1818 self.papi.nat_det_reverse,
1819 {'out_addr': out_addr,
1820 'out_port': out_port})
1822 def nat_det_map_dump(self):
1823 """Dump deterministic NAT mappings
1825 :return: Dictionary of deterministic NAT mappings
1827 return self.api(self.papi.nat_det_map_dump, {})
1829 def nat_set_timeouts(
1832 tcp_established=7440,
1835 """Set values of timeouts for NAT sessions (in seconds)
1837 :param udp - UDP timeout (Default value = 300)
1838 :param tcp_established - TCP established timeout (Default value = 7440)
1839 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1840 :param icmp - ICMP timeout (Default value = 60)
1843 self.papi.nat_set_timeouts,
1845 'tcp_established': tcp_established,
1846 'tcp_transitory': tcp_transitory,
1849 def nat_get_timeouts(self):
1850 """Get values of timeouts for NAT sessions
1852 :return: Timeouts for NAT sessions (in seconds)
1854 return self.api(self.papi.nat_get_timeouts, {})
1856 def nat_set_addr_and_port_alloc_alg(
1864 """Set address and port assignment algorithm
1866 :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1867 :param psid_offset: number of offset bits (valid only for MAP-E alg)
1868 :param psid_length: length of PSID (valid only for MAP-E alg)
1869 :param psid: Port Set Identifier value (valid only for MAP-E alg)
1870 :param start_port: beginning of the port range
1871 :param end_port: end of the port range
1874 self.papi.nat_set_addr_and_port_alloc_alg,
1876 'psid_offset': psid_offset,
1877 'psid_length': psid_length,
1879 'start_port': start_port,
1880 'end_port': end_port})
1882 def nat_get_addr_and_port_alloc_alg(self):
1883 """Get address and port assignment algorithm"""
1884 return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1886 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1887 """Set TCP MSS rewriting configuration
1889 :param enable: disable(0)/enable(1) MSS rewriting feature
1890 :param mss_value: MSS value to be used for MSS rewriting
1893 self.papi.nat_set_mss_clamping,
1894 {'enable': enable, 'mss_value': mss_value})
1896 def nat_get_mss_clamping(self):
1897 """Get TCP MSS rewriting configuration"""
1898 return self.api(self.papi.nat_get_mss_clamping, {})
1900 def nat_det_close_session_out(
1906 """Close deterministic NAT session using outside address and port
1908 :param out_addr - outside IP address
1909 :param out_port - outside port
1910 :param ext_addr - external host IP address
1911 :param ext_port - external host port
1914 self.papi.nat_det_close_session_out,
1915 {'out_addr': out_addr,
1916 'out_port': out_port,
1917 'ext_addr': ext_addr,
1918 'ext_port': ext_port})
1920 def nat_det_close_session_in(
1926 """Close deterministic NAT session using inside address and port
1928 :param in_addr - inside IP address
1929 :param in_port - inside port
1930 :param ext_addr - external host IP address
1931 :param ext_port - external host port
1934 self.papi.nat_det_close_session_in,
1935 {'in_addr': in_addr,
1937 'ext_addr': ext_addr,
1938 'ext_port': ext_port,
1941 def nat_det_session_dump(
1944 """Dump deterministic NAT sessions belonging to a user
1946 :param user_addr - inside IP address of the user
1947 :return: Dictionary of deterministic NAT sessions
1950 self.papi.nat_det_session_dump,
1952 'user_addr': user_addr})
1954 def nat64_add_del_pool_addr_range(
1960 """Add/del address range to NAT64 pool
1962 :param start_addr: First IP address
1963 :param end_addr: Last IP address
1964 :param vrf_id: VRF id for the address range
1965 :param is_add: 1 if add, 0 if delete (Default value = 1)
1968 self.papi.nat64_add_del_pool_addr_range,
1969 {'start_addr': start_addr,
1970 'end_addr': end_addr,
1974 def nat64_pool_addr_dump(self):
1975 """Dump NAT64 pool addresses
1976 :return: Dictionary of NAT64 pool addresses
1978 return self.api(self.papi.nat64_pool_addr_dump, {})
1980 def nat64_add_del_interface(
1985 """Enable/disable NAT64 feature on the interface
1986 :param sw_if_index: Index of the interface
1987 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1988 :param is_add: 1 if add, 0 if delete (Default value = 1)
1991 self.papi.nat64_add_del_interface,
1992 {'sw_if_index': sw_if_index,
1993 'is_inside': is_inside,
1996 def nat64_interface_dump(self):
1997 """Dump interfaces with NAT64 feature
1998 :return: Dictionary of interfaces with NAT64 feature
2000 return self.api(self.papi.nat64_interface_dump, {})
2002 def nat64_add_del_static_bib(
2011 """Add/delete S-NAT static BIB entry
2013 :param in_ip: Inside IPv6 address
2014 :param out_ip: Outside IPv4 address
2015 :param in_port: Inside port number
2016 :param out_port: Outside port number
2017 :param protocol: IP protocol
2018 :param vrf_id: VRF ID (Default value = 0)
2019 :param is_add: 1 if add, 0 if delete (Default value = 1)
2022 self.papi.nat64_add_del_static_bib,
2031 def nat64_bib_dump(self, protocol=255):
2034 :param protocol: IP protocol (Default value = 255, all BIBs)
2035 :returns: Dictionary of NAT64 BIB entries
2037 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
2039 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
2040 tcp_incoming_syn=6):
2041 """Set values of timeouts for NAT64 (in seconds)
2043 :param udpi: UDP timeout (Default value = 300)
2044 :param icmp: ICMP timeout (Default value = 60)
2045 :param tcp_trans: TCP transitory timeout (Default value = 240)
2046 :param tcp_est: TCP established timeout (Default value = 7440)
2047 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
2050 self.papi.nat64_set_timeouts,
2053 'tcp_trans': tcp_trans,
2055 'tcp_incoming_syn': tcp_incoming_syn})
2057 def nat64_get_timeouts(self):
2058 """Get values of timeouts for NAT64
2060 :return: Timeouts for NAT64 (in seconds)
2062 return self.api(self.papi.nat64_get_timeouts, {})
2064 def nat64_st_dump(self, protocol=255):
2065 """Dump NAT64 session table
2067 :param protocol: IP protocol (Default value = 255, all STs)
2068 :returns: Dictionary of NAT64 sesstion table entries
2070 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2072 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2073 """Add/del NAT64 prefix
2075 :param prefix: NAT64 prefix
2076 :param plen: NAT64 prefix length
2077 :param vrf_id: VRF id of tenant (Default 0)
2078 :param is_add: 1 if add, 0 if delete (Default value = 1)
2081 self.papi.nat64_add_del_prefix,
2087 def nat64_prefix_dump(self):
2088 """Dump NAT64 prefix
2090 :returns: Dictionary of NAT64 prefixes
2092 return self.api(self.papi.nat64_prefix_dump, {})
2094 def nat64_add_interface_addr(
2098 """Add/del NAT64 address from interface
2100 :param sw_if_index: Software index of the interface
2101 :param is_add: 1 if add, 0 if delete (Default value = 1)
2103 return self.api(self.papi.nat64_add_del_interface_addr,
2104 {'is_add': is_add, 'sw_if_index': sw_if_index})
2106 def dslite_set_aftr_addr(self, ip6, ip4):
2107 """Set DS-Lite AFTR addresses
2109 :param ip4: IPv4 address
2110 :param ip6: IPv6 address
2113 self.papi.dslite_set_aftr_addr,
2117 def dslite_set_b4_addr(self, ip6, ip4):
2118 """Set DS-Lite B4 IPv6 address
2120 :param ip4: IPv4 address
2121 :param ip6: IPv6 address
2124 self.papi.dslite_set_b4_addr,
2128 def dslite_add_del_pool_addr_range(
2133 """Add/del address range to DS-Lite pool
2135 :param start_addr: First IP address
2136 :param end_addr: Last IP address
2137 :param is_add: 1 if add, 0 if delete (Default value = 1)
2140 self.papi.dslite_add_del_pool_addr_range,
2141 {'start_addr': start_addr,
2142 'end_addr': end_addr,
2145 def nat66_add_del_interface(
2150 """Enable/disable NAT66 feature on the interface
2151 :param sw_if_index: Index of the interface
2152 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2153 :param is_add: 1 if add, 0 if delete (Default value = 1)
2156 self.papi.nat66_add_del_interface,
2157 {'sw_if_index': sw_if_index,
2158 'is_inside': is_inside,
2161 def nat66_add_del_static_mapping(
2167 """Add/delete NAT66 static mapping
2169 :param in_ip: Inside IPv6 address
2170 :param out_ip: Outside IPv6 address
2171 :param vrf_id: VRF ID (Default value = 0)
2172 :param is_add: 1 if add, 0 if delete (Default value = 1)
2175 self.papi.nat66_add_del_static_mapping,
2176 {'local_ip_address': in_ip,
2177 'external_ip_address': out_ip,
2181 def nat66_interface_dump(self):
2182 """Dump interfaces with NAT66 feature
2183 :return: Dictionary of interfaces with NAT66 feature
2185 return self.api(self.papi.nat66_interface_dump, {})
2187 def nat66_static_mapping_dump(self):
2188 """Dump NAT66 static mappings
2189 :return: Dictionary of NAT66 static mappings
2191 return self.api(self.papi.nat66_static_mapping_dump, {})
2193 def control_ping(self):
2194 self.api(self.papi.control_ping)
2196 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2197 detect_mult, local_addr, peer_addr, is_ipv6=0,
2198 bfd_key_id=None, conf_key_id=None):
2199 if bfd_key_id is None:
2200 return self.api(self.papi.bfd_udp_add,
2202 'sw_if_index': sw_if_index,
2203 'desired_min_tx': desired_min_tx,
2204 'required_min_rx': required_min_rx,
2205 'local_addr': local_addr,
2206 'peer_addr': peer_addr,
2208 'detect_mult': detect_mult,
2211 return self.api(self.papi.bfd_udp_add,
2213 'sw_if_index': sw_if_index,
2214 'desired_min_tx': desired_min_tx,
2215 'required_min_rx': required_min_rx,
2216 'local_addr': local_addr,
2217 'peer_addr': peer_addr,
2219 'detect_mult': detect_mult,
2220 'is_authenticated': 1,
2221 'bfd_key_id': bfd_key_id,
2222 'conf_key_id': conf_key_id,
2225 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2226 detect_mult, local_addr, peer_addr, is_ipv6=0):
2227 return self.api(self.papi.bfd_udp_mod,
2229 'sw_if_index': sw_if_index,
2230 'desired_min_tx': desired_min_tx,
2231 'required_min_rx': required_min_rx,
2232 'local_addr': local_addr,
2233 'peer_addr': peer_addr,
2235 'detect_mult': detect_mult,
2238 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2239 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2241 return self.api(self.papi.bfd_udp_auth_activate,
2243 'sw_if_index': sw_if_index,
2244 'local_addr': local_addr,
2245 'peer_addr': peer_addr,
2247 'is_delayed': 1 if is_delayed else 0,
2248 'bfd_key_id': bfd_key_id,
2249 'conf_key_id': conf_key_id,
2252 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2253 is_ipv6=0, is_delayed=False):
2254 return self.api(self.papi.bfd_udp_auth_deactivate,
2256 'sw_if_index': sw_if_index,
2257 'local_addr': local_addr,
2258 'peer_addr': peer_addr,
2260 'is_delayed': 1 if is_delayed else 0,
2263 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2264 return self.api(self.papi.bfd_udp_del,
2266 'sw_if_index': sw_if_index,
2267 'local_addr': local_addr,
2268 'peer_addr': peer_addr,
2272 def bfd_udp_session_dump(self):
2273 return self.api(self.papi.bfd_udp_session_dump, {})
2275 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2276 peer_addr, is_ipv6=0):
2277 return self.api(self.papi.bfd_udp_session_set_flags, {
2278 'admin_up_down': admin_up_down,
2279 'sw_if_index': sw_if_index,
2280 'local_addr': local_addr,
2281 'peer_addr': peer_addr,
2285 def want_bfd_events(self, enable_disable=1):
2286 return self.api(self.papi.want_bfd_events, {
2287 'enable_disable': enable_disable,
2291 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2292 return self.api(self.papi.bfd_auth_set_key, {
2293 'conf_key_id': conf_key_id,
2294 'auth_type': auth_type,
2296 'key_len': len(key),
2299 def bfd_auth_del_key(self, conf_key_id):
2300 return self.api(self.papi.bfd_auth_del_key, {
2301 'conf_key_id': conf_key_id,
2304 def bfd_auth_keys_dump(self):
2305 return self.api(self.papi.bfd_auth_keys_dump, {})
2307 def bfd_udp_set_echo_source(self, sw_if_index):
2308 return self.api(self.papi.bfd_udp_set_echo_source,
2309 {'sw_if_index': sw_if_index})
2311 def bfd_udp_del_echo_source(self):
2312 return self.api(self.papi.bfd_udp_del_echo_source, {})
2314 def bfd_udp_get_echo_source(self):
2315 return self.api(self.papi.bfd_udp_get_echo_source, {})
2317 def classify_add_del_table(
2322 table_index=0xFFFFFFFF,
2324 memory_size=2097152,
2326 next_table_index=0xFFFFFFFF,
2327 miss_next_index=0xFFFFFFFF,
2328 current_data_flag=0,
2329 current_data_offset=0):
2333 :param match_n_vectors: (Default value = 1)
2334 :param table_index: (Default value = 0xFFFFFFFF)
2335 :param nbuckets: (Default value = 2)
2336 :param memory_size: (Default value = 2097152)
2337 :param skip_n_vectors: (Default value = 0)
2338 :param next_table_index: (Default value = 0xFFFFFFFF)
2339 :param miss_next_index: (Default value = 0xFFFFFFFF)
2340 :param current_data_flag: (Default value = 0)
2341 :param current_data_offset: (Default value = 0)
2344 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2345 mask = mask + '\0' * (mask_len - len(mask))
2347 self.papi.classify_add_del_table,
2349 'table_index': table_index,
2350 'nbuckets': nbuckets,
2351 'memory_size': memory_size,
2352 'skip_n_vectors': skip_n_vectors,
2353 'match_n_vectors': match_n_vectors,
2354 'next_table_index': next_table_index,
2355 'miss_next_index': miss_next_index,
2356 'current_data_flag': current_data_flag,
2357 'current_data_offset': current_data_offset,
2358 'mask_len': mask_len,
2361 def classify_add_del_session(
2366 opaque_index=0xFFFFFFFF,
2367 hit_next_index=0xFFFFFFFF,
2375 :param opaque_index: (Default value = 0xFFFFFFFF)
2376 :param hit_next_index: (Default value = 0xFFFFFFFF)
2377 :param advance: (Default value = 0)
2378 :param action: (Default value = 0)
2379 :param metadata: (Default value = 0)
2382 match_len = ((len(match) - 1) / 16 + 1) * 16
2383 match = match + '\0' * (match_len - len(match))
2385 self.papi.classify_add_del_session,
2387 'table_index': table_index,
2388 'hit_next_index': hit_next_index,
2389 'opaque_index': opaque_index,
2392 'metadata': metadata,
2393 'match_len': match_len,
2396 def input_acl_set_interface(
2400 ip4_table_index=0xFFFFFFFF,
2401 ip6_table_index=0xFFFFFFFF,
2402 l2_table_index=0xFFFFFFFF):
2406 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2407 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2408 :param l2_table_index: (Default value = 0xFFFFFFFF)
2412 self.papi.input_acl_set_interface,
2413 {'sw_if_index': sw_if_index,
2414 'ip4_table_index': ip4_table_index,
2415 'ip6_table_index': ip6_table_index,
2416 'l2_table_index': l2_table_index,
2419 def output_acl_set_interface(
2423 ip4_table_index=0xFFFFFFFF,
2424 ip6_table_index=0xFFFFFFFF,
2425 l2_table_index=0xFFFFFFFF):
2429 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2430 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2431 :param l2_table_index: (Default value = 0xFFFFFFFF)
2435 self.papi.output_acl_set_interface,
2436 {'sw_if_index': sw_if_index,
2437 'ip4_table_index': ip4_table_index,
2438 'ip6_table_index': ip6_table_index,
2439 'l2_table_index': l2_table_index,
2442 def set_ipfix_exporter(
2449 collector_port=4739,
2452 self.papi.set_ipfix_exporter,
2454 'collector_address': collector_address,
2455 'collector_port': collector_port,
2456 'src_address': src_address,
2458 'path_mtu': path_mtu,
2459 'template_interval': template_interval,
2460 'udp_checksum': udp_checksum,
2463 def dhcp_proxy_config(self,
2471 self.papi.dhcp_proxy_config,
2473 'rx_vrf_id': rx_table_id,
2474 'server_vrf_id': server_table_id,
2477 'dhcp_server': dhcp_server,
2478 'dhcp_src_address': dhcp_src_address,
2481 def dhcp_proxy_set_vss(self,
2490 self.papi.dhcp_proxy_set_vss,
2493 'vss_type': vss_type,
2494 'vpn_ascii_id': vpn_ascii_id,
2496 'vpn_index': vpn_index,
2501 def dhcp_client_dump(self):
2502 return self.api(self.papi.dhcp_client_dump, {})
2504 def dhcp_client(self,
2509 set_broadcast_flag=1,
2510 want_dhcp_events=0):
2512 self.papi.dhcp_client_config,
2516 'sw_if_index': sw_if_index,
2517 'hostname': hostname,
2519 'want_dhcp_event': want_dhcp_events,
2520 'set_broadcast_flag': set_broadcast_flag,
2524 def ip_mroute_add_del(self,
2530 next_hop_sw_if_index,
2540 IP Multicast Route add/del
2543 self.papi.ip_mroute_add_del,
2544 {'next_hop_sw_if_index': next_hop_sw_if_index,
2545 'entry_flags': e_flags,
2546 'itf_flags': i_flags,
2547 'table_id': table_id,
2551 'is_local': is_local,
2552 'bier_imp': bier_imp,
2553 'next_hop_afi': next_hop_afi,
2554 'grp_address_length': grp_address_length,
2555 'grp_address': grp_address,
2556 'src_address': src_address,
2557 'nh_address': next_hop_address})
2559 def mfib_signal_dump(self):
2560 return self.api(self.papi.mfib_signal_dump, {})
2562 def ip_mfib_dump(self):
2563 return self.api(self.papi.ip_mfib_dump, {})
2565 def ip6_mfib_dump(self):
2566 return self.api(self.papi.ip6_mfib_dump, {})
2568 def lisp_enable_disable(self, is_enabled):
2570 self.papi.lisp_enable_disable,
2572 'is_en': is_enabled,
2575 def lisp_locator_set(self,
2579 self.papi.lisp_add_del_locator_set,
2582 'locator_set_name': ls_name
2585 def lisp_locator_set_dump(self):
2586 return self.api(self.papi.lisp_locator_set_dump, {})
2588 def lisp_locator(self,
2595 self.papi.lisp_add_del_locator,
2598 'locator_set_name': ls_name,
2599 'sw_if_index': sw_if_index,
2600 'priority': priority,
2604 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2606 self.papi.lisp_locator_dump,
2608 'is_index_set': is_index_set,
2610 'ls_index': ls_index,
2613 def lisp_local_mapping(self,
2623 self.papi.lisp_add_del_local_eid,
2625 'locator_set_name': ls_name,
2627 'eid_type': eid_type,
2629 'prefix_len': prefix_len,
2635 def lisp_eid_table_dump(self,
2643 self.papi.lisp_eid_table_dump,
2646 'prefix_length': prefix_length,
2648 'eid_type': eid_type,
2650 'filter': filter_opt,
2653 def lisp_remote_mapping(self,
2663 self.papi.lisp_add_del_remote_mapping,
2666 'eid_type': eid_type,
2668 'eid_len': eid_prefix_len,
2669 'rloc_num': rlocs_num,
2672 'is_src_dst': is_src_dst,
2675 def lisp_adjacency(self,
2684 self.papi.lisp_add_del_adjacency,
2688 'eid_type': eid_type,
2691 'leid_len': leid_len,
2692 'reid_len': reid_len,
2695 def lisp_adjacencies_get(self, vni=0):
2697 self.papi.lisp_adjacencies_get,
2702 def map_add_domain(self,
2713 self.papi.map_add_domain,
2715 'ip6_prefix': ip6_prefix,
2716 'ip4_prefix': ip4_prefix,
2718 'ea_bits_len': ea_bits_len,
2719 'psid_offset': psid_offset,
2720 'psid_length': psid_length,
2721 'is_translation': is_translation,
2722 'is_rfc6052': is_rfc6052,
2726 def gtpu_add_del_tunnel(
2732 mcast_sw_if_index=0xFFFFFFFF,
2734 decap_next_index=0xFFFFFFFF,
2738 :param is_add: (Default value = 1)
2739 :param is_ipv6: (Default value = 0)
2742 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2743 :param encap_vrf_id: (Default value = 0)
2744 :param decap_next_index: (Default value = 0xFFFFFFFF)
2745 :param teid: (Default value = 0)
2748 return self.api(self.papi.gtpu_add_del_tunnel,
2751 'src_address': src_addr,
2752 'dst_address': dst_addr,
2753 'mcast_sw_if_index': mcast_sw_if_index,
2754 'encap_vrf_id': encap_vrf_id,
2755 'decap_next_index': decap_next_index,
2758 def vxlan_gpe_add_del_tunnel(
2762 mcast_sw_if_index=0xFFFFFFFF,
2773 :param is_add: (Default value = 1)
2774 :param is_ipv6: (Default value = 0)
2775 :param encap_vrf_id: (Default value = 0)
2776 :param decap_vrf_id: (Default value = 0)
2777 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2778 :param protocol: (Default value = 3)
2779 :param vni: (Default value = 0)
2782 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2787 'mcast_sw_if_index': mcast_sw_if_index,
2788 'encap_vrf_id': encap_vrf_id,
2789 'decap_vrf_id': decap_vrf_id,
2790 'protocol': protocol,
2793 def vxlan_gbp_tunnel_add_del(
2797 mcast_sw_if_index=0xFFFFFFFF,
2802 instance=0xFFFFFFFF):
2807 :param is_add: (Default value = 1)
2808 :param is_ipv6: (Default value = 0)
2809 :param encap_table_id: (Default value = 0)
2810 :param decap_next_index: (Default value = 0xFFFFFFFF)
2811 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2812 :param vni: (Default value = 0)
2813 :param instance: (Default value = 0xFFFFFFFF)
2816 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2821 'mcast_sw_if_index': mcast_sw_if_index,
2822 'encap_table_id': encap_table_id,
2824 'instance': instance}})
2826 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2827 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2828 {'sw_if_index': sw_if_index})
2830 def pppoe_add_del_session(
2840 :param is_add: (Default value = 1)
2841 :param is_ipv6: (Default value = 0)
2843 :param session_id: (Default value = 0)
2845 :param decap_vrf_id: (Default value = 0)
2848 return self.api(self.papi.pppoe_add_del_session,
2851 'session_id': session_id,
2852 'client_ip': client_ip,
2853 'decap_vrf_id': decap_vrf_id,
2854 'client_mac': client_mac})
2856 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2857 return self.api(self.papi.sr_mpls_policy_add,
2861 'n_segments': len(segments),
2862 'segments': segments})
2864 def sr_mpls_policy_del(self, bsid):
2865 return self.api(self.papi.sr_mpls_policy_del,
2868 def sr_localsid_add_del(self,
2875 sw_if_index=0xFFFFFFFF,
2879 """ Add/del IPv6 SR local-SID.
2882 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2883 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2886 :param is_del: (Default value = 0)
2887 :param end_psp: (Default value = 0)
2888 :param sw_if_index: (Default value = 0xFFFFFFFF)
2889 :param vlan_index: (Default value = 0)
2890 :param fib_table: (Default value = 0)
2893 self.papi.sr_localsid_add_del,
2895 'localsid': localsid,
2897 'behavior': behavior,
2898 'sw_if_index': sw_if_index,
2899 'vlan_index': vlan_index,
2900 'fib_table': fib_table,
2901 'nh_addr4': nh_addr4,
2902 'nh_addr6': nh_addr6
2916 :param bsid_addr: bindingSID of the SR Policy
2917 :param weight: weight of the sid list. optional. (default: 1)
2918 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2920 :param type: type/behavior of the SR policy. (default or spray) \
2922 :param fib_table: VRF where to install the FIB entry for the BSID \
2924 :param n_segments: number of segments \
2926 :param segments: a vector of IPv6 address composing the segment list \
2930 self.papi.sr_policy_add,
2931 {'bsid_addr': bsid_addr,
2933 'is_encap': is_encap,
2935 'fib_table': fib_table,
2936 'n_segments': n_segments,
2937 'segments': segments
2946 :param bsid: bindingSID of the SR Policy
2947 :param sr_policy_index: index of the sr policy (default: 0)
2950 self.papi.sr_policy_del,
2951 {'bsid_addr': bsid_addr,
2952 'sr_policy_index': sr_policy_index
2955 def sr_steering_add_del(
2966 Steer traffic L2 and L3 traffic through a given SR policy
2968 :param is_del: delete or add
2969 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2970 :param sr_policy: is the index of the SR Policy (alt to bsid)
2971 :param table_id: is the VRF where to install the FIB entry for the BSID
2972 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2973 :param mask_width: is the mask for L3 traffic type
2974 :param sw_if_index: is the incoming interface for L2 traffic
2975 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2978 self.papi.sr_steering_add_del,
2980 'bsid_addr': bsid_addr,
2981 'sr_policy_index': sr_policy_index,
2982 'table_id': table_id,
2983 'prefix_addr': prefix_addr,
2984 'mask_width': mask_width,
2985 'sw_if_index': sw_if_index,
2986 'traffic_type': traffic_type
2989 def acl_add_replace(self, acl_index, r, tag='',
2991 """Add/replace an ACL
2992 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2993 :param acl_rule r: ACL rules array.
2994 :param str tag: symbolic tag (description) for this ACL.
2995 :param int count: number of rules.
2997 return self.api(self.papi.acl_add_replace,
2998 {'acl_index': acl_index,
3002 expected_retval=expected_retval)
3004 def acl_del(self, acl_index, expected_retval=0):
3010 return self.api(self.papi.acl_del,
3011 {'acl_index': acl_index},
3012 expected_retval=expected_retval)
3014 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
3016 return self.api(self.papi.acl_interface_set_acl_list,
3017 {'sw_if_index': sw_if_index,
3021 expected_retval=expected_retval)
3023 def acl_interface_set_etype_whitelist(self, sw_if_index,
3026 return self.api(self.papi.acl_interface_set_etype_whitelist,
3027 {'sw_if_index': sw_if_index,
3028 'count': len(whitelist),
3030 'whitelist': whitelist},
3031 expected_retval=expected_retval)
3033 def acl_interface_add_del(self,
3037 """ Add/Delete ACL to/from interface
3041 :param is_add: (Default value = 1)
3044 return self.api(self.papi.acl_interface_add_del,
3047 'sw_if_index': sw_if_index,
3048 'acl_index': acl_index})
3050 def acl_dump(self, acl_index, expected_retval=0):
3051 return self.api(self.papi.acl_dump,
3052 {'acl_index': acl_index},
3053 expected_retval=expected_retval)
3055 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3057 return self.api(self.papi.acl_interface_list_dump,
3058 {'sw_if_index': sw_if_index},
3059 expected_retval=expected_retval)
3061 def macip_acl_add(self, rules, tag=""):
3064 :param rules: list of rules for given acl
3068 return self.api(self.papi.macip_acl_add,
3070 'count': len(rules),
3073 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3076 :param rules: list of rules for given acl
3080 return self.api(self.papi.macip_acl_add_replace,
3081 {'acl_index': acl_index,
3083 'count': len(rules),
3086 def macip_acl_del(self, acl_index):
3092 return self.api(self.papi.macip_acl_del,
3093 {'acl_index': acl_index})
3095 def macip_acl_interface_add_del(self,
3099 """ Add MACIP acl to interface
3103 :param is_add: (Default value = 1)
3106 return self.api(self.papi.macip_acl_interface_add_del,
3108 'sw_if_index': sw_if_index,
3109 'acl_index': acl_index})
3111 def macip_acl_interface_get(self):
3112 """ Return interface acls dump
3115 self.papi.macip_acl_interface_get, {})
3117 def macip_acl_dump(self, acl_index=4294967295):
3118 """ Return MACIP acl dump
3122 self.papi.macip_acl_dump, {'acl_index': acl_index})
3124 def policer_add_del(self,
3135 conform_action_type=1,
3137 exceed_action_type=0,
3139 violate_action_type=0,
3141 return self.api(self.papi.policer_add_del,
3148 'rate_type': rate_type,
3149 'round_type': round_type,
3151 'color_aware': color_aware,
3152 'conform_action_type': conform_action_type,
3153 'conform_dscp': conform_dscp,
3154 'exceed_action_type': exceed_action_type,
3155 'exceed_dscp': exceed_dscp,
3156 'violate_action_type': violate_action_type,
3157 'violate_dscp': violate_dscp})
3159 def ip_punt_police(self,
3163 return self.api(self.papi.ip_punt_police,
3164 {'policer_index': policer_index,
3168 def ip_punt_redirect(self,
3174 return self.api(self.papi.ip_punt_redirect,
3175 {'rx_sw_if_index': rx_sw_if_index,
3176 'tx_sw_if_index': tx_sw_if_index,
3181 def bier_table_add_del(self,
3185 """ BIER Table add/del """
3187 self.papi.bier_table_add_del,
3188 {'bt_tbl_id': {"bt_set": bti.set_id,
3189 "bt_sub_domain": bti.sub_domain_id,
3190 "bt_hdr_len_id": bti.hdr_len_id},
3191 'bt_label': mpls_label,
3192 'bt_is_add': is_add})
3194 def bier_table_dump(self):
3195 return self.api(self.papi.bier_table_dump, {})
3197 def bier_route_add_del(self,
3203 """ BIER Route add/del """
3205 self.papi.bier_route_add_del,
3206 {'br_tbl_id': {"bt_set": bti.set_id,
3207 "bt_sub_domain": bti.sub_domain_id,
3208 "bt_hdr_len_id": bti.hdr_len_id},
3210 'br_n_paths': len(paths),
3212 'br_is_add': is_add,
3213 'br_is_replace': is_replace})
3215 def bier_route_dump(self, bti):
3217 self.papi.bier_route_dump,
3218 {'br_tbl_id': {"bt_set": bti.set_id,
3219 "bt_sub_domain": bti.sub_domain_id,
3220 "bt_hdr_len_id": bti.hdr_len_id}})
3222 def bier_imp_add(self,
3227 """ BIER Imposition Add """
3229 self.papi.bier_imp_add,
3230 {'bi_tbl_id': {"bt_set": bti.set_id,
3231 "bt_sub_domain": bti.sub_domain_id,
3232 "bt_hdr_len_id": bti.hdr_len_id},
3234 'bi_n_bytes': len(ibytes),
3235 'bi_bytes': ibytes})
3237 def bier_imp_del(self, bi_index):
3238 """ BIER Imposition del """
3240 self.papi.bier_imp_del,
3241 {'bi_index': bi_index})
3243 def bier_imp_dump(self):
3244 return self.api(self.papi.bier_imp_dump, {})
3246 def bier_disp_table_add_del(self,
3249 """ BIER Disposition Table add/del """
3251 self.papi.bier_disp_table_add_del,
3252 {'bdt_tbl_id': bdti,
3253 'bdt_is_add': is_add})
3255 def bier_disp_table_dump(self):
3256 return self.api(self.papi.bier_disp_table_dump, {})
3258 def bier_disp_entry_add_del(self,
3268 """ BIER Route add/del """
3270 while (len(lstack) < 16):
3273 self.papi.bier_disp_entry_add_del,
3274 {'bde_tbl_id': bdti,
3276 'bde_payload_proto': payload_proto,
3278 'bde_paths': [{'next_hop': next_hop,
3279 'table_id': next_hop_tbl_id,
3280 'afi': next_hop_afi,
3281 'rpf_id': next_hop_rpf_id,
3283 'label_stack': lstack}],
3284 'bde_is_add': is_add})
3286 def bier_disp_entry_dump(self, bdti):
3288 self.papi.bier_disp_entry_dump,
3289 {'bde_tbl_id': bdti})
3291 def add_node_next(self, node_name, next_name):
3292 """ Set the next node for a given node request
3297 return self.api(self.papi.add_node_next,
3298 {'node_name': node_name,
3299 'next_name': next_name})
3301 def session_enable_disable(self, is_enabled):
3303 self.papi.session_enable_disable,
3304 {'is_enable': is_enabled})
3306 def ipsec_spd_add_del(self, spd_id, is_add=1):
3307 """ SPD add/del - Wrapper to add or del ipsec SPD
3308 Sample CLI : 'ipsec spd add 1'
3310 :param spd_id - SPD ID to be created in the vpp . mandatory
3311 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3313 :returns: reply from the API
3316 self.papi.ipsec_spd_add_del, {
3317 'spd_id': spd_id, 'is_add': is_add})
3319 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3320 """ IPSEC interface SPD add/del - \
3321 Wrapper to associate/disassociate SPD to interface in VPP
3322 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3324 :param spd_id - SPD ID to associate with the interface . mandatory
3325 :param sw_if_index - Interface Index which needs to ipsec \
3326 association mandatory
3327 :param is_add - add(1) or del(0) association with interface \
3328 (Default 1 - add) . optional
3329 :returns: reply from the API
3332 self.papi.ipsec_interface_add_del_spd,
3333 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3335 def ipsec_sad_add_del_entry(self,
3338 integrity_algorithm,
3343 tunnel_src_address='',
3344 tunnel_dst_address='',
3349 """ IPSEC SA add/del
3350 :param sad_id: security association ID
3351 :param spi: security param index of the SA in decimal
3352 :param integrity_algorithm:
3353 :param integrity_key:
3354 :param crypto_algorithm:
3356 :param protocol: AH(0) or ESP(1) protocol
3357 :param tunnel_src_address: tunnel mode outer src address
3358 :param tunnel_dst_address: tunnel mode outer dst address
3361 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3362 crypto and ipsec algorithms
3365 self.papi.ipsec_sad_add_del_entry,
3368 'tunnel_src_address': tunnel_src_address,
3369 'tunnel_dst_address': tunnel_dst_address,
3370 'protocol': protocol,
3371 'integrity_algorithm': integrity_algorithm,
3372 'integrity_key_length': len(integrity_key),
3373 'integrity_key': integrity_key,
3374 'crypto_algorithm': crypto_algorithm,
3375 'crypto_key_length': len(crypto_key) if crypto_key is not None
3377 'crypto_key': crypto_key,
3379 'is_tunnel': is_tunnel,
3380 'is_tunnel_ipv6': is_tunnel_ipv6,
3381 'udp_encap': udp_encap})
3383 def ipsec_spd_add_del_entry(self,
3386 local_address_start,
3388 remote_address_start,
3389 remote_address_stop,
3391 local_port_stop=65535,
3392 remote_port_start=0,
3393 remote_port_stop=65535,
3401 """ IPSEC policy SPD add/del -
3402 Wrapper to configure ipsec SPD policy entries in VPP
3403 :param spd_id: SPD ID for the policy
3404 :param local_address_start: local-ip-range start address
3405 :param local_address_stop : local-ip-range stop address
3406 :param remote_address_start: remote-ip-range start address
3407 :param remote_address_stop : remote-ip-range stop address
3408 :param local_port_start: (Default value = 0)
3409 :param local_port_stop: (Default value = 65535)
3410 :param remote_port_start: (Default value = 0)
3411 :param remote_port_stop: (Default value = 65535)
3412 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3413 :param sa_id: Security Association ID for mapping it to SPD
3414 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3416 :param priority: value for the spd action (Default value = 100)
3417 :param is_outbound: flag for inbound(0) or outbound(1)
3419 :param is_add: (Default value = 1)
3422 self.papi.ipsec_spd_add_del_entry,
3425 'local_address_start': local_address_start,
3426 'local_address_stop': local_address_stop,
3427 'remote_address_start': remote_address_start,
3428 'remote_address_stop': remote_address_stop,
3429 'local_port_start': local_port_start,
3430 'local_port_stop': local_port_stop,
3431 'remote_port_start': remote_port_start,
3432 'remote_port_stop': remote_port_stop,
3434 'protocol': protocol,
3436 'priority': priority,
3437 'is_outbound': is_outbound,
3439 'is_ip_any': is_ip_any})
3441 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3442 remote_spi, crypto_alg, local_crypto_key,
3443 remote_crypto_key, integ_alg, local_integ_key,
3444 remote_integ_key, is_add=1, esn=0,
3445 anti_replay=1, renumber=0, show_instance=0):
3447 self.papi.ipsec_tunnel_if_add_del,
3448 {'local_ip': local_ip, 'remote_ip': remote_ip,
3449 'local_spi': local_spi, 'remote_spi': remote_spi,
3450 'crypto_alg': crypto_alg,
3451 'local_crypto_key_len': len(local_crypto_key),
3452 'local_crypto_key': local_crypto_key,
3453 'remote_crypto_key_len': len(remote_crypto_key),
3454 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3455 'local_integ_key_len': len(local_integ_key),
3456 'local_integ_key': local_integ_key,
3457 'remote_integ_key_len': len(remote_integ_key),
3458 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3459 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3460 'show_instance': show_instance
3463 def ipsec_select_backend(self, protocol, index):
3464 return self.api(self.papi.ipsec_select_backend,
3465 {'protocol': protocol, 'index': index})
3467 def ipsec_backend_dump(self):
3468 return self.api(self.papi.ipsec_backend_dump, {})
3470 def app_namespace_add(self,
3474 sw_if_index=0xFFFFFFFF,
3477 self.papi.app_namespace_add_del,
3479 'sw_if_index': sw_if_index,
3480 'ip4_fib_id': ip4_fib_id,
3481 'ip6_fib_id': ip6_fib_id,
3482 'namespace_id': namespace_id,
3483 'namespace_id_len': len(namespace_id)})
3485 def punt_socket_register(self, l4_port, pathname, header_version=1,
3486 is_ip4=1, l4_protocol=0x11):
3487 """ Punt to socket """
3488 return self.api(self.papi.punt_socket_register,
3490 'l4_protocol': l4_protocol,
3492 'pathname': pathname,
3493 'header_version': header_version})
3495 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3496 expire_walk_interval_ms, is_ip6=0):
3497 """ Set IP reassembly parameters """
3498 return self.api(self.papi.ip_reassembly_set,
3500 'timeout_ms': timeout_ms,
3501 'expire_walk_interval_ms': expire_walk_interval_ms,
3502 'max_reassemblies': max_reassemblies})
3504 def ip_reassembly_get(self, is_ip6=0):
3505 """ Get IP reassembly parameters """
3506 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3508 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3510 """ Enable/disable IP reassembly """
3511 return self.api(self.papi.ip_reassembly_enable_disable,
3512 {'sw_if_index': sw_if_index,
3513 'enable_ip4': 1 if enable_ip4 else 0,
3514 'enable_ip6': 1 if enable_ip6 else 0,
3517 def gbp_endpoint_add(self, sw_if_index, ips, mac, epg, flags,
3519 """ GBP endpoint Add """
3520 return self.api(self.papi.gbp_endpoint_add,
3522 'sw_if_index': sw_if_index,
3534 def gbp_endpoint_del(self, handle):
3535 """ GBP endpoint Del """
3536 return self.api(self.papi.gbp_endpoint_del,
3539 def gbp_endpoint_dump(self):
3540 """ GBP endpoint Dump """
3541 return self.api(self.papi.gbp_endpoint_dump, {})
3543 def gbp_endpoint_group_add(self, epg, bd,
3544 rd, uplink_sw_if_index):
3545 """ GBP endpoint group Add """
3546 return self.api(self.papi.gbp_endpoint_group_add,
3549 'uplink_sw_if_index': uplink_sw_if_index,
3555 def gbp_endpoint_group_del(self, epg):
3556 """ GBP endpoint group Del """
3557 return self.api(self.papi.gbp_endpoint_group_del,
3560 def gbp_endpoint_group_dump(self):
3561 """ GBP endpoint group Dump """
3562 return self.api(self.papi.gbp_endpoint_group_dump, {})
3564 def gbp_bridge_domain_add(self, bd_id, flags,
3566 uu_fwd_sw_if_index):
3567 """ GBP bridge-domain Add """
3568 return self.api(self.papi.gbp_bridge_domain_add,
3572 'bvi_sw_if_index': bvi_sw_if_index,
3573 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
3577 def gbp_bridge_domain_del(self, bd_id):
3578 """ GBP bridge-domain Del """
3579 return self.api(self.papi.gbp_bridge_domain_del,
3582 def gbp_bridge_domain_dump(self):
3583 """ GBP Bridge Domain Dump """
3584 return self.api(self.papi.gbp_bridge_domain_dump, {})
3586 def gbp_route_domain_add(self, rd_id,
3590 ip6_uu_sw_if_index):
3591 """ GBP route-domain Add """
3592 return self.api(self.papi.gbp_route_domain_add,
3595 'ip4_table_id': ip4_table_id,
3596 'ip6_table_id': ip6_table_id,
3597 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
3598 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
3602 def gbp_route_domain_del(self, rd_id):
3603 """ GBP route-domain Del """
3604 return self.api(self.papi.gbp_route_domain_del,
3607 def gbp_route_domain_dump(self):
3608 """ GBP Route Domain Dump """
3609 return self.api(self.papi.gbp_route_domain_dump, {})
3611 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3612 """ GBP recirc Add/Del """
3613 return self.api(self.papi.gbp_recirc_add_del,
3617 'sw_if_index': sw_if_index,
3620 def gbp_recirc_dump(self):
3621 """ GBP recirc Dump """
3622 return self.api(self.papi.gbp_recirc_dump, {})
3624 def gbp_subnet_add_del(self, is_add, rd_id,
3626 sw_if_index=0xffffffff,
3628 """ GBP Subnet Add/Del """
3629 return self.api(self.papi.gbp_subnet_add_del,
3633 'sw_if_index': sw_if_index,
3638 def gbp_subnet_dump(self):
3639 """ GBP Subnet Dump """
3640 return self.api(self.papi.gbp_subnet_dump, {})
3642 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index, rules):
3643 """ GBP contract Add/Del """
3644 return self.api(self.papi.gbp_contract_add_del,
3647 'acl_index': acl_index,
3650 'n_rules': len(rules),
3653 def gbp_contract_dump(self):
3654 """ GBP contract Dump """
3655 return self.api(self.papi.gbp_contract_dump, {})
3657 def gbp_endpoint_learn_set_inactive_threshold(self, threshold):
3658 """ GBP set inactive threshold """
3659 return self.api(self.papi.gbp_endpoint_learn_set_inactive_threshold,
3660 {'threshold': threshold})
3662 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode):
3663 """ GBP VXLAN tunnel add """
3664 return self.api(self.papi.gbp_vxlan_tunnel_add,
3669 'bd_rd_id': bd_rd_id
3673 def gbp_vxlan_tunnel_del(self, vni):
3674 """ GBP VXLAN tunnel del """
3675 return self.api(self.papi.gbp_vxlan_tunnel_del,
3680 def gbp_vxlan_tunnel_dump(self):
3681 """ GBP VXLAN tunnel add/del """
3682 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
3684 def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3685 ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3687 """ 6RD tunnel Add """
3688 return self.api(self.papi.ipip_6rd_add_tunnel,
3689 {'ip4_table_id': ip4_table_id,
3690 'ip6_table_id': ip6_table_id,
3691 'ip6_prefix': ip6_prefix,
3692 'ip6_prefix_len': ip6_prefix_len,
3693 'ip4_prefix': ip4_prefix,
3694 'ip4_prefix_len': ip4_prefix_len,
3696 'security_check': security_check})
3698 def ipip_6rd_del_tunnel(self, sw_if_index):
3699 """ 6RD tunnel Delete """
3700 return self.api(self.papi.ipip_6rd_del_tunnel,
3701 {'sw_if_index': sw_if_index})
3703 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3704 instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3705 """ IPIP tunnel Add/Del """
3706 return self.api(self.papi.ipip_add_tunnel,
3707 {'is_ipv6': is_ipv6,
3708 'instance': instance,
3709 'src_address': src_address,
3710 'dst_address': dst_address,
3711 'table_id': table_id,
3714 def ipip_del_tunnel(self, sw_if_index):
3715 """ IPIP tunnel Delete """
3716 return self.api(self.papi.ipip_del_tunnel,
3717 {'sw_if_index': sw_if_index})
3719 def qos_egress_map_update(self, id, outputs):
3720 """ QOS egress map update """
3721 return self.api(self.papi.qos_egress_map_update,
3725 def qos_egress_map_delete(self, id):
3726 """ QOS egress map delete """
3727 return self.api(self.papi.qos_egress_map_delete,
3730 def qos_mark_enable_disable(self, sw_if_index,
3734 """ QOS Mark Enable/Disable """
3735 return self.api(self.papi.qos_mark_enable_disable,
3737 'sw_if_index': sw_if_index,
3738 'output_source': output_source,
3741 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3742 """ IP QoS recording Enble/Disable """
3743 return self.api(self.papi.qos_record_enable_disable,
3744 {'sw_if_index': sw_if_index,
3745 'input_source': input_source,
3748 def igmp_enable_disable(self, sw_if_index, enable, host):
3749 """ Enable/disable IGMP on a given interface """
3750 return self.api(self.papi.igmp_enable_disable,
3753 'sw_if_index': sw_if_index})
3755 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
3756 """ Add/del IGMP proxy device """
3757 return self.api(self.papi.igmp_proxy_device_add_del,
3758 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3761 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
3762 """ Add/del interface to/from IGMP proxy device """
3763 return self.api(self.papi.igmp_proxy_device_add_del_interface,
3764 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3767 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3768 """ Listen for new (S,G) on specified interface
3770 :param enable: add/del
3771 :param sw_if_index: interface sw index
3772 :param saddr: source ip4 addr
3773 :param gaddr: group ip4 addr
3775 return self.api(self.papi.igmp_listen,
3780 'sw_if_index': sw_if_index,
3781 'n_srcs': len(saddrs),
3790 def igmp_dump(self, sw_if_index=None):
3791 """ Dump all (S,G) interface configurations """
3792 if sw_if_index is None:
3793 sw_if_index = 0xffffffff
3794 return self.api(self.papi.igmp_dump,
3795 {'sw_if_index': sw_if_index})
3797 def igmp_clear_interface(self, sw_if_index):
3798 """ Remove all (S,G)s from specified interface
3799 doesn't send IGMP report!
3802 self.papi.igmp_clear_interface, {
3803 'sw_if_index': sw_if_index})
3805 def want_igmp_events(self, enable=1):
3806 return self.api(self.papi.want_igmp_events, {'enable': enable,
3807 'pid': os.getpid()})
3817 :param lb: load balance
3818 :param use_custom_mac: use custom mac
3819 :param mac_address: mac address
3822 self.papi.bond_create,
3825 'use_custom_mac': use_custom_mac,
3826 'mac_address': mac_address
3833 :param sw_if_index: interface the operation is applied to
3835 return self.api(self.papi.bond_delete,
3836 {'sw_if_index': sw_if_index})
3845 :param sw_if_index: slave sw_if_index
3846 :param bond_sw_if_index: bond sw_if_index
3847 :param is_passive: is passive lacp speaker
3848 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3851 self.papi.bond_enslave,
3852 {'sw_if_index': sw_if_index,
3853 'bond_sw_if_index': bond_sw_if_index,
3854 'is_passive': is_passive,
3855 'is_long_timeout': is_long_timeout
3858 def bond_detach_slave(
3862 :param sw_if_index: slave interface the operation is applied to
3864 return self.api(self.papi.bond_detach_slave,
3865 {'sw_if_index': sw_if_index})
3867 def sw_interface_slave_dump(
3871 :param sw_if_index: bond sw_if_index
3873 return self.api(self.papi.sw_interface_slave_dump,
3874 {'sw_if_index': sw_if_index})
3876 def sw_interface_bond_dump(
3881 return self.api(self.papi.sw_interface_bond_dump,
3884 def create_vhost_user_if(
3890 disable_indirect_desc,
3891 custom_dev_instance,
3896 :param is_server: is server
3897 :param sock_filename: socket name
3898 :param renumber: renumber
3899 :param disable_mrg_rxbuf: disable mergable rx buffers
3900 :param disable_indirect_desc: disable indirect descriptors
3901 :param custom_dev_instance: custom dev instance
3902 :param use_custom_mac: use custom mac
3903 :param mac_address: mac address
3904 :param tag: tag (default '')
3907 self.papi.create_vhost_user_if,
3908 {'is_server': is_server,
3909 'sock_filename': sock_filename,
3910 'renumber': renumber,
3911 'disable_mrg_rxbuf': disable_mrg_rxbuf,
3912 'disable_indirect_desc': disable_indirect_desc,
3913 'custom_dev_instance': custom_dev_instance,
3914 'use_custom_mac': use_custom_mac,
3915 'mac_address': mac_address,
3919 def delete_vhost_user_if(
3923 :param sw_if_index: interface the operation is applied to
3925 return self.api(self.papi.delete_vhost_user_if,
3926 {'sw_if_index': sw_if_index, })
3928 def sw_interface_vhost_user_dump(
3933 return self.api(self.papi.sw_interface_vhost_user_dump,
3936 def abf_policy_add_del(self, is_add, policy):
3938 self.papi.abf_policy_add_del,
3942 def abf_itf_attach_add_del(self, is_add, attach):
3944 self.papi.abf_itf_attach_add_del,
3948 def abf_policy_dump(self):
3950 self.papi.abf_policy_dump, {})
3952 def abf_itf_attach_dump(self):
3954 self.papi.abf_itf_attach_dump, {})
3956 def pipe_create(self, is_specified, user_instance):
3957 return self.api(self.papi.pipe_create,
3958 {'is_specified': is_specified,
3959 'user_instance': user_instance})
3961 def pipe_delete(self, parent_sw_if_index):
3962 return self.api(self.papi.pipe_delete,
3963 {'parent_sw_if_index': parent_sw_if_index})
3965 def pipe_dump(self):
3966 return self.api(self.papi.pipe_dump, {})
3980 return self.api(self.papi.memif_create,
3983 'rx_queues': rx_queues,
3984 'tx_queues': tx_queues,
3986 'socket_id': socket_id,
3988 'ring_size': ring_size,
3989 'buffer_size': buffer_size,
3990 'hw_addr': hw_addr})
3992 def memif_delete(self, sw_if_index):
3993 return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index})
3995 def memif_dump(self):
3996 return self.api(self.papi.memif_dump, {})
3998 def memif_socket_filename_add_del(
3999 self, is_add, socket_id, socket_filename):
4001 self.papi.memif_socket_filename_add_del,
4003 'socket_id': socket_id,
4004 'socket_filename': socket_filename})
4006 def memif_socket_filename_dump(self):
4007 return self.api(self.papi.memif_socket_filename_dump, {})
4009 def svs_table_add_del(self, af, table_id, is_add=1):
4010 return self.api(self.papi.svs_table_add_del,
4012 'table_id': table_id,
4017 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
4018 return self.api(self.papi.svs_route_add_del,
4020 'table_id': table_id,
4021 'source_table_id': src_table_id,
4026 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
4027 return self.api(self.papi.svs_enable_disable,
4030 'table_id': table_id,
4031 'sw_if_index': sw_if_index,
4032 'is_enable': is_enable,
4036 return self.api(self.papi.svs_dump, {})
4038 def syslog_set_sender(
4045 """Set syslog sender configuration
4047 :param collector: colector IP address
4048 :param src: source IP address
4049 :param collector_port: collector UDP port (Default value = 514)
4050 :param vrf_id: VRF id (Default value = 0)
4051 :param max_msg_size: maximum message length (Default value = 480)
4053 return self.api(self.papi.syslog_set_sender,
4054 {'collector_address': {
4055 'address': collector},
4058 'collector_port': collector_port,
4060 'max_msg_size': max_msg_size})
4062 def syslog_get_sender(self):
4063 """Return syslog sender configuration"""
4064 return self.api(self.papi.syslog_get_sender, {})
4066 def syslog_set_filter(self, severity):
4067 """Set syslog filter parameters
4069 :param severity: severity filter (specified severity and greater match)
4071 return self.api(self.papi.syslog_set_filter, {'severity': severity})
4073 def syslog_get_filter(self):
4074 """Return syslog filter parameters"""
4075 return self.api(self.papi.syslog_get_filter, {})