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
21 from vpp_l2 import L2_PORT_TYPE
23 # from vnet/vnet/mpls/mpls_types.h
24 MPLS_IETF_MAX_LABEL = 0xfffff
25 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
47 class UnexpectedApiReturnValueError(Exception):
48 """ exception raised when the API return value is unexpected """
52 class VppPapiProvider(object):
53 """VPP-api provider using vpp-papi
55 @property hook: hook object providing before and after api/cli hooks
58 _zero, _negative = range(2)
60 def __init__(self, name, shm_prefix, test_class, read_timeout):
61 self.hook = Hook("vpp-papi-provider")
63 self.shm_prefix = shm_prefix
64 self.test_class = test_class
65 self._expect_api_retval = self._zero
66 self._expect_stack = []
69 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
70 for root, dirnames, filenames in os.walk(install_dir):
71 for filename in fnmatch.filter(filenames, '*.api.json'):
72 jsonfiles.append(os.path.join(root, filename))
74 self.vpp = VPP(jsonfiles, logger=test_class.logger,
75 read_timeout=read_timeout)
76 self._events = deque()
81 def assert_negative_api_retval(self):
82 """ Expect API failure - used with with, e.g.:
83 with self.vapi.assert_negative_api_retval():
84 self.vapi.<api call expected to fail>
86 self._expect_stack.append(self._expect_api_retval)
87 self._expect_api_retval = self._negative
90 def assert_zero_api_retval(self):
91 """ Expect API success - used with with, e.g.:
92 with self.vapi.assert_negative_api_retval():
93 self.vapi.<api call expected to succeed>
95 note: this is useful only inside another with block
96 as success is the default expected value
98 self._expect_stack.append(self._expect_api_retval)
99 self._expect_api_retval = self._zero
102 def __exit__(self, exc_type, exc_value, traceback):
103 self._expect_api_retval = self._expect_stack.pop()
105 def register_hook(self, hook):
106 """Replace hook registration with new hook
113 def collect_events(self):
114 """ Collect all events from the internal queue and clear the queue. """
116 self._events = deque()
119 def wait_for_event(self, timeout, name=None):
120 """ Wait for and return next event. """
122 self.test_class.logger.debug("Expecting event '%s' within %ss",
125 self.test_class.logger.debug("Expecting event within %ss",
128 self.test_class.logger.debug("Not waiting, event already queued")
129 limit = time.time() + timeout
130 while time.time() < limit:
132 e = self._events.popleft()
133 if name and type(e).__name__ != name:
135 "Unexpected event received: %s, expected: %s" %
136 (type(e).__name__, name))
137 self.test_class.logger.debug("Returning event %s:%s" %
140 time.sleep(0) # yield
141 raise Exception("Event did not occur within timeout")
143 def __call__(self, name, event):
144 """ Enqueue event in the internal event queue. """
145 # FIXME use the name instead of relying on type(e).__name__ ?
146 # FIXME #2 if this throws, it is eaten silently, Ole?
147 self.test_class.logger.debug("New event: %s: %s" % (name, event))
148 self._events.append(event)
151 """Connect the API to VPP"""
152 self.vpp.connect(self.name, self.shm_prefix)
153 self.papi = self.vpp.api
154 self.vpp.register_event_callback(self)
156 def disconnect(self):
157 """Disconnect the API from VPP"""
158 self.vpp.disconnect()
160 def api(self, api_fn, api_args, expected_retval=0):
161 """ Call API function and check it's return value.
162 Call the appropriate hooks before and after the API call
164 :param api_fn: API function to call
165 :param api_args: tuple of API function arguments
166 :param expected_retval: Expected return value (Default value = 0)
167 :returns: reply from the API
170 self.hook.before_api(api_fn.__name__, api_args)
171 reply = api_fn(**api_args)
172 if self._expect_api_retval == self._negative:
173 if hasattr(reply, 'retval') and reply.retval >= 0:
174 msg = "API call passed unexpectedly: expected negative "\
175 "return value instead of %d in %s" % \
176 (reply.retval, repr(reply))
177 self.test_class.logger.info(msg)
178 raise UnexpectedApiReturnValueError(msg)
179 elif self._expect_api_retval == self._zero:
180 if hasattr(reply, 'retval') and reply.retval != expected_retval:
181 msg = "API call failed, expected %d return value instead "\
182 "of %d in %s" % (expected_retval, reply.retval,
184 self.test_class.logger.info(msg)
185 raise UnexpectedApiReturnValueError(msg)
187 raise Exception("Internal error, unexpected value for "
188 "self._expect_api_retval %s" %
189 self._expect_api_retval)
190 self.hook.after_api(api_fn.__name__, api_args)
194 """ Execute a CLI, calling the before/after hooks appropriately.
196 :param cli: CLI to execute
200 self.hook.before_cli(cli)
202 r = self.papi.cli_inband(length=len(cli), cmd=cli)
203 self.hook.after_cli(cli)
204 if hasattr(r, 'reply'):
205 return r.reply.decode().rstrip('\x00')
207 def ppcli(self, cli):
208 """ Helper method to print CLI command in case of info logging level.
210 :param cli: CLI to execute
213 return cli + "\n" + str(self.cli(cli))
215 def _convert_mac(self, mac):
216 return mac.replace(':', '').decode('hex')
218 def show_version(self):
220 return self.api(self.papi.show_version, {})
222 def pg_create_interface(self, pg_index):
228 return self.api(self.papi.pg_create_interface,
229 {"interface_id": pg_index})
231 def sw_interface_dump(self, filter=None):
234 :param filter: (Default value = None)
237 if filter is not None:
238 args = {"name_filter_valid": 1, "name_filter": filter}
241 return self.api(self.papi.sw_interface_dump, args)
243 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
244 """ Set the IPvX Table-id for the Interface
251 return self.api(self.papi.sw_interface_set_table,
252 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
255 def sw_interface_get_table(self, sw_if_index, is_ipv6):
256 """ Get the IPvX Table-id for the Interface
263 return self.api(self.papi.sw_interface_get_table,
264 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6})
266 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
267 is_ipv6=0, is_add=1, del_all=0):
270 :param addr: param is_ipv6: (Default value = 0)
273 :param is_ipv6: (Default value = 0)
274 :param is_add: (Default value = 1)
275 :param del_all: (Default value = 0)
278 return self.api(self.papi.sw_interface_add_del_address,
279 {'sw_if_index': sw_if_index,
283 'address_length': addr_len,
286 def ip_address_dump(self, sw_if_index, is_ipv6=0):
287 return self.api(self.papi.ip_address_dump,
288 {'sw_if_index': sw_if_index,
291 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
293 """ Set the Interface to be unnumbered
295 :param is_add: (Default value = 1)
296 :param sw_if_index - interface That will be unnumbered
297 :param ip_sw_if_index - interface with an IP addres
300 return self.api(self.papi.sw_interface_set_unnumbered,
301 {'sw_if_index': ip_sw_if_index,
302 'unnumbered_sw_if_index': sw_if_index,
305 def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
306 return self.api(self.papi.ip_unnumbered_dump,
307 {'sw_if_index': sw_if_index})
309 def sw_interface_enable_disable_mpls(self, sw_if_index,
312 Enable/Disable MPLS on the interface
314 :param is_enable: (Default value = 1)
317 return self.api(self.papi.sw_interface_set_mpls_enable,
318 {'sw_if_index': sw_if_index,
319 'enable': is_enable})
321 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
322 return self.api(self.papi.sw_interface_ip6nd_ra_config,
323 {'sw_if_index': sw_if_index,
324 'suppress': suppress})
326 def set_ip_flow_hash(self,
335 return self.api(self.papi.set_ip_flow_hash,
345 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
346 return self.api(self.papi.ip6nd_proxy_add_del,
348 'sw_if_index': sw_if_index,
351 def ip6_sw_interface_ra_config(self, sw_if_index,
355 return self.api(self.papi.sw_interface_ip6nd_ra_config,
356 {'sw_if_index': sw_if_index,
358 'suppress': suppress,
359 'send_unicast': send_unicast})
361 def ip6_sw_interface_ra_prefix(self,
371 val_lifetime=0xffffffff,
372 pref_lifetime=0xffffffff):
373 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
374 {'sw_if_index': sw_if_index,
376 'address_length': address_length,
377 'use_default': use_default,
378 'no_advertise': no_advertise,
379 'off_link': off_link,
380 'no_autoconfig': no_autoconfig,
381 'no_onlink': no_onlink,
383 'val_lifetime': val_lifetime,
384 'pref_lifetime': pref_lifetime})
386 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
388 Enable/Disable An interface for IPv6
390 return self.api(self.papi.sw_interface_ip6_enable_disable,
391 {'sw_if_index': sw_if_index,
394 def vxlan_add_del_tunnel(
398 mcast_sw_if_index=0xFFFFFFFF,
402 decap_next_index=0xFFFFFFFF,
404 instance=0xFFFFFFFF):
409 :param is_add: (Default value = 1)
410 :param is_ipv6: (Default value = 0)
411 :param encap_vrf_id: (Default value = 0)
412 :param decap_next_index: (Default value = 0xFFFFFFFF)
413 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
414 :param vni: (Default value = 0)
415 :param instance: (Default value = 0xFFFFFFFF)
418 return self.api(self.papi.vxlan_add_del_tunnel,
421 'src_address': src_addr,
422 'dst_address': dst_addr,
423 'mcast_sw_if_index': mcast_sw_if_index,
424 'encap_vrf_id': encap_vrf_id,
425 'decap_next_index': decap_next_index,
427 'instance': instance})
429 def geneve_add_del_tunnel(
433 mcast_sw_if_index=0xFFFFFFFF,
437 decap_next_index=0xFFFFFFFF,
443 :param is_add: (Default value = 1)
444 :param is_ipv6: (Default value = 0)
445 :param encap_vrf_id: (Default value = 0)
446 :param decap_next_index: (Default value = 0xFFFFFFFF)
447 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
448 :param vni: (Default value = 0)
451 return self.api(self.papi.geneve_add_del_tunnel,
454 'local_address': local_addr,
455 'remote_address': remote_addr,
456 'mcast_sw_if_index': mcast_sw_if_index,
457 'encap_vrf_id': encap_vrf_id,
458 'decap_next_index': decap_next_index,
461 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
462 learn=1, arp_term=0, is_add=1):
463 """Create/delete bridge domain.
465 :param int bd_id: Bridge domain index.
466 :param int flood: Enable/disable bcast/mcast flooding in the BD.
468 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
470 :param int forward: Enable/disable forwarding on all interfaces in
471 the BD. (Default value = 1)
472 :param int learn: Enable/disable learning on all interfaces in the BD.
474 :param int arp_term: Enable/disable arp termination in the BD.
476 :param int is_add: Add or delete flag. (Default value = 1)
478 return self.api(self.papi.bridge_domain_add_del,
481 'uu_flood': uu_flood,
484 'arp_term': arp_term,
487 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
488 return self.api(self.papi.bd_ip_mac_add_del,
494 def bd_ip_mac_dump(self, bd_id):
495 return self.api(self.papi.bd_ip_mac_dump,
498 def want_ip4_arp_events(self, enable_disable=1, address=0):
499 return self.api(self.papi.want_ip4_arp_events,
500 {'enable_disable': enable_disable,
502 'pid': os.getpid(), })
504 def want_ip6_nd_events(self, enable_disable=1, address=0):
505 return self.api(self.papi.want_ip6_nd_events,
506 {'enable_disable': enable_disable,
508 'pid': os.getpid(), })
510 def want_ip6_ra_events(self, enable_disable=1):
511 return self.api(self.papi.want_ip6_ra_events,
512 {'enable_disable': enable_disable,
513 'pid': os.getpid(), })
515 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
517 return self.api(self.papi.ip6nd_send_router_solicitation,
522 'sw_if_index': sw_if_index})
524 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
525 install_default_routes):
526 return self.api(self.papi.ip6_nd_address_autoconfig,
527 {'sw_if_index': sw_if_index,
529 'install_default_routes': install_default_routes})
531 def want_interface_events(self, enable_disable=1):
532 return self.api(self.papi.want_interface_events,
533 {'enable_disable': enable_disable,
534 'pid': os.getpid(), })
536 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
537 max_macs_in_event=0, learn_limit=0):
538 return self.api(self.papi.want_l2_macs_events,
539 {'enable_disable': enable_disable,
540 'scan_delay': scan_delay,
541 'max_macs_in_event': max_macs_in_event,
542 'learn_limit': learn_limit,
543 'pid': os.getpid(), })
545 def want_dhcp6_reply_events(self, enable_disable=1):
546 return self.api(self.papi.want_dhcp6_reply_events,
547 {'enable_disable': enable_disable,
550 def want_dhcp6_pd_reply_events(self, enable_disable=1):
551 return self.api(self.papi.want_dhcp6_pd_reply_events,
552 {'enable_disable': enable_disable,
555 def dhcp6_clients_enable_disable(self, enable=1):
556 return self.api(self.papi.dhcp6_clients_enable_disable,
559 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
560 addresses, server_index=0xFFFFFFFF,
561 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
563 return self.api(self.papi.dhcp6_send_client_message,
564 {'sw_if_index': sw_if_index,
565 'server_index': server_index,
571 'msg_type': msg_type,
574 'n_addresses': len(addresses),
575 'addresses': addresses})
577 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
578 prefixes, server_index=0xFFFFFFFF,
579 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
581 return self.api(self.papi.dhcp6_pd_send_client_message,
582 {'sw_if_index': sw_if_index,
583 'server_index': server_index,
589 'msg_type': msg_type,
592 'n_prefixes': len(prefixes),
593 'prefixes': prefixes})
595 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
597 return self.api(self.papi.dhcp6_client_enable_disable,
598 {'sw_if_index': sw_if_index,
601 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
603 return self.api(self.papi.dhcp6_pd_client_enable_disable,
604 {'sw_if_index': sw_if_index,
605 'prefix_group': prefix_group,
608 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
609 prefix_length, prefix_group,
611 return self.api(self.papi.ip6_add_del_address_using_prefix,
612 {'sw_if_index': sw_if_index,
613 'prefix_group': prefix_group,
615 'prefix_length': prefix_length,
618 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
619 filter_mac=0, bvi_mac=0):
620 """Create/delete L2 FIB entry.
622 :param str mac: MAC address to create FIB entry for.
623 :param int bd_id: Bridge domain index.
624 :param int sw_if_index: Software interface index of the interface.
625 :param int is_add: Add or delete flag. (Default value = 1)
626 :param int static_mac: Set to 1 to create static MAC entry.
628 :param int filter_mac: Set to 1 to drop packet that's source or
629 destination MAC address contains defined MAC address.
631 :param int bvi_mac: Set to 1 to create entry that points to BVI
632 interface. (Default value = 0)
634 return self.api(self.papi.l2fib_add_del,
635 {'mac': self._convert_mac(mac),
637 'sw_if_index': sw_if_index,
639 'static_mac': static_mac,
640 'filter_mac': filter_mac,
643 def l2fib_flush_int(self, sw_if_index):
644 """Flush L2 FIB entries for sw_if_index.
646 :param int sw_if_index: Software interface index of the interface.
648 return self.api(self.papi.l2fib_flush_int,
649 {'sw_if_index': sw_if_index})
651 def l2fib_flush_bd(self, bd_id):
652 """Flush L2 FIB entries for bd_id.
654 :param int sw_if_index: Bridge Domain id.
656 return self.api(self.papi.l2fib_flush_bd,
659 def l2fib_flush_all(self):
662 return self.api(self.papi.l2fib_flush_all, {})
664 def l2_fib_table_dump(self, bd_id):
665 """ Dump the L2 FIB """
666 return self.api(self.papi.l2_fib_table_dump,
669 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
670 shg=0, port_type=L2_PORT_TYPE.NORMAL,
672 """Add/remove interface to/from bridge domain.
674 :param int sw_if_index: Software interface index of the interface.
675 :param int bd_id: Bridge domain index.
676 :param int shg: Split-horizon group index. (Default value = 0)
677 :param int bvi: Set interface as a bridge group virtual interface.
679 :param int enable: Add or remove interface. (Default value = 1)
681 return self.api(self.papi.sw_interface_set_l2_bridge,
682 {'rx_sw_if_index': sw_if_index,
685 'port_type': port_type,
688 def bridge_flags(self, bd_id, is_set, feature_bitmap):
689 """Enable/disable required feature of the bridge domain with defined
692 :param int bd_id: Bridge domain ID.
693 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
694 :param int flags: Bitmap value of the feature to be set:
698 - uu-flood (1 << 3) or
701 return self.api(self.papi.bridge_flags,
704 'flags': feature_bitmap})
706 def bridge_domain_dump(self, bd_id=0):
709 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
710 existing bridge domains returned)
711 :return: Dictionary of bridge domain(s) data.
713 return self.api(self.papi.bridge_domain_dump,
716 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
718 """Create or delete unidirectional cross-connect from Tx interface to
721 :param int rx_sw_if_index: Software interface index of Rx interface.
722 :param int tx_sw_if_index: Software interface index of Tx interface.
723 :param int enable: Create cross-connect if equal to 1, delete
724 cross-connect if equal to 0.
727 return self.api(self.papi.sw_interface_set_l2_xconnect,
728 {'rx_sw_if_index': rx_sw_if_index,
729 'tx_sw_if_index': tx_sw_if_index,
732 def sw_interface_set_l2_tag_rewrite(
739 """L2 interface vlan tag rewrite configure request
740 :param client_index - opaque cookie to identify the sender
741 :param context - sender context, to match reply w/ request
742 :param sw_if_index - interface the operation is applied to
743 :param vtr_op - Choose from l2_vtr_op_t enum values
744 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
745 :param tag1 - Needed for any push or translate vtr op
746 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
749 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
750 {'sw_if_index': sw_if_index,
756 def sw_interface_set_l2_emulation(
761 :param sw_if_index - interface the operation is applied to
764 return self.api(self.papi.l2_emulation,
765 {'sw_if_index': sw_if_index,
768 def sw_interface_set_ip_directed_broadcast(
772 """IP Directed broadcast
773 :param sw_if_index - interface the operation is applied to
776 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
777 {'sw_if_index': sw_if_index,
780 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
783 :param admin_up_down:
787 return self.api(self.papi.sw_interface_set_flags,
788 {'sw_if_index': sw_if_index,
789 'admin_up_down': admin_up_down})
791 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
797 return self.api(self.papi.sw_interface_set_mtu,
798 {'sw_if_index': sw_if_index,
801 def sw_interface_set_promiscuous(self, sw_if_index, enable):
807 return self.api(self.papi.sw_interface_set_promiscuous,
808 {'sw_if_index': sw_if_index,
811 def sw_interface_set_mac_address(self, sw_if_index, mac):
812 return self.api(self.papi.sw_interface_set_mac_address,
813 {'sw_if_index': sw_if_index,
816 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
817 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
818 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
819 """Create subinterface
820 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
822 :param sub_id: param inner_vlan:
826 :param no_tags: (Default value = 0)
827 :param one_tag: (Default value = 0)
828 :param two_tags: (Default value = 0)
829 :param dot1ad: (Default value = 0)
830 :param exact_match: (Default value = 0)
831 :param default_sub: (Default value = 0)
832 :param outer_vlan_id_any: (Default value = 0)
833 :param inner_vlan_id_any: (Default value = 0)
837 self.papi.create_subif,
838 {'sw_if_index': sw_if_index,
842 'two_tags': two_tags,
844 'exact_match': exact_match,
845 'default_sub': default_sub,
846 'outer_vlan_id_any': outer_vlan_id_any,
847 'inner_vlan_id_any': inner_vlan_id_any,
848 'outer_vlan_id': outer_vlan,
849 'inner_vlan_id': inner_vlan})
851 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
852 """Create p2p ethernet subinterface
854 :param sw_if_index: main (parent) interface
855 :param remote_mac: client (remote) mac address
859 self.papi.p2p_ethernet_add,
860 {'parent_if_index': sw_if_index,
861 'remote_mac': remote_mac,
862 'subif_id': subif_id})
864 def delete_subif(self, sw_if_index):
865 """Delete subinterface
869 return self.api(self.papi.delete_subif,
870 {'sw_if_index': sw_if_index})
872 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
873 """Delete p2p ethernet subinterface
875 :param sw_if_index: main (parent) interface
876 :param remote_mac: client (remote) mac address
880 self.papi.p2p_ethernet_del,
881 {'parent_if_index': sw_if_index,
882 'remote_mac': remote_mac})
884 def create_vlan_subif(self, sw_if_index, vlan):
891 return self.api(self.papi.create_vlan_subif,
892 {'sw_if_index': sw_if_index,
895 def create_loopback(self, mac=''):
898 :param mac: (Optional)
900 return self.api(self.papi.create_loopback,
901 {'mac_address': mac})
903 def delete_loopback(self, sw_if_index):
904 return self.api(self.papi.delete_loopback,
905 {'sw_if_index': sw_if_index, })
907 def ip_table_add_del(self,
914 :param is_add: (Default value = 1)
915 :param is_ipv6: (Default value = 0)
920 self.papi.ip_table_add_del,
921 {'table_id': table_id,
925 def ip_add_del_route(
930 next_hop_sw_if_index=0xFFFFFFFF,
934 next_hop_n_out_labels=0,
935 next_hop_out_label_stack=[],
936 next_hop_via_label=MPLS_LABEL_INVALID,
937 next_hop_id=0xFFFFFFFF,
939 is_resolve_attached=0,
940 classify_table_index=0xFFFFFFFF,
954 :param dst_address_length:
955 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
957 :param next_hop_address:
958 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
959 :param vrf_id: (Default value = 0)
960 :param lookup_in_vrf: (Default value = 0)
961 :param classify_table_index: (Default value = 0xFFFFFFFF)
962 :param is_add: (Default value = 1)
963 :param is_drop: (Default value = 0)
964 :param is_ipv6: (Default value = 0)
965 :param is_local: (Default value = 0)
966 :param is_classify: (Default value = 0)
967 :param is_multipath: (Default value = 0)
968 :param is_resolve_host: (Default value = 0)
969 :param is_resolve_attached: (Default value = 0)
970 :param is_dvr: (Default value = 0)
971 :param is_source_lookup: (Default value = 0)
972 :param next_hop_weight: (Default value = 1)
977 self.papi.ip_add_del_route,
978 {'next_hop_sw_if_index': next_hop_sw_if_index,
979 'table_id': table_id,
980 'classify_table_index': classify_table_index,
981 'next_hop_table_id': next_hop_table_id,
984 'is_unreach': is_unreach,
985 'is_prohibit': is_prohibit,
987 'is_local': is_local,
988 'is_classify': is_classify,
989 'is_multipath': is_multipath,
990 'is_resolve_host': is_resolve_host,
991 'is_resolve_attached': is_resolve_attached,
993 'is_source_lookup': is_source_lookup,
994 'is_udp_encap': is_udp_encap,
995 'next_hop_weight': next_hop_weight,
996 'dst_address_length': dst_address_length,
997 'dst_address': dst_address,
998 'next_hop_id': next_hop_id,
999 'next_hop_address': next_hop_address,
1000 'next_hop_n_out_labels': next_hop_n_out_labels,
1001 'next_hop_via_label': next_hop_via_label,
1002 'next_hop_out_label_stack': next_hop_out_label_stack})
1004 def ip_fib_dump(self):
1005 return self.api(self.papi.ip_fib_dump, {})
1007 def ip6_fib_dump(self):
1008 return self.api(self.papi.ip6_fib_dump, {})
1010 def ip_neighbor_add_del(self,
1019 """ Add neighbor MAC to IPv4 or IPv6 address.
1024 :param is_add: (Default value = 1)
1025 :param is_ipv6: (Default value = 0)
1026 :param is_static: (Default value = 0)
1027 :param is_no_adj_fib: (Default value = 0)
1031 self.papi.ip_neighbor_add_del,
1032 {'sw_if_index': sw_if_index,
1035 'is_static': is_static,
1036 'is_no_adj_fib': is_no_adj_fib,
1037 'mac_address': mac_address,
1038 'dst_address': dst_address
1042 def ip_neighbor_dump(self,
1045 """ Return IP neighbor dump.
1048 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1052 self.papi.ip_neighbor_dump,
1053 {'is_ipv6': is_ipv6,
1054 'sw_if_index': sw_if_index
1058 def proxy_arp_add_del(self,
1063 """ Config Proxy Arp Range.
1065 :param low_address: Start address in the rnage to Proxy for
1066 :param hi_address: End address in the rnage to Proxy for
1067 :param vrf_id: The VRF/table in which to proxy
1071 self.papi.proxy_arp_add_del,
1075 'low_address': low_address,
1076 'hi_address': hi_address,
1080 def proxy_arp_intfc_enable_disable(self,
1083 """ Enable/Disable an interface for proxy ARP requests
1085 :param sw_if_index: Interface
1086 :param enable_disable: Enable/Disable
1090 self.papi.proxy_arp_intfc_enable_disable,
1091 {'sw_if_index': sw_if_index,
1092 'enable_disable': is_enable
1100 """ Reset VRF (remove all routes etc.) request.
1102 :param int vrf_id: ID of the FIB table / VRF to reset.
1103 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1107 self.papi.reset_vrf,
1117 """ Reset VRF (remove all routes etc.) request.
1119 :param int vrf_id: ID of the FIB table / VRF to reset.
1120 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1124 self.papi.reset_fib,
1135 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1140 {'is_ipv6': is_ipv6,
1144 def sw_interface_span_enable_disable(
1145 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1148 :param sw_if_index_from:
1149 :param sw_if_index_to:
1153 return self.api(self.papi.sw_interface_span_enable_disable,
1154 {'sw_if_index_from': sw_if_index_from,
1155 'sw_if_index_to': sw_if_index_to,
1160 def gre_tunnel_add_del(self,
1165 instance=0xFFFFFFFF,
1169 """ Add a GRE tunnel
1173 :param outer_fib_id: (Default value = 0)
1174 :param tunnel_type: (Default value = 0)
1175 :param instance: (Default value = 0xFFFFFFFF)
1176 :param session_id: (Defalt value = 0)
1177 :param is_add: (Default value = 1)
1178 :param is_ipv6: (Default value = 0)
1182 self.papi.gre_add_del_tunnel,
1185 'tunnel_type': tunnel_type,
1186 'instance': instance,
1187 'src_address': src_address,
1188 'dst_address': dst_address,
1189 'outer_fib_id': outer_fib_id,
1190 'session_id': session_id}
1193 def udp_encap_add(self,
1199 """ Add a GRE tunnel
1204 :param outer_fib_id: (Default value = 0)
1208 self.papi.udp_encap_add,
1213 'src_port': src_port,
1214 'dst_port': dst_port,
1215 'table_id': table_id
1219 def udp_encap_del(self, id):
1220 return self.api(self.papi.udp_encap_del, {'id': id})
1222 def udp_encap_dump(self):
1223 return self.api(self.papi.udp_encap_dump, {})
1225 def want_udp_encap_stats(self, enable=1):
1226 return self.api(self.papi.want_udp_encap_stats,
1228 'pid': os.getpid()})
1230 def mpls_fib_dump(self):
1231 return self.api(self.papi.mpls_fib_dump, {})
1233 def mpls_table_add_del(
1240 :param is_add: (Default value = 1)
1245 self.papi.mpls_table_add_del,
1246 {'mt_table_id': table_id,
1247 'mt_is_add': is_add})
1249 def mpls_route_add_del(
1255 next_hop_sw_if_index=0xFFFFFFFF,
1257 next_hop_table_id=0,
1259 next_hop_n_out_labels=0,
1260 next_hop_out_label_stack=[],
1261 next_hop_via_label=MPLS_LABEL_INVALID,
1263 is_resolve_attached=0,
1270 classify_table_index=0xFFFFFFFF,
1274 :param dst_address_length:
1275 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1277 :param next_hop_address:
1278 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1279 :param vrf_id: (Default value = 0)
1280 :param lookup_in_vrf: (Default value = 0)
1281 :param classify_table_index: (Default value = 0xFFFFFFFF)
1282 :param is_add: (Default value = 1)
1283 :param is_drop: (Default value = 0)
1284 :param is_ipv6: (Default value = 0)
1285 :param is_local: (Default value = 0)
1286 :param is_classify: (Default value = 0)
1287 :param is_multipath: (Default value = 0)
1288 :param is_multicast: (Default value = 0)
1289 :param is_resolve_host: (Default value = 0)
1290 :param is_resolve_attached: (Default value = 0)
1291 :param next_hop_weight: (Default value = 1)
1295 self.papi.mpls_route_add_del,
1298 'mr_table_id': table_id,
1299 'mr_classify_table_index': classify_table_index,
1300 'mr_is_add': is_add,
1301 'mr_is_classify': is_classify,
1302 'mr_is_multipath': is_multipath,
1303 'mr_is_multicast': is_multicast,
1304 'mr_is_resolve_host': is_resolve_host,
1305 'mr_is_resolve_attached': is_resolve_attached,
1306 'mr_is_interface_rx': is_interface_rx,
1307 'mr_is_rpf_id': is_rpf_id,
1308 'mr_next_hop_proto': next_hop_proto,
1309 'mr_next_hop_weight': next_hop_weight,
1310 'mr_next_hop': next_hop_address,
1311 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1312 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1313 'mr_next_hop_table_id': next_hop_table_id,
1314 'mr_next_hop_via_label': next_hop_via_label,
1315 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1317 def mpls_ip_bind_unbind(
1329 self.papi.mpls_ip_bind_unbind,
1330 {'mb_mpls_table_id': table_id,
1332 'mb_ip_table_id': ip_table_id,
1333 'mb_is_bind': is_bind,
1334 'mb_is_ip4': is_ip4,
1335 'mb_address_length': dst_address_length,
1336 'mb_address': dst_address})
1338 def mpls_tunnel_add_del(
1341 next_hop_proto_is_ip4,
1343 next_hop_sw_if_index=0xFFFFFFFF,
1344 next_hop_table_id=0,
1346 next_hop_n_out_labels=0,
1347 next_hop_out_label_stack=[],
1348 next_hop_via_label=MPLS_LABEL_INVALID,
1354 :param dst_address_length:
1355 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1357 :param next_hop_address:
1358 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1359 :param vrf_id: (Default value = 0)
1360 :param lookup_in_vrf: (Default value = 0)
1361 :param classify_table_index: (Default value = 0xFFFFFFFF)
1362 :param is_add: (Default value = 1)
1363 :param is_drop: (Default value = 0)
1364 :param is_ipv6: (Default value = 0)
1365 :param is_local: (Default value = 0)
1366 :param is_classify: (Default value = 0)
1367 :param is_multipath: (Default value = 0)
1368 :param is_resolve_host: (Default value = 0)
1369 :param is_resolve_attached: (Default value = 0)
1370 :param next_hop_weight: (Default value = 1)
1371 :param is_multicast: (Default value = 0)
1375 self.papi.mpls_tunnel_add_del,
1376 {'mt_sw_if_index': tun_sw_if_index,
1377 'mt_is_add': is_add,
1378 'mt_l2_only': l2_only,
1379 'mt_is_multicast': is_multicast,
1380 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1381 'mt_next_hop_weight': next_hop_weight,
1382 'mt_next_hop': next_hop_address,
1383 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1384 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1385 'mt_next_hop_table_id': next_hop_table_id,
1386 'mt_next_hop_via_label': next_hop_via_label,
1387 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1389 def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
1390 return self.api(self.papi.mpls_tunnel_dump,
1391 {'sw_if_index': sw_if_index})
1393 def nat44_interface_add_del_feature(
1398 """Enable/disable NAT44 feature on the interface
1400 :param sw_if_index: Software index of the interface
1401 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1402 :param is_add: 1 if add, 0 if delete (Default value = 1)
1405 self.papi.nat44_interface_add_del_feature,
1407 'is_inside': is_inside,
1408 'sw_if_index': sw_if_index})
1410 def nat44_interface_add_del_output_feature(
1415 """Enable/disable NAT44 output feature on the interface
1417 :param sw_if_index: Software index of the interface
1418 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1419 :param is_add: 1 if add, 0 if delete (Default value = 1)
1422 self.papi.nat44_interface_add_del_output_feature,
1424 'is_inside': is_inside,
1425 'sw_if_index': sw_if_index})
1427 def nat44_add_del_static_mapping(
1431 external_sw_if_index=0xFFFFFFFF,
1442 """Add/delete NAT44 static mapping
1444 :param local_ip: Local IP address
1445 :param external_ip: External IP address
1446 :param external_sw_if_index: External interface instead of IP address
1447 :param local_port: Local port number (Default value = 0)
1448 :param external_port: External port number (Default value = 0)
1449 :param addr_only: 1 if address only mapping, 0 if address and port
1450 :param vrf_id: VRF ID
1451 :param protocol: IP protocol (Default value = 0)
1452 :param twice_nat: 1 if translate external host address and port
1453 :param self_twice_nat: 1 if translate external host address and port
1454 whenever external host address equals
1455 local address of internal host
1456 :param out2in_only: if 1 rule is matching only out2in direction
1457 :param tag: Opaque string tag
1458 :param is_add: 1 if add, 0 if delete (Default value = 1)
1461 self.papi.nat44_add_del_static_mapping,
1463 'addr_only': addr_only,
1464 'local_ip_address': local_ip,
1465 'external_ip_address': external_ip,
1466 'local_port': local_port,
1467 'external_port': external_port,
1468 'external_sw_if_index': external_sw_if_index,
1470 'protocol': protocol,
1471 'twice_nat': twice_nat,
1472 'self_twice_nat': self_twice_nat,
1473 'out2in_only': out2in_only,
1476 def nat44_add_del_identity_mapping(
1479 sw_if_index=0xFFFFFFFF,
1486 """Add/delete NAT44 identity mapping
1488 :param ip: IP address (Default value = 0)
1489 :param sw_if_index: Interface instead of IP address
1490 :param port: Port number (Default value = 0)
1491 :param addr_only: 1 if address only mapping, 0 if address and port
1492 :param vrf_id: VRF ID
1493 :param protocol: IP protocol (Default value = 0)
1494 :param tag: Opaque string tag
1495 :param is_add: 1 if add, 0 if delete (Default value = 1)
1498 self.papi.nat44_add_del_identity_mapping,
1500 'addr_only': addr_only,
1503 'sw_if_index': sw_if_index,
1506 'protocol': protocol})
1508 def nat44_add_del_address_range(
1515 """Add/del NAT44 address range
1517 :param first_ip_address: First IP address
1518 :param last_ip_address: Last IP address
1519 :param vrf_id: VRF id for the address range
1520 :param twice_nat: twice NAT address for extenal hosts
1521 :param is_add: 1 if add, 0 if delete (Default value = 1)
1524 self.papi.nat44_add_del_address_range,
1525 {'first_ip_address': first_ip_address,
1526 'last_ip_address': last_ip_address,
1528 'twice_nat': twice_nat,
1531 def nat44_address_dump(self):
1532 """Dump NAT44 addresses
1533 :return: Dictionary of NAT44 addresses
1535 return self.api(self.papi.nat44_address_dump, {})
1537 def nat44_interface_dump(self):
1538 """Dump interfaces with NAT44 feature
1539 :return: Dictionary of interfaces with NAT44 feature
1541 return self.api(self.papi.nat44_interface_dump, {})
1543 def nat44_interface_output_feature_dump(self):
1544 """Dump interfaces with NAT44 output feature
1545 :return: Dictionary of interfaces with NAT44 output feature
1547 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1549 def nat44_static_mapping_dump(self):
1550 """Dump NAT44 static mappings
1551 :return: Dictionary of NAT44 static mappings
1553 return self.api(self.papi.nat44_static_mapping_dump, {})
1555 def nat44_identity_mapping_dump(self):
1556 """Dump NAT44 identity mappings
1557 :return: Dictionary of NAT44 identity mappings
1559 return self.api(self.papi.nat44_identity_mapping_dump, {})
1561 def nat_show_config(self):
1562 """Show NAT plugin config
1563 :return: NAT plugin config parameters
1565 return self.api(self.papi.nat_show_config, {})
1567 def nat44_add_interface_addr(
1572 """Add/del NAT44 address from interface
1574 :param sw_if_index: Software index of the interface
1575 :param twice_nat: twice NAT address for extenal hosts
1576 :param is_add: 1 if add, 0 if delete (Default value = 1)
1579 self.papi.nat44_add_del_interface_addr,
1581 'sw_if_index': sw_if_index,
1582 'twice_nat': twice_nat})
1584 def nat44_interface_addr_dump(self):
1585 """Dump NAT44 addresses interfaces
1586 :return: Dictionary of NAT44 addresses interfaces
1588 return self.api(self.papi.nat44_interface_addr_dump, {})
1595 """Enable/disable NAT IPFIX logging
1597 :param domain_id: Observation domain ID (Default value = 1)
1598 :param src_port: Source port number (Default value = 4739)
1599 :param enable: 1 if enable, 0 if disable (Default value = 1)
1602 self.papi.nat_ipfix_enable_disable,
1603 {'domain_id': domain_id,
1604 'src_port': src_port,
1607 def nat44_user_session_dump(
1611 """Dump NAT44 user's sessions
1613 :param ip_address: ip adress of the user to be dumped
1614 :param cpu_index: cpu_index on which the user is
1615 :param vrf_id: VRF ID
1616 :return: Dictionary of S-NAT sessions
1619 self.papi.nat44_user_session_dump,
1620 {'ip_address': ip_address,
1623 def nat44_user_dump(self):
1626 :return: Dictionary of NAT44 users
1628 return self.api(self.papi.nat44_user_dump, {})
1630 def nat44_add_del_lb_static_mapping(
1643 """Add/delete NAT44 load balancing static mapping
1645 :param twice_nat: 1 if translate external host address and port
1646 :param tag: Opaque string tag
1647 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1648 :param is_add - 1 if add, 0 if delete
1651 self.papi.nat44_add_del_lb_static_mapping,
1653 'external_addr': external_addr,
1654 'external_port': external_port,
1655 'protocol': protocol,
1656 'twice_nat': twice_nat,
1657 'self_twice_nat': self_twice_nat,
1658 'out2in_only': out2in_only,
1660 'affinity': affinity,
1661 'local_num': local_num,
1664 def nat44_lb_static_mapping_dump(self):
1665 """Dump NAT44 load balancing static mappings
1667 :return: Dictionary of NAT44 load balancing static mapping
1669 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1671 def nat44_del_session(
1678 ext_host_address=None,
1680 """Delete NAT44 session
1682 :param addr: IPv4 address
1683 :param por: port number
1684 :param protocol: IP protocol number
1685 :param vrf_id: VRF ID
1686 :param is_in: 1 if inside network addres and port pari, 0 if outside
1687 :param ext_host_address: external host IPv4 address
1688 :param ext_host_port: external host port
1690 if ext_host_address is None:
1692 self.papi.nat44_del_session,
1695 'protocol': protocol,
1700 self.papi.nat44_del_session,
1703 'protocol': protocol,
1706 'ext_host_valid': 1,
1707 'ext_host_address': ext_host_address,
1708 'ext_host_port': ext_host_port})
1710 def nat44_forwarding_enable_disable(
1713 """Enable/disable forwarding for NAT44
1715 :param enable: 1 for enable, 0 for disable
1718 self.papi.nat44_forwarding_enable_disable,
1728 """Set NAT virtual fragmentation reassembly
1730 :param timeout: reassembly timeout (Default 2sec)
1731 :param max_reass: maximum concurrent reassemblies (Default 1024)
1732 :param max_frag: maximum fragmets per reassembly (Default 5)
1733 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1734 :param is_ip6: 1 if IPv6, 0 if IPv4
1737 self.papi.nat_set_reass,
1738 {'timeout': timeout,
1739 'max_reass': max_reass,
1740 'max_frag': max_frag,
1741 'drop_frag': drop_frag,
1744 def nat_get_reass(self):
1745 """Get NAT virtual fragmentation reassembly configuration
1747 :return: NAT virtual fragmentation reassembly configuration
1749 return self.api(self.papi.nat_get_reass, {})
1751 def nat_reass_dump(self):
1752 """Dump NAT virtual fragmentation reassemblies
1754 :return: Dictionary of NAT virtual fragmentation reassemblies
1756 return self.api(self.papi.nat_reass_dump, {})
1758 def nat_det_add_del_map(
1765 """Add/delete deterministic NAT mapping
1767 :param is_add - 1 if add, 0 if delete
1768 :param in_addr - inside IP address
1769 :param in_plen - inside IP address prefix length
1770 :param out_addr - outside IP address
1771 :param out_plen - outside IP address prefix length
1774 self.papi.nat_det_add_del_map,
1779 'out_addr': out_addr,
1780 'out_plen': out_plen})
1782 def nat_det_forward(
1785 """Get outside address and port range from inside address
1787 :param in_addr - inside IP address
1790 self.papi.nat_det_forward,
1791 {'in_addr': in_addr,
1794 def nat_det_reverse(
1798 """Get inside address from outside address and port
1800 :param out_addr - outside IP address
1801 :param out_port - outside port
1804 self.papi.nat_det_reverse,
1805 {'out_addr': out_addr,
1806 'out_port': out_port})
1808 def nat_det_map_dump(self):
1809 """Dump deterministic NAT mappings
1811 :return: Dictionary of deterministic NAT mappings
1813 return self.api(self.papi.nat_det_map_dump, {})
1815 def nat_set_timeouts(
1818 tcp_established=7440,
1821 """Set values of timeouts for NAT sessions (in seconds)
1823 :param udp - UDP timeout (Default value = 300)
1824 :param tcp_established - TCP established timeout (Default value = 7440)
1825 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1826 :param icmp - ICMP timeout (Default value = 60)
1829 self.papi.nat_set_timeouts,
1831 'tcp_established': tcp_established,
1832 'tcp_transitory': tcp_transitory,
1835 def nat_get_timeouts(self):
1836 """Get values of timeouts for NAT sessions
1838 :return: Timeouts for NAT sessions (in seconds)
1840 return self.api(self.papi.nat_get_timeouts, {})
1842 def nat_set_addr_and_port_alloc_alg(
1850 """Set address and port assignment algorithm
1852 :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1853 :param psid_offset: number of offset bits (valid only for MAP-E alg)
1854 :param psid_length: length of PSID (valid only for MAP-E alg)
1855 :param psid: Port Set Identifier value (valid only for MAP-E alg)
1856 :param start_port: beginning of the port range
1857 :param end_port: end of the port range
1860 self.papi.nat_set_addr_and_port_alloc_alg,
1862 'psid_offset': psid_offset,
1863 'psid_length': psid_length,
1865 'start_port': start_port,
1866 'end_port': end_port})
1868 def nat_get_addr_and_port_alloc_alg(self):
1869 """Get address and port assignment algorithm"""
1870 return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1872 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1873 """Set TCP MSS rewriting configuration
1875 :param enable: disable(0)/enable(1) MSS rewriting feature
1876 :param mss_value: MSS value to be used for MSS rewriting
1879 self.papi.nat_set_mss_clamping,
1880 {'enable': enable, 'mss_value': mss_value})
1882 def nat_get_mss_clamping(self):
1883 """Get TCP MSS rewriting configuration"""
1884 return self.api(self.papi.nat_get_mss_clamping, {})
1886 def nat_det_close_session_out(
1892 """Close deterministic NAT session using outside address and port
1894 :param out_addr - outside IP address
1895 :param out_port - outside port
1896 :param ext_addr - external host IP address
1897 :param ext_port - external host port
1900 self.papi.nat_det_close_session_out,
1901 {'out_addr': out_addr,
1902 'out_port': out_port,
1903 'ext_addr': ext_addr,
1904 'ext_port': ext_port})
1906 def nat_det_close_session_in(
1912 """Close deterministic NAT session using inside address and port
1914 :param in_addr - inside IP address
1915 :param in_port - inside port
1916 :param ext_addr - external host IP address
1917 :param ext_port - external host port
1920 self.papi.nat_det_close_session_in,
1921 {'in_addr': in_addr,
1923 'ext_addr': ext_addr,
1924 'ext_port': ext_port,
1927 def nat_det_session_dump(
1930 """Dump deterministic NAT sessions belonging to a user
1932 :param user_addr - inside IP address of the user
1933 :return: Dictionary of deterministic NAT sessions
1936 self.papi.nat_det_session_dump,
1938 'user_addr': user_addr})
1940 def nat64_add_del_pool_addr_range(
1946 """Add/del address range to NAT64 pool
1948 :param start_addr: First IP address
1949 :param end_addr: Last IP address
1950 :param vrf_id: VRF id for the address range
1951 :param is_add: 1 if add, 0 if delete (Default value = 1)
1954 self.papi.nat64_add_del_pool_addr_range,
1955 {'start_addr': start_addr,
1956 'end_addr': end_addr,
1960 def nat64_pool_addr_dump(self):
1961 """Dump NAT64 pool addresses
1962 :return: Dictionary of NAT64 pool addresses
1964 return self.api(self.papi.nat64_pool_addr_dump, {})
1966 def nat64_add_del_interface(
1971 """Enable/disable NAT64 feature on the interface
1972 :param sw_if_index: Index of the interface
1973 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1974 :param is_add: 1 if add, 0 if delete (Default value = 1)
1977 self.papi.nat64_add_del_interface,
1978 {'sw_if_index': sw_if_index,
1979 'is_inside': is_inside,
1982 def nat64_interface_dump(self):
1983 """Dump interfaces with NAT64 feature
1984 :return: Dictionary of interfaces with NAT64 feature
1986 return self.api(self.papi.nat64_interface_dump, {})
1988 def nat64_add_del_static_bib(
1997 """Add/delete S-NAT static BIB entry
1999 :param in_ip: Inside IPv6 address
2000 :param out_ip: Outside IPv4 address
2001 :param in_port: Inside port number
2002 :param out_port: Outside port number
2003 :param protocol: IP protocol
2004 :param vrf_id: VRF ID (Default value = 0)
2005 :param is_add: 1 if add, 0 if delete (Default value = 1)
2008 self.papi.nat64_add_del_static_bib,
2017 def nat64_bib_dump(self, protocol=255):
2020 :param protocol: IP protocol (Default value = 255, all BIBs)
2021 :returns: Dictionary of NAT64 BIB entries
2023 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
2025 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
2026 tcp_incoming_syn=6):
2027 """Set values of timeouts for NAT64 (in seconds)
2029 :param udpi: UDP timeout (Default value = 300)
2030 :param icmp: ICMP timeout (Default value = 60)
2031 :param tcp_trans: TCP transitory timeout (Default value = 240)
2032 :param tcp_est: TCP established timeout (Default value = 7440)
2033 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
2036 self.papi.nat64_set_timeouts,
2039 'tcp_trans': tcp_trans,
2041 'tcp_incoming_syn': tcp_incoming_syn})
2043 def nat64_get_timeouts(self):
2044 """Get values of timeouts for NAT64
2046 :return: Timeouts for NAT64 (in seconds)
2048 return self.api(self.papi.nat64_get_timeouts, {})
2050 def nat64_st_dump(self, protocol=255):
2051 """Dump NAT64 session table
2053 :param protocol: IP protocol (Default value = 255, all STs)
2054 :returns: Dictionary of NAT64 sesstion table entries
2056 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2058 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2059 """Add/del NAT64 prefix
2061 :param prefix: NAT64 prefix
2062 :param plen: NAT64 prefix length
2063 :param vrf_id: VRF id of tenant (Default 0)
2064 :param is_add: 1 if add, 0 if delete (Default value = 1)
2067 self.papi.nat64_add_del_prefix,
2073 def nat64_prefix_dump(self):
2074 """Dump NAT64 prefix
2076 :returns: Dictionary of NAT64 prefixes
2078 return self.api(self.papi.nat64_prefix_dump, {})
2080 def nat64_add_interface_addr(
2084 """Add/del NAT64 address from interface
2086 :param sw_if_index: Software index of the interface
2087 :param is_add: 1 if add, 0 if delete (Default value = 1)
2089 return self.api(self.papi.nat64_add_del_interface_addr,
2090 {'is_add': is_add, 'sw_if_index': sw_if_index})
2092 def dslite_set_aftr_addr(self, ip6, ip4):
2093 """Set DS-Lite AFTR addresses
2095 :param ip4: IPv4 address
2096 :param ip6: IPv6 address
2099 self.papi.dslite_set_aftr_addr,
2103 def dslite_set_b4_addr(self, ip6, ip4):
2104 """Set DS-Lite B4 IPv6 address
2106 :param ip4: IPv4 address
2107 :param ip6: IPv6 address
2110 self.papi.dslite_set_b4_addr,
2114 def dslite_add_del_pool_addr_range(
2119 """Add/del address range to DS-Lite pool
2121 :param start_addr: First IP address
2122 :param end_addr: Last IP address
2123 :param is_add: 1 if add, 0 if delete (Default value = 1)
2126 self.papi.dslite_add_del_pool_addr_range,
2127 {'start_addr': start_addr,
2128 'end_addr': end_addr,
2131 def nat66_add_del_interface(
2136 """Enable/disable NAT66 feature on the interface
2137 :param sw_if_index: Index of the interface
2138 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2139 :param is_add: 1 if add, 0 if delete (Default value = 1)
2142 self.papi.nat66_add_del_interface,
2143 {'sw_if_index': sw_if_index,
2144 'is_inside': is_inside,
2147 def nat66_add_del_static_mapping(
2153 """Add/delete NAT66 static mapping
2155 :param in_ip: Inside IPv6 address
2156 :param out_ip: Outside IPv6 address
2157 :param vrf_id: VRF ID (Default value = 0)
2158 :param is_add: 1 if add, 0 if delete (Default value = 1)
2161 self.papi.nat66_add_del_static_mapping,
2162 {'local_ip_address': in_ip,
2163 'external_ip_address': out_ip,
2167 def nat66_interface_dump(self):
2168 """Dump interfaces with NAT66 feature
2169 :return: Dictionary of interfaces with NAT66 feature
2171 return self.api(self.papi.nat66_interface_dump, {})
2173 def nat66_static_mapping_dump(self):
2174 """Dump NAT66 static mappings
2175 :return: Dictionary of NAT66 static mappings
2177 return self.api(self.papi.nat66_static_mapping_dump, {})
2179 def control_ping(self):
2180 self.api(self.papi.control_ping)
2182 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2183 detect_mult, local_addr, peer_addr, is_ipv6=0,
2184 bfd_key_id=None, conf_key_id=None):
2185 if bfd_key_id is None:
2186 return self.api(self.papi.bfd_udp_add,
2188 'sw_if_index': sw_if_index,
2189 'desired_min_tx': desired_min_tx,
2190 'required_min_rx': required_min_rx,
2191 'local_addr': local_addr,
2192 'peer_addr': peer_addr,
2194 'detect_mult': detect_mult,
2197 return self.api(self.papi.bfd_udp_add,
2199 'sw_if_index': sw_if_index,
2200 'desired_min_tx': desired_min_tx,
2201 'required_min_rx': required_min_rx,
2202 'local_addr': local_addr,
2203 'peer_addr': peer_addr,
2205 'detect_mult': detect_mult,
2206 'is_authenticated': 1,
2207 'bfd_key_id': bfd_key_id,
2208 'conf_key_id': conf_key_id,
2211 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2212 detect_mult, local_addr, peer_addr, is_ipv6=0):
2213 return self.api(self.papi.bfd_udp_mod,
2215 'sw_if_index': sw_if_index,
2216 'desired_min_tx': desired_min_tx,
2217 'required_min_rx': required_min_rx,
2218 'local_addr': local_addr,
2219 'peer_addr': peer_addr,
2221 'detect_mult': detect_mult,
2224 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2225 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2227 return self.api(self.papi.bfd_udp_auth_activate,
2229 'sw_if_index': sw_if_index,
2230 'local_addr': local_addr,
2231 'peer_addr': peer_addr,
2233 'is_delayed': 1 if is_delayed else 0,
2234 'bfd_key_id': bfd_key_id,
2235 'conf_key_id': conf_key_id,
2238 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2239 is_ipv6=0, is_delayed=False):
2240 return self.api(self.papi.bfd_udp_auth_deactivate,
2242 'sw_if_index': sw_if_index,
2243 'local_addr': local_addr,
2244 'peer_addr': peer_addr,
2246 'is_delayed': 1 if is_delayed else 0,
2249 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2250 return self.api(self.papi.bfd_udp_del,
2252 'sw_if_index': sw_if_index,
2253 'local_addr': local_addr,
2254 'peer_addr': peer_addr,
2258 def bfd_udp_session_dump(self):
2259 return self.api(self.papi.bfd_udp_session_dump, {})
2261 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2262 peer_addr, is_ipv6=0):
2263 return self.api(self.papi.bfd_udp_session_set_flags, {
2264 'admin_up_down': admin_up_down,
2265 'sw_if_index': sw_if_index,
2266 'local_addr': local_addr,
2267 'peer_addr': peer_addr,
2271 def want_bfd_events(self, enable_disable=1):
2272 return self.api(self.papi.want_bfd_events, {
2273 'enable_disable': enable_disable,
2277 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2278 return self.api(self.papi.bfd_auth_set_key, {
2279 'conf_key_id': conf_key_id,
2280 'auth_type': auth_type,
2282 'key_len': len(key),
2285 def bfd_auth_del_key(self, conf_key_id):
2286 return self.api(self.papi.bfd_auth_del_key, {
2287 'conf_key_id': conf_key_id,
2290 def bfd_auth_keys_dump(self):
2291 return self.api(self.papi.bfd_auth_keys_dump, {})
2293 def bfd_udp_set_echo_source(self, sw_if_index):
2294 return self.api(self.papi.bfd_udp_set_echo_source,
2295 {'sw_if_index': sw_if_index})
2297 def bfd_udp_del_echo_source(self):
2298 return self.api(self.papi.bfd_udp_del_echo_source, {})
2300 def bfd_udp_get_echo_source(self):
2301 return self.api(self.papi.bfd_udp_get_echo_source, {})
2303 def classify_add_del_table(
2308 table_index=0xFFFFFFFF,
2310 memory_size=2097152,
2312 next_table_index=0xFFFFFFFF,
2313 miss_next_index=0xFFFFFFFF,
2314 current_data_flag=0,
2315 current_data_offset=0):
2319 :param match_n_vectors: (Default value = 1)
2320 :param table_index: (Default value = 0xFFFFFFFF)
2321 :param nbuckets: (Default value = 2)
2322 :param memory_size: (Default value = 2097152)
2323 :param skip_n_vectors: (Default value = 0)
2324 :param next_table_index: (Default value = 0xFFFFFFFF)
2325 :param miss_next_index: (Default value = 0xFFFFFFFF)
2326 :param current_data_flag: (Default value = 0)
2327 :param current_data_offset: (Default value = 0)
2330 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2331 mask = mask + '\0' * (mask_len - len(mask))
2333 self.papi.classify_add_del_table,
2335 'table_index': table_index,
2336 'nbuckets': nbuckets,
2337 'memory_size': memory_size,
2338 'skip_n_vectors': skip_n_vectors,
2339 'match_n_vectors': match_n_vectors,
2340 'next_table_index': next_table_index,
2341 'miss_next_index': miss_next_index,
2342 'current_data_flag': current_data_flag,
2343 'current_data_offset': current_data_offset,
2344 'mask_len': mask_len,
2347 def classify_add_del_session(
2352 opaque_index=0xFFFFFFFF,
2353 hit_next_index=0xFFFFFFFF,
2361 :param opaque_index: (Default value = 0xFFFFFFFF)
2362 :param hit_next_index: (Default value = 0xFFFFFFFF)
2363 :param advance: (Default value = 0)
2364 :param action: (Default value = 0)
2365 :param metadata: (Default value = 0)
2368 match_len = ((len(match) - 1) / 16 + 1) * 16
2369 match = match + '\0' * (match_len - len(match))
2371 self.papi.classify_add_del_session,
2373 'table_index': table_index,
2374 'hit_next_index': hit_next_index,
2375 'opaque_index': opaque_index,
2378 'metadata': metadata,
2379 'match_len': match_len,
2382 def input_acl_set_interface(
2386 ip4_table_index=0xFFFFFFFF,
2387 ip6_table_index=0xFFFFFFFF,
2388 l2_table_index=0xFFFFFFFF):
2392 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2393 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2394 :param l2_table_index: (Default value = 0xFFFFFFFF)
2398 self.papi.input_acl_set_interface,
2399 {'sw_if_index': sw_if_index,
2400 'ip4_table_index': ip4_table_index,
2401 'ip6_table_index': ip6_table_index,
2402 'l2_table_index': l2_table_index,
2405 def output_acl_set_interface(
2409 ip4_table_index=0xFFFFFFFF,
2410 ip6_table_index=0xFFFFFFFF,
2411 l2_table_index=0xFFFFFFFF):
2415 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2416 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2417 :param l2_table_index: (Default value = 0xFFFFFFFF)
2421 self.papi.output_acl_set_interface,
2422 {'sw_if_index': sw_if_index,
2423 'ip4_table_index': ip4_table_index,
2424 'ip6_table_index': ip6_table_index,
2425 'l2_table_index': l2_table_index,
2428 def set_ipfix_exporter(
2435 collector_port=4739,
2438 self.papi.set_ipfix_exporter,
2440 'collector_address': collector_address,
2441 'collector_port': collector_port,
2442 'src_address': src_address,
2444 'path_mtu': path_mtu,
2445 'template_interval': template_interval,
2446 'udp_checksum': udp_checksum,
2449 def dhcp_proxy_config(self,
2457 self.papi.dhcp_proxy_config,
2459 'rx_vrf_id': rx_table_id,
2460 'server_vrf_id': server_table_id,
2463 'dhcp_server': dhcp_server,
2464 'dhcp_src_address': dhcp_src_address,
2467 def dhcp_proxy_set_vss(self,
2476 self.papi.dhcp_proxy_set_vss,
2479 'vss_type': vss_type,
2480 'vpn_ascii_id': vpn_ascii_id,
2482 'vpn_index': vpn_index,
2487 def dhcp_client_dump(self):
2488 return self.api(self.papi.dhcp_client_dump, {})
2490 def dhcp_client(self,
2495 set_broadcast_flag=1,
2496 want_dhcp_events=0):
2498 self.papi.dhcp_client_config,
2502 'sw_if_index': sw_if_index,
2503 'hostname': hostname,
2505 'want_dhcp_event': want_dhcp_events,
2506 'set_broadcast_flag': set_broadcast_flag,
2510 def ip_mroute_add_del(self,
2516 next_hop_sw_if_index,
2526 IP Multicast Route add/del
2529 self.papi.ip_mroute_add_del,
2530 {'next_hop_sw_if_index': next_hop_sw_if_index,
2531 'entry_flags': e_flags,
2532 'itf_flags': i_flags,
2533 'table_id': table_id,
2537 'is_local': is_local,
2538 'bier_imp': bier_imp,
2539 'next_hop_afi': next_hop_afi,
2540 'grp_address_length': grp_address_length,
2541 'grp_address': grp_address,
2542 'src_address': src_address,
2543 'nh_address': next_hop_address})
2545 def mfib_signal_dump(self):
2546 return self.api(self.papi.mfib_signal_dump, {})
2548 def ip_mfib_dump(self):
2549 return self.api(self.papi.ip_mfib_dump, {})
2551 def ip6_mfib_dump(self):
2552 return self.api(self.papi.ip6_mfib_dump, {})
2554 def lisp_enable_disable(self, is_enabled):
2556 self.papi.lisp_enable_disable,
2558 'is_en': is_enabled,
2561 def lisp_locator_set(self,
2565 self.papi.lisp_add_del_locator_set,
2568 'locator_set_name': ls_name
2571 def lisp_locator_set_dump(self):
2572 return self.api(self.papi.lisp_locator_set_dump, {})
2574 def lisp_locator(self,
2581 self.papi.lisp_add_del_locator,
2584 'locator_set_name': ls_name,
2585 'sw_if_index': sw_if_index,
2586 'priority': priority,
2590 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2592 self.papi.lisp_locator_dump,
2594 'is_index_set': is_index_set,
2596 'ls_index': ls_index,
2599 def lisp_local_mapping(self,
2609 self.papi.lisp_add_del_local_eid,
2611 'locator_set_name': ls_name,
2613 'eid_type': eid_type,
2615 'prefix_len': prefix_len,
2621 def lisp_eid_table_dump(self,
2629 self.papi.lisp_eid_table_dump,
2632 'prefix_length': prefix_length,
2634 'eid_type': eid_type,
2636 'filter': filter_opt,
2639 def lisp_remote_mapping(self,
2649 self.papi.lisp_add_del_remote_mapping,
2652 'eid_type': eid_type,
2654 'eid_len': eid_prefix_len,
2655 'rloc_num': rlocs_num,
2658 'is_src_dst': is_src_dst,
2661 def lisp_adjacency(self,
2670 self.papi.lisp_add_del_adjacency,
2674 'eid_type': eid_type,
2677 'leid_len': leid_len,
2678 'reid_len': reid_len,
2681 def lisp_adjacencies_get(self, vni=0):
2683 self.papi.lisp_adjacencies_get,
2688 def map_add_domain(self,
2702 self.papi.map_add_domain,
2704 'ip6_prefix': ip6_prefix,
2705 'ip6_prefix_len': ip6_prefix_len,
2706 'ip4_prefix': ip4_prefix,
2707 'ip4_prefix_len': ip4_prefix_len,
2709 'ip6_src_prefix_len': ip6_src_prefix_len,
2710 'ea_bits_len': ea_bits_len,
2711 'psid_offset': psid_offset,
2712 'psid_length': psid_length,
2713 'is_translation': is_translation,
2714 'is_rfc6052': is_rfc6052,
2718 def gtpu_add_del_tunnel(
2724 mcast_sw_if_index=0xFFFFFFFF,
2726 decap_next_index=0xFFFFFFFF,
2730 :param is_add: (Default value = 1)
2731 :param is_ipv6: (Default value = 0)
2734 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2735 :param encap_vrf_id: (Default value = 0)
2736 :param decap_next_index: (Default value = 0xFFFFFFFF)
2737 :param teid: (Default value = 0)
2740 return self.api(self.papi.gtpu_add_del_tunnel,
2743 'src_address': src_addr,
2744 'dst_address': dst_addr,
2745 'mcast_sw_if_index': mcast_sw_if_index,
2746 'encap_vrf_id': encap_vrf_id,
2747 'decap_next_index': decap_next_index,
2750 def vxlan_gpe_add_del_tunnel(
2754 mcast_sw_if_index=0xFFFFFFFF,
2765 :param is_add: (Default value = 1)
2766 :param is_ipv6: (Default value = 0)
2767 :param encap_vrf_id: (Default value = 0)
2768 :param decap_vrf_id: (Default value = 0)
2769 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2770 :param protocol: (Default value = 3)
2771 :param vni: (Default value = 0)
2774 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2779 'mcast_sw_if_index': mcast_sw_if_index,
2780 'encap_vrf_id': encap_vrf_id,
2781 'decap_vrf_id': decap_vrf_id,
2782 'protocol': protocol,
2785 def vxlan_gbp_tunnel_add_del(
2789 mcast_sw_if_index=0xFFFFFFFF,
2794 instance=0xFFFFFFFF):
2799 :param is_add: (Default value = 1)
2800 :param is_ipv6: (Default value = 0)
2801 :param encap_table_id: (Default value = 0)
2802 :param decap_next_index: (Default value = 0xFFFFFFFF)
2803 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2804 :param vni: (Default value = 0)
2805 :param instance: (Default value = 0xFFFFFFFF)
2808 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2813 'mcast_sw_if_index': mcast_sw_if_index,
2814 'encap_table_id': encap_table_id,
2816 'instance': instance}})
2818 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2819 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2820 {'sw_if_index': sw_if_index})
2822 def pppoe_add_del_session(
2832 :param is_add: (Default value = 1)
2833 :param is_ipv6: (Default value = 0)
2835 :param session_id: (Default value = 0)
2837 :param decap_vrf_id: (Default value = 0)
2840 return self.api(self.papi.pppoe_add_del_session,
2843 'session_id': session_id,
2844 'client_ip': client_ip,
2845 'decap_vrf_id': decap_vrf_id,
2846 'client_mac': client_mac})
2848 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2849 return self.api(self.papi.sr_mpls_policy_add,
2853 'n_segments': len(segments),
2854 'segments': segments})
2856 def sr_mpls_policy_del(self, bsid):
2857 return self.api(self.papi.sr_mpls_policy_del,
2860 def sr_localsid_add_del(self,
2867 sw_if_index=0xFFFFFFFF,
2871 """ Add/del IPv6 SR local-SID.
2874 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2875 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2878 :param is_del: (Default value = 0)
2879 :param end_psp: (Default value = 0)
2880 :param sw_if_index: (Default value = 0xFFFFFFFF)
2881 :param vlan_index: (Default value = 0)
2882 :param fib_table: (Default value = 0)
2885 self.papi.sr_localsid_add_del,
2887 'localsid': localsid,
2889 'behavior': behavior,
2890 'sw_if_index': sw_if_index,
2891 'vlan_index': vlan_index,
2892 'fib_table': fib_table,
2893 'nh_addr4': nh_addr4,
2894 'nh_addr6': nh_addr6
2908 :param bsid_addr: bindingSID of the SR Policy
2909 :param weight: weight of the sid list. optional. (default: 1)
2910 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2912 :param type: type/behavior of the SR policy. (default or spray) \
2914 :param fib_table: VRF where to install the FIB entry for the BSID \
2916 :param n_segments: number of segments \
2918 :param segments: a vector of IPv6 address composing the segment list \
2922 self.papi.sr_policy_add,
2923 {'bsid_addr': bsid_addr,
2925 'is_encap': is_encap,
2927 'fib_table': fib_table,
2928 'n_segments': n_segments,
2929 'segments': segments
2938 :param bsid: bindingSID of the SR Policy
2939 :param sr_policy_index: index of the sr policy (default: 0)
2942 self.papi.sr_policy_del,
2943 {'bsid_addr': bsid_addr,
2944 'sr_policy_index': sr_policy_index
2947 def sr_steering_add_del(
2958 Steer traffic L2 and L3 traffic through a given SR policy
2960 :param is_del: delete or add
2961 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2962 :param sr_policy: is the index of the SR Policy (alt to bsid)
2963 :param table_id: is the VRF where to install the FIB entry for the BSID
2964 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2965 :param mask_width: is the mask for L3 traffic type
2966 :param sw_if_index: is the incoming interface for L2 traffic
2967 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2970 self.papi.sr_steering_add_del,
2972 'bsid_addr': bsid_addr,
2973 'sr_policy_index': sr_policy_index,
2974 'table_id': table_id,
2975 'prefix_addr': prefix_addr,
2976 'mask_width': mask_width,
2977 'sw_if_index': sw_if_index,
2978 'traffic_type': traffic_type
2981 def acl_add_replace(self, acl_index, r, tag='',
2983 """Add/replace an ACL
2984 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2985 :param acl_rule r: ACL rules array.
2986 :param str tag: symbolic tag (description) for this ACL.
2987 :param int count: number of rules.
2989 return self.api(self.papi.acl_add_replace,
2990 {'acl_index': acl_index,
2994 expected_retval=expected_retval)
2996 def acl_del(self, acl_index, expected_retval=0):
3002 return self.api(self.papi.acl_del,
3003 {'acl_index': acl_index},
3004 expected_retval=expected_retval)
3006 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
3008 return self.api(self.papi.acl_interface_set_acl_list,
3009 {'sw_if_index': sw_if_index,
3013 expected_retval=expected_retval)
3015 def acl_interface_set_etype_whitelist(self, sw_if_index,
3018 return self.api(self.papi.acl_interface_set_etype_whitelist,
3019 {'sw_if_index': sw_if_index,
3020 'count': len(whitelist),
3022 'whitelist': whitelist},
3023 expected_retval=expected_retval)
3025 def acl_interface_add_del(self,
3029 """ Add/Delete ACL to/from interface
3033 :param is_add: (Default value = 1)
3036 return self.api(self.papi.acl_interface_add_del,
3039 'sw_if_index': sw_if_index,
3040 'acl_index': acl_index})
3042 def acl_dump(self, acl_index, expected_retval=0):
3043 return self.api(self.papi.acl_dump,
3044 {'acl_index': acl_index},
3045 expected_retval=expected_retval)
3047 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3049 return self.api(self.papi.acl_interface_list_dump,
3050 {'sw_if_index': sw_if_index},
3051 expected_retval=expected_retval)
3053 def macip_acl_add(self, rules, tag=""):
3056 :param rules: list of rules for given acl
3060 return self.api(self.papi.macip_acl_add,
3062 'count': len(rules),
3065 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3068 :param rules: list of rules for given acl
3072 return self.api(self.papi.macip_acl_add_replace,
3073 {'acl_index': acl_index,
3075 'count': len(rules),
3078 def macip_acl_del(self, acl_index):
3084 return self.api(self.papi.macip_acl_del,
3085 {'acl_index': acl_index})
3087 def macip_acl_interface_add_del(self,
3091 """ Add MACIP acl to interface
3095 :param is_add: (Default value = 1)
3098 return self.api(self.papi.macip_acl_interface_add_del,
3100 'sw_if_index': sw_if_index,
3101 'acl_index': acl_index})
3103 def macip_acl_interface_get(self):
3104 """ Return interface acls dump
3107 self.papi.macip_acl_interface_get, {})
3109 def macip_acl_dump(self, acl_index=4294967295):
3110 """ Return MACIP acl dump
3114 self.papi.macip_acl_dump, {'acl_index': acl_index})
3116 def policer_add_del(self,
3127 conform_action_type=1,
3129 exceed_action_type=0,
3131 violate_action_type=0,
3133 return self.api(self.papi.policer_add_del,
3140 'rate_type': rate_type,
3141 'round_type': round_type,
3143 'color_aware': color_aware,
3144 'conform_action_type': conform_action_type,
3145 'conform_dscp': conform_dscp,
3146 'exceed_action_type': exceed_action_type,
3147 'exceed_dscp': exceed_dscp,
3148 'violate_action_type': violate_action_type,
3149 'violate_dscp': violate_dscp})
3151 def ip_punt_police(self,
3155 return self.api(self.papi.ip_punt_police,
3156 {'policer_index': policer_index,
3160 def ip_punt_redirect(self,
3166 return self.api(self.papi.ip_punt_redirect,
3167 {'rx_sw_if_index': rx_sw_if_index,
3168 'tx_sw_if_index': tx_sw_if_index,
3173 def bier_table_add_del(self,
3177 """ BIER Table add/del """
3179 self.papi.bier_table_add_del,
3180 {'bt_tbl_id': {"bt_set": bti.set_id,
3181 "bt_sub_domain": bti.sub_domain_id,
3182 "bt_hdr_len_id": bti.hdr_len_id},
3183 'bt_label': mpls_label,
3184 'bt_is_add': is_add})
3186 def bier_table_dump(self):
3187 return self.api(self.papi.bier_table_dump, {})
3189 def bier_route_add_del(self,
3195 """ BIER Route add/del """
3197 self.papi.bier_route_add_del,
3198 {'br_tbl_id': {"bt_set": bti.set_id,
3199 "bt_sub_domain": bti.sub_domain_id,
3200 "bt_hdr_len_id": bti.hdr_len_id},
3202 'br_n_paths': len(paths),
3204 'br_is_add': is_add,
3205 'br_is_replace': is_replace})
3207 def bier_route_dump(self, bti):
3209 self.papi.bier_route_dump,
3210 {'br_tbl_id': {"bt_set": bti.set_id,
3211 "bt_sub_domain": bti.sub_domain_id,
3212 "bt_hdr_len_id": bti.hdr_len_id}})
3214 def bier_imp_add(self,
3219 """ BIER Imposition Add """
3221 self.papi.bier_imp_add,
3222 {'bi_tbl_id': {"bt_set": bti.set_id,
3223 "bt_sub_domain": bti.sub_domain_id,
3224 "bt_hdr_len_id": bti.hdr_len_id},
3226 'bi_n_bytes': len(ibytes),
3227 'bi_bytes': ibytes})
3229 def bier_imp_del(self, bi_index):
3230 """ BIER Imposition del """
3232 self.papi.bier_imp_del,
3233 {'bi_index': bi_index})
3235 def bier_imp_dump(self):
3236 return self.api(self.papi.bier_imp_dump, {})
3238 def bier_disp_table_add_del(self,
3241 """ BIER Disposition Table add/del """
3243 self.papi.bier_disp_table_add_del,
3244 {'bdt_tbl_id': bdti,
3245 'bdt_is_add': is_add})
3247 def bier_disp_table_dump(self):
3248 return self.api(self.papi.bier_disp_table_dump, {})
3250 def bier_disp_entry_add_del(self,
3260 """ BIER Route add/del """
3262 while (len(lstack) < 16):
3265 self.papi.bier_disp_entry_add_del,
3266 {'bde_tbl_id': bdti,
3268 'bde_payload_proto': payload_proto,
3270 'bde_paths': [{'next_hop': next_hop,
3271 'table_id': next_hop_tbl_id,
3272 'afi': next_hop_afi,
3273 'rpf_id': next_hop_rpf_id,
3275 'label_stack': lstack}],
3276 'bde_is_add': is_add})
3278 def bier_disp_entry_dump(self, bdti):
3280 self.papi.bier_disp_entry_dump,
3281 {'bde_tbl_id': bdti})
3283 def add_node_next(self, node_name, next_name):
3284 """ Set the next node for a given node request
3289 return self.api(self.papi.add_node_next,
3290 {'node_name': node_name,
3291 'next_name': next_name})
3293 def session_enable_disable(self, is_enabled):
3295 self.papi.session_enable_disable,
3296 {'is_enable': is_enabled})
3298 def ipsec_spd_add_del(self, spd_id, is_add=1):
3299 """ SPD add/del - Wrapper to add or del ipsec SPD
3300 Sample CLI : 'ipsec spd add 1'
3302 :param spd_id - SPD ID to be created in the vpp . mandatory
3303 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3305 :returns: reply from the API
3308 self.papi.ipsec_spd_add_del, {
3309 'spd_id': spd_id, 'is_add': is_add})
3311 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3312 """ IPSEC interface SPD add/del - \
3313 Wrapper to associate/disassociate SPD to interface in VPP
3314 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3316 :param spd_id - SPD ID to associate with the interface . mandatory
3317 :param sw_if_index - Interface Index which needs to ipsec \
3318 association mandatory
3319 :param is_add - add(1) or del(0) association with interface \
3320 (Default 1 - add) . optional
3321 :returns: reply from the API
3324 self.papi.ipsec_interface_add_del_spd,
3325 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3327 def ipsec_sad_add_del_entry(self,
3330 integrity_algorithm,
3335 tunnel_src_address='',
3336 tunnel_dst_address='',
3341 """ IPSEC SA add/del
3342 :param sad_id: security association ID
3343 :param spi: security param index of the SA in decimal
3344 :param integrity_algorithm:
3345 :param integrity_key:
3346 :param crypto_algorithm:
3348 :param protocol: AH(0) or ESP(1) protocol
3349 :param tunnel_src_address: tunnel mode outer src address
3350 :param tunnel_dst_address: tunnel mode outer dst address
3353 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3354 crypto and ipsec algorithms
3357 self.papi.ipsec_sad_add_del_entry,
3360 'tunnel_src_address': tunnel_src_address,
3361 'tunnel_dst_address': tunnel_dst_address,
3362 'protocol': protocol,
3363 'integrity_algorithm': integrity_algorithm,
3364 'integrity_key_length': len(integrity_key),
3365 'integrity_key': integrity_key,
3366 'crypto_algorithm': crypto_algorithm,
3367 'crypto_key_length': len(crypto_key) if crypto_key is not None
3369 'crypto_key': crypto_key,
3371 'is_tunnel': is_tunnel,
3372 'is_tunnel_ipv6': is_tunnel_ipv6,
3373 'udp_encap': udp_encap})
3375 def ipsec_spd_add_del_entry(self,
3378 local_address_start,
3380 remote_address_start,
3381 remote_address_stop,
3383 local_port_stop=65535,
3384 remote_port_start=0,
3385 remote_port_stop=65535,
3393 """ IPSEC policy SPD add/del -
3394 Wrapper to configure ipsec SPD policy entries in VPP
3395 :param spd_id: SPD ID for the policy
3396 :param local_address_start: local-ip-range start address
3397 :param local_address_stop : local-ip-range stop address
3398 :param remote_address_start: remote-ip-range start address
3399 :param remote_address_stop : remote-ip-range stop address
3400 :param local_port_start: (Default value = 0)
3401 :param local_port_stop: (Default value = 65535)
3402 :param remote_port_start: (Default value = 0)
3403 :param remote_port_stop: (Default value = 65535)
3404 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3405 :param sa_id: Security Association ID for mapping it to SPD
3406 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3408 :param priority: value for the spd action (Default value = 100)
3409 :param is_outbound: flag for inbound(0) or outbound(1)
3411 :param is_add: (Default value = 1)
3414 self.papi.ipsec_spd_add_del_entry,
3417 'local_address_start': local_address_start,
3418 'local_address_stop': local_address_stop,
3419 'remote_address_start': remote_address_start,
3420 'remote_address_stop': remote_address_stop,
3421 'local_port_start': local_port_start,
3422 'local_port_stop': local_port_stop,
3423 'remote_port_start': remote_port_start,
3424 'remote_port_stop': remote_port_stop,
3426 'protocol': protocol,
3428 'priority': priority,
3429 'is_outbound': is_outbound,
3431 'is_ip_any': is_ip_any})
3433 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3434 remote_spi, crypto_alg, local_crypto_key,
3435 remote_crypto_key, integ_alg, local_integ_key,
3436 remote_integ_key, is_add=1, esn=0,
3437 anti_replay=1, renumber=0, show_instance=0):
3439 self.papi.ipsec_tunnel_if_add_del,
3440 {'local_ip': local_ip, 'remote_ip': remote_ip,
3441 'local_spi': local_spi, 'remote_spi': remote_spi,
3442 'crypto_alg': crypto_alg,
3443 'local_crypto_key_len': len(local_crypto_key),
3444 'local_crypto_key': local_crypto_key,
3445 'remote_crypto_key_len': len(remote_crypto_key),
3446 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3447 'local_integ_key_len': len(local_integ_key),
3448 'local_integ_key': local_integ_key,
3449 'remote_integ_key_len': len(remote_integ_key),
3450 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3451 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3452 'show_instance': show_instance
3455 def ipsec_select_backend(self, protocol, index):
3456 return self.api(self.papi.ipsec_select_backend,
3457 {'protocol': protocol, 'index': index})
3459 def ipsec_backend_dump(self):
3460 return self.api(self.papi.ipsec_backend_dump, {})
3462 def app_namespace_add(self,
3466 sw_if_index=0xFFFFFFFF,
3469 self.papi.app_namespace_add_del,
3471 'sw_if_index': sw_if_index,
3472 'ip4_fib_id': ip4_fib_id,
3473 'ip6_fib_id': ip6_fib_id,
3474 'namespace_id': namespace_id,
3475 'namespace_id_len': len(namespace_id)})
3477 def punt_socket_register(self, l4_port, pathname, header_version=1,
3478 is_ip4=1, l4_protocol=0x11):
3479 """ Punt to socket """
3480 return self.api(self.papi.punt_socket_register,
3482 'l4_protocol': l4_protocol,
3484 'pathname': pathname,
3485 'header_version': header_version})
3487 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3488 expire_walk_interval_ms, is_ip6=0):
3489 """ Set IP reassembly parameters """
3490 return self.api(self.papi.ip_reassembly_set,
3492 'timeout_ms': timeout_ms,
3493 'expire_walk_interval_ms': expire_walk_interval_ms,
3494 'max_reassemblies': max_reassemblies})
3496 def ip_reassembly_get(self, is_ip6=0):
3497 """ Get IP reassembly parameters """
3498 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3500 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3502 """ Enable/disable IP reassembly """
3503 return self.api(self.papi.ip_reassembly_enable_disable,
3504 {'sw_if_index': sw_if_index,
3505 'enable_ip4': 1 if enable_ip4 else 0,
3506 'enable_ip6': 1 if enable_ip6 else 0,
3509 def gbp_endpoint_add(self, sw_if_index, ips, mac, epg, flags,
3511 """ GBP endpoint Add """
3512 return self.api(self.papi.gbp_endpoint_add,
3514 'sw_if_index': sw_if_index,
3526 def gbp_endpoint_del(self, handle):
3527 """ GBP endpoint Del """
3528 return self.api(self.papi.gbp_endpoint_del,
3531 def gbp_endpoint_dump(self):
3532 """ GBP endpoint Dump """
3533 return self.api(self.papi.gbp_endpoint_dump, {})
3535 def gbp_endpoint_group_add(self, epg, bd,
3536 rd, uplink_sw_if_index):
3537 """ GBP endpoint group Add """
3538 return self.api(self.papi.gbp_endpoint_group_add,
3541 'uplink_sw_if_index': uplink_sw_if_index,
3547 def gbp_endpoint_group_del(self, epg):
3548 """ GBP endpoint group Del """
3549 return self.api(self.papi.gbp_endpoint_group_del,
3552 def gbp_endpoint_group_dump(self):
3553 """ GBP endpoint group Dump """
3554 return self.api(self.papi.gbp_endpoint_group_dump, {})
3556 def gbp_bridge_domain_add(self, bd_id, flags,
3558 uu_fwd_sw_if_index):
3559 """ GBP bridge-domain Add """
3560 return self.api(self.papi.gbp_bridge_domain_add,
3564 'bvi_sw_if_index': bvi_sw_if_index,
3565 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
3569 def gbp_bridge_domain_del(self, bd_id):
3570 """ GBP bridge-domain Del """
3571 return self.api(self.papi.gbp_bridge_domain_del,
3574 def gbp_bridge_domain_dump(self):
3575 """ GBP Bridge Domain Dump """
3576 return self.api(self.papi.gbp_bridge_domain_dump, {})
3578 def gbp_route_domain_add(self, rd_id,
3582 ip6_uu_sw_if_index):
3583 """ GBP route-domain Add """
3584 return self.api(self.papi.gbp_route_domain_add,
3587 'ip4_table_id': ip4_table_id,
3588 'ip6_table_id': ip6_table_id,
3589 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
3590 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
3594 def gbp_route_domain_del(self, rd_id):
3595 """ GBP route-domain Del """
3596 return self.api(self.papi.gbp_route_domain_del,
3599 def gbp_route_domain_dump(self):
3600 """ GBP Route Domain Dump """
3601 return self.api(self.papi.gbp_route_domain_dump, {})
3603 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3604 """ GBP recirc Add/Del """
3605 return self.api(self.papi.gbp_recirc_add_del,
3609 'sw_if_index': sw_if_index,
3612 def gbp_recirc_dump(self):
3613 """ GBP recirc Dump """
3614 return self.api(self.papi.gbp_recirc_dump, {})
3616 def gbp_subnet_add_del(self, is_add, rd_id,
3618 sw_if_index=0xffffffff,
3620 """ GBP Subnet Add/Del """
3621 return self.api(self.papi.gbp_subnet_add_del,
3625 'sw_if_index': sw_if_index,
3630 def gbp_subnet_dump(self):
3631 """ GBP Subnet Dump """
3632 return self.api(self.papi.gbp_subnet_dump, {})
3634 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index, rules):
3635 """ GBP contract Add/Del """
3636 return self.api(self.papi.gbp_contract_add_del,
3639 'acl_index': acl_index,
3642 'n_rules': len(rules),
3645 def gbp_contract_dump(self):
3646 """ GBP contract Dump """
3647 return self.api(self.papi.gbp_contract_dump, {})
3649 def gbp_endpoint_learn_set_inactive_threshold(self, threshold):
3650 """ GBP set inactive threshold """
3651 return self.api(self.papi.gbp_endpoint_learn_set_inactive_threshold,
3652 {'threshold': threshold})
3654 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode):
3655 """ GBP VXLAN tunnel add """
3656 return self.api(self.papi.gbp_vxlan_tunnel_add,
3661 'bd_rd_id': bd_rd_id
3665 def gbp_vxlan_tunnel_del(self, vni):
3666 """ GBP VXLAN tunnel del """
3667 return self.api(self.papi.gbp_vxlan_tunnel_del,
3672 def gbp_vxlan_tunnel_dump(self):
3673 """ GBP VXLAN tunnel add/del """
3674 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
3676 def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3677 ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3679 """ 6RD tunnel Add """
3680 return self.api(self.papi.ipip_6rd_add_tunnel,
3681 {'ip4_table_id': ip4_table_id,
3682 'ip6_table_id': ip6_table_id,
3683 'ip6_prefix': ip6_prefix,
3684 'ip6_prefix_len': ip6_prefix_len,
3685 'ip4_prefix': ip4_prefix,
3686 'ip4_prefix_len': ip4_prefix_len,
3688 'security_check': security_check})
3690 def ipip_6rd_del_tunnel(self, sw_if_index):
3691 """ 6RD tunnel Delete """
3692 return self.api(self.papi.ipip_6rd_del_tunnel,
3693 {'sw_if_index': sw_if_index})
3695 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3696 instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3697 """ IPIP tunnel Add/Del """
3698 return self.api(self.papi.ipip_add_tunnel,
3699 {'is_ipv6': is_ipv6,
3700 'instance': instance,
3701 'src_address': src_address,
3702 'dst_address': dst_address,
3703 'table_id': table_id,
3706 def ipip_del_tunnel(self, sw_if_index):
3707 """ IPIP tunnel Delete """
3708 return self.api(self.papi.ipip_del_tunnel,
3709 {'sw_if_index': sw_if_index})
3711 def qos_egress_map_update(self, id, outputs):
3712 """ QOS egress map update """
3713 return self.api(self.papi.qos_egress_map_update,
3717 def qos_egress_map_delete(self, id):
3718 """ QOS egress map delete """
3719 return self.api(self.papi.qos_egress_map_delete,
3722 def qos_mark_enable_disable(self, sw_if_index,
3726 """ QOS Mark Enable/Disable """
3727 return self.api(self.papi.qos_mark_enable_disable,
3729 'sw_if_index': sw_if_index,
3730 'output_source': output_source,
3733 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3734 """ IP QoS recording Enble/Disable """
3735 return self.api(self.papi.qos_record_enable_disable,
3736 {'sw_if_index': sw_if_index,
3737 'input_source': input_source,
3740 def igmp_enable_disable(self, sw_if_index, enable, host):
3741 """ Enable/disable IGMP on a given interface """
3742 return self.api(self.papi.igmp_enable_disable,
3745 'sw_if_index': sw_if_index})
3747 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
3748 """ Add/del IGMP proxy device """
3749 return self.api(self.papi.igmp_proxy_device_add_del,
3750 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3753 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
3754 """ Add/del interface to/from IGMP proxy device """
3755 return self.api(self.papi.igmp_proxy_device_add_del_interface,
3756 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3759 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3760 """ Listen for new (S,G) on specified interface
3762 :param enable: add/del
3763 :param sw_if_index: interface sw index
3764 :param saddr: source ip4 addr
3765 :param gaddr: group ip4 addr
3767 return self.api(self.papi.igmp_listen,
3772 'sw_if_index': sw_if_index,
3773 'n_srcs': len(saddrs),
3782 def igmp_dump(self, sw_if_index=None):
3783 """ Dump all (S,G) interface configurations """
3784 if sw_if_index is None:
3785 sw_if_index = 0xffffffff
3786 return self.api(self.papi.igmp_dump,
3787 {'sw_if_index': sw_if_index})
3789 def igmp_clear_interface(self, sw_if_index):
3790 """ Remove all (S,G)s from specified interface
3791 doesn't send IGMP report!
3794 self.papi.igmp_clear_interface, {
3795 'sw_if_index': sw_if_index})
3797 def want_igmp_events(self, enable=1):
3798 return self.api(self.papi.want_igmp_events, {'enable': enable,
3799 'pid': os.getpid()})
3809 :param lb: load balance
3810 :param use_custom_mac: use custom mac
3811 :param mac_address: mac address
3814 self.papi.bond_create,
3817 'use_custom_mac': use_custom_mac,
3818 'mac_address': mac_address
3825 :param sw_if_index: interface the operation is applied to
3827 return self.api(self.papi.bond_delete,
3828 {'sw_if_index': sw_if_index})
3837 :param sw_if_index: slave sw_if_index
3838 :param bond_sw_if_index: bond sw_if_index
3839 :param is_passive: is passive lacp speaker
3840 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3843 self.papi.bond_enslave,
3844 {'sw_if_index': sw_if_index,
3845 'bond_sw_if_index': bond_sw_if_index,
3846 'is_passive': is_passive,
3847 'is_long_timeout': is_long_timeout
3850 def bond_detach_slave(
3854 :param sw_if_index: slave interface the operation is applied to
3856 return self.api(self.papi.bond_detach_slave,
3857 {'sw_if_index': sw_if_index})
3859 def sw_interface_slave_dump(
3863 :param sw_if_index: bond sw_if_index
3865 return self.api(self.papi.sw_interface_slave_dump,
3866 {'sw_if_index': sw_if_index})
3868 def sw_interface_bond_dump(
3873 return self.api(self.papi.sw_interface_bond_dump,
3876 def create_vhost_user_if(
3882 disable_indirect_desc,
3883 custom_dev_instance,
3888 :param is_server: is server
3889 :param sock_filename: socket name
3890 :param renumber: renumber
3891 :param disable_mrg_rxbuf: disable mergable rx buffers
3892 :param disable_indirect_desc: disable indirect descriptors
3893 :param custom_dev_instance: custom dev instance
3894 :param use_custom_mac: use custom mac
3895 :param mac_address: mac address
3896 :param tag: tag (default '')
3899 self.papi.create_vhost_user_if,
3900 {'is_server': is_server,
3901 'sock_filename': sock_filename,
3902 'renumber': renumber,
3903 'disable_mrg_rxbuf': disable_mrg_rxbuf,
3904 'disable_indirect_desc': disable_indirect_desc,
3905 'custom_dev_instance': custom_dev_instance,
3906 'use_custom_mac': use_custom_mac,
3907 'mac_address': mac_address,
3911 def delete_vhost_user_if(
3915 :param sw_if_index: interface the operation is applied to
3917 return self.api(self.papi.delete_vhost_user_if,
3918 {'sw_if_index': sw_if_index, })
3920 def sw_interface_vhost_user_dump(
3925 return self.api(self.papi.sw_interface_vhost_user_dump,
3928 def abf_policy_add_del(self, is_add, policy):
3930 self.papi.abf_policy_add_del,
3934 def abf_itf_attach_add_del(self, is_add, attach):
3936 self.papi.abf_itf_attach_add_del,
3940 def abf_policy_dump(self):
3942 self.papi.abf_policy_dump, {})
3944 def abf_itf_attach_dump(self):
3946 self.papi.abf_itf_attach_dump, {})
3948 def pipe_create(self, is_specified, user_instance):
3949 return self.api(self.papi.pipe_create,
3950 {'is_specified': is_specified,
3951 'user_instance': user_instance})
3953 def pipe_delete(self, parent_sw_if_index):
3954 return self.api(self.papi.pipe_delete,
3955 {'parent_sw_if_index': parent_sw_if_index})
3957 def pipe_dump(self):
3958 return self.api(self.papi.pipe_dump, {})
3972 return self.api(self.papi.memif_create,
3975 'rx_queues': rx_queues,
3976 'tx_queues': tx_queues,
3978 'socket_id': socket_id,
3980 'ring_size': ring_size,
3981 'buffer_size': buffer_size,
3982 'hw_addr': hw_addr})
3984 def memif_delete(self, sw_if_index):
3985 return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index})
3987 def memif_dump(self):
3988 return self.api(self.papi.memif_dump, {})
3990 def memif_socket_filename_add_del(
3991 self, is_add, socket_id, socket_filename):
3993 self.papi.memif_socket_filename_add_del,
3995 'socket_id': socket_id,
3996 'socket_filename': socket_filename})
3998 def memif_socket_filename_dump(self):
3999 return self.api(self.papi.memif_socket_filename_dump, {})
4001 def svs_table_add_del(self, af, table_id, is_add=1):
4002 return self.api(self.papi.svs_table_add_del,
4004 'table_id': table_id,
4009 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
4010 return self.api(self.papi.svs_route_add_del,
4012 'table_id': table_id,
4013 'source_table_id': src_table_id,
4018 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
4019 return self.api(self.papi.svs_enable_disable,
4022 'table_id': table_id,
4023 'sw_if_index': sw_if_index,
4024 'is_enable': is_enable,
4028 return self.api(self.papi.svs_dump, {})