3 from collections import deque
5 from six import moves, iteritems
6 from vpp_papi import VPP, mac_pton
8 from vpp_l2 import L2_PORT_TYPE
10 # from vnet/vnet/mpls/mpls_types.h
11 MPLS_IETF_MAX_LABEL = 0xfffff
12 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
34 class SYSLOG_SEVERITY:
45 # Dictionary keyed on message name to override default values for
48 defaultmapping = {'map_add_domain': {'mtu': 1280},
49 'syslog_set_sender': {'collector_port': 514,
53 class UnexpectedApiReturnValueError(Exception):
54 """ exception raised when the API return value is unexpected """
58 class VppPapiProvider(object):
59 """VPP-api provider using vpp-papi
61 @property hook: hook object providing before and after api/cli hooks
64 _zero, _negative = range(2)
66 def __init__(self, name, shm_prefix, test_class, read_timeout):
67 self.hook = Hook(test_class)
69 self.shm_prefix = shm_prefix
70 self.test_class = test_class
71 self._expect_api_retval = self._zero
72 self._expect_stack = []
74 install_dir = os.getenv('VPP_INSTALL_PATH')
76 # Vapi requires 'VPP_API_DIR', not set when run from Makefile.
77 if 'VPP_API_DIR' not in os.environ:
78 os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH')
80 self.vpp = VPP(logger=test_class.logger,
81 read_timeout=read_timeout)
82 self._events = deque()
87 def assert_negative_api_retval(self):
88 """ Expect API failure - used with with, e.g.:
89 with self.vapi.assert_negative_api_retval():
90 self.vapi.<api call expected to fail>
92 self._expect_stack.append(self._expect_api_retval)
93 self._expect_api_retval = self._negative
96 def assert_zero_api_retval(self):
97 """ Expect API success - used with with, e.g.:
98 with self.vapi.assert_negative_api_retval():
99 self.vapi.<api call expected to succeed>
101 note: this is useful only inside another with block
102 as success is the default expected value
104 self._expect_stack.append(self._expect_api_retval)
105 self._expect_api_retval = self._zero
108 def __exit__(self, exc_type, exc_value, traceback):
109 self._expect_api_retval = self._expect_stack.pop()
111 def register_hook(self, hook):
112 """Replace hook registration with new hook
119 def collect_events(self):
120 """ Collect all events from the internal queue and clear the queue. """
122 self._events = deque()
125 def wait_for_event(self, timeout, name=None):
126 """ Wait for and return next event. """
128 self.test_class.logger.debug("Expecting event '%s' within %ss",
131 self.test_class.logger.debug("Expecting event within %ss",
134 self.test_class.logger.debug("Not waiting, event already queued")
135 limit = time.time() + timeout
136 while time.time() < limit:
138 e = self._events.popleft()
139 if name and type(e).__name__ != name:
141 "Unexpected event received: %s, expected: %s" %
142 (type(e).__name__, name))
143 self.test_class.logger.debug("Returning event %s:%s" %
146 time.sleep(0) # yield
147 raise Exception("Event did not occur within timeout")
149 def __call__(self, name, event):
150 """ Enqueue event in the internal event queue. """
151 # FIXME use the name instead of relying on type(e).__name__ ?
152 # FIXME #2 if this throws, it is eaten silently, Ole?
153 self.test_class.logger.debug("New event: %s: %s" % (name, event))
154 self._events.append(event)
156 def factory(self, name, apifn):
158 fields = apifn._func.msg.fields
160 # add positional and kw arguments
162 for i, o in enumerate(fields[3:]):
169 if name in defaultmapping:
170 for k, v in iteritems(defaultmapping[name]):
174 return self.api(apifn, d)
177 def __getattribute__(self, name):
179 method = super(VppPapiProvider, self).__getattribute__(name)
180 except AttributeError:
181 method = self.factory(name, getattr(self.papi, name))
182 # lazily load the method so we don't need to call factory
183 # again for this name.
184 setattr(self, name, method)
188 """Connect the API to VPP"""
189 self.vpp.connect(self.name, self.shm_prefix)
190 self.papi = self.vpp.api
191 self.vpp.register_event_callback(self)
193 def disconnect(self):
194 """Disconnect the API from VPP"""
195 self.vpp.disconnect()
197 def api(self, api_fn, api_args, expected_retval=0):
198 """ Call API function and check it's return value.
199 Call the appropriate hooks before and after the API call
201 :param api_fn: API function to call
202 :param api_args: tuple of API function arguments
203 :param expected_retval: Expected return value (Default value = 0)
204 :returns: reply from the API
207 self.hook.before_api(api_fn.__name__, api_args)
208 reply = api_fn(**api_args)
209 if self._expect_api_retval == self._negative:
210 if hasattr(reply, 'retval') and reply.retval >= 0:
211 msg = "API call passed unexpectedly: expected negative "\
212 "return value instead of %d in %s" % \
213 (reply.retval, moves.reprlib.repr(reply))
214 self.test_class.logger.info(msg)
215 raise UnexpectedApiReturnValueError(msg)
216 elif self._expect_api_retval == self._zero:
217 if hasattr(reply, 'retval') and reply.retval != expected_retval:
218 msg = "API call failed, expected %d return value instead "\
219 "of %d in %s" % (expected_retval, reply.retval,
220 moves.reprlib.repr(reply))
221 self.test_class.logger.info(msg)
222 raise UnexpectedApiReturnValueError(msg)
224 raise Exception("Internal error, unexpected value for "
225 "self._expect_api_retval %s" %
226 self._expect_api_retval)
227 self.hook.after_api(api_fn.__name__, api_args)
231 """ Execute a CLI, calling the before/after hooks appropriately.
233 :param cli: CLI to execute
237 self.hook.before_cli(cli)
239 r = self.papi.cli_inband(cmd=cli)
240 self.hook.after_cli(cli)
241 if hasattr(r, 'reply'):
244 def ppcli(self, cli):
245 """ Helper method to print CLI command in case of info logging level.
247 :param cli: CLI to execute
250 return cli + "\n" + str(self.cli(cli))
252 def show_version(self):
254 return self.api(self.papi.show_version, {})
256 def pg_create_interface(self, pg_index):
262 return self.api(self.papi.pg_create_interface,
263 {"interface_id": pg_index})
265 def sw_interface_dump(self, filter=None):
268 :param filter: (Default value = None)
271 if filter is not None:
272 args = {"name_filter_valid": 1, "name_filter": filter}
275 return self.api(self.papi.sw_interface_dump, args)
277 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
278 """ Set the IPvX Table-id for the Interface
285 return self.api(self.papi.sw_interface_set_table,
286 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
289 def sw_interface_get_table(self, sw_if_index, is_ipv6):
290 """ Get the IPvX Table-id for the Interface
297 return self.api(self.papi.sw_interface_get_table,
298 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6})
300 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
301 is_ipv6=0, is_add=1, del_all=0):
304 :param addr: param is_ipv6: (Default value = 0)
307 :param is_ipv6: (Default value = 0)
308 :param is_add: (Default value = 1)
309 :param del_all: (Default value = 0)
312 return self.api(self.papi.sw_interface_add_del_address,
313 {'sw_if_index': sw_if_index,
317 'address_length': addr_len,
320 def ip_address_dump(self, sw_if_index, is_ipv6=0):
321 return self.api(self.papi.ip_address_dump,
322 {'sw_if_index': sw_if_index,
325 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
327 """ Set the Interface to be unnumbered
329 :param is_add: (Default value = 1)
330 :param sw_if_index - interface That will be unnumbered
331 :param ip_sw_if_index - interface with an IP addres
334 return self.api(self.papi.sw_interface_set_unnumbered,
335 {'sw_if_index': ip_sw_if_index,
336 'unnumbered_sw_if_index': sw_if_index,
339 def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
340 return self.api(self.papi.ip_unnumbered_dump,
341 {'sw_if_index': sw_if_index})
343 def sw_interface_set_mpls_enable(self, sw_if_index,
346 Enable/Disable MPLS on the interface
348 :param is_enable: (Default value = 1)
351 return self.api(self.papi.sw_interface_set_mpls_enable,
352 {'sw_if_index': sw_if_index,
353 'enable': is_enable})
355 def set_ip_flow_hash(self,
364 return self.api(self.papi.set_ip_flow_hash,
374 def ip6nd_proxy_add_del(self, ip, sw_if_index, is_del=0):
375 return self.api(self.papi.ip6nd_proxy_add_del,
377 'sw_if_index': sw_if_index,
380 def sw_interface_ip6nd_ra_prefix(self,
390 val_lifetime=0xffffffff,
391 pref_lifetime=0xffffffff):
392 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
393 {'sw_if_index': sw_if_index,
396 'address_length': address_length,
398 'use_default': use_default,
399 'no_advertise': no_advertise,
400 'off_link': off_link,
401 'no_autoconfig': no_autoconfig,
402 'no_onlink': no_onlink,
404 'val_lifetime': val_lifetime,
405 'pref_lifetime': pref_lifetime})
407 def sw_interface_ip6_enable_disable(self, sw_if_index, enable):
409 Enable/Disable An interface for IPv6
411 return self.api(self.papi.sw_interface_ip6_enable_disable,
412 {'sw_if_index': sw_if_index,
415 def vxlan_add_del_tunnel(
419 mcast_sw_if_index=0xFFFFFFFF,
423 decap_next_index=0xFFFFFFFF,
425 instance=0xFFFFFFFF):
430 :param is_add: (Default value = 1)
431 :param is_ipv6: (Default value = 0)
432 :param encap_vrf_id: (Default value = 0)
433 :param decap_next_index: (Default value = 0xFFFFFFFF)
434 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
435 :param vni: (Default value = 0)
436 :param instance: (Default value = 0xFFFFFFFF)
439 return self.api(self.papi.vxlan_add_del_tunnel,
442 'src_address': src_addr,
443 'dst_address': dst_addr,
444 'mcast_sw_if_index': mcast_sw_if_index,
445 'encap_vrf_id': encap_vrf_id,
446 'decap_next_index': decap_next_index,
448 'instance': instance})
450 def geneve_add_del_tunnel(
454 mcast_sw_if_index=0xFFFFFFFF,
458 decap_next_index=0xFFFFFFFF,
464 :param is_add: (Default value = 1)
465 :param is_ipv6: (Default value = 0)
466 :param encap_vrf_id: (Default value = 0)
467 :param decap_next_index: (Default value = 0xFFFFFFFF)
468 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
469 :param vni: (Default value = 0)
472 return self.api(self.papi.geneve_add_del_tunnel,
475 'local_address': local_addr,
476 'remote_address': remote_addr,
477 'mcast_sw_if_index': mcast_sw_if_index,
478 'encap_vrf_id': encap_vrf_id,
479 'decap_next_index': decap_next_index,
482 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
483 learn=1, arp_term=0, is_add=1):
484 """Create/delete bridge domain.
486 :param int bd_id: Bridge domain index.
487 :param int flood: Enable/disable bcast/mcast flooding in the BD.
489 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
491 :param int forward: Enable/disable forwarding on all interfaces in
492 the BD. (Default value = 1)
493 :param int learn: Enable/disable learning on all interfaces in the BD.
495 :param int arp_term: Enable/disable arp termination in the BD.
497 :param int is_add: Add or delete flag. (Default value = 1)
499 return self.api(self.papi.bridge_domain_add_del,
502 'uu_flood': uu_flood,
505 'arp_term': arp_term,
508 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
509 return self.api(self.papi.bd_ip_mac_add_del,
515 def bd_ip_mac_dump(self, bd_id):
516 return self.api(self.papi.bd_ip_mac_dump,
519 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
520 return self.api(self.papi.want_ip4_arp_events,
521 {'enable_disable': enable_disable,
523 'pid': os.getpid(), })
525 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
526 return self.api(self.papi.want_ip6_nd_events,
527 {'enable_disable': enable_disable,
529 'pid': os.getpid(), })
531 def want_ip6_ra_events(self, enable_disable=1):
532 return self.api(self.papi.want_ip6_ra_events,
533 {'enable_disable': enable_disable,
534 'pid': os.getpid(), })
536 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
538 return self.api(self.papi.ip6nd_send_router_solicitation,
543 'sw_if_index': sw_if_index})
545 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
546 install_default_routes):
547 return self.api(self.papi.ip6_nd_address_autoconfig,
548 {'sw_if_index': sw_if_index,
550 'install_default_routes': install_default_routes})
552 def want_interface_events(self, enable_disable=1):
553 return self.api(self.papi.want_interface_events,
554 {'enable_disable': enable_disable,
555 'pid': os.getpid(), })
557 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
558 max_macs_in_event=0, learn_limit=0):
559 return self.api(self.papi.want_l2_macs_events,
560 {'enable_disable': enable_disable,
561 'scan_delay': scan_delay,
562 'max_macs_in_event': max_macs_in_event,
563 'learn_limit': learn_limit,
564 'pid': os.getpid(), })
566 def want_dhcp6_reply_events(self, enable_disable=1):
567 return self.api(self.papi.want_dhcp6_reply_events,
568 {'enable_disable': enable_disable,
571 def want_dhcp6_pd_reply_events(self, enable_disable=1):
572 return self.api(self.papi.want_dhcp6_pd_reply_events,
573 {'enable_disable': enable_disable,
576 def dhcp6_clients_enable_disable(self, enable=1):
577 return self.api(self.papi.dhcp6_clients_enable_disable,
580 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
581 addresses, server_index=0xFFFFFFFF,
582 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
584 return self.api(self.papi.dhcp6_send_client_message,
585 {'sw_if_index': sw_if_index,
586 'server_index': server_index,
592 'msg_type': msg_type,
595 'n_addresses': len(addresses),
596 'addresses': addresses})
598 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
599 prefixes, server_index=0xFFFFFFFF,
600 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
602 return self.api(self.papi.dhcp6_pd_send_client_message,
603 {'sw_if_index': sw_if_index,
604 'server_index': server_index,
610 'msg_type': msg_type,
613 'n_prefixes': len(prefixes),
614 'prefixes': prefixes})
616 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
618 return self.api(self.papi.dhcp6_client_enable_disable,
619 {'sw_if_index': sw_if_index,
622 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
624 return self.api(self.papi.dhcp6_pd_client_enable_disable,
625 {'sw_if_index': sw_if_index,
626 'prefix_group': prefix_group,
629 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
630 prefix_length, prefix_group,
632 return self.api(self.papi.ip6_add_del_address_using_prefix,
633 {'sw_if_index': sw_if_index,
634 'prefix_group': prefix_group,
636 'prefix_length': prefix_length,
639 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
640 filter_mac=0, bvi_mac=0):
641 """Create/delete L2 FIB entry.
643 :param str mac: MAC address to create FIB entry for.
644 :param int bd_id: Bridge domain index.
645 :param int sw_if_index: Software interface index of the interface.
646 :param int is_add: Add or delete flag. (Default value = 1)
647 :param int static_mac: Set to 1 to create static MAC entry.
649 :param int filter_mac: Set to 1 to drop packet that's source or
650 destination MAC address contains defined MAC address.
652 :param int bvi_mac: Set to 1 to create entry that points to BVI
653 interface. (Default value = 0)
655 return self.api(self.papi.l2fib_add_del,
658 'sw_if_index': sw_if_index,
660 'static_mac': static_mac,
661 'filter_mac': filter_mac,
664 def l2fib_flush_int(self, sw_if_index):
665 """Flush L2 FIB entries for sw_if_index.
667 :param int sw_if_index: Software interface index of the interface.
669 return self.api(self.papi.l2fib_flush_int,
670 {'sw_if_index': sw_if_index})
672 def l2fib_flush_bd(self, bd_id):
673 """Flush L2 FIB entries for bd_id.
675 :param int sw_if_index: Bridge Domain id.
677 return self.api(self.papi.l2fib_flush_bd,
680 def l2fib_flush_all(self):
683 return self.api(self.papi.l2fib_flush_all, {})
685 def l2_fib_table_dump(self, bd_id):
686 """ Dump the L2 FIB """
687 return self.api(self.papi.l2_fib_table_dump,
690 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
691 shg=0, port_type=L2_PORT_TYPE.NORMAL,
693 """Add/remove interface to/from bridge domain.
695 :param int sw_if_index: Software interface index of the interface.
696 :param int bd_id: Bridge domain index.
697 :param int shg: Split-horizon group index. (Default value = 0)
698 :param int bvi: Set interface as a bridge group virtual interface.
700 :param int enable: Add or remove interface. (Default value = 1)
702 return self.api(self.papi.sw_interface_set_l2_bridge,
703 {'rx_sw_if_index': sw_if_index,
706 'port_type': port_type,
709 def bridge_flags(self, bd_id, is_set, feature_bitmap):
710 """Enable/disable required feature of the bridge domain with defined
713 :param int bd_id: Bridge domain ID.
714 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
715 :param int flags: Bitmap value of the feature to be set:
719 - uu-flood (1 << 3) or
722 return self.api(self.papi.bridge_flags,
725 'flags': feature_bitmap})
727 def bridge_domain_dump(self, bd_id=0):
730 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
731 existing bridge domains returned)
732 :return: Dictionary of bridge domain(s) data.
734 return self.api(self.papi.bridge_domain_dump,
737 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
739 """Create or delete unidirectional cross-connect from Tx interface to
742 :param int rx_sw_if_index: Software interface index of Rx interface.
743 :param int tx_sw_if_index: Software interface index of Tx interface.
744 :param int enable: Create cross-connect if equal to 1, delete
745 cross-connect if equal to 0.
748 return self.api(self.papi.sw_interface_set_l2_xconnect,
749 {'rx_sw_if_index': rx_sw_if_index,
750 'tx_sw_if_index': tx_sw_if_index,
753 def l2_interface_vlan_tag_rewrite(
760 """L2 interface vlan tag rewrite configure request
761 :param client_index - opaque cookie to identify the sender
762 :param context - sender context, to match reply w/ request
763 :param sw_if_index - interface the operation is applied to
764 :param vtr_op - Choose from l2_vtr_op_t enum values
765 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
766 :param tag1 - Needed for any push or translate vtr op
767 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
770 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
771 {'sw_if_index': sw_if_index,
782 :param sw_if_index - interface the operation is applied to
785 return self.api(self.papi.l2_emulation,
786 {'sw_if_index': sw_if_index,
789 def sw_interface_set_ip_directed_broadcast(
793 """IP Directed broadcast
794 :param sw_if_index - interface the operation is applied to
797 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
798 {'sw_if_index': sw_if_index,
801 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
804 :param admin_up_down:
808 return self.api(self.papi.sw_interface_set_flags,
809 {'sw_if_index': sw_if_index,
810 'admin_up_down': admin_up_down})
812 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
818 return self.api(self.papi.sw_interface_set_mtu,
819 {'sw_if_index': sw_if_index,
822 def sw_interface_set_mac_address(self, sw_if_index, mac):
823 return self.api(self.papi.sw_interface_set_mac_address,
824 {'sw_if_index': sw_if_index,
827 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
828 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
829 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
830 """Create subinterface
831 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
833 :param sub_id: param inner_vlan:
837 :param no_tags: (Default value = 0)
838 :param one_tag: (Default value = 0)
839 :param two_tags: (Default value = 0)
840 :param dot1ad: (Default value = 0)
841 :param exact_match: (Default value = 0)
842 :param default_sub: (Default value = 0)
843 :param outer_vlan_id_any: (Default value = 0)
844 :param inner_vlan_id_any: (Default value = 0)
848 self.papi.create_subif,
849 {'sw_if_index': sw_if_index,
853 'two_tags': two_tags,
855 'exact_match': exact_match,
856 'default_sub': default_sub,
857 'outer_vlan_id_any': outer_vlan_id_any,
858 'inner_vlan_id_any': inner_vlan_id_any,
859 'outer_vlan_id': outer_vlan,
860 'inner_vlan_id': inner_vlan})
862 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
863 """Create p2p ethernet subinterface
865 :param sw_if_index: main (parent) interface
866 :param remote_mac: client (remote) mac address
870 self.papi.p2p_ethernet_add,
871 {'parent_if_index': sw_if_index,
872 'remote_mac': remote_mac,
873 'subif_id': subif_id})
875 def delete_subif(self, sw_if_index):
876 """Delete subinterface
880 return self.api(self.papi.delete_subif,
881 {'sw_if_index': sw_if_index})
883 def p2p_ethernet_del(self, sw_if_index, remote_mac):
884 """Delete p2p ethernet subinterface
886 :param sw_if_index: main (parent) interface
887 :param remote_mac: client (remote) mac address
891 self.papi.p2p_ethernet_del,
892 {'parent_if_index': sw_if_index,
893 'remote_mac': remote_mac})
895 def create_vlan_subif(self, sw_if_index, vlan):
902 return self.api(self.papi.create_vlan_subif,
903 {'sw_if_index': sw_if_index,
906 def create_loopback(self, mac=''):
909 :param mac: (Optional)
911 return self.api(self.papi.create_loopback,
912 {'mac_address': mac})
914 def delete_loopback(self, sw_if_index):
915 return self.api(self.papi.delete_loopback,
916 {'sw_if_index': sw_if_index, })
918 def ip_table_add_del(self,
925 :param is_add: (Default value = 1)
926 :param is_ipv6: (Default value = 0)
931 self.papi.ip_table_add_del,
932 {'table_id': table_id,
936 def ip_add_del_route(
941 next_hop_sw_if_index=0xFFFFFFFF,
945 next_hop_n_out_labels=0,
946 next_hop_out_label_stack=[],
947 next_hop_via_label=MPLS_LABEL_INVALID,
948 next_hop_id=0xFFFFFFFF,
950 is_resolve_attached=0,
951 classify_table_index=0xFFFFFFFF,
965 :param dst_address_length:
966 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
968 :param next_hop_address:
969 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
970 :param vrf_id: (Default value = 0)
971 :param lookup_in_vrf: (Default value = 0)
972 :param classify_table_index: (Default value = 0xFFFFFFFF)
973 :param is_add: (Default value = 1)
974 :param is_drop: (Default value = 0)
975 :param is_ipv6: (Default value = 0)
976 :param is_local: (Default value = 0)
977 :param is_classify: (Default value = 0)
978 :param is_multipath: (Default value = 0)
979 :param is_resolve_host: (Default value = 0)
980 :param is_resolve_attached: (Default value = 0)
981 :param is_dvr: (Default value = 0)
982 :param is_source_lookup: (Default value = 0)
983 :param next_hop_weight: (Default value = 1)
988 self.papi.ip_add_del_route,
989 {'next_hop_sw_if_index': next_hop_sw_if_index,
990 'table_id': table_id,
991 'classify_table_index': classify_table_index,
992 'next_hop_table_id': next_hop_table_id,
995 'is_unreach': is_unreach,
996 'is_prohibit': is_prohibit,
998 'is_local': is_local,
999 'is_classify': is_classify,
1000 'is_multipath': is_multipath,
1001 'is_resolve_host': is_resolve_host,
1002 'is_resolve_attached': is_resolve_attached,
1004 'is_source_lookup': is_source_lookup,
1005 'is_udp_encap': is_udp_encap,
1006 'next_hop_weight': next_hop_weight,
1007 'dst_address_length': dst_address_length,
1008 'dst_address': dst_address,
1009 'next_hop_id': next_hop_id,
1010 'next_hop_address': next_hop_address,
1011 'next_hop_n_out_labels': next_hop_n_out_labels,
1012 'next_hop_via_label': next_hop_via_label,
1013 'next_hop_out_label_stack': next_hop_out_label_stack})
1015 def ip_fib_dump(self):
1016 return self.api(self.papi.ip_fib_dump, {})
1018 def ip6_fib_dump(self):
1019 return self.api(self.papi.ip6_fib_dump, {})
1021 def ip_neighbor_add_del(self,
1027 """ Add neighbor MAC to IPv4 or IPv6 address.
1032 :param is_add: (Default value = 1)
1033 :param flags: (Default value = 0/NONE)
1036 self.papi.ip_neighbor_add_del,
1040 'sw_if_index': sw_if_index,
1042 'mac_address': mac_address,
1043 'ip_address': ip_address
1048 def ip_neighbor_dump(self,
1051 """ Return IP neighbor dump.
1054 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1058 self.papi.ip_neighbor_dump,
1059 {'is_ipv6': is_ipv6,
1060 'sw_if_index': sw_if_index
1064 def proxy_arp_add_del(self,
1069 """ Config Proxy Arp Range.
1071 :param low_address: Start address in the rnage to Proxy for
1072 :param hi_address: End address in the rnage to Proxy for
1073 :param vrf_id: The VRF/table in which to proxy
1077 self.papi.proxy_arp_add_del,
1080 'table_id': table_id,
1086 def proxy_arp_intfc_enable_disable(self,
1089 """ Enable/Disable an interface for proxy ARP requests
1091 :param sw_if_index: Interface
1092 :param enable_disable: Enable/Disable
1096 self.papi.proxy_arp_intfc_enable_disable,
1097 {'sw_if_index': sw_if_index,
1098 'enable_disable': is_enable
1106 """ Reset VRF (remove all routes etc.) request.
1108 :param int vrf_id: ID of the FIB table / VRF to reset.
1109 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1113 self.papi.reset_fib,
1124 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1129 {'is_ipv6': is_ipv6,
1133 def sw_interface_span_enable_disable(
1134 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1137 :param sw_if_index_from:
1138 :param sw_if_index_to:
1142 return self.api(self.papi.sw_interface_span_enable_disable,
1143 {'sw_if_index_from': sw_if_index_from,
1144 'sw_if_index_to': sw_if_index_to,
1149 def gre_add_del_tunnel(self,
1154 instance=0xFFFFFFFF,
1158 """ Add a GRE tunnel
1162 :param outer_fib_id: (Default value = 0)
1163 :param tunnel_type: (Default value = 0)
1164 :param instance: (Default value = 0xFFFFFFFF)
1165 :param session_id: (Defalt value = 0)
1166 :param is_add: (Default value = 1)
1167 :param is_ipv6: (Default value = 0)
1171 self.papi.gre_add_del_tunnel,
1174 'tunnel_type': tunnel_type,
1175 'instance': instance,
1176 'src_address': src_address,
1177 'dst_address': dst_address,
1178 'outer_fib_id': outer_fib_id,
1179 'session_id': session_id}
1182 def udp_encap_add(self,
1188 """ Add a GRE tunnel
1193 :param outer_fib_id: (Default value = 0)
1197 self.papi.udp_encap_add,
1202 'src_port': src_port,
1203 'dst_port': dst_port,
1204 'table_id': table_id
1208 def udp_encap_del(self, id):
1209 return self.api(self.papi.udp_encap_del, {'id': id})
1211 def udp_encap_dump(self):
1212 return self.api(self.papi.udp_encap_dump, {})
1214 def mpls_fib_dump(self):
1215 return self.api(self.papi.mpls_fib_dump, {})
1217 def mpls_table_add_del(
1224 :param is_add: (Default value = 1)
1229 self.papi.mpls_table_add_del,
1230 {'mt_table_id': table_id,
1231 'mt_is_add': is_add})
1233 def mpls_route_add_del(
1239 next_hop_sw_if_index=0xFFFFFFFF,
1241 next_hop_table_id=0,
1243 next_hop_n_out_labels=0,
1244 next_hop_out_label_stack=[],
1245 next_hop_via_label=MPLS_LABEL_INVALID,
1247 is_resolve_attached=0,
1254 classify_table_index=0xFFFFFFFF,
1258 :param dst_address_length:
1259 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1261 :param next_hop_address:
1262 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1263 :param vrf_id: (Default value = 0)
1264 :param lookup_in_vrf: (Default value = 0)
1265 :param classify_table_index: (Default value = 0xFFFFFFFF)
1266 :param is_add: (Default value = 1)
1267 :param is_drop: (Default value = 0)
1268 :param is_ipv6: (Default value = 0)
1269 :param is_local: (Default value = 0)
1270 :param is_classify: (Default value = 0)
1271 :param is_multipath: (Default value = 0)
1272 :param is_multicast: (Default value = 0)
1273 :param is_resolve_host: (Default value = 0)
1274 :param is_resolve_attached: (Default value = 0)
1275 :param next_hop_weight: (Default value = 1)
1279 self.papi.mpls_route_add_del,
1282 'mr_table_id': table_id,
1283 'mr_classify_table_index': classify_table_index,
1284 'mr_is_add': is_add,
1285 'mr_is_classify': is_classify,
1286 'mr_is_multipath': is_multipath,
1287 'mr_is_multicast': is_multicast,
1288 'mr_is_resolve_host': is_resolve_host,
1289 'mr_is_resolve_attached': is_resolve_attached,
1290 'mr_is_interface_rx': is_interface_rx,
1291 'mr_is_rpf_id': is_rpf_id,
1292 'mr_next_hop_proto': next_hop_proto,
1293 'mr_next_hop_weight': next_hop_weight,
1294 'mr_next_hop': next_hop_address,
1295 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1296 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1297 'mr_next_hop_table_id': next_hop_table_id,
1298 'mr_next_hop_via_label': next_hop_via_label,
1299 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1301 def mpls_ip_bind_unbind(
1313 self.papi.mpls_ip_bind_unbind,
1314 {'mb_mpls_table_id': table_id,
1316 'mb_ip_table_id': ip_table_id,
1317 'mb_is_bind': is_bind,
1318 'mb_is_ip4': is_ip4,
1319 'mb_address_length': dst_address_length,
1320 'mb_address': dst_address})
1322 def mpls_tunnel_add_del(
1325 next_hop_proto_is_ip4,
1327 next_hop_sw_if_index=0xFFFFFFFF,
1328 next_hop_table_id=0,
1330 next_hop_n_out_labels=0,
1331 next_hop_out_label_stack=[],
1332 next_hop_via_label=MPLS_LABEL_INVALID,
1338 :param dst_address_length:
1339 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1341 :param next_hop_address:
1342 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1343 :param vrf_id: (Default value = 0)
1344 :param lookup_in_vrf: (Default value = 0)
1345 :param classify_table_index: (Default value = 0xFFFFFFFF)
1346 :param is_add: (Default value = 1)
1347 :param is_drop: (Default value = 0)
1348 :param is_ipv6: (Default value = 0)
1349 :param is_local: (Default value = 0)
1350 :param is_classify: (Default value = 0)
1351 :param is_multipath: (Default value = 0)
1352 :param is_resolve_host: (Default value = 0)
1353 :param is_resolve_attached: (Default value = 0)
1354 :param next_hop_weight: (Default value = 1)
1355 :param is_multicast: (Default value = 0)
1359 self.papi.mpls_tunnel_add_del,
1360 {'mt_sw_if_index': tun_sw_if_index,
1361 'mt_is_add': is_add,
1362 'mt_l2_only': l2_only,
1363 'mt_is_multicast': is_multicast,
1364 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1365 'mt_next_hop_weight': next_hop_weight,
1366 'mt_next_hop': next_hop_address,
1367 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1368 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1369 'mt_next_hop_table_id': next_hop_table_id,
1370 'mt_next_hop_via_label': next_hop_via_label,
1371 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1373 def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
1374 return self.api(self.papi.mpls_tunnel_dump,
1375 {'sw_if_index': sw_if_index})
1377 def nat44_interface_add_del_feature(
1382 """Enable/disable NAT44 feature on the interface
1384 :param sw_if_index: Software index of the interface
1385 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1386 :param is_add: 1 if add, 0 if delete (Default value = 1)
1389 self.papi.nat44_interface_add_del_feature,
1391 'is_inside': is_inside,
1392 'sw_if_index': sw_if_index})
1394 def nat44_interface_add_del_output_feature(
1399 """Enable/disable NAT44 output feature on the interface
1401 :param sw_if_index: Software index of the interface
1402 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1403 :param is_add: 1 if add, 0 if delete (Default value = 1)
1406 self.papi.nat44_interface_add_del_output_feature,
1408 'is_inside': is_inside,
1409 'sw_if_index': sw_if_index})
1411 def nat44_add_del_static_mapping(
1415 external_sw_if_index=0xFFFFFFFF,
1426 """Add/delete NAT44 static mapping
1428 :param local_ip: Local IP address
1429 :param external_ip: External IP address
1430 :param external_sw_if_index: External interface instead of IP address
1431 :param local_port: Local port number (Default value = 0)
1432 :param external_port: External port number (Default value = 0)
1433 :param addr_only: 1 if address only mapping, 0 if address and port
1434 :param vrf_id: VRF ID
1435 :param protocol: IP protocol (Default value = 0)
1436 :param twice_nat: 1 if translate external host address and port
1437 :param self_twice_nat: 1 if translate external host address and port
1438 whenever external host address equals
1439 local address of internal host
1440 :param out2in_only: if 1 rule is matching only out2in direction
1441 :param tag: Opaque string tag
1442 :param is_add: 1 if add, 0 if delete (Default value = 1)
1445 self.papi.nat44_add_del_static_mapping,
1447 'addr_only': addr_only,
1448 'local_ip_address': local_ip,
1449 'external_ip_address': external_ip,
1450 'local_port': local_port,
1451 'external_port': external_port,
1452 'external_sw_if_index': external_sw_if_index,
1454 'protocol': protocol,
1455 'twice_nat': twice_nat,
1456 'self_twice_nat': self_twice_nat,
1457 'out2in_only': out2in_only,
1460 def nat44_add_del_identity_mapping(
1463 sw_if_index=0xFFFFFFFF,
1470 """Add/delete NAT44 identity mapping
1472 :param ip: IP address (Default value = 0)
1473 :param sw_if_index: Interface instead of IP address
1474 :param port: Port number (Default value = 0)
1475 :param addr_only: 1 if address only mapping, 0 if address and port
1476 :param vrf_id: VRF ID
1477 :param protocol: IP protocol (Default value = 0)
1478 :param tag: Opaque string tag
1479 :param is_add: 1 if add, 0 if delete (Default value = 1)
1482 self.papi.nat44_add_del_identity_mapping,
1484 'addr_only': addr_only,
1487 'sw_if_index': sw_if_index,
1490 'protocol': protocol})
1492 def nat44_add_del_address_range(
1499 """Add/del NAT44 address range
1501 :param first_ip_address: First IP address
1502 :param last_ip_address: Last IP address
1503 :param vrf_id: VRF id for the address range
1504 :param twice_nat: twice NAT address for extenal hosts
1505 :param is_add: 1 if add, 0 if delete (Default value = 1)
1508 self.papi.nat44_add_del_address_range,
1509 {'first_ip_address': first_ip_address,
1510 'last_ip_address': last_ip_address,
1512 'twice_nat': twice_nat,
1515 def nat44_address_dump(self):
1516 """Dump NAT44 addresses
1517 :return: Dictionary of NAT44 addresses
1519 return self.api(self.papi.nat44_address_dump, {})
1521 def nat44_interface_dump(self):
1522 """Dump interfaces with NAT44 feature
1523 :return: Dictionary of interfaces with NAT44 feature
1525 return self.api(self.papi.nat44_interface_dump, {})
1527 def nat44_interface_output_feature_dump(self):
1528 """Dump interfaces with NAT44 output feature
1529 :return: Dictionary of interfaces with NAT44 output feature
1531 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1533 def nat44_static_mapping_dump(self):
1534 """Dump NAT44 static mappings
1535 :return: Dictionary of NAT44 static mappings
1537 return self.api(self.papi.nat44_static_mapping_dump, {})
1539 def nat44_identity_mapping_dump(self):
1540 """Dump NAT44 identity mappings
1541 :return: Dictionary of NAT44 identity mappings
1543 return self.api(self.papi.nat44_identity_mapping_dump, {})
1545 def nat_show_config(self):
1546 """Show NAT plugin config
1547 :return: NAT plugin config parameters
1549 return self.api(self.papi.nat_show_config, {})
1551 def nat44_add_del_interface_addr(
1556 """Add/del NAT44 address from interface
1558 :param sw_if_index: Software index of the interface
1559 :param twice_nat: twice NAT address for extenal hosts
1560 :param is_add: 1 if add, 0 if delete (Default value = 1)
1563 self.papi.nat44_add_del_interface_addr,
1565 'sw_if_index': sw_if_index,
1566 'twice_nat': twice_nat})
1568 def nat44_interface_addr_dump(self):
1569 """Dump NAT44 addresses interfaces
1570 :return: Dictionary of NAT44 addresses interfaces
1572 return self.api(self.papi.nat44_interface_addr_dump, {})
1574 def nat_ipfix_enable_disable(
1579 """Enable/disable NAT IPFIX logging
1581 :param domain_id: Observation domain ID (Default value = 1)
1582 :param src_port: Source port number (Default value = 4739)
1583 :param enable: 1 if enable, 0 if disable (Default value = 1)
1586 self.papi.nat_ipfix_enable_disable,
1587 {'domain_id': domain_id,
1588 'src_port': src_port,
1591 def nat44_user_session_dump(
1595 """Dump NAT44 user's sessions
1597 :param ip_address: ip adress of the user to be dumped
1598 :param cpu_index: cpu_index on which the user is
1599 :param vrf_id: VRF ID
1600 :return: Dictionary of S-NAT sessions
1603 self.papi.nat44_user_session_dump,
1604 {'ip_address': ip_address,
1607 def nat44_user_dump(self):
1610 :return: Dictionary of NAT44 users
1612 return self.api(self.papi.nat44_user_dump, {})
1614 def nat44_add_del_lb_static_mapping(
1627 """Add/delete NAT44 load balancing static mapping
1629 :param twice_nat: 1 if translate external host address and port
1630 :param tag: Opaque string tag
1631 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1632 :param is_add - 1 if add, 0 if delete
1635 self.papi.nat44_add_del_lb_static_mapping,
1637 'external_addr': external_addr,
1638 'external_port': external_port,
1639 'protocol': protocol,
1640 'twice_nat': twice_nat,
1641 'self_twice_nat': self_twice_nat,
1642 'out2in_only': out2in_only,
1644 'affinity': affinity,
1645 'local_num': local_num,
1648 def nat44_lb_static_mapping_add_del_local(
1658 """Add/delete NAT44 load-balancing static mapping rule backend
1660 :param external_addr: external IPv4 address of the servic
1661 :param external_port: external L4 port number of the service
1662 :param local_addr: IPv4 address of the internal node
1663 :param local_port: L4 port number of the internal node
1664 :param protocol: IP protocol number
1665 :param probability: probability of the internal node
1666 :param vrf_id: VRF id of the internal node
1667 :param is_add: 1 if add, 0 if delete
1670 self.papi.nat44_lb_static_mapping_add_del_local,
1672 'external_addr': external_addr,
1673 'external_port': external_port,
1677 'probability': probability,
1679 'protocol': protocol})
1681 def nat44_lb_static_mapping_dump(self):
1682 """Dump NAT44 load balancing static mappings
1684 :return: Dictionary of NAT44 load balancing static mapping
1686 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1688 def nat44_del_session(
1695 ext_host_address=None,
1697 """Delete NAT44 session
1699 :param addr: IPv4 address
1700 :param por: port number
1701 :param protocol: IP protocol number
1702 :param vrf_id: VRF ID
1703 :param is_in: 1 if inside network addres and port pari, 0 if outside
1704 :param ext_host_address: external host IPv4 address
1705 :param ext_host_port: external host port
1707 if ext_host_address is None:
1709 self.papi.nat44_del_session,
1712 'protocol': protocol,
1717 self.papi.nat44_del_session,
1720 'protocol': protocol,
1723 'ext_host_valid': 1,
1724 'ext_host_address': ext_host_address,
1725 'ext_host_port': ext_host_port})
1727 def nat44_forwarding_enable_disable(
1730 """Enable/disable forwarding for NAT44
1732 :param enable: 1 for enable, 0 for disable
1735 self.papi.nat44_forwarding_enable_disable,
1745 """Set NAT virtual fragmentation reassembly
1747 :param timeout: reassembly timeout (Default 2sec)
1748 :param max_reass: maximum concurrent reassemblies (Default 1024)
1749 :param max_frag: maximum fragmets per reassembly (Default 5)
1750 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1751 :param is_ip6: 1 if IPv6, 0 if IPv4
1754 self.papi.nat_set_reass,
1755 {'timeout': timeout,
1756 'max_reass': max_reass,
1757 'max_frag': max_frag,
1758 'drop_frag': drop_frag,
1761 def nat_get_reass(self):
1762 """Get NAT virtual fragmentation reassembly configuration
1764 :return: NAT virtual fragmentation reassembly configuration
1766 return self.api(self.papi.nat_get_reass, {})
1768 def nat_reass_dump(self):
1769 """Dump NAT virtual fragmentation reassemblies
1771 :return: Dictionary of NAT virtual fragmentation reassemblies
1773 return self.api(self.papi.nat_reass_dump, {})
1775 def nat_det_add_del_map(
1782 """Add/delete deterministic NAT mapping
1784 :param is_add - 1 if add, 0 if delete
1785 :param in_addr - inside IP address
1786 :param in_plen - inside IP address prefix length
1787 :param out_addr - outside IP address
1788 :param out_plen - outside IP address prefix length
1791 self.papi.nat_det_add_del_map,
1796 'out_addr': out_addr,
1797 'out_plen': out_plen})
1799 def nat_det_forward(
1802 """Get outside address and port range from inside address
1804 :param in_addr - inside IP address
1807 self.papi.nat_det_forward,
1808 {'in_addr': in_addr,
1811 def nat_det_reverse(
1815 """Get inside address from outside address and port
1817 :param out_addr - outside IP address
1818 :param out_port - outside port
1821 self.papi.nat_det_reverse,
1822 {'out_addr': out_addr,
1823 'out_port': out_port})
1825 def nat_det_map_dump(self):
1826 """Dump deterministic NAT mappings
1828 :return: Dictionary of deterministic NAT mappings
1830 return self.api(self.papi.nat_det_map_dump, {})
1832 def nat_set_timeouts(
1835 tcp_established=7440,
1838 """Set values of timeouts for NAT sessions (in seconds)
1840 :param udp - UDP timeout (Default value = 300)
1841 :param tcp_established - TCP established timeout (Default value = 7440)
1842 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1843 :param icmp - ICMP timeout (Default value = 60)
1846 self.papi.nat_set_timeouts,
1848 'tcp_established': tcp_established,
1849 'tcp_transitory': tcp_transitory,
1852 def nat_get_timeouts(self):
1853 """Get values of timeouts for NAT sessions
1855 :return: Timeouts for NAT sessions (in seconds)
1857 return self.api(self.papi.nat_get_timeouts, {})
1859 def nat_set_addr_and_port_alloc_alg(
1867 """Set address and port assignment algorithm
1869 :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1870 :param psid_offset: number of offset bits (valid only for MAP-E alg)
1871 :param psid_length: length of PSID (valid only for MAP-E alg)
1872 :param psid: Port Set Identifier value (valid only for MAP-E alg)
1873 :param start_port: beginning of the port range
1874 :param end_port: end of the port range
1877 self.papi.nat_set_addr_and_port_alloc_alg,
1879 'psid_offset': psid_offset,
1880 'psid_length': psid_length,
1882 'start_port': start_port,
1883 'end_port': end_port})
1885 def nat_get_addr_and_port_alloc_alg(self):
1886 """Get address and port assignment algorithm"""
1887 return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1889 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1890 """Set TCP MSS rewriting configuration
1892 :param enable: disable(0)/enable(1) MSS rewriting feature
1893 :param mss_value: MSS value to be used for MSS rewriting
1896 self.papi.nat_set_mss_clamping,
1897 {'enable': enable, 'mss_value': mss_value})
1899 def nat_get_mss_clamping(self):
1900 """Get TCP MSS rewriting configuration"""
1901 return self.api(self.papi.nat_get_mss_clamping, {})
1903 def nat_det_close_session_out(
1909 """Close deterministic NAT session using outside address and port
1911 :param out_addr - outside IP address
1912 :param out_port - outside port
1913 :param ext_addr - external host IP address
1914 :param ext_port - external host port
1917 self.papi.nat_det_close_session_out,
1918 {'out_addr': out_addr,
1919 'out_port': out_port,
1920 'ext_addr': ext_addr,
1921 'ext_port': ext_port})
1923 def nat_det_close_session_in(
1929 """Close deterministic NAT session using inside address and port
1931 :param in_addr - inside IP address
1932 :param in_port - inside port
1933 :param ext_addr - external host IP address
1934 :param ext_port - external host port
1937 self.papi.nat_det_close_session_in,
1938 {'in_addr': in_addr,
1940 'ext_addr': ext_addr,
1941 'ext_port': ext_port,
1944 def nat_det_session_dump(
1947 """Dump deterministic NAT sessions belonging to a user
1949 :param user_addr - inside IP address of the user
1950 :return: Dictionary of deterministic NAT sessions
1953 self.papi.nat_det_session_dump,
1955 'user_addr': user_addr})
1957 def nat64_add_del_pool_addr_range(
1963 """Add/del address range to NAT64 pool
1965 :param start_addr: First IP address
1966 :param end_addr: Last IP address
1967 :param vrf_id: VRF id for the address range
1968 :param is_add: 1 if add, 0 if delete (Default value = 1)
1971 self.papi.nat64_add_del_pool_addr_range,
1972 {'start_addr': start_addr,
1973 'end_addr': end_addr,
1977 def nat64_pool_addr_dump(self):
1978 """Dump NAT64 pool addresses
1979 :return: Dictionary of NAT64 pool addresses
1981 return self.api(self.papi.nat64_pool_addr_dump, {})
1983 def nat64_add_del_interface(
1988 """Enable/disable NAT64 feature on the interface
1989 :param sw_if_index: Index of the interface
1990 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1991 :param is_add: 1 if add, 0 if delete (Default value = 1)
1994 self.papi.nat64_add_del_interface,
1995 {'sw_if_index': sw_if_index,
1996 'is_inside': is_inside,
1999 def nat64_interface_dump(self):
2000 """Dump interfaces with NAT64 feature
2001 :return: Dictionary of interfaces with NAT64 feature
2003 return self.api(self.papi.nat64_interface_dump, {})
2005 def nat64_add_del_static_bib(
2014 """Add/delete S-NAT static BIB entry
2016 :param in_ip: Inside IPv6 address
2017 :param out_ip: Outside IPv4 address
2018 :param in_port: Inside port number
2019 :param out_port: Outside port number
2020 :param protocol: IP protocol
2021 :param vrf_id: VRF ID (Default value = 0)
2022 :param is_add: 1 if add, 0 if delete (Default value = 1)
2025 self.papi.nat64_add_del_static_bib,
2034 def nat64_bib_dump(self, protocol=255):
2037 :param protocol: IP protocol (Default value = 255, all BIBs)
2038 :returns: Dictionary of NAT64 BIB entries
2040 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
2042 def nat64_st_dump(self, protocol=255):
2043 """Dump NAT64 session table
2045 :param protocol: IP protocol (Default value = 255, all STs)
2046 :returns: Dictionary of NAT64 sesstion table entries
2048 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2050 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2051 """Add/del NAT64 prefix
2053 :param prefix: NAT64 prefix
2054 :param plen: NAT64 prefix length
2055 :param vrf_id: VRF id of tenant (Default 0)
2056 :param is_add: 1 if add, 0 if delete (Default value = 1)
2059 self.papi.nat64_add_del_prefix,
2065 def nat64_prefix_dump(self):
2066 """Dump NAT64 prefix
2068 :returns: Dictionary of NAT64 prefixes
2070 return self.api(self.papi.nat64_prefix_dump, {})
2072 def nat64_add_del_interface_addr(
2076 """Add/del NAT64 address from interface
2078 :param sw_if_index: Software index of the interface
2079 :param is_add: 1 if add, 0 if delete (Default value = 1)
2081 return self.api(self.papi.nat64_add_del_interface_addr,
2082 {'is_add': is_add, 'sw_if_index': sw_if_index})
2084 def dslite_set_aftr_addr(self, ip6, ip4):
2085 """Set DS-Lite AFTR addresses
2087 :param ip4: IPv4 address
2088 :param ip6: IPv6 address
2091 self.papi.dslite_set_aftr_addr,
2095 def dslite_set_b4_addr(self, ip6, ip4):
2096 """Set DS-Lite B4 IPv6 address
2098 :param ip4: IPv4 address
2099 :param ip6: IPv6 address
2102 self.papi.dslite_set_b4_addr,
2106 def dslite_add_del_pool_addr_range(
2111 """Add/del address range to DS-Lite pool
2113 :param start_addr: First IP address
2114 :param end_addr: Last IP address
2115 :param is_add: 1 if add, 0 if delete (Default value = 1)
2118 self.papi.dslite_add_del_pool_addr_range,
2119 {'start_addr': start_addr,
2120 'end_addr': end_addr,
2123 def nat66_add_del_interface(
2128 """Enable/disable NAT66 feature on the interface
2129 :param sw_if_index: Index of the interface
2130 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2131 :param is_add: 1 if add, 0 if delete (Default value = 1)
2134 self.papi.nat66_add_del_interface,
2135 {'sw_if_index': sw_if_index,
2136 'is_inside': is_inside,
2139 def nat66_add_del_static_mapping(
2145 """Add/delete NAT66 static mapping
2147 :param in_ip: Inside IPv6 address
2148 :param out_ip: Outside IPv6 address
2149 :param vrf_id: VRF ID (Default value = 0)
2150 :param is_add: 1 if add, 0 if delete (Default value = 1)
2153 self.papi.nat66_add_del_static_mapping,
2154 {'local_ip_address': in_ip,
2155 'external_ip_address': out_ip,
2159 def nat66_interface_dump(self):
2160 """Dump interfaces with NAT66 feature
2161 :return: Dictionary of interfaces with NAT66 feature
2163 return self.api(self.papi.nat66_interface_dump, {})
2165 def nat66_static_mapping_dump(self):
2166 """Dump NAT66 static mappings
2167 :return: Dictionary of NAT66 static mappings
2169 return self.api(self.papi.nat66_static_mapping_dump, {})
2171 def nat_ha_set_listener(self, addr, port, path_mtu=512):
2172 """Set HA listener (local settings)
2174 :param addr: local IP4 address
2175 :param port: local UDP port number
2176 :param path_mtu: path MTU (Default value = 512)
2178 return self.api(self.papi.nat_ha_set_listener,
2179 {'ip_address': addr,
2181 'path_mtu': path_mtu})
2183 def nat_ha_get_listener(self):
2184 """Get HA listener/local configuration"""
2185 return self.api(self.papi.nat_ha_get_listener, {})
2187 def nat_ha_set_failover(self, addr, port, refresh=10):
2188 """Set HA failover (remote settings)
2190 :param addr: failover IP4 address
2191 :param port: failvoer UDP port number
2192 :param refresh: number of seconds after which to send session refresh
2194 return self.api(self.papi.nat_ha_set_failover,
2195 {'ip_address': addr,
2197 'session_refresh_interval': refresh})
2199 def nat_ha_get_failover(self):
2200 """Get HA failover/remote settings reply"""
2201 return self.api(self.papi.nat_ha_get_failover, {})
2203 def nat_ha_flush(self):
2204 """Flush the current HA data"""
2205 return self.api(self.papi.nat_ha_flush, {})
2207 def nat_ha_resync(self, want_resync_event=1):
2208 """Resync HA (resend existing sessions to new failover)
2209 :param want_resync_event: if non-zero resync completed event sent
2211 return self.api(self.papi.nat_ha_resync,
2212 {'want_resync_event': want_resync_event,
2213 'pid': os.getpid()})
2215 def control_ping(self):
2216 self.api(self.papi.control_ping)
2218 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2219 detect_mult, local_addr, peer_addr, is_ipv6=0,
2220 bfd_key_id=None, conf_key_id=None):
2221 if bfd_key_id is None:
2222 return self.api(self.papi.bfd_udp_add,
2224 'sw_if_index': sw_if_index,
2225 'desired_min_tx': desired_min_tx,
2226 'required_min_rx': required_min_rx,
2227 'local_addr': local_addr,
2228 'peer_addr': peer_addr,
2230 'detect_mult': detect_mult,
2233 return self.api(self.papi.bfd_udp_add,
2235 'sw_if_index': sw_if_index,
2236 'desired_min_tx': desired_min_tx,
2237 'required_min_rx': required_min_rx,
2238 'local_addr': local_addr,
2239 'peer_addr': peer_addr,
2241 'detect_mult': detect_mult,
2242 'is_authenticated': 1,
2243 'bfd_key_id': bfd_key_id,
2244 'conf_key_id': conf_key_id,
2247 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2248 detect_mult, local_addr, peer_addr, is_ipv6=0):
2249 return self.api(self.papi.bfd_udp_mod,
2251 'sw_if_index': sw_if_index,
2252 'desired_min_tx': desired_min_tx,
2253 'required_min_rx': required_min_rx,
2254 'local_addr': local_addr,
2255 'peer_addr': peer_addr,
2257 'detect_mult': detect_mult,
2260 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2261 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2263 return self.api(self.papi.bfd_udp_auth_activate,
2265 'sw_if_index': sw_if_index,
2266 'local_addr': local_addr,
2267 'peer_addr': peer_addr,
2269 'is_delayed': 1 if is_delayed else 0,
2270 'bfd_key_id': bfd_key_id,
2271 'conf_key_id': conf_key_id,
2274 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2275 is_ipv6=0, is_delayed=False):
2276 return self.api(self.papi.bfd_udp_auth_deactivate,
2278 'sw_if_index': sw_if_index,
2279 'local_addr': local_addr,
2280 'peer_addr': peer_addr,
2282 'is_delayed': 1 if is_delayed else 0,
2285 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2286 return self.api(self.papi.bfd_udp_del,
2288 'sw_if_index': sw_if_index,
2289 'local_addr': local_addr,
2290 'peer_addr': peer_addr,
2294 def bfd_udp_session_dump(self):
2295 return self.api(self.papi.bfd_udp_session_dump, {})
2297 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2298 peer_addr, is_ipv6=0):
2299 return self.api(self.papi.bfd_udp_session_set_flags, {
2300 'admin_up_down': admin_up_down,
2301 'sw_if_index': sw_if_index,
2302 'local_addr': local_addr,
2303 'peer_addr': peer_addr,
2307 def want_bfd_events(self, enable_disable=1):
2308 return self.api(self.papi.want_bfd_events, {
2309 'enable_disable': enable_disable,
2313 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2314 return self.api(self.papi.bfd_auth_set_key, {
2315 'conf_key_id': conf_key_id,
2316 'auth_type': auth_type,
2318 'key_len': len(key),
2321 def bfd_auth_del_key(self, conf_key_id):
2322 return self.api(self.papi.bfd_auth_del_key, {
2323 'conf_key_id': conf_key_id,
2326 def bfd_auth_keys_dump(self):
2327 return self.api(self.papi.bfd_auth_keys_dump, {})
2329 def bfd_udp_set_echo_source(self, sw_if_index):
2330 return self.api(self.papi.bfd_udp_set_echo_source,
2331 {'sw_if_index': sw_if_index})
2333 def bfd_udp_del_echo_source(self):
2334 return self.api(self.papi.bfd_udp_del_echo_source, {})
2336 def bfd_udp_get_echo_source(self):
2337 return self.api(self.papi.bfd_udp_get_echo_source, {})
2339 def classify_add_del_table(
2344 table_index=0xFFFFFFFF,
2346 memory_size=2097152,
2348 next_table_index=0xFFFFFFFF,
2349 miss_next_index=0xFFFFFFFF,
2350 current_data_flag=0,
2351 current_data_offset=0):
2355 :param match_n_vectors: (Default value = 1)
2356 :param table_index: (Default value = 0xFFFFFFFF)
2357 :param nbuckets: (Default value = 2)
2358 :param memory_size: (Default value = 2097152)
2359 :param skip_n_vectors: (Default value = 0)
2360 :param next_table_index: (Default value = 0xFFFFFFFF)
2361 :param miss_next_index: (Default value = 0xFFFFFFFF)
2362 :param current_data_flag: (Default value = 0)
2363 :param current_data_offset: (Default value = 0)
2366 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2367 mask = mask + '\0' * (mask_len - len(mask))
2369 self.papi.classify_add_del_table,
2371 'table_index': table_index,
2372 'nbuckets': nbuckets,
2373 'memory_size': memory_size,
2374 'skip_n_vectors': skip_n_vectors,
2375 'match_n_vectors': match_n_vectors,
2376 'next_table_index': next_table_index,
2377 'miss_next_index': miss_next_index,
2378 'current_data_flag': current_data_flag,
2379 'current_data_offset': current_data_offset,
2380 'mask_len': mask_len,
2383 def classify_add_del_session(
2388 opaque_index=0xFFFFFFFF,
2389 hit_next_index=0xFFFFFFFF,
2397 :param opaque_index: (Default value = 0xFFFFFFFF)
2398 :param hit_next_index: (Default value = 0xFFFFFFFF)
2399 :param advance: (Default value = 0)
2400 :param action: (Default value = 0)
2401 :param metadata: (Default value = 0)
2404 match_len = ((len(match) - 1) / 16 + 1) * 16
2405 match = match + '\0' * (match_len - len(match))
2407 self.papi.classify_add_del_session,
2409 'table_index': table_index,
2410 'hit_next_index': hit_next_index,
2411 'opaque_index': opaque_index,
2414 'metadata': metadata,
2415 'match_len': match_len,
2418 def input_acl_set_interface(
2422 ip4_table_index=0xFFFFFFFF,
2423 ip6_table_index=0xFFFFFFFF,
2424 l2_table_index=0xFFFFFFFF):
2428 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2429 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2430 :param l2_table_index: (Default value = 0xFFFFFFFF)
2434 self.papi.input_acl_set_interface,
2435 {'sw_if_index': sw_if_index,
2436 'ip4_table_index': ip4_table_index,
2437 'ip6_table_index': ip6_table_index,
2438 'l2_table_index': l2_table_index,
2441 def output_acl_set_interface(
2445 ip4_table_index=0xFFFFFFFF,
2446 ip6_table_index=0xFFFFFFFF,
2447 l2_table_index=0xFFFFFFFF):
2451 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2452 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2453 :param l2_table_index: (Default value = 0xFFFFFFFF)
2457 self.papi.output_acl_set_interface,
2458 {'sw_if_index': sw_if_index,
2459 'ip4_table_index': ip4_table_index,
2460 'ip6_table_index': ip6_table_index,
2461 'l2_table_index': l2_table_index,
2464 def set_ipfix_exporter(
2471 collector_port=4739,
2474 self.papi.set_ipfix_exporter,
2476 'collector_address': collector_address,
2477 'collector_port': collector_port,
2478 'src_address': src_address,
2480 'path_mtu': path_mtu,
2481 'template_interval': template_interval,
2482 'udp_checksum': udp_checksum,
2485 def dhcp_proxy_config(self,
2493 self.papi.dhcp_proxy_config,
2495 'rx_vrf_id': rx_table_id,
2496 'server_vrf_id': server_table_id,
2499 'dhcp_server': dhcp_server,
2500 'dhcp_src_address': dhcp_src_address,
2503 def dhcp_proxy_set_vss(self,
2512 self.papi.dhcp_proxy_set_vss,
2515 'vss_type': vss_type,
2516 'vpn_ascii_id': vpn_ascii_id,
2518 'vpn_index': vpn_index,
2523 def dhcp_client_dump(self):
2524 return self.api(self.papi.dhcp_client_dump, {})
2526 def dhcp_client_config(self,
2531 set_broadcast_flag=1,
2532 want_dhcp_events=0):
2534 self.papi.dhcp_client_config,
2538 'sw_if_index': sw_if_index,
2539 'hostname': hostname,
2541 'want_dhcp_event': want_dhcp_events,
2542 'set_broadcast_flag': set_broadcast_flag,
2546 def ip_mroute_add_del(self,
2552 next_hop_sw_if_index,
2562 IP Multicast Route add/del
2565 self.papi.ip_mroute_add_del,
2566 {'next_hop_sw_if_index': next_hop_sw_if_index,
2567 'entry_flags': e_flags,
2568 'itf_flags': i_flags,
2569 'table_id': table_id,
2573 'is_local': is_local,
2574 'bier_imp': bier_imp,
2575 'next_hop_afi': next_hop_afi,
2576 'grp_address_length': grp_address_length,
2577 'grp_address': grp_address,
2578 'src_address': src_address,
2579 'nh_address': next_hop_address})
2581 def mfib_signal_dump(self):
2582 return self.api(self.papi.mfib_signal_dump, {})
2584 def ip_mfib_dump(self):
2585 return self.api(self.papi.ip_mfib_dump, {})
2587 def ip6_mfib_dump(self):
2588 return self.api(self.papi.ip6_mfib_dump, {})
2590 def lisp_enable_disable(self, is_enabled):
2592 self.papi.lisp_enable_disable,
2594 'is_en': is_enabled,
2597 def lisp_add_del_locator_set(self,
2601 self.papi.lisp_add_del_locator_set,
2604 'locator_set_name': ls_name
2607 def lisp_locator_set_dump(self):
2608 return self.api(self.papi.lisp_locator_set_dump, {})
2610 def lisp_add_del_locator(self,
2617 self.papi.lisp_add_del_locator,
2620 'locator_set_name': ls_name,
2621 'sw_if_index': sw_if_index,
2622 'priority': priority,
2626 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2628 self.papi.lisp_locator_dump,
2630 'is_index_set': is_index_set,
2632 'ls_index': ls_index,
2635 def lisp_add_del_local_eid(self,
2645 self.papi.lisp_add_del_local_eid,
2647 'locator_set_name': ls_name,
2649 'eid_type': eid_type,
2651 'prefix_len': prefix_len,
2657 def lisp_eid_table_dump(self,
2665 self.papi.lisp_eid_table_dump,
2668 'prefix_length': prefix_length,
2670 'eid_type': eid_type,
2672 'filter': filter_opt,
2675 def lisp_add_del_remote_mapping(self,
2685 self.papi.lisp_add_del_remote_mapping,
2688 'eid_type': eid_type,
2690 'eid_len': eid_prefix_len,
2691 'rloc_num': rlocs_num,
2694 'is_src_dst': is_src_dst,
2697 def lisp_add_del_adjacency(self,
2706 self.papi.lisp_add_del_adjacency,
2710 'eid_type': eid_type,
2713 'leid_len': leid_len,
2714 'reid_len': reid_len,
2717 def lisp_adjacencies_get(self, vni=0):
2719 self.papi.lisp_adjacencies_get,
2724 def gtpu_add_del_tunnel(
2730 mcast_sw_if_index=0xFFFFFFFF,
2732 decap_next_index=0xFFFFFFFF,
2736 :param is_add: (Default value = 1)
2737 :param is_ipv6: (Default value = 0)
2740 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2741 :param encap_vrf_id: (Default value = 0)
2742 :param decap_next_index: (Default value = 0xFFFFFFFF)
2743 :param teid: (Default value = 0)
2746 return self.api(self.papi.gtpu_add_del_tunnel,
2749 'src_address': src_addr,
2750 'dst_address': dst_addr,
2751 'mcast_sw_if_index': mcast_sw_if_index,
2752 'encap_vrf_id': encap_vrf_id,
2753 'decap_next_index': decap_next_index,
2756 def vxlan_gpe_add_del_tunnel(
2760 mcast_sw_if_index=0xFFFFFFFF,
2771 :param is_add: (Default value = 1)
2772 :param is_ipv6: (Default value = 0)
2773 :param encap_vrf_id: (Default value = 0)
2774 :param decap_vrf_id: (Default value = 0)
2775 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2776 :param protocol: (Default value = 3)
2777 :param vni: (Default value = 0)
2780 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2785 'mcast_sw_if_index': mcast_sw_if_index,
2786 'encap_vrf_id': encap_vrf_id,
2787 'decap_vrf_id': decap_vrf_id,
2788 'protocol': protocol,
2791 def vxlan_gbp_tunnel_add_del(
2795 mcast_sw_if_index=0xFFFFFFFF,
2800 instance=0xFFFFFFFF):
2805 :param is_add: (Default value = 1)
2806 :param is_ipv6: (Default value = 0)
2807 :param encap_table_id: (Default value = 0)
2808 :param decap_next_index: (Default value = 0xFFFFFFFF)
2809 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2810 :param vni: (Default value = 0)
2811 :param instance: (Default value = 0xFFFFFFFF)
2814 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2819 'mcast_sw_if_index': mcast_sw_if_index,
2820 'encap_table_id': encap_table_id,
2822 'instance': instance}})
2824 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2825 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2826 {'sw_if_index': sw_if_index,
2827 '_no_type_conversion': True})
2829 def pppoe_add_del_session(
2839 :param is_add: (Default value = 1)
2840 :param is_ipv6: (Default value = 0)
2842 :param session_id: (Default value = 0)
2844 :param decap_vrf_id: (Default value = 0)
2847 return self.api(self.papi.pppoe_add_del_session,
2850 'session_id': session_id,
2851 'client_ip': client_ip,
2852 'decap_vrf_id': decap_vrf_id,
2853 'client_mac': client_mac})
2855 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2856 return self.api(self.papi.sr_mpls_policy_add,
2860 'n_segments': len(segments),
2861 'segments': segments})
2863 def sr_mpls_policy_del(self, bsid):
2864 return self.api(self.papi.sr_mpls_policy_del,
2867 def sr_localsid_add_del(self,
2874 sw_if_index=0xFFFFFFFF,
2878 """ Add/del IPv6 SR local-SID.
2881 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2882 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2885 :param is_del: (Default value = 0)
2886 :param end_psp: (Default value = 0)
2887 :param sw_if_index: (Default value = 0xFFFFFFFF)
2888 :param vlan_index: (Default value = 0)
2889 :param fib_table: (Default value = 0)
2892 self.papi.sr_localsid_add_del,
2894 'localsid': localsid,
2896 'behavior': behavior,
2897 'sw_if_index': sw_if_index,
2898 'vlan_index': vlan_index,
2899 'fib_table': fib_table,
2900 'nh_addr4': nh_addr4,
2901 'nh_addr6': nh_addr6
2915 :param bsid_addr: bindingSID of the SR Policy
2916 :param weight: weight of the sid list. optional. (default: 1)
2917 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2919 :param type: type/behavior of the SR policy. (default or spray) \
2921 :param fib_table: VRF where to install the FIB entry for the BSID \
2923 :param n_segments: number of segments \
2925 :param segments: a vector of IPv6 address composing the segment list \
2929 self.papi.sr_policy_add,
2930 {'bsid_addr': bsid_addr,
2932 'is_encap': is_encap,
2934 'fib_table': fib_table,
2935 'n_segments': n_segments,
2936 'segments': segments
2945 :param bsid: bindingSID of the SR Policy
2946 :param sr_policy_index: index of the sr policy (default: 0)
2949 self.papi.sr_policy_del,
2950 {'bsid_addr': bsid_addr,
2951 'sr_policy_index': sr_policy_index
2954 def sr_steering_add_del(
2965 Steer traffic L2 and L3 traffic through a given SR policy
2967 :param is_del: delete or add
2968 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2969 :param sr_policy: is the index of the SR Policy (alt to bsid)
2970 :param table_id: is the VRF where to install the FIB entry for the BSID
2971 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2972 :param mask_width: is the mask for L3 traffic type
2973 :param sw_if_index: is the incoming interface for L2 traffic
2974 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2977 self.papi.sr_steering_add_del,
2979 'bsid_addr': bsid_addr,
2980 'sr_policy_index': sr_policy_index,
2981 'table_id': table_id,
2982 'prefix_addr': prefix_addr,
2983 'mask_width': mask_width,
2984 'sw_if_index': sw_if_index,
2985 'traffic_type': traffic_type
2988 def acl_add_replace(self, acl_index, r, tag='',
2990 """Add/replace an ACL
2991 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2992 :param acl_rule r: ACL rules array.
2993 :param str tag: symbolic tag (description) for this ACL.
2994 :param int count: number of rules.
2996 return self.api(self.papi.acl_add_replace,
2997 {'acl_index': acl_index,
3001 expected_retval=expected_retval)
3003 def acl_del(self, acl_index, expected_retval=0):
3009 return self.api(self.papi.acl_del,
3010 {'acl_index': acl_index},
3011 expected_retval=expected_retval)
3013 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
3015 return self.api(self.papi.acl_interface_set_acl_list,
3016 {'sw_if_index': sw_if_index,
3020 expected_retval=expected_retval)
3022 def acl_interface_set_etype_whitelist(self, sw_if_index,
3025 return self.api(self.papi.acl_interface_set_etype_whitelist,
3026 {'sw_if_index': sw_if_index,
3027 'count': len(whitelist),
3029 'whitelist': whitelist},
3030 expected_retval=expected_retval)
3032 def acl_interface_add_del(self,
3036 """ Add/Delete ACL to/from interface
3040 :param is_add: (Default value = 1)
3043 return self.api(self.papi.acl_interface_add_del,
3046 'sw_if_index': sw_if_index,
3047 'acl_index': acl_index})
3049 def acl_dump(self, acl_index, expected_retval=0):
3050 return self.api(self.papi.acl_dump,
3051 {'acl_index': acl_index},
3052 expected_retval=expected_retval)
3054 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3056 return self.api(self.papi.acl_interface_list_dump,
3057 {'sw_if_index': sw_if_index},
3058 expected_retval=expected_retval)
3060 def macip_acl_add(self, rules, tag=""):
3063 :param rules: list of rules for given acl
3067 return self.api(self.papi.macip_acl_add,
3069 'count': len(rules),
3072 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3075 :param rules: list of rules for given acl
3079 return self.api(self.papi.macip_acl_add_replace,
3080 {'acl_index': acl_index,
3082 'count': len(rules),
3085 def macip_acl_del(self, acl_index):
3091 return self.api(self.papi.macip_acl_del,
3092 {'acl_index': acl_index})
3094 def macip_acl_interface_add_del(self,
3098 """ Add MACIP acl to interface
3102 :param is_add: (Default value = 1)
3105 return self.api(self.papi.macip_acl_interface_add_del,
3107 'sw_if_index': sw_if_index,
3108 'acl_index': acl_index})
3110 def macip_acl_interface_get(self):
3111 """ Return interface acls dump
3114 self.papi.macip_acl_interface_get, {})
3116 def macip_acl_dump(self, acl_index=4294967295):
3117 """ Return MACIP acl dump
3121 self.papi.macip_acl_dump, {'acl_index': acl_index})
3123 def policer_add_del(self,
3134 conform_action_type=1,
3136 exceed_action_type=0,
3138 violate_action_type=0,
3140 return self.api(self.papi.policer_add_del,
3147 'rate_type': rate_type,
3148 'round_type': round_type,
3150 'color_aware': color_aware,
3151 'conform_action_type': conform_action_type,
3152 'conform_dscp': conform_dscp,
3153 'exceed_action_type': exceed_action_type,
3154 'exceed_dscp': exceed_dscp,
3155 'violate_action_type': violate_action_type,
3156 'violate_dscp': violate_dscp})
3158 def ip_punt_police(self,
3162 return self.api(self.papi.ip_punt_police,
3163 {'policer_index': policer_index,
3167 def ip_punt_redirect(self,
3172 return self.api(self.papi.ip_punt_redirect,
3173 {'punt': {'rx_sw_if_index': rx_sw_if_index,
3174 'tx_sw_if_index': tx_sw_if_index,
3178 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
3179 return self.api(self.papi.ip_punt_redirect_dump,
3180 {'sw_if_index': sw_if_index,
3181 'is_ipv6': is_ipv6})
3183 def bier_table_add_del(self,
3187 """ BIER Table add/del """
3189 self.papi.bier_table_add_del,
3190 {'bt_tbl_id': {"bt_set": bti.set_id,
3191 "bt_sub_domain": bti.sub_domain_id,
3192 "bt_hdr_len_id": bti.hdr_len_id},
3193 'bt_label': mpls_label,
3194 'bt_is_add': is_add})
3196 def bier_table_dump(self):
3197 return self.api(self.papi.bier_table_dump, {})
3199 def bier_route_add_del(self,
3205 """ BIER Route add/del """
3207 self.papi.bier_route_add_del,
3208 {'br_tbl_id': {"bt_set": bti.set_id,
3209 "bt_sub_domain": bti.sub_domain_id,
3210 "bt_hdr_len_id": bti.hdr_len_id},
3212 'br_n_paths': len(paths),
3214 'br_is_add': is_add,
3215 'br_is_replace': is_replace})
3217 def bier_route_dump(self, bti):
3219 self.papi.bier_route_dump,
3220 {'br_tbl_id': {"bt_set": bti.set_id,
3221 "bt_sub_domain": bti.sub_domain_id,
3222 "bt_hdr_len_id": bti.hdr_len_id}})
3224 def bier_imp_add(self,
3229 """ BIER Imposition Add """
3231 self.papi.bier_imp_add,
3232 {'bi_tbl_id': {"bt_set": bti.set_id,
3233 "bt_sub_domain": bti.sub_domain_id,
3234 "bt_hdr_len_id": bti.hdr_len_id},
3236 'bi_n_bytes': len(ibytes),
3237 'bi_bytes': ibytes})
3239 def bier_imp_del(self, bi_index):
3240 """ BIER Imposition del """
3242 self.papi.bier_imp_del,
3243 {'bi_index': bi_index})
3245 def bier_imp_dump(self):
3246 return self.api(self.papi.bier_imp_dump, {})
3248 def bier_disp_table_add_del(self,
3251 """ BIER Disposition Table add/del """
3253 self.papi.bier_disp_table_add_del,
3254 {'bdt_tbl_id': bdti,
3255 'bdt_is_add': is_add})
3257 def bier_disp_table_dump(self):
3258 return self.api(self.papi.bier_disp_table_dump, {})
3260 def bier_disp_entry_add_del(self,
3270 """ BIER Route add/del """
3272 while (len(lstack) < 16):
3275 self.papi.bier_disp_entry_add_del,
3276 {'bde_tbl_id': bdti,
3278 'bde_payload_proto': payload_proto,
3280 'bde_paths': [{'next_hop': next_hop,
3281 'table_id': next_hop_tbl_id,
3282 'afi': next_hop_afi,
3283 'rpf_id': next_hop_rpf_id,
3285 'label_stack': lstack}],
3286 'bde_is_add': is_add})
3288 def bier_disp_entry_dump(self, bdti):
3290 self.papi.bier_disp_entry_dump,
3291 {'bde_tbl_id': bdti})
3293 def add_node_next(self, node_name, next_name):
3294 """ Set the next node for a given node request
3299 return self.api(self.papi.add_node_next,
3300 {'node_name': node_name,
3301 'next_name': next_name})
3303 def session_enable_disable(self, is_enabled):
3305 self.papi.session_enable_disable,
3306 {'is_enable': is_enabled})
3308 def ipsec_spd_add_del(self, spd_id, is_add=1):
3309 """ SPD add/del - Wrapper to add or del ipsec SPD
3310 Sample CLI : 'ipsec spd add 1'
3312 :param spd_id - SPD ID to be created in the vpp . mandatory
3313 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3315 :returns: reply from the API
3318 self.papi.ipsec_spd_add_del, {
3319 'spd_id': spd_id, 'is_add': is_add})
3321 def ipsec_spds_dump(self):
3322 return self.api(self.papi.ipsec_spds_dump, {})
3324 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3325 """ IPSEC interface SPD add/del - \
3326 Wrapper to associate/disassociate SPD to interface in VPP
3327 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3329 :param spd_id - SPD ID to associate with the interface . mandatory
3330 :param sw_if_index - Interface Index which needs to ipsec \
3331 association mandatory
3332 :param is_add - add(1) or del(0) association with interface \
3333 (Default 1 - add) . optional
3334 :returns: reply from the API
3337 self.papi.ipsec_interface_add_del_spd,
3338 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3340 def ipsec_spd_interface_dump(self, spd_index=None):
3341 return self.api(self.papi.ipsec_spd_interface_dump,
3342 {'spd_index': spd_index if spd_index else 0,
3343 'spd_index_valid': 1 if spd_index else 0})
3345 def ipsec_sad_entry_add_del(self,
3348 integrity_algorithm,
3353 tunnel_src_address='',
3354 tunnel_dst_address='',
3357 """ IPSEC SA add/del
3358 :param sad_id: security association ID
3359 :param spi: security param index of the SA in decimal
3360 :param integrity_algorithm:
3361 :param integrity_key:
3362 :param crypto_algorithm:
3364 :param protocol: AH(0) or ESP(1) protocol
3365 :param tunnel_src_address: tunnel mode outer src address
3366 :param tunnel_dst_address: tunnel mode outer dst address
3369 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3370 crypto and ipsec algorithms
3373 self.papi.ipsec_sad_entry_add_del,
3380 'tunnel_src': tunnel_src_address,
3381 'tunnel_dst': tunnel_dst_address,
3382 'protocol': protocol,
3383 'integrity_algorithm': integrity_algorithm,
3385 'length': len(integrity_key),
3386 'data': integrity_key,
3388 'crypto_algorithm': crypto_algorithm,
3390 'length': len(crypto_key),
3397 def ipsec_sa_dump(self, sa_id=None):
3398 return self.api(self.papi.ipsec_sa_dump,
3399 {'sa_id': sa_id if sa_id else 0xffffffff})
3401 def ipsec_spd_entry_add_del(self,
3404 local_address_start,
3406 remote_address_start,
3407 remote_address_stop,
3409 local_port_stop=65535,
3410 remote_port_start=0,
3411 remote_port_stop=65535,
3419 """ IPSEC policy SPD add/del -
3420 Wrapper to configure ipsec SPD policy entries in VPP
3421 :param spd_id: SPD ID for the policy
3422 :param local_address_start: local-ip-range start address
3423 :param local_address_stop : local-ip-range stop address
3424 :param remote_address_start: remote-ip-range start address
3425 :param remote_address_stop : remote-ip-range stop address
3426 :param local_port_start: (Default value = 0)
3427 :param local_port_stop: (Default value = 65535)
3428 :param remote_port_start: (Default value = 0)
3429 :param remote_port_stop: (Default value = 65535)
3430 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3431 :param sa_id: Security Association ID for mapping it to SPD
3432 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3434 :param priority: value for the spd action (Default value = 100)
3435 :param is_outbound: flag for inbound(0) or outbound(1)
3437 :param is_add: (Default value = 1)
3440 self.papi.ipsec_spd_entry_add_del,
3447 'local_address_start': local_address_start,
3448 'local_address_stop': local_address_stop,
3449 'remote_address_start': remote_address_start,
3450 'remote_address_stop': remote_address_stop,
3451 'local_port_start': local_port_start,
3452 'local_port_stop': local_port_stop,
3453 'remote_port_start': remote_port_start,
3454 'remote_port_stop': remote_port_stop,
3455 'protocol': protocol,
3457 'priority': priority,
3458 'is_outbound': is_outbound,
3459 'is_ip_any': is_ip_any
3463 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
3464 return self.api(self.papi.ipsec_spd_dump,
3468 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3469 remote_spi, crypto_alg, local_crypto_key,
3470 remote_crypto_key, integ_alg, local_integ_key,
3471 remote_integ_key, is_add=1, esn=0,
3472 anti_replay=1, renumber=0, show_instance=0):
3474 self.papi.ipsec_tunnel_if_add_del,
3475 {'local_ip': local_ip, 'remote_ip': remote_ip,
3476 'local_spi': local_spi, 'remote_spi': remote_spi,
3477 'crypto_alg': crypto_alg,
3478 'local_crypto_key_len': len(local_crypto_key),
3479 'local_crypto_key': local_crypto_key,
3480 'remote_crypto_key_len': len(remote_crypto_key),
3481 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3482 'local_integ_key_len': len(local_integ_key),
3483 'local_integ_key': local_integ_key,
3484 'remote_integ_key_len': len(remote_integ_key),
3485 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3486 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3487 'show_instance': show_instance
3490 def ipsec_select_backend(self, protocol, index):
3491 return self.api(self.papi.ipsec_select_backend,
3492 {'protocol': protocol, 'index': index})
3494 def ipsec_backend_dump(self):
3495 return self.api(self.papi.ipsec_backend_dump, {})
3497 def app_namespace_add_del(self,
3501 sw_if_index=0xFFFFFFFF,
3504 self.papi.app_namespace_add_del,
3506 'sw_if_index': sw_if_index,
3507 'ip4_fib_id': ip4_fib_id,
3508 'ip6_fib_id': ip6_fib_id,
3509 'namespace_id': namespace_id,
3510 'namespace_id_len': len(namespace_id)})
3512 def punt_socket_register(self, port, pathname, protocol=0x11,
3513 header_version=1, is_ip4=1):
3514 """ Register punt socket """
3515 return self.api(self.papi.punt_socket_register,
3516 {'header_version': header_version,
3517 'punt': {'ipv': is_ip4,
3518 'l4_protocol': protocol,
3520 'pathname': pathname})
3522 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
3523 """ Unregister punt socket """
3524 return self.api(self.papi.punt_socket_deregister,
3525 {'punt': {'ipv': is_ip4,
3526 'l4_protocol': protocol,
3529 def punt_socket_dump(self, is_ip6=1):
3530 """ Dump punt socket"""
3531 return self.api(self.papi.punt_socket_dump,
3532 {'is_ipv6': is_ip6})
3534 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3535 expire_walk_interval_ms, is_ip6=0):
3536 """ Set IP reassembly parameters """
3537 return self.api(self.papi.ip_reassembly_set,
3539 'timeout_ms': timeout_ms,
3540 'expire_walk_interval_ms': expire_walk_interval_ms,
3541 'max_reassemblies': max_reassemblies})
3543 def ip_reassembly_get(self, is_ip6=0):
3544 """ Get IP reassembly parameters """
3545 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3547 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3549 """ Enable/disable IP reassembly """
3550 return self.api(self.papi.ip_reassembly_enable_disable,
3551 {'sw_if_index': sw_if_index,
3552 'enable_ip4': 1 if enable_ip4 else 0,
3553 'enable_ip6': 1 if enable_ip6 else 0,
3556 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
3558 """ GBP endpoint Add """
3559 return self.api(self.papi.gbp_endpoint_add,
3561 'sw_if_index': sw_if_index,
3572 def gbp_endpoint_del(self, handle):
3573 """ GBP endpoint Del """
3574 return self.api(self.papi.gbp_endpoint_del,
3577 def gbp_endpoint_dump(self):
3578 """ GBP endpoint Dump """
3579 return self.api(self.papi.gbp_endpoint_dump,
3580 {'_no_type_conversion': True})
3582 def gbp_endpoint_group_add(self, vnid, sclass, bd,
3583 rd, uplink_sw_if_index,
3585 """ GBP endpoint group Add """
3586 return self.api(self.papi.gbp_endpoint_group_add,
3589 'uplink_sw_if_index': uplink_sw_if_index,
3594 'retention': retention
3597 def gbp_endpoint_group_del(self, sclass):
3598 """ GBP endpoint group Del """
3599 return self.api(self.papi.gbp_endpoint_group_del,
3602 def gbp_endpoint_group_dump(self):
3603 """ GBP endpoint group Dump """
3604 return self.api(self.papi.gbp_endpoint_group_dump, {})
3606 def gbp_bridge_domain_add(self, bd_id, flags,
3609 bm_flood_sw_if_index):
3610 """ GBP bridge-domain Add """
3611 return self.api(self.papi.gbp_bridge_domain_add,
3615 'bvi_sw_if_index': bvi_sw_if_index,
3616 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
3617 'bm_flood_sw_if_index': bm_flood_sw_if_index,
3621 def gbp_bridge_domain_del(self, bd_id):
3622 """ GBP bridge-domain Del """
3623 return self.api(self.papi.gbp_bridge_domain_del,
3626 def gbp_bridge_domain_dump(self):
3627 """ GBP Bridge Domain Dump """
3628 return self.api(self.papi.gbp_bridge_domain_dump, {})
3630 def gbp_route_domain_add(self, rd_id,
3634 ip6_uu_sw_if_index):
3635 """ GBP route-domain Add """
3636 return self.api(self.papi.gbp_route_domain_add,
3639 'ip4_table_id': ip4_table_id,
3640 'ip6_table_id': ip6_table_id,
3641 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
3642 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
3646 def gbp_route_domain_del(self, rd_id):
3647 """ GBP route-domain Del """
3648 return self.api(self.papi.gbp_route_domain_del,
3651 def gbp_route_domain_dump(self):
3652 """ GBP Route Domain Dump """
3653 return self.api(self.papi.gbp_route_domain_dump, {})
3655 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
3656 """ GBP recirc Add/Del """
3657 return self.api(self.papi.gbp_recirc_add_del,
3661 'sw_if_index': sw_if_index,
3664 def gbp_recirc_dump(self):
3665 """ GBP recirc Dump """
3666 return self.api(self.papi.gbp_recirc_dump, {})
3668 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
3669 """ GBP recirc Add/Del """
3670 return self.api(self.papi.gbp_ext_itf_add_del,
3673 'sw_if_index': sw_if_index,
3677 def gbp_ext_itf_dump(self):
3678 """ GBP recirc Dump """
3679 return self.api(self.papi.gbp_ext_itf_dump, {})
3681 def gbp_subnet_add_del(self, is_add, rd_id,
3683 sw_if_index=0xffffffff,
3685 """ GBP Subnet Add/Del """
3686 return self.api(self.papi.gbp_subnet_add_del,
3690 'sw_if_index': sw_if_index,
3695 def gbp_subnet_dump(self):
3696 """ GBP Subnet Dump """
3697 return self.api(self.papi.gbp_subnet_dump,
3698 {'_no_type_conversion': True})
3700 def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
3701 rules, allowed_ethertypes):
3702 """ GBP contract Add/Del """
3703 return self.api(self.papi.gbp_contract_add_del,
3706 'acl_index': acl_index,
3709 'n_rules': len(rules),
3711 'n_ether_types': len(allowed_ethertypes),
3712 'allowed_ethertypes': allowed_ethertypes}})
3714 def gbp_contract_dump(self):
3715 """ GBP contract Dump """
3716 return self.api(self.papi.gbp_contract_dump, {})
3718 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
3719 """ GBP VXLAN tunnel add """
3720 return self.api(self.papi.gbp_vxlan_tunnel_add,
3725 'bd_rd_id': bd_rd_id,
3730 def gbp_vxlan_tunnel_del(self, vni):
3731 """ GBP VXLAN tunnel del """
3732 return self.api(self.papi.gbp_vxlan_tunnel_del,
3737 def gbp_vxlan_tunnel_dump(self):
3738 """ GBP VXLAN tunnel add/del """
3739 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
3741 def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3742 ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3744 """ 6RD tunnel Add """
3745 return self.api(self.papi.ipip_6rd_add_tunnel,
3746 {'ip4_table_id': ip4_table_id,
3747 'ip6_table_id': ip6_table_id,
3748 'ip6_prefix': ip6_prefix,
3749 'ip6_prefix_len': ip6_prefix_len,
3750 'ip4_prefix': ip4_prefix,
3751 'ip4_prefix_len': ip4_prefix_len,
3753 'security_check': security_check})
3755 def ipip_6rd_del_tunnel(self, sw_if_index):
3756 """ 6RD tunnel Delete """
3757 return self.api(self.papi.ipip_6rd_del_tunnel,
3758 {'sw_if_index': sw_if_index})
3760 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3761 instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3762 """ IPIP tunnel Add/Del """
3763 return self.api(self.papi.ipip_add_tunnel,
3764 {'is_ipv6': is_ipv6,
3765 'instance': instance,
3766 'src_address': src_address,
3767 'dst_address': dst_address,
3768 'table_id': table_id,
3771 def ipip_del_tunnel(self, sw_if_index):
3772 """ IPIP tunnel Delete """
3773 return self.api(self.papi.ipip_del_tunnel,
3774 {'sw_if_index': sw_if_index})
3776 def qos_egress_map_update(self, id, outputs):
3777 """ QOS egress map update """
3778 return self.api(self.papi.qos_egress_map_update,
3782 def qos_egress_map_delete(self, id):
3783 """ QOS egress map delete """
3784 return self.api(self.papi.qos_egress_map_delete,
3787 def qos_mark_enable_disable(self, sw_if_index,
3791 """ QOS Mark Enable/Disable """
3792 return self.api(self.papi.qos_mark_enable_disable,
3794 'sw_if_index': sw_if_index,
3795 'output_source': output_source,
3798 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3799 """ IP QoS recording Enble/Disable """
3800 return self.api(self.papi.qos_record_enable_disable,
3801 {'sw_if_index': sw_if_index,
3802 'input_source': input_source,
3805 def igmp_enable_disable(self, sw_if_index, enable, host):
3806 """ Enable/disable IGMP on a given interface """
3807 return self.api(self.papi.igmp_enable_disable,
3810 'sw_if_index': sw_if_index})
3812 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
3813 """ Add/del IGMP proxy device """
3814 return self.api(self.papi.igmp_proxy_device_add_del,
3815 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3818 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
3819 """ Add/del interface to/from IGMP proxy device """
3820 return self.api(self.papi.igmp_proxy_device_add_del_interface,
3821 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3824 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3825 """ Listen for new (S,G) on specified interface
3827 :param enable: add/del
3828 :param sw_if_index: interface sw index
3829 :param saddr: source ip4 addr
3830 :param gaddr: group ip4 addr
3832 return self.api(self.papi.igmp_listen,
3837 'sw_if_index': sw_if_index,
3838 'n_srcs': len(saddrs),
3844 def igmp_dump(self, sw_if_index=None):
3845 """ Dump all (S,G) interface configurations """
3846 if sw_if_index is None:
3847 sw_if_index = 0xffffffff
3848 return self.api(self.papi.igmp_dump,
3849 {'sw_if_index': sw_if_index})
3851 def igmp_clear_interface(self, sw_if_index):
3852 """ Remove all (S,G)s from specified interface
3853 doesn't send IGMP report!
3856 self.papi.igmp_clear_interface, {
3857 'sw_if_index': sw_if_index})
3859 def want_igmp_events(self, enable=1):
3860 return self.api(self.papi.want_igmp_events, {'enable': enable,
3861 'pid': os.getpid()})
3869 interface_id=0xFFFFFFFF):
3872 :param lb: load balance
3873 :param use_custom_mac: use custom mac
3874 :param mac_address: mac address
3875 :param interface_id: custom interface ID
3878 self.papi.bond_create,
3881 'use_custom_mac': use_custom_mac,
3882 'mac_address': mac_address,
3890 :param sw_if_index: interface the operation is applied to
3892 return self.api(self.papi.bond_delete,
3893 {'sw_if_index': sw_if_index})
3902 :param sw_if_index: slave sw_if_index
3903 :param bond_sw_if_index: bond sw_if_index
3904 :param is_passive: is passive lacp speaker
3905 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3908 self.papi.bond_enslave,
3909 {'sw_if_index': sw_if_index,
3910 'bond_sw_if_index': bond_sw_if_index,
3911 'is_passive': is_passive,
3912 'is_long_timeout': is_long_timeout
3915 def bond_detach_slave(
3919 :param sw_if_index: slave interface the operation is applied to
3921 return self.api(self.papi.bond_detach_slave,
3922 {'sw_if_index': sw_if_index})
3924 def sw_interface_slave_dump(
3928 :param sw_if_index: bond sw_if_index
3930 return self.api(self.papi.sw_interface_slave_dump,
3931 {'sw_if_index': sw_if_index})
3933 def sw_interface_bond_dump(
3938 return self.api(self.papi.sw_interface_bond_dump,
3941 def create_vhost_user_if(
3947 disable_indirect_desc,
3948 custom_dev_instance,
3953 :param is_server: is server
3954 :param sock_filename: socket name
3955 :param renumber: renumber
3956 :param disable_mrg_rxbuf: disable mergable rx buffers
3957 :param disable_indirect_desc: disable indirect descriptors
3958 :param custom_dev_instance: custom dev instance
3959 :param use_custom_mac: use custom mac
3960 :param mac_address: mac address
3961 :param tag: tag (default '')
3964 self.papi.create_vhost_user_if,
3965 {'is_server': is_server,
3966 'sock_filename': sock_filename,
3967 'renumber': renumber,
3968 'disable_mrg_rxbuf': disable_mrg_rxbuf,
3969 'disable_indirect_desc': disable_indirect_desc,
3970 'custom_dev_instance': custom_dev_instance,
3971 'use_custom_mac': use_custom_mac,
3972 'mac_address': mac_address,
3976 def delete_vhost_user_if(
3980 :param sw_if_index: interface the operation is applied to
3982 return self.api(self.papi.delete_vhost_user_if,
3983 {'sw_if_index': sw_if_index, })
3985 def sw_interface_vhost_user_dump(
3990 return self.api(self.papi.sw_interface_vhost_user_dump,
3993 def abf_policy_add_del(self, is_add, policy):
3995 self.papi.abf_policy_add_del,
3999 def abf_itf_attach_add_del(self, is_add, attach):
4001 self.papi.abf_itf_attach_add_del,
4005 def abf_policy_dump(self):
4007 self.papi.abf_policy_dump, {})
4009 def abf_itf_attach_dump(self):
4011 self.papi.abf_itf_attach_dump, {})
4013 def pipe_create(self, is_specified, user_instance):
4014 return self.api(self.papi.pipe_create,
4015 {'is_specified': is_specified,
4016 'user_instance': user_instance})
4018 def pipe_delete(self, parent_sw_if_index):
4019 return self.api(self.papi.pipe_delete,
4020 {'parent_sw_if_index': parent_sw_if_index})
4022 def pipe_dump(self):
4023 return self.api(self.papi.pipe_dump, {})
4037 return self.api(self.papi.memif_create,
4040 'rx_queues': rx_queues,
4041 'tx_queues': tx_queues,
4043 'socket_id': socket_id,
4045 'ring_size': ring_size,
4046 'buffer_size': buffer_size,
4047 'hw_addr': hw_addr})
4049 def memif_delete(self, sw_if_index):
4050 return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index})
4052 def memif_dump(self):
4053 return self.api(self.papi.memif_dump, {})
4055 def memif_socket_filename_add_del(
4056 self, is_add, socket_id, socket_filename):
4058 self.papi.memif_socket_filename_add_del,
4060 'socket_id': socket_id,
4061 'socket_filename': socket_filename})
4063 def memif_socket_filename_dump(self):
4064 return self.api(self.papi.memif_socket_filename_dump, {})
4066 def svs_table_add_del(self, af, table_id, is_add=1):
4067 return self.api(self.papi.svs_table_add_del,
4069 'table_id': table_id,
4074 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
4075 return self.api(self.papi.svs_route_add_del,
4077 'table_id': table_id,
4078 'source_table_id': src_table_id,
4083 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
4084 return self.api(self.papi.svs_enable_disable,
4087 'table_id': table_id,
4088 'sw_if_index': sw_if_index,
4089 'is_enable': is_enable,
4093 return self.api(self.papi.svs_dump, {})