4 from collections import deque
7 from vpp_mac import mactobinary
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(length=len(cli), cmd=str(cli).encode('utf8'))
214 self.hook.after_cli(cli)
215 if hasattr(r, 'reply'):
216 return r.reply.decode().rstrip('\x00')
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 _convert_mac(self, mac):
227 return mactobinary(mac)
229 def show_version(self):
231 return self.api(self.papi.show_version, {})
233 def pg_create_interface(self, pg_index):
239 return self.api(self.papi.pg_create_interface,
240 {"interface_id": pg_index})
242 def sw_interface_dump(self, filter=None):
245 :param filter: (Default value = None)
248 if filter is not None:
249 args = {"name_filter_valid": 1, "name_filter": filter}
252 return self.api(self.papi.sw_interface_dump, args)
254 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
255 """ Set the IPvX Table-id for the Interface
262 return self.api(self.papi.sw_interface_set_table,
263 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
266 def sw_interface_get_table(self, sw_if_index, is_ipv6):
267 """ Get the IPvX Table-id for the Interface
274 return self.api(self.papi.sw_interface_get_table,
275 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6})
277 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
278 is_ipv6=0, is_add=1, del_all=0):
281 :param addr: param is_ipv6: (Default value = 0)
284 :param is_ipv6: (Default value = 0)
285 :param is_add: (Default value = 1)
286 :param del_all: (Default value = 0)
289 return self.api(self.papi.sw_interface_add_del_address,
290 {'sw_if_index': sw_if_index,
294 'address_length': addr_len,
297 def ip_address_dump(self, sw_if_index, is_ipv6=0):
298 return self.api(self.papi.ip_address_dump,
299 {'sw_if_index': sw_if_index,
302 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
304 """ Set the Interface to be unnumbered
306 :param is_add: (Default value = 1)
307 :param sw_if_index - interface That will be unnumbered
308 :param ip_sw_if_index - interface with an IP addres
311 return self.api(self.papi.sw_interface_set_unnumbered,
312 {'sw_if_index': ip_sw_if_index,
313 'unnumbered_sw_if_index': sw_if_index,
316 def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
317 return self.api(self.papi.ip_unnumbered_dump,
318 {'sw_if_index': sw_if_index})
320 def sw_interface_enable_disable_mpls(self, sw_if_index,
323 Enable/Disable MPLS on the interface
325 :param is_enable: (Default value = 1)
328 return self.api(self.papi.sw_interface_set_mpls_enable,
329 {'sw_if_index': sw_if_index,
330 'enable': is_enable})
332 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
333 return self.api(self.papi.sw_interface_ip6nd_ra_config,
334 {'sw_if_index': sw_if_index,
335 'suppress': suppress})
337 def set_ip_flow_hash(self,
346 return self.api(self.papi.set_ip_flow_hash,
356 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
357 return self.api(self.papi.ip6nd_proxy_add_del,
359 'sw_if_index': sw_if_index,
362 def ip6_sw_interface_ra_config(self, sw_if_index,
366 return self.api(self.papi.sw_interface_ip6nd_ra_config,
367 {'sw_if_index': sw_if_index,
369 'suppress': suppress,
370 'send_unicast': send_unicast})
372 def ip6_sw_interface_ra_prefix(self,
382 val_lifetime=0xffffffff,
383 pref_lifetime=0xffffffff):
384 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
385 {'sw_if_index': sw_if_index,
387 'address_length': address_length,
388 'use_default': use_default,
389 'no_advertise': no_advertise,
390 'off_link': off_link,
391 'no_autoconfig': no_autoconfig,
392 'no_onlink': no_onlink,
394 'val_lifetime': val_lifetime,
395 'pref_lifetime': pref_lifetime})
397 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
399 Enable/Disable An interface for IPv6
401 return self.api(self.papi.sw_interface_ip6_enable_disable,
402 {'sw_if_index': sw_if_index,
405 def vxlan_add_del_tunnel(
409 mcast_sw_if_index=0xFFFFFFFF,
413 decap_next_index=0xFFFFFFFF,
415 instance=0xFFFFFFFF):
420 :param is_add: (Default value = 1)
421 :param is_ipv6: (Default value = 0)
422 :param encap_vrf_id: (Default value = 0)
423 :param decap_next_index: (Default value = 0xFFFFFFFF)
424 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
425 :param vni: (Default value = 0)
426 :param instance: (Default value = 0xFFFFFFFF)
429 return self.api(self.papi.vxlan_add_del_tunnel,
432 'src_address': src_addr,
433 'dst_address': dst_addr,
434 'mcast_sw_if_index': mcast_sw_if_index,
435 'encap_vrf_id': encap_vrf_id,
436 'decap_next_index': decap_next_index,
438 'instance': instance})
440 def geneve_add_del_tunnel(
444 mcast_sw_if_index=0xFFFFFFFF,
448 decap_next_index=0xFFFFFFFF,
454 :param is_add: (Default value = 1)
455 :param is_ipv6: (Default value = 0)
456 :param encap_vrf_id: (Default value = 0)
457 :param decap_next_index: (Default value = 0xFFFFFFFF)
458 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
459 :param vni: (Default value = 0)
462 return self.api(self.papi.geneve_add_del_tunnel,
465 'local_address': local_addr,
466 'remote_address': remote_addr,
467 'mcast_sw_if_index': mcast_sw_if_index,
468 'encap_vrf_id': encap_vrf_id,
469 'decap_next_index': decap_next_index,
472 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
473 learn=1, arp_term=0, is_add=1):
474 """Create/delete bridge domain.
476 :param int bd_id: Bridge domain index.
477 :param int flood: Enable/disable bcast/mcast flooding in the BD.
479 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
481 :param int forward: Enable/disable forwarding on all interfaces in
482 the BD. (Default value = 1)
483 :param int learn: Enable/disable learning on all interfaces in the BD.
485 :param int arp_term: Enable/disable arp termination in the BD.
487 :param int is_add: Add or delete flag. (Default value = 1)
489 return self.api(self.papi.bridge_domain_add_del,
492 'uu_flood': uu_flood,
495 'arp_term': arp_term,
498 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
499 return self.api(self.papi.bd_ip_mac_add_del,
505 def bd_ip_mac_dump(self, bd_id):
506 return self.api(self.papi.bd_ip_mac_dump,
509 def want_ip4_arp_events(self, enable_disable=1, address=0):
510 return self.api(self.papi.want_ip4_arp_events,
511 {'enable_disable': enable_disable,
513 'pid': os.getpid(), })
515 def want_ip6_nd_events(self, enable_disable=1, address=0):
516 return self.api(self.papi.want_ip6_nd_events,
517 {'enable_disable': enable_disable,
519 'pid': os.getpid(), })
521 def want_ip6_ra_events(self, enable_disable=1):
522 return self.api(self.papi.want_ip6_ra_events,
523 {'enable_disable': enable_disable,
524 'pid': os.getpid(), })
526 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
528 return self.api(self.papi.ip6nd_send_router_solicitation,
533 'sw_if_index': sw_if_index})
535 def ip6_nd_address_autoconfig(self, sw_if_index, enable,
536 install_default_routes):
537 return self.api(self.papi.ip6_nd_address_autoconfig,
538 {'sw_if_index': sw_if_index,
540 'install_default_routes': install_default_routes})
542 def want_interface_events(self, enable_disable=1):
543 return self.api(self.papi.want_interface_events,
544 {'enable_disable': enable_disable,
545 'pid': os.getpid(), })
547 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
548 max_macs_in_event=0, learn_limit=0):
549 return self.api(self.papi.want_l2_macs_events,
550 {'enable_disable': enable_disable,
551 'scan_delay': scan_delay,
552 'max_macs_in_event': max_macs_in_event,
553 'learn_limit': learn_limit,
554 'pid': os.getpid(), })
556 def want_dhcp6_reply_events(self, enable_disable=1):
557 return self.api(self.papi.want_dhcp6_reply_events,
558 {'enable_disable': enable_disable,
561 def want_dhcp6_pd_reply_events(self, enable_disable=1):
562 return self.api(self.papi.want_dhcp6_pd_reply_events,
563 {'enable_disable': enable_disable,
566 def dhcp6_clients_enable_disable(self, enable=1):
567 return self.api(self.papi.dhcp6_clients_enable_disable,
570 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
571 addresses, server_index=0xFFFFFFFF,
572 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
574 return self.api(self.papi.dhcp6_send_client_message,
575 {'sw_if_index': sw_if_index,
576 'server_index': server_index,
582 'msg_type': msg_type,
585 'n_addresses': len(addresses),
586 'addresses': addresses})
588 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
589 prefixes, server_index=0xFFFFFFFF,
590 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
592 return self.api(self.papi.dhcp6_pd_send_client_message,
593 {'sw_if_index': sw_if_index,
594 'server_index': server_index,
600 'msg_type': msg_type,
603 'n_prefixes': len(prefixes),
604 'prefixes': prefixes})
606 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
608 return self.api(self.papi.dhcp6_client_enable_disable,
609 {'sw_if_index': sw_if_index,
612 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
614 return self.api(self.papi.dhcp6_pd_client_enable_disable,
615 {'sw_if_index': sw_if_index,
616 'prefix_group': prefix_group,
619 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
620 prefix_length, prefix_group,
622 return self.api(self.papi.ip6_add_del_address_using_prefix,
623 {'sw_if_index': sw_if_index,
624 'prefix_group': prefix_group,
626 'prefix_length': prefix_length,
629 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
630 filter_mac=0, bvi_mac=0):
631 """Create/delete L2 FIB entry.
633 :param str mac: MAC address to create FIB entry for.
634 :param int bd_id: Bridge domain index.
635 :param int sw_if_index: Software interface index of the interface.
636 :param int is_add: Add or delete flag. (Default value = 1)
637 :param int static_mac: Set to 1 to create static MAC entry.
639 :param int filter_mac: Set to 1 to drop packet that's source or
640 destination MAC address contains defined MAC address.
642 :param int bvi_mac: Set to 1 to create entry that points to BVI
643 interface. (Default value = 0)
645 return self.api(self.papi.l2fib_add_del,
646 {'mac': self._convert_mac(mac),
648 'sw_if_index': sw_if_index,
650 'static_mac': static_mac,
651 'filter_mac': filter_mac,
654 def l2fib_flush_int(self, sw_if_index):
655 """Flush L2 FIB entries for sw_if_index.
657 :param int sw_if_index: Software interface index of the interface.
659 return self.api(self.papi.l2fib_flush_int,
660 {'sw_if_index': sw_if_index})
662 def l2fib_flush_bd(self, bd_id):
663 """Flush L2 FIB entries for bd_id.
665 :param int sw_if_index: Bridge Domain id.
667 return self.api(self.papi.l2fib_flush_bd,
670 def l2fib_flush_all(self):
673 return self.api(self.papi.l2fib_flush_all, {})
675 def l2_fib_table_dump(self, bd_id):
676 """ Dump the L2 FIB """
677 return self.api(self.papi.l2_fib_table_dump,
680 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
681 shg=0, port_type=L2_PORT_TYPE.NORMAL,
683 """Add/remove interface to/from bridge domain.
685 :param int sw_if_index: Software interface index of the interface.
686 :param int bd_id: Bridge domain index.
687 :param int shg: Split-horizon group index. (Default value = 0)
688 :param int bvi: Set interface as a bridge group virtual interface.
690 :param int enable: Add or remove interface. (Default value = 1)
692 return self.api(self.papi.sw_interface_set_l2_bridge,
693 {'rx_sw_if_index': sw_if_index,
696 'port_type': port_type,
699 def bridge_flags(self, bd_id, is_set, feature_bitmap):
700 """Enable/disable required feature of the bridge domain with defined
703 :param int bd_id: Bridge domain ID.
704 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
705 :param int flags: Bitmap value of the feature to be set:
709 - uu-flood (1 << 3) or
712 return self.api(self.papi.bridge_flags,
715 'flags': feature_bitmap})
717 def bridge_domain_dump(self, bd_id=0):
720 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
721 existing bridge domains returned)
722 :return: Dictionary of bridge domain(s) data.
724 return self.api(self.papi.bridge_domain_dump,
727 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
729 """Create or delete unidirectional cross-connect from Tx interface to
732 :param int rx_sw_if_index: Software interface index of Rx interface.
733 :param int tx_sw_if_index: Software interface index of Tx interface.
734 :param int enable: Create cross-connect if equal to 1, delete
735 cross-connect if equal to 0.
738 return self.api(self.papi.sw_interface_set_l2_xconnect,
739 {'rx_sw_if_index': rx_sw_if_index,
740 'tx_sw_if_index': tx_sw_if_index,
743 def sw_interface_set_l2_tag_rewrite(
750 """L2 interface vlan tag rewrite configure request
751 :param client_index - opaque cookie to identify the sender
752 :param context - sender context, to match reply w/ request
753 :param sw_if_index - interface the operation is applied to
754 :param vtr_op - Choose from l2_vtr_op_t enum values
755 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
756 :param tag1 - Needed for any push or translate vtr op
757 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
760 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
761 {'sw_if_index': sw_if_index,
767 def sw_interface_set_l2_emulation(
772 :param sw_if_index - interface the operation is applied to
775 return self.api(self.papi.l2_emulation,
776 {'sw_if_index': sw_if_index,
779 def sw_interface_set_ip_directed_broadcast(
783 """IP Directed broadcast
784 :param sw_if_index - interface the operation is applied to
787 return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
788 {'sw_if_index': sw_if_index,
791 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
794 :param admin_up_down:
798 return self.api(self.papi.sw_interface_set_flags,
799 {'sw_if_index': sw_if_index,
800 'admin_up_down': admin_up_down})
802 def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
808 return self.api(self.papi.sw_interface_set_mtu,
809 {'sw_if_index': sw_if_index,
812 def sw_interface_set_promiscuous(self, sw_if_index, enable):
818 return self.api(self.papi.sw_interface_set_promiscuous,
819 {'sw_if_index': sw_if_index,
822 def sw_interface_set_mac_address(self, sw_if_index, mac):
823 return self.api(self.papi.sw_interface_set_mac_address,
824 {'sw_if_index': sw_if_index,
827 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
828 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
829 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
830 """Create subinterface
831 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
833 :param sub_id: param inner_vlan:
837 :param no_tags: (Default value = 0)
838 :param one_tag: (Default value = 0)
839 :param two_tags: (Default value = 0)
840 :param dot1ad: (Default value = 0)
841 :param exact_match: (Default value = 0)
842 :param default_sub: (Default value = 0)
843 :param outer_vlan_id_any: (Default value = 0)
844 :param inner_vlan_id_any: (Default value = 0)
848 self.papi.create_subif,
849 {'sw_if_index': sw_if_index,
853 'two_tags': two_tags,
855 'exact_match': exact_match,
856 'default_sub': default_sub,
857 'outer_vlan_id_any': outer_vlan_id_any,
858 'inner_vlan_id_any': inner_vlan_id_any,
859 'outer_vlan_id': outer_vlan,
860 'inner_vlan_id': inner_vlan})
862 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
863 """Create p2p ethernet subinterface
865 :param sw_if_index: main (parent) interface
866 :param remote_mac: client (remote) mac address
870 self.papi.p2p_ethernet_add,
871 {'parent_if_index': sw_if_index,
872 'remote_mac': remote_mac,
873 'subif_id': subif_id})
875 def delete_subif(self, sw_if_index):
876 """Delete subinterface
880 return self.api(self.papi.delete_subif,
881 {'sw_if_index': sw_if_index})
883 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
884 """Delete p2p ethernet subinterface
886 :param sw_if_index: main (parent) interface
887 :param remote_mac: client (remote) mac address
891 self.papi.p2p_ethernet_del,
892 {'parent_if_index': sw_if_index,
893 'remote_mac': remote_mac})
895 def create_vlan_subif(self, sw_if_index, vlan):
902 return self.api(self.papi.create_vlan_subif,
903 {'sw_if_index': sw_if_index,
906 def create_loopback(self, mac=''):
909 :param mac: (Optional)
911 return self.api(self.papi.create_loopback,
912 {'mac_address': mac})
914 def delete_loopback(self, sw_if_index):
915 return self.api(self.papi.delete_loopback,
916 {'sw_if_index': sw_if_index, })
918 def ip_table_add_del(self,
925 :param is_add: (Default value = 1)
926 :param is_ipv6: (Default value = 0)
931 self.papi.ip_table_add_del,
932 {'table_id': table_id,
936 def ip_add_del_route(
941 next_hop_sw_if_index=0xFFFFFFFF,
945 next_hop_n_out_labels=0,
946 next_hop_out_label_stack=[],
947 next_hop_via_label=MPLS_LABEL_INVALID,
948 next_hop_id=0xFFFFFFFF,
950 is_resolve_attached=0,
951 classify_table_index=0xFFFFFFFF,
965 :param dst_address_length:
966 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
968 :param next_hop_address:
969 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
970 :param vrf_id: (Default value = 0)
971 :param lookup_in_vrf: (Default value = 0)
972 :param classify_table_index: (Default value = 0xFFFFFFFF)
973 :param is_add: (Default value = 1)
974 :param is_drop: (Default value = 0)
975 :param is_ipv6: (Default value = 0)
976 :param is_local: (Default value = 0)
977 :param is_classify: (Default value = 0)
978 :param is_multipath: (Default value = 0)
979 :param is_resolve_host: (Default value = 0)
980 :param is_resolve_attached: (Default value = 0)
981 :param is_dvr: (Default value = 0)
982 :param is_source_lookup: (Default value = 0)
983 :param next_hop_weight: (Default value = 1)
988 self.papi.ip_add_del_route,
989 {'next_hop_sw_if_index': next_hop_sw_if_index,
990 'table_id': table_id,
991 'classify_table_index': classify_table_index,
992 'next_hop_table_id': next_hop_table_id,
995 'is_unreach': is_unreach,
996 'is_prohibit': is_prohibit,
998 'is_local': is_local,
999 'is_classify': is_classify,
1000 'is_multipath': is_multipath,
1001 'is_resolve_host': is_resolve_host,
1002 'is_resolve_attached': is_resolve_attached,
1004 'is_source_lookup': is_source_lookup,
1005 'is_udp_encap': is_udp_encap,
1006 'next_hop_weight': next_hop_weight,
1007 'dst_address_length': dst_address_length,
1008 'dst_address': dst_address,
1009 'next_hop_id': next_hop_id,
1010 'next_hop_address': next_hop_address,
1011 'next_hop_n_out_labels': next_hop_n_out_labels,
1012 'next_hop_via_label': next_hop_via_label,
1013 'next_hop_out_label_stack': next_hop_out_label_stack})
1015 def ip_fib_dump(self):
1016 return self.api(self.papi.ip_fib_dump, {})
1018 def ip6_fib_dump(self):
1019 return self.api(self.papi.ip6_fib_dump, {})
1021 def ip_neighbor_add_del(self,
1030 """ Add neighbor MAC to IPv4 or IPv6 address.
1035 :param is_add: (Default value = 1)
1036 :param is_ipv6: (Default value = 0)
1037 :param is_static: (Default value = 0)
1038 :param is_no_adj_fib: (Default value = 0)
1041 self.papi.ip_neighbor_add_del,
1042 {'sw_if_index': sw_if_index,
1045 'is_static': is_static,
1046 'is_no_adj_fib': is_no_adj_fib,
1047 'mac_address': mac_address,
1048 'dst_address': dst_address
1052 def ip_neighbor_dump(self,
1055 """ Return IP neighbor dump.
1058 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1062 self.papi.ip_neighbor_dump,
1063 {'is_ipv6': is_ipv6,
1064 'sw_if_index': sw_if_index
1068 def proxy_arp_add_del(self,
1073 """ Config Proxy Arp Range.
1075 :param low_address: Start address in the rnage to Proxy for
1076 :param hi_address: End address in the rnage to Proxy for
1077 :param vrf_id: The VRF/table in which to proxy
1081 self.papi.proxy_arp_add_del,
1085 'low_address': low_address,
1086 'hi_address': hi_address,
1090 def proxy_arp_intfc_enable_disable(self,
1093 """ Enable/Disable an interface for proxy ARP requests
1095 :param sw_if_index: Interface
1096 :param enable_disable: Enable/Disable
1100 self.papi.proxy_arp_intfc_enable_disable,
1101 {'sw_if_index': sw_if_index,
1102 'enable_disable': is_enable
1110 """ Reset VRF (remove all routes etc.) request.
1112 :param int vrf_id: ID of the FIB table / VRF to reset.
1113 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1117 self.papi.reset_vrf,
1127 """ Reset VRF (remove all routes etc.) request.
1129 :param int vrf_id: ID of the FIB table / VRF to reset.
1130 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1134 self.papi.reset_fib,
1145 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1150 {'is_ipv6': is_ipv6,
1154 def sw_interface_span_enable_disable(
1155 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1158 :param sw_if_index_from:
1159 :param sw_if_index_to:
1163 return self.api(self.papi.sw_interface_span_enable_disable,
1164 {'sw_if_index_from': sw_if_index_from,
1165 'sw_if_index_to': sw_if_index_to,
1170 def gre_tunnel_add_del(self,
1175 instance=0xFFFFFFFF,
1179 """ Add a GRE tunnel
1183 :param outer_fib_id: (Default value = 0)
1184 :param tunnel_type: (Default value = 0)
1185 :param instance: (Default value = 0xFFFFFFFF)
1186 :param session_id: (Defalt value = 0)
1187 :param is_add: (Default value = 1)
1188 :param is_ipv6: (Default value = 0)
1192 self.papi.gre_add_del_tunnel,
1195 'tunnel_type': tunnel_type,
1196 'instance': instance,
1197 'src_address': src_address,
1198 'dst_address': dst_address,
1199 'outer_fib_id': outer_fib_id,
1200 'session_id': session_id}
1203 def udp_encap_add(self,
1209 """ Add a GRE tunnel
1214 :param outer_fib_id: (Default value = 0)
1218 self.papi.udp_encap_add,
1223 'src_port': src_port,
1224 'dst_port': dst_port,
1225 'table_id': table_id
1229 def udp_encap_del(self, id):
1230 return self.api(self.papi.udp_encap_del, {'id': id})
1232 def udp_encap_dump(self):
1233 return self.api(self.papi.udp_encap_dump, {})
1235 def want_udp_encap_stats(self, enable=1):
1236 return self.api(self.papi.want_udp_encap_stats,
1238 'pid': os.getpid()})
1240 def mpls_fib_dump(self):
1241 return self.api(self.papi.mpls_fib_dump, {})
1243 def mpls_table_add_del(
1250 :param is_add: (Default value = 1)
1255 self.papi.mpls_table_add_del,
1256 {'mt_table_id': table_id,
1257 'mt_is_add': is_add})
1259 def mpls_route_add_del(
1265 next_hop_sw_if_index=0xFFFFFFFF,
1267 next_hop_table_id=0,
1269 next_hop_n_out_labels=0,
1270 next_hop_out_label_stack=[],
1271 next_hop_via_label=MPLS_LABEL_INVALID,
1273 is_resolve_attached=0,
1280 classify_table_index=0xFFFFFFFF,
1284 :param dst_address_length:
1285 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1287 :param next_hop_address:
1288 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1289 :param vrf_id: (Default value = 0)
1290 :param lookup_in_vrf: (Default value = 0)
1291 :param classify_table_index: (Default value = 0xFFFFFFFF)
1292 :param is_add: (Default value = 1)
1293 :param is_drop: (Default value = 0)
1294 :param is_ipv6: (Default value = 0)
1295 :param is_local: (Default value = 0)
1296 :param is_classify: (Default value = 0)
1297 :param is_multipath: (Default value = 0)
1298 :param is_multicast: (Default value = 0)
1299 :param is_resolve_host: (Default value = 0)
1300 :param is_resolve_attached: (Default value = 0)
1301 :param next_hop_weight: (Default value = 1)
1305 self.papi.mpls_route_add_del,
1308 'mr_table_id': table_id,
1309 'mr_classify_table_index': classify_table_index,
1310 'mr_is_add': is_add,
1311 'mr_is_classify': is_classify,
1312 'mr_is_multipath': is_multipath,
1313 'mr_is_multicast': is_multicast,
1314 'mr_is_resolve_host': is_resolve_host,
1315 'mr_is_resolve_attached': is_resolve_attached,
1316 'mr_is_interface_rx': is_interface_rx,
1317 'mr_is_rpf_id': is_rpf_id,
1318 'mr_next_hop_proto': next_hop_proto,
1319 'mr_next_hop_weight': next_hop_weight,
1320 'mr_next_hop': next_hop_address,
1321 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1322 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1323 'mr_next_hop_table_id': next_hop_table_id,
1324 'mr_next_hop_via_label': next_hop_via_label,
1325 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1327 def mpls_ip_bind_unbind(
1339 self.papi.mpls_ip_bind_unbind,
1340 {'mb_mpls_table_id': table_id,
1342 'mb_ip_table_id': ip_table_id,
1343 'mb_is_bind': is_bind,
1344 'mb_is_ip4': is_ip4,
1345 'mb_address_length': dst_address_length,
1346 'mb_address': dst_address})
1348 def mpls_tunnel_add_del(
1351 next_hop_proto_is_ip4,
1353 next_hop_sw_if_index=0xFFFFFFFF,
1354 next_hop_table_id=0,
1356 next_hop_n_out_labels=0,
1357 next_hop_out_label_stack=[],
1358 next_hop_via_label=MPLS_LABEL_INVALID,
1364 :param dst_address_length:
1365 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1367 :param next_hop_address:
1368 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1369 :param vrf_id: (Default value = 0)
1370 :param lookup_in_vrf: (Default value = 0)
1371 :param classify_table_index: (Default value = 0xFFFFFFFF)
1372 :param is_add: (Default value = 1)
1373 :param is_drop: (Default value = 0)
1374 :param is_ipv6: (Default value = 0)
1375 :param is_local: (Default value = 0)
1376 :param is_classify: (Default value = 0)
1377 :param is_multipath: (Default value = 0)
1378 :param is_resolve_host: (Default value = 0)
1379 :param is_resolve_attached: (Default value = 0)
1380 :param next_hop_weight: (Default value = 1)
1381 :param is_multicast: (Default value = 0)
1385 self.papi.mpls_tunnel_add_del,
1386 {'mt_sw_if_index': tun_sw_if_index,
1387 'mt_is_add': is_add,
1388 'mt_l2_only': l2_only,
1389 'mt_is_multicast': is_multicast,
1390 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1391 'mt_next_hop_weight': next_hop_weight,
1392 'mt_next_hop': next_hop_address,
1393 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1394 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1395 'mt_next_hop_table_id': next_hop_table_id,
1396 'mt_next_hop_via_label': next_hop_via_label,
1397 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1399 def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
1400 return self.api(self.papi.mpls_tunnel_dump,
1401 {'sw_if_index': sw_if_index})
1403 def nat44_interface_add_del_feature(
1408 """Enable/disable NAT44 feature on the interface
1410 :param sw_if_index: Software index of the interface
1411 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1412 :param is_add: 1 if add, 0 if delete (Default value = 1)
1415 self.papi.nat44_interface_add_del_feature,
1417 'is_inside': is_inside,
1418 'sw_if_index': sw_if_index})
1420 def nat44_interface_add_del_output_feature(
1425 """Enable/disable NAT44 output feature on the interface
1427 :param sw_if_index: Software index of the interface
1428 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1429 :param is_add: 1 if add, 0 if delete (Default value = 1)
1432 self.papi.nat44_interface_add_del_output_feature,
1434 'is_inside': is_inside,
1435 'sw_if_index': sw_if_index})
1437 def nat44_add_del_static_mapping(
1441 external_sw_if_index=0xFFFFFFFF,
1452 """Add/delete NAT44 static mapping
1454 :param local_ip: Local IP address
1455 :param external_ip: External IP address
1456 :param external_sw_if_index: External interface instead of IP address
1457 :param local_port: Local port number (Default value = 0)
1458 :param external_port: External port number (Default value = 0)
1459 :param addr_only: 1 if address only mapping, 0 if address and port
1460 :param vrf_id: VRF ID
1461 :param protocol: IP protocol (Default value = 0)
1462 :param twice_nat: 1 if translate external host address and port
1463 :param self_twice_nat: 1 if translate external host address and port
1464 whenever external host address equals
1465 local address of internal host
1466 :param out2in_only: if 1 rule is matching only out2in direction
1467 :param tag: Opaque string tag
1468 :param is_add: 1 if add, 0 if delete (Default value = 1)
1471 self.papi.nat44_add_del_static_mapping,
1473 'addr_only': addr_only,
1474 'local_ip_address': local_ip,
1475 'external_ip_address': external_ip,
1476 'local_port': local_port,
1477 'external_port': external_port,
1478 'external_sw_if_index': external_sw_if_index,
1480 'protocol': protocol,
1481 'twice_nat': twice_nat,
1482 'self_twice_nat': self_twice_nat,
1483 'out2in_only': out2in_only,
1486 def nat44_add_del_identity_mapping(
1489 sw_if_index=0xFFFFFFFF,
1496 """Add/delete NAT44 identity mapping
1498 :param ip: IP address (Default value = 0)
1499 :param sw_if_index: Interface instead of IP address
1500 :param port: Port number (Default value = 0)
1501 :param addr_only: 1 if address only mapping, 0 if address and port
1502 :param vrf_id: VRF ID
1503 :param protocol: IP protocol (Default value = 0)
1504 :param tag: Opaque string tag
1505 :param is_add: 1 if add, 0 if delete (Default value = 1)
1508 self.papi.nat44_add_del_identity_mapping,
1510 'addr_only': addr_only,
1513 'sw_if_index': sw_if_index,
1516 'protocol': protocol})
1518 def nat44_add_del_address_range(
1525 """Add/del NAT44 address range
1527 :param first_ip_address: First IP address
1528 :param last_ip_address: Last IP address
1529 :param vrf_id: VRF id for the address range
1530 :param twice_nat: twice NAT address for extenal hosts
1531 :param is_add: 1 if add, 0 if delete (Default value = 1)
1534 self.papi.nat44_add_del_address_range,
1535 {'first_ip_address': first_ip_address,
1536 'last_ip_address': last_ip_address,
1538 'twice_nat': twice_nat,
1541 def nat44_address_dump(self):
1542 """Dump NAT44 addresses
1543 :return: Dictionary of NAT44 addresses
1545 return self.api(self.papi.nat44_address_dump, {})
1547 def nat44_interface_dump(self):
1548 """Dump interfaces with NAT44 feature
1549 :return: Dictionary of interfaces with NAT44 feature
1551 return self.api(self.papi.nat44_interface_dump, {})
1553 def nat44_interface_output_feature_dump(self):
1554 """Dump interfaces with NAT44 output feature
1555 :return: Dictionary of interfaces with NAT44 output feature
1557 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1559 def nat44_static_mapping_dump(self):
1560 """Dump NAT44 static mappings
1561 :return: Dictionary of NAT44 static mappings
1563 return self.api(self.papi.nat44_static_mapping_dump, {})
1565 def nat44_identity_mapping_dump(self):
1566 """Dump NAT44 identity mappings
1567 :return: Dictionary of NAT44 identity mappings
1569 return self.api(self.papi.nat44_identity_mapping_dump, {})
1571 def nat_show_config(self):
1572 """Show NAT plugin config
1573 :return: NAT plugin config parameters
1575 return self.api(self.papi.nat_show_config, {})
1577 def nat44_add_interface_addr(
1582 """Add/del NAT44 address from interface
1584 :param sw_if_index: Software index of the interface
1585 :param twice_nat: twice NAT address for extenal hosts
1586 :param is_add: 1 if add, 0 if delete (Default value = 1)
1589 self.papi.nat44_add_del_interface_addr,
1591 'sw_if_index': sw_if_index,
1592 'twice_nat': twice_nat})
1594 def nat44_interface_addr_dump(self):
1595 """Dump NAT44 addresses interfaces
1596 :return: Dictionary of NAT44 addresses interfaces
1598 return self.api(self.papi.nat44_interface_addr_dump, {})
1605 """Enable/disable NAT IPFIX logging
1607 :param domain_id: Observation domain ID (Default value = 1)
1608 :param src_port: Source port number (Default value = 4739)
1609 :param enable: 1 if enable, 0 if disable (Default value = 1)
1612 self.papi.nat_ipfix_enable_disable,
1613 {'domain_id': domain_id,
1614 'src_port': src_port,
1617 def nat44_user_session_dump(
1621 """Dump NAT44 user's sessions
1623 :param ip_address: ip adress of the user to be dumped
1624 :param cpu_index: cpu_index on which the user is
1625 :param vrf_id: VRF ID
1626 :return: Dictionary of S-NAT sessions
1629 self.papi.nat44_user_session_dump,
1630 {'ip_address': ip_address,
1633 def nat44_user_dump(self):
1636 :return: Dictionary of NAT44 users
1638 return self.api(self.papi.nat44_user_dump, {})
1640 def nat44_add_del_lb_static_mapping(
1653 """Add/delete NAT44 load balancing static mapping
1655 :param twice_nat: 1 if translate external host address and port
1656 :param tag: Opaque string tag
1657 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1658 :param is_add - 1 if add, 0 if delete
1661 self.papi.nat44_add_del_lb_static_mapping,
1663 'external_addr': external_addr,
1664 'external_port': external_port,
1665 'protocol': protocol,
1666 'twice_nat': twice_nat,
1667 'self_twice_nat': self_twice_nat,
1668 'out2in_only': out2in_only,
1670 'affinity': affinity,
1671 'local_num': local_num,
1674 def nat44_lb_static_mapping_dump(self):
1675 """Dump NAT44 load balancing static mappings
1677 :return: Dictionary of NAT44 load balancing static mapping
1679 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1681 def nat44_del_session(
1688 ext_host_address=None,
1690 """Delete NAT44 session
1692 :param addr: IPv4 address
1693 :param por: port number
1694 :param protocol: IP protocol number
1695 :param vrf_id: VRF ID
1696 :param is_in: 1 if inside network addres and port pari, 0 if outside
1697 :param ext_host_address: external host IPv4 address
1698 :param ext_host_port: external host port
1700 if ext_host_address is None:
1702 self.papi.nat44_del_session,
1705 'protocol': protocol,
1710 self.papi.nat44_del_session,
1713 'protocol': protocol,
1716 'ext_host_valid': 1,
1717 'ext_host_address': ext_host_address,
1718 'ext_host_port': ext_host_port})
1720 def nat44_forwarding_enable_disable(
1723 """Enable/disable forwarding for NAT44
1725 :param enable: 1 for enable, 0 for disable
1728 self.papi.nat44_forwarding_enable_disable,
1738 """Set NAT virtual fragmentation reassembly
1740 :param timeout: reassembly timeout (Default 2sec)
1741 :param max_reass: maximum concurrent reassemblies (Default 1024)
1742 :param max_frag: maximum fragmets per reassembly (Default 5)
1743 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1744 :param is_ip6: 1 if IPv6, 0 if IPv4
1747 self.papi.nat_set_reass,
1748 {'timeout': timeout,
1749 'max_reass': max_reass,
1750 'max_frag': max_frag,
1751 'drop_frag': drop_frag,
1754 def nat_get_reass(self):
1755 """Get NAT virtual fragmentation reassembly configuration
1757 :return: NAT virtual fragmentation reassembly configuration
1759 return self.api(self.papi.nat_get_reass, {})
1761 def nat_reass_dump(self):
1762 """Dump NAT virtual fragmentation reassemblies
1764 :return: Dictionary of NAT virtual fragmentation reassemblies
1766 return self.api(self.papi.nat_reass_dump, {})
1768 def nat_det_add_del_map(
1775 """Add/delete deterministic NAT mapping
1777 :param is_add - 1 if add, 0 if delete
1778 :param in_addr - inside IP address
1779 :param in_plen - inside IP address prefix length
1780 :param out_addr - outside IP address
1781 :param out_plen - outside IP address prefix length
1784 self.papi.nat_det_add_del_map,
1789 'out_addr': out_addr,
1790 'out_plen': out_plen})
1792 def nat_det_forward(
1795 """Get outside address and port range from inside address
1797 :param in_addr - inside IP address
1800 self.papi.nat_det_forward,
1801 {'in_addr': in_addr,
1804 def nat_det_reverse(
1808 """Get inside address from outside address and port
1810 :param out_addr - outside IP address
1811 :param out_port - outside port
1814 self.papi.nat_det_reverse,
1815 {'out_addr': out_addr,
1816 'out_port': out_port})
1818 def nat_det_map_dump(self):
1819 """Dump deterministic NAT mappings
1821 :return: Dictionary of deterministic NAT mappings
1823 return self.api(self.papi.nat_det_map_dump, {})
1825 def nat_set_timeouts(
1828 tcp_established=7440,
1831 """Set values of timeouts for NAT sessions (in seconds)
1833 :param udp - UDP timeout (Default value = 300)
1834 :param tcp_established - TCP established timeout (Default value = 7440)
1835 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1836 :param icmp - ICMP timeout (Default value = 60)
1839 self.papi.nat_set_timeouts,
1841 'tcp_established': tcp_established,
1842 'tcp_transitory': tcp_transitory,
1845 def nat_get_timeouts(self):
1846 """Get values of timeouts for NAT sessions
1848 :return: Timeouts for NAT sessions (in seconds)
1850 return self.api(self.papi.nat_get_timeouts, {})
1852 def nat_set_addr_and_port_alloc_alg(
1860 """Set address and port assignment algorithm
1862 :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1863 :param psid_offset: number of offset bits (valid only for MAP-E alg)
1864 :param psid_length: length of PSID (valid only for MAP-E alg)
1865 :param psid: Port Set Identifier value (valid only for MAP-E alg)
1866 :param start_port: beginning of the port range
1867 :param end_port: end of the port range
1870 self.papi.nat_set_addr_and_port_alloc_alg,
1872 'psid_offset': psid_offset,
1873 'psid_length': psid_length,
1875 'start_port': start_port,
1876 'end_port': end_port})
1878 def nat_get_addr_and_port_alloc_alg(self):
1879 """Get address and port assignment algorithm"""
1880 return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1882 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1883 """Set TCP MSS rewriting configuration
1885 :param enable: disable(0)/enable(1) MSS rewriting feature
1886 :param mss_value: MSS value to be used for MSS rewriting
1889 self.papi.nat_set_mss_clamping,
1890 {'enable': enable, 'mss_value': mss_value})
1892 def nat_get_mss_clamping(self):
1893 """Get TCP MSS rewriting configuration"""
1894 return self.api(self.papi.nat_get_mss_clamping, {})
1896 def nat_det_close_session_out(
1902 """Close deterministic NAT session using outside address and port
1904 :param out_addr - outside IP address
1905 :param out_port - outside port
1906 :param ext_addr - external host IP address
1907 :param ext_port - external host port
1910 self.papi.nat_det_close_session_out,
1911 {'out_addr': out_addr,
1912 'out_port': out_port,
1913 'ext_addr': ext_addr,
1914 'ext_port': ext_port})
1916 def nat_det_close_session_in(
1922 """Close deterministic NAT session using inside address and port
1924 :param in_addr - inside IP address
1925 :param in_port - inside port
1926 :param ext_addr - external host IP address
1927 :param ext_port - external host port
1930 self.papi.nat_det_close_session_in,
1931 {'in_addr': in_addr,
1933 'ext_addr': ext_addr,
1934 'ext_port': ext_port,
1937 def nat_det_session_dump(
1940 """Dump deterministic NAT sessions belonging to a user
1942 :param user_addr - inside IP address of the user
1943 :return: Dictionary of deterministic NAT sessions
1946 self.papi.nat_det_session_dump,
1948 'user_addr': user_addr})
1950 def nat64_add_del_pool_addr_range(
1956 """Add/del address range to NAT64 pool
1958 :param start_addr: First IP address
1959 :param end_addr: Last IP address
1960 :param vrf_id: VRF id for the address range
1961 :param is_add: 1 if add, 0 if delete (Default value = 1)
1964 self.papi.nat64_add_del_pool_addr_range,
1965 {'start_addr': start_addr,
1966 'end_addr': end_addr,
1970 def nat64_pool_addr_dump(self):
1971 """Dump NAT64 pool addresses
1972 :return: Dictionary of NAT64 pool addresses
1974 return self.api(self.papi.nat64_pool_addr_dump, {})
1976 def nat64_add_del_interface(
1981 """Enable/disable NAT64 feature on the interface
1982 :param sw_if_index: Index of the interface
1983 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1984 :param is_add: 1 if add, 0 if delete (Default value = 1)
1987 self.papi.nat64_add_del_interface,
1988 {'sw_if_index': sw_if_index,
1989 'is_inside': is_inside,
1992 def nat64_interface_dump(self):
1993 """Dump interfaces with NAT64 feature
1994 :return: Dictionary of interfaces with NAT64 feature
1996 return self.api(self.papi.nat64_interface_dump, {})
1998 def nat64_add_del_static_bib(
2007 """Add/delete S-NAT static BIB entry
2009 :param in_ip: Inside IPv6 address
2010 :param out_ip: Outside IPv4 address
2011 :param in_port: Inside port number
2012 :param out_port: Outside port number
2013 :param protocol: IP protocol
2014 :param vrf_id: VRF ID (Default value = 0)
2015 :param is_add: 1 if add, 0 if delete (Default value = 1)
2018 self.papi.nat64_add_del_static_bib,
2027 def nat64_bib_dump(self, protocol=255):
2030 :param protocol: IP protocol (Default value = 255, all BIBs)
2031 :returns: Dictionary of NAT64 BIB entries
2033 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
2035 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
2036 tcp_incoming_syn=6):
2037 """Set values of timeouts for NAT64 (in seconds)
2039 :param udpi: UDP timeout (Default value = 300)
2040 :param icmp: ICMP timeout (Default value = 60)
2041 :param tcp_trans: TCP transitory timeout (Default value = 240)
2042 :param tcp_est: TCP established timeout (Default value = 7440)
2043 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
2046 self.papi.nat64_set_timeouts,
2049 'tcp_trans': tcp_trans,
2051 'tcp_incoming_syn': tcp_incoming_syn})
2053 def nat64_get_timeouts(self):
2054 """Get values of timeouts for NAT64
2056 :return: Timeouts for NAT64 (in seconds)
2058 return self.api(self.papi.nat64_get_timeouts, {})
2060 def nat64_st_dump(self, protocol=255):
2061 """Dump NAT64 session table
2063 :param protocol: IP protocol (Default value = 255, all STs)
2064 :returns: Dictionary of NAT64 sesstion table entries
2066 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2068 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2069 """Add/del NAT64 prefix
2071 :param prefix: NAT64 prefix
2072 :param plen: NAT64 prefix length
2073 :param vrf_id: VRF id of tenant (Default 0)
2074 :param is_add: 1 if add, 0 if delete (Default value = 1)
2077 self.papi.nat64_add_del_prefix,
2083 def nat64_prefix_dump(self):
2084 """Dump NAT64 prefix
2086 :returns: Dictionary of NAT64 prefixes
2088 return self.api(self.papi.nat64_prefix_dump, {})
2090 def nat64_add_interface_addr(
2094 """Add/del NAT64 address from interface
2096 :param sw_if_index: Software index of the interface
2097 :param is_add: 1 if add, 0 if delete (Default value = 1)
2099 return self.api(self.papi.nat64_add_del_interface_addr,
2100 {'is_add': is_add, 'sw_if_index': sw_if_index})
2102 def dslite_set_aftr_addr(self, ip6, ip4):
2103 """Set DS-Lite AFTR addresses
2105 :param ip4: IPv4 address
2106 :param ip6: IPv6 address
2109 self.papi.dslite_set_aftr_addr,
2113 def dslite_set_b4_addr(self, ip6, ip4):
2114 """Set DS-Lite B4 IPv6 address
2116 :param ip4: IPv4 address
2117 :param ip6: IPv6 address
2120 self.papi.dslite_set_b4_addr,
2124 def dslite_add_del_pool_addr_range(
2129 """Add/del address range to DS-Lite pool
2131 :param start_addr: First IP address
2132 :param end_addr: Last IP address
2133 :param is_add: 1 if add, 0 if delete (Default value = 1)
2136 self.papi.dslite_add_del_pool_addr_range,
2137 {'start_addr': start_addr,
2138 'end_addr': end_addr,
2141 def nat66_add_del_interface(
2146 """Enable/disable NAT66 feature on the interface
2147 :param sw_if_index: Index of the interface
2148 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2149 :param is_add: 1 if add, 0 if delete (Default value = 1)
2152 self.papi.nat66_add_del_interface,
2153 {'sw_if_index': sw_if_index,
2154 'is_inside': is_inside,
2157 def nat66_add_del_static_mapping(
2163 """Add/delete NAT66 static mapping
2165 :param in_ip: Inside IPv6 address
2166 :param out_ip: Outside IPv6 address
2167 :param vrf_id: VRF ID (Default value = 0)
2168 :param is_add: 1 if add, 0 if delete (Default value = 1)
2171 self.papi.nat66_add_del_static_mapping,
2172 {'local_ip_address': in_ip,
2173 'external_ip_address': out_ip,
2177 def nat66_interface_dump(self):
2178 """Dump interfaces with NAT66 feature
2179 :return: Dictionary of interfaces with NAT66 feature
2181 return self.api(self.papi.nat66_interface_dump, {})
2183 def nat66_static_mapping_dump(self):
2184 """Dump NAT66 static mappings
2185 :return: Dictionary of NAT66 static mappings
2187 return self.api(self.papi.nat66_static_mapping_dump, {})
2189 def control_ping(self):
2190 self.api(self.papi.control_ping)
2192 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2193 detect_mult, local_addr, peer_addr, is_ipv6=0,
2194 bfd_key_id=None, conf_key_id=None):
2195 if bfd_key_id is None:
2196 return self.api(self.papi.bfd_udp_add,
2198 'sw_if_index': sw_if_index,
2199 'desired_min_tx': desired_min_tx,
2200 'required_min_rx': required_min_rx,
2201 'local_addr': local_addr,
2202 'peer_addr': peer_addr,
2204 'detect_mult': detect_mult,
2207 return self.api(self.papi.bfd_udp_add,
2209 'sw_if_index': sw_if_index,
2210 'desired_min_tx': desired_min_tx,
2211 'required_min_rx': required_min_rx,
2212 'local_addr': local_addr,
2213 'peer_addr': peer_addr,
2215 'detect_mult': detect_mult,
2216 'is_authenticated': 1,
2217 'bfd_key_id': bfd_key_id,
2218 'conf_key_id': conf_key_id,
2221 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2222 detect_mult, local_addr, peer_addr, is_ipv6=0):
2223 return self.api(self.papi.bfd_udp_mod,
2225 'sw_if_index': sw_if_index,
2226 'desired_min_tx': desired_min_tx,
2227 'required_min_rx': required_min_rx,
2228 'local_addr': local_addr,
2229 'peer_addr': peer_addr,
2231 'detect_mult': detect_mult,
2234 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2235 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2237 return self.api(self.papi.bfd_udp_auth_activate,
2239 'sw_if_index': sw_if_index,
2240 'local_addr': local_addr,
2241 'peer_addr': peer_addr,
2243 'is_delayed': 1 if is_delayed else 0,
2244 'bfd_key_id': bfd_key_id,
2245 'conf_key_id': conf_key_id,
2248 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2249 is_ipv6=0, is_delayed=False):
2250 return self.api(self.papi.bfd_udp_auth_deactivate,
2252 'sw_if_index': sw_if_index,
2253 'local_addr': local_addr,
2254 'peer_addr': peer_addr,
2256 'is_delayed': 1 if is_delayed else 0,
2259 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2260 return self.api(self.papi.bfd_udp_del,
2262 'sw_if_index': sw_if_index,
2263 'local_addr': local_addr,
2264 'peer_addr': peer_addr,
2268 def bfd_udp_session_dump(self):
2269 return self.api(self.papi.bfd_udp_session_dump, {})
2271 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2272 peer_addr, is_ipv6=0):
2273 return self.api(self.papi.bfd_udp_session_set_flags, {
2274 'admin_up_down': admin_up_down,
2275 'sw_if_index': sw_if_index,
2276 'local_addr': local_addr,
2277 'peer_addr': peer_addr,
2281 def want_bfd_events(self, enable_disable=1):
2282 return self.api(self.papi.want_bfd_events, {
2283 'enable_disable': enable_disable,
2287 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2288 return self.api(self.papi.bfd_auth_set_key, {
2289 'conf_key_id': conf_key_id,
2290 'auth_type': auth_type,
2292 'key_len': len(key),
2295 def bfd_auth_del_key(self, conf_key_id):
2296 return self.api(self.papi.bfd_auth_del_key, {
2297 'conf_key_id': conf_key_id,
2300 def bfd_auth_keys_dump(self):
2301 return self.api(self.papi.bfd_auth_keys_dump, {})
2303 def bfd_udp_set_echo_source(self, sw_if_index):
2304 return self.api(self.papi.bfd_udp_set_echo_source,
2305 {'sw_if_index': sw_if_index})
2307 def bfd_udp_del_echo_source(self):
2308 return self.api(self.papi.bfd_udp_del_echo_source, {})
2310 def bfd_udp_get_echo_source(self):
2311 return self.api(self.papi.bfd_udp_get_echo_source, {})
2313 def classify_add_del_table(
2318 table_index=0xFFFFFFFF,
2320 memory_size=2097152,
2322 next_table_index=0xFFFFFFFF,
2323 miss_next_index=0xFFFFFFFF,
2324 current_data_flag=0,
2325 current_data_offset=0):
2329 :param match_n_vectors: (Default value = 1)
2330 :param table_index: (Default value = 0xFFFFFFFF)
2331 :param nbuckets: (Default value = 2)
2332 :param memory_size: (Default value = 2097152)
2333 :param skip_n_vectors: (Default value = 0)
2334 :param next_table_index: (Default value = 0xFFFFFFFF)
2335 :param miss_next_index: (Default value = 0xFFFFFFFF)
2336 :param current_data_flag: (Default value = 0)
2337 :param current_data_offset: (Default value = 0)
2340 mask_len = ((len(mask) - 1) / 16 + 1) * 16
2341 mask = mask + '\0' * (mask_len - len(mask))
2343 self.papi.classify_add_del_table,
2345 'table_index': table_index,
2346 'nbuckets': nbuckets,
2347 'memory_size': memory_size,
2348 'skip_n_vectors': skip_n_vectors,
2349 'match_n_vectors': match_n_vectors,
2350 'next_table_index': next_table_index,
2351 'miss_next_index': miss_next_index,
2352 'current_data_flag': current_data_flag,
2353 'current_data_offset': current_data_offset,
2354 'mask_len': mask_len,
2357 def classify_add_del_session(
2362 opaque_index=0xFFFFFFFF,
2363 hit_next_index=0xFFFFFFFF,
2371 :param opaque_index: (Default value = 0xFFFFFFFF)
2372 :param hit_next_index: (Default value = 0xFFFFFFFF)
2373 :param advance: (Default value = 0)
2374 :param action: (Default value = 0)
2375 :param metadata: (Default value = 0)
2378 match_len = ((len(match) - 1) / 16 + 1) * 16
2379 match = match + '\0' * (match_len - len(match))
2381 self.papi.classify_add_del_session,
2383 'table_index': table_index,
2384 'hit_next_index': hit_next_index,
2385 'opaque_index': opaque_index,
2388 'metadata': metadata,
2389 'match_len': match_len,
2392 def input_acl_set_interface(
2396 ip4_table_index=0xFFFFFFFF,
2397 ip6_table_index=0xFFFFFFFF,
2398 l2_table_index=0xFFFFFFFF):
2402 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2403 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2404 :param l2_table_index: (Default value = 0xFFFFFFFF)
2408 self.papi.input_acl_set_interface,
2409 {'sw_if_index': sw_if_index,
2410 'ip4_table_index': ip4_table_index,
2411 'ip6_table_index': ip6_table_index,
2412 'l2_table_index': l2_table_index,
2415 def output_acl_set_interface(
2419 ip4_table_index=0xFFFFFFFF,
2420 ip6_table_index=0xFFFFFFFF,
2421 l2_table_index=0xFFFFFFFF):
2425 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2426 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2427 :param l2_table_index: (Default value = 0xFFFFFFFF)
2431 self.papi.output_acl_set_interface,
2432 {'sw_if_index': sw_if_index,
2433 'ip4_table_index': ip4_table_index,
2434 'ip6_table_index': ip6_table_index,
2435 'l2_table_index': l2_table_index,
2438 def set_ipfix_exporter(
2445 collector_port=4739,
2448 self.papi.set_ipfix_exporter,
2450 'collector_address': collector_address,
2451 'collector_port': collector_port,
2452 'src_address': src_address,
2454 'path_mtu': path_mtu,
2455 'template_interval': template_interval,
2456 'udp_checksum': udp_checksum,
2459 def dhcp_proxy_config(self,
2467 self.papi.dhcp_proxy_config,
2469 'rx_vrf_id': rx_table_id,
2470 'server_vrf_id': server_table_id,
2473 'dhcp_server': dhcp_server,
2474 'dhcp_src_address': dhcp_src_address,
2477 def dhcp_proxy_set_vss(self,
2486 self.papi.dhcp_proxy_set_vss,
2489 'vss_type': vss_type,
2490 'vpn_ascii_id': vpn_ascii_id,
2492 'vpn_index': vpn_index,
2497 def dhcp_client_dump(self):
2498 return self.api(self.papi.dhcp_client_dump, {})
2500 def dhcp_client(self,
2505 set_broadcast_flag=1,
2506 want_dhcp_events=0):
2508 self.papi.dhcp_client_config,
2512 'sw_if_index': sw_if_index,
2513 'hostname': hostname,
2515 'want_dhcp_event': want_dhcp_events,
2516 'set_broadcast_flag': set_broadcast_flag,
2520 def ip_mroute_add_del(self,
2526 next_hop_sw_if_index,
2536 IP Multicast Route add/del
2539 self.papi.ip_mroute_add_del,
2540 {'next_hop_sw_if_index': next_hop_sw_if_index,
2541 'entry_flags': e_flags,
2542 'itf_flags': i_flags,
2543 'table_id': table_id,
2547 'is_local': is_local,
2548 'bier_imp': bier_imp,
2549 'next_hop_afi': next_hop_afi,
2550 'grp_address_length': grp_address_length,
2551 'grp_address': grp_address,
2552 'src_address': src_address,
2553 'nh_address': next_hop_address})
2555 def mfib_signal_dump(self):
2556 return self.api(self.papi.mfib_signal_dump, {})
2558 def ip_mfib_dump(self):
2559 return self.api(self.papi.ip_mfib_dump, {})
2561 def ip6_mfib_dump(self):
2562 return self.api(self.papi.ip6_mfib_dump, {})
2564 def lisp_enable_disable(self, is_enabled):
2566 self.papi.lisp_enable_disable,
2568 'is_en': is_enabled,
2571 def lisp_locator_set(self,
2575 self.papi.lisp_add_del_locator_set,
2578 'locator_set_name': ls_name
2581 def lisp_locator_set_dump(self):
2582 return self.api(self.papi.lisp_locator_set_dump, {})
2584 def lisp_locator(self,
2591 self.papi.lisp_add_del_locator,
2594 'locator_set_name': ls_name,
2595 'sw_if_index': sw_if_index,
2596 'priority': priority,
2600 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2602 self.papi.lisp_locator_dump,
2604 'is_index_set': is_index_set,
2606 'ls_index': ls_index,
2609 def lisp_local_mapping(self,
2619 self.papi.lisp_add_del_local_eid,
2621 'locator_set_name': ls_name,
2623 'eid_type': eid_type,
2625 'prefix_len': prefix_len,
2631 def lisp_eid_table_dump(self,
2639 self.papi.lisp_eid_table_dump,
2642 'prefix_length': prefix_length,
2644 'eid_type': eid_type,
2646 'filter': filter_opt,
2649 def lisp_remote_mapping(self,
2659 self.papi.lisp_add_del_remote_mapping,
2662 'eid_type': eid_type,
2664 'eid_len': eid_prefix_len,
2665 'rloc_num': rlocs_num,
2668 'is_src_dst': is_src_dst,
2671 def lisp_adjacency(self,
2680 self.papi.lisp_add_del_adjacency,
2684 'eid_type': eid_type,
2687 'leid_len': leid_len,
2688 'reid_len': reid_len,
2691 def lisp_adjacencies_get(self, vni=0):
2693 self.papi.lisp_adjacencies_get,
2698 def map_add_domain(self,
2709 self.papi.map_add_domain,
2711 'ip6_prefix': ip6_prefix,
2712 'ip4_prefix': ip4_prefix,
2714 'ea_bits_len': ea_bits_len,
2715 'psid_offset': psid_offset,
2716 'psid_length': psid_length,
2717 'is_translation': is_translation,
2718 'is_rfc6052': is_rfc6052,
2722 def gtpu_add_del_tunnel(
2728 mcast_sw_if_index=0xFFFFFFFF,
2730 decap_next_index=0xFFFFFFFF,
2734 :param is_add: (Default value = 1)
2735 :param is_ipv6: (Default value = 0)
2738 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2739 :param encap_vrf_id: (Default value = 0)
2740 :param decap_next_index: (Default value = 0xFFFFFFFF)
2741 :param teid: (Default value = 0)
2744 return self.api(self.papi.gtpu_add_del_tunnel,
2747 'src_address': src_addr,
2748 'dst_address': dst_addr,
2749 'mcast_sw_if_index': mcast_sw_if_index,
2750 'encap_vrf_id': encap_vrf_id,
2751 'decap_next_index': decap_next_index,
2754 def vxlan_gpe_add_del_tunnel(
2758 mcast_sw_if_index=0xFFFFFFFF,
2769 :param is_add: (Default value = 1)
2770 :param is_ipv6: (Default value = 0)
2771 :param encap_vrf_id: (Default value = 0)
2772 :param decap_vrf_id: (Default value = 0)
2773 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2774 :param protocol: (Default value = 3)
2775 :param vni: (Default value = 0)
2778 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2783 'mcast_sw_if_index': mcast_sw_if_index,
2784 'encap_vrf_id': encap_vrf_id,
2785 'decap_vrf_id': decap_vrf_id,
2786 'protocol': protocol,
2789 def vxlan_gbp_tunnel_add_del(
2793 mcast_sw_if_index=0xFFFFFFFF,
2798 instance=0xFFFFFFFF):
2803 :param is_add: (Default value = 1)
2804 :param is_ipv6: (Default value = 0)
2805 :param encap_table_id: (Default value = 0)
2806 :param decap_next_index: (Default value = 0xFFFFFFFF)
2807 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2808 :param vni: (Default value = 0)
2809 :param instance: (Default value = 0xFFFFFFFF)
2812 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2817 'mcast_sw_if_index': mcast_sw_if_index,
2818 'encap_table_id': encap_table_id,
2820 'instance': instance}})
2822 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2823 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2824 {'sw_if_index': sw_if_index})
2826 def pppoe_add_del_session(
2836 :param is_add: (Default value = 1)
2837 :param is_ipv6: (Default value = 0)
2839 :param session_id: (Default value = 0)
2841 :param decap_vrf_id: (Default value = 0)
2844 return self.api(self.papi.pppoe_add_del_session,
2847 'session_id': session_id,
2848 'client_ip': client_ip,
2849 'decap_vrf_id': decap_vrf_id,
2850 'client_mac': client_mac})
2852 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2853 return self.api(self.papi.sr_mpls_policy_add,
2857 'n_segments': len(segments),
2858 'segments': segments})
2860 def sr_mpls_policy_del(self, bsid):
2861 return self.api(self.papi.sr_mpls_policy_del,
2864 def sr_localsid_add_del(self,
2871 sw_if_index=0xFFFFFFFF,
2875 """ Add/del IPv6 SR local-SID.
2878 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2879 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2882 :param is_del: (Default value = 0)
2883 :param end_psp: (Default value = 0)
2884 :param sw_if_index: (Default value = 0xFFFFFFFF)
2885 :param vlan_index: (Default value = 0)
2886 :param fib_table: (Default value = 0)
2889 self.papi.sr_localsid_add_del,
2891 'localsid': localsid,
2893 'behavior': behavior,
2894 'sw_if_index': sw_if_index,
2895 'vlan_index': vlan_index,
2896 'fib_table': fib_table,
2897 'nh_addr4': nh_addr4,
2898 'nh_addr6': nh_addr6
2912 :param bsid_addr: bindingSID of the SR Policy
2913 :param weight: weight of the sid list. optional. (default: 1)
2914 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2916 :param type: type/behavior of the SR policy. (default or spray) \
2918 :param fib_table: VRF where to install the FIB entry for the BSID \
2920 :param n_segments: number of segments \
2922 :param segments: a vector of IPv6 address composing the segment list \
2926 self.papi.sr_policy_add,
2927 {'bsid_addr': bsid_addr,
2929 'is_encap': is_encap,
2931 'fib_table': fib_table,
2932 'n_segments': n_segments,
2933 'segments': segments
2942 :param bsid: bindingSID of the SR Policy
2943 :param sr_policy_index: index of the sr policy (default: 0)
2946 self.papi.sr_policy_del,
2947 {'bsid_addr': bsid_addr,
2948 'sr_policy_index': sr_policy_index
2951 def sr_steering_add_del(
2962 Steer traffic L2 and L3 traffic through a given SR policy
2964 :param is_del: delete or add
2965 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2966 :param sr_policy: is the index of the SR Policy (alt to bsid)
2967 :param table_id: is the VRF where to install the FIB entry for the BSID
2968 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2969 :param mask_width: is the mask for L3 traffic type
2970 :param sw_if_index: is the incoming interface for L2 traffic
2971 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2974 self.papi.sr_steering_add_del,
2976 'bsid_addr': bsid_addr,
2977 'sr_policy_index': sr_policy_index,
2978 'table_id': table_id,
2979 'prefix_addr': prefix_addr,
2980 'mask_width': mask_width,
2981 'sw_if_index': sw_if_index,
2982 'traffic_type': traffic_type
2985 def acl_add_replace(self, acl_index, r, tag='',
2987 """Add/replace an ACL
2988 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2989 :param acl_rule r: ACL rules array.
2990 :param str tag: symbolic tag (description) for this ACL.
2991 :param int count: number of rules.
2993 return self.api(self.papi.acl_add_replace,
2994 {'acl_index': acl_index,
2998 expected_retval=expected_retval)
3000 def acl_del(self, acl_index, expected_retval=0):
3006 return self.api(self.papi.acl_del,
3007 {'acl_index': acl_index},
3008 expected_retval=expected_retval)
3010 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
3012 return self.api(self.papi.acl_interface_set_acl_list,
3013 {'sw_if_index': sw_if_index,
3017 expected_retval=expected_retval)
3019 def acl_interface_set_etype_whitelist(self, sw_if_index,
3022 return self.api(self.papi.acl_interface_set_etype_whitelist,
3023 {'sw_if_index': sw_if_index,
3024 'count': len(whitelist),
3026 'whitelist': whitelist},
3027 expected_retval=expected_retval)
3029 def acl_interface_add_del(self,
3033 """ Add/Delete ACL to/from interface
3037 :param is_add: (Default value = 1)
3040 return self.api(self.papi.acl_interface_add_del,
3043 'sw_if_index': sw_if_index,
3044 'acl_index': acl_index})
3046 def acl_dump(self, acl_index, expected_retval=0):
3047 return self.api(self.papi.acl_dump,
3048 {'acl_index': acl_index},
3049 expected_retval=expected_retval)
3051 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3053 return self.api(self.papi.acl_interface_list_dump,
3054 {'sw_if_index': sw_if_index},
3055 expected_retval=expected_retval)
3057 def macip_acl_add(self, rules, tag=""):
3060 :param rules: list of rules for given acl
3064 return self.api(self.papi.macip_acl_add,
3066 'count': len(rules),
3069 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3072 :param rules: list of rules for given acl
3076 return self.api(self.papi.macip_acl_add_replace,
3077 {'acl_index': acl_index,
3079 'count': len(rules),
3082 def macip_acl_del(self, acl_index):
3088 return self.api(self.papi.macip_acl_del,
3089 {'acl_index': acl_index})
3091 def macip_acl_interface_add_del(self,
3095 """ Add MACIP acl to interface
3099 :param is_add: (Default value = 1)
3102 return self.api(self.papi.macip_acl_interface_add_del,
3104 'sw_if_index': sw_if_index,
3105 'acl_index': acl_index})
3107 def macip_acl_interface_get(self):
3108 """ Return interface acls dump
3111 self.papi.macip_acl_interface_get, {})
3113 def macip_acl_dump(self, acl_index=4294967295):
3114 """ Return MACIP acl dump
3118 self.papi.macip_acl_dump, {'acl_index': acl_index})
3120 def policer_add_del(self,
3131 conform_action_type=1,
3133 exceed_action_type=0,
3135 violate_action_type=0,
3137 return self.api(self.papi.policer_add_del,
3144 'rate_type': rate_type,
3145 'round_type': round_type,
3147 'color_aware': color_aware,
3148 'conform_action_type': conform_action_type,
3149 'conform_dscp': conform_dscp,
3150 'exceed_action_type': exceed_action_type,
3151 'exceed_dscp': exceed_dscp,
3152 'violate_action_type': violate_action_type,
3153 'violate_dscp': violate_dscp})
3155 def ip_punt_police(self,
3159 return self.api(self.papi.ip_punt_police,
3160 {'policer_index': policer_index,
3164 def ip_punt_redirect(self,
3169 return self.api(self.papi.ip_punt_redirect,
3170 {'punt': {'rx_sw_if_index': rx_sw_if_index,
3171 'tx_sw_if_index': tx_sw_if_index,
3175 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
3176 return self.api(self.papi.ip_punt_redirect_dump,
3177 {'sw_if_index': sw_if_index,
3178 'is_ipv6': is_ipv6})
3180 def bier_table_add_del(self,
3184 """ BIER Table add/del """
3186 self.papi.bier_table_add_del,
3187 {'bt_tbl_id': {"bt_set": bti.set_id,
3188 "bt_sub_domain": bti.sub_domain_id,
3189 "bt_hdr_len_id": bti.hdr_len_id},
3190 'bt_label': mpls_label,
3191 'bt_is_add': is_add})
3193 def bier_table_dump(self):
3194 return self.api(self.papi.bier_table_dump, {})
3196 def bier_route_add_del(self,
3202 """ BIER Route add/del """
3204 self.papi.bier_route_add_del,
3205 {'br_tbl_id': {"bt_set": bti.set_id,
3206 "bt_sub_domain": bti.sub_domain_id,
3207 "bt_hdr_len_id": bti.hdr_len_id},
3209 'br_n_paths': len(paths),
3211 'br_is_add': is_add,
3212 'br_is_replace': is_replace})
3214 def bier_route_dump(self, bti):
3216 self.papi.bier_route_dump,
3217 {'br_tbl_id': {"bt_set": bti.set_id,
3218 "bt_sub_domain": bti.sub_domain_id,
3219 "bt_hdr_len_id": bti.hdr_len_id}})
3221 def bier_imp_add(self,
3226 """ BIER Imposition Add """
3228 self.papi.bier_imp_add,
3229 {'bi_tbl_id': {"bt_set": bti.set_id,
3230 "bt_sub_domain": bti.sub_domain_id,
3231 "bt_hdr_len_id": bti.hdr_len_id},
3233 'bi_n_bytes': len(ibytes),
3234 'bi_bytes': ibytes})
3236 def bier_imp_del(self, bi_index):
3237 """ BIER Imposition del """
3239 self.papi.bier_imp_del,
3240 {'bi_index': bi_index})
3242 def bier_imp_dump(self):
3243 return self.api(self.papi.bier_imp_dump, {})
3245 def bier_disp_table_add_del(self,
3248 """ BIER Disposition Table add/del """
3250 self.papi.bier_disp_table_add_del,
3251 {'bdt_tbl_id': bdti,
3252 'bdt_is_add': is_add})
3254 def bier_disp_table_dump(self):
3255 return self.api(self.papi.bier_disp_table_dump, {})
3257 def bier_disp_entry_add_del(self,
3267 """ BIER Route add/del """
3269 while (len(lstack) < 16):
3272 self.papi.bier_disp_entry_add_del,
3273 {'bde_tbl_id': bdti,
3275 'bde_payload_proto': payload_proto,
3277 'bde_paths': [{'next_hop': next_hop,
3278 'table_id': next_hop_tbl_id,
3279 'afi': next_hop_afi,
3280 'rpf_id': next_hop_rpf_id,
3282 'label_stack': lstack}],
3283 'bde_is_add': is_add})
3285 def bier_disp_entry_dump(self, bdti):
3287 self.papi.bier_disp_entry_dump,
3288 {'bde_tbl_id': bdti})
3290 def add_node_next(self, node_name, next_name):
3291 """ Set the next node for a given node request
3296 return self.api(self.papi.add_node_next,
3297 {'node_name': node_name,
3298 'next_name': next_name})
3300 def session_enable_disable(self, is_enabled):
3302 self.papi.session_enable_disable,
3303 {'is_enable': is_enabled})
3305 def ipsec_spd_add_del(self, spd_id, is_add=1):
3306 """ SPD add/del - Wrapper to add or del ipsec SPD
3307 Sample CLI : 'ipsec spd add 1'
3309 :param spd_id - SPD ID to be created in the vpp . mandatory
3310 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3312 :returns: reply from the API
3315 self.papi.ipsec_spd_add_del, {
3316 'spd_id': spd_id, 'is_add': is_add})
3318 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3319 """ IPSEC interface SPD add/del - \
3320 Wrapper to associate/disassociate SPD to interface in VPP
3321 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3323 :param spd_id - SPD ID to associate with the interface . mandatory
3324 :param sw_if_index - Interface Index which needs to ipsec \
3325 association mandatory
3326 :param is_add - add(1) or del(0) association with interface \
3327 (Default 1 - add) . optional
3328 :returns: reply from the API
3331 self.papi.ipsec_interface_add_del_spd,
3332 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3334 def ipsec_sad_add_del_entry(self,
3337 integrity_algorithm,
3342 tunnel_src_address='',
3343 tunnel_dst_address='',
3349 use_extended_sequence_number=0):
3350 """ IPSEC SA add/del
3351 :param sad_id: security association ID
3352 :param spi: security param index of the SA in decimal
3353 :param integrity_algorithm:
3354 :param integrity_key:
3355 :param crypto_algorithm:
3357 :param protocol: AH(0) or ESP(1) protocol
3358 :param tunnel_src_address: tunnel mode outer src address
3359 :param tunnel_dst_address: tunnel mode outer dst address
3362 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3363 crypto and ipsec algorithms
3366 self.papi.ipsec_sad_add_del_entry,
3369 'tunnel_src_address': tunnel_src_address,
3370 'tunnel_dst_address': tunnel_dst_address,
3371 'protocol': protocol,
3372 'integrity_algorithm': integrity_algorithm,
3373 'integrity_key_length': len(integrity_key),
3374 'integrity_key': integrity_key,
3375 'crypto_algorithm': crypto_algorithm,
3376 'crypto_key_length': len(crypto_key) if crypto_key is not None
3378 'crypto_key': crypto_key,
3380 'is_tunnel': is_tunnel,
3381 'is_tunnel_ipv6': is_tunnel_ipv6,
3382 'udp_encap': udp_encap,
3383 'use_extended_sequence_number': use_extended_sequence_number,
3384 'use_anti_replay': use_anti_replay})
3386 def ipsec_spd_add_del_entry(self,
3389 local_address_start,
3391 remote_address_start,
3392 remote_address_stop,
3394 local_port_stop=65535,
3395 remote_port_start=0,
3396 remote_port_stop=65535,
3404 """ IPSEC policy SPD add/del -
3405 Wrapper to configure ipsec SPD policy entries in VPP
3406 :param spd_id: SPD ID for the policy
3407 :param local_address_start: local-ip-range start address
3408 :param local_address_stop : local-ip-range stop address
3409 :param remote_address_start: remote-ip-range start address
3410 :param remote_address_stop : remote-ip-range stop address
3411 :param local_port_start: (Default value = 0)
3412 :param local_port_stop: (Default value = 65535)
3413 :param remote_port_start: (Default value = 0)
3414 :param remote_port_stop: (Default value = 65535)
3415 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3416 :param sa_id: Security Association ID for mapping it to SPD
3417 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3419 :param priority: value for the spd action (Default value = 100)
3420 :param is_outbound: flag for inbound(0) or outbound(1)
3422 :param is_add: (Default value = 1)
3425 self.papi.ipsec_spd_add_del_entry,
3428 'local_address_start': local_address_start,
3429 'local_address_stop': local_address_stop,
3430 'remote_address_start': remote_address_start,
3431 'remote_address_stop': remote_address_stop,
3432 'local_port_start': local_port_start,
3433 'local_port_stop': local_port_stop,
3434 'remote_port_start': remote_port_start,
3435 'remote_port_stop': remote_port_stop,
3437 'protocol': protocol,
3439 'priority': priority,
3440 'is_outbound': is_outbound,
3442 'is_ip_any': is_ip_any})
3444 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3445 remote_spi, crypto_alg, local_crypto_key,
3446 remote_crypto_key, integ_alg, local_integ_key,
3447 remote_integ_key, is_add=1, esn=0,
3448 anti_replay=1, renumber=0, show_instance=0):
3450 self.papi.ipsec_tunnel_if_add_del,
3451 {'local_ip': local_ip, 'remote_ip': remote_ip,
3452 'local_spi': local_spi, 'remote_spi': remote_spi,
3453 'crypto_alg': crypto_alg,
3454 'local_crypto_key_len': len(local_crypto_key),
3455 'local_crypto_key': local_crypto_key,
3456 'remote_crypto_key_len': len(remote_crypto_key),
3457 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3458 'local_integ_key_len': len(local_integ_key),
3459 'local_integ_key': local_integ_key,
3460 'remote_integ_key_len': len(remote_integ_key),
3461 'remote_integ_key': remote_integ_key, 'is_add': is_add,
3462 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3463 'show_instance': show_instance
3466 def ipsec_select_backend(self, protocol, index):
3467 return self.api(self.papi.ipsec_select_backend,
3468 {'protocol': protocol, 'index': index})
3470 def ipsec_backend_dump(self):
3471 return self.api(self.papi.ipsec_backend_dump, {})
3473 def app_namespace_add(self,
3477 sw_if_index=0xFFFFFFFF,
3480 self.papi.app_namespace_add_del,
3482 'sw_if_index': sw_if_index,
3483 'ip4_fib_id': ip4_fib_id,
3484 'ip6_fib_id': ip6_fib_id,
3485 'namespace_id': namespace_id,
3486 'namespace_id_len': len(namespace_id)})
3488 def punt_socket_register(self, port, pathname, protocol=0x11,
3489 header_version=1, is_ip4=1):
3490 """ Register punt socket """
3491 return self.api(self.papi.punt_socket_register,
3492 {'header_version': header_version,
3493 'punt': {'ipv': is_ip4,
3494 'l4_protocol': protocol,
3496 'pathname': pathname})
3498 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
3499 """ Unregister punt socket """
3500 return self.api(self.papi.punt_socket_deregister,
3501 {'punt': {'ipv': is_ip4,
3502 'l4_protocol': protocol,
3505 def punt_socket_dump(self, is_ip6=1):
3506 """ Dump punt socket"""
3507 return self.api(self.papi.punt_socket_dump,
3508 {'is_ipv6': is_ip6})
3510 def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3511 expire_walk_interval_ms, is_ip6=0):
3512 """ Set IP reassembly parameters """
3513 return self.api(self.papi.ip_reassembly_set,
3515 'timeout_ms': timeout_ms,
3516 'expire_walk_interval_ms': expire_walk_interval_ms,
3517 'max_reassemblies': max_reassemblies})
3519 def ip_reassembly_get(self, is_ip6=0):
3520 """ Get IP reassembly parameters """
3521 return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3523 def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3525 """ Enable/disable IP reassembly """
3526 return self.api(self.papi.ip_reassembly_enable_disable,
3527 {'sw_if_index': sw_if_index,
3528 'enable_ip4': 1 if enable_ip4 else 0,
3529 'enable_ip6': 1 if enable_ip6 else 0,
3532 def gbp_endpoint_add(self, sw_if_index, ips, mac, epg, flags,
3534 """ GBP endpoint Add """
3535 return self.api(self.papi.gbp_endpoint_add,
3537 'sw_if_index': sw_if_index,
3549 def gbp_endpoint_del(self, handle):
3550 """ GBP endpoint Del """
3551 return self.api(self.papi.gbp_endpoint_del,
3554 def gbp_endpoint_dump(self):
3555 """ GBP endpoint Dump """
3556 return self.api(self.papi.gbp_endpoint_dump, {})
3558 def gbp_endpoint_group_add(self, epg, bd,
3559 rd, uplink_sw_if_index):
3560 """ GBP endpoint group Add """
3561 return self.api(self.papi.gbp_endpoint_group_add,
3564 'uplink_sw_if_index': uplink_sw_if_index,
3570 def gbp_endpoint_group_del(self, epg):
3571 """ GBP endpoint group Del """
3572 return self.api(self.papi.gbp_endpoint_group_del,
3575 def gbp_endpoint_group_dump(self):
3576 """ GBP endpoint group Dump """
3577 return self.api(self.papi.gbp_endpoint_group_dump, {})
3579 def gbp_bridge_domain_add(self, bd_id, flags,
3581 uu_fwd_sw_if_index):
3582 """ GBP bridge-domain Add """
3583 return self.api(self.papi.gbp_bridge_domain_add,
3587 'bvi_sw_if_index': bvi_sw_if_index,
3588 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
3592 def gbp_bridge_domain_del(self, bd_id):
3593 """ GBP bridge-domain Del """
3594 return self.api(self.papi.gbp_bridge_domain_del,
3597 def gbp_bridge_domain_dump(self):
3598 """ GBP Bridge Domain Dump """
3599 return self.api(self.papi.gbp_bridge_domain_dump, {})
3601 def gbp_route_domain_add(self, rd_id,
3605 ip6_uu_sw_if_index):
3606 """ GBP route-domain Add """
3607 return self.api(self.papi.gbp_route_domain_add,
3610 'ip4_table_id': ip4_table_id,
3611 'ip6_table_id': ip6_table_id,
3612 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
3613 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
3617 def gbp_route_domain_del(self, rd_id):
3618 """ GBP route-domain Del """
3619 return self.api(self.papi.gbp_route_domain_del,
3622 def gbp_route_domain_dump(self):
3623 """ GBP Route Domain Dump """
3624 return self.api(self.papi.gbp_route_domain_dump, {})
3626 def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3627 """ GBP recirc Add/Del """
3628 return self.api(self.papi.gbp_recirc_add_del,
3632 'sw_if_index': sw_if_index,
3635 def gbp_recirc_dump(self):
3636 """ GBP recirc Dump """
3637 return self.api(self.papi.gbp_recirc_dump, {})
3639 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
3640 """ GBP recirc Add/Del """
3641 return self.api(self.papi.gbp_ext_itf_add_del,
3644 'sw_if_index': sw_if_index,
3648 def gbp_ext_itf_dump(self):
3649 """ GBP recirc Dump """
3650 return self.api(self.papi.gbp_ext_itf_dump, {})
3652 def gbp_subnet_add_del(self, is_add, rd_id,
3654 sw_if_index=0xffffffff,
3656 """ GBP Subnet Add/Del """
3657 return self.api(self.papi.gbp_subnet_add_del,
3661 'sw_if_index': sw_if_index,
3666 def gbp_subnet_dump(self):
3667 """ GBP Subnet Dump """
3668 return self.api(self.papi.gbp_subnet_dump, {})
3670 def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index, rules):
3671 """ GBP contract Add/Del """
3672 return self.api(self.papi.gbp_contract_add_del,
3675 'acl_index': acl_index,
3678 'n_rules': len(rules),
3681 def gbp_contract_dump(self):
3682 """ GBP contract Dump """
3683 return self.api(self.papi.gbp_contract_dump, {})
3685 def gbp_endpoint_learn_set_inactive_threshold(self, threshold):
3686 """ GBP set inactive threshold """
3687 return self.api(self.papi.gbp_endpoint_learn_set_inactive_threshold,
3688 {'threshold': threshold})
3690 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode):
3691 """ GBP VXLAN tunnel add """
3692 return self.api(self.papi.gbp_vxlan_tunnel_add,
3697 'bd_rd_id': bd_rd_id
3701 def gbp_vxlan_tunnel_del(self, vni):
3702 """ GBP VXLAN tunnel del """
3703 return self.api(self.papi.gbp_vxlan_tunnel_del,
3708 def gbp_vxlan_tunnel_dump(self):
3709 """ GBP VXLAN tunnel add/del """
3710 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
3712 def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3713 ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3715 """ 6RD tunnel Add """
3716 return self.api(self.papi.ipip_6rd_add_tunnel,
3717 {'ip4_table_id': ip4_table_id,
3718 'ip6_table_id': ip6_table_id,
3719 'ip6_prefix': ip6_prefix,
3720 'ip6_prefix_len': ip6_prefix_len,
3721 'ip4_prefix': ip4_prefix,
3722 'ip4_prefix_len': ip4_prefix_len,
3724 'security_check': security_check})
3726 def ipip_6rd_del_tunnel(self, sw_if_index):
3727 """ 6RD tunnel Delete """
3728 return self.api(self.papi.ipip_6rd_del_tunnel,
3729 {'sw_if_index': sw_if_index})
3731 def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3732 instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3733 """ IPIP tunnel Add/Del """
3734 return self.api(self.papi.ipip_add_tunnel,
3735 {'is_ipv6': is_ipv6,
3736 'instance': instance,
3737 'src_address': src_address,
3738 'dst_address': dst_address,
3739 'table_id': table_id,
3742 def ipip_del_tunnel(self, sw_if_index):
3743 """ IPIP tunnel Delete """
3744 return self.api(self.papi.ipip_del_tunnel,
3745 {'sw_if_index': sw_if_index})
3747 def qos_egress_map_update(self, id, outputs):
3748 """ QOS egress map update """
3749 return self.api(self.papi.qos_egress_map_update,
3753 def qos_egress_map_delete(self, id):
3754 """ QOS egress map delete """
3755 return self.api(self.papi.qos_egress_map_delete,
3758 def qos_mark_enable_disable(self, sw_if_index,
3762 """ QOS Mark Enable/Disable """
3763 return self.api(self.papi.qos_mark_enable_disable,
3765 'sw_if_index': sw_if_index,
3766 'output_source': output_source,
3769 def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3770 """ IP QoS recording Enble/Disable """
3771 return self.api(self.papi.qos_record_enable_disable,
3772 {'sw_if_index': sw_if_index,
3773 'input_source': input_source,
3776 def igmp_enable_disable(self, sw_if_index, enable, host):
3777 """ Enable/disable IGMP on a given interface """
3778 return self.api(self.papi.igmp_enable_disable,
3781 'sw_if_index': sw_if_index})
3783 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
3784 """ Add/del IGMP proxy device """
3785 return self.api(self.papi.igmp_proxy_device_add_del,
3786 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3789 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
3790 """ Add/del interface to/from IGMP proxy device """
3791 return self.api(self.papi.igmp_proxy_device_add_del_interface,
3792 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3795 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3796 """ Listen for new (S,G) on specified interface
3798 :param enable: add/del
3799 :param sw_if_index: interface sw index
3800 :param saddr: source ip4 addr
3801 :param gaddr: group ip4 addr
3803 return self.api(self.papi.igmp_listen,
3808 'sw_if_index': sw_if_index,
3809 'n_srcs': len(saddrs),
3815 def igmp_dump(self, sw_if_index=None):
3816 """ Dump all (S,G) interface configurations """
3817 if sw_if_index is None:
3818 sw_if_index = 0xffffffff
3819 return self.api(self.papi.igmp_dump,
3820 {'sw_if_index': sw_if_index})
3822 def igmp_clear_interface(self, sw_if_index):
3823 """ Remove all (S,G)s from specified interface
3824 doesn't send IGMP report!
3827 self.papi.igmp_clear_interface, {
3828 'sw_if_index': sw_if_index})
3830 def want_igmp_events(self, enable=1):
3831 return self.api(self.papi.want_igmp_events, {'enable': enable,
3832 'pid': os.getpid()})
3842 :param lb: load balance
3843 :param use_custom_mac: use custom mac
3844 :param mac_address: mac address
3847 self.papi.bond_create,
3850 'use_custom_mac': use_custom_mac,
3851 'mac_address': mac_address
3858 :param sw_if_index: interface the operation is applied to
3860 return self.api(self.papi.bond_delete,
3861 {'sw_if_index': sw_if_index})
3870 :param sw_if_index: slave sw_if_index
3871 :param bond_sw_if_index: bond sw_if_index
3872 :param is_passive: is passive lacp speaker
3873 :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3876 self.papi.bond_enslave,
3877 {'sw_if_index': sw_if_index,
3878 'bond_sw_if_index': bond_sw_if_index,
3879 'is_passive': is_passive,
3880 'is_long_timeout': is_long_timeout
3883 def bond_detach_slave(
3887 :param sw_if_index: slave interface the operation is applied to
3889 return self.api(self.papi.bond_detach_slave,
3890 {'sw_if_index': sw_if_index})
3892 def sw_interface_slave_dump(
3896 :param sw_if_index: bond sw_if_index
3898 return self.api(self.papi.sw_interface_slave_dump,
3899 {'sw_if_index': sw_if_index})
3901 def sw_interface_bond_dump(
3906 return self.api(self.papi.sw_interface_bond_dump,
3909 def create_vhost_user_if(
3915 disable_indirect_desc,
3916 custom_dev_instance,
3921 :param is_server: is server
3922 :param sock_filename: socket name
3923 :param renumber: renumber
3924 :param disable_mrg_rxbuf: disable mergable rx buffers
3925 :param disable_indirect_desc: disable indirect descriptors
3926 :param custom_dev_instance: custom dev instance
3927 :param use_custom_mac: use custom mac
3928 :param mac_address: mac address
3929 :param tag: tag (default '')
3932 self.papi.create_vhost_user_if,
3933 {'is_server': is_server,
3934 'sock_filename': sock_filename,
3935 'renumber': renumber,
3936 'disable_mrg_rxbuf': disable_mrg_rxbuf,
3937 'disable_indirect_desc': disable_indirect_desc,
3938 'custom_dev_instance': custom_dev_instance,
3939 'use_custom_mac': use_custom_mac,
3940 'mac_address': mac_address,
3944 def delete_vhost_user_if(
3948 :param sw_if_index: interface the operation is applied to
3950 return self.api(self.papi.delete_vhost_user_if,
3951 {'sw_if_index': sw_if_index, })
3953 def sw_interface_vhost_user_dump(
3958 return self.api(self.papi.sw_interface_vhost_user_dump,
3961 def abf_policy_add_del(self, is_add, policy):
3963 self.papi.abf_policy_add_del,
3967 def abf_itf_attach_add_del(self, is_add, attach):
3969 self.papi.abf_itf_attach_add_del,
3973 def abf_policy_dump(self):
3975 self.papi.abf_policy_dump, {})
3977 def abf_itf_attach_dump(self):
3979 self.papi.abf_itf_attach_dump, {})
3981 def pipe_create(self, is_specified, user_instance):
3982 return self.api(self.papi.pipe_create,
3983 {'is_specified': is_specified,
3984 'user_instance': user_instance})
3986 def pipe_delete(self, parent_sw_if_index):
3987 return self.api(self.papi.pipe_delete,
3988 {'parent_sw_if_index': parent_sw_if_index})
3990 def pipe_dump(self):
3991 return self.api(self.papi.pipe_dump, {})
4005 return self.api(self.papi.memif_create,
4008 'rx_queues': rx_queues,
4009 'tx_queues': tx_queues,
4011 'socket_id': socket_id,
4013 'ring_size': ring_size,
4014 'buffer_size': buffer_size,
4015 'hw_addr': hw_addr})
4017 def memif_delete(self, sw_if_index):
4018 return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index})
4020 def memif_dump(self):
4021 return self.api(self.papi.memif_dump, {})
4023 def memif_socket_filename_add_del(
4024 self, is_add, socket_id, socket_filename):
4026 self.papi.memif_socket_filename_add_del,
4028 'socket_id': socket_id,
4029 'socket_filename': socket_filename})
4031 def memif_socket_filename_dump(self):
4032 return self.api(self.papi.memif_socket_filename_dump, {})
4034 def svs_table_add_del(self, af, table_id, is_add=1):
4035 return self.api(self.papi.svs_table_add_del,
4037 'table_id': table_id,
4042 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
4043 return self.api(self.papi.svs_route_add_del,
4045 'table_id': table_id,
4046 'source_table_id': src_table_id,
4051 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
4052 return self.api(self.papi.svs_enable_disable,
4055 'table_id': table_id,
4056 'sw_if_index': sw_if_index,
4057 'is_enable': is_enable,
4061 return self.api(self.papi.svs_dump, {})
4063 def syslog_set_sender(
4070 """Set syslog sender configuration
4072 :param collector: colector IP address
4073 :param src: source IP address
4074 :param collector_port: collector UDP port (Default value = 514)
4075 :param vrf_id: VRF id (Default value = 0)
4076 :param max_msg_size: maximum message length (Default value = 480)
4078 return self.api(self.papi.syslog_set_sender,
4079 {'collector_address': collector,
4081 'collector_port': collector_port,
4083 'max_msg_size': max_msg_size})
4085 def syslog_get_sender(self):
4086 """Return syslog sender configuration"""
4087 return self.api(self.papi.syslog_get_sender, {})
4089 def syslog_set_filter(self, severity):
4090 """Set syslog filter parameters
4092 :param severity: severity filter (specified severity and greater match)
4094 return self.api(self.papi.syslog_set_filter, {'severity': severity})
4096 def syslog_get_filter(self):
4097 """Return syslog filter parameters"""
4098 return self.api(self.papi.syslog_get_filter, {})