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, address, 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,
372 'address_length': address_length,
373 'use_default': use_default,
374 'no_advertise': no_advertise,
375 'off_link': off_link,
376 'no_autoconfig': no_autoconfig,
377 'no_onlink': no_onlink,
379 'val_lifetime': val_lifetime,
380 'pref_lifetime': pref_lifetime})
382 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
384 Enable/Disable An interface for IPv6
386 return self.api(self.papi.sw_interface_ip6_enable_disable,
387 {'sw_if_index': sw_if_index,
390 def vxlan_add_del_tunnel(
394 mcast_sw_if_index=0xFFFFFFFF,
398 decap_next_index=0xFFFFFFFF,
400 instance=0xFFFFFFFF):
405 :param is_add: (Default value = 1)
406 :param is_ipv6: (Default value = 0)
407 :param encap_vrf_id: (Default value = 0)
408 :param decap_next_index: (Default value = 0xFFFFFFFF)
409 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
410 :param vni: (Default value = 0)
411 :param instance: (Default value = 0xFFFFFFFF)
414 return self.api(self.papi.vxlan_add_del_tunnel,
417 'src_address': src_addr,
418 'dst_address': dst_addr,
419 'mcast_sw_if_index': mcast_sw_if_index,
420 'encap_vrf_id': encap_vrf_id,
421 'decap_next_index': decap_next_index,
423 'instance': instance})
425 def geneve_add_del_tunnel(
429 mcast_sw_if_index=0xFFFFFFFF,
433 decap_next_index=0xFFFFFFFF,
439 :param is_add: (Default value = 1)
440 :param is_ipv6: (Default value = 0)
441 :param encap_vrf_id: (Default value = 0)
442 :param decap_next_index: (Default value = 0xFFFFFFFF)
443 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
444 :param vni: (Default value = 0)
447 return self.api(self.papi.geneve_add_del_tunnel,
450 'local_address': local_addr,
451 'remote_address': remote_addr,
452 'mcast_sw_if_index': mcast_sw_if_index,
453 'encap_vrf_id': encap_vrf_id,
454 'decap_next_index': decap_next_index,
457 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
458 learn=1, arp_term=0, is_add=1):
459 """Create/delete bridge domain.
461 :param int bd_id: Bridge domain index.
462 :param int flood: Enable/disable bcast/mcast flooding in the BD.
464 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
466 :param int forward: Enable/disable forwarding on all interfaces in
467 the BD. (Default value = 1)
468 :param int learn: Enable/disable learning on all interfaces in the BD.
470 :param int arp_term: Enable/disable arp termination in the BD.
472 :param int is_add: Add or delete flag. (Default value = 1)
474 return self.api(self.papi.bridge_domain_add_del,
477 'uu_flood': uu_flood,
480 'arp_term': arp_term,
483 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
484 return self.api(self.papi.bd_ip_mac_add_del,
490 def bd_ip_mac_dump(self, bd_id):
491 return self.api(self.papi.bd_ip_mac_dump,
494 def want_ip4_arp_events(self, enable_disable=1, address=0):
495 return self.api(self.papi.want_ip4_arp_events,
496 {'enable_disable': enable_disable,
498 'pid': os.getpid(), })
500 def want_ip6_nd_events(self, enable_disable=1, address=0):
501 return self.api(self.papi.want_ip6_nd_events,
502 {'enable_disable': enable_disable,
504 'pid': os.getpid(), })
506 def want_ip6_ra_events(self, enable_disable=1):
507 return self.api(self.papi.want_ip6_ra_events,
508 {'enable_disable': enable_disable,
509 'pid': os.getpid(), })
511 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
513 return self.api(self.papi.ip6nd_send_router_solicitation,
518 'sw_if_index': sw_if_index})
520 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
521 install_default_routes):
522 return self.api(self.papi.ip6_nd_address_autoconfig,
523 {'sw_if_index': sw_if_index,
525 'install_default_routes': install_default_routes})
527 def want_interface_events(self, enable_disable=1):
528 return self.api(self.papi.want_interface_events,
529 {'enable_disable': enable_disable,
530 'pid': os.getpid(), })
532 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
533 max_macs_in_event=0, learn_limit=0):
534 return self.api(self.papi.want_l2_macs_events,
535 {'enable_disable': enable_disable,
536 'scan_delay': scan_delay,
537 'max_macs_in_event': max_macs_in_event,
538 'learn_limit': learn_limit,
539 'pid': os.getpid(), })
541 def want_dhcp6_reply_events(self, enable_disable=1):
542 return self.api(self.papi.want_dhcp6_reply_events,
543 {'enable_disable': enable_disable,
546 def want_dhcp6_pd_reply_events(self, enable_disable=1):
547 return self.api(self.papi.want_dhcp6_pd_reply_events,
548 {'enable_disable': enable_disable,
551 def dhcp6_clients_enable_disable(self, enable=1):
552 return self.api(self.papi.dhcp6_clients_enable_disable,
555 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
556 addresses, server_index=0xFFFFFFFF,
557 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
559 return self.api(self.papi.dhcp6_send_client_message,
560 {'sw_if_index': sw_if_index,
561 'server_index': server_index,
567 'msg_type': msg_type,
570 'n_addresses': len(addresses),
571 'addresses': addresses})
573 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
574 prefixes, server_index=0xFFFFFFFF,
575 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
577 return self.api(self.papi.dhcp6_pd_send_client_message,
578 {'sw_if_index': sw_if_index,
579 'server_index': server_index,
585 'msg_type': msg_type,
588 'n_prefixes': len(prefixes),
589 'prefixes': prefixes})
591 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
593 return self.api(self.papi.dhcp6_client_enable_disable,
594 {'sw_if_index': sw_if_index,
597 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
599 return self.api(self.papi.dhcp6_pd_client_enable_disable,
600 {'sw_if_index': sw_if_index,
601 'prefix_group': prefix_group,
604 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
605 prefix_length, prefix_group,
607 return self.api(self.papi.ip6_add_del_address_using_prefix,
608 {'sw_if_index': sw_if_index,
609 'prefix_group': prefix_group,
611 'prefix_length': prefix_length,
614 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
615 filter_mac=0, bvi_mac=0):
616 """Create/delete L2 FIB entry.
618 :param str mac: MAC address to create FIB entry for.
619 :param int bd_id: Bridge domain index.
620 :param int sw_if_index: Software interface index of the interface.
621 :param int is_add: Add or delete flag. (Default value = 1)
622 :param int static_mac: Set to 1 to create static MAC entry.
624 :param int filter_mac: Set to 1 to drop packet that's source or
625 destination MAC address contains defined MAC address.
627 :param int bvi_mac: Set to 1 to create entry that points to BVI
628 interface. (Default value = 0)
630 return self.api(self.papi.l2fib_add_del,
633 'sw_if_index': sw_if_index,
635 'static_mac': static_mac,
636 'filter_mac': filter_mac,
639 def l2fib_flush_int(self, sw_if_index):
640 """Flush L2 FIB entries for sw_if_index.
642 :param int sw_if_index: Software interface index of the interface.
644 return self.api(self.papi.l2fib_flush_int,
645 {'sw_if_index': sw_if_index})
647 def l2fib_flush_bd(self, bd_id):
648 """Flush L2 FIB entries for bd_id.
650 :param int sw_if_index: Bridge Domain id.
652 return self.api(self.papi.l2fib_flush_bd,
655 def l2fib_flush_all(self):
658 return self.api(self.papi.l2fib_flush_all, {})
660 def l2_fib_table_dump(self, bd_id):
661 """ Dump the L2 FIB """
662 return self.api(self.papi.l2_fib_table_dump,
665 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
666 shg=0, port_type=L2_PORT_TYPE.NORMAL,
668 """Add/remove interface to/from bridge domain.
670 :param int sw_if_index: Software interface index of the interface.
671 :param int bd_id: Bridge domain index.
672 :param int shg: Split-horizon group index. (Default value = 0)
673 :param int bvi: Set interface as a bridge group virtual interface.
675 :param int enable: Add or remove interface. (Default value = 1)
677 return self.api(self.papi.sw_interface_set_l2_bridge,
678 {'rx_sw_if_index': sw_if_index,
681 'port_type': port_type,
684 def bridge_flags(self, bd_id, is_set, feature_bitmap):
685 """Enable/disable required feature of the bridge domain with defined
688 :param int bd_id: Bridge domain ID.
689 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
690 :param int flags: Bitmap value of the feature to be set:
694 - uu-flood (1 << 3) or
697 return self.api(self.papi.bridge_flags,
700 'flags': feature_bitmap})
702 def bridge_domain_dump(self, bd_id=0):
705 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
706 existing bridge domains returned)
707 :return: Dictionary of bridge domain(s) data.
709 return self.api(self.papi.bridge_domain_dump,
712 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
714 """Create or delete unidirectional cross-connect from Tx interface to
717 :param int rx_sw_if_index: Software interface index of Rx interface.
718 :param int tx_sw_if_index: Software interface index of Tx interface.
719 :param int enable: Create cross-connect if equal to 1, delete
720 cross-connect if equal to 0.
723 return self.api(self.papi.sw_interface_set_l2_xconnect,
724 {'rx_sw_if_index': rx_sw_if_index,
725 'tx_sw_if_index': tx_sw_if_index,
728 def sw_interface_set_l2_tag_rewrite(
735 """L2 interface vlan tag rewrite configure request
736 :param client_index - opaque cookie to identify the sender
737 :param context - sender context, to match reply w/ request
738 :param sw_if_index - interface the operation is applied to
739 :param vtr_op - Choose from l2_vtr_op_t enum values
740 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
741 :param tag1 - Needed for any push or translate vtr op
742 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
745 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
746 {'sw_if_index': sw_if_index,
752 def sw_interface_set_l2_emulation(
757 :param sw_if_index - interface the operation is applied to
760 return self.api(self.papi.l2_emulation,
761 {'sw_if_index': sw_if_index,
764 def sw_interface_set_ip_directed_broadcast(
768 """IP Directed broadcast
769 :param sw_if_index - interface the operation is applied to
772 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
773 {'sw_if_index': sw_if_index,
776 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
779 :param admin_up_down:
783 return self.api(self.papi.sw_interface_set_flags,
784 {'sw_if_index': sw_if_index,
785 'admin_up_down': admin_up_down})
787 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
793 return self.api(self.papi.sw_interface_set_mtu,
794 {'sw_if_index': sw_if_index,
797 def sw_interface_set_promiscuous(self, sw_if_index, enable):
803 return self.api(self.papi.sw_interface_set_promiscuous,
804 {'sw_if_index': sw_if_index,
807 def sw_interface_set_mac_address(self, sw_if_index, mac):
808 return self.api(self.papi.sw_interface_set_mac_address,
809 {'sw_if_index': sw_if_index,
812 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
813 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
814 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
815 """Create subinterface
816 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
818 :param sub_id: param inner_vlan:
822 :param no_tags: (Default value = 0)
823 :param one_tag: (Default value = 0)
824 :param two_tags: (Default value = 0)
825 :param dot1ad: (Default value = 0)
826 :param exact_match: (Default value = 0)
827 :param default_sub: (Default value = 0)
828 :param outer_vlan_id_any: (Default value = 0)
829 :param inner_vlan_id_any: (Default value = 0)
833 self.papi.create_subif,
834 {'sw_if_index': sw_if_index,
838 'two_tags': two_tags,
840 'exact_match': exact_match,
841 'default_sub': default_sub,
842 'outer_vlan_id_any': outer_vlan_id_any,
843 'inner_vlan_id_any': inner_vlan_id_any,
844 'outer_vlan_id': outer_vlan,
845 'inner_vlan_id': inner_vlan})
847 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
848 """Create p2p ethernet subinterface
850 :param sw_if_index: main (parent) interface
851 :param remote_mac: client (remote) mac address
855 self.papi.p2p_ethernet_add,
856 {'parent_if_index': sw_if_index,
857 'remote_mac': remote_mac,
858 'subif_id': subif_id})
860 def delete_subif(self, sw_if_index):
861 """Delete subinterface
865 return self.api(self.papi.delete_subif,
866 {'sw_if_index': sw_if_index})
868 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
869 """Delete p2p ethernet subinterface
871 :param sw_if_index: main (parent) interface
872 :param remote_mac: client (remote) mac address
876 self.papi.p2p_ethernet_del,
877 {'parent_if_index': sw_if_index,
878 'remote_mac': remote_mac})
880 def create_vlan_subif(self, sw_if_index, vlan):
887 return self.api(self.papi.create_vlan_subif,
888 {'sw_if_index': sw_if_index,
891 def create_loopback(self, mac=''):
894 :param mac: (Optional)
896 return self.api(self.papi.create_loopback,
897 {'mac_address': mac})
899 def delete_loopback(self, sw_if_index):
900 return self.api(self.papi.delete_loopback,
901 {'sw_if_index': sw_if_index, })
903 def ip_table_add_del(self,
910 :param is_add: (Default value = 1)
911 :param is_ipv6: (Default value = 0)
916 self.papi.ip_table_add_del,
917 {'table_id': table_id,
921 def ip_add_del_route(
926 next_hop_sw_if_index=0xFFFFFFFF,
930 next_hop_n_out_labels=0,
931 next_hop_out_label_stack=[],
932 next_hop_via_label=MPLS_LABEL_INVALID,
933 next_hop_id=0xFFFFFFFF,
935 is_resolve_attached=0,
936 classify_table_index=0xFFFFFFFF,
950 :param dst_address_length:
951 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
953 :param next_hop_address:
954 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
955 :param vrf_id: (Default value = 0)
956 :param lookup_in_vrf: (Default value = 0)
957 :param classify_table_index: (Default value = 0xFFFFFFFF)
958 :param is_add: (Default value = 1)
959 :param is_drop: (Default value = 0)
960 :param is_ipv6: (Default value = 0)
961 :param is_local: (Default value = 0)
962 :param is_classify: (Default value = 0)
963 :param is_multipath: (Default value = 0)
964 :param is_resolve_host: (Default value = 0)
965 :param is_resolve_attached: (Default value = 0)
966 :param is_dvr: (Default value = 0)
967 :param is_source_lookup: (Default value = 0)
968 :param next_hop_weight: (Default value = 1)
973 self.papi.ip_add_del_route,
974 {'next_hop_sw_if_index': next_hop_sw_if_index,
975 'table_id': table_id,
976 'classify_table_index': classify_table_index,
977 'next_hop_table_id': next_hop_table_id,
980 'is_unreach': is_unreach,
981 'is_prohibit': is_prohibit,
983 'is_local': is_local,
984 'is_classify': is_classify,
985 'is_multipath': is_multipath,
986 'is_resolve_host': is_resolve_host,
987 'is_resolve_attached': is_resolve_attached,
989 'is_source_lookup': is_source_lookup,
990 'is_udp_encap': is_udp_encap,
991 'next_hop_weight': next_hop_weight,
992 'dst_address_length': dst_address_length,
993 'dst_address': dst_address,
994 'next_hop_id': next_hop_id,
995 'next_hop_address': next_hop_address,
996 'next_hop_n_out_labels': next_hop_n_out_labels,
997 'next_hop_via_label': next_hop_via_label,
998 'next_hop_out_label_stack': next_hop_out_label_stack})
1000 def ip_fib_dump(self):
1001 return self.api(self.papi.ip_fib_dump, {})
1003 def ip6_fib_dump(self):
1004 return self.api(self.papi.ip6_fib_dump, {})
1006 def ip_neighbor_add_del(self,
1015 """ Add neighbor MAC to IPv4 or IPv6 address.
1020 :param is_add: (Default value = 1)
1021 :param is_ipv6: (Default value = 0)
1022 :param is_static: (Default value = 0)
1023 :param is_no_adj_fib: (Default value = 0)
1026 self.papi.ip_neighbor_add_del,
1027 {'sw_if_index': sw_if_index,
1030 'is_static': is_static,
1031 'is_no_adj_fib': is_no_adj_fib,
1032 'mac_address': mac_address,
1033 'dst_address': dst_address
1037 def ip_neighbor_dump(self,
1040 """ Return IP neighbor dump.
1043 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1047 self.papi.ip_neighbor_dump,
1048 {'is_ipv6': is_ipv6,
1049 'sw_if_index': sw_if_index
1053 def proxy_arp_add_del(self,
1058 """ Config Proxy Arp Range.
1060 :param low_address: Start address in the rnage to Proxy for
1061 :param hi_address: End address in the rnage to Proxy for
1062 :param vrf_id: The VRF/table in which to proxy
1066 self.papi.proxy_arp_add_del,
1070 'low_address': low_address,
1071 'hi_address': hi_address,
1075 def proxy_arp_intfc_enable_disable(self,
1078 """ Enable/Disable an interface for proxy ARP requests
1080 :param sw_if_index: Interface
1081 :param enable_disable: Enable/Disable
1085 self.papi.proxy_arp_intfc_enable_disable,
1086 {'sw_if_index': sw_if_index,
1087 'enable_disable': is_enable
1095 """ Reset VRF (remove all routes etc.) request.
1097 :param int vrf_id: ID of the FIB table / VRF to reset.
1098 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1102 self.papi.reset_vrf,
1112 """ Reset VRF (remove all routes etc.) request.
1114 :param int vrf_id: ID of the FIB table / VRF to reset.
1115 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1119 self.papi.reset_fib,
1130 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1135 {'is_ipv6': is_ipv6,
1139 def sw_interface_span_enable_disable(
1140 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1143 :param sw_if_index_from:
1144 :param sw_if_index_to:
1148 return self.api(self.papi.sw_interface_span_enable_disable,
1149 {'sw_if_index_from': sw_if_index_from,
1150 'sw_if_index_to': sw_if_index_to,
1155 def gre_tunnel_add_del(self,
1160 instance=0xFFFFFFFF,
1164 """ Add a GRE tunnel
1168 :param outer_fib_id: (Default value = 0)
1169 :param tunnel_type: (Default value = 0)
1170 :param instance: (Default value = 0xFFFFFFFF)
1171 :param session_id: (Defalt value = 0)
1172 :param is_add: (Default value = 1)
1173 :param is_ipv6: (Default value = 0)
1177 self.papi.gre_add_del_tunnel,
1180 'tunnel_type': tunnel_type,
1181 'instance': instance,
1182 'src_address': src_address,
1183 'dst_address': dst_address,
1184 'outer_fib_id': outer_fib_id,
1185 'session_id': session_id}
1188 def udp_encap_add(self,
1194 """ Add a GRE tunnel
1199 :param outer_fib_id: (Default value = 0)
1203 self.papi.udp_encap_add,
1208 'src_port': src_port,
1209 'dst_port': dst_port,
1210 'table_id': table_id
1214 def udp_encap_del(self, id):
1215 return self.api(self.papi.udp_encap_del, {'id': id})
1217 def udp_encap_dump(self):
1218 return self.api(self.papi.udp_encap_dump, {})
1220 def want_udp_encap_stats(self, enable=1):
1221 return self.api(self.papi.want_udp_encap_stats,
1223 'pid': os.getpid()})
1225 def mpls_fib_dump(self):
1226 return self.api(self.papi.mpls_fib_dump, {})
1228 def mpls_table_add_del(
1235 :param is_add: (Default value = 1)
1240 self.papi.mpls_table_add_del,
1241 {'mt_table_id': table_id,
1242 'mt_is_add': is_add})
1244 def mpls_route_add_del(
1250 next_hop_sw_if_index=0xFFFFFFFF,
1252 next_hop_table_id=0,
1254 next_hop_n_out_labels=0,
1255 next_hop_out_label_stack=[],
1256 next_hop_via_label=MPLS_LABEL_INVALID,
1258 is_resolve_attached=0,
1265 classify_table_index=0xFFFFFFFF,
1269 :param dst_address_length:
1270 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1272 :param next_hop_address:
1273 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1274 :param vrf_id: (Default value = 0)
1275 :param lookup_in_vrf: (Default value = 0)
1276 :param classify_table_index: (Default value = 0xFFFFFFFF)
1277 :param is_add: (Default value = 1)
1278 :param is_drop: (Default value = 0)
1279 :param is_ipv6: (Default value = 0)
1280 :param is_local: (Default value = 0)
1281 :param is_classify: (Default value = 0)
1282 :param is_multipath: (Default value = 0)
1283 :param is_multicast: (Default value = 0)
1284 :param is_resolve_host: (Default value = 0)
1285 :param is_resolve_attached: (Default value = 0)
1286 :param next_hop_weight: (Default value = 1)
1290 self.papi.mpls_route_add_del,
1293 'mr_table_id': table_id,
1294 'mr_classify_table_index': classify_table_index,
1295 'mr_is_add': is_add,
1296 'mr_is_classify': is_classify,
1297 'mr_is_multipath': is_multipath,
1298 'mr_is_multicast': is_multicast,
1299 'mr_is_resolve_host': is_resolve_host,
1300 'mr_is_resolve_attached': is_resolve_attached,
1301 'mr_is_interface_rx': is_interface_rx,
1302 'mr_is_rpf_id': is_rpf_id,
1303 'mr_next_hop_proto': next_hop_proto,
1304 'mr_next_hop_weight': next_hop_weight,
1305 'mr_next_hop': next_hop_address,
1306 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1307 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1308 'mr_next_hop_table_id': next_hop_table_id,
1309 'mr_next_hop_via_label': next_hop_via_label,
1310 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1312 def mpls_ip_bind_unbind(
1324 self.papi.mpls_ip_bind_unbind,
1325 {'mb_mpls_table_id': table_id,
1327 'mb_ip_table_id': ip_table_id,
1328 'mb_is_bind': is_bind,
1329 'mb_is_ip4': is_ip4,
1330 'mb_address_length': dst_address_length,
1331 'mb_address': dst_address})
1333 def mpls_tunnel_add_del(
1336 next_hop_proto_is_ip4,
1338 next_hop_sw_if_index=0xFFFFFFFF,
1339 next_hop_table_id=0,
1341 next_hop_n_out_labels=0,
1342 next_hop_out_label_stack=[],
1343 next_hop_via_label=MPLS_LABEL_INVALID,
1349 :param dst_address_length:
1350 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1352 :param next_hop_address:
1353 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1354 :param vrf_id: (Default value = 0)
1355 :param lookup_in_vrf: (Default value = 0)
1356 :param classify_table_index: (Default value = 0xFFFFFFFF)
1357 :param is_add: (Default value = 1)
1358 :param is_drop: (Default value = 0)
1359 :param is_ipv6: (Default value = 0)
1360 :param is_local: (Default value = 0)
1361 :param is_classify: (Default value = 0)
1362 :param is_multipath: (Default value = 0)
1363 :param is_resolve_host: (Default value = 0)
1364 :param is_resolve_attached: (Default value = 0)
1365 :param next_hop_weight: (Default value = 1)
1366 :param is_multicast: (Default value = 0)
1370 self.papi.mpls_tunnel_add_del,
1371 {'mt_sw_if_index': tun_sw_if_index,
1372 'mt_is_add': is_add,
1373 'mt_l2_only': l2_only,
1374 'mt_is_multicast': is_multicast,
1375 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1376 'mt_next_hop_weight': next_hop_weight,
1377 'mt_next_hop': next_hop_address,
1378 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1379 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1380 'mt_next_hop_table_id': next_hop_table_id,
1381 'mt_next_hop_via_label': next_hop_via_label,
1382 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1384 def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
1385 return self.api(self.papi.mpls_tunnel_dump,
1386 {'sw_if_index': sw_if_index})
1388 def nat44_interface_add_del_feature(
1393 """Enable/disable NAT44 feature on the interface
1395 :param sw_if_index: Software index of the interface
1396 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1397 :param is_add: 1 if add, 0 if delete (Default value = 1)
1400 self.papi.nat44_interface_add_del_feature,
1402 'is_inside': is_inside,
1403 'sw_if_index': sw_if_index})
1405 def nat44_interface_add_del_output_feature(
1410 """Enable/disable NAT44 output feature on the interface
1412 :param sw_if_index: Software index of the interface
1413 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1414 :param is_add: 1 if add, 0 if delete (Default value = 1)
1417 self.papi.nat44_interface_add_del_output_feature,
1419 'is_inside': is_inside,
1420 'sw_if_index': sw_if_index})
1422 def nat44_add_del_static_mapping(
1426 external_sw_if_index=0xFFFFFFFF,
1437 """Add/delete NAT44 static mapping
1439 :param local_ip: Local IP address
1440 :param external_ip: External IP address
1441 :param external_sw_if_index: External interface instead of IP address
1442 :param local_port: Local port number (Default value = 0)
1443 :param external_port: External port number (Default value = 0)
1444 :param addr_only: 1 if address only mapping, 0 if address and port
1445 :param vrf_id: VRF ID
1446 :param protocol: IP protocol (Default value = 0)
1447 :param twice_nat: 1 if translate external host address and port
1448 :param self_twice_nat: 1 if translate external host address and port
1449 whenever external host address equals
1450 local address of internal host
1451 :param out2in_only: if 1 rule is matching only out2in direction
1452 :param tag: Opaque string tag
1453 :param is_add: 1 if add, 0 if delete (Default value = 1)
1456 self.papi.nat44_add_del_static_mapping,
1458 'addr_only': addr_only,
1459 'local_ip_address': local_ip,
1460 'external_ip_address': external_ip,
1461 'local_port': local_port,
1462 'external_port': external_port,
1463 'external_sw_if_index': external_sw_if_index,
1465 'protocol': protocol,
1466 'twice_nat': twice_nat,
1467 'self_twice_nat': self_twice_nat,
1468 'out2in_only': out2in_only,
1471 def nat44_add_del_identity_mapping(
1474 sw_if_index=0xFFFFFFFF,
1481 """Add/delete NAT44 identity mapping
1483 :param ip: IP address (Default value = 0)
1484 :param sw_if_index: Interface instead of IP address
1485 :param port: Port number (Default value = 0)
1486 :param addr_only: 1 if address only mapping, 0 if address and port
1487 :param vrf_id: VRF ID
1488 :param protocol: IP protocol (Default value = 0)
1489 :param tag: Opaque string tag
1490 :param is_add: 1 if add, 0 if delete (Default value = 1)
1493 self.papi.nat44_add_del_identity_mapping,
1495 'addr_only': addr_only,
1498 'sw_if_index': sw_if_index,
1501 'protocol': protocol})
1503 def nat44_add_del_address_range(
1510 """Add/del NAT44 address range
1512 :param first_ip_address: First IP address
1513 :param last_ip_address: Last IP address
1514 :param vrf_id: VRF id for the address range
1515 :param twice_nat: twice NAT address for extenal hosts
1516 :param is_add: 1 if add, 0 if delete (Default value = 1)
1519 self.papi.nat44_add_del_address_range,
1520 {'first_ip_address': first_ip_address,
1521 'last_ip_address': last_ip_address,
1523 'twice_nat': twice_nat,
1526 def nat44_address_dump(self):
1527 """Dump NAT44 addresses
1528 :return: Dictionary of NAT44 addresses
1530 return self.api(self.papi.nat44_address_dump, {})
1532 def nat44_interface_dump(self):
1533 """Dump interfaces with NAT44 feature
1534 :return: Dictionary of interfaces with NAT44 feature
1536 return self.api(self.papi.nat44_interface_dump, {})
1538 def nat44_interface_output_feature_dump(self):
1539 """Dump interfaces with NAT44 output feature
1540 :return: Dictionary of interfaces with NAT44 output feature
1542 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1544 def nat44_static_mapping_dump(self):
1545 """Dump NAT44 static mappings
1546 :return: Dictionary of NAT44 static mappings
1548 return self.api(self.papi.nat44_static_mapping_dump, {})
1550 def nat44_identity_mapping_dump(self):
1551 """Dump NAT44 identity mappings
1552 :return: Dictionary of NAT44 identity mappings
1554 return self.api(self.papi.nat44_identity_mapping_dump, {})
1556 def nat_show_config(self):
1557 """Show NAT plugin config
1558 :return: NAT plugin config parameters
1560 return self.api(self.papi.nat_show_config, {})
1562 def nat44_add_interface_addr(
1567 """Add/del NAT44 address from interface
1569 :param sw_if_index: Software index of the interface
1570 :param twice_nat: twice NAT address for extenal hosts
1571 :param is_add: 1 if add, 0 if delete (Default value = 1)
1574 self.papi.nat44_add_del_interface_addr,
1576 'sw_if_index': sw_if_index,
1577 'twice_nat': twice_nat})
1579 def nat44_interface_addr_dump(self):
1580 """Dump NAT44 addresses interfaces
1581 :return: Dictionary of NAT44 addresses interfaces
1583 return self.api(self.papi.nat44_interface_addr_dump, {})
1590 """Enable/disable NAT IPFIX logging
1592 :param domain_id: Observation domain ID (Default value = 1)
1593 :param src_port: Source port number (Default value = 4739)
1594 :param enable: 1 if enable, 0 if disable (Default value = 1)
1597 self.papi.nat_ipfix_enable_disable,
1598 {'domain_id': domain_id,
1599 'src_port': src_port,
1602 def nat44_user_session_dump(
1606 """Dump NAT44 user's sessions
1608 :param ip_address: ip adress of the user to be dumped
1609 :param cpu_index: cpu_index on which the user is
1610 :param vrf_id: VRF ID
1611 :return: Dictionary of S-NAT sessions
1614 self.papi.nat44_user_session_dump,
1615 {'ip_address': ip_address,
1618 def nat44_user_dump(self):
1621 :return: Dictionary of NAT44 users
1623 return self.api(self.papi.nat44_user_dump, {})
1625 def nat44_add_del_lb_static_mapping(
1638 """Add/delete NAT44 load balancing static mapping
1640 :param twice_nat: 1 if translate external host address and port
1641 :param tag: Opaque string tag
1642 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1643 :param is_add - 1 if add, 0 if delete
1646 self.papi.nat44_add_del_lb_static_mapping,
1648 'external_addr': external_addr,
1649 'external_port': external_port,
1650 'protocol': protocol,
1651 'twice_nat': twice_nat,
1652 'self_twice_nat': self_twice_nat,
1653 'out2in_only': out2in_only,
1655 'affinity': affinity,
1656 'local_num': local_num,
1659 def nat44_lb_static_mapping_add_del_local(
1669 """Add/delete NAT44 load-balancing static mapping rule backend
1671 :param external_addr: external IPv4 address of the servic
1672 :param external_port: external L4 port number of the service
1673 :param local_addr: IPv4 address of the internal node
1674 :param local_port: L4 port number of the internal node
1675 :param protocol: IP protocol number
1676 :param probability: probability of the internal node
1677 :param vrf_id: VRF id of the internal node
1678 :param is_add: 1 if add, 0 if delete
1681 self.papi.nat44_lb_static_mapping_add_del_local,
1683 'external_addr': external_addr,
1684 'external_port': external_port,
1688 'probability': probability,
1690 'protocol': protocol})
1692 def nat44_lb_static_mapping_dump(self):
1693 """Dump NAT44 load balancing static mappings
1695 :return: Dictionary of NAT44 load balancing static mapping
1697 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1699 def nat44_del_session(
1706 ext_host_address=None,
1708 """Delete NAT44 session
1710 :param addr: IPv4 address
1711 :param por: port number
1712 :param protocol: IP protocol number
1713 :param vrf_id: VRF ID
1714 :param is_in: 1 if inside network addres and port pari, 0 if outside
1715 :param ext_host_address: external host IPv4 address
1716 :param ext_host_port: external host port
1718 if ext_host_address is None:
1720 self.papi.nat44_del_session,
1723 'protocol': protocol,
1728 self.papi.nat44_del_session,
1731 'protocol': protocol,
1734 'ext_host_valid': 1,
1735 'ext_host_address': ext_host_address,
1736 'ext_host_port': ext_host_port})
1738 def nat44_forwarding_enable_disable(
1741 """Enable/disable forwarding for NAT44
1743 :param enable: 1 for enable, 0 for disable
1746 self.papi.nat44_forwarding_enable_disable,
1756 """Set NAT virtual fragmentation reassembly
1758 :param timeout: reassembly timeout (Default 2sec)
1759 :param max_reass: maximum concurrent reassemblies (Default 1024)
1760 :param max_frag: maximum fragmets per reassembly (Default 5)
1761 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1762 :param is_ip6: 1 if IPv6, 0 if IPv4
1765 self.papi.nat_set_reass,
1766 {'timeout': timeout,
1767 'max_reass': max_reass,
1768 'max_frag': max_frag,
1769 'drop_frag': drop_frag,
1772 def nat_get_reass(self):
1773 """Get NAT virtual fragmentation reassembly configuration
1775 :return: NAT virtual fragmentation reassembly configuration
1777 return self.api(self.papi.nat_get_reass, {})
1779 def nat_reass_dump(self):
1780 """Dump NAT virtual fragmentation reassemblies
1782 :return: Dictionary of NAT virtual fragmentation reassemblies
1784 return self.api(self.papi.nat_reass_dump, {})
1786 def nat_det_add_del_map(
1793 """Add/delete deterministic NAT mapping
1795 :param is_add - 1 if add, 0 if delete
1796 :param in_addr - inside IP address
1797 :param in_plen - inside IP address prefix length
1798 :param out_addr - outside IP address
1799 :param out_plen - outside IP address prefix length
1802 self.papi.nat_det_add_del_map,
1807 'out_addr': out_addr,
1808 'out_plen': out_plen})
1810 def nat_det_forward(
1813 """Get outside address and port range from inside address
1815 :param in_addr - inside IP address
1818 self.papi.nat_det_forward,
1819 {'in_addr': in_addr,
1822 def nat_det_reverse(
1826 """Get inside address from outside address and port
1828 :param out_addr - outside IP address
1829 :param out_port - outside port
1832 self.papi.nat_det_reverse,
1833 {'out_addr': out_addr,
1834 'out_port': out_port})
1836 def nat_det_map_dump(self):
1837 """Dump deterministic NAT mappings
1839 :return: Dictionary of deterministic NAT mappings
1841 return self.api(self.papi.nat_det_map_dump, {})
1843 def nat_set_timeouts(
1846 tcp_established=7440,
1849 """Set values of timeouts for NAT sessions (in seconds)
1851 :param udp - UDP timeout (Default value = 300)
1852 :param tcp_established - TCP established timeout (Default value = 7440)
1853 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1854 :param icmp - ICMP timeout (Default value = 60)
1857 self.papi.nat_set_timeouts,
1859 'tcp_established': tcp_established,
1860 'tcp_transitory': tcp_transitory,
1863 def nat_get_timeouts(self):
1864 """Get values of timeouts for NAT sessions
1866 :return: Timeouts for NAT sessions (in seconds)
1868 return self.api(self.papi.nat_get_timeouts, {})
1870 def nat_set_addr_and_port_alloc_alg(
1878 """Set address and port assignment algorithm
1880 :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1881 :param psid_offset: number of offset bits (valid only for MAP-E alg)
1882 :param psid_length: length of PSID (valid only for MAP-E alg)
1883 :param psid: Port Set Identifier value (valid only for MAP-E alg)
1884 :param start_port: beginning of the port range
1885 :param end_port: end of the port range
1888 self.papi.nat_set_addr_and_port_alloc_alg,
1890 'psid_offset': psid_offset,
1891 'psid_length': psid_length,
1893 'start_port': start_port,
1894 'end_port': end_port})
1896 def nat_get_addr_and_port_alloc_alg(self):
1897 """Get address and port assignment algorithm"""
1898 return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1900 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1901 """Set TCP MSS rewriting configuration
1903 :param enable: disable(0)/enable(1) MSS rewriting feature
1904 :param mss_value: MSS value to be used for MSS rewriting
1907 self.papi.nat_set_mss_clamping,
1908 {'enable': enable, 'mss_value': mss_value})
1910 def nat_get_mss_clamping(self):
1911 """Get TCP MSS rewriting configuration"""
1912 return self.api(self.papi.nat_get_mss_clamping, {})
1914 def nat_det_close_session_out(
1920 """Close deterministic NAT session using outside address and port
1922 :param out_addr - outside IP address
1923 :param out_port - outside port
1924 :param ext_addr - external host IP address
1925 :param ext_port - external host port
1928 self.papi.nat_det_close_session_out,
1929 {'out_addr': out_addr,
1930 'out_port': out_port,
1931 'ext_addr': ext_addr,
1932 'ext_port': ext_port})
1934 def nat_det_close_session_in(
1940 """Close deterministic NAT session using inside address and port
1942 :param in_addr - inside IP address
1943 :param in_port - inside port
1944 :param ext_addr - external host IP address
1945 :param ext_port - external host port
1948 self.papi.nat_det_close_session_in,
1949 {'in_addr': in_addr,
1951 'ext_addr': ext_addr,
1952 'ext_port': ext_port,
1955 def nat_det_session_dump(
1958 """Dump deterministic NAT sessions belonging to a user
1960 :param user_addr - inside IP address of the user
1961 :return: Dictionary of deterministic NAT sessions
1964 self.papi.nat_det_session_dump,
1966 'user_addr': user_addr})
1968 def nat64_add_del_pool_addr_range(
1974 """Add/del address range to NAT64 pool
1976 :param start_addr: First IP address
1977 :param end_addr: Last IP address
1978 :param vrf_id: VRF id for the address range
1979 :param is_add: 1 if add, 0 if delete (Default value = 1)
1982 self.papi.nat64_add_del_pool_addr_range,
1983 {'start_addr': start_addr,
1984 'end_addr': end_addr,
1988 def nat64_pool_addr_dump(self):
1989 """Dump NAT64 pool addresses
1990 :return: Dictionary of NAT64 pool addresses
1992 return self.api(self.papi.nat64_pool_addr_dump, {})
1994 def nat64_add_del_interface(
1999 """Enable/disable NAT64 feature on the interface
2000 :param sw_if_index: Index of the interface
2001 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2002 :param is_add: 1 if add, 0 if delete (Default value = 1)
2005 self.papi.nat64_add_del_interface,
2006 {'sw_if_index': sw_if_index,
2007 'is_inside': is_inside,
2010 def nat64_interface_dump(self):
2011 """Dump interfaces with NAT64 feature
2012 :return: Dictionary of interfaces with NAT64 feature
2014 return self.api(self.papi.nat64_interface_dump, {})
2016 def nat64_add_del_static_bib(
2025 """Add/delete S-NAT static BIB entry
2027 :param in_ip: Inside IPv6 address
2028 :param out_ip: Outside IPv4 address
2029 :param in_port: Inside port number
2030 :param out_port: Outside port number
2031 :param protocol: IP protocol
2032 :param vrf_id: VRF ID (Default value = 0)
2033 :param is_add: 1 if add, 0 if delete (Default value = 1)
2036 self.papi.nat64_add_del_static_bib,
2045 def nat64_bib_dump(self, protocol=255):
2048 :param protocol: IP protocol (Default value = 255, all BIBs)
2049 :returns: Dictionary of NAT64 BIB entries
2051 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
2053 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
2054 tcp_incoming_syn=6):
2055 """Set values of timeouts for NAT64 (in seconds)
2057 :param udpi: UDP timeout (Default value = 300)
2058 :param icmp: ICMP timeout (Default value = 60)
2059 :param tcp_trans: TCP transitory timeout (Default value = 240)
2060 :param tcp_est: TCP established timeout (Default value = 7440)
2061 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
2064 self.papi.nat64_set_timeouts,
2067 'tcp_trans': tcp_trans,
2069 'tcp_incoming_syn': tcp_incoming_syn})
2071 def nat64_get_timeouts(self):
2072 """Get values of timeouts for NAT64
2074 :return: Timeouts for NAT64 (in seconds)
2076 return self.api(self.papi.nat64_get_timeouts, {})
2078 def nat64_st_dump(self, protocol=255):
2079 """Dump NAT64 session table
2081 :param protocol: IP protocol (Default value = 255, all STs)
2082 :returns: Dictionary of NAT64 sesstion table entries
2084 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2086 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2087 """Add/del NAT64 prefix
2089 :param prefix: NAT64 prefix
2090 :param plen: NAT64 prefix length
2091 :param vrf_id: VRF id of tenant (Default 0)
2092 :param is_add: 1 if add, 0 if delete (Default value = 1)
2095 self.papi.nat64_add_del_prefix,
2101 def nat64_prefix_dump(self):
2102 """Dump NAT64 prefix
2104 :returns: Dictionary of NAT64 prefixes
2106 return self.api(self.papi.nat64_prefix_dump, {})
2108 def nat64_add_interface_addr(
2112 """Add/del NAT64 address from interface
2114 :param sw_if_index: Software index of the interface
2115 :param is_add: 1 if add, 0 if delete (Default value = 1)
2117 return self.api(self.papi.nat64_add_del_interface_addr,
2118 {'is_add': is_add, 'sw_if_index': sw_if_index})
2120 def dslite_set_aftr_addr(self, ip6, ip4):
2121 """Set DS-Lite AFTR addresses
2123 :param ip4: IPv4 address
2124 :param ip6: IPv6 address
2127 self.papi.dslite_set_aftr_addr,
2131 def dslite_set_b4_addr(self, ip6, ip4):
2132 """Set DS-Lite B4 IPv6 address
2134 :param ip4: IPv4 address
2135 :param ip6: IPv6 address
2138 self.papi.dslite_set_b4_addr,
2142 def dslite_add_del_pool_addr_range(
2147 """Add/del address range to DS-Lite pool
2149 :param start_addr: First IP address
2150 :param end_addr: Last IP address
2151 :param is_add: 1 if add, 0 if delete (Default value = 1)
2154 self.papi.dslite_add_del_pool_addr_range,
2155 {'start_addr': start_addr,
2156 'end_addr': end_addr,
2159 def nat66_add_del_interface(
2164 """Enable/disable NAT66 feature on the interface
2165 :param sw_if_index: Index of the interface
2166 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2167 :param is_add: 1 if add, 0 if delete (Default value = 1)
2170 self.papi.nat66_add_del_interface,
2171 {'sw_if_index': sw_if_index,
2172 'is_inside': is_inside,
2175 def nat66_add_del_static_mapping(
2181 """Add/delete NAT66 static mapping
2183 :param in_ip: Inside IPv6 address
2184 :param out_ip: Outside IPv6 address
2185 :param vrf_id: VRF ID (Default value = 0)
2186 :param is_add: 1 if add, 0 if delete (Default value = 1)
2189 self.papi.nat66_add_del_static_mapping,
2190 {'local_ip_address': in_ip,
2191 'external_ip_address': out_ip,
2195 def nat66_interface_dump(self):
2196 """Dump interfaces with NAT66 feature
2197 :return: Dictionary of interfaces with NAT66 feature
2199 return self.api(self.papi.nat66_interface_dump, {})
2201 def nat66_static_mapping_dump(self):
2202 """Dump NAT66 static mappings
2203 :return: Dictionary of NAT66 static mappings
2205 return self.api(self.papi.nat66_static_mapping_dump, {})
2207 def control_ping(self):
2208 self.api(self.papi.control_ping)
2210 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2211 detect_mult, local_addr, peer_addr, is_ipv6=0,
2212 bfd_key_id=None, conf_key_id=None):
2213 if bfd_key_id is None:
2214 return self.api(self.papi.bfd_udp_add,
2216 'sw_if_index': sw_if_index,
2217 'desired_min_tx': desired_min_tx,
2218 'required_min_rx': required_min_rx,
2219 'local_addr': local_addr,
2220 'peer_addr': peer_addr,
2222 'detect_mult': detect_mult,
2225 return self.api(self.papi.bfd_udp_add,
2227 'sw_if_index': sw_if_index,
2228 'desired_min_tx': desired_min_tx,
2229 'required_min_rx': required_min_rx,
2230 'local_addr': local_addr,
2231 'peer_addr': peer_addr,
2233 'detect_mult': detect_mult,
2234 'is_authenticated': 1,
2235 'bfd_key_id': bfd_key_id,
2236 'conf_key_id': conf_key_id,
2239 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2240 detect_mult, local_addr, peer_addr, is_ipv6=0):
2241 return self.api(self.papi.bfd_udp_mod,
2243 'sw_if_index': sw_if_index,
2244 'desired_min_tx': desired_min_tx,
2245 'required_min_rx': required_min_rx,
2246 'local_addr': local_addr,
2247 'peer_addr': peer_addr,
2249 'detect_mult': detect_mult,
2252 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2253 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2255 return self.api(self.papi.bfd_udp_auth_activate,
2257 'sw_if_index': sw_if_index,
2258 'local_addr': local_addr,
2259 'peer_addr': peer_addr,
2261 'is_delayed': 1 if is_delayed else 0,
2262 'bfd_key_id': bfd_key_id,
2263 'conf_key_id': conf_key_id,
2266 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2267 is_ipv6=0, is_delayed=False):
2268 return self.api(self.papi.bfd_udp_auth_deactivate,
2270 'sw_if_index': sw_if_index,
2271 'local_addr': local_addr,
2272 'peer_addr': peer_addr,
2274 'is_delayed': 1 if is_delayed else 0,
2277 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2278 return self.api(self.papi.bfd_udp_del,
2280 'sw_if_index': sw_if_index,
2281 'local_addr': local_addr,
2282 'peer_addr': peer_addr,
2286 def bfd_udp_session_dump(self):
2287 return self.api(self.papi.bfd_udp_session_dump, {})
2289 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2290 peer_addr, is_ipv6=0):
2291 return self.api(self.papi.bfd_udp_session_set_flags, {
2292 'admin_up_down': admin_up_down,
2293 'sw_if_index': sw_if_index,
2294 'local_addr': local_addr,
2295 'peer_addr': peer_addr,
2299 def want_bfd_events(self, enable_disable=1):
2300 return self.api(self.papi.want_bfd_events, {
2301 'enable_disable': enable_disable,
2305 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2306 return self.api(self.papi.bfd_auth_set_key, {
2307 'conf_key_id': conf_key_id,
2308 'auth_type': auth_type,
2310 'key_len': len(key),
2313 def bfd_auth_del_key(self, conf_key_id):
2314 return self.api(self.papi.bfd_auth_del_key, {
2315 'conf_key_id': conf_key_id,
2318 def bfd_auth_keys_dump(self):
2319 return self.api(self.papi.bfd_auth_keys_dump, {})
2321 def bfd_udp_set_echo_source(self, sw_if_index):
2322 return self.api(self.papi.bfd_udp_set_echo_source,
2323 {'sw_if_index': sw_if_index})
2325 def bfd_udp_del_echo_source(self):
2326 return self.api(self.papi.bfd_udp_del_echo_source, {})
2328 def bfd_udp_get_echo_source(self):
2329 return self.api(self.papi.bfd_udp_get_echo_source, {})
2331 def classify_add_del_table(
2336 table_index=0xFFFFFFFF,
2338 memory_size=2097152,
2340 next_table_index=0xFFFFFFFF,
2341 miss_next_index=0xFFFFFFFF,
2342 current_data_flag=0,
2343 current_data_offset=0):
2347 :param match_n_vectors: (Default value = 1)
2348 :param table_index: (Default value = 0xFFFFFFFF)
2349 :param nbuckets: (Default value = 2)
2350 :param memory_size: (Default value = 2097152)
2351 :param skip_n_vectors: (Default value = 0)
2352 :param next_table_index: (Default value = 0xFFFFFFFF)
2353 :param miss_next_index: (Default value = 0xFFFFFFFF)
2354 :param current_data_flag: (Default value = 0)
2355 :param current_data_offset: (Default value = 0)
2358 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2359 mask = mask + '\0' * (mask_len - len(mask))
2361 self.papi.classify_add_del_table,
2363 'table_index': table_index,
2364 'nbuckets': nbuckets,
2365 'memory_size': memory_size,
2366 'skip_n_vectors': skip_n_vectors,
2367 'match_n_vectors': match_n_vectors,
2368 'next_table_index': next_table_index,
2369 'miss_next_index': miss_next_index,
2370 'current_data_flag': current_data_flag,
2371 'current_data_offset': current_data_offset,
2372 'mask_len': mask_len,
2375 def classify_add_del_session(
2380 opaque_index=0xFFFFFFFF,
2381 hit_next_index=0xFFFFFFFF,
2389 :param opaque_index: (Default value = 0xFFFFFFFF)
2390 :param hit_next_index: (Default value = 0xFFFFFFFF)
2391 :param advance: (Default value = 0)
2392 :param action: (Default value = 0)
2393 :param metadata: (Default value = 0)
2396 match_len = ((len(match) - 1) / 16 + 1) * 16
2397 match = match + '\0' * (match_len - len(match))
2399 self.papi.classify_add_del_session,
2401 'table_index': table_index,
2402 'hit_next_index': hit_next_index,
2403 'opaque_index': opaque_index,
2406 'metadata': metadata,
2407 'match_len': match_len,
2410 def input_acl_set_interface(
2414 ip4_table_index=0xFFFFFFFF,
2415 ip6_table_index=0xFFFFFFFF,
2416 l2_table_index=0xFFFFFFFF):
2420 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2421 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2422 :param l2_table_index: (Default value = 0xFFFFFFFF)
2426 self.papi.input_acl_set_interface,
2427 {'sw_if_index': sw_if_index,
2428 'ip4_table_index': ip4_table_index,
2429 'ip6_table_index': ip6_table_index,
2430 'l2_table_index': l2_table_index,
2433 def output_acl_set_interface(
2437 ip4_table_index=0xFFFFFFFF,
2438 ip6_table_index=0xFFFFFFFF,
2439 l2_table_index=0xFFFFFFFF):
2443 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2444 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2445 :param l2_table_index: (Default value = 0xFFFFFFFF)
2449 self.papi.output_acl_set_interface,
2450 {'sw_if_index': sw_if_index,
2451 'ip4_table_index': ip4_table_index,
2452 'ip6_table_index': ip6_table_index,
2453 'l2_table_index': l2_table_index,
2456 def set_ipfix_exporter(
2463 collector_port=4739,
2466 self.papi.set_ipfix_exporter,
2468 'collector_address': collector_address,
2469 'collector_port': collector_port,
2470 'src_address': src_address,
2472 'path_mtu': path_mtu,
2473 'template_interval': template_interval,
2474 'udp_checksum': udp_checksum,
2477 def dhcp_proxy_config(self,
2485 self.papi.dhcp_proxy_config,
2487 'rx_vrf_id': rx_table_id,
2488 'server_vrf_id': server_table_id,
2491 'dhcp_server': dhcp_server,
2492 'dhcp_src_address': dhcp_src_address,
2495 def dhcp_proxy_set_vss(self,
2504 self.papi.dhcp_proxy_set_vss,
2507 'vss_type': vss_type,
2508 'vpn_ascii_id': vpn_ascii_id,
2510 'vpn_index': vpn_index,
2515 def dhcp_client_dump(self):
2516 return self.api(self.papi.dhcp_client_dump, {})
2518 def dhcp_client(self,
2523 set_broadcast_flag=1,
2524 want_dhcp_events=0):
2526 self.papi.dhcp_client_config,
2530 'sw_if_index': sw_if_index,
2531 'hostname': hostname,
2533 'want_dhcp_event': want_dhcp_events,
2534 'set_broadcast_flag': set_broadcast_flag,
2538 def ip_mroute_add_del(self,
2544 next_hop_sw_if_index,
2554 IP Multicast Route add/del
2557 self.papi.ip_mroute_add_del,
2558 {'next_hop_sw_if_index': next_hop_sw_if_index,
2559 'entry_flags': e_flags,
2560 'itf_flags': i_flags,
2561 'table_id': table_id,
2565 'is_local': is_local,
2566 'bier_imp': bier_imp,
2567 'next_hop_afi': next_hop_afi,
2568 'grp_address_length': grp_address_length,
2569 'grp_address': grp_address,
2570 'src_address': src_address,
2571 'nh_address': next_hop_address})
2573 def mfib_signal_dump(self):
2574 return self.api(self.papi.mfib_signal_dump, {})
2576 def ip_mfib_dump(self):
2577 return self.api(self.papi.ip_mfib_dump, {})
2579 def ip6_mfib_dump(self):
2580 return self.api(self.papi.ip6_mfib_dump, {})
2582 def lisp_enable_disable(self, is_enabled):
2584 self.papi.lisp_enable_disable,
2586 'is_en': is_enabled,
2589 def lisp_locator_set(self,
2593 self.papi.lisp_add_del_locator_set,
2596 'locator_set_name': ls_name
2599 def lisp_locator_set_dump(self):
2600 return self.api(self.papi.lisp_locator_set_dump, {})
2602 def lisp_locator(self,
2609 self.papi.lisp_add_del_locator,
2612 'locator_set_name': ls_name,
2613 'sw_if_index': sw_if_index,
2614 'priority': priority,
2618 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2620 self.papi.lisp_locator_dump,
2622 'is_index_set': is_index_set,
2624 'ls_index': ls_index,
2627 def lisp_local_mapping(self,
2637 self.papi.lisp_add_del_local_eid,
2639 'locator_set_name': ls_name,
2641 'eid_type': eid_type,
2643 'prefix_len': prefix_len,
2649 def lisp_eid_table_dump(self,
2657 self.papi.lisp_eid_table_dump,
2660 'prefix_length': prefix_length,
2662 'eid_type': eid_type,
2664 'filter': filter_opt,
2667 def lisp_remote_mapping(self,
2677 self.papi.lisp_add_del_remote_mapping,
2680 'eid_type': eid_type,
2682 'eid_len': eid_prefix_len,
2683 'rloc_num': rlocs_num,
2686 'is_src_dst': is_src_dst,
2689 def lisp_adjacency(self,
2698 self.papi.lisp_add_del_adjacency,
2702 'eid_type': eid_type,
2705 'leid_len': leid_len,
2706 'reid_len': reid_len,
2709 def lisp_adjacencies_get(self, vni=0):
2711 self.papi.lisp_adjacencies_get,
2716 def map_add_domain(self,
2726 self.papi.map_add_domain,
2728 'ip6_prefix': ip6_prefix,
2729 'ip4_prefix': ip4_prefix,
2731 'ea_bits_len': ea_bits_len,
2732 'psid_offset': psid_offset,
2733 'psid_length': psid_length,
2737 def map_if_enable_disable(self, is_enable, sw_if_index, is_translation):
2739 self.papi.map_if_enable_disable,
2741 'is_enable': is_enable,
2742 'sw_if_index': sw_if_index,
2743 'is_translation': is_translation,
2746 def map_param_set_tcp(self, tcp_mss):
2748 self.papi.map_param_set_tcp,
2753 def gtpu_add_del_tunnel(
2759 mcast_sw_if_index=0xFFFFFFFF,
2761 decap_next_index=0xFFFFFFFF,
2765 :param is_add: (Default value = 1)
2766 :param is_ipv6: (Default value = 0)
2769 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2770 :param encap_vrf_id: (Default value = 0)
2771 :param decap_next_index: (Default value = 0xFFFFFFFF)
2772 :param teid: (Default value = 0)
2775 return self.api(self.papi.gtpu_add_del_tunnel,
2778 'src_address': src_addr,
2779 'dst_address': dst_addr,
2780 'mcast_sw_if_index': mcast_sw_if_index,
2781 'encap_vrf_id': encap_vrf_id,
2782 'decap_next_index': decap_next_index,
2785 def vxlan_gpe_add_del_tunnel(
2789 mcast_sw_if_index=0xFFFFFFFF,
2800 :param is_add: (Default value = 1)
2801 :param is_ipv6: (Default value = 0)
2802 :param encap_vrf_id: (Default value = 0)
2803 :param decap_vrf_id: (Default value = 0)
2804 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2805 :param protocol: (Default value = 3)
2806 :param vni: (Default value = 0)
2809 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2814 'mcast_sw_if_index': mcast_sw_if_index,
2815 'encap_vrf_id': encap_vrf_id,
2816 'decap_vrf_id': decap_vrf_id,
2817 'protocol': protocol,
2820 def vxlan_gbp_tunnel_add_del(
2824 mcast_sw_if_index=0xFFFFFFFF,
2829 instance=0xFFFFFFFF):
2834 :param is_add: (Default value = 1)
2835 :param is_ipv6: (Default value = 0)
2836 :param encap_table_id: (Default value = 0)
2837 :param decap_next_index: (Default value = 0xFFFFFFFF)
2838 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2839 :param vni: (Default value = 0)
2840 :param instance: (Default value = 0xFFFFFFFF)
2843 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2848 'mcast_sw_if_index': mcast_sw_if_index,
2849 'encap_table_id': encap_table_id,
2851 'instance': instance}})
2853 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2854 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2855 {'sw_if_index': sw_if_index,
2856 '_no_type_conversion': True})
2858 def pppoe_add_del_session(
2868 :param is_add: (Default value = 1)
2869 :param is_ipv6: (Default value = 0)
2871 :param session_id: (Default value = 0)
2873 :param decap_vrf_id: (Default value = 0)
2876 return self.api(self.papi.pppoe_add_del_session,
2879 'session_id': session_id,
2880 'client_ip': client_ip,
2881 'decap_vrf_id': decap_vrf_id,
2882 'client_mac': client_mac})
2884 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2885 return self.api(self.papi.sr_mpls_policy_add,
2889 'n_segments': len(segments),
2890 'segments': segments})
2892 def sr_mpls_policy_del(self, bsid):
2893 return self.api(self.papi.sr_mpls_policy_del,
2896 def sr_localsid_add_del(self,
2903 sw_if_index=0xFFFFFFFF,
2907 """ Add/del IPv6 SR local-SID.
2910 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2911 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2914 :param is_del: (Default value = 0)
2915 :param end_psp: (Default value = 0)
2916 :param sw_if_index: (Default value = 0xFFFFFFFF)
2917 :param vlan_index: (Default value = 0)
2918 :param fib_table: (Default value = 0)
2921 self.papi.sr_localsid_add_del,
2923 'localsid': localsid,
2925 'behavior': behavior,
2926 'sw_if_index': sw_if_index,
2927 'vlan_index': vlan_index,
2928 'fib_table': fib_table,
2929 'nh_addr4': nh_addr4,
2930 'nh_addr6': nh_addr6
2944 :param bsid_addr: bindingSID of the SR Policy
2945 :param weight: weight of the sid list. optional. (default: 1)
2946 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2948 :param type: type/behavior of the SR policy. (default or spray) \
2950 :param fib_table: VRF where to install the FIB entry for the BSID \
2952 :param n_segments: number of segments \
2954 :param segments: a vector of IPv6 address composing the segment list \
2958 self.papi.sr_policy_add,
2959 {'bsid_addr': bsid_addr,
2961 'is_encap': is_encap,
2963 'fib_table': fib_table,
2964 'n_segments': n_segments,
2965 'segments': segments
2974 :param bsid: bindingSID of the SR Policy
2975 :param sr_policy_index: index of the sr policy (default: 0)
2978 self.papi.sr_policy_del,
2979 {'bsid_addr': bsid_addr,
2980 'sr_policy_index': sr_policy_index
2983 def sr_steering_add_del(
2994 Steer traffic L2 and L3 traffic through a given SR policy
2996 :param is_del: delete or add
2997 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2998 :param sr_policy: is the index of the SR Policy (alt to bsid)
2999 :param table_id: is the VRF where to install the FIB entry for the BSID
3000 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
3001 :param mask_width: is the mask for L3 traffic type
3002 :param sw_if_index: is the incoming interface for L2 traffic
3003 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
3006 self.papi.sr_steering_add_del,
3008 'bsid_addr': bsid_addr,
3009 'sr_policy_index': sr_policy_index,
3010 'table_id': table_id,
3011 'prefix_addr': prefix_addr,
3012 'mask_width': mask_width,
3013 'sw_if_index': sw_if_index,
3014 'traffic_type': traffic_type
3017 def acl_add_replace(self, acl_index, r, tag='',
3019 """Add/replace an ACL
3020 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
3021 :param acl_rule r: ACL rules array.
3022 :param str tag: symbolic tag (description) for this ACL.
3023 :param int count: number of rules.
3025 return self.api(self.papi.acl_add_replace,
3026 {'acl_index': acl_index,
3030 expected_retval=expected_retval)
3032 def acl_del(self, acl_index, expected_retval=0):
3038 return self.api(self.papi.acl_del,
3039 {'acl_index': acl_index},
3040 expected_retval=expected_retval)
3042 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
3044 return self.api(self.papi.acl_interface_set_acl_list,
3045 {'sw_if_index': sw_if_index,
3049 expected_retval=expected_retval)
3051 def acl_interface_set_etype_whitelist(self, sw_if_index,
3054 return self.api(self.papi.acl_interface_set_etype_whitelist,
3055 {'sw_if_index': sw_if_index,
3056 'count': len(whitelist),
3058 'whitelist': whitelist},
3059 expected_retval=expected_retval)
3061 def acl_interface_add_del(self,
3065 """ Add/Delete ACL to/from interface
3069 :param is_add: (Default value = 1)
3072 return self.api(self.papi.acl_interface_add_del,
3075 'sw_if_index': sw_if_index,
3076 'acl_index': acl_index})
3078 def acl_dump(self, acl_index, expected_retval=0):
3079 return self.api(self.papi.acl_dump,
3080 {'acl_index': acl_index},
3081 expected_retval=expected_retval)
3083 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3085 return self.api(self.papi.acl_interface_list_dump,
3086 {'sw_if_index': sw_if_index},
3087 expected_retval=expected_retval)
3089 def macip_acl_add(self, rules, tag=""):
3092 :param rules: list of rules for given acl
3096 return self.api(self.papi.macip_acl_add,
3098 'count': len(rules),
3101 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3104 :param rules: list of rules for given acl
3108 return self.api(self.papi.macip_acl_add_replace,
3109 {'acl_index': acl_index,
3111 'count': len(rules),
3114 def macip_acl_del(self, acl_index):
3120 return self.api(self.papi.macip_acl_del,
3121 {'acl_index': acl_index})
3123 def macip_acl_interface_add_del(self,
3127 """ Add MACIP acl to interface
3131 :param is_add: (Default value = 1)
3134 return self.api(self.papi.macip_acl_interface_add_del,
3136 'sw_if_index': sw_if_index,
3137 'acl_index': acl_index})
3139 def macip_acl_interface_get(self):
3140 """ Return interface acls dump
3143 self.papi.macip_acl_interface_get, {})
3145 def macip_acl_dump(self, acl_index=4294967295):
3146 """ Return MACIP acl dump
3150 self.papi.macip_acl_dump, {'acl_index': acl_index})
3152 def policer_add_del(self,
3163 conform_action_type=1,
3165 exceed_action_type=0,
3167 violate_action_type=0,
3169 return self.api(self.papi.policer_add_del,
3176 'rate_type': rate_type,
3177 'round_type': round_type,
3179 'color_aware': color_aware,
3180 'conform_action_type': conform_action_type,
3181 'conform_dscp': conform_dscp,
3182 'exceed_action_type': exceed_action_type,
3183 'exceed_dscp': exceed_dscp,
3184 'violate_action_type': violate_action_type,
3185 'violate_dscp': violate_dscp})
3187 def ip_punt_police(self,
3191 return self.api(self.papi.ip_punt_police,
3192 {'policer_index': policer_index,
3196 def ip_punt_redirect(self,
3201 return self.api(self.papi.ip_punt_redirect,
3202 {'punt': {'rx_sw_if_index': rx_sw_if_index,
3203 'tx_sw_if_index': tx_sw_if_index,
3207 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
3208 return self.api(self.papi.ip_punt_redirect_dump,
3209 {'sw_if_index': sw_if_index,
3210 'is_ipv6': is_ipv6})
3212 def bier_table_add_del(self,
3216 """ BIER Table add/del """
3218 self.papi.bier_table_add_del,
3219 {'bt_tbl_id': {"bt_set": bti.set_id,
3220 "bt_sub_domain": bti.sub_domain_id,
3221 "bt_hdr_len_id": bti.hdr_len_id},
3222 'bt_label': mpls_label,
3223 'bt_is_add': is_add})
3225 def bier_table_dump(self):
3226 return self.api(self.papi.bier_table_dump, {})
3228 def bier_route_add_del(self,
3234 """ BIER Route add/del """
3236 self.papi.bier_route_add_del,
3237 {'br_tbl_id': {"bt_set": bti.set_id,
3238 "bt_sub_domain": bti.sub_domain_id,
3239 "bt_hdr_len_id": bti.hdr_len_id},
3241 'br_n_paths': len(paths),
3243 'br_is_add': is_add,
3244 'br_is_replace': is_replace})
3246 def bier_route_dump(self, bti):
3248 self.papi.bier_route_dump,
3249 {'br_tbl_id': {"bt_set": bti.set_id,
3250 "bt_sub_domain": bti.sub_domain_id,
3251 "bt_hdr_len_id": bti.hdr_len_id}})
3253 def bier_imp_add(self,
3258 """ BIER Imposition Add """
3260 self.papi.bier_imp_add,
3261 {'bi_tbl_id': {"bt_set": bti.set_id,
3262 "bt_sub_domain": bti.sub_domain_id,
3263 "bt_hdr_len_id": bti.hdr_len_id},
3265 'bi_n_bytes': len(ibytes),
3266 'bi_bytes': ibytes})
3268 def bier_imp_del(self, bi_index):
3269 """ BIER Imposition del """
3271 self.papi.bier_imp_del,
3272 {'bi_index': bi_index})
3274 def bier_imp_dump(self):
3275 return self.api(self.papi.bier_imp_dump, {})
3277 def bier_disp_table_add_del(self,
3280 """ BIER Disposition Table add/del """
3282 self.papi.bier_disp_table_add_del,
3283 {'bdt_tbl_id': bdti,
3284 'bdt_is_add': is_add})
3286 def bier_disp_table_dump(self):
3287 return self.api(self.papi.bier_disp_table_dump, {})
3289 def bier_disp_entry_add_del(self,
3299 """ BIER Route add/del """
3301 while (len(lstack) < 16):
3304 self.papi.bier_disp_entry_add_del,
3305 {'bde_tbl_id': bdti,
3307 'bde_payload_proto': payload_proto,
3309 'bde_paths': [{'next_hop': next_hop,
3310 'table_id': next_hop_tbl_id,
3311 'afi': next_hop_afi,
3312 'rpf_id': next_hop_rpf_id,
3314 'label_stack': lstack}],
3315 'bde_is_add': is_add})
3317 def bier_disp_entry_dump(self, bdti):
3319 self.papi.bier_disp_entry_dump,
3320 {'bde_tbl_id': bdti})
3322 def add_node_next(self, node_name, next_name):
3323 """ Set the next node for a given node request
3328 return self.api(self.papi.add_node_next,
3329 {'node_name': node_name,
3330 'next_name': next_name})
3332 def session_enable_disable(self, is_enabled):
3334 self.papi.session_enable_disable,
3335 {'is_enable': is_enabled})
3337 def ipsec_spd_add_del(self, spd_id, is_add=1):
3338 """ SPD add/del - Wrapper to add or del ipsec SPD
3339 Sample CLI : 'ipsec spd add 1'
3341 :param spd_id - SPD ID to be created in the vpp . mandatory
3342 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3344 :returns: reply from the API
3347 self.papi.ipsec_spd_add_del, {
3348 'spd_id': spd_id, 'is_add': is_add})
3350 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3351 """ IPSEC interface SPD add/del - \
3352 Wrapper to associate/disassociate SPD to interface in VPP
3353 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3355 :param spd_id - SPD ID to associate with the interface . mandatory
3356 :param sw_if_index - Interface Index which needs to ipsec \
3357 association mandatory
3358 :param is_add - add(1) or del(0) association with interface \
3359 (Default 1 - add) . optional
3360 :returns: reply from the API
3363 self.papi.ipsec_interface_add_del_spd,
3364 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3366 def ipsec_sad_add_del_entry(self,
3369 integrity_algorithm,
3374 tunnel_src_address='',
3375 tunnel_dst_address='',
3381 use_extended_sequence_number=0):
3382 """ IPSEC SA add/del
3383 :param sad_id: security association ID
3384 :param spi: security param index of the SA in decimal
3385 :param integrity_algorithm:
3386 :param integrity_key:
3387 :param crypto_algorithm:
3389 :param protocol: AH(0) or ESP(1) protocol
3390 :param tunnel_src_address: tunnel mode outer src address
3391 :param tunnel_dst_address: tunnel mode outer dst address
3394 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3395 crypto and ipsec algorithms
3398 self.papi.ipsec_sad_add_del_entry,
3401 'tunnel_src_address': tunnel_src_address,
3402 'tunnel_dst_address': tunnel_dst_address,
3403 'protocol': protocol,
3404 'integrity_algorithm': integrity_algorithm,
3405 'integrity_key_length': len(integrity_key),
3406 'integrity_key': integrity_key,
3407 'crypto_algorithm': crypto_algorithm,
3408 'crypto_key_length': len(crypto_key) if crypto_key is not None
3410 'crypto_key': crypto_key,
3412 'is_tunnel': is_tunnel,
3413 'is_tunnel_ipv6': is_tunnel_ipv6,
3414 'udp_encap': udp_encap,
3415 'use_extended_sequence_number': use_extended_sequence_number,
3416 'use_anti_replay': use_anti_replay})
3418 def ipsec_spd_add_del_entry(self,
3421 local_address_start,
3423 remote_address_start,
3424 remote_address_stop,
3426 local_port_stop=65535,
3427 remote_port_start=0,
3428 remote_port_stop=65535,
3436 """ IPSEC policy SPD add/del -
3437 Wrapper to configure ipsec SPD policy entries in VPP
3438 :param spd_id: SPD ID for the policy
3439 :param local_address_start: local-ip-range start address
3440 :param local_address_stop : local-ip-range stop address
3441 :param remote_address_start: remote-ip-range start address
3442 :param remote_address_stop : remote-ip-range stop address
3443 :param local_port_start: (Default value = 0)
3444 :param local_port_stop: (Default value = 65535)
3445 :param remote_port_start: (Default value = 0)
3446 :param remote_port_stop: (Default value = 65535)
3447 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3448 :param sa_id: Security Association ID for mapping it to SPD
3449 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3451 :param priority: value for the spd action (Default value = 100)
3452 :param is_outbound: flag for inbound(0) or outbound(1)
3454 :param is_add: (Default value = 1)
3457 self.papi.ipsec_spd_add_del_entry,
3460 'local_address_start': local_address_start,
3461 'local_address_stop': local_address_stop,
3462 'remote_address_start': remote_address_start,
3463 'remote_address_stop': remote_address_stop,
3464 'local_port_start': local_port_start,
3465 'local_port_stop': local_port_stop,
3466 'remote_port_start': remote_port_start,
3467 'remote_port_stop': remote_port_stop,
3469 'protocol': protocol,
3471 'priority': priority,
3472 'is_outbound': is_outbound,
3474 'is_ip_any': is_ip_any})
3476 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3477 remote_spi, crypto_alg, local_crypto_key,
3478 remote_crypto_key, integ_alg, local_integ_key,
3479 remote_integ_key, is_add=1, esn=0,
3480 anti_replay=1, renumber=0, show_instance=0):
3482 self.papi.ipsec_tunnel_if_add_del,
3483 {'local_ip': local_ip, 'remote_ip': remote_ip,
3484 'local_spi': local_spi, 'remote_spi': remote_spi,
3485 'crypto_alg': crypto_alg,
3486 'local_crypto_key_len': len(local_crypto_key),
3487 'local_crypto_key': local_crypto_key,
3488 'remote_crypto_key_len': len(remote_crypto_key),
3489 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3490 'local_integ_key_len': len(local_integ_key),
3491 'local_integ_key': local_integ_key,
3492 'remote_integ_key_len': len(remote_integ_key),
3493 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3494 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3495 'show_instance': show_instance
3498 def ipsec_select_backend(self, protocol, index):
3499 return self.api(self.papi.ipsec_select_backend,
3500 {'protocol': protocol, 'index': index})
3502 def ipsec_backend_dump(self):
3503 return self.api(self.papi.ipsec_backend_dump, {})
3505 def app_namespace_add(self,
3509 sw_if_index=0xFFFFFFFF,
3512 self.papi.app_namespace_add_del,
3514 'sw_if_index': sw_if_index,
3515 'ip4_fib_id': ip4_fib_id,
3516 'ip6_fib_id': ip6_fib_id,
3517 'namespace_id': namespace_id,
3518 'namespace_id_len': len(namespace_id)})
3520 def punt_socket_register(self, port, pathname, protocol=0x11,
3521 header_version=1, is_ip4=1):
3522 """ Register punt socket """
3523 return self.api(self.papi.punt_socket_register,
3524 {'header_version': header_version,
3525 'punt': {'ipv': is_ip4,
3526 'l4_protocol': protocol,
3528 'pathname': pathname})
3530 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
3531 """ Unregister punt socket """
3532 return self.api(self.papi.punt_socket_deregister,
3533 {'punt': {'ipv': is_ip4,
3534 'l4_protocol': protocol,
3537 def punt_socket_dump(self, is_ip6=1):
3538 """ Dump punt socket"""
3539 return self.api(self.papi.punt_socket_dump,
3540 {'is_ipv6': is_ip6})
3542 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3543 expire_walk_interval_ms, is_ip6=0):
3544 """ Set IP reassembly parameters """
3545 return self.api(self.papi.ip_reassembly_set,
3547 'timeout_ms': timeout_ms,
3548 'expire_walk_interval_ms': expire_walk_interval_ms,
3549 'max_reassemblies': max_reassemblies})
3551 def ip_reassembly_get(self, is_ip6=0):
3552 """ Get IP reassembly parameters """
3553 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3555 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3557 """ Enable/disable IP reassembly """
3558 return self.api(self.papi.ip_reassembly_enable_disable,
3559 {'sw_if_index': sw_if_index,
3560 'enable_ip4': 1 if enable_ip4 else 0,
3561 'enable_ip6': 1 if enable_ip6 else 0,
3564 def gbp_endpoint_add(self, sw_if_index, ips, mac, epg, flags,
3566 """ GBP endpoint Add """
3567 return self.api(self.papi.gbp_endpoint_add,
3569 'sw_if_index': sw_if_index,
3580 def gbp_endpoint_del(self, handle):
3581 """ GBP endpoint Del """
3582 return self.api(self.papi.gbp_endpoint_del,
3585 def gbp_endpoint_dump(self):
3586 """ GBP endpoint Dump """
3587 return self.api(self.papi.gbp_endpoint_dump,
3588 {'_no_type_conversion': True})
3590 def gbp_endpoint_group_add(self, epg, bd,
3591 rd, uplink_sw_if_index):
3592 """ GBP endpoint group Add """
3593 return self.api(self.papi.gbp_endpoint_group_add,
3596 'uplink_sw_if_index': uplink_sw_if_index,
3602 def gbp_endpoint_group_del(self, epg):
3603 """ GBP endpoint group Del """
3604 return self.api(self.papi.gbp_endpoint_group_del,
3607 def gbp_endpoint_group_dump(self):
3608 """ GBP endpoint group Dump """
3609 return self.api(self.papi.gbp_endpoint_group_dump, {})
3611 def gbp_bridge_domain_add(self, bd_id, flags,
3613 uu_fwd_sw_if_index):
3614 """ GBP bridge-domain Add """
3615 return self.api(self.papi.gbp_bridge_domain_add,
3619 'bvi_sw_if_index': bvi_sw_if_index,
3620 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
3624 def gbp_bridge_domain_del(self, bd_id):
3625 """ GBP bridge-domain Del """
3626 return self.api(self.papi.gbp_bridge_domain_del,
3629 def gbp_bridge_domain_dump(self):
3630 """ GBP Bridge Domain Dump """
3631 return self.api(self.papi.gbp_bridge_domain_dump, {})
3633 def gbp_route_domain_add(self, rd_id,
3637 ip6_uu_sw_if_index):
3638 """ GBP route-domain Add """
3639 return self.api(self.papi.gbp_route_domain_add,
3642 'ip4_table_id': ip4_table_id,
3643 'ip6_table_id': ip6_table_id,
3644 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
3645 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
3649 def gbp_route_domain_del(self, rd_id):
3650 """ GBP route-domain Del """
3651 return self.api(self.papi.gbp_route_domain_del,
3654 def gbp_route_domain_dump(self):
3655 """ GBP Route Domain Dump """
3656 return self.api(self.papi.gbp_route_domain_dump, {})
3658 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3659 """ GBP recirc Add/Del """
3660 return self.api(self.papi.gbp_recirc_add_del,
3664 'sw_if_index': sw_if_index,
3667 def gbp_recirc_dump(self):
3668 """ GBP recirc Dump """
3669 return self.api(self.papi.gbp_recirc_dump, {})
3671 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
3672 """ GBP recirc Add/Del """
3673 return self.api(self.papi.gbp_ext_itf_add_del,
3676 'sw_if_index': sw_if_index,
3680 def gbp_ext_itf_dump(self):
3681 """ GBP recirc Dump """
3682 return self.api(self.papi.gbp_ext_itf_dump, {})
3684 def gbp_subnet_add_del(self, is_add, rd_id,
3686 sw_if_index=0xffffffff,
3688 """ GBP Subnet Add/Del """
3689 return self.api(self.papi.gbp_subnet_add_del,
3693 'sw_if_index': sw_if_index,
3698 def gbp_subnet_dump(self):
3699 """ GBP Subnet Dump """
3700 return self.api(self.papi.gbp_subnet_dump,
3701 {'_no_type_conversion': True})
3703 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index,
3704 rules, allowed_ethertypes):
3705 """ GBP contract Add/Del """
3706 return self.api(self.papi.gbp_contract_add_del,
3709 'acl_index': acl_index,
3712 'n_rules': len(rules),
3714 'n_ether_types': len(allowed_ethertypes),
3715 'allowed_ethertypes': allowed_ethertypes}})
3717 def gbp_contract_dump(self):
3718 """ GBP contract Dump """
3719 return self.api(self.papi.gbp_contract_dump, {})
3721 def gbp_endpoint_learn_set_inactive_threshold(self, threshold):
3722 """ GBP set inactive threshold """
3723 return self.api(self.papi.gbp_endpoint_learn_set_inactive_threshold,
3724 {'threshold': threshold})
3726 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode):
3727 """ GBP VXLAN tunnel add """
3728 return self.api(self.papi.gbp_vxlan_tunnel_add,
3733 'bd_rd_id': bd_rd_id
3737 def gbp_vxlan_tunnel_del(self, vni):
3738 """ GBP VXLAN tunnel del """
3739 return self.api(self.papi.gbp_vxlan_tunnel_del,
3744 def gbp_vxlan_tunnel_dump(self):
3745 """ GBP VXLAN tunnel add/del """
3746 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
3748 def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3749 ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3751 """ 6RD tunnel Add """
3752 return self.api(self.papi.ipip_6rd_add_tunnel,
3753 {'ip4_table_id': ip4_table_id,
3754 'ip6_table_id': ip6_table_id,
3755 'ip6_prefix': ip6_prefix,
3756 'ip6_prefix_len': ip6_prefix_len,
3757 'ip4_prefix': ip4_prefix,
3758 'ip4_prefix_len': ip4_prefix_len,
3760 'security_check': security_check})
3762 def ipip_6rd_del_tunnel(self, sw_if_index):
3763 """ 6RD tunnel Delete """
3764 return self.api(self.papi.ipip_6rd_del_tunnel,
3765 {'sw_if_index': sw_if_index})
3767 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3768 instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3769 """ IPIP tunnel Add/Del """
3770 return self.api(self.papi.ipip_add_tunnel,
3771 {'is_ipv6': is_ipv6,
3772 'instance': instance,
3773 'src_address': src_address,
3774 'dst_address': dst_address,
3775 'table_id': table_id,
3778 def ipip_del_tunnel(self, sw_if_index):
3779 """ IPIP tunnel Delete """
3780 return self.api(self.papi.ipip_del_tunnel,
3781 {'sw_if_index': sw_if_index})
3783 def qos_egress_map_update(self, id, outputs):
3784 """ QOS egress map update """
3785 return self.api(self.papi.qos_egress_map_update,
3789 def qos_egress_map_delete(self, id):
3790 """ QOS egress map delete """
3791 return self.api(self.papi.qos_egress_map_delete,
3794 def qos_mark_enable_disable(self, sw_if_index,
3798 """ QOS Mark Enable/Disable """
3799 return self.api(self.papi.qos_mark_enable_disable,
3801 'sw_if_index': sw_if_index,
3802 'output_source': output_source,
3805 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3806 """ IP QoS recording Enble/Disable """
3807 return self.api(self.papi.qos_record_enable_disable,
3808 {'sw_if_index': sw_if_index,
3809 'input_source': input_source,
3812 def igmp_enable_disable(self, sw_if_index, enable, host):
3813 """ Enable/disable IGMP on a given interface """
3814 return self.api(self.papi.igmp_enable_disable,
3817 'sw_if_index': sw_if_index})
3819 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
3820 """ Add/del IGMP proxy device """
3821 return self.api(self.papi.igmp_proxy_device_add_del,
3822 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3825 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
3826 """ Add/del interface to/from IGMP proxy device """
3827 return self.api(self.papi.igmp_proxy_device_add_del_interface,
3828 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3831 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3832 """ Listen for new (S,G) on specified interface
3834 :param enable: add/del
3835 :param sw_if_index: interface sw index
3836 :param saddr: source ip4 addr
3837 :param gaddr: group ip4 addr
3839 return self.api(self.papi.igmp_listen,
3844 'sw_if_index': sw_if_index,
3845 'n_srcs': len(saddrs),
3851 def igmp_dump(self, sw_if_index=None):
3852 """ Dump all (S,G) interface configurations """
3853 if sw_if_index is None:
3854 sw_if_index = 0xffffffff
3855 return self.api(self.papi.igmp_dump,
3856 {'sw_if_index': sw_if_index})
3858 def igmp_clear_interface(self, sw_if_index):
3859 """ Remove all (S,G)s from specified interface
3860 doesn't send IGMP report!
3863 self.papi.igmp_clear_interface, {
3864 'sw_if_index': sw_if_index})
3866 def want_igmp_events(self, enable=1):
3867 return self.api(self.papi.want_igmp_events, {'enable': enable,
3868 'pid': os.getpid()})
3876 interface_id=0xFFFFFFFF):
3879 :param lb: load balance
3880 :param use_custom_mac: use custom mac
3881 :param mac_address: mac address
3882 :param interface_id: custom interface ID
3885 self.papi.bond_create,
3888 'use_custom_mac': use_custom_mac,
3889 'mac_address': mac_address,
3897 :param sw_if_index: interface the operation is applied to
3899 return self.api(self.papi.bond_delete,
3900 {'sw_if_index': sw_if_index})
3909 :param sw_if_index: slave sw_if_index
3910 :param bond_sw_if_index: bond sw_if_index
3911 :param is_passive: is passive lacp speaker
3912 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3915 self.papi.bond_enslave,
3916 {'sw_if_index': sw_if_index,
3917 'bond_sw_if_index': bond_sw_if_index,
3918 'is_passive': is_passive,
3919 'is_long_timeout': is_long_timeout
3922 def bond_detach_slave(
3926 :param sw_if_index: slave interface the operation is applied to
3928 return self.api(self.papi.bond_detach_slave,
3929 {'sw_if_index': sw_if_index})
3931 def sw_interface_slave_dump(
3935 :param sw_if_index: bond sw_if_index
3937 return self.api(self.papi.sw_interface_slave_dump,
3938 {'sw_if_index': sw_if_index})
3940 def sw_interface_bond_dump(
3945 return self.api(self.papi.sw_interface_bond_dump,
3948 def create_vhost_user_if(
3954 disable_indirect_desc,
3955 custom_dev_instance,
3960 :param is_server: is server
3961 :param sock_filename: socket name
3962 :param renumber: renumber
3963 :param disable_mrg_rxbuf: disable mergable rx buffers
3964 :param disable_indirect_desc: disable indirect descriptors
3965 :param custom_dev_instance: custom dev instance
3966 :param use_custom_mac: use custom mac
3967 :param mac_address: mac address
3968 :param tag: tag (default '')
3971 self.papi.create_vhost_user_if,
3972 {'is_server': is_server,
3973 'sock_filename': sock_filename,
3974 'renumber': renumber,
3975 'disable_mrg_rxbuf': disable_mrg_rxbuf,
3976 'disable_indirect_desc': disable_indirect_desc,
3977 'custom_dev_instance': custom_dev_instance,
3978 'use_custom_mac': use_custom_mac,
3979 'mac_address': mac_address,
3983 def delete_vhost_user_if(
3987 :param sw_if_index: interface the operation is applied to
3989 return self.api(self.papi.delete_vhost_user_if,
3990 {'sw_if_index': sw_if_index, })
3992 def sw_interface_vhost_user_dump(
3997 return self.api(self.papi.sw_interface_vhost_user_dump,
4000 def abf_policy_add_del(self, is_add, policy):
4002 self.papi.abf_policy_add_del,
4006 def abf_itf_attach_add_del(self, is_add, attach):
4008 self.papi.abf_itf_attach_add_del,
4012 def abf_policy_dump(self):
4014 self.papi.abf_policy_dump, {})
4016 def abf_itf_attach_dump(self):
4018 self.papi.abf_itf_attach_dump, {})
4020 def pipe_create(self, is_specified, user_instance):
4021 return self.api(self.papi.pipe_create,
4022 {'is_specified': is_specified,
4023 'user_instance': user_instance})
4025 def pipe_delete(self, parent_sw_if_index):
4026 return self.api(self.papi.pipe_delete,
4027 {'parent_sw_if_index': parent_sw_if_index})
4029 def pipe_dump(self):
4030 return self.api(self.papi.pipe_dump, {})
4044 return self.api(self.papi.memif_create,
4047 'rx_queues': rx_queues,
4048 'tx_queues': tx_queues,
4050 'socket_id': socket_id,
4052 'ring_size': ring_size,
4053 'buffer_size': buffer_size,
4054 'hw_addr': hw_addr})
4056 def memif_delete(self, sw_if_index):
4057 return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index})
4059 def memif_dump(self):
4060 return self.api(self.papi.memif_dump, {})
4062 def memif_socket_filename_add_del(
4063 self, is_add, socket_id, socket_filename):
4065 self.papi.memif_socket_filename_add_del,
4067 'socket_id': socket_id,
4068 'socket_filename': socket_filename})
4070 def memif_socket_filename_dump(self):
4071 return self.api(self.papi.memif_socket_filename_dump, {})
4073 def svs_table_add_del(self, af, table_id, is_add=1):
4074 return self.api(self.papi.svs_table_add_del,
4076 'table_id': table_id,
4081 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
4082 return self.api(self.papi.svs_route_add_del,
4084 'table_id': table_id,
4085 'source_table_id': src_table_id,
4090 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
4091 return self.api(self.papi.svs_enable_disable,
4094 'table_id': table_id,
4095 'sw_if_index': sw_if_index,
4096 'is_enable': is_enable,
4100 return self.api(self.papi.svs_dump, {})
4102 def syslog_set_sender(
4109 """Set syslog sender configuration
4111 :param collector: colector IP address
4112 :param src: source IP address
4113 :param collector_port: collector UDP port (Default value = 514)
4114 :param vrf_id: VRF id (Default value = 0)
4115 :param max_msg_size: maximum message length (Default value = 480)
4117 return self.api(self.papi.syslog_set_sender,
4118 {'collector_address': collector,
4120 'collector_port': collector_port,
4122 'max_msg_size': max_msg_size})
4124 def syslog_get_sender(self):
4125 """Return syslog sender configuration"""
4126 return self.api(self.papi.syslog_get_sender, {})
4128 def syslog_set_filter(self, severity):
4129 """Set syslog filter parameters
4131 :param severity: severity filter (specified severity and greater match)
4133 return self.api(self.papi.syslog_set_filter, {'severity': severity})
4135 def syslog_get_filter(self):
4136 """Return syslog filter parameters"""
4137 return self.api(self.papi.syslog_get_filter, {})