3 from collections import deque
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 class UnexpectedApiReturnValueError(Exception):
46 """ exception raised when the API return value is unexpected """
50 class VppPapiProvider(object):
51 """VPP-api provider using vpp-papi
53 @property hook: hook object providing before and after api/cli hooks
56 _zero, _negative = range(2)
58 def __init__(self, name, shm_prefix, test_class, read_timeout):
59 self.hook = Hook(test_class)
61 self.shm_prefix = shm_prefix
62 self.test_class = test_class
63 self._expect_api_retval = self._zero
64 self._expect_stack = []
66 install_dir = os.getenv('VPP_INSTALL_PATH')
68 # Vapi requires 'VPP_API_DIR', not set when run from Makefile.
69 if 'VPP_API_DIR' not in os.environ:
70 os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH')
72 self.vpp = VPP(logger=test_class.logger,
73 read_timeout=read_timeout)
74 self._events = deque()
79 def assert_negative_api_retval(self):
80 """ Expect API failure - used with with, e.g.:
81 with self.vapi.assert_negative_api_retval():
82 self.vapi.<api call expected to fail>
84 self._expect_stack.append(self._expect_api_retval)
85 self._expect_api_retval = self._negative
88 def assert_zero_api_retval(self):
89 """ Expect API success - used with with, e.g.:
90 with self.vapi.assert_negative_api_retval():
91 self.vapi.<api call expected to succeed>
93 note: this is useful only inside another with block
94 as success is the default expected value
96 self._expect_stack.append(self._expect_api_retval)
97 self._expect_api_retval = self._zero
100 def __exit__(self, exc_type, exc_value, traceback):
101 self._expect_api_retval = self._expect_stack.pop()
103 def register_hook(self, hook):
104 """Replace hook registration with new hook
111 def collect_events(self):
112 """ Collect all events from the internal queue and clear the queue. """
114 self._events = deque()
117 def wait_for_event(self, timeout, name=None):
118 """ Wait for and return next event. """
120 self.test_class.logger.debug("Expecting event '%s' within %ss",
123 self.test_class.logger.debug("Expecting event within %ss",
126 self.test_class.logger.debug("Not waiting, event already queued")
127 limit = time.time() + timeout
128 while time.time() < limit:
130 e = self._events.popleft()
131 if name and type(e).__name__ != name:
133 "Unexpected event received: %s, expected: %s" %
134 (type(e).__name__, name))
135 self.test_class.logger.debug("Returning event %s:%s" %
138 time.sleep(0) # yield
139 raise Exception("Event did not occur within timeout")
141 def __call__(self, name, event):
142 """ Enqueue event in the internal event queue. """
143 # FIXME use the name instead of relying on type(e).__name__ ?
144 # FIXME #2 if this throws, it is eaten silently, Ole?
145 self.test_class.logger.debug("New event: %s: %s" % (name, event))
146 self._events.append(event)
149 """Connect the API to VPP"""
150 self.vpp.connect(self.name, self.shm_prefix)
151 self.papi = self.vpp.api
152 self.vpp.register_event_callback(self)
154 def disconnect(self):
155 """Disconnect the API from VPP"""
156 self.vpp.disconnect()
158 def api(self, api_fn, api_args, expected_retval=0):
159 """ Call API function and check it's return value.
160 Call the appropriate hooks before and after the API call
162 :param api_fn: API function to call
163 :param api_args: tuple of API function arguments
164 :param expected_retval: Expected return value (Default value = 0)
165 :returns: reply from the API
168 self.hook.before_api(api_fn.__name__, api_args)
169 reply = api_fn(**api_args)
170 if self._expect_api_retval == self._negative:
171 if hasattr(reply, 'retval') and reply.retval >= 0:
172 msg = "API call passed unexpectedly: expected negative "\
173 "return value instead of %d in %s" % \
174 (reply.retval, moves.reprlib.repr(reply))
175 self.test_class.logger.info(msg)
176 raise UnexpectedApiReturnValueError(msg)
177 elif self._expect_api_retval == self._zero:
178 if hasattr(reply, 'retval') and reply.retval != expected_retval:
179 msg = "API call failed, expected %d return value instead "\
180 "of %d in %s" % (expected_retval, reply.retval,
181 moves.reprlib.repr(reply))
182 self.test_class.logger.info(msg)
183 raise UnexpectedApiReturnValueError(msg)
185 raise Exception("Internal error, unexpected value for "
186 "self._expect_api_retval %s" %
187 self._expect_api_retval)
188 self.hook.after_api(api_fn.__name__, api_args)
192 """ Execute a CLI, calling the before/after hooks appropriately.
194 :param cli: CLI to execute
198 self.hook.before_cli(cli)
200 r = self.papi.cli_inband(cmd=cli)
201 self.hook.after_cli(cli)
202 if hasattr(r, 'reply'):
205 def ppcli(self, cli):
206 """ Helper method to print CLI command in case of info logging level.
208 :param cli: CLI to execute
211 return cli + "\n" + str(self.cli(cli))
213 def show_version(self):
215 return self.api(self.papi.show_version, {})
217 def pg_create_interface(self, pg_index):
223 return self.api(self.papi.pg_create_interface,
224 {"interface_id": pg_index})
226 def sw_interface_dump(self, filter=None):
229 :param filter: (Default value = None)
232 if filter is not None:
233 args = {"name_filter_valid": 1, "name_filter": filter}
236 return self.api(self.papi.sw_interface_dump, args)
238 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
239 """ Set the IPvX Table-id for the Interface
246 return self.api(self.papi.sw_interface_set_table,
247 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
250 def sw_interface_get_table(self, sw_if_index, is_ipv6):
251 """ Get the IPvX Table-id for the Interface
258 return self.api(self.papi.sw_interface_get_table,
259 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6})
261 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
262 is_ipv6=0, is_add=1, del_all=0):
265 :param addr: param is_ipv6: (Default value = 0)
268 :param is_ipv6: (Default value = 0)
269 :param is_add: (Default value = 1)
270 :param del_all: (Default value = 0)
273 return self.api(self.papi.sw_interface_add_del_address,
274 {'sw_if_index': sw_if_index,
278 'address_length': addr_len,
281 def ip_address_dump(self, sw_if_index, is_ipv6=0):
282 return self.api(self.papi.ip_address_dump,
283 {'sw_if_index': sw_if_index,
286 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
288 """ Set the Interface to be unnumbered
290 :param is_add: (Default value = 1)
291 :param sw_if_index - interface That will be unnumbered
292 :param ip_sw_if_index - interface with an IP addres
295 return self.api(self.papi.sw_interface_set_unnumbered,
296 {'sw_if_index': ip_sw_if_index,
297 'unnumbered_sw_if_index': sw_if_index,
300 def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
301 return self.api(self.papi.ip_unnumbered_dump,
302 {'sw_if_index': sw_if_index})
304 def sw_interface_enable_disable_mpls(self, sw_if_index,
307 Enable/Disable MPLS on the interface
309 :param is_enable: (Default value = 1)
312 return self.api(self.papi.sw_interface_set_mpls_enable,
313 {'sw_if_index': sw_if_index,
314 'enable': is_enable})
316 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
317 return self.api(self.papi.sw_interface_ip6nd_ra_config,
318 {'sw_if_index': sw_if_index,
319 'suppress': suppress})
321 def set_ip_flow_hash(self,
330 return self.api(self.papi.set_ip_flow_hash,
340 def ip6_nd_proxy(self, ip, sw_if_index, is_del=0):
341 return self.api(self.papi.ip6nd_proxy_add_del,
343 'sw_if_index': sw_if_index,
346 def ip6_sw_interface_ra_config(self, sw_if_index,
350 return self.api(self.papi.sw_interface_ip6nd_ra_config,
351 {'sw_if_index': sw_if_index,
353 'suppress': suppress,
354 'send_unicast': send_unicast})
356 def ip6_sw_interface_ra_prefix(self,
366 val_lifetime=0xffffffff,
367 pref_lifetime=0xffffffff):
368 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
369 {'sw_if_index': sw_if_index,
372 'address_length': address_length,
374 'use_default': use_default,
375 'no_advertise': no_advertise,
376 'off_link': off_link,
377 'no_autoconfig': no_autoconfig,
378 'no_onlink': no_onlink,
380 'val_lifetime': val_lifetime,
381 'pref_lifetime': pref_lifetime})
383 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
385 Enable/Disable An interface for IPv6
387 return self.api(self.papi.sw_interface_ip6_enable_disable,
388 {'sw_if_index': sw_if_index,
391 def vxlan_add_del_tunnel(
395 mcast_sw_if_index=0xFFFFFFFF,
399 decap_next_index=0xFFFFFFFF,
401 instance=0xFFFFFFFF):
406 :param is_add: (Default value = 1)
407 :param is_ipv6: (Default value = 0)
408 :param encap_vrf_id: (Default value = 0)
409 :param decap_next_index: (Default value = 0xFFFFFFFF)
410 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
411 :param vni: (Default value = 0)
412 :param instance: (Default value = 0xFFFFFFFF)
415 return self.api(self.papi.vxlan_add_del_tunnel,
418 'src_address': src_addr,
419 'dst_address': dst_addr,
420 'mcast_sw_if_index': mcast_sw_if_index,
421 'encap_vrf_id': encap_vrf_id,
422 'decap_next_index': decap_next_index,
424 'instance': instance})
426 def geneve_add_del_tunnel(
430 mcast_sw_if_index=0xFFFFFFFF,
434 decap_next_index=0xFFFFFFFF,
440 :param is_add: (Default value = 1)
441 :param is_ipv6: (Default value = 0)
442 :param encap_vrf_id: (Default value = 0)
443 :param decap_next_index: (Default value = 0xFFFFFFFF)
444 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
445 :param vni: (Default value = 0)
448 return self.api(self.papi.geneve_add_del_tunnel,
451 'local_address': local_addr,
452 'remote_address': remote_addr,
453 'mcast_sw_if_index': mcast_sw_if_index,
454 'encap_vrf_id': encap_vrf_id,
455 'decap_next_index': decap_next_index,
458 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
459 learn=1, arp_term=0, is_add=1):
460 """Create/delete bridge domain.
462 :param int bd_id: Bridge domain index.
463 :param int flood: Enable/disable bcast/mcast flooding in the BD.
465 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
467 :param int forward: Enable/disable forwarding on all interfaces in
468 the BD. (Default value = 1)
469 :param int learn: Enable/disable learning on all interfaces in the BD.
471 :param int arp_term: Enable/disable arp termination in the BD.
473 :param int is_add: Add or delete flag. (Default value = 1)
475 return self.api(self.papi.bridge_domain_add_del,
478 'uu_flood': uu_flood,
481 'arp_term': arp_term,
484 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
485 return self.api(self.papi.bd_ip_mac_add_del,
491 def bd_ip_mac_dump(self, bd_id):
492 return self.api(self.papi.bd_ip_mac_dump,
495 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
496 return self.api(self.papi.want_ip4_arp_events,
497 {'enable_disable': enable_disable,
499 'pid': os.getpid(), })
501 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
502 return self.api(self.papi.want_ip6_nd_events,
503 {'enable_disable': enable_disable,
505 'pid': os.getpid(), })
507 def want_ip6_ra_events(self, enable_disable=1):
508 return self.api(self.papi.want_ip6_ra_events,
509 {'enable_disable': enable_disable,
510 'pid': os.getpid(), })
512 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
514 return self.api(self.papi.ip6nd_send_router_solicitation,
519 'sw_if_index': sw_if_index})
521 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
522 install_default_routes):
523 return self.api(self.papi.ip6_nd_address_autoconfig,
524 {'sw_if_index': sw_if_index,
526 'install_default_routes': install_default_routes})
528 def want_interface_events(self, enable_disable=1):
529 return self.api(self.papi.want_interface_events,
530 {'enable_disable': enable_disable,
531 'pid': os.getpid(), })
533 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
534 max_macs_in_event=0, learn_limit=0):
535 return self.api(self.papi.want_l2_macs_events,
536 {'enable_disable': enable_disable,
537 'scan_delay': scan_delay,
538 'max_macs_in_event': max_macs_in_event,
539 'learn_limit': learn_limit,
540 'pid': os.getpid(), })
542 def want_dhcp6_reply_events(self, enable_disable=1):
543 return self.api(self.papi.want_dhcp6_reply_events,
544 {'enable_disable': enable_disable,
547 def want_dhcp6_pd_reply_events(self, enable_disable=1):
548 return self.api(self.papi.want_dhcp6_pd_reply_events,
549 {'enable_disable': enable_disable,
552 def dhcp6_clients_enable_disable(self, enable=1):
553 return self.api(self.papi.dhcp6_clients_enable_disable,
556 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
557 addresses, server_index=0xFFFFFFFF,
558 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
560 return self.api(self.papi.dhcp6_send_client_message,
561 {'sw_if_index': sw_if_index,
562 'server_index': server_index,
568 'msg_type': msg_type,
571 'n_addresses': len(addresses),
572 'addresses': addresses})
574 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
575 prefixes, server_index=0xFFFFFFFF,
576 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
578 return self.api(self.papi.dhcp6_pd_send_client_message,
579 {'sw_if_index': sw_if_index,
580 'server_index': server_index,
586 'msg_type': msg_type,
589 'n_prefixes': len(prefixes),
590 'prefixes': prefixes})
592 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
594 return self.api(self.papi.dhcp6_client_enable_disable,
595 {'sw_if_index': sw_if_index,
598 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
600 return self.api(self.papi.dhcp6_pd_client_enable_disable,
601 {'sw_if_index': sw_if_index,
602 'prefix_group': prefix_group,
605 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
606 prefix_length, prefix_group,
608 return self.api(self.papi.ip6_add_del_address_using_prefix,
609 {'sw_if_index': sw_if_index,
610 'prefix_group': prefix_group,
612 'prefix_length': prefix_length,
615 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
616 filter_mac=0, bvi_mac=0):
617 """Create/delete L2 FIB entry.
619 :param str mac: MAC address to create FIB entry for.
620 :param int bd_id: Bridge domain index.
621 :param int sw_if_index: Software interface index of the interface.
622 :param int is_add: Add or delete flag. (Default value = 1)
623 :param int static_mac: Set to 1 to create static MAC entry.
625 :param int filter_mac: Set to 1 to drop packet that's source or
626 destination MAC address contains defined MAC address.
628 :param int bvi_mac: Set to 1 to create entry that points to BVI
629 interface. (Default value = 0)
631 return self.api(self.papi.l2fib_add_del,
634 'sw_if_index': sw_if_index,
636 'static_mac': static_mac,
637 'filter_mac': filter_mac,
640 def l2fib_flush_int(self, sw_if_index):
641 """Flush L2 FIB entries for sw_if_index.
643 :param int sw_if_index: Software interface index of the interface.
645 return self.api(self.papi.l2fib_flush_int,
646 {'sw_if_index': sw_if_index})
648 def l2fib_flush_bd(self, bd_id):
649 """Flush L2 FIB entries for bd_id.
651 :param int sw_if_index: Bridge Domain id.
653 return self.api(self.papi.l2fib_flush_bd,
656 def l2fib_flush_all(self):
659 return self.api(self.papi.l2fib_flush_all, {})
661 def l2_fib_table_dump(self, bd_id):
662 """ Dump the L2 FIB """
663 return self.api(self.papi.l2_fib_table_dump,
666 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
667 shg=0, port_type=L2_PORT_TYPE.NORMAL,
669 """Add/remove interface to/from bridge domain.
671 :param int sw_if_index: Software interface index of the interface.
672 :param int bd_id: Bridge domain index.
673 :param int shg: Split-horizon group index. (Default value = 0)
674 :param int bvi: Set interface as a bridge group virtual interface.
676 :param int enable: Add or remove interface. (Default value = 1)
678 return self.api(self.papi.sw_interface_set_l2_bridge,
679 {'rx_sw_if_index': sw_if_index,
682 'port_type': port_type,
685 def bridge_flags(self, bd_id, is_set, feature_bitmap):
686 """Enable/disable required feature of the bridge domain with defined
689 :param int bd_id: Bridge domain ID.
690 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
691 :param int flags: Bitmap value of the feature to be set:
695 - uu-flood (1 << 3) or
698 return self.api(self.papi.bridge_flags,
701 'flags': feature_bitmap})
703 def bridge_domain_dump(self, bd_id=0):
706 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
707 existing bridge domains returned)
708 :return: Dictionary of bridge domain(s) data.
710 return self.api(self.papi.bridge_domain_dump,
713 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
715 """Create or delete unidirectional cross-connect from Tx interface to
718 :param int rx_sw_if_index: Software interface index of Rx interface.
719 :param int tx_sw_if_index: Software interface index of Tx interface.
720 :param int enable: Create cross-connect if equal to 1, delete
721 cross-connect if equal to 0.
724 return self.api(self.papi.sw_interface_set_l2_xconnect,
725 {'rx_sw_if_index': rx_sw_if_index,
726 'tx_sw_if_index': tx_sw_if_index,
729 def sw_interface_set_l2_tag_rewrite(
736 """L2 interface vlan tag rewrite configure request
737 :param client_index - opaque cookie to identify the sender
738 :param context - sender context, to match reply w/ request
739 :param sw_if_index - interface the operation is applied to
740 :param vtr_op - Choose from l2_vtr_op_t enum values
741 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
742 :param tag1 - Needed for any push or translate vtr op
743 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
746 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
747 {'sw_if_index': sw_if_index,
753 def sw_interface_set_l2_emulation(
758 :param sw_if_index - interface the operation is applied to
761 return self.api(self.papi.l2_emulation,
762 {'sw_if_index': sw_if_index,
765 def sw_interface_set_ip_directed_broadcast(
769 """IP Directed broadcast
770 :param sw_if_index - interface the operation is applied to
773 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
774 {'sw_if_index': sw_if_index,
777 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
780 :param admin_up_down:
784 return self.api(self.papi.sw_interface_set_flags,
785 {'sw_if_index': sw_if_index,
786 'admin_up_down': admin_up_down})
788 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
794 return self.api(self.papi.sw_interface_set_mtu,
795 {'sw_if_index': sw_if_index,
798 def sw_interface_set_promiscuous(self, sw_if_index, enable):
804 return self.api(self.papi.sw_interface_set_promiscuous,
805 {'sw_if_index': sw_if_index,
808 def sw_interface_set_mac_address(self, sw_if_index, mac):
809 return self.api(self.papi.sw_interface_set_mac_address,
810 {'sw_if_index': sw_if_index,
813 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
814 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
815 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
816 """Create subinterface
817 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
819 :param sub_id: param inner_vlan:
823 :param no_tags: (Default value = 0)
824 :param one_tag: (Default value = 0)
825 :param two_tags: (Default value = 0)
826 :param dot1ad: (Default value = 0)
827 :param exact_match: (Default value = 0)
828 :param default_sub: (Default value = 0)
829 :param outer_vlan_id_any: (Default value = 0)
830 :param inner_vlan_id_any: (Default value = 0)
834 self.papi.create_subif,
835 {'sw_if_index': sw_if_index,
839 'two_tags': two_tags,
841 'exact_match': exact_match,
842 'default_sub': default_sub,
843 'outer_vlan_id_any': outer_vlan_id_any,
844 'inner_vlan_id_any': inner_vlan_id_any,
845 'outer_vlan_id': outer_vlan,
846 'inner_vlan_id': inner_vlan})
848 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
849 """Create p2p ethernet subinterface
851 :param sw_if_index: main (parent) interface
852 :param remote_mac: client (remote) mac address
856 self.papi.p2p_ethernet_add,
857 {'parent_if_index': sw_if_index,
858 'remote_mac': remote_mac,
859 'subif_id': subif_id})
861 def delete_subif(self, sw_if_index):
862 """Delete subinterface
866 return self.api(self.papi.delete_subif,
867 {'sw_if_index': sw_if_index})
869 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
870 """Delete p2p ethernet subinterface
872 :param sw_if_index: main (parent) interface
873 :param remote_mac: client (remote) mac address
877 self.papi.p2p_ethernet_del,
878 {'parent_if_index': sw_if_index,
879 'remote_mac': remote_mac})
881 def create_vlan_subif(self, sw_if_index, vlan):
888 return self.api(self.papi.create_vlan_subif,
889 {'sw_if_index': sw_if_index,
892 def create_loopback(self, mac=''):
895 :param mac: (Optional)
897 return self.api(self.papi.create_loopback,
898 {'mac_address': mac})
900 def delete_loopback(self, sw_if_index):
901 return self.api(self.papi.delete_loopback,
902 {'sw_if_index': sw_if_index, })
904 def ip_table_add_del(self,
911 :param is_add: (Default value = 1)
912 :param is_ipv6: (Default value = 0)
917 self.papi.ip_table_add_del,
918 {'table_id': table_id,
922 def ip_add_del_route(
927 next_hop_sw_if_index=0xFFFFFFFF,
931 next_hop_n_out_labels=0,
932 next_hop_out_label_stack=[],
933 next_hop_via_label=MPLS_LABEL_INVALID,
934 next_hop_id=0xFFFFFFFF,
936 is_resolve_attached=0,
937 classify_table_index=0xFFFFFFFF,
951 :param dst_address_length:
952 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
954 :param next_hop_address:
955 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
956 :param vrf_id: (Default value = 0)
957 :param lookup_in_vrf: (Default value = 0)
958 :param classify_table_index: (Default value = 0xFFFFFFFF)
959 :param is_add: (Default value = 1)
960 :param is_drop: (Default value = 0)
961 :param is_ipv6: (Default value = 0)
962 :param is_local: (Default value = 0)
963 :param is_classify: (Default value = 0)
964 :param is_multipath: (Default value = 0)
965 :param is_resolve_host: (Default value = 0)
966 :param is_resolve_attached: (Default value = 0)
967 :param is_dvr: (Default value = 0)
968 :param is_source_lookup: (Default value = 0)
969 :param next_hop_weight: (Default value = 1)
974 self.papi.ip_add_del_route,
975 {'next_hop_sw_if_index': next_hop_sw_if_index,
976 'table_id': table_id,
977 'classify_table_index': classify_table_index,
978 'next_hop_table_id': next_hop_table_id,
981 'is_unreach': is_unreach,
982 'is_prohibit': is_prohibit,
984 'is_local': is_local,
985 'is_classify': is_classify,
986 'is_multipath': is_multipath,
987 'is_resolve_host': is_resolve_host,
988 'is_resolve_attached': is_resolve_attached,
990 'is_source_lookup': is_source_lookup,
991 'is_udp_encap': is_udp_encap,
992 'next_hop_weight': next_hop_weight,
993 'dst_address_length': dst_address_length,
994 'dst_address': dst_address,
995 'next_hop_id': next_hop_id,
996 'next_hop_address': next_hop_address,
997 'next_hop_n_out_labels': next_hop_n_out_labels,
998 'next_hop_via_label': next_hop_via_label,
999 'next_hop_out_label_stack': next_hop_out_label_stack})
1001 def ip_fib_dump(self):
1002 return self.api(self.papi.ip_fib_dump, {})
1004 def ip6_fib_dump(self):
1005 return self.api(self.papi.ip6_fib_dump, {})
1007 def ip_neighbor_add_del(self,
1013 """ Add neighbor MAC to IPv4 or IPv6 address.
1018 :param is_add: (Default value = 1)
1019 :param flags: (Default value = 0/NONE)
1022 self.papi.ip_neighbor_add_del,
1026 'sw_if_index': sw_if_index,
1028 'mac_address': mac_address,
1029 'ip_address': ip_address
1034 def ip_neighbor_dump(self,
1037 """ Return IP neighbor dump.
1040 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1044 self.papi.ip_neighbor_dump,
1045 {'is_ipv6': is_ipv6,
1046 'sw_if_index': sw_if_index
1050 def proxy_arp_add_del(self,
1055 """ Config Proxy Arp Range.
1057 :param low_address: Start address in the rnage to Proxy for
1058 :param hi_address: End address in the rnage to Proxy for
1059 :param vrf_id: The VRF/table in which to proxy
1063 self.papi.proxy_arp_add_del,
1066 'table_id': table_id,
1072 def proxy_arp_intfc_enable_disable(self,
1075 """ Enable/Disable an interface for proxy ARP requests
1077 :param sw_if_index: Interface
1078 :param enable_disable: Enable/Disable
1082 self.papi.proxy_arp_intfc_enable_disable,
1083 {'sw_if_index': sw_if_index,
1084 'enable_disable': is_enable
1092 """ Reset VRF (remove all routes etc.) request.
1094 :param int vrf_id: ID of the FIB table / VRF to reset.
1095 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1099 self.papi.reset_vrf,
1109 """ Reset VRF (remove all routes etc.) request.
1111 :param int vrf_id: ID of the FIB table / VRF to reset.
1112 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1116 self.papi.reset_fib,
1127 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1132 {'is_ipv6': is_ipv6,
1136 def sw_interface_span_enable_disable(
1137 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1140 :param sw_if_index_from:
1141 :param sw_if_index_to:
1145 return self.api(self.papi.sw_interface_span_enable_disable,
1146 {'sw_if_index_from': sw_if_index_from,
1147 'sw_if_index_to': sw_if_index_to,
1152 def gre_tunnel_add_del(self,
1157 instance=0xFFFFFFFF,
1161 """ Add a GRE tunnel
1165 :param outer_fib_id: (Default value = 0)
1166 :param tunnel_type: (Default value = 0)
1167 :param instance: (Default value = 0xFFFFFFFF)
1168 :param session_id: (Defalt value = 0)
1169 :param is_add: (Default value = 1)
1170 :param is_ipv6: (Default value = 0)
1174 self.papi.gre_add_del_tunnel,
1177 'tunnel_type': tunnel_type,
1178 'instance': instance,
1179 'src_address': src_address,
1180 'dst_address': dst_address,
1181 'outer_fib_id': outer_fib_id,
1182 'session_id': session_id}
1185 def udp_encap_add(self,
1191 """ Add a GRE tunnel
1196 :param outer_fib_id: (Default value = 0)
1200 self.papi.udp_encap_add,
1205 'src_port': src_port,
1206 'dst_port': dst_port,
1207 'table_id': table_id
1211 def udp_encap_del(self, id):
1212 return self.api(self.papi.udp_encap_del, {'id': id})
1214 def udp_encap_dump(self):
1215 return self.api(self.papi.udp_encap_dump, {})
1217 def want_udp_encap_stats(self, enable=1):
1218 return self.api(self.papi.want_udp_encap_stats,
1220 'pid': os.getpid()})
1222 def mpls_fib_dump(self):
1223 return self.api(self.papi.mpls_fib_dump, {})
1225 def mpls_table_add_del(
1232 :param is_add: (Default value = 1)
1237 self.papi.mpls_table_add_del,
1238 {'mt_table_id': table_id,
1239 'mt_is_add': is_add})
1241 def mpls_route_add_del(
1247 next_hop_sw_if_index=0xFFFFFFFF,
1249 next_hop_table_id=0,
1251 next_hop_n_out_labels=0,
1252 next_hop_out_label_stack=[],
1253 next_hop_via_label=MPLS_LABEL_INVALID,
1255 is_resolve_attached=0,
1262 classify_table_index=0xFFFFFFFF,
1266 :param dst_address_length:
1267 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1269 :param next_hop_address:
1270 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1271 :param vrf_id: (Default value = 0)
1272 :param lookup_in_vrf: (Default value = 0)
1273 :param classify_table_index: (Default value = 0xFFFFFFFF)
1274 :param is_add: (Default value = 1)
1275 :param is_drop: (Default value = 0)
1276 :param is_ipv6: (Default value = 0)
1277 :param is_local: (Default value = 0)
1278 :param is_classify: (Default value = 0)
1279 :param is_multipath: (Default value = 0)
1280 :param is_multicast: (Default value = 0)
1281 :param is_resolve_host: (Default value = 0)
1282 :param is_resolve_attached: (Default value = 0)
1283 :param next_hop_weight: (Default value = 1)
1287 self.papi.mpls_route_add_del,
1290 'mr_table_id': table_id,
1291 'mr_classify_table_index': classify_table_index,
1292 'mr_is_add': is_add,
1293 'mr_is_classify': is_classify,
1294 'mr_is_multipath': is_multipath,
1295 'mr_is_multicast': is_multicast,
1296 'mr_is_resolve_host': is_resolve_host,
1297 'mr_is_resolve_attached': is_resolve_attached,
1298 'mr_is_interface_rx': is_interface_rx,
1299 'mr_is_rpf_id': is_rpf_id,
1300 'mr_next_hop_proto': next_hop_proto,
1301 'mr_next_hop_weight': next_hop_weight,
1302 'mr_next_hop': next_hop_address,
1303 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1304 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1305 'mr_next_hop_table_id': next_hop_table_id,
1306 'mr_next_hop_via_label': next_hop_via_label,
1307 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1309 def mpls_ip_bind_unbind(
1321 self.papi.mpls_ip_bind_unbind,
1322 {'mb_mpls_table_id': table_id,
1324 'mb_ip_table_id': ip_table_id,
1325 'mb_is_bind': is_bind,
1326 'mb_is_ip4': is_ip4,
1327 'mb_address_length': dst_address_length,
1328 'mb_address': dst_address})
1330 def mpls_tunnel_add_del(
1333 next_hop_proto_is_ip4,
1335 next_hop_sw_if_index=0xFFFFFFFF,
1336 next_hop_table_id=0,
1338 next_hop_n_out_labels=0,
1339 next_hop_out_label_stack=[],
1340 next_hop_via_label=MPLS_LABEL_INVALID,
1346 :param dst_address_length:
1347 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1349 :param next_hop_address:
1350 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1351 :param vrf_id: (Default value = 0)
1352 :param lookup_in_vrf: (Default value = 0)
1353 :param classify_table_index: (Default value = 0xFFFFFFFF)
1354 :param is_add: (Default value = 1)
1355 :param is_drop: (Default value = 0)
1356 :param is_ipv6: (Default value = 0)
1357 :param is_local: (Default value = 0)
1358 :param is_classify: (Default value = 0)
1359 :param is_multipath: (Default value = 0)
1360 :param is_resolve_host: (Default value = 0)
1361 :param is_resolve_attached: (Default value = 0)
1362 :param next_hop_weight: (Default value = 1)
1363 :param is_multicast: (Default value = 0)
1367 self.papi.mpls_tunnel_add_del,
1368 {'mt_sw_if_index': tun_sw_if_index,
1369 'mt_is_add': is_add,
1370 'mt_l2_only': l2_only,
1371 'mt_is_multicast': is_multicast,
1372 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1373 'mt_next_hop_weight': next_hop_weight,
1374 'mt_next_hop': next_hop_address,
1375 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1376 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1377 'mt_next_hop_table_id': next_hop_table_id,
1378 'mt_next_hop_via_label': next_hop_via_label,
1379 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1381 def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
1382 return self.api(self.papi.mpls_tunnel_dump,
1383 {'sw_if_index': sw_if_index})
1385 def nat44_interface_add_del_feature(
1390 """Enable/disable NAT44 feature on the interface
1392 :param sw_if_index: Software index of the interface
1393 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1394 :param is_add: 1 if add, 0 if delete (Default value = 1)
1397 self.papi.nat44_interface_add_del_feature,
1399 'is_inside': is_inside,
1400 'sw_if_index': sw_if_index})
1402 def nat44_interface_add_del_output_feature(
1407 """Enable/disable NAT44 output feature on the interface
1409 :param sw_if_index: Software index of the interface
1410 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1411 :param is_add: 1 if add, 0 if delete (Default value = 1)
1414 self.papi.nat44_interface_add_del_output_feature,
1416 'is_inside': is_inside,
1417 'sw_if_index': sw_if_index})
1419 def nat44_add_del_static_mapping(
1423 external_sw_if_index=0xFFFFFFFF,
1434 """Add/delete NAT44 static mapping
1436 :param local_ip: Local IP address
1437 :param external_ip: External IP address
1438 :param external_sw_if_index: External interface instead of IP address
1439 :param local_port: Local port number (Default value = 0)
1440 :param external_port: External port number (Default value = 0)
1441 :param addr_only: 1 if address only mapping, 0 if address and port
1442 :param vrf_id: VRF ID
1443 :param protocol: IP protocol (Default value = 0)
1444 :param twice_nat: 1 if translate external host address and port
1445 :param self_twice_nat: 1 if translate external host address and port
1446 whenever external host address equals
1447 local address of internal host
1448 :param out2in_only: if 1 rule is matching only out2in direction
1449 :param tag: Opaque string tag
1450 :param is_add: 1 if add, 0 if delete (Default value = 1)
1453 self.papi.nat44_add_del_static_mapping,
1455 'addr_only': addr_only,
1456 'local_ip_address': local_ip,
1457 'external_ip_address': external_ip,
1458 'local_port': local_port,
1459 'external_port': external_port,
1460 'external_sw_if_index': external_sw_if_index,
1462 'protocol': protocol,
1463 'twice_nat': twice_nat,
1464 'self_twice_nat': self_twice_nat,
1465 'out2in_only': out2in_only,
1468 def nat44_add_del_identity_mapping(
1471 sw_if_index=0xFFFFFFFF,
1478 """Add/delete NAT44 identity mapping
1480 :param ip: IP address (Default value = 0)
1481 :param sw_if_index: Interface instead of IP address
1482 :param port: Port number (Default value = 0)
1483 :param addr_only: 1 if address only mapping, 0 if address and port
1484 :param vrf_id: VRF ID
1485 :param protocol: IP protocol (Default value = 0)
1486 :param tag: Opaque string tag
1487 :param is_add: 1 if add, 0 if delete (Default value = 1)
1490 self.papi.nat44_add_del_identity_mapping,
1492 'addr_only': addr_only,
1495 'sw_if_index': sw_if_index,
1498 'protocol': protocol})
1500 def nat44_add_del_address_range(
1507 """Add/del NAT44 address range
1509 :param first_ip_address: First IP address
1510 :param last_ip_address: Last IP address
1511 :param vrf_id: VRF id for the address range
1512 :param twice_nat: twice NAT address for extenal hosts
1513 :param is_add: 1 if add, 0 if delete (Default value = 1)
1516 self.papi.nat44_add_del_address_range,
1517 {'first_ip_address': first_ip_address,
1518 'last_ip_address': last_ip_address,
1520 'twice_nat': twice_nat,
1523 def nat44_address_dump(self):
1524 """Dump NAT44 addresses
1525 :return: Dictionary of NAT44 addresses
1527 return self.api(self.papi.nat44_address_dump, {})
1529 def nat44_interface_dump(self):
1530 """Dump interfaces with NAT44 feature
1531 :return: Dictionary of interfaces with NAT44 feature
1533 return self.api(self.papi.nat44_interface_dump, {})
1535 def nat44_interface_output_feature_dump(self):
1536 """Dump interfaces with NAT44 output feature
1537 :return: Dictionary of interfaces with NAT44 output feature
1539 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1541 def nat44_static_mapping_dump(self):
1542 """Dump NAT44 static mappings
1543 :return: Dictionary of NAT44 static mappings
1545 return self.api(self.papi.nat44_static_mapping_dump, {})
1547 def nat44_identity_mapping_dump(self):
1548 """Dump NAT44 identity mappings
1549 :return: Dictionary of NAT44 identity mappings
1551 return self.api(self.papi.nat44_identity_mapping_dump, {})
1553 def nat_show_config(self):
1554 """Show NAT plugin config
1555 :return: NAT plugin config parameters
1557 return self.api(self.papi.nat_show_config, {})
1559 def nat44_add_interface_addr(
1564 """Add/del NAT44 address from interface
1566 :param sw_if_index: Software index of the interface
1567 :param twice_nat: twice NAT address for extenal hosts
1568 :param is_add: 1 if add, 0 if delete (Default value = 1)
1571 self.papi.nat44_add_del_interface_addr,
1573 'sw_if_index': sw_if_index,
1574 'twice_nat': twice_nat})
1576 def nat44_interface_addr_dump(self):
1577 """Dump NAT44 addresses interfaces
1578 :return: Dictionary of NAT44 addresses interfaces
1580 return self.api(self.papi.nat44_interface_addr_dump, {})
1587 """Enable/disable NAT IPFIX logging
1589 :param domain_id: Observation domain ID (Default value = 1)
1590 :param src_port: Source port number (Default value = 4739)
1591 :param enable: 1 if enable, 0 if disable (Default value = 1)
1594 self.papi.nat_ipfix_enable_disable,
1595 {'domain_id': domain_id,
1596 'src_port': src_port,
1599 def nat44_user_session_dump(
1603 """Dump NAT44 user's sessions
1605 :param ip_address: ip adress of the user to be dumped
1606 :param cpu_index: cpu_index on which the user is
1607 :param vrf_id: VRF ID
1608 :return: Dictionary of S-NAT sessions
1611 self.papi.nat44_user_session_dump,
1612 {'ip_address': ip_address,
1615 def nat44_user_dump(self):
1618 :return: Dictionary of NAT44 users
1620 return self.api(self.papi.nat44_user_dump, {})
1622 def nat44_add_del_lb_static_mapping(
1635 """Add/delete NAT44 load balancing static mapping
1637 :param twice_nat: 1 if translate external host address and port
1638 :param tag: Opaque string tag
1639 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1640 :param is_add - 1 if add, 0 if delete
1643 self.papi.nat44_add_del_lb_static_mapping,
1645 'external_addr': external_addr,
1646 'external_port': external_port,
1647 'protocol': protocol,
1648 'twice_nat': twice_nat,
1649 'self_twice_nat': self_twice_nat,
1650 'out2in_only': out2in_only,
1652 'affinity': affinity,
1653 'local_num': local_num,
1656 def nat44_lb_static_mapping_add_del_local(
1666 """Add/delete NAT44 load-balancing static mapping rule backend
1668 :param external_addr: external IPv4 address of the servic
1669 :param external_port: external L4 port number of the service
1670 :param local_addr: IPv4 address of the internal node
1671 :param local_port: L4 port number of the internal node
1672 :param protocol: IP protocol number
1673 :param probability: probability of the internal node
1674 :param vrf_id: VRF id of the internal node
1675 :param is_add: 1 if add, 0 if delete
1678 self.papi.nat44_lb_static_mapping_add_del_local,
1680 'external_addr': external_addr,
1681 'external_port': external_port,
1685 'probability': probability,
1687 'protocol': protocol})
1689 def nat44_lb_static_mapping_dump(self):
1690 """Dump NAT44 load balancing static mappings
1692 :return: Dictionary of NAT44 load balancing static mapping
1694 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1696 def nat44_del_session(
1703 ext_host_address=None,
1705 """Delete NAT44 session
1707 :param addr: IPv4 address
1708 :param por: port number
1709 :param protocol: IP protocol number
1710 :param vrf_id: VRF ID
1711 :param is_in: 1 if inside network addres and port pari, 0 if outside
1712 :param ext_host_address: external host IPv4 address
1713 :param ext_host_port: external host port
1715 if ext_host_address is None:
1717 self.papi.nat44_del_session,
1720 'protocol': protocol,
1725 self.papi.nat44_del_session,
1728 'protocol': protocol,
1731 'ext_host_valid': 1,
1732 'ext_host_address': ext_host_address,
1733 'ext_host_port': ext_host_port})
1735 def nat44_forwarding_enable_disable(
1738 """Enable/disable forwarding for NAT44
1740 :param enable: 1 for enable, 0 for disable
1743 self.papi.nat44_forwarding_enable_disable,
1753 """Set NAT virtual fragmentation reassembly
1755 :param timeout: reassembly timeout (Default 2sec)
1756 :param max_reass: maximum concurrent reassemblies (Default 1024)
1757 :param max_frag: maximum fragmets per reassembly (Default 5)
1758 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1759 :param is_ip6: 1 if IPv6, 0 if IPv4
1762 self.papi.nat_set_reass,
1763 {'timeout': timeout,
1764 'max_reass': max_reass,
1765 'max_frag': max_frag,
1766 'drop_frag': drop_frag,
1769 def nat_get_reass(self):
1770 """Get NAT virtual fragmentation reassembly configuration
1772 :return: NAT virtual fragmentation reassembly configuration
1774 return self.api(self.papi.nat_get_reass, {})
1776 def nat_reass_dump(self):
1777 """Dump NAT virtual fragmentation reassemblies
1779 :return: Dictionary of NAT virtual fragmentation reassemblies
1781 return self.api(self.papi.nat_reass_dump, {})
1783 def nat_det_add_del_map(
1790 """Add/delete deterministic NAT mapping
1792 :param is_add - 1 if add, 0 if delete
1793 :param in_addr - inside IP address
1794 :param in_plen - inside IP address prefix length
1795 :param out_addr - outside IP address
1796 :param out_plen - outside IP address prefix length
1799 self.papi.nat_det_add_del_map,
1804 'out_addr': out_addr,
1805 'out_plen': out_plen})
1807 def nat_det_forward(
1810 """Get outside address and port range from inside address
1812 :param in_addr - inside IP address
1815 self.papi.nat_det_forward,
1816 {'in_addr': in_addr,
1819 def nat_det_reverse(
1823 """Get inside address from outside address and port
1825 :param out_addr - outside IP address
1826 :param out_port - outside port
1829 self.papi.nat_det_reverse,
1830 {'out_addr': out_addr,
1831 'out_port': out_port})
1833 def nat_det_map_dump(self):
1834 """Dump deterministic NAT mappings
1836 :return: Dictionary of deterministic NAT mappings
1838 return self.api(self.papi.nat_det_map_dump, {})
1840 def nat_set_timeouts(
1843 tcp_established=7440,
1846 """Set values of timeouts for NAT sessions (in seconds)
1848 :param udp - UDP timeout (Default value = 300)
1849 :param tcp_established - TCP established timeout (Default value = 7440)
1850 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1851 :param icmp - ICMP timeout (Default value = 60)
1854 self.papi.nat_set_timeouts,
1856 'tcp_established': tcp_established,
1857 'tcp_transitory': tcp_transitory,
1860 def nat_get_timeouts(self):
1861 """Get values of timeouts for NAT sessions
1863 :return: Timeouts for NAT sessions (in seconds)
1865 return self.api(self.papi.nat_get_timeouts, {})
1867 def nat_set_addr_and_port_alloc_alg(
1875 """Set address and port assignment algorithm
1877 :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1878 :param psid_offset: number of offset bits (valid only for MAP-E alg)
1879 :param psid_length: length of PSID (valid only for MAP-E alg)
1880 :param psid: Port Set Identifier value (valid only for MAP-E alg)
1881 :param start_port: beginning of the port range
1882 :param end_port: end of the port range
1885 self.papi.nat_set_addr_and_port_alloc_alg,
1887 'psid_offset': psid_offset,
1888 'psid_length': psid_length,
1890 'start_port': start_port,
1891 'end_port': end_port})
1893 def nat_get_addr_and_port_alloc_alg(self):
1894 """Get address and port assignment algorithm"""
1895 return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1897 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1898 """Set TCP MSS rewriting configuration
1900 :param enable: disable(0)/enable(1) MSS rewriting feature
1901 :param mss_value: MSS value to be used for MSS rewriting
1904 self.papi.nat_set_mss_clamping,
1905 {'enable': enable, 'mss_value': mss_value})
1907 def nat_get_mss_clamping(self):
1908 """Get TCP MSS rewriting configuration"""
1909 return self.api(self.papi.nat_get_mss_clamping, {})
1911 def nat_det_close_session_out(
1917 """Close deterministic NAT session using outside address and port
1919 :param out_addr - outside IP address
1920 :param out_port - outside port
1921 :param ext_addr - external host IP address
1922 :param ext_port - external host port
1925 self.papi.nat_det_close_session_out,
1926 {'out_addr': out_addr,
1927 'out_port': out_port,
1928 'ext_addr': ext_addr,
1929 'ext_port': ext_port})
1931 def nat_det_close_session_in(
1937 """Close deterministic NAT session using inside address and port
1939 :param in_addr - inside IP address
1940 :param in_port - inside port
1941 :param ext_addr - external host IP address
1942 :param ext_port - external host port
1945 self.papi.nat_det_close_session_in,
1946 {'in_addr': in_addr,
1948 'ext_addr': ext_addr,
1949 'ext_port': ext_port,
1952 def nat_det_session_dump(
1955 """Dump deterministic NAT sessions belonging to a user
1957 :param user_addr - inside IP address of the user
1958 :return: Dictionary of deterministic NAT sessions
1961 self.papi.nat_det_session_dump,
1963 'user_addr': user_addr})
1965 def nat64_add_del_pool_addr_range(
1971 """Add/del address range to NAT64 pool
1973 :param start_addr: First IP address
1974 :param end_addr: Last IP address
1975 :param vrf_id: VRF id for the address range
1976 :param is_add: 1 if add, 0 if delete (Default value = 1)
1979 self.papi.nat64_add_del_pool_addr_range,
1980 {'start_addr': start_addr,
1981 'end_addr': end_addr,
1985 def nat64_pool_addr_dump(self):
1986 """Dump NAT64 pool addresses
1987 :return: Dictionary of NAT64 pool addresses
1989 return self.api(self.papi.nat64_pool_addr_dump, {})
1991 def nat64_add_del_interface(
1996 """Enable/disable NAT64 feature on the interface
1997 :param sw_if_index: Index of the interface
1998 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1999 :param is_add: 1 if add, 0 if delete (Default value = 1)
2002 self.papi.nat64_add_del_interface,
2003 {'sw_if_index': sw_if_index,
2004 'is_inside': is_inside,
2007 def nat64_interface_dump(self):
2008 """Dump interfaces with NAT64 feature
2009 :return: Dictionary of interfaces with NAT64 feature
2011 return self.api(self.papi.nat64_interface_dump, {})
2013 def nat64_add_del_static_bib(
2022 """Add/delete S-NAT static BIB entry
2024 :param in_ip: Inside IPv6 address
2025 :param out_ip: Outside IPv4 address
2026 :param in_port: Inside port number
2027 :param out_port: Outside port number
2028 :param protocol: IP protocol
2029 :param vrf_id: VRF ID (Default value = 0)
2030 :param is_add: 1 if add, 0 if delete (Default value = 1)
2033 self.papi.nat64_add_del_static_bib,
2042 def nat64_bib_dump(self, protocol=255):
2045 :param protocol: IP protocol (Default value = 255, all BIBs)
2046 :returns: Dictionary of NAT64 BIB entries
2048 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
2050 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
2051 tcp_incoming_syn=6):
2052 """Set values of timeouts for NAT64 (in seconds)
2054 :param udpi: UDP timeout (Default value = 300)
2055 :param icmp: ICMP timeout (Default value = 60)
2056 :param tcp_trans: TCP transitory timeout (Default value = 240)
2057 :param tcp_est: TCP established timeout (Default value = 7440)
2058 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
2061 self.papi.nat64_set_timeouts,
2064 'tcp_trans': tcp_trans,
2066 'tcp_incoming_syn': tcp_incoming_syn})
2068 def nat64_get_timeouts(self):
2069 """Get values of timeouts for NAT64
2071 :return: Timeouts for NAT64 (in seconds)
2073 return self.api(self.papi.nat64_get_timeouts, {})
2075 def nat64_st_dump(self, protocol=255):
2076 """Dump NAT64 session table
2078 :param protocol: IP protocol (Default value = 255, all STs)
2079 :returns: Dictionary of NAT64 sesstion table entries
2081 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2083 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2084 """Add/del NAT64 prefix
2086 :param prefix: NAT64 prefix
2087 :param plen: NAT64 prefix length
2088 :param vrf_id: VRF id of tenant (Default 0)
2089 :param is_add: 1 if add, 0 if delete (Default value = 1)
2092 self.papi.nat64_add_del_prefix,
2098 def nat64_prefix_dump(self):
2099 """Dump NAT64 prefix
2101 :returns: Dictionary of NAT64 prefixes
2103 return self.api(self.papi.nat64_prefix_dump, {})
2105 def nat64_add_interface_addr(
2109 """Add/del NAT64 address from interface
2111 :param sw_if_index: Software index of the interface
2112 :param is_add: 1 if add, 0 if delete (Default value = 1)
2114 return self.api(self.papi.nat64_add_del_interface_addr,
2115 {'is_add': is_add, 'sw_if_index': sw_if_index})
2117 def dslite_set_aftr_addr(self, ip6, ip4):
2118 """Set DS-Lite AFTR addresses
2120 :param ip4: IPv4 address
2121 :param ip6: IPv6 address
2124 self.papi.dslite_set_aftr_addr,
2128 def dslite_set_b4_addr(self, ip6, ip4):
2129 """Set DS-Lite B4 IPv6 address
2131 :param ip4: IPv4 address
2132 :param ip6: IPv6 address
2135 self.papi.dslite_set_b4_addr,
2139 def dslite_add_del_pool_addr_range(
2144 """Add/del address range to DS-Lite pool
2146 :param start_addr: First IP address
2147 :param end_addr: Last IP address
2148 :param is_add: 1 if add, 0 if delete (Default value = 1)
2151 self.papi.dslite_add_del_pool_addr_range,
2152 {'start_addr': start_addr,
2153 'end_addr': end_addr,
2156 def nat66_add_del_interface(
2161 """Enable/disable NAT66 feature on the interface
2162 :param sw_if_index: Index of the interface
2163 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2164 :param is_add: 1 if add, 0 if delete (Default value = 1)
2167 self.papi.nat66_add_del_interface,
2168 {'sw_if_index': sw_if_index,
2169 'is_inside': is_inside,
2172 def nat66_add_del_static_mapping(
2178 """Add/delete NAT66 static mapping
2180 :param in_ip: Inside IPv6 address
2181 :param out_ip: Outside IPv6 address
2182 :param vrf_id: VRF ID (Default value = 0)
2183 :param is_add: 1 if add, 0 if delete (Default value = 1)
2186 self.papi.nat66_add_del_static_mapping,
2187 {'local_ip_address': in_ip,
2188 'external_ip_address': out_ip,
2192 def nat66_interface_dump(self):
2193 """Dump interfaces with NAT66 feature
2194 :return: Dictionary of interfaces with NAT66 feature
2196 return self.api(self.papi.nat66_interface_dump, {})
2198 def nat66_static_mapping_dump(self):
2199 """Dump NAT66 static mappings
2200 :return: Dictionary of NAT66 static mappings
2202 return self.api(self.papi.nat66_static_mapping_dump, {})
2204 def nat_ha_set_listener(self, addr, port, path_mtu=512):
2205 """Set HA listener (local settings)
2207 :param addr: local IP4 address
2208 :param port: local UDP port number
2209 :param path_mtu: path MTU (Default value = 512)
2211 return self.api(self.papi.nat_ha_set_listener,
2212 {'ip_address': addr,
2214 'path_mtu': path_mtu})
2216 def nat_ha_get_listener(self):
2217 """Get HA listener/local configuration"""
2218 return self.api(self.papi.nat_ha_get_listener, {})
2220 def nat_ha_set_failover(self, addr, port, refresh=10):
2221 """Set HA failover (remote settings)
2223 :param addr: failover IP4 address
2224 :param port: failvoer UDP port number
2225 :param refresh: number of seconds after which to send session refresh
2227 return self.api(self.papi.nat_ha_set_failover,
2228 {'ip_address': addr,
2230 'session_refresh_interval': refresh})
2232 def nat_ha_get_failover(self):
2233 """Get HA failover/remote settings reply"""
2234 return self.api(self.papi.nat_ha_get_failover, {})
2236 def nat_ha_flush(self):
2237 """Flush the current HA data"""
2238 return self.api(self.papi.nat_ha_flush, {})
2240 def nat_ha_resync(self, want_resync_event=1):
2241 """Resync HA (resend existing sessions to new failover)
2242 :param want_resync_event: if non-zero resync completed event sent
2244 return self.api(self.papi.nat_ha_resync,
2245 {'want_resync_event': want_resync_event,
2246 'pid': os.getpid()})
2248 def control_ping(self):
2249 self.api(self.papi.control_ping)
2251 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2252 detect_mult, local_addr, peer_addr, is_ipv6=0,
2253 bfd_key_id=None, conf_key_id=None):
2254 if bfd_key_id is None:
2255 return self.api(self.papi.bfd_udp_add,
2257 'sw_if_index': sw_if_index,
2258 'desired_min_tx': desired_min_tx,
2259 'required_min_rx': required_min_rx,
2260 'local_addr': local_addr,
2261 'peer_addr': peer_addr,
2263 'detect_mult': detect_mult,
2266 return self.api(self.papi.bfd_udp_add,
2268 'sw_if_index': sw_if_index,
2269 'desired_min_tx': desired_min_tx,
2270 'required_min_rx': required_min_rx,
2271 'local_addr': local_addr,
2272 'peer_addr': peer_addr,
2274 'detect_mult': detect_mult,
2275 'is_authenticated': 1,
2276 'bfd_key_id': bfd_key_id,
2277 'conf_key_id': conf_key_id,
2280 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2281 detect_mult, local_addr, peer_addr, is_ipv6=0):
2282 return self.api(self.papi.bfd_udp_mod,
2284 'sw_if_index': sw_if_index,
2285 'desired_min_tx': desired_min_tx,
2286 'required_min_rx': required_min_rx,
2287 'local_addr': local_addr,
2288 'peer_addr': peer_addr,
2290 'detect_mult': detect_mult,
2293 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2294 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2296 return self.api(self.papi.bfd_udp_auth_activate,
2298 'sw_if_index': sw_if_index,
2299 'local_addr': local_addr,
2300 'peer_addr': peer_addr,
2302 'is_delayed': 1 if is_delayed else 0,
2303 'bfd_key_id': bfd_key_id,
2304 'conf_key_id': conf_key_id,
2307 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2308 is_ipv6=0, is_delayed=False):
2309 return self.api(self.papi.bfd_udp_auth_deactivate,
2311 'sw_if_index': sw_if_index,
2312 'local_addr': local_addr,
2313 'peer_addr': peer_addr,
2315 'is_delayed': 1 if is_delayed else 0,
2318 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2319 return self.api(self.papi.bfd_udp_del,
2321 'sw_if_index': sw_if_index,
2322 'local_addr': local_addr,
2323 'peer_addr': peer_addr,
2327 def bfd_udp_session_dump(self):
2328 return self.api(self.papi.bfd_udp_session_dump, {})
2330 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2331 peer_addr, is_ipv6=0):
2332 return self.api(self.papi.bfd_udp_session_set_flags, {
2333 'admin_up_down': admin_up_down,
2334 'sw_if_index': sw_if_index,
2335 'local_addr': local_addr,
2336 'peer_addr': peer_addr,
2340 def want_bfd_events(self, enable_disable=1):
2341 return self.api(self.papi.want_bfd_events, {
2342 'enable_disable': enable_disable,
2346 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2347 return self.api(self.papi.bfd_auth_set_key, {
2348 'conf_key_id': conf_key_id,
2349 'auth_type': auth_type,
2351 'key_len': len(key),
2354 def bfd_auth_del_key(self, conf_key_id):
2355 return self.api(self.papi.bfd_auth_del_key, {
2356 'conf_key_id': conf_key_id,
2359 def bfd_auth_keys_dump(self):
2360 return self.api(self.papi.bfd_auth_keys_dump, {})
2362 def bfd_udp_set_echo_source(self, sw_if_index):
2363 return self.api(self.papi.bfd_udp_set_echo_source,
2364 {'sw_if_index': sw_if_index})
2366 def bfd_udp_del_echo_source(self):
2367 return self.api(self.papi.bfd_udp_del_echo_source, {})
2369 def bfd_udp_get_echo_source(self):
2370 return self.api(self.papi.bfd_udp_get_echo_source, {})
2372 def classify_add_del_table(
2377 table_index=0xFFFFFFFF,
2379 memory_size=2097152,
2381 next_table_index=0xFFFFFFFF,
2382 miss_next_index=0xFFFFFFFF,
2383 current_data_flag=0,
2384 current_data_offset=0):
2388 :param match_n_vectors: (Default value = 1)
2389 :param table_index: (Default value = 0xFFFFFFFF)
2390 :param nbuckets: (Default value = 2)
2391 :param memory_size: (Default value = 2097152)
2392 :param skip_n_vectors: (Default value = 0)
2393 :param next_table_index: (Default value = 0xFFFFFFFF)
2394 :param miss_next_index: (Default value = 0xFFFFFFFF)
2395 :param current_data_flag: (Default value = 0)
2396 :param current_data_offset: (Default value = 0)
2399 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2400 mask = mask + '\0' * (mask_len - len(mask))
2402 self.papi.classify_add_del_table,
2404 'table_index': table_index,
2405 'nbuckets': nbuckets,
2406 'memory_size': memory_size,
2407 'skip_n_vectors': skip_n_vectors,
2408 'match_n_vectors': match_n_vectors,
2409 'next_table_index': next_table_index,
2410 'miss_next_index': miss_next_index,
2411 'current_data_flag': current_data_flag,
2412 'current_data_offset': current_data_offset,
2413 'mask_len': mask_len,
2416 def classify_add_del_session(
2421 opaque_index=0xFFFFFFFF,
2422 hit_next_index=0xFFFFFFFF,
2430 :param opaque_index: (Default value = 0xFFFFFFFF)
2431 :param hit_next_index: (Default value = 0xFFFFFFFF)
2432 :param advance: (Default value = 0)
2433 :param action: (Default value = 0)
2434 :param metadata: (Default value = 0)
2437 match_len = ((len(match) - 1) / 16 + 1) * 16
2438 match = match + '\0' * (match_len - len(match))
2440 self.papi.classify_add_del_session,
2442 'table_index': table_index,
2443 'hit_next_index': hit_next_index,
2444 'opaque_index': opaque_index,
2447 'metadata': metadata,
2448 'match_len': match_len,
2451 def input_acl_set_interface(
2455 ip4_table_index=0xFFFFFFFF,
2456 ip6_table_index=0xFFFFFFFF,
2457 l2_table_index=0xFFFFFFFF):
2461 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2462 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2463 :param l2_table_index: (Default value = 0xFFFFFFFF)
2467 self.papi.input_acl_set_interface,
2468 {'sw_if_index': sw_if_index,
2469 'ip4_table_index': ip4_table_index,
2470 'ip6_table_index': ip6_table_index,
2471 'l2_table_index': l2_table_index,
2474 def output_acl_set_interface(
2478 ip4_table_index=0xFFFFFFFF,
2479 ip6_table_index=0xFFFFFFFF,
2480 l2_table_index=0xFFFFFFFF):
2484 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2485 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2486 :param l2_table_index: (Default value = 0xFFFFFFFF)
2490 self.papi.output_acl_set_interface,
2491 {'sw_if_index': sw_if_index,
2492 'ip4_table_index': ip4_table_index,
2493 'ip6_table_index': ip6_table_index,
2494 'l2_table_index': l2_table_index,
2497 def set_ipfix_exporter(
2504 collector_port=4739,
2507 self.papi.set_ipfix_exporter,
2509 'collector_address': collector_address,
2510 'collector_port': collector_port,
2511 'src_address': src_address,
2513 'path_mtu': path_mtu,
2514 'template_interval': template_interval,
2515 'udp_checksum': udp_checksum,
2518 def dhcp_proxy_config(self,
2526 self.papi.dhcp_proxy_config,
2528 'rx_vrf_id': rx_table_id,
2529 'server_vrf_id': server_table_id,
2532 'dhcp_server': dhcp_server,
2533 'dhcp_src_address': dhcp_src_address,
2536 def dhcp_proxy_set_vss(self,
2545 self.papi.dhcp_proxy_set_vss,
2548 'vss_type': vss_type,
2549 'vpn_ascii_id': vpn_ascii_id,
2551 'vpn_index': vpn_index,
2556 def dhcp_client_dump(self):
2557 return self.api(self.papi.dhcp_client_dump, {})
2559 def dhcp_client(self,
2564 set_broadcast_flag=1,
2565 want_dhcp_events=0):
2567 self.papi.dhcp_client_config,
2571 'sw_if_index': sw_if_index,
2572 'hostname': hostname,
2574 'want_dhcp_event': want_dhcp_events,
2575 'set_broadcast_flag': set_broadcast_flag,
2579 def ip_mroute_add_del(self,
2585 next_hop_sw_if_index,
2595 IP Multicast Route add/del
2598 self.papi.ip_mroute_add_del,
2599 {'next_hop_sw_if_index': next_hop_sw_if_index,
2600 'entry_flags': e_flags,
2601 'itf_flags': i_flags,
2602 'table_id': table_id,
2606 'is_local': is_local,
2607 'bier_imp': bier_imp,
2608 'next_hop_afi': next_hop_afi,
2609 'grp_address_length': grp_address_length,
2610 'grp_address': grp_address,
2611 'src_address': src_address,
2612 'nh_address': next_hop_address})
2614 def mfib_signal_dump(self):
2615 return self.api(self.papi.mfib_signal_dump, {})
2617 def ip_mfib_dump(self):
2618 return self.api(self.papi.ip_mfib_dump, {})
2620 def ip6_mfib_dump(self):
2621 return self.api(self.papi.ip6_mfib_dump, {})
2623 def lisp_enable_disable(self, is_enabled):
2625 self.papi.lisp_enable_disable,
2627 'is_en': is_enabled,
2630 def lisp_locator_set(self,
2634 self.papi.lisp_add_del_locator_set,
2637 'locator_set_name': ls_name
2640 def lisp_locator_set_dump(self):
2641 return self.api(self.papi.lisp_locator_set_dump, {})
2643 def lisp_locator(self,
2650 self.papi.lisp_add_del_locator,
2653 'locator_set_name': ls_name,
2654 'sw_if_index': sw_if_index,
2655 'priority': priority,
2659 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2661 self.papi.lisp_locator_dump,
2663 'is_index_set': is_index_set,
2665 'ls_index': ls_index,
2668 def lisp_local_mapping(self,
2678 self.papi.lisp_add_del_local_eid,
2680 'locator_set_name': ls_name,
2682 'eid_type': eid_type,
2684 'prefix_len': prefix_len,
2690 def lisp_eid_table_dump(self,
2698 self.papi.lisp_eid_table_dump,
2701 'prefix_length': prefix_length,
2703 'eid_type': eid_type,
2705 'filter': filter_opt,
2708 def lisp_remote_mapping(self,
2718 self.papi.lisp_add_del_remote_mapping,
2721 'eid_type': eid_type,
2723 'eid_len': eid_prefix_len,
2724 'rloc_num': rlocs_num,
2727 'is_src_dst': is_src_dst,
2730 def lisp_adjacency(self,
2739 self.papi.lisp_add_del_adjacency,
2743 'eid_type': eid_type,
2746 'leid_len': leid_len,
2747 'reid_len': reid_len,
2750 def lisp_adjacencies_get(self, vni=0):
2752 self.papi.lisp_adjacencies_get,
2757 def map_add_domain(self,
2767 self.papi.map_add_domain,
2769 'ip6_prefix': ip6_prefix,
2770 'ip4_prefix': ip4_prefix,
2772 'ea_bits_len': ea_bits_len,
2773 'psid_offset': psid_offset,
2774 'psid_length': psid_length,
2778 def map_if_enable_disable(self, is_enable, sw_if_index, is_translation):
2780 self.papi.map_if_enable_disable,
2782 'is_enable': is_enable,
2783 'sw_if_index': sw_if_index,
2784 'is_translation': is_translation,
2787 def map_param_set_tcp(self, tcp_mss):
2789 self.papi.map_param_set_tcp,
2794 def gtpu_add_del_tunnel(
2800 mcast_sw_if_index=0xFFFFFFFF,
2802 decap_next_index=0xFFFFFFFF,
2806 :param is_add: (Default value = 1)
2807 :param is_ipv6: (Default value = 0)
2810 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2811 :param encap_vrf_id: (Default value = 0)
2812 :param decap_next_index: (Default value = 0xFFFFFFFF)
2813 :param teid: (Default value = 0)
2816 return self.api(self.papi.gtpu_add_del_tunnel,
2819 'src_address': src_addr,
2820 'dst_address': dst_addr,
2821 'mcast_sw_if_index': mcast_sw_if_index,
2822 'encap_vrf_id': encap_vrf_id,
2823 'decap_next_index': decap_next_index,
2826 def vxlan_gpe_add_del_tunnel(
2830 mcast_sw_if_index=0xFFFFFFFF,
2841 :param is_add: (Default value = 1)
2842 :param is_ipv6: (Default value = 0)
2843 :param encap_vrf_id: (Default value = 0)
2844 :param decap_vrf_id: (Default value = 0)
2845 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2846 :param protocol: (Default value = 3)
2847 :param vni: (Default value = 0)
2850 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2855 'mcast_sw_if_index': mcast_sw_if_index,
2856 'encap_vrf_id': encap_vrf_id,
2857 'decap_vrf_id': decap_vrf_id,
2858 'protocol': protocol,
2861 def vxlan_gbp_tunnel_add_del(
2865 mcast_sw_if_index=0xFFFFFFFF,
2870 instance=0xFFFFFFFF):
2875 :param is_add: (Default value = 1)
2876 :param is_ipv6: (Default value = 0)
2877 :param encap_table_id: (Default value = 0)
2878 :param decap_next_index: (Default value = 0xFFFFFFFF)
2879 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2880 :param vni: (Default value = 0)
2881 :param instance: (Default value = 0xFFFFFFFF)
2884 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2889 'mcast_sw_if_index': mcast_sw_if_index,
2890 'encap_table_id': encap_table_id,
2892 'instance': instance}})
2894 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2895 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2896 {'sw_if_index': sw_if_index,
2897 '_no_type_conversion': True})
2899 def pppoe_add_del_session(
2909 :param is_add: (Default value = 1)
2910 :param is_ipv6: (Default value = 0)
2912 :param session_id: (Default value = 0)
2914 :param decap_vrf_id: (Default value = 0)
2917 return self.api(self.papi.pppoe_add_del_session,
2920 'session_id': session_id,
2921 'client_ip': client_ip,
2922 'decap_vrf_id': decap_vrf_id,
2923 'client_mac': client_mac})
2925 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2926 return self.api(self.papi.sr_mpls_policy_add,
2930 'n_segments': len(segments),
2931 'segments': segments})
2933 def sr_mpls_policy_del(self, bsid):
2934 return self.api(self.papi.sr_mpls_policy_del,
2937 def sr_localsid_add_del(self,
2944 sw_if_index=0xFFFFFFFF,
2948 """ Add/del IPv6 SR local-SID.
2951 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2952 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2955 :param is_del: (Default value = 0)
2956 :param end_psp: (Default value = 0)
2957 :param sw_if_index: (Default value = 0xFFFFFFFF)
2958 :param vlan_index: (Default value = 0)
2959 :param fib_table: (Default value = 0)
2962 self.papi.sr_localsid_add_del,
2964 'localsid': localsid,
2966 'behavior': behavior,
2967 'sw_if_index': sw_if_index,
2968 'vlan_index': vlan_index,
2969 'fib_table': fib_table,
2970 'nh_addr4': nh_addr4,
2971 'nh_addr6': nh_addr6
2985 :param bsid_addr: bindingSID of the SR Policy
2986 :param weight: weight of the sid list. optional. (default: 1)
2987 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2989 :param type: type/behavior of the SR policy. (default or spray) \
2991 :param fib_table: VRF where to install the FIB entry for the BSID \
2993 :param n_segments: number of segments \
2995 :param segments: a vector of IPv6 address composing the segment list \
2999 self.papi.sr_policy_add,
3000 {'bsid_addr': bsid_addr,
3002 'is_encap': is_encap,
3004 'fib_table': fib_table,
3005 'n_segments': n_segments,
3006 'segments': segments
3015 :param bsid: bindingSID of the SR Policy
3016 :param sr_policy_index: index of the sr policy (default: 0)
3019 self.papi.sr_policy_del,
3020 {'bsid_addr': bsid_addr,
3021 'sr_policy_index': sr_policy_index
3024 def sr_steering_add_del(
3035 Steer traffic L2 and L3 traffic through a given SR policy
3037 :param is_del: delete or add
3038 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
3039 :param sr_policy: is the index of the SR Policy (alt to bsid)
3040 :param table_id: is the VRF where to install the FIB entry for the BSID
3041 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
3042 :param mask_width: is the mask for L3 traffic type
3043 :param sw_if_index: is the incoming interface for L2 traffic
3044 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
3047 self.papi.sr_steering_add_del,
3049 'bsid_addr': bsid_addr,
3050 'sr_policy_index': sr_policy_index,
3051 'table_id': table_id,
3052 'prefix_addr': prefix_addr,
3053 'mask_width': mask_width,
3054 'sw_if_index': sw_if_index,
3055 'traffic_type': traffic_type
3058 def acl_add_replace(self, acl_index, r, tag='',
3060 """Add/replace an ACL
3061 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
3062 :param acl_rule r: ACL rules array.
3063 :param str tag: symbolic tag (description) for this ACL.
3064 :param int count: number of rules.
3066 return self.api(self.papi.acl_add_replace,
3067 {'acl_index': acl_index,
3071 expected_retval=expected_retval)
3073 def acl_del(self, acl_index, expected_retval=0):
3079 return self.api(self.papi.acl_del,
3080 {'acl_index': acl_index},
3081 expected_retval=expected_retval)
3083 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
3085 return self.api(self.papi.acl_interface_set_acl_list,
3086 {'sw_if_index': sw_if_index,
3090 expected_retval=expected_retval)
3092 def acl_interface_set_etype_whitelist(self, sw_if_index,
3095 return self.api(self.papi.acl_interface_set_etype_whitelist,
3096 {'sw_if_index': sw_if_index,
3097 'count': len(whitelist),
3099 'whitelist': whitelist},
3100 expected_retval=expected_retval)
3102 def acl_interface_add_del(self,
3106 """ Add/Delete ACL to/from interface
3110 :param is_add: (Default value = 1)
3113 return self.api(self.papi.acl_interface_add_del,
3116 'sw_if_index': sw_if_index,
3117 'acl_index': acl_index})
3119 def acl_dump(self, acl_index, expected_retval=0):
3120 return self.api(self.papi.acl_dump,
3121 {'acl_index': acl_index},
3122 expected_retval=expected_retval)
3124 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3126 return self.api(self.papi.acl_interface_list_dump,
3127 {'sw_if_index': sw_if_index},
3128 expected_retval=expected_retval)
3130 def macip_acl_add(self, rules, tag=""):
3133 :param rules: list of rules for given acl
3137 return self.api(self.papi.macip_acl_add,
3139 'count': len(rules),
3142 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3145 :param rules: list of rules for given acl
3149 return self.api(self.papi.macip_acl_add_replace,
3150 {'acl_index': acl_index,
3152 'count': len(rules),
3155 def macip_acl_del(self, acl_index):
3161 return self.api(self.papi.macip_acl_del,
3162 {'acl_index': acl_index})
3164 def macip_acl_interface_add_del(self,
3168 """ Add MACIP acl to interface
3172 :param is_add: (Default value = 1)
3175 return self.api(self.papi.macip_acl_interface_add_del,
3177 'sw_if_index': sw_if_index,
3178 'acl_index': acl_index})
3180 def macip_acl_interface_get(self):
3181 """ Return interface acls dump
3184 self.papi.macip_acl_interface_get, {})
3186 def macip_acl_dump(self, acl_index=4294967295):
3187 """ Return MACIP acl dump
3191 self.papi.macip_acl_dump, {'acl_index': acl_index})
3193 def policer_add_del(self,
3204 conform_action_type=1,
3206 exceed_action_type=0,
3208 violate_action_type=0,
3210 return self.api(self.papi.policer_add_del,
3217 'rate_type': rate_type,
3218 'round_type': round_type,
3220 'color_aware': color_aware,
3221 'conform_action_type': conform_action_type,
3222 'conform_dscp': conform_dscp,
3223 'exceed_action_type': exceed_action_type,
3224 'exceed_dscp': exceed_dscp,
3225 'violate_action_type': violate_action_type,
3226 'violate_dscp': violate_dscp})
3228 def ip_punt_police(self,
3232 return self.api(self.papi.ip_punt_police,
3233 {'policer_index': policer_index,
3237 def ip_punt_redirect(self,
3242 return self.api(self.papi.ip_punt_redirect,
3243 {'punt': {'rx_sw_if_index': rx_sw_if_index,
3244 'tx_sw_if_index': tx_sw_if_index,
3248 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
3249 return self.api(self.papi.ip_punt_redirect_dump,
3250 {'sw_if_index': sw_if_index,
3251 'is_ipv6': is_ipv6})
3253 def bier_table_add_del(self,
3257 """ BIER Table add/del """
3259 self.papi.bier_table_add_del,
3260 {'bt_tbl_id': {"bt_set": bti.set_id,
3261 "bt_sub_domain": bti.sub_domain_id,
3262 "bt_hdr_len_id": bti.hdr_len_id},
3263 'bt_label': mpls_label,
3264 'bt_is_add': is_add})
3266 def bier_table_dump(self):
3267 return self.api(self.papi.bier_table_dump, {})
3269 def bier_route_add_del(self,
3275 """ BIER Route add/del """
3277 self.papi.bier_route_add_del,
3278 {'br_tbl_id': {"bt_set": bti.set_id,
3279 "bt_sub_domain": bti.sub_domain_id,
3280 "bt_hdr_len_id": bti.hdr_len_id},
3282 'br_n_paths': len(paths),
3284 'br_is_add': is_add,
3285 'br_is_replace': is_replace})
3287 def bier_route_dump(self, bti):
3289 self.papi.bier_route_dump,
3290 {'br_tbl_id': {"bt_set": bti.set_id,
3291 "bt_sub_domain": bti.sub_domain_id,
3292 "bt_hdr_len_id": bti.hdr_len_id}})
3294 def bier_imp_add(self,
3299 """ BIER Imposition Add """
3301 self.papi.bier_imp_add,
3302 {'bi_tbl_id': {"bt_set": bti.set_id,
3303 "bt_sub_domain": bti.sub_domain_id,
3304 "bt_hdr_len_id": bti.hdr_len_id},
3306 'bi_n_bytes': len(ibytes),
3307 'bi_bytes': ibytes})
3309 def bier_imp_del(self, bi_index):
3310 """ BIER Imposition del """
3312 self.papi.bier_imp_del,
3313 {'bi_index': bi_index})
3315 def bier_imp_dump(self):
3316 return self.api(self.papi.bier_imp_dump, {})
3318 def bier_disp_table_add_del(self,
3321 """ BIER Disposition Table add/del """
3323 self.papi.bier_disp_table_add_del,
3324 {'bdt_tbl_id': bdti,
3325 'bdt_is_add': is_add})
3327 def bier_disp_table_dump(self):
3328 return self.api(self.papi.bier_disp_table_dump, {})
3330 def bier_disp_entry_add_del(self,
3340 """ BIER Route add/del """
3342 while (len(lstack) < 16):
3345 self.papi.bier_disp_entry_add_del,
3346 {'bde_tbl_id': bdti,
3348 'bde_payload_proto': payload_proto,
3350 'bde_paths': [{'next_hop': next_hop,
3351 'table_id': next_hop_tbl_id,
3352 'afi': next_hop_afi,
3353 'rpf_id': next_hop_rpf_id,
3355 'label_stack': lstack}],
3356 'bde_is_add': is_add})
3358 def bier_disp_entry_dump(self, bdti):
3360 self.papi.bier_disp_entry_dump,
3361 {'bde_tbl_id': bdti})
3363 def add_node_next(self, node_name, next_name):
3364 """ Set the next node for a given node request
3369 return self.api(self.papi.add_node_next,
3370 {'node_name': node_name,
3371 'next_name': next_name})
3373 def session_enable_disable(self, is_enabled):
3375 self.papi.session_enable_disable,
3376 {'is_enable': is_enabled})
3378 def ipsec_spd_add_del(self, spd_id, is_add=1):
3379 """ SPD add/del - Wrapper to add or del ipsec SPD
3380 Sample CLI : 'ipsec spd add 1'
3382 :param spd_id - SPD ID to be created in the vpp . mandatory
3383 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3385 :returns: reply from the API
3388 self.papi.ipsec_spd_add_del, {
3389 'spd_id': spd_id, 'is_add': is_add})
3391 def ipsec_spds_dump(self):
3392 return self.api(self.papi.ipsec_spds_dump, {})
3394 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3395 """ IPSEC interface SPD add/del - \
3396 Wrapper to associate/disassociate SPD to interface in VPP
3397 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3399 :param spd_id - SPD ID to associate with the interface . mandatory
3400 :param sw_if_index - Interface Index which needs to ipsec \
3401 association mandatory
3402 :param is_add - add(1) or del(0) association with interface \
3403 (Default 1 - add) . optional
3404 :returns: reply from the API
3407 self.papi.ipsec_interface_add_del_spd,
3408 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3410 def ipsec_spd_interface_dump(self, spd_index=None):
3411 return self.api(self.papi.ipsec_spd_interface_dump,
3412 {'spd_index': spd_index if spd_index else 0,
3413 'spd_index_valid': 1 if spd_index else 0})
3415 def ipsec_sad_entry_add_del(self,
3418 integrity_algorithm,
3423 tunnel_src_address='',
3424 tunnel_dst_address='',
3427 """ IPSEC SA add/del
3428 :param sad_id: security association ID
3429 :param spi: security param index of the SA in decimal
3430 :param integrity_algorithm:
3431 :param integrity_key:
3432 :param crypto_algorithm:
3434 :param protocol: AH(0) or ESP(1) protocol
3435 :param tunnel_src_address: tunnel mode outer src address
3436 :param tunnel_dst_address: tunnel mode outer dst address
3439 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3440 crypto and ipsec algorithms
3443 self.papi.ipsec_sad_entry_add_del,
3450 'tunnel_src': tunnel_src_address,
3451 'tunnel_dst': tunnel_dst_address,
3452 'protocol': protocol,
3453 'integrity_algorithm': integrity_algorithm,
3455 'length': len(integrity_key),
3456 'data': integrity_key,
3458 'crypto_algorithm': crypto_algorithm,
3460 'length': len(crypto_key),
3467 def ipsec_sa_dump(self, sa_id=None):
3468 return self.api(self.papi.ipsec_sa_dump,
3469 {'sa_id': sa_id if sa_id else 0xffffffff})
3471 def ipsec_spd_entry_add_del(self,
3474 local_address_start,
3476 remote_address_start,
3477 remote_address_stop,
3479 local_port_stop=65535,
3480 remote_port_start=0,
3481 remote_port_stop=65535,
3489 """ IPSEC policy SPD add/del -
3490 Wrapper to configure ipsec SPD policy entries in VPP
3491 :param spd_id: SPD ID for the policy
3492 :param local_address_start: local-ip-range start address
3493 :param local_address_stop : local-ip-range stop address
3494 :param remote_address_start: remote-ip-range start address
3495 :param remote_address_stop : remote-ip-range stop address
3496 :param local_port_start: (Default value = 0)
3497 :param local_port_stop: (Default value = 65535)
3498 :param remote_port_start: (Default value = 0)
3499 :param remote_port_stop: (Default value = 65535)
3500 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3501 :param sa_id: Security Association ID for mapping it to SPD
3502 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3504 :param priority: value for the spd action (Default value = 100)
3505 :param is_outbound: flag for inbound(0) or outbound(1)
3507 :param is_add: (Default value = 1)
3510 self.papi.ipsec_spd_entry_add_del,
3517 'local_address_start': local_address_start,
3518 'local_address_stop': local_address_stop,
3519 'remote_address_start': remote_address_start,
3520 'remote_address_stop': remote_address_stop,
3521 'local_port_start': local_port_start,
3522 'local_port_stop': local_port_stop,
3523 'remote_port_start': remote_port_start,
3524 'remote_port_stop': remote_port_stop,
3525 'protocol': protocol,
3527 'priority': priority,
3528 'is_outbound': is_outbound,
3529 'is_ip_any': is_ip_any
3533 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
3534 return self.api(self.papi.ipsec_spd_dump,
3538 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3539 remote_spi, crypto_alg, local_crypto_key,
3540 remote_crypto_key, integ_alg, local_integ_key,
3541 remote_integ_key, is_add=1, esn=0,
3542 anti_replay=1, renumber=0, show_instance=0):
3544 self.papi.ipsec_tunnel_if_add_del,
3545 {'local_ip': local_ip, 'remote_ip': remote_ip,
3546 'local_spi': local_spi, 'remote_spi': remote_spi,
3547 'crypto_alg': crypto_alg,
3548 'local_crypto_key_len': len(local_crypto_key),
3549 'local_crypto_key': local_crypto_key,
3550 'remote_crypto_key_len': len(remote_crypto_key),
3551 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3552 'local_integ_key_len': len(local_integ_key),
3553 'local_integ_key': local_integ_key,
3554 'remote_integ_key_len': len(remote_integ_key),
3555 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3556 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3557 'show_instance': show_instance
3560 def ipsec_select_backend(self, protocol, index):
3561 return self.api(self.papi.ipsec_select_backend,
3562 {'protocol': protocol, 'index': index})
3564 def ipsec_backend_dump(self):
3565 return self.api(self.papi.ipsec_backend_dump, {})
3567 def app_namespace_add(self,
3571 sw_if_index=0xFFFFFFFF,
3574 self.papi.app_namespace_add_del,
3576 'sw_if_index': sw_if_index,
3577 'ip4_fib_id': ip4_fib_id,
3578 'ip6_fib_id': ip6_fib_id,
3579 'namespace_id': namespace_id,
3580 'namespace_id_len': len(namespace_id)})
3582 def punt_socket_register(self, port, pathname, protocol=0x11,
3583 header_version=1, is_ip4=1):
3584 """ Register punt socket """
3585 return self.api(self.papi.punt_socket_register,
3586 {'header_version': header_version,
3587 'punt': {'ipv': is_ip4,
3588 'l4_protocol': protocol,
3590 'pathname': pathname})
3592 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
3593 """ Unregister punt socket """
3594 return self.api(self.papi.punt_socket_deregister,
3595 {'punt': {'ipv': is_ip4,
3596 'l4_protocol': protocol,
3599 def punt_socket_dump(self, is_ip6=1):
3600 """ Dump punt socket"""
3601 return self.api(self.papi.punt_socket_dump,
3602 {'is_ipv6': is_ip6})
3604 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3605 expire_walk_interval_ms, is_ip6=0):
3606 """ Set IP reassembly parameters """
3607 return self.api(self.papi.ip_reassembly_set,
3609 'timeout_ms': timeout_ms,
3610 'expire_walk_interval_ms': expire_walk_interval_ms,
3611 'max_reassemblies': max_reassemblies})
3613 def ip_reassembly_get(self, is_ip6=0):
3614 """ Get IP reassembly parameters """
3615 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3617 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3619 """ Enable/disable IP reassembly """
3620 return self.api(self.papi.ip_reassembly_enable_disable,
3621 {'sw_if_index': sw_if_index,
3622 'enable_ip4': 1 if enable_ip4 else 0,
3623 'enable_ip6': 1 if enable_ip6 else 0,
3626 def gbp_endpoint_add(self, sw_if_index, ips, mac, epg, flags,
3628 """ GBP endpoint Add """
3629 return self.api(self.papi.gbp_endpoint_add,
3631 'sw_if_index': sw_if_index,
3642 def gbp_endpoint_del(self, handle):
3643 """ GBP endpoint Del """
3644 return self.api(self.papi.gbp_endpoint_del,
3647 def gbp_endpoint_dump(self):
3648 """ GBP endpoint Dump """
3649 return self.api(self.papi.gbp_endpoint_dump,
3650 {'_no_type_conversion': True})
3652 def gbp_endpoint_group_add(self, epg, sclass, bd,
3653 rd, uplink_sw_if_index):
3654 """ GBP endpoint group Add """
3655 return self.api(self.papi.gbp_endpoint_group_add,
3658 'uplink_sw_if_index': uplink_sw_if_index,
3665 def gbp_endpoint_group_del(self, epg):
3666 """ GBP endpoint group Del """
3667 return self.api(self.papi.gbp_endpoint_group_del,
3670 def gbp_endpoint_group_dump(self):
3671 """ GBP endpoint group Dump """
3672 return self.api(self.papi.gbp_endpoint_group_dump, {})
3674 def gbp_bridge_domain_add(self, bd_id, flags,
3677 bm_flood_sw_if_index):
3678 """ GBP bridge-domain Add """
3679 return self.api(self.papi.gbp_bridge_domain_add,
3683 'bvi_sw_if_index': bvi_sw_if_index,
3684 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
3685 'bm_flood_sw_if_index': bm_flood_sw_if_index,
3689 def gbp_bridge_domain_del(self, bd_id):
3690 """ GBP bridge-domain Del """
3691 return self.api(self.papi.gbp_bridge_domain_del,
3694 def gbp_bridge_domain_dump(self):
3695 """ GBP Bridge Domain Dump """
3696 return self.api(self.papi.gbp_bridge_domain_dump, {})
3698 def gbp_route_domain_add(self, rd_id,
3702 ip6_uu_sw_if_index):
3703 """ GBP route-domain Add """
3704 return self.api(self.papi.gbp_route_domain_add,
3707 'ip4_table_id': ip4_table_id,
3708 'ip6_table_id': ip6_table_id,
3709 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
3710 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
3714 def gbp_route_domain_del(self, rd_id):
3715 """ GBP route-domain Del """
3716 return self.api(self.papi.gbp_route_domain_del,
3719 def gbp_route_domain_dump(self):
3720 """ GBP Route Domain Dump """
3721 return self.api(self.papi.gbp_route_domain_dump, {})
3723 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3724 """ GBP recirc Add/Del """
3725 return self.api(self.papi.gbp_recirc_add_del,
3729 'sw_if_index': sw_if_index,
3732 def gbp_recirc_dump(self):
3733 """ GBP recirc Dump """
3734 return self.api(self.papi.gbp_recirc_dump, {})
3736 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
3737 """ GBP recirc Add/Del """
3738 return self.api(self.papi.gbp_ext_itf_add_del,
3741 'sw_if_index': sw_if_index,
3745 def gbp_ext_itf_dump(self):
3746 """ GBP recirc Dump """
3747 return self.api(self.papi.gbp_ext_itf_dump, {})
3749 def gbp_subnet_add_del(self, is_add, rd_id,
3751 sw_if_index=0xffffffff,
3753 """ GBP Subnet Add/Del """
3754 return self.api(self.papi.gbp_subnet_add_del,
3758 'sw_if_index': sw_if_index,
3763 def gbp_subnet_dump(self):
3764 """ GBP Subnet Dump """
3765 return self.api(self.papi.gbp_subnet_dump,
3766 {'_no_type_conversion': True})
3768 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index,
3769 rules, allowed_ethertypes):
3770 """ GBP contract Add/Del """
3771 return self.api(self.papi.gbp_contract_add_del,
3774 'acl_index': acl_index,
3777 'n_rules': len(rules),
3779 'n_ether_types': len(allowed_ethertypes),
3780 'allowed_ethertypes': allowed_ethertypes}})
3782 def gbp_contract_dump(self):
3783 """ GBP contract Dump """
3784 return self.api(self.papi.gbp_contract_dump, {})
3786 def gbp_endpoint_learn_set_inactive_threshold(self, threshold):
3787 """ GBP set inactive threshold """
3788 return self.api(self.papi.gbp_endpoint_learn_set_inactive_threshold,
3789 {'threshold': threshold})
3791 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode):
3792 """ GBP VXLAN tunnel add """
3793 return self.api(self.papi.gbp_vxlan_tunnel_add,
3798 'bd_rd_id': bd_rd_id
3802 def gbp_vxlan_tunnel_del(self, vni):
3803 """ GBP VXLAN tunnel del """
3804 return self.api(self.papi.gbp_vxlan_tunnel_del,
3809 def gbp_vxlan_tunnel_dump(self):
3810 """ GBP VXLAN tunnel add/del """
3811 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
3813 def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3814 ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3816 """ 6RD tunnel Add """
3817 return self.api(self.papi.ipip_6rd_add_tunnel,
3818 {'ip4_table_id': ip4_table_id,
3819 'ip6_table_id': ip6_table_id,
3820 'ip6_prefix': ip6_prefix,
3821 'ip6_prefix_len': ip6_prefix_len,
3822 'ip4_prefix': ip4_prefix,
3823 'ip4_prefix_len': ip4_prefix_len,
3825 'security_check': security_check})
3827 def ipip_6rd_del_tunnel(self, sw_if_index):
3828 """ 6RD tunnel Delete """
3829 return self.api(self.papi.ipip_6rd_del_tunnel,
3830 {'sw_if_index': sw_if_index})
3832 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3833 instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3834 """ IPIP tunnel Add/Del """
3835 return self.api(self.papi.ipip_add_tunnel,
3836 {'is_ipv6': is_ipv6,
3837 'instance': instance,
3838 'src_address': src_address,
3839 'dst_address': dst_address,
3840 'table_id': table_id,
3843 def ipip_del_tunnel(self, sw_if_index):
3844 """ IPIP tunnel Delete """
3845 return self.api(self.papi.ipip_del_tunnel,
3846 {'sw_if_index': sw_if_index})
3848 def qos_egress_map_update(self, id, outputs):
3849 """ QOS egress map update """
3850 return self.api(self.papi.qos_egress_map_update,
3854 def qos_egress_map_delete(self, id):
3855 """ QOS egress map delete """
3856 return self.api(self.papi.qos_egress_map_delete,
3859 def qos_mark_enable_disable(self, sw_if_index,
3863 """ QOS Mark Enable/Disable """
3864 return self.api(self.papi.qos_mark_enable_disable,
3866 'sw_if_index': sw_if_index,
3867 'output_source': output_source,
3870 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3871 """ IP QoS recording Enble/Disable """
3872 return self.api(self.papi.qos_record_enable_disable,
3873 {'sw_if_index': sw_if_index,
3874 'input_source': input_source,
3877 def igmp_enable_disable(self, sw_if_index, enable, host):
3878 """ Enable/disable IGMP on a given interface """
3879 return self.api(self.papi.igmp_enable_disable,
3882 'sw_if_index': sw_if_index})
3884 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
3885 """ Add/del IGMP proxy device """
3886 return self.api(self.papi.igmp_proxy_device_add_del,
3887 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3890 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
3891 """ Add/del interface to/from IGMP proxy device """
3892 return self.api(self.papi.igmp_proxy_device_add_del_interface,
3893 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3896 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3897 """ Listen for new (S,G) on specified interface
3899 :param enable: add/del
3900 :param sw_if_index: interface sw index
3901 :param saddr: source ip4 addr
3902 :param gaddr: group ip4 addr
3904 return self.api(self.papi.igmp_listen,
3909 'sw_if_index': sw_if_index,
3910 'n_srcs': len(saddrs),
3916 def igmp_dump(self, sw_if_index=None):
3917 """ Dump all (S,G) interface configurations """
3918 if sw_if_index is None:
3919 sw_if_index = 0xffffffff
3920 return self.api(self.papi.igmp_dump,
3921 {'sw_if_index': sw_if_index})
3923 def igmp_clear_interface(self, sw_if_index):
3924 """ Remove all (S,G)s from specified interface
3925 doesn't send IGMP report!
3928 self.papi.igmp_clear_interface, {
3929 'sw_if_index': sw_if_index})
3931 def want_igmp_events(self, enable=1):
3932 return self.api(self.papi.want_igmp_events, {'enable': enable,
3933 'pid': os.getpid()})
3941 interface_id=0xFFFFFFFF):
3944 :param lb: load balance
3945 :param use_custom_mac: use custom mac
3946 :param mac_address: mac address
3947 :param interface_id: custom interface ID
3950 self.papi.bond_create,
3953 'use_custom_mac': use_custom_mac,
3954 'mac_address': mac_address,
3962 :param sw_if_index: interface the operation is applied to
3964 return self.api(self.papi.bond_delete,
3965 {'sw_if_index': sw_if_index})
3974 :param sw_if_index: slave sw_if_index
3975 :param bond_sw_if_index: bond sw_if_index
3976 :param is_passive: is passive lacp speaker
3977 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3980 self.papi.bond_enslave,
3981 {'sw_if_index': sw_if_index,
3982 'bond_sw_if_index': bond_sw_if_index,
3983 'is_passive': is_passive,
3984 'is_long_timeout': is_long_timeout
3987 def bond_detach_slave(
3991 :param sw_if_index: slave interface the operation is applied to
3993 return self.api(self.papi.bond_detach_slave,
3994 {'sw_if_index': sw_if_index})
3996 def sw_interface_slave_dump(
4000 :param sw_if_index: bond sw_if_index
4002 return self.api(self.papi.sw_interface_slave_dump,
4003 {'sw_if_index': sw_if_index})
4005 def sw_interface_bond_dump(
4010 return self.api(self.papi.sw_interface_bond_dump,
4013 def create_vhost_user_if(
4019 disable_indirect_desc,
4020 custom_dev_instance,
4025 :param is_server: is server
4026 :param sock_filename: socket name
4027 :param renumber: renumber
4028 :param disable_mrg_rxbuf: disable mergable rx buffers
4029 :param disable_indirect_desc: disable indirect descriptors
4030 :param custom_dev_instance: custom dev instance
4031 :param use_custom_mac: use custom mac
4032 :param mac_address: mac address
4033 :param tag: tag (default '')
4036 self.papi.create_vhost_user_if,
4037 {'is_server': is_server,
4038 'sock_filename': sock_filename,
4039 'renumber': renumber,
4040 'disable_mrg_rxbuf': disable_mrg_rxbuf,
4041 'disable_indirect_desc': disable_indirect_desc,
4042 'custom_dev_instance': custom_dev_instance,
4043 'use_custom_mac': use_custom_mac,
4044 'mac_address': mac_address,
4048 def delete_vhost_user_if(
4052 :param sw_if_index: interface the operation is applied to
4054 return self.api(self.papi.delete_vhost_user_if,
4055 {'sw_if_index': sw_if_index, })
4057 def sw_interface_vhost_user_dump(
4062 return self.api(self.papi.sw_interface_vhost_user_dump,
4065 def abf_policy_add_del(self, is_add, policy):
4067 self.papi.abf_policy_add_del,
4071 def abf_itf_attach_add_del(self, is_add, attach):
4073 self.papi.abf_itf_attach_add_del,
4077 def abf_policy_dump(self):
4079 self.papi.abf_policy_dump, {})
4081 def abf_itf_attach_dump(self):
4083 self.papi.abf_itf_attach_dump, {})
4085 def pipe_create(self, is_specified, user_instance):
4086 return self.api(self.papi.pipe_create,
4087 {'is_specified': is_specified,
4088 'user_instance': user_instance})
4090 def pipe_delete(self, parent_sw_if_index):
4091 return self.api(self.papi.pipe_delete,
4092 {'parent_sw_if_index': parent_sw_if_index})
4094 def pipe_dump(self):
4095 return self.api(self.papi.pipe_dump, {})
4109 return self.api(self.papi.memif_create,
4112 'rx_queues': rx_queues,
4113 'tx_queues': tx_queues,
4115 'socket_id': socket_id,
4117 'ring_size': ring_size,
4118 'buffer_size': buffer_size,
4119 'hw_addr': hw_addr})
4121 def memif_delete(self, sw_if_index):
4122 return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index})
4124 def memif_dump(self):
4125 return self.api(self.papi.memif_dump, {})
4127 def memif_socket_filename_add_del(
4128 self, is_add, socket_id, socket_filename):
4130 self.papi.memif_socket_filename_add_del,
4132 'socket_id': socket_id,
4133 'socket_filename': socket_filename})
4135 def memif_socket_filename_dump(self):
4136 return self.api(self.papi.memif_socket_filename_dump, {})
4138 def svs_table_add_del(self, af, table_id, is_add=1):
4139 return self.api(self.papi.svs_table_add_del,
4141 'table_id': table_id,
4146 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
4147 return self.api(self.papi.svs_route_add_del,
4149 'table_id': table_id,
4150 'source_table_id': src_table_id,
4155 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
4156 return self.api(self.papi.svs_enable_disable,
4159 'table_id': table_id,
4160 'sw_if_index': sw_if_index,
4161 'is_enable': is_enable,
4165 return self.api(self.papi.svs_dump, {})
4167 def syslog_set_sender(
4174 """Set syslog sender configuration
4176 :param collector: colector IP address
4177 :param src: source IP address
4178 :param collector_port: collector UDP port (Default value = 514)
4179 :param vrf_id: VRF id (Default value = 0)
4180 :param max_msg_size: maximum message length (Default value = 480)
4182 return self.api(self.papi.syslog_set_sender,
4183 {'collector_address': collector,
4185 'collector_port': collector_port,
4187 'max_msg_size': max_msg_size})
4189 def syslog_get_sender(self):
4190 """Return syslog sender configuration"""
4191 return self.api(self.papi.syslog_get_sender, {})
4193 def syslog_set_filter(self, severity):
4194 """Set syslog filter parameters
4196 :param severity: severity filter (specified severity and greater match)
4198 return self.api(self.papi.syslog_set_filter, {'severity': severity})
4200 def syslog_get_filter(self):
4201 """Return syslog filter parameters"""
4202 return self.api(self.papi.syslog_get_filter, {})