4 from collections import deque
7 from vpp_papi import VPP, mac_pton
9 from vpp_l2 import L2_PORT_TYPE
11 # from vnet/vnet/mpls/mpls_types.h
12 MPLS_IETF_MAX_LABEL = 0xfffff
13 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
35 class SYSLOG_SEVERITY:
46 class UnexpectedApiReturnValueError(Exception):
47 """ exception raised when the API return value is unexpected """
51 class VppPapiProvider(object):
52 """VPP-api provider using vpp-papi
54 @property hook: hook object providing before and after api/cli hooks
57 _zero, _negative = range(2)
59 def __init__(self, name, shm_prefix, test_class, read_timeout):
60 self.hook = Hook("vpp-papi-provider")
62 self.shm_prefix = shm_prefix
63 self.test_class = test_class
64 self._expect_api_retval = self._zero
65 self._expect_stack = []
67 install_dir = os.getenv('VPP_INSTALL_PATH')
69 # Vapi requires 'VPP_API_DIR', not set when run from Makefile.
70 if 'VPP_API_DIR' not in os.environ:
71 os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH')
73 self.vpp = VPP(logger=test_class.logger,
74 read_timeout=read_timeout)
75 self._events = deque()
80 def assert_negative_api_retval(self):
81 """ Expect API failure - used with with, e.g.:
82 with self.vapi.assert_negative_api_retval():
83 self.vapi.<api call expected to fail>
85 self._expect_stack.append(self._expect_api_retval)
86 self._expect_api_retval = self._negative
89 def assert_zero_api_retval(self):
90 """ Expect API success - used with with, e.g.:
91 with self.vapi.assert_negative_api_retval():
92 self.vapi.<api call expected to succeed>
94 note: this is useful only inside another with block
95 as success is the default expected value
97 self._expect_stack.append(self._expect_api_retval)
98 self._expect_api_retval = self._zero
101 def __exit__(self, exc_type, exc_value, traceback):
102 self._expect_api_retval = self._expect_stack.pop()
104 def register_hook(self, hook):
105 """Replace hook registration with new hook
112 def collect_events(self):
113 """ Collect all events from the internal queue and clear the queue. """
115 self._events = deque()
118 def wait_for_event(self, timeout, name=None):
119 """ Wait for and return next event. """
121 self.test_class.logger.debug("Expecting event '%s' within %ss",
124 self.test_class.logger.debug("Expecting event within %ss",
127 self.test_class.logger.debug("Not waiting, event already queued")
128 limit = time.time() + timeout
129 while time.time() < limit:
131 e = self._events.popleft()
132 if name and type(e).__name__ != name:
134 "Unexpected event received: %s, expected: %s" %
135 (type(e).__name__, name))
136 self.test_class.logger.debug("Returning event %s:%s" %
139 time.sleep(0) # yield
140 raise Exception("Event did not occur within timeout")
142 def __call__(self, name, event):
143 """ Enqueue event in the internal event queue. """
144 # FIXME use the name instead of relying on type(e).__name__ ?
145 # FIXME #2 if this throws, it is eaten silently, Ole?
146 self.test_class.logger.debug("New event: %s: %s" % (name, event))
147 self._events.append(event)
150 """Connect the API to VPP"""
151 self.vpp.connect(self.name, self.shm_prefix)
152 self.papi = self.vpp.api
153 self.vpp.register_event_callback(self)
155 def disconnect(self):
156 """Disconnect the API from VPP"""
157 self.vpp.disconnect()
159 def api(self, api_fn, api_args, expected_retval=0):
160 """ Call API function and check it's return value.
161 Call the appropriate hooks before and after the API call
163 :param api_fn: API function to call
164 :param api_args: tuple of API function arguments
165 :param expected_retval: Expected return value (Default value = 0)
166 :returns: reply from the API
169 self.hook.before_api(api_fn.__name__, api_args)
170 reply = api_fn(**api_args)
171 if self._expect_api_retval == self._negative:
172 if hasattr(reply, 'retval') and reply.retval >= 0:
173 msg = "API call passed unexpectedly: expected negative "\
174 "return value instead of %d in %s" % \
175 (reply.retval, moves.reprlib.repr(reply))
176 self.test_class.logger.info(msg)
177 raise UnexpectedApiReturnValueError(msg)
178 elif self._expect_api_retval == self._zero:
179 if hasattr(reply, 'retval') and reply.retval != expected_retval:
180 msg = "API call failed, expected %d return value instead "\
181 "of %d in %s" % (expected_retval, reply.retval,
182 moves.reprlib.repr(reply))
183 self.test_class.logger.info(msg)
184 raise UnexpectedApiReturnValueError(msg)
186 raise Exception("Internal error, unexpected value for "
187 "self._expect_api_retval %s" %
188 self._expect_api_retval)
189 self.hook.after_api(api_fn.__name__, api_args)
193 """ Execute a CLI, calling the before/after hooks appropriately.
195 :param cli: CLI to execute
199 self.hook.before_cli(cli)
201 r = self.papi.cli_inband(cmd=cli)
202 self.hook.after_cli(cli)
203 if hasattr(r, 'reply'):
206 def ppcli(self, cli):
207 """ Helper method to print CLI command in case of info logging level.
209 :param cli: CLI to execute
212 return cli + "\n" + str(self.cli(cli))
214 def show_version(self):
216 return self.api(self.papi.show_version, {})
218 def pg_create_interface(self, pg_index):
224 return self.api(self.papi.pg_create_interface,
225 {"interface_id": pg_index})
227 def sw_interface_dump(self, filter=None):
230 :param filter: (Default value = None)
233 if filter is not None:
234 args = {"name_filter_valid": 1, "name_filter": filter}
237 return self.api(self.papi.sw_interface_dump, args)
239 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
240 """ Set the IPvX Table-id for the Interface
247 return self.api(self.papi.sw_interface_set_table,
248 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
251 def sw_interface_get_table(self, sw_if_index, is_ipv6):
252 """ Get the IPvX Table-id for the Interface
259 return self.api(self.papi.sw_interface_get_table,
260 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6})
262 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
263 is_ipv6=0, is_add=1, del_all=0):
266 :param addr: param is_ipv6: (Default value = 0)
269 :param is_ipv6: (Default value = 0)
270 :param is_add: (Default value = 1)
271 :param del_all: (Default value = 0)
274 return self.api(self.papi.sw_interface_add_del_address,
275 {'sw_if_index': sw_if_index,
279 'address_length': addr_len,
282 def ip_address_dump(self, sw_if_index, is_ipv6=0):
283 return self.api(self.papi.ip_address_dump,
284 {'sw_if_index': sw_if_index,
287 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
289 """ Set the Interface to be unnumbered
291 :param is_add: (Default value = 1)
292 :param sw_if_index - interface That will be unnumbered
293 :param ip_sw_if_index - interface with an IP addres
296 return self.api(self.papi.sw_interface_set_unnumbered,
297 {'sw_if_index': ip_sw_if_index,
298 'unnumbered_sw_if_index': sw_if_index,
301 def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
302 return self.api(self.papi.ip_unnumbered_dump,
303 {'sw_if_index': sw_if_index})
305 def sw_interface_enable_disable_mpls(self, sw_if_index,
308 Enable/Disable MPLS on the interface
310 :param is_enable: (Default value = 1)
313 return self.api(self.papi.sw_interface_set_mpls_enable,
314 {'sw_if_index': sw_if_index,
315 'enable': is_enable})
317 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
318 return self.api(self.papi.sw_interface_ip6nd_ra_config,
319 {'sw_if_index': sw_if_index,
320 'suppress': suppress})
322 def set_ip_flow_hash(self,
331 return self.api(self.papi.set_ip_flow_hash,
341 def ip6_nd_proxy(self, ip, sw_if_index, is_del=0):
342 return self.api(self.papi.ip6nd_proxy_add_del,
344 'sw_if_index': sw_if_index,
347 def ip6_sw_interface_ra_config(self, sw_if_index,
351 return self.api(self.papi.sw_interface_ip6nd_ra_config,
352 {'sw_if_index': sw_if_index,
354 'suppress': suppress,
355 'send_unicast': send_unicast})
357 def ip6_sw_interface_ra_prefix(self,
367 val_lifetime=0xffffffff,
368 pref_lifetime=0xffffffff):
369 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
370 {'sw_if_index': sw_if_index,
373 'address_length': address_length,
375 'use_default': use_default,
376 'no_advertise': no_advertise,
377 'off_link': off_link,
378 'no_autoconfig': no_autoconfig,
379 'no_onlink': no_onlink,
381 'val_lifetime': val_lifetime,
382 'pref_lifetime': pref_lifetime})
384 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
386 Enable/Disable An interface for IPv6
388 return self.api(self.papi.sw_interface_ip6_enable_disable,
389 {'sw_if_index': sw_if_index,
392 def vxlan_add_del_tunnel(
396 mcast_sw_if_index=0xFFFFFFFF,
400 decap_next_index=0xFFFFFFFF,
402 instance=0xFFFFFFFF):
407 :param is_add: (Default value = 1)
408 :param is_ipv6: (Default value = 0)
409 :param encap_vrf_id: (Default value = 0)
410 :param decap_next_index: (Default value = 0xFFFFFFFF)
411 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
412 :param vni: (Default value = 0)
413 :param instance: (Default value = 0xFFFFFFFF)
416 return self.api(self.papi.vxlan_add_del_tunnel,
419 'src_address': src_addr,
420 'dst_address': dst_addr,
421 'mcast_sw_if_index': mcast_sw_if_index,
422 'encap_vrf_id': encap_vrf_id,
423 'decap_next_index': decap_next_index,
425 'instance': instance})
427 def geneve_add_del_tunnel(
431 mcast_sw_if_index=0xFFFFFFFF,
435 decap_next_index=0xFFFFFFFF,
441 :param is_add: (Default value = 1)
442 :param is_ipv6: (Default value = 0)
443 :param encap_vrf_id: (Default value = 0)
444 :param decap_next_index: (Default value = 0xFFFFFFFF)
445 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
446 :param vni: (Default value = 0)
449 return self.api(self.papi.geneve_add_del_tunnel,
452 'local_address': local_addr,
453 'remote_address': remote_addr,
454 'mcast_sw_if_index': mcast_sw_if_index,
455 'encap_vrf_id': encap_vrf_id,
456 'decap_next_index': decap_next_index,
459 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
460 learn=1, arp_term=0, is_add=1):
461 """Create/delete bridge domain.
463 :param int bd_id: Bridge domain index.
464 :param int flood: Enable/disable bcast/mcast flooding in the BD.
466 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
468 :param int forward: Enable/disable forwarding on all interfaces in
469 the BD. (Default value = 1)
470 :param int learn: Enable/disable learning on all interfaces in the BD.
472 :param int arp_term: Enable/disable arp termination in the BD.
474 :param int is_add: Add or delete flag. (Default value = 1)
476 return self.api(self.papi.bridge_domain_add_del,
479 'uu_flood': uu_flood,
482 'arp_term': arp_term,
485 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
486 return self.api(self.papi.bd_ip_mac_add_del,
492 def bd_ip_mac_dump(self, bd_id):
493 return self.api(self.papi.bd_ip_mac_dump,
496 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
497 return self.api(self.papi.want_ip4_arp_events,
498 {'enable_disable': enable_disable,
500 'pid': os.getpid(), })
502 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
503 return self.api(self.papi.want_ip6_nd_events,
504 {'enable_disable': enable_disable,
506 'pid': os.getpid(), })
508 def want_ip6_ra_events(self, enable_disable=1):
509 return self.api(self.papi.want_ip6_ra_events,
510 {'enable_disable': enable_disable,
511 'pid': os.getpid(), })
513 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
515 return self.api(self.papi.ip6nd_send_router_solicitation,
520 'sw_if_index': sw_if_index})
522 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
523 install_default_routes):
524 return self.api(self.papi.ip6_nd_address_autoconfig,
525 {'sw_if_index': sw_if_index,
527 'install_default_routes': install_default_routes})
529 def want_interface_events(self, enable_disable=1):
530 return self.api(self.papi.want_interface_events,
531 {'enable_disable': enable_disable,
532 'pid': os.getpid(), })
534 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
535 max_macs_in_event=0, learn_limit=0):
536 return self.api(self.papi.want_l2_macs_events,
537 {'enable_disable': enable_disable,
538 'scan_delay': scan_delay,
539 'max_macs_in_event': max_macs_in_event,
540 'learn_limit': learn_limit,
541 'pid': os.getpid(), })
543 def want_dhcp6_reply_events(self, enable_disable=1):
544 return self.api(self.papi.want_dhcp6_reply_events,
545 {'enable_disable': enable_disable,
548 def want_dhcp6_pd_reply_events(self, enable_disable=1):
549 return self.api(self.papi.want_dhcp6_pd_reply_events,
550 {'enable_disable': enable_disable,
553 def dhcp6_clients_enable_disable(self, enable=1):
554 return self.api(self.papi.dhcp6_clients_enable_disable,
557 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
558 addresses, server_index=0xFFFFFFFF,
559 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
561 return self.api(self.papi.dhcp6_send_client_message,
562 {'sw_if_index': sw_if_index,
563 'server_index': server_index,
569 'msg_type': msg_type,
572 'n_addresses': len(addresses),
573 'addresses': addresses})
575 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
576 prefixes, server_index=0xFFFFFFFF,
577 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
579 return self.api(self.papi.dhcp6_pd_send_client_message,
580 {'sw_if_index': sw_if_index,
581 'server_index': server_index,
587 'msg_type': msg_type,
590 'n_prefixes': len(prefixes),
591 'prefixes': prefixes})
593 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
595 return self.api(self.papi.dhcp6_client_enable_disable,
596 {'sw_if_index': sw_if_index,
599 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
601 return self.api(self.papi.dhcp6_pd_client_enable_disable,
602 {'sw_if_index': sw_if_index,
603 'prefix_group': prefix_group,
606 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
607 prefix_length, prefix_group,
609 return self.api(self.papi.ip6_add_del_address_using_prefix,
610 {'sw_if_index': sw_if_index,
611 'prefix_group': prefix_group,
613 'prefix_length': prefix_length,
616 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
617 filter_mac=0, bvi_mac=0):
618 """Create/delete L2 FIB entry.
620 :param str mac: MAC address to create FIB entry for.
621 :param int bd_id: Bridge domain index.
622 :param int sw_if_index: Software interface index of the interface.
623 :param int is_add: Add or delete flag. (Default value = 1)
624 :param int static_mac: Set to 1 to create static MAC entry.
626 :param int filter_mac: Set to 1 to drop packet that's source or
627 destination MAC address contains defined MAC address.
629 :param int bvi_mac: Set to 1 to create entry that points to BVI
630 interface. (Default value = 0)
632 return self.api(self.papi.l2fib_add_del,
635 'sw_if_index': sw_if_index,
637 'static_mac': static_mac,
638 'filter_mac': filter_mac,
641 def l2fib_flush_int(self, sw_if_index):
642 """Flush L2 FIB entries for sw_if_index.
644 :param int sw_if_index: Software interface index of the interface.
646 return self.api(self.papi.l2fib_flush_int,
647 {'sw_if_index': sw_if_index})
649 def l2fib_flush_bd(self, bd_id):
650 """Flush L2 FIB entries for bd_id.
652 :param int sw_if_index: Bridge Domain id.
654 return self.api(self.papi.l2fib_flush_bd,
657 def l2fib_flush_all(self):
660 return self.api(self.papi.l2fib_flush_all, {})
662 def l2_fib_table_dump(self, bd_id):
663 """ Dump the L2 FIB """
664 return self.api(self.papi.l2_fib_table_dump,
667 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
668 shg=0, port_type=L2_PORT_TYPE.NORMAL,
670 """Add/remove interface to/from bridge domain.
672 :param int sw_if_index: Software interface index of the interface.
673 :param int bd_id: Bridge domain index.
674 :param int shg: Split-horizon group index. (Default value = 0)
675 :param int bvi: Set interface as a bridge group virtual interface.
677 :param int enable: Add or remove interface. (Default value = 1)
679 return self.api(self.papi.sw_interface_set_l2_bridge,
680 {'rx_sw_if_index': sw_if_index,
683 'port_type': port_type,
686 def bridge_flags(self, bd_id, is_set, feature_bitmap):
687 """Enable/disable required feature of the bridge domain with defined
690 :param int bd_id: Bridge domain ID.
691 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
692 :param int flags: Bitmap value of the feature to be set:
696 - uu-flood (1 << 3) or
699 return self.api(self.papi.bridge_flags,
702 'flags': feature_bitmap})
704 def bridge_domain_dump(self, bd_id=0):
707 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
708 existing bridge domains returned)
709 :return: Dictionary of bridge domain(s) data.
711 return self.api(self.papi.bridge_domain_dump,
714 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
716 """Create or delete unidirectional cross-connect from Tx interface to
719 :param int rx_sw_if_index: Software interface index of Rx interface.
720 :param int tx_sw_if_index: Software interface index of Tx interface.
721 :param int enable: Create cross-connect if equal to 1, delete
722 cross-connect if equal to 0.
725 return self.api(self.papi.sw_interface_set_l2_xconnect,
726 {'rx_sw_if_index': rx_sw_if_index,
727 'tx_sw_if_index': tx_sw_if_index,
730 def sw_interface_set_l2_tag_rewrite(
737 """L2 interface vlan tag rewrite configure request
738 :param client_index - opaque cookie to identify the sender
739 :param context - sender context, to match reply w/ request
740 :param sw_if_index - interface the operation is applied to
741 :param vtr_op - Choose from l2_vtr_op_t enum values
742 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
743 :param tag1 - Needed for any push or translate vtr op
744 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
747 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
748 {'sw_if_index': sw_if_index,
754 def sw_interface_set_l2_emulation(
759 :param sw_if_index - interface the operation is applied to
762 return self.api(self.papi.l2_emulation,
763 {'sw_if_index': sw_if_index,
766 def sw_interface_set_ip_directed_broadcast(
770 """IP Directed broadcast
771 :param sw_if_index - interface the operation is applied to
774 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
775 {'sw_if_index': sw_if_index,
778 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
781 :param admin_up_down:
785 return self.api(self.papi.sw_interface_set_flags,
786 {'sw_if_index': sw_if_index,
787 'admin_up_down': admin_up_down})
789 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
795 return self.api(self.papi.sw_interface_set_mtu,
796 {'sw_if_index': sw_if_index,
799 def sw_interface_set_promiscuous(self, sw_if_index, enable):
805 return self.api(self.papi.sw_interface_set_promiscuous,
806 {'sw_if_index': sw_if_index,
809 def sw_interface_set_mac_address(self, sw_if_index, mac):
810 return self.api(self.papi.sw_interface_set_mac_address,
811 {'sw_if_index': sw_if_index,
814 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
815 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
816 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
817 """Create subinterface
818 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
820 :param sub_id: param inner_vlan:
824 :param no_tags: (Default value = 0)
825 :param one_tag: (Default value = 0)
826 :param two_tags: (Default value = 0)
827 :param dot1ad: (Default value = 0)
828 :param exact_match: (Default value = 0)
829 :param default_sub: (Default value = 0)
830 :param outer_vlan_id_any: (Default value = 0)
831 :param inner_vlan_id_any: (Default value = 0)
835 self.papi.create_subif,
836 {'sw_if_index': sw_if_index,
840 'two_tags': two_tags,
842 'exact_match': exact_match,
843 'default_sub': default_sub,
844 'outer_vlan_id_any': outer_vlan_id_any,
845 'inner_vlan_id_any': inner_vlan_id_any,
846 'outer_vlan_id': outer_vlan,
847 'inner_vlan_id': inner_vlan})
849 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
850 """Create p2p ethernet subinterface
852 :param sw_if_index: main (parent) interface
853 :param remote_mac: client (remote) mac address
857 self.papi.p2p_ethernet_add,
858 {'parent_if_index': sw_if_index,
859 'remote_mac': remote_mac,
860 'subif_id': subif_id})
862 def delete_subif(self, sw_if_index):
863 """Delete subinterface
867 return self.api(self.papi.delete_subif,
868 {'sw_if_index': sw_if_index})
870 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
871 """Delete p2p ethernet subinterface
873 :param sw_if_index: main (parent) interface
874 :param remote_mac: client (remote) mac address
878 self.papi.p2p_ethernet_del,
879 {'parent_if_index': sw_if_index,
880 'remote_mac': remote_mac})
882 def create_vlan_subif(self, sw_if_index, vlan):
889 return self.api(self.papi.create_vlan_subif,
890 {'sw_if_index': sw_if_index,
893 def create_loopback(self, mac=''):
896 :param mac: (Optional)
898 return self.api(self.papi.create_loopback,
899 {'mac_address': mac})
901 def delete_loopback(self, sw_if_index):
902 return self.api(self.papi.delete_loopback,
903 {'sw_if_index': sw_if_index, })
905 def ip_table_add_del(self,
912 :param is_add: (Default value = 1)
913 :param is_ipv6: (Default value = 0)
918 self.papi.ip_table_add_del,
919 {'table_id': table_id,
923 def ip_add_del_route(
928 next_hop_sw_if_index=0xFFFFFFFF,
932 next_hop_n_out_labels=0,
933 next_hop_out_label_stack=[],
934 next_hop_via_label=MPLS_LABEL_INVALID,
935 next_hop_id=0xFFFFFFFF,
937 is_resolve_attached=0,
938 classify_table_index=0xFFFFFFFF,
952 :param dst_address_length:
953 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
955 :param next_hop_address:
956 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
957 :param vrf_id: (Default value = 0)
958 :param lookup_in_vrf: (Default value = 0)
959 :param classify_table_index: (Default value = 0xFFFFFFFF)
960 :param is_add: (Default value = 1)
961 :param is_drop: (Default value = 0)
962 :param is_ipv6: (Default value = 0)
963 :param is_local: (Default value = 0)
964 :param is_classify: (Default value = 0)
965 :param is_multipath: (Default value = 0)
966 :param is_resolve_host: (Default value = 0)
967 :param is_resolve_attached: (Default value = 0)
968 :param is_dvr: (Default value = 0)
969 :param is_source_lookup: (Default value = 0)
970 :param next_hop_weight: (Default value = 1)
975 self.papi.ip_add_del_route,
976 {'next_hop_sw_if_index': next_hop_sw_if_index,
977 'table_id': table_id,
978 'classify_table_index': classify_table_index,
979 'next_hop_table_id': next_hop_table_id,
982 'is_unreach': is_unreach,
983 'is_prohibit': is_prohibit,
985 'is_local': is_local,
986 'is_classify': is_classify,
987 'is_multipath': is_multipath,
988 'is_resolve_host': is_resolve_host,
989 'is_resolve_attached': is_resolve_attached,
991 'is_source_lookup': is_source_lookup,
992 'is_udp_encap': is_udp_encap,
993 'next_hop_weight': next_hop_weight,
994 'dst_address_length': dst_address_length,
995 'dst_address': dst_address,
996 'next_hop_id': next_hop_id,
997 'next_hop_address': next_hop_address,
998 'next_hop_n_out_labels': next_hop_n_out_labels,
999 'next_hop_via_label': next_hop_via_label,
1000 'next_hop_out_label_stack': next_hop_out_label_stack})
1002 def ip_fib_dump(self):
1003 return self.api(self.papi.ip_fib_dump, {})
1005 def ip6_fib_dump(self):
1006 return self.api(self.papi.ip6_fib_dump, {})
1008 def ip_neighbor_add_del(self,
1014 """ Add neighbor MAC to IPv4 or IPv6 address.
1019 :param is_add: (Default value = 1)
1020 :param flags: (Default value = 0/NONE)
1023 self.papi.ip_neighbor_add_del,
1027 'sw_if_index': sw_if_index,
1029 'mac_address': mac_address,
1030 'ip_address': ip_address
1035 def ip_neighbor_dump(self,
1038 """ Return IP neighbor dump.
1041 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1045 self.papi.ip_neighbor_dump,
1046 {'is_ipv6': is_ipv6,
1047 'sw_if_index': sw_if_index
1051 def proxy_arp_add_del(self,
1056 """ Config Proxy Arp Range.
1058 :param low_address: Start address in the rnage to Proxy for
1059 :param hi_address: End address in the rnage to Proxy for
1060 :param vrf_id: The VRF/table in which to proxy
1064 self.papi.proxy_arp_add_del,
1067 'table_id': table_id,
1073 def proxy_arp_intfc_enable_disable(self,
1076 """ Enable/Disable an interface for proxy ARP requests
1078 :param sw_if_index: Interface
1079 :param enable_disable: Enable/Disable
1083 self.papi.proxy_arp_intfc_enable_disable,
1084 {'sw_if_index': sw_if_index,
1085 'enable_disable': is_enable
1093 """ Reset VRF (remove all routes etc.) request.
1095 :param int vrf_id: ID of the FIB table / VRF to reset.
1096 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1100 self.papi.reset_vrf,
1110 """ Reset VRF (remove all routes etc.) request.
1112 :param int vrf_id: ID of the FIB table / VRF to reset.
1113 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1117 self.papi.reset_fib,
1128 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1133 {'is_ipv6': is_ipv6,
1137 def sw_interface_span_enable_disable(
1138 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1141 :param sw_if_index_from:
1142 :param sw_if_index_to:
1146 return self.api(self.papi.sw_interface_span_enable_disable,
1147 {'sw_if_index_from': sw_if_index_from,
1148 'sw_if_index_to': sw_if_index_to,
1153 def gre_tunnel_add_del(self,
1158 instance=0xFFFFFFFF,
1162 """ Add a GRE tunnel
1166 :param outer_fib_id: (Default value = 0)
1167 :param tunnel_type: (Default value = 0)
1168 :param instance: (Default value = 0xFFFFFFFF)
1169 :param session_id: (Defalt value = 0)
1170 :param is_add: (Default value = 1)
1171 :param is_ipv6: (Default value = 0)
1175 self.papi.gre_add_del_tunnel,
1178 'tunnel_type': tunnel_type,
1179 'instance': instance,
1180 'src_address': src_address,
1181 'dst_address': dst_address,
1182 'outer_fib_id': outer_fib_id,
1183 'session_id': session_id}
1186 def udp_encap_add(self,
1192 """ Add a GRE tunnel
1197 :param outer_fib_id: (Default value = 0)
1201 self.papi.udp_encap_add,
1206 'src_port': src_port,
1207 'dst_port': dst_port,
1208 'table_id': table_id
1212 def udp_encap_del(self, id):
1213 return self.api(self.papi.udp_encap_del, {'id': id})
1215 def udp_encap_dump(self):
1216 return self.api(self.papi.udp_encap_dump, {})
1218 def want_udp_encap_stats(self, enable=1):
1219 return self.api(self.papi.want_udp_encap_stats,
1221 'pid': os.getpid()})
1223 def mpls_fib_dump(self):
1224 return self.api(self.papi.mpls_fib_dump, {})
1226 def mpls_table_add_del(
1233 :param is_add: (Default value = 1)
1238 self.papi.mpls_table_add_del,
1239 {'mt_table_id': table_id,
1240 'mt_is_add': is_add})
1242 def mpls_route_add_del(
1248 next_hop_sw_if_index=0xFFFFFFFF,
1250 next_hop_table_id=0,
1252 next_hop_n_out_labels=0,
1253 next_hop_out_label_stack=[],
1254 next_hop_via_label=MPLS_LABEL_INVALID,
1256 is_resolve_attached=0,
1263 classify_table_index=0xFFFFFFFF,
1267 :param dst_address_length:
1268 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1270 :param next_hop_address:
1271 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1272 :param vrf_id: (Default value = 0)
1273 :param lookup_in_vrf: (Default value = 0)
1274 :param classify_table_index: (Default value = 0xFFFFFFFF)
1275 :param is_add: (Default value = 1)
1276 :param is_drop: (Default value = 0)
1277 :param is_ipv6: (Default value = 0)
1278 :param is_local: (Default value = 0)
1279 :param is_classify: (Default value = 0)
1280 :param is_multipath: (Default value = 0)
1281 :param is_multicast: (Default value = 0)
1282 :param is_resolve_host: (Default value = 0)
1283 :param is_resolve_attached: (Default value = 0)
1284 :param next_hop_weight: (Default value = 1)
1288 self.papi.mpls_route_add_del,
1291 'mr_table_id': table_id,
1292 'mr_classify_table_index': classify_table_index,
1293 'mr_is_add': is_add,
1294 'mr_is_classify': is_classify,
1295 'mr_is_multipath': is_multipath,
1296 'mr_is_multicast': is_multicast,
1297 'mr_is_resolve_host': is_resolve_host,
1298 'mr_is_resolve_attached': is_resolve_attached,
1299 'mr_is_interface_rx': is_interface_rx,
1300 'mr_is_rpf_id': is_rpf_id,
1301 'mr_next_hop_proto': next_hop_proto,
1302 'mr_next_hop_weight': next_hop_weight,
1303 'mr_next_hop': next_hop_address,
1304 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1305 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1306 'mr_next_hop_table_id': next_hop_table_id,
1307 'mr_next_hop_via_label': next_hop_via_label,
1308 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1310 def mpls_ip_bind_unbind(
1322 self.papi.mpls_ip_bind_unbind,
1323 {'mb_mpls_table_id': table_id,
1325 'mb_ip_table_id': ip_table_id,
1326 'mb_is_bind': is_bind,
1327 'mb_is_ip4': is_ip4,
1328 'mb_address_length': dst_address_length,
1329 'mb_address': dst_address})
1331 def mpls_tunnel_add_del(
1334 next_hop_proto_is_ip4,
1336 next_hop_sw_if_index=0xFFFFFFFF,
1337 next_hop_table_id=0,
1339 next_hop_n_out_labels=0,
1340 next_hop_out_label_stack=[],
1341 next_hop_via_label=MPLS_LABEL_INVALID,
1347 :param dst_address_length:
1348 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1350 :param next_hop_address:
1351 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1352 :param vrf_id: (Default value = 0)
1353 :param lookup_in_vrf: (Default value = 0)
1354 :param classify_table_index: (Default value = 0xFFFFFFFF)
1355 :param is_add: (Default value = 1)
1356 :param is_drop: (Default value = 0)
1357 :param is_ipv6: (Default value = 0)
1358 :param is_local: (Default value = 0)
1359 :param is_classify: (Default value = 0)
1360 :param is_multipath: (Default value = 0)
1361 :param is_resolve_host: (Default value = 0)
1362 :param is_resolve_attached: (Default value = 0)
1363 :param next_hop_weight: (Default value = 1)
1364 :param is_multicast: (Default value = 0)
1368 self.papi.mpls_tunnel_add_del,
1369 {'mt_sw_if_index': tun_sw_if_index,
1370 'mt_is_add': is_add,
1371 'mt_l2_only': l2_only,
1372 'mt_is_multicast': is_multicast,
1373 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1374 'mt_next_hop_weight': next_hop_weight,
1375 'mt_next_hop': next_hop_address,
1376 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1377 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1378 'mt_next_hop_table_id': next_hop_table_id,
1379 'mt_next_hop_via_label': next_hop_via_label,
1380 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1382 def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
1383 return self.api(self.papi.mpls_tunnel_dump,
1384 {'sw_if_index': sw_if_index})
1386 def nat44_interface_add_del_feature(
1391 """Enable/disable NAT44 feature on the interface
1393 :param sw_if_index: Software index of the interface
1394 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1395 :param is_add: 1 if add, 0 if delete (Default value = 1)
1398 self.papi.nat44_interface_add_del_feature,
1400 'is_inside': is_inside,
1401 'sw_if_index': sw_if_index})
1403 def nat44_interface_add_del_output_feature(
1408 """Enable/disable NAT44 output feature on the interface
1410 :param sw_if_index: Software index of the interface
1411 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1412 :param is_add: 1 if add, 0 if delete (Default value = 1)
1415 self.papi.nat44_interface_add_del_output_feature,
1417 'is_inside': is_inside,
1418 'sw_if_index': sw_if_index})
1420 def nat44_add_del_static_mapping(
1424 external_sw_if_index=0xFFFFFFFF,
1435 """Add/delete NAT44 static mapping
1437 :param local_ip: Local IP address
1438 :param external_ip: External IP address
1439 :param external_sw_if_index: External interface instead of IP address
1440 :param local_port: Local port number (Default value = 0)
1441 :param external_port: External port number (Default value = 0)
1442 :param addr_only: 1 if address only mapping, 0 if address and port
1443 :param vrf_id: VRF ID
1444 :param protocol: IP protocol (Default value = 0)
1445 :param twice_nat: 1 if translate external host address and port
1446 :param self_twice_nat: 1 if translate external host address and port
1447 whenever external host address equals
1448 local address of internal host
1449 :param out2in_only: if 1 rule is matching only out2in direction
1450 :param tag: Opaque string tag
1451 :param is_add: 1 if add, 0 if delete (Default value = 1)
1454 self.papi.nat44_add_del_static_mapping,
1456 'addr_only': addr_only,
1457 'local_ip_address': local_ip,
1458 'external_ip_address': external_ip,
1459 'local_port': local_port,
1460 'external_port': external_port,
1461 'external_sw_if_index': external_sw_if_index,
1463 'protocol': protocol,
1464 'twice_nat': twice_nat,
1465 'self_twice_nat': self_twice_nat,
1466 'out2in_only': out2in_only,
1469 def nat44_add_del_identity_mapping(
1472 sw_if_index=0xFFFFFFFF,
1479 """Add/delete NAT44 identity mapping
1481 :param ip: IP address (Default value = 0)
1482 :param sw_if_index: Interface instead of IP address
1483 :param port: Port number (Default value = 0)
1484 :param addr_only: 1 if address only mapping, 0 if address and port
1485 :param vrf_id: VRF ID
1486 :param protocol: IP protocol (Default value = 0)
1487 :param tag: Opaque string tag
1488 :param is_add: 1 if add, 0 if delete (Default value = 1)
1491 self.papi.nat44_add_del_identity_mapping,
1493 'addr_only': addr_only,
1496 'sw_if_index': sw_if_index,
1499 'protocol': protocol})
1501 def nat44_add_del_address_range(
1508 """Add/del NAT44 address range
1510 :param first_ip_address: First IP address
1511 :param last_ip_address: Last IP address
1512 :param vrf_id: VRF id for the address range
1513 :param twice_nat: twice NAT address for extenal hosts
1514 :param is_add: 1 if add, 0 if delete (Default value = 1)
1517 self.papi.nat44_add_del_address_range,
1518 {'first_ip_address': first_ip_address,
1519 'last_ip_address': last_ip_address,
1521 'twice_nat': twice_nat,
1524 def nat44_address_dump(self):
1525 """Dump NAT44 addresses
1526 :return: Dictionary of NAT44 addresses
1528 return self.api(self.papi.nat44_address_dump, {})
1530 def nat44_interface_dump(self):
1531 """Dump interfaces with NAT44 feature
1532 :return: Dictionary of interfaces with NAT44 feature
1534 return self.api(self.papi.nat44_interface_dump, {})
1536 def nat44_interface_output_feature_dump(self):
1537 """Dump interfaces with NAT44 output feature
1538 :return: Dictionary of interfaces with NAT44 output feature
1540 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1542 def nat44_static_mapping_dump(self):
1543 """Dump NAT44 static mappings
1544 :return: Dictionary of NAT44 static mappings
1546 return self.api(self.papi.nat44_static_mapping_dump, {})
1548 def nat44_identity_mapping_dump(self):
1549 """Dump NAT44 identity mappings
1550 :return: Dictionary of NAT44 identity mappings
1552 return self.api(self.papi.nat44_identity_mapping_dump, {})
1554 def nat_show_config(self):
1555 """Show NAT plugin config
1556 :return: NAT plugin config parameters
1558 return self.api(self.papi.nat_show_config, {})
1560 def nat44_add_interface_addr(
1565 """Add/del NAT44 address from interface
1567 :param sw_if_index: Software index of the interface
1568 :param twice_nat: twice NAT address for extenal hosts
1569 :param is_add: 1 if add, 0 if delete (Default value = 1)
1572 self.papi.nat44_add_del_interface_addr,
1574 'sw_if_index': sw_if_index,
1575 'twice_nat': twice_nat})
1577 def nat44_interface_addr_dump(self):
1578 """Dump NAT44 addresses interfaces
1579 :return: Dictionary of NAT44 addresses interfaces
1581 return self.api(self.papi.nat44_interface_addr_dump, {})
1588 """Enable/disable NAT IPFIX logging
1590 :param domain_id: Observation domain ID (Default value = 1)
1591 :param src_port: Source port number (Default value = 4739)
1592 :param enable: 1 if enable, 0 if disable (Default value = 1)
1595 self.papi.nat_ipfix_enable_disable,
1596 {'domain_id': domain_id,
1597 'src_port': src_port,
1600 def nat44_user_session_dump(
1604 """Dump NAT44 user's sessions
1606 :param ip_address: ip adress of the user to be dumped
1607 :param cpu_index: cpu_index on which the user is
1608 :param vrf_id: VRF ID
1609 :return: Dictionary of S-NAT sessions
1612 self.papi.nat44_user_session_dump,
1613 {'ip_address': ip_address,
1616 def nat44_user_dump(self):
1619 :return: Dictionary of NAT44 users
1621 return self.api(self.papi.nat44_user_dump, {})
1623 def nat44_add_del_lb_static_mapping(
1636 """Add/delete NAT44 load balancing static mapping
1638 :param twice_nat: 1 if translate external host address and port
1639 :param tag: Opaque string tag
1640 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1641 :param is_add - 1 if add, 0 if delete
1644 self.papi.nat44_add_del_lb_static_mapping,
1646 'external_addr': external_addr,
1647 'external_port': external_port,
1648 'protocol': protocol,
1649 'twice_nat': twice_nat,
1650 'self_twice_nat': self_twice_nat,
1651 'out2in_only': out2in_only,
1653 'affinity': affinity,
1654 'local_num': local_num,
1657 def nat44_lb_static_mapping_add_del_local(
1667 """Add/delete NAT44 load-balancing static mapping rule backend
1669 :param external_addr: external IPv4 address of the servic
1670 :param external_port: external L4 port number of the service
1671 :param local_addr: IPv4 address of the internal node
1672 :param local_port: L4 port number of the internal node
1673 :param protocol: IP protocol number
1674 :param probability: probability of the internal node
1675 :param vrf_id: VRF id of the internal node
1676 :param is_add: 1 if add, 0 if delete
1679 self.papi.nat44_lb_static_mapping_add_del_local,
1681 'external_addr': external_addr,
1682 'external_port': external_port,
1686 'probability': probability,
1688 'protocol': protocol})
1690 def nat44_lb_static_mapping_dump(self):
1691 """Dump NAT44 load balancing static mappings
1693 :return: Dictionary of NAT44 load balancing static mapping
1695 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1697 def nat44_del_session(
1704 ext_host_address=None,
1706 """Delete NAT44 session
1708 :param addr: IPv4 address
1709 :param por: port number
1710 :param protocol: IP protocol number
1711 :param vrf_id: VRF ID
1712 :param is_in: 1 if inside network addres and port pari, 0 if outside
1713 :param ext_host_address: external host IPv4 address
1714 :param ext_host_port: external host port
1716 if ext_host_address is None:
1718 self.papi.nat44_del_session,
1721 'protocol': protocol,
1726 self.papi.nat44_del_session,
1729 'protocol': protocol,
1732 'ext_host_valid': 1,
1733 'ext_host_address': ext_host_address,
1734 'ext_host_port': ext_host_port})
1736 def nat44_forwarding_enable_disable(
1739 """Enable/disable forwarding for NAT44
1741 :param enable: 1 for enable, 0 for disable
1744 self.papi.nat44_forwarding_enable_disable,
1754 """Set NAT virtual fragmentation reassembly
1756 :param timeout: reassembly timeout (Default 2sec)
1757 :param max_reass: maximum concurrent reassemblies (Default 1024)
1758 :param max_frag: maximum fragmets per reassembly (Default 5)
1759 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1760 :param is_ip6: 1 if IPv6, 0 if IPv4
1763 self.papi.nat_set_reass,
1764 {'timeout': timeout,
1765 'max_reass': max_reass,
1766 'max_frag': max_frag,
1767 'drop_frag': drop_frag,
1770 def nat_get_reass(self):
1771 """Get NAT virtual fragmentation reassembly configuration
1773 :return: NAT virtual fragmentation reassembly configuration
1775 return self.api(self.papi.nat_get_reass, {})
1777 def nat_reass_dump(self):
1778 """Dump NAT virtual fragmentation reassemblies
1780 :return: Dictionary of NAT virtual fragmentation reassemblies
1782 return self.api(self.papi.nat_reass_dump, {})
1784 def nat_det_add_del_map(
1791 """Add/delete deterministic NAT mapping
1793 :param is_add - 1 if add, 0 if delete
1794 :param in_addr - inside IP address
1795 :param in_plen - inside IP address prefix length
1796 :param out_addr - outside IP address
1797 :param out_plen - outside IP address prefix length
1800 self.papi.nat_det_add_del_map,
1805 'out_addr': out_addr,
1806 'out_plen': out_plen})
1808 def nat_det_forward(
1811 """Get outside address and port range from inside address
1813 :param in_addr - inside IP address
1816 self.papi.nat_det_forward,
1817 {'in_addr': in_addr,
1820 def nat_det_reverse(
1824 """Get inside address from outside address and port
1826 :param out_addr - outside IP address
1827 :param out_port - outside port
1830 self.papi.nat_det_reverse,
1831 {'out_addr': out_addr,
1832 'out_port': out_port})
1834 def nat_det_map_dump(self):
1835 """Dump deterministic NAT mappings
1837 :return: Dictionary of deterministic NAT mappings
1839 return self.api(self.papi.nat_det_map_dump, {})
1841 def nat_set_timeouts(
1844 tcp_established=7440,
1847 """Set values of timeouts for NAT sessions (in seconds)
1849 :param udp - UDP timeout (Default value = 300)
1850 :param tcp_established - TCP established timeout (Default value = 7440)
1851 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1852 :param icmp - ICMP timeout (Default value = 60)
1855 self.papi.nat_set_timeouts,
1857 'tcp_established': tcp_established,
1858 'tcp_transitory': tcp_transitory,
1861 def nat_get_timeouts(self):
1862 """Get values of timeouts for NAT sessions
1864 :return: Timeouts for NAT sessions (in seconds)
1866 return self.api(self.papi.nat_get_timeouts, {})
1868 def nat_set_addr_and_port_alloc_alg(
1876 """Set address and port assignment algorithm
1878 :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1879 :param psid_offset: number of offset bits (valid only for MAP-E alg)
1880 :param psid_length: length of PSID (valid only for MAP-E alg)
1881 :param psid: Port Set Identifier value (valid only for MAP-E alg)
1882 :param start_port: beginning of the port range
1883 :param end_port: end of the port range
1886 self.papi.nat_set_addr_and_port_alloc_alg,
1888 'psid_offset': psid_offset,
1889 'psid_length': psid_length,
1891 'start_port': start_port,
1892 'end_port': end_port})
1894 def nat_get_addr_and_port_alloc_alg(self):
1895 """Get address and port assignment algorithm"""
1896 return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1898 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1899 """Set TCP MSS rewriting configuration
1901 :param enable: disable(0)/enable(1) MSS rewriting feature
1902 :param mss_value: MSS value to be used for MSS rewriting
1905 self.papi.nat_set_mss_clamping,
1906 {'enable': enable, 'mss_value': mss_value})
1908 def nat_get_mss_clamping(self):
1909 """Get TCP MSS rewriting configuration"""
1910 return self.api(self.papi.nat_get_mss_clamping, {})
1912 def nat_det_close_session_out(
1918 """Close deterministic NAT session using outside address and port
1920 :param out_addr - outside IP address
1921 :param out_port - outside port
1922 :param ext_addr - external host IP address
1923 :param ext_port - external host port
1926 self.papi.nat_det_close_session_out,
1927 {'out_addr': out_addr,
1928 'out_port': out_port,
1929 'ext_addr': ext_addr,
1930 'ext_port': ext_port})
1932 def nat_det_close_session_in(
1938 """Close deterministic NAT session using inside address and port
1940 :param in_addr - inside IP address
1941 :param in_port - inside port
1942 :param ext_addr - external host IP address
1943 :param ext_port - external host port
1946 self.papi.nat_det_close_session_in,
1947 {'in_addr': in_addr,
1949 'ext_addr': ext_addr,
1950 'ext_port': ext_port,
1953 def nat_det_session_dump(
1956 """Dump deterministic NAT sessions belonging to a user
1958 :param user_addr - inside IP address of the user
1959 :return: Dictionary of deterministic NAT sessions
1962 self.papi.nat_det_session_dump,
1964 'user_addr': user_addr})
1966 def nat64_add_del_pool_addr_range(
1972 """Add/del address range to NAT64 pool
1974 :param start_addr: First IP address
1975 :param end_addr: Last IP address
1976 :param vrf_id: VRF id for the address range
1977 :param is_add: 1 if add, 0 if delete (Default value = 1)
1980 self.papi.nat64_add_del_pool_addr_range,
1981 {'start_addr': start_addr,
1982 'end_addr': end_addr,
1986 def nat64_pool_addr_dump(self):
1987 """Dump NAT64 pool addresses
1988 :return: Dictionary of NAT64 pool addresses
1990 return self.api(self.papi.nat64_pool_addr_dump, {})
1992 def nat64_add_del_interface(
1997 """Enable/disable NAT64 feature on the interface
1998 :param sw_if_index: Index of the interface
1999 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2000 :param is_add: 1 if add, 0 if delete (Default value = 1)
2003 self.papi.nat64_add_del_interface,
2004 {'sw_if_index': sw_if_index,
2005 'is_inside': is_inside,
2008 def nat64_interface_dump(self):
2009 """Dump interfaces with NAT64 feature
2010 :return: Dictionary of interfaces with NAT64 feature
2012 return self.api(self.papi.nat64_interface_dump, {})
2014 def nat64_add_del_static_bib(
2023 """Add/delete S-NAT static BIB entry
2025 :param in_ip: Inside IPv6 address
2026 :param out_ip: Outside IPv4 address
2027 :param in_port: Inside port number
2028 :param out_port: Outside port number
2029 :param protocol: IP protocol
2030 :param vrf_id: VRF ID (Default value = 0)
2031 :param is_add: 1 if add, 0 if delete (Default value = 1)
2034 self.papi.nat64_add_del_static_bib,
2043 def nat64_bib_dump(self, protocol=255):
2046 :param protocol: IP protocol (Default value = 255, all BIBs)
2047 :returns: Dictionary of NAT64 BIB entries
2049 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
2051 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
2052 tcp_incoming_syn=6):
2053 """Set values of timeouts for NAT64 (in seconds)
2055 :param udpi: UDP timeout (Default value = 300)
2056 :param icmp: ICMP timeout (Default value = 60)
2057 :param tcp_trans: TCP transitory timeout (Default value = 240)
2058 :param tcp_est: TCP established timeout (Default value = 7440)
2059 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
2062 self.papi.nat64_set_timeouts,
2065 'tcp_trans': tcp_trans,
2067 'tcp_incoming_syn': tcp_incoming_syn})
2069 def nat64_get_timeouts(self):
2070 """Get values of timeouts for NAT64
2072 :return: Timeouts for NAT64 (in seconds)
2074 return self.api(self.papi.nat64_get_timeouts, {})
2076 def nat64_st_dump(self, protocol=255):
2077 """Dump NAT64 session table
2079 :param protocol: IP protocol (Default value = 255, all STs)
2080 :returns: Dictionary of NAT64 sesstion table entries
2082 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2084 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2085 """Add/del NAT64 prefix
2087 :param prefix: NAT64 prefix
2088 :param plen: NAT64 prefix length
2089 :param vrf_id: VRF id of tenant (Default 0)
2090 :param is_add: 1 if add, 0 if delete (Default value = 1)
2093 self.papi.nat64_add_del_prefix,
2099 def nat64_prefix_dump(self):
2100 """Dump NAT64 prefix
2102 :returns: Dictionary of NAT64 prefixes
2104 return self.api(self.papi.nat64_prefix_dump, {})
2106 def nat64_add_interface_addr(
2110 """Add/del NAT64 address from interface
2112 :param sw_if_index: Software index of the interface
2113 :param is_add: 1 if add, 0 if delete (Default value = 1)
2115 return self.api(self.papi.nat64_add_del_interface_addr,
2116 {'is_add': is_add, 'sw_if_index': sw_if_index})
2118 def dslite_set_aftr_addr(self, ip6, ip4):
2119 """Set DS-Lite AFTR addresses
2121 :param ip4: IPv4 address
2122 :param ip6: IPv6 address
2125 self.papi.dslite_set_aftr_addr,
2129 def dslite_set_b4_addr(self, ip6, ip4):
2130 """Set DS-Lite B4 IPv6 address
2132 :param ip4: IPv4 address
2133 :param ip6: IPv6 address
2136 self.papi.dslite_set_b4_addr,
2140 def dslite_add_del_pool_addr_range(
2145 """Add/del address range to DS-Lite pool
2147 :param start_addr: First IP address
2148 :param end_addr: Last IP address
2149 :param is_add: 1 if add, 0 if delete (Default value = 1)
2152 self.papi.dslite_add_del_pool_addr_range,
2153 {'start_addr': start_addr,
2154 'end_addr': end_addr,
2157 def nat66_add_del_interface(
2162 """Enable/disable NAT66 feature on the interface
2163 :param sw_if_index: Index of the interface
2164 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2165 :param is_add: 1 if add, 0 if delete (Default value = 1)
2168 self.papi.nat66_add_del_interface,
2169 {'sw_if_index': sw_if_index,
2170 'is_inside': is_inside,
2173 def nat66_add_del_static_mapping(
2179 """Add/delete NAT66 static mapping
2181 :param in_ip: Inside IPv6 address
2182 :param out_ip: Outside IPv6 address
2183 :param vrf_id: VRF ID (Default value = 0)
2184 :param is_add: 1 if add, 0 if delete (Default value = 1)
2187 self.papi.nat66_add_del_static_mapping,
2188 {'local_ip_address': in_ip,
2189 'external_ip_address': out_ip,
2193 def nat66_interface_dump(self):
2194 """Dump interfaces with NAT66 feature
2195 :return: Dictionary of interfaces with NAT66 feature
2197 return self.api(self.papi.nat66_interface_dump, {})
2199 def nat66_static_mapping_dump(self):
2200 """Dump NAT66 static mappings
2201 :return: Dictionary of NAT66 static mappings
2203 return self.api(self.papi.nat66_static_mapping_dump, {})
2205 def control_ping(self):
2206 self.api(self.papi.control_ping)
2208 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2209 detect_mult, local_addr, peer_addr, is_ipv6=0,
2210 bfd_key_id=None, conf_key_id=None):
2211 if bfd_key_id is None:
2212 return self.api(self.papi.bfd_udp_add,
2214 'sw_if_index': sw_if_index,
2215 'desired_min_tx': desired_min_tx,
2216 'required_min_rx': required_min_rx,
2217 'local_addr': local_addr,
2218 'peer_addr': peer_addr,
2220 'detect_mult': detect_mult,
2223 return self.api(self.papi.bfd_udp_add,
2225 'sw_if_index': sw_if_index,
2226 'desired_min_tx': desired_min_tx,
2227 'required_min_rx': required_min_rx,
2228 'local_addr': local_addr,
2229 'peer_addr': peer_addr,
2231 'detect_mult': detect_mult,
2232 'is_authenticated': 1,
2233 'bfd_key_id': bfd_key_id,
2234 'conf_key_id': conf_key_id,
2237 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2238 detect_mult, local_addr, peer_addr, is_ipv6=0):
2239 return self.api(self.papi.bfd_udp_mod,
2241 'sw_if_index': sw_if_index,
2242 'desired_min_tx': desired_min_tx,
2243 'required_min_rx': required_min_rx,
2244 'local_addr': local_addr,
2245 'peer_addr': peer_addr,
2247 'detect_mult': detect_mult,
2250 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2251 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2253 return self.api(self.papi.bfd_udp_auth_activate,
2255 'sw_if_index': sw_if_index,
2256 'local_addr': local_addr,
2257 'peer_addr': peer_addr,
2259 'is_delayed': 1 if is_delayed else 0,
2260 'bfd_key_id': bfd_key_id,
2261 'conf_key_id': conf_key_id,
2264 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2265 is_ipv6=0, is_delayed=False):
2266 return self.api(self.papi.bfd_udp_auth_deactivate,
2268 'sw_if_index': sw_if_index,
2269 'local_addr': local_addr,
2270 'peer_addr': peer_addr,
2272 'is_delayed': 1 if is_delayed else 0,
2275 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2276 return self.api(self.papi.bfd_udp_del,
2278 'sw_if_index': sw_if_index,
2279 'local_addr': local_addr,
2280 'peer_addr': peer_addr,
2284 def bfd_udp_session_dump(self):
2285 return self.api(self.papi.bfd_udp_session_dump, {})
2287 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2288 peer_addr, is_ipv6=0):
2289 return self.api(self.papi.bfd_udp_session_set_flags, {
2290 'admin_up_down': admin_up_down,
2291 'sw_if_index': sw_if_index,
2292 'local_addr': local_addr,
2293 'peer_addr': peer_addr,
2297 def want_bfd_events(self, enable_disable=1):
2298 return self.api(self.papi.want_bfd_events, {
2299 'enable_disable': enable_disable,
2303 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2304 return self.api(self.papi.bfd_auth_set_key, {
2305 'conf_key_id': conf_key_id,
2306 'auth_type': auth_type,
2308 'key_len': len(key),
2311 def bfd_auth_del_key(self, conf_key_id):
2312 return self.api(self.papi.bfd_auth_del_key, {
2313 'conf_key_id': conf_key_id,
2316 def bfd_auth_keys_dump(self):
2317 return self.api(self.papi.bfd_auth_keys_dump, {})
2319 def bfd_udp_set_echo_source(self, sw_if_index):
2320 return self.api(self.papi.bfd_udp_set_echo_source,
2321 {'sw_if_index': sw_if_index})
2323 def bfd_udp_del_echo_source(self):
2324 return self.api(self.papi.bfd_udp_del_echo_source, {})
2326 def bfd_udp_get_echo_source(self):
2327 return self.api(self.papi.bfd_udp_get_echo_source, {})
2329 def classify_add_del_table(
2334 table_index=0xFFFFFFFF,
2336 memory_size=2097152,
2338 next_table_index=0xFFFFFFFF,
2339 miss_next_index=0xFFFFFFFF,
2340 current_data_flag=0,
2341 current_data_offset=0):
2345 :param match_n_vectors: (Default value = 1)
2346 :param table_index: (Default value = 0xFFFFFFFF)
2347 :param nbuckets: (Default value = 2)
2348 :param memory_size: (Default value = 2097152)
2349 :param skip_n_vectors: (Default value = 0)
2350 :param next_table_index: (Default value = 0xFFFFFFFF)
2351 :param miss_next_index: (Default value = 0xFFFFFFFF)
2352 :param current_data_flag: (Default value = 0)
2353 :param current_data_offset: (Default value = 0)
2356 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2357 mask = mask + '\0' * (mask_len - len(mask))
2359 self.papi.classify_add_del_table,
2361 'table_index': table_index,
2362 'nbuckets': nbuckets,
2363 'memory_size': memory_size,
2364 'skip_n_vectors': skip_n_vectors,
2365 'match_n_vectors': match_n_vectors,
2366 'next_table_index': next_table_index,
2367 'miss_next_index': miss_next_index,
2368 'current_data_flag': current_data_flag,
2369 'current_data_offset': current_data_offset,
2370 'mask_len': mask_len,
2373 def classify_add_del_session(
2378 opaque_index=0xFFFFFFFF,
2379 hit_next_index=0xFFFFFFFF,
2387 :param opaque_index: (Default value = 0xFFFFFFFF)
2388 :param hit_next_index: (Default value = 0xFFFFFFFF)
2389 :param advance: (Default value = 0)
2390 :param action: (Default value = 0)
2391 :param metadata: (Default value = 0)
2394 match_len = ((len(match) - 1) / 16 + 1) * 16
2395 match = match + '\0' * (match_len - len(match))
2397 self.papi.classify_add_del_session,
2399 'table_index': table_index,
2400 'hit_next_index': hit_next_index,
2401 'opaque_index': opaque_index,
2404 'metadata': metadata,
2405 'match_len': match_len,
2408 def input_acl_set_interface(
2412 ip4_table_index=0xFFFFFFFF,
2413 ip6_table_index=0xFFFFFFFF,
2414 l2_table_index=0xFFFFFFFF):
2418 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2419 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2420 :param l2_table_index: (Default value = 0xFFFFFFFF)
2424 self.papi.input_acl_set_interface,
2425 {'sw_if_index': sw_if_index,
2426 'ip4_table_index': ip4_table_index,
2427 'ip6_table_index': ip6_table_index,
2428 'l2_table_index': l2_table_index,
2431 def output_acl_set_interface(
2435 ip4_table_index=0xFFFFFFFF,
2436 ip6_table_index=0xFFFFFFFF,
2437 l2_table_index=0xFFFFFFFF):
2441 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2442 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2443 :param l2_table_index: (Default value = 0xFFFFFFFF)
2447 self.papi.output_acl_set_interface,
2448 {'sw_if_index': sw_if_index,
2449 'ip4_table_index': ip4_table_index,
2450 'ip6_table_index': ip6_table_index,
2451 'l2_table_index': l2_table_index,
2454 def set_ipfix_exporter(
2461 collector_port=4739,
2464 self.papi.set_ipfix_exporter,
2466 'collector_address': collector_address,
2467 'collector_port': collector_port,
2468 'src_address': src_address,
2470 'path_mtu': path_mtu,
2471 'template_interval': template_interval,
2472 'udp_checksum': udp_checksum,
2475 def dhcp_proxy_config(self,
2483 self.papi.dhcp_proxy_config,
2485 'rx_vrf_id': rx_table_id,
2486 'server_vrf_id': server_table_id,
2489 'dhcp_server': dhcp_server,
2490 'dhcp_src_address': dhcp_src_address,
2493 def dhcp_proxy_set_vss(self,
2502 self.papi.dhcp_proxy_set_vss,
2505 'vss_type': vss_type,
2506 'vpn_ascii_id': vpn_ascii_id,
2508 'vpn_index': vpn_index,
2513 def dhcp_client_dump(self):
2514 return self.api(self.papi.dhcp_client_dump, {})
2516 def dhcp_client(self,
2521 set_broadcast_flag=1,
2522 want_dhcp_events=0):
2524 self.papi.dhcp_client_config,
2528 'sw_if_index': sw_if_index,
2529 'hostname': hostname,
2531 'want_dhcp_event': want_dhcp_events,
2532 'set_broadcast_flag': set_broadcast_flag,
2536 def ip_mroute_add_del(self,
2542 next_hop_sw_if_index,
2552 IP Multicast Route add/del
2555 self.papi.ip_mroute_add_del,
2556 {'next_hop_sw_if_index': next_hop_sw_if_index,
2557 'entry_flags': e_flags,
2558 'itf_flags': i_flags,
2559 'table_id': table_id,
2563 'is_local': is_local,
2564 'bier_imp': bier_imp,
2565 'next_hop_afi': next_hop_afi,
2566 'grp_address_length': grp_address_length,
2567 'grp_address': grp_address,
2568 'src_address': src_address,
2569 'nh_address': next_hop_address})
2571 def mfib_signal_dump(self):
2572 return self.api(self.papi.mfib_signal_dump, {})
2574 def ip_mfib_dump(self):
2575 return self.api(self.papi.ip_mfib_dump, {})
2577 def ip6_mfib_dump(self):
2578 return self.api(self.papi.ip6_mfib_dump, {})
2580 def lisp_enable_disable(self, is_enabled):
2582 self.papi.lisp_enable_disable,
2584 'is_en': is_enabled,
2587 def lisp_locator_set(self,
2591 self.papi.lisp_add_del_locator_set,
2594 'locator_set_name': ls_name
2597 def lisp_locator_set_dump(self):
2598 return self.api(self.papi.lisp_locator_set_dump, {})
2600 def lisp_locator(self,
2607 self.papi.lisp_add_del_locator,
2610 'locator_set_name': ls_name,
2611 'sw_if_index': sw_if_index,
2612 'priority': priority,
2616 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2618 self.papi.lisp_locator_dump,
2620 'is_index_set': is_index_set,
2622 'ls_index': ls_index,
2625 def lisp_local_mapping(self,
2635 self.papi.lisp_add_del_local_eid,
2637 'locator_set_name': ls_name,
2639 'eid_type': eid_type,
2641 'prefix_len': prefix_len,
2647 def lisp_eid_table_dump(self,
2655 self.papi.lisp_eid_table_dump,
2658 'prefix_length': prefix_length,
2660 'eid_type': eid_type,
2662 'filter': filter_opt,
2665 def lisp_remote_mapping(self,
2675 self.papi.lisp_add_del_remote_mapping,
2678 'eid_type': eid_type,
2680 'eid_len': eid_prefix_len,
2681 'rloc_num': rlocs_num,
2684 'is_src_dst': is_src_dst,
2687 def lisp_adjacency(self,
2696 self.papi.lisp_add_del_adjacency,
2700 'eid_type': eid_type,
2703 'leid_len': leid_len,
2704 'reid_len': reid_len,
2707 def lisp_adjacencies_get(self, vni=0):
2709 self.papi.lisp_adjacencies_get,
2714 def map_add_domain(self,
2724 self.papi.map_add_domain,
2726 'ip6_prefix': ip6_prefix,
2727 'ip4_prefix': ip4_prefix,
2729 'ea_bits_len': ea_bits_len,
2730 'psid_offset': psid_offset,
2731 'psid_length': psid_length,
2735 def map_if_enable_disable(self, is_enable, sw_if_index, is_translation):
2737 self.papi.map_if_enable_disable,
2739 'is_enable': is_enable,
2740 'sw_if_index': sw_if_index,
2741 'is_translation': is_translation,
2744 def map_param_set_tcp(self, tcp_mss):
2746 self.papi.map_param_set_tcp,
2751 def gtpu_add_del_tunnel(
2757 mcast_sw_if_index=0xFFFFFFFF,
2759 decap_next_index=0xFFFFFFFF,
2763 :param is_add: (Default value = 1)
2764 :param is_ipv6: (Default value = 0)
2767 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2768 :param encap_vrf_id: (Default value = 0)
2769 :param decap_next_index: (Default value = 0xFFFFFFFF)
2770 :param teid: (Default value = 0)
2773 return self.api(self.papi.gtpu_add_del_tunnel,
2776 'src_address': src_addr,
2777 'dst_address': dst_addr,
2778 'mcast_sw_if_index': mcast_sw_if_index,
2779 'encap_vrf_id': encap_vrf_id,
2780 'decap_next_index': decap_next_index,
2783 def vxlan_gpe_add_del_tunnel(
2787 mcast_sw_if_index=0xFFFFFFFF,
2798 :param is_add: (Default value = 1)
2799 :param is_ipv6: (Default value = 0)
2800 :param encap_vrf_id: (Default value = 0)
2801 :param decap_vrf_id: (Default value = 0)
2802 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2803 :param protocol: (Default value = 3)
2804 :param vni: (Default value = 0)
2807 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2812 'mcast_sw_if_index': mcast_sw_if_index,
2813 'encap_vrf_id': encap_vrf_id,
2814 'decap_vrf_id': decap_vrf_id,
2815 'protocol': protocol,
2818 def vxlan_gbp_tunnel_add_del(
2822 mcast_sw_if_index=0xFFFFFFFF,
2827 instance=0xFFFFFFFF):
2832 :param is_add: (Default value = 1)
2833 :param is_ipv6: (Default value = 0)
2834 :param encap_table_id: (Default value = 0)
2835 :param decap_next_index: (Default value = 0xFFFFFFFF)
2836 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2837 :param vni: (Default value = 0)
2838 :param instance: (Default value = 0xFFFFFFFF)
2841 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2846 'mcast_sw_if_index': mcast_sw_if_index,
2847 'encap_table_id': encap_table_id,
2849 'instance': instance}})
2851 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2852 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2853 {'sw_if_index': sw_if_index,
2854 '_no_type_conversion': True})
2856 def pppoe_add_del_session(
2866 :param is_add: (Default value = 1)
2867 :param is_ipv6: (Default value = 0)
2869 :param session_id: (Default value = 0)
2871 :param decap_vrf_id: (Default value = 0)
2874 return self.api(self.papi.pppoe_add_del_session,
2877 'session_id': session_id,
2878 'client_ip': client_ip,
2879 'decap_vrf_id': decap_vrf_id,
2880 'client_mac': client_mac})
2882 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2883 return self.api(self.papi.sr_mpls_policy_add,
2887 'n_segments': len(segments),
2888 'segments': segments})
2890 def sr_mpls_policy_del(self, bsid):
2891 return self.api(self.papi.sr_mpls_policy_del,
2894 def sr_localsid_add_del(self,
2901 sw_if_index=0xFFFFFFFF,
2905 """ Add/del IPv6 SR local-SID.
2908 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2909 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2912 :param is_del: (Default value = 0)
2913 :param end_psp: (Default value = 0)
2914 :param sw_if_index: (Default value = 0xFFFFFFFF)
2915 :param vlan_index: (Default value = 0)
2916 :param fib_table: (Default value = 0)
2919 self.papi.sr_localsid_add_del,
2921 'localsid': localsid,
2923 'behavior': behavior,
2924 'sw_if_index': sw_if_index,
2925 'vlan_index': vlan_index,
2926 'fib_table': fib_table,
2927 'nh_addr4': nh_addr4,
2928 'nh_addr6': nh_addr6
2942 :param bsid_addr: bindingSID of the SR Policy
2943 :param weight: weight of the sid list. optional. (default: 1)
2944 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2946 :param type: type/behavior of the SR policy. (default or spray) \
2948 :param fib_table: VRF where to install the FIB entry for the BSID \
2950 :param n_segments: number of segments \
2952 :param segments: a vector of IPv6 address composing the segment list \
2956 self.papi.sr_policy_add,
2957 {'bsid_addr': bsid_addr,
2959 'is_encap': is_encap,
2961 'fib_table': fib_table,
2962 'n_segments': n_segments,
2963 'segments': segments
2972 :param bsid: bindingSID of the SR Policy
2973 :param sr_policy_index: index of the sr policy (default: 0)
2976 self.papi.sr_policy_del,
2977 {'bsid_addr': bsid_addr,
2978 'sr_policy_index': sr_policy_index
2981 def sr_steering_add_del(
2992 Steer traffic L2 and L3 traffic through a given SR policy
2994 :param is_del: delete or add
2995 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2996 :param sr_policy: is the index of the SR Policy (alt to bsid)
2997 :param table_id: is the VRF where to install the FIB entry for the BSID
2998 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2999 :param mask_width: is the mask for L3 traffic type
3000 :param sw_if_index: is the incoming interface for L2 traffic
3001 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
3004 self.papi.sr_steering_add_del,
3006 'bsid_addr': bsid_addr,
3007 'sr_policy_index': sr_policy_index,
3008 'table_id': table_id,
3009 'prefix_addr': prefix_addr,
3010 'mask_width': mask_width,
3011 'sw_if_index': sw_if_index,
3012 'traffic_type': traffic_type
3015 def acl_add_replace(self, acl_index, r, tag='',
3017 """Add/replace an ACL
3018 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
3019 :param acl_rule r: ACL rules array.
3020 :param str tag: symbolic tag (description) for this ACL.
3021 :param int count: number of rules.
3023 return self.api(self.papi.acl_add_replace,
3024 {'acl_index': acl_index,
3028 expected_retval=expected_retval)
3030 def acl_del(self, acl_index, expected_retval=0):
3036 return self.api(self.papi.acl_del,
3037 {'acl_index': acl_index},
3038 expected_retval=expected_retval)
3040 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
3042 return self.api(self.papi.acl_interface_set_acl_list,
3043 {'sw_if_index': sw_if_index,
3047 expected_retval=expected_retval)
3049 def acl_interface_set_etype_whitelist(self, sw_if_index,
3052 return self.api(self.papi.acl_interface_set_etype_whitelist,
3053 {'sw_if_index': sw_if_index,
3054 'count': len(whitelist),
3056 'whitelist': whitelist},
3057 expected_retval=expected_retval)
3059 def acl_interface_add_del(self,
3063 """ Add/Delete ACL to/from interface
3067 :param is_add: (Default value = 1)
3070 return self.api(self.papi.acl_interface_add_del,
3073 'sw_if_index': sw_if_index,
3074 'acl_index': acl_index})
3076 def acl_dump(self, acl_index, expected_retval=0):
3077 return self.api(self.papi.acl_dump,
3078 {'acl_index': acl_index},
3079 expected_retval=expected_retval)
3081 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3083 return self.api(self.papi.acl_interface_list_dump,
3084 {'sw_if_index': sw_if_index},
3085 expected_retval=expected_retval)
3087 def macip_acl_add(self, rules, tag=""):
3090 :param rules: list of rules for given acl
3094 return self.api(self.papi.macip_acl_add,
3096 'count': len(rules),
3099 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3102 :param rules: list of rules for given acl
3106 return self.api(self.papi.macip_acl_add_replace,
3107 {'acl_index': acl_index,
3109 'count': len(rules),
3112 def macip_acl_del(self, acl_index):
3118 return self.api(self.papi.macip_acl_del,
3119 {'acl_index': acl_index})
3121 def macip_acl_interface_add_del(self,
3125 """ Add MACIP acl to interface
3129 :param is_add: (Default value = 1)
3132 return self.api(self.papi.macip_acl_interface_add_del,
3134 'sw_if_index': sw_if_index,
3135 'acl_index': acl_index})
3137 def macip_acl_interface_get(self):
3138 """ Return interface acls dump
3141 self.papi.macip_acl_interface_get, {})
3143 def macip_acl_dump(self, acl_index=4294967295):
3144 """ Return MACIP acl dump
3148 self.papi.macip_acl_dump, {'acl_index': acl_index})
3150 def policer_add_del(self,
3161 conform_action_type=1,
3163 exceed_action_type=0,
3165 violate_action_type=0,
3167 return self.api(self.papi.policer_add_del,
3174 'rate_type': rate_type,
3175 'round_type': round_type,
3177 'color_aware': color_aware,
3178 'conform_action_type': conform_action_type,
3179 'conform_dscp': conform_dscp,
3180 'exceed_action_type': exceed_action_type,
3181 'exceed_dscp': exceed_dscp,
3182 'violate_action_type': violate_action_type,
3183 'violate_dscp': violate_dscp})
3185 def ip_punt_police(self,
3189 return self.api(self.papi.ip_punt_police,
3190 {'policer_index': policer_index,
3194 def ip_punt_redirect(self,
3199 return self.api(self.papi.ip_punt_redirect,
3200 {'punt': {'rx_sw_if_index': rx_sw_if_index,
3201 'tx_sw_if_index': tx_sw_if_index,
3205 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
3206 return self.api(self.papi.ip_punt_redirect_dump,
3207 {'sw_if_index': sw_if_index,
3208 'is_ipv6': is_ipv6})
3210 def bier_table_add_del(self,
3214 """ BIER Table add/del """
3216 self.papi.bier_table_add_del,
3217 {'bt_tbl_id': {"bt_set": bti.set_id,
3218 "bt_sub_domain": bti.sub_domain_id,
3219 "bt_hdr_len_id": bti.hdr_len_id},
3220 'bt_label': mpls_label,
3221 'bt_is_add': is_add})
3223 def bier_table_dump(self):
3224 return self.api(self.papi.bier_table_dump, {})
3226 def bier_route_add_del(self,
3232 """ BIER Route add/del """
3234 self.papi.bier_route_add_del,
3235 {'br_tbl_id': {"bt_set": bti.set_id,
3236 "bt_sub_domain": bti.sub_domain_id,
3237 "bt_hdr_len_id": bti.hdr_len_id},
3239 'br_n_paths': len(paths),
3241 'br_is_add': is_add,
3242 'br_is_replace': is_replace})
3244 def bier_route_dump(self, bti):
3246 self.papi.bier_route_dump,
3247 {'br_tbl_id': {"bt_set": bti.set_id,
3248 "bt_sub_domain": bti.sub_domain_id,
3249 "bt_hdr_len_id": bti.hdr_len_id}})
3251 def bier_imp_add(self,
3256 """ BIER Imposition Add """
3258 self.papi.bier_imp_add,
3259 {'bi_tbl_id': {"bt_set": bti.set_id,
3260 "bt_sub_domain": bti.sub_domain_id,
3261 "bt_hdr_len_id": bti.hdr_len_id},
3263 'bi_n_bytes': len(ibytes),
3264 'bi_bytes': ibytes})
3266 def bier_imp_del(self, bi_index):
3267 """ BIER Imposition del """
3269 self.papi.bier_imp_del,
3270 {'bi_index': bi_index})
3272 def bier_imp_dump(self):
3273 return self.api(self.papi.bier_imp_dump, {})
3275 def bier_disp_table_add_del(self,
3278 """ BIER Disposition Table add/del """
3280 self.papi.bier_disp_table_add_del,
3281 {'bdt_tbl_id': bdti,
3282 'bdt_is_add': is_add})
3284 def bier_disp_table_dump(self):
3285 return self.api(self.papi.bier_disp_table_dump, {})
3287 def bier_disp_entry_add_del(self,
3297 """ BIER Route add/del """
3299 while (len(lstack) < 16):
3302 self.papi.bier_disp_entry_add_del,
3303 {'bde_tbl_id': bdti,
3305 'bde_payload_proto': payload_proto,
3307 'bde_paths': [{'next_hop': next_hop,
3308 'table_id': next_hop_tbl_id,
3309 'afi': next_hop_afi,
3310 'rpf_id': next_hop_rpf_id,
3312 'label_stack': lstack}],
3313 'bde_is_add': is_add})
3315 def bier_disp_entry_dump(self, bdti):
3317 self.papi.bier_disp_entry_dump,
3318 {'bde_tbl_id': bdti})
3320 def add_node_next(self, node_name, next_name):
3321 """ Set the next node for a given node request
3326 return self.api(self.papi.add_node_next,
3327 {'node_name': node_name,
3328 'next_name': next_name})
3330 def session_enable_disable(self, is_enabled):
3332 self.papi.session_enable_disable,
3333 {'is_enable': is_enabled})
3335 def ipsec_spd_add_del(self, spd_id, is_add=1):
3336 """ SPD add/del - Wrapper to add or del ipsec SPD
3337 Sample CLI : 'ipsec spd add 1'
3339 :param spd_id - SPD ID to be created in the vpp . mandatory
3340 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3342 :returns: reply from the API
3345 self.papi.ipsec_spd_add_del, {
3346 'spd_id': spd_id, 'is_add': is_add})
3348 def ipsec_spds_dump(self):
3349 return self.api(self.papi.ipsec_spds_dump, {})
3351 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3352 """ IPSEC interface SPD add/del - \
3353 Wrapper to associate/disassociate SPD to interface in VPP
3354 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3356 :param spd_id - SPD ID to associate with the interface . mandatory
3357 :param sw_if_index - Interface Index which needs to ipsec \
3358 association mandatory
3359 :param is_add - add(1) or del(0) association with interface \
3360 (Default 1 - add) . optional
3361 :returns: reply from the API
3364 self.papi.ipsec_interface_add_del_spd,
3365 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3367 def ipsec_spd_interface_dump(self, spd_index=None):
3368 return self.api(self.papi.ipsec_spd_interface_dump,
3369 {'spd_index': spd_index if spd_index else 0,
3370 'spd_index_valid': 1 if spd_index else 0})
3372 def ipsec_sad_add_del_entry(self,
3375 integrity_algorithm,
3380 tunnel_src_address='',
3381 tunnel_dst_address='',
3387 use_extended_sequence_number=0):
3388 """ IPSEC SA add/del
3389 :param sad_id: security association ID
3390 :param spi: security param index of the SA in decimal
3391 :param integrity_algorithm:
3392 :param integrity_key:
3393 :param crypto_algorithm:
3395 :param protocol: AH(0) or ESP(1) protocol
3396 :param tunnel_src_address: tunnel mode outer src address
3397 :param tunnel_dst_address: tunnel mode outer dst address
3400 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3401 crypto and ipsec algorithms
3404 self.papi.ipsec_sad_add_del_entry,
3407 'tunnel_src_address': tunnel_src_address,
3408 'tunnel_dst_address': tunnel_dst_address,
3409 'protocol': protocol,
3410 'integrity_algorithm': integrity_algorithm,
3411 'integrity_key_length': len(integrity_key),
3412 'integrity_key': integrity_key,
3413 'crypto_algorithm': crypto_algorithm,
3414 'crypto_key_length': len(crypto_key) if crypto_key is not None
3416 'crypto_key': crypto_key,
3418 'is_tunnel': is_tunnel,
3419 'is_tunnel_ipv6': is_tunnel_ipv6,
3420 'udp_encap': udp_encap,
3421 'use_extended_sequence_number': use_extended_sequence_number,
3422 'use_anti_replay': use_anti_replay})
3424 def ipsec_sa_dump(self, sa_id=None):
3425 return self.api(self.papi.ipsec_sa_dump,
3426 {'sa_id': sa_id if sa_id else 0xffffffff})
3428 def ipsec_spd_add_del_entry(self,
3431 local_address_start,
3433 remote_address_start,
3434 remote_address_stop,
3436 local_port_stop=65535,
3437 remote_port_start=0,
3438 remote_port_stop=65535,
3446 """ IPSEC policy SPD add/del -
3447 Wrapper to configure ipsec SPD policy entries in VPP
3448 :param spd_id: SPD ID for the policy
3449 :param local_address_start: local-ip-range start address
3450 :param local_address_stop : local-ip-range stop address
3451 :param remote_address_start: remote-ip-range start address
3452 :param remote_address_stop : remote-ip-range stop address
3453 :param local_port_start: (Default value = 0)
3454 :param local_port_stop: (Default value = 65535)
3455 :param remote_port_start: (Default value = 0)
3456 :param remote_port_stop: (Default value = 65535)
3457 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3458 :param sa_id: Security Association ID for mapping it to SPD
3459 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3461 :param priority: value for the spd action (Default value = 100)
3462 :param is_outbound: flag for inbound(0) or outbound(1)
3464 :param is_add: (Default value = 1)
3467 self.papi.ipsec_spd_add_del_entry,
3470 'local_address_start': local_address_start,
3471 'local_address_stop': local_address_stop,
3472 'remote_address_start': remote_address_start,
3473 'remote_address_stop': remote_address_stop,
3474 'local_port_start': local_port_start,
3475 'local_port_stop': local_port_stop,
3476 'remote_port_start': remote_port_start,
3477 'remote_port_stop': remote_port_stop,
3479 'protocol': protocol,
3481 'priority': priority,
3482 'is_outbound': is_outbound,
3484 'is_ip_any': is_ip_any})
3486 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
3487 return self.api(self.papi.ipsec_spd_dump,
3491 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3492 remote_spi, crypto_alg, local_crypto_key,
3493 remote_crypto_key, integ_alg, local_integ_key,
3494 remote_integ_key, is_add=1, esn=0,
3495 anti_replay=1, renumber=0, show_instance=0):
3497 self.papi.ipsec_tunnel_if_add_del,
3498 {'local_ip': local_ip, 'remote_ip': remote_ip,
3499 'local_spi': local_spi, 'remote_spi': remote_spi,
3500 'crypto_alg': crypto_alg,
3501 'local_crypto_key_len': len(local_crypto_key),
3502 'local_crypto_key': local_crypto_key,
3503 'remote_crypto_key_len': len(remote_crypto_key),
3504 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3505 'local_integ_key_len': len(local_integ_key),
3506 'local_integ_key': local_integ_key,
3507 'remote_integ_key_len': len(remote_integ_key),
3508 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3509 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3510 'show_instance': show_instance
3513 def ipsec_select_backend(self, protocol, index):
3514 return self.api(self.papi.ipsec_select_backend,
3515 {'protocol': protocol, 'index': index})
3517 def ipsec_backend_dump(self):
3518 return self.api(self.papi.ipsec_backend_dump, {})
3520 def app_namespace_add(self,
3524 sw_if_index=0xFFFFFFFF,
3527 self.papi.app_namespace_add_del,
3529 'sw_if_index': sw_if_index,
3530 'ip4_fib_id': ip4_fib_id,
3531 'ip6_fib_id': ip6_fib_id,
3532 'namespace_id': namespace_id,
3533 'namespace_id_len': len(namespace_id)})
3535 def punt_socket_register(self, port, pathname, protocol=0x11,
3536 header_version=1, is_ip4=1):
3537 """ Register punt socket """
3538 return self.api(self.papi.punt_socket_register,
3539 {'header_version': header_version,
3540 'punt': {'ipv': is_ip4,
3541 'l4_protocol': protocol,
3543 'pathname': pathname})
3545 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
3546 """ Unregister punt socket """
3547 return self.api(self.papi.punt_socket_deregister,
3548 {'punt': {'ipv': is_ip4,
3549 'l4_protocol': protocol,
3552 def punt_socket_dump(self, is_ip6=1):
3553 """ Dump punt socket"""
3554 return self.api(self.papi.punt_socket_dump,
3555 {'is_ipv6': is_ip6})
3557 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3558 expire_walk_interval_ms, is_ip6=0):
3559 """ Set IP reassembly parameters """
3560 return self.api(self.papi.ip_reassembly_set,
3562 'timeout_ms': timeout_ms,
3563 'expire_walk_interval_ms': expire_walk_interval_ms,
3564 'max_reassemblies': max_reassemblies})
3566 def ip_reassembly_get(self, is_ip6=0):
3567 """ Get IP reassembly parameters """
3568 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3570 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3572 """ Enable/disable IP reassembly """
3573 return self.api(self.papi.ip_reassembly_enable_disable,
3574 {'sw_if_index': sw_if_index,
3575 'enable_ip4': 1 if enable_ip4 else 0,
3576 'enable_ip6': 1 if enable_ip6 else 0,
3579 def gbp_endpoint_add(self, sw_if_index, ips, mac, epg, flags,
3581 """ GBP endpoint Add """
3582 return self.api(self.papi.gbp_endpoint_add,
3584 'sw_if_index': sw_if_index,
3595 def gbp_endpoint_del(self, handle):
3596 """ GBP endpoint Del """
3597 return self.api(self.papi.gbp_endpoint_del,
3600 def gbp_endpoint_dump(self):
3601 """ GBP endpoint Dump """
3602 return self.api(self.papi.gbp_endpoint_dump,
3603 {'_no_type_conversion': True})
3605 def gbp_endpoint_group_add(self, epg, sclass, bd,
3606 rd, uplink_sw_if_index):
3607 """ GBP endpoint group Add """
3608 return self.api(self.papi.gbp_endpoint_group_add,
3611 'uplink_sw_if_index': uplink_sw_if_index,
3618 def gbp_endpoint_group_del(self, epg):
3619 """ GBP endpoint group Del """
3620 return self.api(self.papi.gbp_endpoint_group_del,
3623 def gbp_endpoint_group_dump(self):
3624 """ GBP endpoint group Dump """
3625 return self.api(self.papi.gbp_endpoint_group_dump, {})
3627 def gbp_bridge_domain_add(self, bd_id, flags,
3630 bm_flood_sw_if_index):
3631 """ GBP bridge-domain Add """
3632 return self.api(self.papi.gbp_bridge_domain_add,
3636 'bvi_sw_if_index': bvi_sw_if_index,
3637 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
3638 'bm_flood_sw_if_index': bm_flood_sw_if_index,
3642 def gbp_bridge_domain_del(self, bd_id):
3643 """ GBP bridge-domain Del """
3644 return self.api(self.papi.gbp_bridge_domain_del,
3647 def gbp_bridge_domain_dump(self):
3648 """ GBP Bridge Domain Dump """
3649 return self.api(self.papi.gbp_bridge_domain_dump, {})
3651 def gbp_route_domain_add(self, rd_id,
3655 ip6_uu_sw_if_index):
3656 """ GBP route-domain Add """
3657 return self.api(self.papi.gbp_route_domain_add,
3660 'ip4_table_id': ip4_table_id,
3661 'ip6_table_id': ip6_table_id,
3662 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
3663 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
3667 def gbp_route_domain_del(self, rd_id):
3668 """ GBP route-domain Del """
3669 return self.api(self.papi.gbp_route_domain_del,
3672 def gbp_route_domain_dump(self):
3673 """ GBP Route Domain Dump """
3674 return self.api(self.papi.gbp_route_domain_dump, {})
3676 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3677 """ GBP recirc Add/Del """
3678 return self.api(self.papi.gbp_recirc_add_del,
3682 'sw_if_index': sw_if_index,
3685 def gbp_recirc_dump(self):
3686 """ GBP recirc Dump """
3687 return self.api(self.papi.gbp_recirc_dump, {})
3689 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
3690 """ GBP recirc Add/Del """
3691 return self.api(self.papi.gbp_ext_itf_add_del,
3694 'sw_if_index': sw_if_index,
3698 def gbp_ext_itf_dump(self):
3699 """ GBP recirc Dump """
3700 return self.api(self.papi.gbp_ext_itf_dump, {})
3702 def gbp_subnet_add_del(self, is_add, rd_id,
3704 sw_if_index=0xffffffff,
3706 """ GBP Subnet Add/Del """
3707 return self.api(self.papi.gbp_subnet_add_del,
3711 'sw_if_index': sw_if_index,
3716 def gbp_subnet_dump(self):
3717 """ GBP Subnet Dump """
3718 return self.api(self.papi.gbp_subnet_dump,
3719 {'_no_type_conversion': True})
3721 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index,
3722 rules, allowed_ethertypes):
3723 """ GBP contract Add/Del """
3724 return self.api(self.papi.gbp_contract_add_del,
3727 'acl_index': acl_index,
3730 'n_rules': len(rules),
3732 'n_ether_types': len(allowed_ethertypes),
3733 'allowed_ethertypes': allowed_ethertypes}})
3735 def gbp_contract_dump(self):
3736 """ GBP contract Dump """
3737 return self.api(self.papi.gbp_contract_dump, {})
3739 def gbp_endpoint_learn_set_inactive_threshold(self, threshold):
3740 """ GBP set inactive threshold """
3741 return self.api(self.papi.gbp_endpoint_learn_set_inactive_threshold,
3742 {'threshold': threshold})
3744 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode):
3745 """ GBP VXLAN tunnel add """
3746 return self.api(self.papi.gbp_vxlan_tunnel_add,
3751 'bd_rd_id': bd_rd_id
3755 def gbp_vxlan_tunnel_del(self, vni):
3756 """ GBP VXLAN tunnel del """
3757 return self.api(self.papi.gbp_vxlan_tunnel_del,
3762 def gbp_vxlan_tunnel_dump(self):
3763 """ GBP VXLAN tunnel add/del """
3764 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
3766 def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3767 ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3769 """ 6RD tunnel Add """
3770 return self.api(self.papi.ipip_6rd_add_tunnel,
3771 {'ip4_table_id': ip4_table_id,
3772 'ip6_table_id': ip6_table_id,
3773 'ip6_prefix': ip6_prefix,
3774 'ip6_prefix_len': ip6_prefix_len,
3775 'ip4_prefix': ip4_prefix,
3776 'ip4_prefix_len': ip4_prefix_len,
3778 'security_check': security_check})
3780 def ipip_6rd_del_tunnel(self, sw_if_index):
3781 """ 6RD tunnel Delete """
3782 return self.api(self.papi.ipip_6rd_del_tunnel,
3783 {'sw_if_index': sw_if_index})
3785 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3786 instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3787 """ IPIP tunnel Add/Del """
3788 return self.api(self.papi.ipip_add_tunnel,
3789 {'is_ipv6': is_ipv6,
3790 'instance': instance,
3791 'src_address': src_address,
3792 'dst_address': dst_address,
3793 'table_id': table_id,
3796 def ipip_del_tunnel(self, sw_if_index):
3797 """ IPIP tunnel Delete """
3798 return self.api(self.papi.ipip_del_tunnel,
3799 {'sw_if_index': sw_if_index})
3801 def qos_egress_map_update(self, id, outputs):
3802 """ QOS egress map update """
3803 return self.api(self.papi.qos_egress_map_update,
3807 def qos_egress_map_delete(self, id):
3808 """ QOS egress map delete """
3809 return self.api(self.papi.qos_egress_map_delete,
3812 def qos_mark_enable_disable(self, sw_if_index,
3816 """ QOS Mark Enable/Disable """
3817 return self.api(self.papi.qos_mark_enable_disable,
3819 'sw_if_index': sw_if_index,
3820 'output_source': output_source,
3823 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3824 """ IP QoS recording Enble/Disable """
3825 return self.api(self.papi.qos_record_enable_disable,
3826 {'sw_if_index': sw_if_index,
3827 'input_source': input_source,
3830 def igmp_enable_disable(self, sw_if_index, enable, host):
3831 """ Enable/disable IGMP on a given interface """
3832 return self.api(self.papi.igmp_enable_disable,
3835 'sw_if_index': sw_if_index})
3837 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
3838 """ Add/del IGMP proxy device """
3839 return self.api(self.papi.igmp_proxy_device_add_del,
3840 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3843 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
3844 """ Add/del interface to/from IGMP proxy device """
3845 return self.api(self.papi.igmp_proxy_device_add_del_interface,
3846 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3849 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3850 """ Listen for new (S,G) on specified interface
3852 :param enable: add/del
3853 :param sw_if_index: interface sw index
3854 :param saddr: source ip4 addr
3855 :param gaddr: group ip4 addr
3857 return self.api(self.papi.igmp_listen,
3862 'sw_if_index': sw_if_index,
3863 'n_srcs': len(saddrs),
3869 def igmp_dump(self, sw_if_index=None):
3870 """ Dump all (S,G) interface configurations """
3871 if sw_if_index is None:
3872 sw_if_index = 0xffffffff
3873 return self.api(self.papi.igmp_dump,
3874 {'sw_if_index': sw_if_index})
3876 def igmp_clear_interface(self, sw_if_index):
3877 """ Remove all (S,G)s from specified interface
3878 doesn't send IGMP report!
3881 self.papi.igmp_clear_interface, {
3882 'sw_if_index': sw_if_index})
3884 def want_igmp_events(self, enable=1):
3885 return self.api(self.papi.want_igmp_events, {'enable': enable,
3886 'pid': os.getpid()})
3894 interface_id=0xFFFFFFFF):
3897 :param lb: load balance
3898 :param use_custom_mac: use custom mac
3899 :param mac_address: mac address
3900 :param interface_id: custom interface ID
3903 self.papi.bond_create,
3906 'use_custom_mac': use_custom_mac,
3907 'mac_address': mac_address,
3915 :param sw_if_index: interface the operation is applied to
3917 return self.api(self.papi.bond_delete,
3918 {'sw_if_index': sw_if_index})
3927 :param sw_if_index: slave sw_if_index
3928 :param bond_sw_if_index: bond sw_if_index
3929 :param is_passive: is passive lacp speaker
3930 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3933 self.papi.bond_enslave,
3934 {'sw_if_index': sw_if_index,
3935 'bond_sw_if_index': bond_sw_if_index,
3936 'is_passive': is_passive,
3937 'is_long_timeout': is_long_timeout
3940 def bond_detach_slave(
3944 :param sw_if_index: slave interface the operation is applied to
3946 return self.api(self.papi.bond_detach_slave,
3947 {'sw_if_index': sw_if_index})
3949 def sw_interface_slave_dump(
3953 :param sw_if_index: bond sw_if_index
3955 return self.api(self.papi.sw_interface_slave_dump,
3956 {'sw_if_index': sw_if_index})
3958 def sw_interface_bond_dump(
3963 return self.api(self.papi.sw_interface_bond_dump,
3966 def create_vhost_user_if(
3972 disable_indirect_desc,
3973 custom_dev_instance,
3978 :param is_server: is server
3979 :param sock_filename: socket name
3980 :param renumber: renumber
3981 :param disable_mrg_rxbuf: disable mergable rx buffers
3982 :param disable_indirect_desc: disable indirect descriptors
3983 :param custom_dev_instance: custom dev instance
3984 :param use_custom_mac: use custom mac
3985 :param mac_address: mac address
3986 :param tag: tag (default '')
3989 self.papi.create_vhost_user_if,
3990 {'is_server': is_server,
3991 'sock_filename': sock_filename,
3992 'renumber': renumber,
3993 'disable_mrg_rxbuf': disable_mrg_rxbuf,
3994 'disable_indirect_desc': disable_indirect_desc,
3995 'custom_dev_instance': custom_dev_instance,
3996 'use_custom_mac': use_custom_mac,
3997 'mac_address': mac_address,
4001 def delete_vhost_user_if(
4005 :param sw_if_index: interface the operation is applied to
4007 return self.api(self.papi.delete_vhost_user_if,
4008 {'sw_if_index': sw_if_index, })
4010 def sw_interface_vhost_user_dump(
4015 return self.api(self.papi.sw_interface_vhost_user_dump,
4018 def abf_policy_add_del(self, is_add, policy):
4020 self.papi.abf_policy_add_del,
4024 def abf_itf_attach_add_del(self, is_add, attach):
4026 self.papi.abf_itf_attach_add_del,
4030 def abf_policy_dump(self):
4032 self.papi.abf_policy_dump, {})
4034 def abf_itf_attach_dump(self):
4036 self.papi.abf_itf_attach_dump, {})
4038 def pipe_create(self, is_specified, user_instance):
4039 return self.api(self.papi.pipe_create,
4040 {'is_specified': is_specified,
4041 'user_instance': user_instance})
4043 def pipe_delete(self, parent_sw_if_index):
4044 return self.api(self.papi.pipe_delete,
4045 {'parent_sw_if_index': parent_sw_if_index})
4047 def pipe_dump(self):
4048 return self.api(self.papi.pipe_dump, {})
4062 return self.api(self.papi.memif_create,
4065 'rx_queues': rx_queues,
4066 'tx_queues': tx_queues,
4068 'socket_id': socket_id,
4070 'ring_size': ring_size,
4071 'buffer_size': buffer_size,
4072 'hw_addr': hw_addr})
4074 def memif_delete(self, sw_if_index):
4075 return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index})
4077 def memif_dump(self):
4078 return self.api(self.papi.memif_dump, {})
4080 def memif_socket_filename_add_del(
4081 self, is_add, socket_id, socket_filename):
4083 self.papi.memif_socket_filename_add_del,
4085 'socket_id': socket_id,
4086 'socket_filename': socket_filename})
4088 def memif_socket_filename_dump(self):
4089 return self.api(self.papi.memif_socket_filename_dump, {})
4091 def svs_table_add_del(self, af, table_id, is_add=1):
4092 return self.api(self.papi.svs_table_add_del,
4094 'table_id': table_id,
4099 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
4100 return self.api(self.papi.svs_route_add_del,
4102 'table_id': table_id,
4103 'source_table_id': src_table_id,
4108 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
4109 return self.api(self.papi.svs_enable_disable,
4112 'table_id': table_id,
4113 'sw_if_index': sw_if_index,
4114 'is_enable': is_enable,
4118 return self.api(self.papi.svs_dump, {})
4120 def syslog_set_sender(
4127 """Set syslog sender configuration
4129 :param collector: colector IP address
4130 :param src: source IP address
4131 :param collector_port: collector UDP port (Default value = 514)
4132 :param vrf_id: VRF id (Default value = 0)
4133 :param max_msg_size: maximum message length (Default value = 480)
4135 return self.api(self.papi.syslog_set_sender,
4136 {'collector_address': collector,
4138 'collector_port': collector_port,
4140 'max_msg_size': max_msg_size})
4142 def syslog_get_sender(self):
4143 """Return syslog sender configuration"""
4144 return self.api(self.papi.syslog_get_sender, {})
4146 def syslog_set_filter(self, severity):
4147 """Set syslog filter parameters
4149 :param severity: severity filter (specified severity and greater match)
4151 return self.api(self.papi.syslog_set_filter, {'severity': severity})
4153 def syslog_get_filter(self):
4154 """Return syslog filter parameters"""
4155 return self.api(self.papi.syslog_get_filter, {})