4 from collections import deque
7 from vpp_papi import mac_pton
9 from vpp_l2 import L2_PORT_TYPE
11 # Sphinx creates auto-generated documentation by importing the python source
12 # files and collecting the docstrings from them. The NO_VPP_PAPI flag allows
13 # the vpp_papi_provider.py file to be importable without having to build
14 # the whole vpp api if the user only wishes to generate the test documentation.
17 from vpp_papi import VPP
19 if not os.getenv("NO_VPP_PAPI") == 1:
23 # from vnet/vnet/mpls/mpls_types.h
24 MPLS_IETF_MAX_LABEL = 0xfffff
25 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
47 class SYSLOG_SEVERITY:
58 class UnexpectedApiReturnValueError(Exception):
59 """ exception raised when the API return value is unexpected """
63 class VppPapiProvider(object):
64 """VPP-api provider using vpp-papi
66 @property hook: hook object providing before and after api/cli hooks
69 _zero, _negative = range(2)
71 def __init__(self, name, shm_prefix, test_class, read_timeout):
72 self.hook = Hook("vpp-papi-provider")
74 self.shm_prefix = shm_prefix
75 self.test_class = test_class
76 self._expect_api_retval = self._zero
77 self._expect_stack = []
80 install_dir = os.getenv('VPP_INSTALL_PATH')
81 for root, dirnames, filenames in os.walk(install_dir):
82 for filename in fnmatch.filter(filenames, '*.api.json'):
83 jsonfiles.append(os.path.join(root, filename))
85 self.vpp = VPP(jsonfiles, logger=test_class.logger,
86 read_timeout=read_timeout)
87 self._events = deque()
92 def assert_negative_api_retval(self):
93 """ Expect API failure - used with with, e.g.:
94 with self.vapi.assert_negative_api_retval():
95 self.vapi.<api call expected to fail>
97 self._expect_stack.append(self._expect_api_retval)
98 self._expect_api_retval = self._negative
101 def assert_zero_api_retval(self):
102 """ Expect API success - used with with, e.g.:
103 with self.vapi.assert_negative_api_retval():
104 self.vapi.<api call expected to succeed>
106 note: this is useful only inside another with block
107 as success is the default expected value
109 self._expect_stack.append(self._expect_api_retval)
110 self._expect_api_retval = self._zero
113 def __exit__(self, exc_type, exc_value, traceback):
114 self._expect_api_retval = self._expect_stack.pop()
116 def register_hook(self, hook):
117 """Replace hook registration with new hook
124 def collect_events(self):
125 """ Collect all events from the internal queue and clear the queue. """
127 self._events = deque()
130 def wait_for_event(self, timeout, name=None):
131 """ Wait for and return next event. """
133 self.test_class.logger.debug("Expecting event '%s' within %ss",
136 self.test_class.logger.debug("Expecting event within %ss",
139 self.test_class.logger.debug("Not waiting, event already queued")
140 limit = time.time() + timeout
141 while time.time() < limit:
143 e = self._events.popleft()
144 if name and type(e).__name__ != name:
146 "Unexpected event received: %s, expected: %s" %
147 (type(e).__name__, name))
148 self.test_class.logger.debug("Returning event %s:%s" %
151 time.sleep(0) # yield
152 raise Exception("Event did not occur within timeout")
154 def __call__(self, name, event):
155 """ Enqueue event in the internal event queue. """
156 # FIXME use the name instead of relying on type(e).__name__ ?
157 # FIXME #2 if this throws, it is eaten silently, Ole?
158 self.test_class.logger.debug("New event: %s: %s" % (name, event))
159 self._events.append(event)
162 """Connect the API to VPP"""
163 self.vpp.connect(self.name, self.shm_prefix)
164 self.papi = self.vpp.api
165 self.vpp.register_event_callback(self)
167 def disconnect(self):
168 """Disconnect the API from VPP"""
169 self.vpp.disconnect()
171 def api(self, api_fn, api_args, expected_retval=0):
172 """ Call API function and check it's return value.
173 Call the appropriate hooks before and after the API call
175 :param api_fn: API function to call
176 :param api_args: tuple of API function arguments
177 :param expected_retval: Expected return value (Default value = 0)
178 :returns: reply from the API
181 self.hook.before_api(api_fn.__name__, api_args)
182 reply = api_fn(**api_args)
183 if self._expect_api_retval == self._negative:
184 if hasattr(reply, 'retval') and reply.retval >= 0:
185 msg = "API call passed unexpectedly: expected negative "\
186 "return value instead of %d in %s" % \
187 (reply.retval, moves.reprlib.repr(reply))
188 self.test_class.logger.info(msg)
189 raise UnexpectedApiReturnValueError(msg)
190 elif self._expect_api_retval == self._zero:
191 if hasattr(reply, 'retval') and reply.retval != expected_retval:
192 msg = "API call failed, expected %d return value instead "\
193 "of %d in %s" % (expected_retval, reply.retval,
194 moves.reprlib.repr(reply))
195 self.test_class.logger.info(msg)
196 raise UnexpectedApiReturnValueError(msg)
198 raise Exception("Internal error, unexpected value for "
199 "self._expect_api_retval %s" %
200 self._expect_api_retval)
201 self.hook.after_api(api_fn.__name__, api_args)
205 """ Execute a CLI, calling the before/after hooks appropriately.
207 :param cli: CLI to execute
211 self.hook.before_cli(cli)
213 r = self.papi.cli_inband(cmd=cli)
214 self.hook.after_cli(cli)
215 if hasattr(r, 'reply'):
218 def ppcli(self, cli):
219 """ Helper method to print CLI command in case of info logging level.
221 :param cli: CLI to execute
224 return cli + "\n" + str(self.cli(cli))
226 def show_version(self):
228 return self.api(self.papi.show_version, {})
230 def pg_create_interface(self, pg_index):
236 return self.api(self.papi.pg_create_interface,
237 {"interface_id": pg_index})
239 def sw_interface_dump(self, filter=None):
242 :param filter: (Default value = None)
245 if filter is not None:
246 args = {"name_filter_valid": 1, "name_filter": filter}
249 return self.api(self.papi.sw_interface_dump, args)
251 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
252 """ Set the IPvX Table-id for the Interface
259 return self.api(self.papi.sw_interface_set_table,
260 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
263 def sw_interface_get_table(self, sw_if_index, is_ipv6):
264 """ Get the IPvX Table-id for the Interface
271 return self.api(self.papi.sw_interface_get_table,
272 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6})
274 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
275 is_ipv6=0, is_add=1, del_all=0):
278 :param addr: param is_ipv6: (Default value = 0)
281 :param is_ipv6: (Default value = 0)
282 :param is_add: (Default value = 1)
283 :param del_all: (Default value = 0)
286 return self.api(self.papi.sw_interface_add_del_address,
287 {'sw_if_index': sw_if_index,
291 'address_length': addr_len,
294 def ip_address_dump(self, sw_if_index, is_ipv6=0):
295 return self.api(self.papi.ip_address_dump,
296 {'sw_if_index': sw_if_index,
299 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
301 """ Set the Interface to be unnumbered
303 :param is_add: (Default value = 1)
304 :param sw_if_index - interface That will be unnumbered
305 :param ip_sw_if_index - interface with an IP addres
308 return self.api(self.papi.sw_interface_set_unnumbered,
309 {'sw_if_index': ip_sw_if_index,
310 'unnumbered_sw_if_index': sw_if_index,
313 def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
314 return self.api(self.papi.ip_unnumbered_dump,
315 {'sw_if_index': sw_if_index})
317 def sw_interface_enable_disable_mpls(self, sw_if_index,
320 Enable/Disable MPLS on the interface
322 :param is_enable: (Default value = 1)
325 return self.api(self.papi.sw_interface_set_mpls_enable,
326 {'sw_if_index': sw_if_index,
327 'enable': is_enable})
329 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
330 return self.api(self.papi.sw_interface_ip6nd_ra_config,
331 {'sw_if_index': sw_if_index,
332 'suppress': suppress})
334 def set_ip_flow_hash(self,
343 return self.api(self.papi.set_ip_flow_hash,
353 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
354 return self.api(self.papi.ip6nd_proxy_add_del,
356 'sw_if_index': sw_if_index,
359 def ip6_sw_interface_ra_config(self, sw_if_index,
363 return self.api(self.papi.sw_interface_ip6nd_ra_config,
364 {'sw_if_index': sw_if_index,
366 'suppress': suppress,
367 'send_unicast': send_unicast})
369 def ip6_sw_interface_ra_prefix(self,
379 val_lifetime=0xffffffff,
380 pref_lifetime=0xffffffff):
381 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
382 {'sw_if_index': sw_if_index,
384 'address_length': address_length,
385 'use_default': use_default,
386 'no_advertise': no_advertise,
387 'off_link': off_link,
388 'no_autoconfig': no_autoconfig,
389 'no_onlink': no_onlink,
391 'val_lifetime': val_lifetime,
392 'pref_lifetime': pref_lifetime})
394 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
396 Enable/Disable An interface for IPv6
398 return self.api(self.papi.sw_interface_ip6_enable_disable,
399 {'sw_if_index': sw_if_index,
402 def vxlan_add_del_tunnel(
406 mcast_sw_if_index=0xFFFFFFFF,
410 decap_next_index=0xFFFFFFFF,
412 instance=0xFFFFFFFF):
417 :param is_add: (Default value = 1)
418 :param is_ipv6: (Default value = 0)
419 :param encap_vrf_id: (Default value = 0)
420 :param decap_next_index: (Default value = 0xFFFFFFFF)
421 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
422 :param vni: (Default value = 0)
423 :param instance: (Default value = 0xFFFFFFFF)
426 return self.api(self.papi.vxlan_add_del_tunnel,
429 'src_address': src_addr,
430 'dst_address': dst_addr,
431 'mcast_sw_if_index': mcast_sw_if_index,
432 'encap_vrf_id': encap_vrf_id,
433 'decap_next_index': decap_next_index,
435 'instance': instance})
437 def geneve_add_del_tunnel(
441 mcast_sw_if_index=0xFFFFFFFF,
445 decap_next_index=0xFFFFFFFF,
451 :param is_add: (Default value = 1)
452 :param is_ipv6: (Default value = 0)
453 :param encap_vrf_id: (Default value = 0)
454 :param decap_next_index: (Default value = 0xFFFFFFFF)
455 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
456 :param vni: (Default value = 0)
459 return self.api(self.papi.geneve_add_del_tunnel,
462 'local_address': local_addr,
463 'remote_address': remote_addr,
464 'mcast_sw_if_index': mcast_sw_if_index,
465 'encap_vrf_id': encap_vrf_id,
466 'decap_next_index': decap_next_index,
469 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
470 learn=1, arp_term=0, is_add=1):
471 """Create/delete bridge domain.
473 :param int bd_id: Bridge domain index.
474 :param int flood: Enable/disable bcast/mcast flooding in the BD.
476 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
478 :param int forward: Enable/disable forwarding on all interfaces in
479 the BD. (Default value = 1)
480 :param int learn: Enable/disable learning on all interfaces in the BD.
482 :param int arp_term: Enable/disable arp termination in the BD.
484 :param int is_add: Add or delete flag. (Default value = 1)
486 return self.api(self.papi.bridge_domain_add_del,
489 'uu_flood': uu_flood,
492 'arp_term': arp_term,
495 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
496 return self.api(self.papi.bd_ip_mac_add_del,
502 def bd_ip_mac_dump(self, bd_id):
503 return self.api(self.papi.bd_ip_mac_dump,
506 def want_ip4_arp_events(self, enable_disable=1, address=0):
507 return self.api(self.papi.want_ip4_arp_events,
508 {'enable_disable': enable_disable,
510 'pid': os.getpid(), })
512 def want_ip6_nd_events(self, enable_disable=1, address=0):
513 return self.api(self.papi.want_ip6_nd_events,
514 {'enable_disable': enable_disable,
516 'pid': os.getpid(), })
518 def want_ip6_ra_events(self, enable_disable=1):
519 return self.api(self.papi.want_ip6_ra_events,
520 {'enable_disable': enable_disable,
521 'pid': os.getpid(), })
523 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
525 return self.api(self.papi.ip6nd_send_router_solicitation,
530 'sw_if_index': sw_if_index})
532 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
533 install_default_routes):
534 return self.api(self.papi.ip6_nd_address_autoconfig,
535 {'sw_if_index': sw_if_index,
537 'install_default_routes': install_default_routes})
539 def want_interface_events(self, enable_disable=1):
540 return self.api(self.papi.want_interface_events,
541 {'enable_disable': enable_disable,
542 'pid': os.getpid(), })
544 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
545 max_macs_in_event=0, learn_limit=0):
546 return self.api(self.papi.want_l2_macs_events,
547 {'enable_disable': enable_disable,
548 'scan_delay': scan_delay,
549 'max_macs_in_event': max_macs_in_event,
550 'learn_limit': learn_limit,
551 'pid': os.getpid(), })
553 def want_dhcp6_reply_events(self, enable_disable=1):
554 return self.api(self.papi.want_dhcp6_reply_events,
555 {'enable_disable': enable_disable,
558 def want_dhcp6_pd_reply_events(self, enable_disable=1):
559 return self.api(self.papi.want_dhcp6_pd_reply_events,
560 {'enable_disable': enable_disable,
563 def dhcp6_clients_enable_disable(self, enable=1):
564 return self.api(self.papi.dhcp6_clients_enable_disable,
567 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
568 addresses, server_index=0xFFFFFFFF,
569 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
571 return self.api(self.papi.dhcp6_send_client_message,
572 {'sw_if_index': sw_if_index,
573 'server_index': server_index,
579 'msg_type': msg_type,
582 'n_addresses': len(addresses),
583 'addresses': addresses})
585 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
586 prefixes, server_index=0xFFFFFFFF,
587 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
589 return self.api(self.papi.dhcp6_pd_send_client_message,
590 {'sw_if_index': sw_if_index,
591 'server_index': server_index,
597 'msg_type': msg_type,
600 'n_prefixes': len(prefixes),
601 'prefixes': prefixes})
603 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
605 return self.api(self.papi.dhcp6_client_enable_disable,
606 {'sw_if_index': sw_if_index,
609 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
611 return self.api(self.papi.dhcp6_pd_client_enable_disable,
612 {'sw_if_index': sw_if_index,
613 'prefix_group': prefix_group,
616 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
617 prefix_length, prefix_group,
619 return self.api(self.papi.ip6_add_del_address_using_prefix,
620 {'sw_if_index': sw_if_index,
621 'prefix_group': prefix_group,
623 'prefix_length': prefix_length,
626 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
627 filter_mac=0, bvi_mac=0):
628 """Create/delete L2 FIB entry.
630 :param str mac: MAC address to create FIB entry for.
631 :param int bd_id: Bridge domain index.
632 :param int sw_if_index: Software interface index of the interface.
633 :param int is_add: Add or delete flag. (Default value = 1)
634 :param int static_mac: Set to 1 to create static MAC entry.
636 :param int filter_mac: Set to 1 to drop packet that's source or
637 destination MAC address contains defined MAC address.
639 :param int bvi_mac: Set to 1 to create entry that points to BVI
640 interface. (Default value = 0)
642 return self.api(self.papi.l2fib_add_del,
645 'sw_if_index': sw_if_index,
647 'static_mac': static_mac,
648 'filter_mac': filter_mac,
651 def l2fib_flush_int(self, sw_if_index):
652 """Flush L2 FIB entries for sw_if_index.
654 :param int sw_if_index: Software interface index of the interface.
656 return self.api(self.papi.l2fib_flush_int,
657 {'sw_if_index': sw_if_index})
659 def l2fib_flush_bd(self, bd_id):
660 """Flush L2 FIB entries for bd_id.
662 :param int sw_if_index: Bridge Domain id.
664 return self.api(self.papi.l2fib_flush_bd,
667 def l2fib_flush_all(self):
670 return self.api(self.papi.l2fib_flush_all, {})
672 def l2_fib_table_dump(self, bd_id):
673 """ Dump the L2 FIB """
674 return self.api(self.papi.l2_fib_table_dump,
677 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
678 shg=0, port_type=L2_PORT_TYPE.NORMAL,
680 """Add/remove interface to/from bridge domain.
682 :param int sw_if_index: Software interface index of the interface.
683 :param int bd_id: Bridge domain index.
684 :param int shg: Split-horizon group index. (Default value = 0)
685 :param int bvi: Set interface as a bridge group virtual interface.
687 :param int enable: Add or remove interface. (Default value = 1)
689 return self.api(self.papi.sw_interface_set_l2_bridge,
690 {'rx_sw_if_index': sw_if_index,
693 'port_type': port_type,
696 def bridge_flags(self, bd_id, is_set, feature_bitmap):
697 """Enable/disable required feature of the bridge domain with defined
700 :param int bd_id: Bridge domain ID.
701 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
702 :param int flags: Bitmap value of the feature to be set:
706 - uu-flood (1 << 3) or
709 return self.api(self.papi.bridge_flags,
712 'flags': feature_bitmap})
714 def bridge_domain_dump(self, bd_id=0):
717 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
718 existing bridge domains returned)
719 :return: Dictionary of bridge domain(s) data.
721 return self.api(self.papi.bridge_domain_dump,
724 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
726 """Create or delete unidirectional cross-connect from Tx interface to
729 :param int rx_sw_if_index: Software interface index of Rx interface.
730 :param int tx_sw_if_index: Software interface index of Tx interface.
731 :param int enable: Create cross-connect if equal to 1, delete
732 cross-connect if equal to 0.
735 return self.api(self.papi.sw_interface_set_l2_xconnect,
736 {'rx_sw_if_index': rx_sw_if_index,
737 'tx_sw_if_index': tx_sw_if_index,
740 def sw_interface_set_l2_tag_rewrite(
747 """L2 interface vlan tag rewrite configure request
748 :param client_index - opaque cookie to identify the sender
749 :param context - sender context, to match reply w/ request
750 :param sw_if_index - interface the operation is applied to
751 :param vtr_op - Choose from l2_vtr_op_t enum values
752 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
753 :param tag1 - Needed for any push or translate vtr op
754 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
757 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
758 {'sw_if_index': sw_if_index,
764 def sw_interface_set_l2_emulation(
769 :param sw_if_index - interface the operation is applied to
772 return self.api(self.papi.l2_emulation,
773 {'sw_if_index': sw_if_index,
776 def sw_interface_set_ip_directed_broadcast(
780 """IP Directed broadcast
781 :param sw_if_index - interface the operation is applied to
784 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
785 {'sw_if_index': sw_if_index,
788 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
791 :param admin_up_down:
795 return self.api(self.papi.sw_interface_set_flags,
796 {'sw_if_index': sw_if_index,
797 'admin_up_down': admin_up_down})
799 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
805 return self.api(self.papi.sw_interface_set_mtu,
806 {'sw_if_index': sw_if_index,
809 def sw_interface_set_promiscuous(self, sw_if_index, enable):
815 return self.api(self.papi.sw_interface_set_promiscuous,
816 {'sw_if_index': sw_if_index,
819 def sw_interface_set_mac_address(self, sw_if_index, mac):
820 return self.api(self.papi.sw_interface_set_mac_address,
821 {'sw_if_index': sw_if_index,
824 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
825 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
826 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
827 """Create subinterface
828 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
830 :param sub_id: param inner_vlan:
834 :param no_tags: (Default value = 0)
835 :param one_tag: (Default value = 0)
836 :param two_tags: (Default value = 0)
837 :param dot1ad: (Default value = 0)
838 :param exact_match: (Default value = 0)
839 :param default_sub: (Default value = 0)
840 :param outer_vlan_id_any: (Default value = 0)
841 :param inner_vlan_id_any: (Default value = 0)
845 self.papi.create_subif,
846 {'sw_if_index': sw_if_index,
850 'two_tags': two_tags,
852 'exact_match': exact_match,
853 'default_sub': default_sub,
854 'outer_vlan_id_any': outer_vlan_id_any,
855 'inner_vlan_id_any': inner_vlan_id_any,
856 'outer_vlan_id': outer_vlan,
857 'inner_vlan_id': inner_vlan})
859 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
860 """Create p2p ethernet subinterface
862 :param sw_if_index: main (parent) interface
863 :param remote_mac: client (remote) mac address
867 self.papi.p2p_ethernet_add,
868 {'parent_if_index': sw_if_index,
869 'remote_mac': remote_mac,
870 'subif_id': subif_id})
872 def delete_subif(self, sw_if_index):
873 """Delete subinterface
877 return self.api(self.papi.delete_subif,
878 {'sw_if_index': sw_if_index})
880 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
881 """Delete p2p ethernet subinterface
883 :param sw_if_index: main (parent) interface
884 :param remote_mac: client (remote) mac address
888 self.papi.p2p_ethernet_del,
889 {'parent_if_index': sw_if_index,
890 'remote_mac': remote_mac})
892 def create_vlan_subif(self, sw_if_index, vlan):
899 return self.api(self.papi.create_vlan_subif,
900 {'sw_if_index': sw_if_index,
903 def create_loopback(self, mac=''):
906 :param mac: (Optional)
908 return self.api(self.papi.create_loopback,
909 {'mac_address': mac})
911 def delete_loopback(self, sw_if_index):
912 return self.api(self.papi.delete_loopback,
913 {'sw_if_index': sw_if_index, })
915 def ip_table_add_del(self,
922 :param is_add: (Default value = 1)
923 :param is_ipv6: (Default value = 0)
928 self.papi.ip_table_add_del,
929 {'table_id': table_id,
933 def ip_add_del_route(
938 next_hop_sw_if_index=0xFFFFFFFF,
942 next_hop_n_out_labels=0,
943 next_hop_out_label_stack=[],
944 next_hop_via_label=MPLS_LABEL_INVALID,
945 next_hop_id=0xFFFFFFFF,
947 is_resolve_attached=0,
948 classify_table_index=0xFFFFFFFF,
962 :param dst_address_length:
963 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
965 :param next_hop_address:
966 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
967 :param vrf_id: (Default value = 0)
968 :param lookup_in_vrf: (Default value = 0)
969 :param classify_table_index: (Default value = 0xFFFFFFFF)
970 :param is_add: (Default value = 1)
971 :param is_drop: (Default value = 0)
972 :param is_ipv6: (Default value = 0)
973 :param is_local: (Default value = 0)
974 :param is_classify: (Default value = 0)
975 :param is_multipath: (Default value = 0)
976 :param is_resolve_host: (Default value = 0)
977 :param is_resolve_attached: (Default value = 0)
978 :param is_dvr: (Default value = 0)
979 :param is_source_lookup: (Default value = 0)
980 :param next_hop_weight: (Default value = 1)
985 self.papi.ip_add_del_route,
986 {'next_hop_sw_if_index': next_hop_sw_if_index,
987 'table_id': table_id,
988 'classify_table_index': classify_table_index,
989 'next_hop_table_id': next_hop_table_id,
992 'is_unreach': is_unreach,
993 'is_prohibit': is_prohibit,
995 'is_local': is_local,
996 'is_classify': is_classify,
997 'is_multipath': is_multipath,
998 'is_resolve_host': is_resolve_host,
999 'is_resolve_attached': is_resolve_attached,
1001 'is_source_lookup': is_source_lookup,
1002 'is_udp_encap': is_udp_encap,
1003 'next_hop_weight': next_hop_weight,
1004 'dst_address_length': dst_address_length,
1005 'dst_address': dst_address,
1006 'next_hop_id': next_hop_id,
1007 'next_hop_address': next_hop_address,
1008 'next_hop_n_out_labels': next_hop_n_out_labels,
1009 'next_hop_via_label': next_hop_via_label,
1010 'next_hop_out_label_stack': next_hop_out_label_stack})
1012 def ip_fib_dump(self):
1013 return self.api(self.papi.ip_fib_dump, {})
1015 def ip6_fib_dump(self):
1016 return self.api(self.papi.ip6_fib_dump, {})
1018 def ip_neighbor_add_del(self,
1027 """ Add neighbor MAC to IPv4 or IPv6 address.
1032 :param is_add: (Default value = 1)
1033 :param is_ipv6: (Default value = 0)
1034 :param is_static: (Default value = 0)
1035 :param is_no_adj_fib: (Default value = 0)
1038 self.papi.ip_neighbor_add_del,
1039 {'sw_if_index': sw_if_index,
1042 'is_static': is_static,
1043 'is_no_adj_fib': is_no_adj_fib,
1044 'mac_address': mac_address,
1045 'dst_address': dst_address
1049 def ip_neighbor_dump(self,
1052 """ Return IP neighbor dump.
1055 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1059 self.papi.ip_neighbor_dump,
1060 {'is_ipv6': is_ipv6,
1061 'sw_if_index': sw_if_index
1065 def proxy_arp_add_del(self,
1070 """ Config Proxy Arp Range.
1072 :param low_address: Start address in the rnage to Proxy for
1073 :param hi_address: End address in the rnage to Proxy for
1074 :param vrf_id: The VRF/table in which to proxy
1078 self.papi.proxy_arp_add_del,
1082 'low_address': low_address,
1083 'hi_address': hi_address,
1087 def proxy_arp_intfc_enable_disable(self,
1090 """ Enable/Disable an interface for proxy ARP requests
1092 :param sw_if_index: Interface
1093 :param enable_disable: Enable/Disable
1097 self.papi.proxy_arp_intfc_enable_disable,
1098 {'sw_if_index': sw_if_index,
1099 'enable_disable': is_enable
1107 """ Reset VRF (remove all routes etc.) request.
1109 :param int vrf_id: ID of the FIB table / VRF to reset.
1110 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1114 self.papi.reset_vrf,
1124 """ Reset VRF (remove all routes etc.) request.
1126 :param int vrf_id: ID of the FIB table / VRF to reset.
1127 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1131 self.papi.reset_fib,
1142 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1147 {'is_ipv6': is_ipv6,
1151 def sw_interface_span_enable_disable(
1152 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1155 :param sw_if_index_from:
1156 :param sw_if_index_to:
1160 return self.api(self.papi.sw_interface_span_enable_disable,
1161 {'sw_if_index_from': sw_if_index_from,
1162 'sw_if_index_to': sw_if_index_to,
1167 def gre_tunnel_add_del(self,
1172 instance=0xFFFFFFFF,
1176 """ Add a GRE tunnel
1180 :param outer_fib_id: (Default value = 0)
1181 :param tunnel_type: (Default value = 0)
1182 :param instance: (Default value = 0xFFFFFFFF)
1183 :param session_id: (Defalt value = 0)
1184 :param is_add: (Default value = 1)
1185 :param is_ipv6: (Default value = 0)
1189 self.papi.gre_add_del_tunnel,
1192 'tunnel_type': tunnel_type,
1193 'instance': instance,
1194 'src_address': src_address,
1195 'dst_address': dst_address,
1196 'outer_fib_id': outer_fib_id,
1197 'session_id': session_id}
1200 def udp_encap_add(self,
1206 """ Add a GRE tunnel
1211 :param outer_fib_id: (Default value = 0)
1215 self.papi.udp_encap_add,
1220 'src_port': src_port,
1221 'dst_port': dst_port,
1222 'table_id': table_id
1226 def udp_encap_del(self, id):
1227 return self.api(self.papi.udp_encap_del, {'id': id})
1229 def udp_encap_dump(self):
1230 return self.api(self.papi.udp_encap_dump, {})
1232 def want_udp_encap_stats(self, enable=1):
1233 return self.api(self.papi.want_udp_encap_stats,
1235 'pid': os.getpid()})
1237 def mpls_fib_dump(self):
1238 return self.api(self.papi.mpls_fib_dump, {})
1240 def mpls_table_add_del(
1247 :param is_add: (Default value = 1)
1252 self.papi.mpls_table_add_del,
1253 {'mt_table_id': table_id,
1254 'mt_is_add': is_add})
1256 def mpls_route_add_del(
1262 next_hop_sw_if_index=0xFFFFFFFF,
1264 next_hop_table_id=0,
1266 next_hop_n_out_labels=0,
1267 next_hop_out_label_stack=[],
1268 next_hop_via_label=MPLS_LABEL_INVALID,
1270 is_resolve_attached=0,
1277 classify_table_index=0xFFFFFFFF,
1281 :param dst_address_length:
1282 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1284 :param next_hop_address:
1285 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1286 :param vrf_id: (Default value = 0)
1287 :param lookup_in_vrf: (Default value = 0)
1288 :param classify_table_index: (Default value = 0xFFFFFFFF)
1289 :param is_add: (Default value = 1)
1290 :param is_drop: (Default value = 0)
1291 :param is_ipv6: (Default value = 0)
1292 :param is_local: (Default value = 0)
1293 :param is_classify: (Default value = 0)
1294 :param is_multipath: (Default value = 0)
1295 :param is_multicast: (Default value = 0)
1296 :param is_resolve_host: (Default value = 0)
1297 :param is_resolve_attached: (Default value = 0)
1298 :param next_hop_weight: (Default value = 1)
1302 self.papi.mpls_route_add_del,
1305 'mr_table_id': table_id,
1306 'mr_classify_table_index': classify_table_index,
1307 'mr_is_add': is_add,
1308 'mr_is_classify': is_classify,
1309 'mr_is_multipath': is_multipath,
1310 'mr_is_multicast': is_multicast,
1311 'mr_is_resolve_host': is_resolve_host,
1312 'mr_is_resolve_attached': is_resolve_attached,
1313 'mr_is_interface_rx': is_interface_rx,
1314 'mr_is_rpf_id': is_rpf_id,
1315 'mr_next_hop_proto': next_hop_proto,
1316 'mr_next_hop_weight': next_hop_weight,
1317 'mr_next_hop': next_hop_address,
1318 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1319 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1320 'mr_next_hop_table_id': next_hop_table_id,
1321 'mr_next_hop_via_label': next_hop_via_label,
1322 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1324 def mpls_ip_bind_unbind(
1336 self.papi.mpls_ip_bind_unbind,
1337 {'mb_mpls_table_id': table_id,
1339 'mb_ip_table_id': ip_table_id,
1340 'mb_is_bind': is_bind,
1341 'mb_is_ip4': is_ip4,
1342 'mb_address_length': dst_address_length,
1343 'mb_address': dst_address})
1345 def mpls_tunnel_add_del(
1348 next_hop_proto_is_ip4,
1350 next_hop_sw_if_index=0xFFFFFFFF,
1351 next_hop_table_id=0,
1353 next_hop_n_out_labels=0,
1354 next_hop_out_label_stack=[],
1355 next_hop_via_label=MPLS_LABEL_INVALID,
1361 :param dst_address_length:
1362 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1364 :param next_hop_address:
1365 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1366 :param vrf_id: (Default value = 0)
1367 :param lookup_in_vrf: (Default value = 0)
1368 :param classify_table_index: (Default value = 0xFFFFFFFF)
1369 :param is_add: (Default value = 1)
1370 :param is_drop: (Default value = 0)
1371 :param is_ipv6: (Default value = 0)
1372 :param is_local: (Default value = 0)
1373 :param is_classify: (Default value = 0)
1374 :param is_multipath: (Default value = 0)
1375 :param is_resolve_host: (Default value = 0)
1376 :param is_resolve_attached: (Default value = 0)
1377 :param next_hop_weight: (Default value = 1)
1378 :param is_multicast: (Default value = 0)
1382 self.papi.mpls_tunnel_add_del,
1383 {'mt_sw_if_index': tun_sw_if_index,
1384 'mt_is_add': is_add,
1385 'mt_l2_only': l2_only,
1386 'mt_is_multicast': is_multicast,
1387 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1388 'mt_next_hop_weight': next_hop_weight,
1389 'mt_next_hop': next_hop_address,
1390 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1391 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1392 'mt_next_hop_table_id': next_hop_table_id,
1393 'mt_next_hop_via_label': next_hop_via_label,
1394 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1396 def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
1397 return self.api(self.papi.mpls_tunnel_dump,
1398 {'sw_if_index': sw_if_index})
1400 def nat44_interface_add_del_feature(
1405 """Enable/disable NAT44 feature on the interface
1407 :param sw_if_index: Software index of the interface
1408 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1409 :param is_add: 1 if add, 0 if delete (Default value = 1)
1412 self.papi.nat44_interface_add_del_feature,
1414 'is_inside': is_inside,
1415 'sw_if_index': sw_if_index})
1417 def nat44_interface_add_del_output_feature(
1422 """Enable/disable NAT44 output feature on the interface
1424 :param sw_if_index: Software index of the interface
1425 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1426 :param is_add: 1 if add, 0 if delete (Default value = 1)
1429 self.papi.nat44_interface_add_del_output_feature,
1431 'is_inside': is_inside,
1432 'sw_if_index': sw_if_index})
1434 def nat44_add_del_static_mapping(
1438 external_sw_if_index=0xFFFFFFFF,
1449 """Add/delete NAT44 static mapping
1451 :param local_ip: Local IP address
1452 :param external_ip: External IP address
1453 :param external_sw_if_index: External interface instead of IP address
1454 :param local_port: Local port number (Default value = 0)
1455 :param external_port: External port number (Default value = 0)
1456 :param addr_only: 1 if address only mapping, 0 if address and port
1457 :param vrf_id: VRF ID
1458 :param protocol: IP protocol (Default value = 0)
1459 :param twice_nat: 1 if translate external host address and port
1460 :param self_twice_nat: 1 if translate external host address and port
1461 whenever external host address equals
1462 local address of internal host
1463 :param out2in_only: if 1 rule is matching only out2in direction
1464 :param tag: Opaque string tag
1465 :param is_add: 1 if add, 0 if delete (Default value = 1)
1468 self.papi.nat44_add_del_static_mapping,
1470 'addr_only': addr_only,
1471 'local_ip_address': local_ip,
1472 'external_ip_address': external_ip,
1473 'local_port': local_port,
1474 'external_port': external_port,
1475 'external_sw_if_index': external_sw_if_index,
1477 'protocol': protocol,
1478 'twice_nat': twice_nat,
1479 'self_twice_nat': self_twice_nat,
1480 'out2in_only': out2in_only,
1483 def nat44_add_del_identity_mapping(
1486 sw_if_index=0xFFFFFFFF,
1493 """Add/delete NAT44 identity mapping
1495 :param ip: IP address (Default value = 0)
1496 :param sw_if_index: Interface instead of IP address
1497 :param port: Port number (Default value = 0)
1498 :param addr_only: 1 if address only mapping, 0 if address and port
1499 :param vrf_id: VRF ID
1500 :param protocol: IP protocol (Default value = 0)
1501 :param tag: Opaque string tag
1502 :param is_add: 1 if add, 0 if delete (Default value = 1)
1505 self.papi.nat44_add_del_identity_mapping,
1507 'addr_only': addr_only,
1510 'sw_if_index': sw_if_index,
1513 'protocol': protocol})
1515 def nat44_add_del_address_range(
1522 """Add/del NAT44 address range
1524 :param first_ip_address: First IP address
1525 :param last_ip_address: Last IP address
1526 :param vrf_id: VRF id for the address range
1527 :param twice_nat: twice NAT address for extenal hosts
1528 :param is_add: 1 if add, 0 if delete (Default value = 1)
1531 self.papi.nat44_add_del_address_range,
1532 {'first_ip_address': first_ip_address,
1533 'last_ip_address': last_ip_address,
1535 'twice_nat': twice_nat,
1538 def nat44_address_dump(self):
1539 """Dump NAT44 addresses
1540 :return: Dictionary of NAT44 addresses
1542 return self.api(self.papi.nat44_address_dump, {})
1544 def nat44_interface_dump(self):
1545 """Dump interfaces with NAT44 feature
1546 :return: Dictionary of interfaces with NAT44 feature
1548 return self.api(self.papi.nat44_interface_dump, {})
1550 def nat44_interface_output_feature_dump(self):
1551 """Dump interfaces with NAT44 output feature
1552 :return: Dictionary of interfaces with NAT44 output feature
1554 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1556 def nat44_static_mapping_dump(self):
1557 """Dump NAT44 static mappings
1558 :return: Dictionary of NAT44 static mappings
1560 return self.api(self.papi.nat44_static_mapping_dump, {})
1562 def nat44_identity_mapping_dump(self):
1563 """Dump NAT44 identity mappings
1564 :return: Dictionary of NAT44 identity mappings
1566 return self.api(self.papi.nat44_identity_mapping_dump, {})
1568 def nat_show_config(self):
1569 """Show NAT plugin config
1570 :return: NAT plugin config parameters
1572 return self.api(self.papi.nat_show_config, {})
1574 def nat44_add_interface_addr(
1579 """Add/del NAT44 address from interface
1581 :param sw_if_index: Software index of the interface
1582 :param twice_nat: twice NAT address for extenal hosts
1583 :param is_add: 1 if add, 0 if delete (Default value = 1)
1586 self.papi.nat44_add_del_interface_addr,
1588 'sw_if_index': sw_if_index,
1589 'twice_nat': twice_nat})
1591 def nat44_interface_addr_dump(self):
1592 """Dump NAT44 addresses interfaces
1593 :return: Dictionary of NAT44 addresses interfaces
1595 return self.api(self.papi.nat44_interface_addr_dump, {})
1602 """Enable/disable NAT IPFIX logging
1604 :param domain_id: Observation domain ID (Default value = 1)
1605 :param src_port: Source port number (Default value = 4739)
1606 :param enable: 1 if enable, 0 if disable (Default value = 1)
1609 self.papi.nat_ipfix_enable_disable,
1610 {'domain_id': domain_id,
1611 'src_port': src_port,
1614 def nat44_user_session_dump(
1618 """Dump NAT44 user's sessions
1620 :param ip_address: ip adress of the user to be dumped
1621 :param cpu_index: cpu_index on which the user is
1622 :param vrf_id: VRF ID
1623 :return: Dictionary of S-NAT sessions
1626 self.papi.nat44_user_session_dump,
1627 {'ip_address': ip_address,
1630 def nat44_user_dump(self):
1633 :return: Dictionary of NAT44 users
1635 return self.api(self.papi.nat44_user_dump, {})
1637 def nat44_add_del_lb_static_mapping(
1650 """Add/delete NAT44 load balancing static mapping
1652 :param twice_nat: 1 if translate external host address and port
1653 :param tag: Opaque string tag
1654 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1655 :param is_add - 1 if add, 0 if delete
1658 self.papi.nat44_add_del_lb_static_mapping,
1660 'external_addr': external_addr,
1661 'external_port': external_port,
1662 'protocol': protocol,
1663 'twice_nat': twice_nat,
1664 'self_twice_nat': self_twice_nat,
1665 'out2in_only': out2in_only,
1667 'affinity': affinity,
1668 'local_num': local_num,
1671 def nat44_lb_static_mapping_add_del_local(
1681 """Add/delete NAT44 load-balancing static mapping rule backend
1683 :param external_addr: external IPv4 address of the servic
1684 :param external_port: external L4 port number of the service
1685 :param local_addr: IPv4 address of the internal node
1686 :param local_port: L4 port number of the internal node
1687 :param protocol: IP protocol number
1688 :param probability: probability of the internal node
1689 :param vrf_id: VRF id of the internal node
1690 :param is_add: 1 if add, 0 if delete
1693 self.papi.nat44_lb_static_mapping_add_del_local,
1695 'external_addr': external_addr,
1696 'external_port': external_port,
1700 'probability': probability,
1702 'protocol': protocol})
1704 def nat44_lb_static_mapping_dump(self):
1705 """Dump NAT44 load balancing static mappings
1707 :return: Dictionary of NAT44 load balancing static mapping
1709 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1711 def nat44_del_session(
1718 ext_host_address=None,
1720 """Delete NAT44 session
1722 :param addr: IPv4 address
1723 :param por: port number
1724 :param protocol: IP protocol number
1725 :param vrf_id: VRF ID
1726 :param is_in: 1 if inside network addres and port pari, 0 if outside
1727 :param ext_host_address: external host IPv4 address
1728 :param ext_host_port: external host port
1730 if ext_host_address is None:
1732 self.papi.nat44_del_session,
1735 'protocol': protocol,
1740 self.papi.nat44_del_session,
1743 'protocol': protocol,
1746 'ext_host_valid': 1,
1747 'ext_host_address': ext_host_address,
1748 'ext_host_port': ext_host_port})
1750 def nat44_forwarding_enable_disable(
1753 """Enable/disable forwarding for NAT44
1755 :param enable: 1 for enable, 0 for disable
1758 self.papi.nat44_forwarding_enable_disable,
1768 """Set NAT virtual fragmentation reassembly
1770 :param timeout: reassembly timeout (Default 2sec)
1771 :param max_reass: maximum concurrent reassemblies (Default 1024)
1772 :param max_frag: maximum fragmets per reassembly (Default 5)
1773 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1774 :param is_ip6: 1 if IPv6, 0 if IPv4
1777 self.papi.nat_set_reass,
1778 {'timeout': timeout,
1779 'max_reass': max_reass,
1780 'max_frag': max_frag,
1781 'drop_frag': drop_frag,
1784 def nat_get_reass(self):
1785 """Get NAT virtual fragmentation reassembly configuration
1787 :return: NAT virtual fragmentation reassembly configuration
1789 return self.api(self.papi.nat_get_reass, {})
1791 def nat_reass_dump(self):
1792 """Dump NAT virtual fragmentation reassemblies
1794 :return: Dictionary of NAT virtual fragmentation reassemblies
1796 return self.api(self.papi.nat_reass_dump, {})
1798 def nat_det_add_del_map(
1805 """Add/delete deterministic NAT mapping
1807 :param is_add - 1 if add, 0 if delete
1808 :param in_addr - inside IP address
1809 :param in_plen - inside IP address prefix length
1810 :param out_addr - outside IP address
1811 :param out_plen - outside IP address prefix length
1814 self.papi.nat_det_add_del_map,
1819 'out_addr': out_addr,
1820 'out_plen': out_plen})
1822 def nat_det_forward(
1825 """Get outside address and port range from inside address
1827 :param in_addr - inside IP address
1830 self.papi.nat_det_forward,
1831 {'in_addr': in_addr,
1834 def nat_det_reverse(
1838 """Get inside address from outside address and port
1840 :param out_addr - outside IP address
1841 :param out_port - outside port
1844 self.papi.nat_det_reverse,
1845 {'out_addr': out_addr,
1846 'out_port': out_port})
1848 def nat_det_map_dump(self):
1849 """Dump deterministic NAT mappings
1851 :return: Dictionary of deterministic NAT mappings
1853 return self.api(self.papi.nat_det_map_dump, {})
1855 def nat_set_timeouts(
1858 tcp_established=7440,
1861 """Set values of timeouts for NAT sessions (in seconds)
1863 :param udp - UDP timeout (Default value = 300)
1864 :param tcp_established - TCP established timeout (Default value = 7440)
1865 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1866 :param icmp - ICMP timeout (Default value = 60)
1869 self.papi.nat_set_timeouts,
1871 'tcp_established': tcp_established,
1872 'tcp_transitory': tcp_transitory,
1875 def nat_get_timeouts(self):
1876 """Get values of timeouts for NAT sessions
1878 :return: Timeouts for NAT sessions (in seconds)
1880 return self.api(self.papi.nat_get_timeouts, {})
1882 def nat_set_addr_and_port_alloc_alg(
1890 """Set address and port assignment algorithm
1892 :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1893 :param psid_offset: number of offset bits (valid only for MAP-E alg)
1894 :param psid_length: length of PSID (valid only for MAP-E alg)
1895 :param psid: Port Set Identifier value (valid only for MAP-E alg)
1896 :param start_port: beginning of the port range
1897 :param end_port: end of the port range
1900 self.papi.nat_set_addr_and_port_alloc_alg,
1902 'psid_offset': psid_offset,
1903 'psid_length': psid_length,
1905 'start_port': start_port,
1906 'end_port': end_port})
1908 def nat_get_addr_and_port_alloc_alg(self):
1909 """Get address and port assignment algorithm"""
1910 return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1912 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1913 """Set TCP MSS rewriting configuration
1915 :param enable: disable(0)/enable(1) MSS rewriting feature
1916 :param mss_value: MSS value to be used for MSS rewriting
1919 self.papi.nat_set_mss_clamping,
1920 {'enable': enable, 'mss_value': mss_value})
1922 def nat_get_mss_clamping(self):
1923 """Get TCP MSS rewriting configuration"""
1924 return self.api(self.papi.nat_get_mss_clamping, {})
1926 def nat_det_close_session_out(
1932 """Close deterministic NAT session using outside address and port
1934 :param out_addr - outside IP address
1935 :param out_port - outside port
1936 :param ext_addr - external host IP address
1937 :param ext_port - external host port
1940 self.papi.nat_det_close_session_out,
1941 {'out_addr': out_addr,
1942 'out_port': out_port,
1943 'ext_addr': ext_addr,
1944 'ext_port': ext_port})
1946 def nat_det_close_session_in(
1952 """Close deterministic NAT session using inside address and port
1954 :param in_addr - inside IP address
1955 :param in_port - inside port
1956 :param ext_addr - external host IP address
1957 :param ext_port - external host port
1960 self.papi.nat_det_close_session_in,
1961 {'in_addr': in_addr,
1963 'ext_addr': ext_addr,
1964 'ext_port': ext_port,
1967 def nat_det_session_dump(
1970 """Dump deterministic NAT sessions belonging to a user
1972 :param user_addr - inside IP address of the user
1973 :return: Dictionary of deterministic NAT sessions
1976 self.papi.nat_det_session_dump,
1978 'user_addr': user_addr})
1980 def nat64_add_del_pool_addr_range(
1986 """Add/del address range to NAT64 pool
1988 :param start_addr: First IP address
1989 :param end_addr: Last IP address
1990 :param vrf_id: VRF id for the address range
1991 :param is_add: 1 if add, 0 if delete (Default value = 1)
1994 self.papi.nat64_add_del_pool_addr_range,
1995 {'start_addr': start_addr,
1996 'end_addr': end_addr,
2000 def nat64_pool_addr_dump(self):
2001 """Dump NAT64 pool addresses
2002 :return: Dictionary of NAT64 pool addresses
2004 return self.api(self.papi.nat64_pool_addr_dump, {})
2006 def nat64_add_del_interface(
2011 """Enable/disable NAT64 feature on the interface
2012 :param sw_if_index: Index of the interface
2013 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2014 :param is_add: 1 if add, 0 if delete (Default value = 1)
2017 self.papi.nat64_add_del_interface,
2018 {'sw_if_index': sw_if_index,
2019 'is_inside': is_inside,
2022 def nat64_interface_dump(self):
2023 """Dump interfaces with NAT64 feature
2024 :return: Dictionary of interfaces with NAT64 feature
2026 return self.api(self.papi.nat64_interface_dump, {})
2028 def nat64_add_del_static_bib(
2037 """Add/delete S-NAT static BIB entry
2039 :param in_ip: Inside IPv6 address
2040 :param out_ip: Outside IPv4 address
2041 :param in_port: Inside port number
2042 :param out_port: Outside port number
2043 :param protocol: IP protocol
2044 :param vrf_id: VRF ID (Default value = 0)
2045 :param is_add: 1 if add, 0 if delete (Default value = 1)
2048 self.papi.nat64_add_del_static_bib,
2057 def nat64_bib_dump(self, protocol=255):
2060 :param protocol: IP protocol (Default value = 255, all BIBs)
2061 :returns: Dictionary of NAT64 BIB entries
2063 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
2065 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
2066 tcp_incoming_syn=6):
2067 """Set values of timeouts for NAT64 (in seconds)
2069 :param udpi: UDP timeout (Default value = 300)
2070 :param icmp: ICMP timeout (Default value = 60)
2071 :param tcp_trans: TCP transitory timeout (Default value = 240)
2072 :param tcp_est: TCP established timeout (Default value = 7440)
2073 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
2076 self.papi.nat64_set_timeouts,
2079 'tcp_trans': tcp_trans,
2081 'tcp_incoming_syn': tcp_incoming_syn})
2083 def nat64_get_timeouts(self):
2084 """Get values of timeouts for NAT64
2086 :return: Timeouts for NAT64 (in seconds)
2088 return self.api(self.papi.nat64_get_timeouts, {})
2090 def nat64_st_dump(self, protocol=255):
2091 """Dump NAT64 session table
2093 :param protocol: IP protocol (Default value = 255, all STs)
2094 :returns: Dictionary of NAT64 sesstion table entries
2096 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2098 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2099 """Add/del NAT64 prefix
2101 :param prefix: NAT64 prefix
2102 :param plen: NAT64 prefix length
2103 :param vrf_id: VRF id of tenant (Default 0)
2104 :param is_add: 1 if add, 0 if delete (Default value = 1)
2107 self.papi.nat64_add_del_prefix,
2113 def nat64_prefix_dump(self):
2114 """Dump NAT64 prefix
2116 :returns: Dictionary of NAT64 prefixes
2118 return self.api(self.papi.nat64_prefix_dump, {})
2120 def nat64_add_interface_addr(
2124 """Add/del NAT64 address from interface
2126 :param sw_if_index: Software index of the interface
2127 :param is_add: 1 if add, 0 if delete (Default value = 1)
2129 return self.api(self.papi.nat64_add_del_interface_addr,
2130 {'is_add': is_add, 'sw_if_index': sw_if_index})
2132 def dslite_set_aftr_addr(self, ip6, ip4):
2133 """Set DS-Lite AFTR addresses
2135 :param ip4: IPv4 address
2136 :param ip6: IPv6 address
2139 self.papi.dslite_set_aftr_addr,
2143 def dslite_set_b4_addr(self, ip6, ip4):
2144 """Set DS-Lite B4 IPv6 address
2146 :param ip4: IPv4 address
2147 :param ip6: IPv6 address
2150 self.papi.dslite_set_b4_addr,
2154 def dslite_add_del_pool_addr_range(
2159 """Add/del address range to DS-Lite pool
2161 :param start_addr: First IP address
2162 :param end_addr: Last IP address
2163 :param is_add: 1 if add, 0 if delete (Default value = 1)
2166 self.papi.dslite_add_del_pool_addr_range,
2167 {'start_addr': start_addr,
2168 'end_addr': end_addr,
2171 def nat66_add_del_interface(
2176 """Enable/disable NAT66 feature on the interface
2177 :param sw_if_index: Index of the interface
2178 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2179 :param is_add: 1 if add, 0 if delete (Default value = 1)
2182 self.papi.nat66_add_del_interface,
2183 {'sw_if_index': sw_if_index,
2184 'is_inside': is_inside,
2187 def nat66_add_del_static_mapping(
2193 """Add/delete NAT66 static mapping
2195 :param in_ip: Inside IPv6 address
2196 :param out_ip: Outside IPv6 address
2197 :param vrf_id: VRF ID (Default value = 0)
2198 :param is_add: 1 if add, 0 if delete (Default value = 1)
2201 self.papi.nat66_add_del_static_mapping,
2202 {'local_ip_address': in_ip,
2203 'external_ip_address': out_ip,
2207 def nat66_interface_dump(self):
2208 """Dump interfaces with NAT66 feature
2209 :return: Dictionary of interfaces with NAT66 feature
2211 return self.api(self.papi.nat66_interface_dump, {})
2213 def nat66_static_mapping_dump(self):
2214 """Dump NAT66 static mappings
2215 :return: Dictionary of NAT66 static mappings
2217 return self.api(self.papi.nat66_static_mapping_dump, {})
2219 def control_ping(self):
2220 self.api(self.papi.control_ping)
2222 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2223 detect_mult, local_addr, peer_addr, is_ipv6=0,
2224 bfd_key_id=None, conf_key_id=None):
2225 if bfd_key_id is None:
2226 return self.api(self.papi.bfd_udp_add,
2228 'sw_if_index': sw_if_index,
2229 'desired_min_tx': desired_min_tx,
2230 'required_min_rx': required_min_rx,
2231 'local_addr': local_addr,
2232 'peer_addr': peer_addr,
2234 'detect_mult': detect_mult,
2237 return self.api(self.papi.bfd_udp_add,
2239 'sw_if_index': sw_if_index,
2240 'desired_min_tx': desired_min_tx,
2241 'required_min_rx': required_min_rx,
2242 'local_addr': local_addr,
2243 'peer_addr': peer_addr,
2245 'detect_mult': detect_mult,
2246 'is_authenticated': 1,
2247 'bfd_key_id': bfd_key_id,
2248 'conf_key_id': conf_key_id,
2251 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2252 detect_mult, local_addr, peer_addr, is_ipv6=0):
2253 return self.api(self.papi.bfd_udp_mod,
2255 'sw_if_index': sw_if_index,
2256 'desired_min_tx': desired_min_tx,
2257 'required_min_rx': required_min_rx,
2258 'local_addr': local_addr,
2259 'peer_addr': peer_addr,
2261 'detect_mult': detect_mult,
2264 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2265 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2267 return self.api(self.papi.bfd_udp_auth_activate,
2269 'sw_if_index': sw_if_index,
2270 'local_addr': local_addr,
2271 'peer_addr': peer_addr,
2273 'is_delayed': 1 if is_delayed else 0,
2274 'bfd_key_id': bfd_key_id,
2275 'conf_key_id': conf_key_id,
2278 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2279 is_ipv6=0, is_delayed=False):
2280 return self.api(self.papi.bfd_udp_auth_deactivate,
2282 'sw_if_index': sw_if_index,
2283 'local_addr': local_addr,
2284 'peer_addr': peer_addr,
2286 'is_delayed': 1 if is_delayed else 0,
2289 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2290 return self.api(self.papi.bfd_udp_del,
2292 'sw_if_index': sw_if_index,
2293 'local_addr': local_addr,
2294 'peer_addr': peer_addr,
2298 def bfd_udp_session_dump(self):
2299 return self.api(self.papi.bfd_udp_session_dump, {})
2301 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2302 peer_addr, is_ipv6=0):
2303 return self.api(self.papi.bfd_udp_session_set_flags, {
2304 'admin_up_down': admin_up_down,
2305 'sw_if_index': sw_if_index,
2306 'local_addr': local_addr,
2307 'peer_addr': peer_addr,
2311 def want_bfd_events(self, enable_disable=1):
2312 return self.api(self.papi.want_bfd_events, {
2313 'enable_disable': enable_disable,
2317 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2318 return self.api(self.papi.bfd_auth_set_key, {
2319 'conf_key_id': conf_key_id,
2320 'auth_type': auth_type,
2322 'key_len': len(key),
2325 def bfd_auth_del_key(self, conf_key_id):
2326 return self.api(self.papi.bfd_auth_del_key, {
2327 'conf_key_id': conf_key_id,
2330 def bfd_auth_keys_dump(self):
2331 return self.api(self.papi.bfd_auth_keys_dump, {})
2333 def bfd_udp_set_echo_source(self, sw_if_index):
2334 return self.api(self.papi.bfd_udp_set_echo_source,
2335 {'sw_if_index': sw_if_index})
2337 def bfd_udp_del_echo_source(self):
2338 return self.api(self.papi.bfd_udp_del_echo_source, {})
2340 def bfd_udp_get_echo_source(self):
2341 return self.api(self.papi.bfd_udp_get_echo_source, {})
2343 def classify_add_del_table(
2348 table_index=0xFFFFFFFF,
2350 memory_size=2097152,
2352 next_table_index=0xFFFFFFFF,
2353 miss_next_index=0xFFFFFFFF,
2354 current_data_flag=0,
2355 current_data_offset=0):
2359 :param match_n_vectors: (Default value = 1)
2360 :param table_index: (Default value = 0xFFFFFFFF)
2361 :param nbuckets: (Default value = 2)
2362 :param memory_size: (Default value = 2097152)
2363 :param skip_n_vectors: (Default value = 0)
2364 :param next_table_index: (Default value = 0xFFFFFFFF)
2365 :param miss_next_index: (Default value = 0xFFFFFFFF)
2366 :param current_data_flag: (Default value = 0)
2367 :param current_data_offset: (Default value = 0)
2370 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2371 mask = mask + '\0' * (mask_len - len(mask))
2373 self.papi.classify_add_del_table,
2375 'table_index': table_index,
2376 'nbuckets': nbuckets,
2377 'memory_size': memory_size,
2378 'skip_n_vectors': skip_n_vectors,
2379 'match_n_vectors': match_n_vectors,
2380 'next_table_index': next_table_index,
2381 'miss_next_index': miss_next_index,
2382 'current_data_flag': current_data_flag,
2383 'current_data_offset': current_data_offset,
2384 'mask_len': mask_len,
2387 def classify_add_del_session(
2392 opaque_index=0xFFFFFFFF,
2393 hit_next_index=0xFFFFFFFF,
2401 :param opaque_index: (Default value = 0xFFFFFFFF)
2402 :param hit_next_index: (Default value = 0xFFFFFFFF)
2403 :param advance: (Default value = 0)
2404 :param action: (Default value = 0)
2405 :param metadata: (Default value = 0)
2408 match_len = ((len(match) - 1) / 16 + 1) * 16
2409 match = match + '\0' * (match_len - len(match))
2411 self.papi.classify_add_del_session,
2413 'table_index': table_index,
2414 'hit_next_index': hit_next_index,
2415 'opaque_index': opaque_index,
2418 'metadata': metadata,
2419 'match_len': match_len,
2422 def input_acl_set_interface(
2426 ip4_table_index=0xFFFFFFFF,
2427 ip6_table_index=0xFFFFFFFF,
2428 l2_table_index=0xFFFFFFFF):
2432 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2433 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2434 :param l2_table_index: (Default value = 0xFFFFFFFF)
2438 self.papi.input_acl_set_interface,
2439 {'sw_if_index': sw_if_index,
2440 'ip4_table_index': ip4_table_index,
2441 'ip6_table_index': ip6_table_index,
2442 'l2_table_index': l2_table_index,
2445 def output_acl_set_interface(
2449 ip4_table_index=0xFFFFFFFF,
2450 ip6_table_index=0xFFFFFFFF,
2451 l2_table_index=0xFFFFFFFF):
2455 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2456 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2457 :param l2_table_index: (Default value = 0xFFFFFFFF)
2461 self.papi.output_acl_set_interface,
2462 {'sw_if_index': sw_if_index,
2463 'ip4_table_index': ip4_table_index,
2464 'ip6_table_index': ip6_table_index,
2465 'l2_table_index': l2_table_index,
2468 def set_ipfix_exporter(
2475 collector_port=4739,
2478 self.papi.set_ipfix_exporter,
2480 'collector_address': collector_address,
2481 'collector_port': collector_port,
2482 'src_address': src_address,
2484 'path_mtu': path_mtu,
2485 'template_interval': template_interval,
2486 'udp_checksum': udp_checksum,
2489 def dhcp_proxy_config(self,
2497 self.papi.dhcp_proxy_config,
2499 'rx_vrf_id': rx_table_id,
2500 'server_vrf_id': server_table_id,
2503 'dhcp_server': dhcp_server,
2504 'dhcp_src_address': dhcp_src_address,
2507 def dhcp_proxy_set_vss(self,
2516 self.papi.dhcp_proxy_set_vss,
2519 'vss_type': vss_type,
2520 'vpn_ascii_id': vpn_ascii_id,
2522 'vpn_index': vpn_index,
2527 def dhcp_client_dump(self):
2528 return self.api(self.papi.dhcp_client_dump, {})
2530 def dhcp_client(self,
2535 set_broadcast_flag=1,
2536 want_dhcp_events=0):
2538 self.papi.dhcp_client_config,
2542 'sw_if_index': sw_if_index,
2543 'hostname': hostname,
2545 'want_dhcp_event': want_dhcp_events,
2546 'set_broadcast_flag': set_broadcast_flag,
2550 def ip_mroute_add_del(self,
2556 next_hop_sw_if_index,
2566 IP Multicast Route add/del
2569 self.papi.ip_mroute_add_del,
2570 {'next_hop_sw_if_index': next_hop_sw_if_index,
2571 'entry_flags': e_flags,
2572 'itf_flags': i_flags,
2573 'table_id': table_id,
2577 'is_local': is_local,
2578 'bier_imp': bier_imp,
2579 'next_hop_afi': next_hop_afi,
2580 'grp_address_length': grp_address_length,
2581 'grp_address': grp_address,
2582 'src_address': src_address,
2583 'nh_address': next_hop_address})
2585 def mfib_signal_dump(self):
2586 return self.api(self.papi.mfib_signal_dump, {})
2588 def ip_mfib_dump(self):
2589 return self.api(self.papi.ip_mfib_dump, {})
2591 def ip6_mfib_dump(self):
2592 return self.api(self.papi.ip6_mfib_dump, {})
2594 def lisp_enable_disable(self, is_enabled):
2596 self.papi.lisp_enable_disable,
2598 'is_en': is_enabled,
2601 def lisp_locator_set(self,
2605 self.papi.lisp_add_del_locator_set,
2608 'locator_set_name': ls_name
2611 def lisp_locator_set_dump(self):
2612 return self.api(self.papi.lisp_locator_set_dump, {})
2614 def lisp_locator(self,
2621 self.papi.lisp_add_del_locator,
2624 'locator_set_name': ls_name,
2625 'sw_if_index': sw_if_index,
2626 'priority': priority,
2630 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2632 self.papi.lisp_locator_dump,
2634 'is_index_set': is_index_set,
2636 'ls_index': ls_index,
2639 def lisp_local_mapping(self,
2649 self.papi.lisp_add_del_local_eid,
2651 'locator_set_name': ls_name,
2653 'eid_type': eid_type,
2655 'prefix_len': prefix_len,
2661 def lisp_eid_table_dump(self,
2669 self.papi.lisp_eid_table_dump,
2672 'prefix_length': prefix_length,
2674 'eid_type': eid_type,
2676 'filter': filter_opt,
2679 def lisp_remote_mapping(self,
2689 self.papi.lisp_add_del_remote_mapping,
2692 'eid_type': eid_type,
2694 'eid_len': eid_prefix_len,
2695 'rloc_num': rlocs_num,
2698 'is_src_dst': is_src_dst,
2701 def lisp_adjacency(self,
2710 self.papi.lisp_add_del_adjacency,
2714 'eid_type': eid_type,
2717 'leid_len': leid_len,
2718 'reid_len': reid_len,
2721 def lisp_adjacencies_get(self, vni=0):
2723 self.papi.lisp_adjacencies_get,
2728 def map_add_domain(self,
2738 self.papi.map_add_domain,
2740 'ip6_prefix': ip6_prefix,
2741 'ip4_prefix': ip4_prefix,
2743 'ea_bits_len': ea_bits_len,
2744 'psid_offset': psid_offset,
2745 'psid_length': psid_length,
2749 def map_if_enable_disable(self, is_enable, sw_if_index, is_translation):
2751 self.papi.map_if_enable_disable,
2753 'is_enable': is_enable,
2754 'sw_if_index': sw_if_index,
2755 'is_translation': is_translation,
2758 def map_param_set_tcp(self, tcp_mss):
2760 self.papi.map_param_set_tcp,
2765 def gtpu_add_del_tunnel(
2771 mcast_sw_if_index=0xFFFFFFFF,
2773 decap_next_index=0xFFFFFFFF,
2777 :param is_add: (Default value = 1)
2778 :param is_ipv6: (Default value = 0)
2781 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2782 :param encap_vrf_id: (Default value = 0)
2783 :param decap_next_index: (Default value = 0xFFFFFFFF)
2784 :param teid: (Default value = 0)
2787 return self.api(self.papi.gtpu_add_del_tunnel,
2790 'src_address': src_addr,
2791 'dst_address': dst_addr,
2792 'mcast_sw_if_index': mcast_sw_if_index,
2793 'encap_vrf_id': encap_vrf_id,
2794 'decap_next_index': decap_next_index,
2797 def vxlan_gpe_add_del_tunnel(
2801 mcast_sw_if_index=0xFFFFFFFF,
2812 :param is_add: (Default value = 1)
2813 :param is_ipv6: (Default value = 0)
2814 :param encap_vrf_id: (Default value = 0)
2815 :param decap_vrf_id: (Default value = 0)
2816 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2817 :param protocol: (Default value = 3)
2818 :param vni: (Default value = 0)
2821 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2826 'mcast_sw_if_index': mcast_sw_if_index,
2827 'encap_vrf_id': encap_vrf_id,
2828 'decap_vrf_id': decap_vrf_id,
2829 'protocol': protocol,
2832 def vxlan_gbp_tunnel_add_del(
2836 mcast_sw_if_index=0xFFFFFFFF,
2841 instance=0xFFFFFFFF):
2846 :param is_add: (Default value = 1)
2847 :param is_ipv6: (Default value = 0)
2848 :param encap_table_id: (Default value = 0)
2849 :param decap_next_index: (Default value = 0xFFFFFFFF)
2850 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2851 :param vni: (Default value = 0)
2852 :param instance: (Default value = 0xFFFFFFFF)
2855 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2860 'mcast_sw_if_index': mcast_sw_if_index,
2861 'encap_table_id': encap_table_id,
2863 'instance': instance}})
2865 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2866 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2867 {'sw_if_index': sw_if_index,
2868 '_no_type_conversion': True})
2870 def pppoe_add_del_session(
2880 :param is_add: (Default value = 1)
2881 :param is_ipv6: (Default value = 0)
2883 :param session_id: (Default value = 0)
2885 :param decap_vrf_id: (Default value = 0)
2888 return self.api(self.papi.pppoe_add_del_session,
2891 'session_id': session_id,
2892 'client_ip': client_ip,
2893 'decap_vrf_id': decap_vrf_id,
2894 'client_mac': client_mac})
2896 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2897 return self.api(self.papi.sr_mpls_policy_add,
2901 'n_segments': len(segments),
2902 'segments': segments})
2904 def sr_mpls_policy_del(self, bsid):
2905 return self.api(self.papi.sr_mpls_policy_del,
2908 def sr_localsid_add_del(self,
2915 sw_if_index=0xFFFFFFFF,
2919 """ Add/del IPv6 SR local-SID.
2922 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2923 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2926 :param is_del: (Default value = 0)
2927 :param end_psp: (Default value = 0)
2928 :param sw_if_index: (Default value = 0xFFFFFFFF)
2929 :param vlan_index: (Default value = 0)
2930 :param fib_table: (Default value = 0)
2933 self.papi.sr_localsid_add_del,
2935 'localsid': localsid,
2937 'behavior': behavior,
2938 'sw_if_index': sw_if_index,
2939 'vlan_index': vlan_index,
2940 'fib_table': fib_table,
2941 'nh_addr4': nh_addr4,
2942 'nh_addr6': nh_addr6
2956 :param bsid_addr: bindingSID of the SR Policy
2957 :param weight: weight of the sid list. optional. (default: 1)
2958 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2960 :param type: type/behavior of the SR policy. (default or spray) \
2962 :param fib_table: VRF where to install the FIB entry for the BSID \
2964 :param n_segments: number of segments \
2966 :param segments: a vector of IPv6 address composing the segment list \
2970 self.papi.sr_policy_add,
2971 {'bsid_addr': bsid_addr,
2973 'is_encap': is_encap,
2975 'fib_table': fib_table,
2976 'n_segments': n_segments,
2977 'segments': segments
2986 :param bsid: bindingSID of the SR Policy
2987 :param sr_policy_index: index of the sr policy (default: 0)
2990 self.papi.sr_policy_del,
2991 {'bsid_addr': bsid_addr,
2992 'sr_policy_index': sr_policy_index
2995 def sr_steering_add_del(
3006 Steer traffic L2 and L3 traffic through a given SR policy
3008 :param is_del: delete or add
3009 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
3010 :param sr_policy: is the index of the SR Policy (alt to bsid)
3011 :param table_id: is the VRF where to install the FIB entry for the BSID
3012 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
3013 :param mask_width: is the mask for L3 traffic type
3014 :param sw_if_index: is the incoming interface for L2 traffic
3015 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
3018 self.papi.sr_steering_add_del,
3020 'bsid_addr': bsid_addr,
3021 'sr_policy_index': sr_policy_index,
3022 'table_id': table_id,
3023 'prefix_addr': prefix_addr,
3024 'mask_width': mask_width,
3025 'sw_if_index': sw_if_index,
3026 'traffic_type': traffic_type
3029 def acl_add_replace(self, acl_index, r, tag='',
3031 """Add/replace an ACL
3032 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
3033 :param acl_rule r: ACL rules array.
3034 :param str tag: symbolic tag (description) for this ACL.
3035 :param int count: number of rules.
3037 return self.api(self.papi.acl_add_replace,
3038 {'acl_index': acl_index,
3042 expected_retval=expected_retval)
3044 def acl_del(self, acl_index, expected_retval=0):
3050 return self.api(self.papi.acl_del,
3051 {'acl_index': acl_index},
3052 expected_retval=expected_retval)
3054 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
3056 return self.api(self.papi.acl_interface_set_acl_list,
3057 {'sw_if_index': sw_if_index,
3061 expected_retval=expected_retval)
3063 def acl_interface_set_etype_whitelist(self, sw_if_index,
3066 return self.api(self.papi.acl_interface_set_etype_whitelist,
3067 {'sw_if_index': sw_if_index,
3068 'count': len(whitelist),
3070 'whitelist': whitelist},
3071 expected_retval=expected_retval)
3073 def acl_interface_add_del(self,
3077 """ Add/Delete ACL to/from interface
3081 :param is_add: (Default value = 1)
3084 return self.api(self.papi.acl_interface_add_del,
3087 'sw_if_index': sw_if_index,
3088 'acl_index': acl_index})
3090 def acl_dump(self, acl_index, expected_retval=0):
3091 return self.api(self.papi.acl_dump,
3092 {'acl_index': acl_index},
3093 expected_retval=expected_retval)
3095 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3097 return self.api(self.papi.acl_interface_list_dump,
3098 {'sw_if_index': sw_if_index},
3099 expected_retval=expected_retval)
3101 def macip_acl_add(self, rules, tag=""):
3104 :param rules: list of rules for given acl
3108 return self.api(self.papi.macip_acl_add,
3110 'count': len(rules),
3113 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3116 :param rules: list of rules for given acl
3120 return self.api(self.papi.macip_acl_add_replace,
3121 {'acl_index': acl_index,
3123 'count': len(rules),
3126 def macip_acl_del(self, acl_index):
3132 return self.api(self.papi.macip_acl_del,
3133 {'acl_index': acl_index})
3135 def macip_acl_interface_add_del(self,
3139 """ Add MACIP acl to interface
3143 :param is_add: (Default value = 1)
3146 return self.api(self.papi.macip_acl_interface_add_del,
3148 'sw_if_index': sw_if_index,
3149 'acl_index': acl_index})
3151 def macip_acl_interface_get(self):
3152 """ Return interface acls dump
3155 self.papi.macip_acl_interface_get, {})
3157 def macip_acl_dump(self, acl_index=4294967295):
3158 """ Return MACIP acl dump
3162 self.papi.macip_acl_dump, {'acl_index': acl_index})
3164 def policer_add_del(self,
3175 conform_action_type=1,
3177 exceed_action_type=0,
3179 violate_action_type=0,
3181 return self.api(self.papi.policer_add_del,
3188 'rate_type': rate_type,
3189 'round_type': round_type,
3191 'color_aware': color_aware,
3192 'conform_action_type': conform_action_type,
3193 'conform_dscp': conform_dscp,
3194 'exceed_action_type': exceed_action_type,
3195 'exceed_dscp': exceed_dscp,
3196 'violate_action_type': violate_action_type,
3197 'violate_dscp': violate_dscp})
3199 def ip_punt_police(self,
3203 return self.api(self.papi.ip_punt_police,
3204 {'policer_index': policer_index,
3208 def ip_punt_redirect(self,
3213 return self.api(self.papi.ip_punt_redirect,
3214 {'punt': {'rx_sw_if_index': rx_sw_if_index,
3215 'tx_sw_if_index': tx_sw_if_index,
3219 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
3220 return self.api(self.papi.ip_punt_redirect_dump,
3221 {'sw_if_index': sw_if_index,
3222 'is_ipv6': is_ipv6})
3224 def bier_table_add_del(self,
3228 """ BIER Table add/del """
3230 self.papi.bier_table_add_del,
3231 {'bt_tbl_id': {"bt_set": bti.set_id,
3232 "bt_sub_domain": bti.sub_domain_id,
3233 "bt_hdr_len_id": bti.hdr_len_id},
3234 'bt_label': mpls_label,
3235 'bt_is_add': is_add})
3237 def bier_table_dump(self):
3238 return self.api(self.papi.bier_table_dump, {})
3240 def bier_route_add_del(self,
3246 """ BIER Route add/del """
3248 self.papi.bier_route_add_del,
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 'br_n_paths': len(paths),
3255 'br_is_add': is_add,
3256 'br_is_replace': is_replace})
3258 def bier_route_dump(self, bti):
3260 self.papi.bier_route_dump,
3261 {'br_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 def bier_imp_add(self,
3270 """ BIER Imposition Add """
3272 self.papi.bier_imp_add,
3273 {'bi_tbl_id': {"bt_set": bti.set_id,
3274 "bt_sub_domain": bti.sub_domain_id,
3275 "bt_hdr_len_id": bti.hdr_len_id},
3277 'bi_n_bytes': len(ibytes),
3278 'bi_bytes': ibytes})
3280 def bier_imp_del(self, bi_index):
3281 """ BIER Imposition del """
3283 self.papi.bier_imp_del,
3284 {'bi_index': bi_index})
3286 def bier_imp_dump(self):
3287 return self.api(self.papi.bier_imp_dump, {})
3289 def bier_disp_table_add_del(self,
3292 """ BIER Disposition Table add/del """
3294 self.papi.bier_disp_table_add_del,
3295 {'bdt_tbl_id': bdti,
3296 'bdt_is_add': is_add})
3298 def bier_disp_table_dump(self):
3299 return self.api(self.papi.bier_disp_table_dump, {})
3301 def bier_disp_entry_add_del(self,
3311 """ BIER Route add/del """
3313 while (len(lstack) < 16):
3316 self.papi.bier_disp_entry_add_del,
3317 {'bde_tbl_id': bdti,
3319 'bde_payload_proto': payload_proto,
3321 'bde_paths': [{'next_hop': next_hop,
3322 'table_id': next_hop_tbl_id,
3323 'afi': next_hop_afi,
3324 'rpf_id': next_hop_rpf_id,
3326 'label_stack': lstack}],
3327 'bde_is_add': is_add})
3329 def bier_disp_entry_dump(self, bdti):
3331 self.papi.bier_disp_entry_dump,
3332 {'bde_tbl_id': bdti})
3334 def add_node_next(self, node_name, next_name):
3335 """ Set the next node for a given node request
3340 return self.api(self.papi.add_node_next,
3341 {'node_name': node_name,
3342 'next_name': next_name})
3344 def session_enable_disable(self, is_enabled):
3346 self.papi.session_enable_disable,
3347 {'is_enable': is_enabled})
3349 def ipsec_spd_add_del(self, spd_id, is_add=1):
3350 """ SPD add/del - Wrapper to add or del ipsec SPD
3351 Sample CLI : 'ipsec spd add 1'
3353 :param spd_id - SPD ID to be created in the vpp . mandatory
3354 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3356 :returns: reply from the API
3359 self.papi.ipsec_spd_add_del, {
3360 'spd_id': spd_id, 'is_add': is_add})
3362 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3363 """ IPSEC interface SPD add/del - \
3364 Wrapper to associate/disassociate SPD to interface in VPP
3365 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3367 :param spd_id - SPD ID to associate with the interface . mandatory
3368 :param sw_if_index - Interface Index which needs to ipsec \
3369 association mandatory
3370 :param is_add - add(1) or del(0) association with interface \
3371 (Default 1 - add) . optional
3372 :returns: reply from the API
3375 self.papi.ipsec_interface_add_del_spd,
3376 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3378 def ipsec_sad_add_del_entry(self,
3381 integrity_algorithm,
3386 tunnel_src_address='',
3387 tunnel_dst_address='',
3393 use_extended_sequence_number=0):
3394 """ IPSEC SA add/del
3395 :param sad_id: security association ID
3396 :param spi: security param index of the SA in decimal
3397 :param integrity_algorithm:
3398 :param integrity_key:
3399 :param crypto_algorithm:
3401 :param protocol: AH(0) or ESP(1) protocol
3402 :param tunnel_src_address: tunnel mode outer src address
3403 :param tunnel_dst_address: tunnel mode outer dst address
3406 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3407 crypto and ipsec algorithms
3410 self.papi.ipsec_sad_add_del_entry,
3413 'tunnel_src_address': tunnel_src_address,
3414 'tunnel_dst_address': tunnel_dst_address,
3415 'protocol': protocol,
3416 'integrity_algorithm': integrity_algorithm,
3417 'integrity_key_length': len(integrity_key),
3418 'integrity_key': integrity_key,
3419 'crypto_algorithm': crypto_algorithm,
3420 'crypto_key_length': len(crypto_key) if crypto_key is not None
3422 'crypto_key': crypto_key,
3424 'is_tunnel': is_tunnel,
3425 'is_tunnel_ipv6': is_tunnel_ipv6,
3426 'udp_encap': udp_encap,
3427 'use_extended_sequence_number': use_extended_sequence_number,
3428 'use_anti_replay': use_anti_replay})
3430 def ipsec_spd_add_del_entry(self,
3433 local_address_start,
3435 remote_address_start,
3436 remote_address_stop,
3438 local_port_stop=65535,
3439 remote_port_start=0,
3440 remote_port_stop=65535,
3448 """ IPSEC policy SPD add/del -
3449 Wrapper to configure ipsec SPD policy entries in VPP
3450 :param spd_id: SPD ID for the policy
3451 :param local_address_start: local-ip-range start address
3452 :param local_address_stop : local-ip-range stop address
3453 :param remote_address_start: remote-ip-range start address
3454 :param remote_address_stop : remote-ip-range stop address
3455 :param local_port_start: (Default value = 0)
3456 :param local_port_stop: (Default value = 65535)
3457 :param remote_port_start: (Default value = 0)
3458 :param remote_port_stop: (Default value = 65535)
3459 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3460 :param sa_id: Security Association ID for mapping it to SPD
3461 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3463 :param priority: value for the spd action (Default value = 100)
3464 :param is_outbound: flag for inbound(0) or outbound(1)
3466 :param is_add: (Default value = 1)
3469 self.papi.ipsec_spd_add_del_entry,
3472 'local_address_start': local_address_start,
3473 'local_address_stop': local_address_stop,
3474 'remote_address_start': remote_address_start,
3475 'remote_address_stop': remote_address_stop,
3476 'local_port_start': local_port_start,
3477 'local_port_stop': local_port_stop,
3478 'remote_port_start': remote_port_start,
3479 'remote_port_stop': remote_port_stop,
3481 'protocol': protocol,
3483 'priority': priority,
3484 'is_outbound': is_outbound,
3486 'is_ip_any': is_ip_any})
3488 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3489 remote_spi, crypto_alg, local_crypto_key,
3490 remote_crypto_key, integ_alg, local_integ_key,
3491 remote_integ_key, is_add=1, esn=0,
3492 anti_replay=1, renumber=0, show_instance=0):
3494 self.papi.ipsec_tunnel_if_add_del,
3495 {'local_ip': local_ip, 'remote_ip': remote_ip,
3496 'local_spi': local_spi, 'remote_spi': remote_spi,
3497 'crypto_alg': crypto_alg,
3498 'local_crypto_key_len': len(local_crypto_key),
3499 'local_crypto_key': local_crypto_key,
3500 'remote_crypto_key_len': len(remote_crypto_key),
3501 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3502 'local_integ_key_len': len(local_integ_key),
3503 'local_integ_key': local_integ_key,
3504 'remote_integ_key_len': len(remote_integ_key),
3505 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3506 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3507 'show_instance': show_instance
3510 def ipsec_select_backend(self, protocol, index):
3511 return self.api(self.papi.ipsec_select_backend,
3512 {'protocol': protocol, 'index': index})
3514 def ipsec_backend_dump(self):
3515 return self.api(self.papi.ipsec_backend_dump, {})
3517 def app_namespace_add(self,
3521 sw_if_index=0xFFFFFFFF,
3524 self.papi.app_namespace_add_del,
3526 'sw_if_index': sw_if_index,
3527 'ip4_fib_id': ip4_fib_id,
3528 'ip6_fib_id': ip6_fib_id,
3529 'namespace_id': namespace_id,
3530 'namespace_id_len': len(namespace_id)})
3532 def punt_socket_register(self, port, pathname, protocol=0x11,
3533 header_version=1, is_ip4=1):
3534 """ Register punt socket """
3535 return self.api(self.papi.punt_socket_register,
3536 {'header_version': header_version,
3537 'punt': {'ipv': is_ip4,
3538 'l4_protocol': protocol,
3540 'pathname': pathname})
3542 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
3543 """ Unregister punt socket """
3544 return self.api(self.papi.punt_socket_deregister,
3545 {'punt': {'ipv': is_ip4,
3546 'l4_protocol': protocol,
3549 def punt_socket_dump(self, is_ip6=1):
3550 """ Dump punt socket"""
3551 return self.api(self.papi.punt_socket_dump,
3552 {'is_ipv6': is_ip6})
3554 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3555 expire_walk_interval_ms, is_ip6=0):
3556 """ Set IP reassembly parameters """
3557 return self.api(self.papi.ip_reassembly_set,
3559 'timeout_ms': timeout_ms,
3560 'expire_walk_interval_ms': expire_walk_interval_ms,
3561 'max_reassemblies': max_reassemblies})
3563 def ip_reassembly_get(self, is_ip6=0):
3564 """ Get IP reassembly parameters """
3565 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3567 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3569 """ Enable/disable IP reassembly """
3570 return self.api(self.papi.ip_reassembly_enable_disable,
3571 {'sw_if_index': sw_if_index,
3572 'enable_ip4': 1 if enable_ip4 else 0,
3573 'enable_ip6': 1 if enable_ip6 else 0,
3576 def gbp_endpoint_add(self, sw_if_index, ips, mac, epg, flags,
3578 """ GBP endpoint Add """
3579 return self.api(self.papi.gbp_endpoint_add,
3581 'sw_if_index': sw_if_index,
3593 def gbp_endpoint_del(self, handle):
3594 """ GBP endpoint Del """
3595 return self.api(self.papi.gbp_endpoint_del,
3598 def gbp_endpoint_dump(self):
3599 """ GBP endpoint Dump """
3600 return self.api(self.papi.gbp_endpoint_dump,
3601 {'_no_type_conversion': True})
3603 def gbp_endpoint_group_add(self, epg, bd,
3604 rd, uplink_sw_if_index):
3605 """ GBP endpoint group Add """
3606 return self.api(self.papi.gbp_endpoint_group_add,
3609 'uplink_sw_if_index': uplink_sw_if_index,
3615 def gbp_endpoint_group_del(self, epg):
3616 """ GBP endpoint group Del """
3617 return self.api(self.papi.gbp_endpoint_group_del,
3620 def gbp_endpoint_group_dump(self):
3621 """ GBP endpoint group Dump """
3622 return self.api(self.papi.gbp_endpoint_group_dump, {})
3624 def gbp_bridge_domain_add(self, bd_id, flags,
3626 uu_fwd_sw_if_index):
3627 """ GBP bridge-domain Add """
3628 return self.api(self.papi.gbp_bridge_domain_add,
3632 'bvi_sw_if_index': bvi_sw_if_index,
3633 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
3637 def gbp_bridge_domain_del(self, bd_id):
3638 """ GBP bridge-domain Del """
3639 return self.api(self.papi.gbp_bridge_domain_del,
3642 def gbp_bridge_domain_dump(self):
3643 """ GBP Bridge Domain Dump """
3644 return self.api(self.papi.gbp_bridge_domain_dump, {})
3646 def gbp_route_domain_add(self, rd_id,
3650 ip6_uu_sw_if_index):
3651 """ GBP route-domain Add """
3652 return self.api(self.papi.gbp_route_domain_add,
3655 'ip4_table_id': ip4_table_id,
3656 'ip6_table_id': ip6_table_id,
3657 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
3658 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
3662 def gbp_route_domain_del(self, rd_id):
3663 """ GBP route-domain Del """
3664 return self.api(self.papi.gbp_route_domain_del,
3667 def gbp_route_domain_dump(self):
3668 """ GBP Route Domain Dump """
3669 return self.api(self.papi.gbp_route_domain_dump, {})
3671 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3672 """ GBP recirc Add/Del """
3673 return self.api(self.papi.gbp_recirc_add_del,
3677 'sw_if_index': sw_if_index,
3680 def gbp_recirc_dump(self):
3681 """ GBP recirc Dump """
3682 return self.api(self.papi.gbp_recirc_dump, {})
3684 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
3685 """ GBP recirc Add/Del """
3686 return self.api(self.papi.gbp_ext_itf_add_del,
3689 'sw_if_index': sw_if_index,
3693 def gbp_ext_itf_dump(self):
3694 """ GBP recirc Dump """
3695 return self.api(self.papi.gbp_ext_itf_dump, {})
3697 def gbp_subnet_add_del(self, is_add, rd_id,
3699 sw_if_index=0xffffffff,
3701 """ GBP Subnet Add/Del """
3702 return self.api(self.papi.gbp_subnet_add_del,
3706 'sw_if_index': sw_if_index,
3711 def gbp_subnet_dump(self):
3712 """ GBP Subnet Dump """
3713 return self.api(self.papi.gbp_subnet_dump,
3714 {'_no_type_conversion': True})
3716 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index,
3717 rules, allowed_ethertypes):
3718 """ GBP contract Add/Del """
3719 return self.api(self.papi.gbp_contract_add_del,
3722 'acl_index': acl_index,
3725 'n_rules': len(rules),
3727 'n_ether_types': len(allowed_ethertypes),
3728 'allowed_ethertypes': allowed_ethertypes}})
3730 def gbp_contract_dump(self):
3731 """ GBP contract Dump """
3732 return self.api(self.papi.gbp_contract_dump, {})
3734 def gbp_endpoint_learn_set_inactive_threshold(self, threshold):
3735 """ GBP set inactive threshold """
3736 return self.api(self.papi.gbp_endpoint_learn_set_inactive_threshold,
3737 {'threshold': threshold})
3739 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode):
3740 """ GBP VXLAN tunnel add """
3741 return self.api(self.papi.gbp_vxlan_tunnel_add,
3746 'bd_rd_id': bd_rd_id
3750 def gbp_vxlan_tunnel_del(self, vni):
3751 """ GBP VXLAN tunnel del """
3752 return self.api(self.papi.gbp_vxlan_tunnel_del,
3757 def gbp_vxlan_tunnel_dump(self):
3758 """ GBP VXLAN tunnel add/del """
3759 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
3761 def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3762 ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3764 """ 6RD tunnel Add """
3765 return self.api(self.papi.ipip_6rd_add_tunnel,
3766 {'ip4_table_id': ip4_table_id,
3767 'ip6_table_id': ip6_table_id,
3768 'ip6_prefix': ip6_prefix,
3769 'ip6_prefix_len': ip6_prefix_len,
3770 'ip4_prefix': ip4_prefix,
3771 'ip4_prefix_len': ip4_prefix_len,
3773 'security_check': security_check})
3775 def ipip_6rd_del_tunnel(self, sw_if_index):
3776 """ 6RD tunnel Delete """
3777 return self.api(self.papi.ipip_6rd_del_tunnel,
3778 {'sw_if_index': sw_if_index})
3780 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3781 instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3782 """ IPIP tunnel Add/Del """
3783 return self.api(self.papi.ipip_add_tunnel,
3784 {'is_ipv6': is_ipv6,
3785 'instance': instance,
3786 'src_address': src_address,
3787 'dst_address': dst_address,
3788 'table_id': table_id,
3791 def ipip_del_tunnel(self, sw_if_index):
3792 """ IPIP tunnel Delete """
3793 return self.api(self.papi.ipip_del_tunnel,
3794 {'sw_if_index': sw_if_index})
3796 def qos_egress_map_update(self, id, outputs):
3797 """ QOS egress map update """
3798 return self.api(self.papi.qos_egress_map_update,
3802 def qos_egress_map_delete(self, id):
3803 """ QOS egress map delete """
3804 return self.api(self.papi.qos_egress_map_delete,
3807 def qos_mark_enable_disable(self, sw_if_index,
3811 """ QOS Mark Enable/Disable """
3812 return self.api(self.papi.qos_mark_enable_disable,
3814 'sw_if_index': sw_if_index,
3815 'output_source': output_source,
3818 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3819 """ IP QoS recording Enble/Disable """
3820 return self.api(self.papi.qos_record_enable_disable,
3821 {'sw_if_index': sw_if_index,
3822 'input_source': input_source,
3825 def igmp_enable_disable(self, sw_if_index, enable, host):
3826 """ Enable/disable IGMP on a given interface """
3827 return self.api(self.papi.igmp_enable_disable,
3830 'sw_if_index': sw_if_index})
3832 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
3833 """ Add/del IGMP proxy device """
3834 return self.api(self.papi.igmp_proxy_device_add_del,
3835 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3838 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
3839 """ Add/del interface to/from IGMP proxy device """
3840 return self.api(self.papi.igmp_proxy_device_add_del_interface,
3841 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3844 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3845 """ Listen for new (S,G) on specified interface
3847 :param enable: add/del
3848 :param sw_if_index: interface sw index
3849 :param saddr: source ip4 addr
3850 :param gaddr: group ip4 addr
3852 return self.api(self.papi.igmp_listen,
3857 'sw_if_index': sw_if_index,
3858 'n_srcs': len(saddrs),
3864 def igmp_dump(self, sw_if_index=None):
3865 """ Dump all (S,G) interface configurations """
3866 if sw_if_index is None:
3867 sw_if_index = 0xffffffff
3868 return self.api(self.papi.igmp_dump,
3869 {'sw_if_index': sw_if_index})
3871 def igmp_clear_interface(self, sw_if_index):
3872 """ Remove all (S,G)s from specified interface
3873 doesn't send IGMP report!
3876 self.papi.igmp_clear_interface, {
3877 'sw_if_index': sw_if_index})
3879 def want_igmp_events(self, enable=1):
3880 return self.api(self.papi.want_igmp_events, {'enable': enable,
3881 'pid': os.getpid()})
3891 :param lb: load balance
3892 :param use_custom_mac: use custom mac
3893 :param mac_address: mac address
3896 self.papi.bond_create,
3899 'use_custom_mac': use_custom_mac,
3900 'mac_address': mac_address
3907 :param sw_if_index: interface the operation is applied to
3909 return self.api(self.papi.bond_delete,
3910 {'sw_if_index': sw_if_index})
3919 :param sw_if_index: slave sw_if_index
3920 :param bond_sw_if_index: bond sw_if_index
3921 :param is_passive: is passive lacp speaker
3922 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3925 self.papi.bond_enslave,
3926 {'sw_if_index': sw_if_index,
3927 'bond_sw_if_index': bond_sw_if_index,
3928 'is_passive': is_passive,
3929 'is_long_timeout': is_long_timeout
3932 def bond_detach_slave(
3936 :param sw_if_index: slave interface the operation is applied to
3938 return self.api(self.papi.bond_detach_slave,
3939 {'sw_if_index': sw_if_index})
3941 def sw_interface_slave_dump(
3945 :param sw_if_index: bond sw_if_index
3947 return self.api(self.papi.sw_interface_slave_dump,
3948 {'sw_if_index': sw_if_index})
3950 def sw_interface_bond_dump(
3955 return self.api(self.papi.sw_interface_bond_dump,
3958 def create_vhost_user_if(
3964 disable_indirect_desc,
3965 custom_dev_instance,
3970 :param is_server: is server
3971 :param sock_filename: socket name
3972 :param renumber: renumber
3973 :param disable_mrg_rxbuf: disable mergable rx buffers
3974 :param disable_indirect_desc: disable indirect descriptors
3975 :param custom_dev_instance: custom dev instance
3976 :param use_custom_mac: use custom mac
3977 :param mac_address: mac address
3978 :param tag: tag (default '')
3981 self.papi.create_vhost_user_if,
3982 {'is_server': is_server,
3983 'sock_filename': sock_filename,
3984 'renumber': renumber,
3985 'disable_mrg_rxbuf': disable_mrg_rxbuf,
3986 'disable_indirect_desc': disable_indirect_desc,
3987 'custom_dev_instance': custom_dev_instance,
3988 'use_custom_mac': use_custom_mac,
3989 'mac_address': mac_address,
3993 def delete_vhost_user_if(
3997 :param sw_if_index: interface the operation is applied to
3999 return self.api(self.papi.delete_vhost_user_if,
4000 {'sw_if_index': sw_if_index, })
4002 def sw_interface_vhost_user_dump(
4007 return self.api(self.papi.sw_interface_vhost_user_dump,
4010 def abf_policy_add_del(self, is_add, policy):
4012 self.papi.abf_policy_add_del,
4016 def abf_itf_attach_add_del(self, is_add, attach):
4018 self.papi.abf_itf_attach_add_del,
4022 def abf_policy_dump(self):
4024 self.papi.abf_policy_dump, {})
4026 def abf_itf_attach_dump(self):
4028 self.papi.abf_itf_attach_dump, {})
4030 def pipe_create(self, is_specified, user_instance):
4031 return self.api(self.papi.pipe_create,
4032 {'is_specified': is_specified,
4033 'user_instance': user_instance})
4035 def pipe_delete(self, parent_sw_if_index):
4036 return self.api(self.papi.pipe_delete,
4037 {'parent_sw_if_index': parent_sw_if_index})
4039 def pipe_dump(self):
4040 return self.api(self.papi.pipe_dump, {})
4054 return self.api(self.papi.memif_create,
4057 'rx_queues': rx_queues,
4058 'tx_queues': tx_queues,
4060 'socket_id': socket_id,
4062 'ring_size': ring_size,
4063 'buffer_size': buffer_size,
4064 'hw_addr': hw_addr})
4066 def memif_delete(self, sw_if_index):
4067 return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index})
4069 def memif_dump(self):
4070 return self.api(self.papi.memif_dump, {})
4072 def memif_socket_filename_add_del(
4073 self, is_add, socket_id, socket_filename):
4075 self.papi.memif_socket_filename_add_del,
4077 'socket_id': socket_id,
4078 'socket_filename': socket_filename})
4080 def memif_socket_filename_dump(self):
4081 return self.api(self.papi.memif_socket_filename_dump, {})
4083 def svs_table_add_del(self, af, table_id, is_add=1):
4084 return self.api(self.papi.svs_table_add_del,
4086 'table_id': table_id,
4091 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
4092 return self.api(self.papi.svs_route_add_del,
4094 'table_id': table_id,
4095 'source_table_id': src_table_id,
4100 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
4101 return self.api(self.papi.svs_enable_disable,
4104 'table_id': table_id,
4105 'sw_if_index': sw_if_index,
4106 'is_enable': is_enable,
4110 return self.api(self.papi.svs_dump, {})
4112 def syslog_set_sender(
4119 """Set syslog sender configuration
4121 :param collector: colector IP address
4122 :param src: source IP address
4123 :param collector_port: collector UDP port (Default value = 514)
4124 :param vrf_id: VRF id (Default value = 0)
4125 :param max_msg_size: maximum message length (Default value = 480)
4127 return self.api(self.papi.syslog_set_sender,
4128 {'collector_address': collector,
4130 'collector_port': collector_port,
4132 'max_msg_size': max_msg_size})
4134 def syslog_get_sender(self):
4135 """Return syslog sender configuration"""
4136 return self.api(self.papi.syslog_get_sender, {})
4138 def syslog_set_filter(self, severity):
4139 """Set syslog filter parameters
4141 :param severity: severity filter (specified severity and greater match)
4143 return self.api(self.papi.syslog_set_filter, {'severity': severity})
4145 def syslog_get_filter(self):
4146 """Return syslog filter parameters"""
4147 return self.api(self.papi.syslog_get_filter, {})