X-Git-Url: https://gerrit.fd.io/r/gitweb?p=vpp.git;a=blobdiff_plain;f=test%2Fvpp_papi_provider.py;h=ed2eee1dc84e275d1e119860373ce8418277e1d7;hp=7869afa32cc535b303d79d9b067c9d97d94ad49d;hb=8feeaff56;hpb=dd3b8f7ab9f120b92c5fdf26016db47bbe18cb39 diff --git a/test/vpp_papi_provider.py b/test/vpp_papi_provider.py index 7869afa32cc..ed2eee1dc84 100644 --- a/test/vpp_papi_provider.py +++ b/test/vpp_papi_provider.py @@ -1,27 +1,19 @@ +# NB NB NB NB NB NB NB NB NB NB NB +# +# NOTE: The API binary wrappers in this file are in the process of being +# deprecated. DO NOT ADD NEW WRAPPERS HERE. Call the functions using +# named arguments directly instead. +# + import os -import fnmatch import time -from hook import Hook from collections import deque -# Sphinx creates auto-generated documentation by importing the python source -# files and collecting the docstrings from them. The NO_VPP_PAPI flag allows -# the vpp_papi_provider.py file to be importable without having to build -# the whole vpp api if the user only wishes to generate the test documentation. -do_import = True -try: - no_vpp_papi = os.getenv("NO_VPP_PAPI") - if no_vpp_papi == "1": - do_import = False -except: - pass - -if do_import: - from vpp_papi import VPP - -# from vnet/vnet/mpls/mpls_types.h -MPLS_IETF_MAX_LABEL = 0xfffff -MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1 +from six import moves, iteritems +from vpp_papi import VPP, mac_pton +from hook import Hook +from vpp_l2 import L2_PORT_TYPE +from vpp_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID class L2_VTR_OP: @@ -43,6 +35,182 @@ class QOS_SOURCE: IP = 3 +class SYSLOG_SEVERITY: + EMERG = 0 + ALERT = 1 + CRIT = 2 + ERR = 3 + WARN = 4 + NOTICE = 5 + INFO = 6 + DBG = 7 + + +# +# Dictionary keyed on message name to override default values for +# named parameters +# +defaultmapping = { + 'map_add_domain': {'mtu': 1280}, + 'syslog_set_sender': {'collector_port': 514, + 'max_msg_size': 480}, + 'acl_interface_add_del': {'is_add': 1, 'is_input': 1}, + 'acl_interface_list_dump': {'sw_if_index': 4294967295, }, + 'app_namespace_add_del': {'sw_if_index': 4294967295, }, + 'bd_ip_mac_add_del': {'is_add': 1, }, + 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1, + 'is_add': 1, }, + 'bier_disp_table_add_del': {'is_add': 1, }, + 'bier_imp_add': {'is_add': 1, }, + 'bier_route_add_del': {'is_add': 1, }, + 'bier_table_add_del': {'is_add': 1, }, + 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1, + 'learn': 1, 'is_add': 1, }, + 'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295, + 'nbuckets': 2, 'memory_size': 2097152, + 'next_table_index': 4294967295, + 'miss_next_index': 4294967295, }, + 'dhcp6_client_enable_disable': {'enable': 1, }, + 'dhcp6_clients_enable_disable': {'enable': 1, }, + 'dhcp6_pd_client_enable_disable': {'enable': 1, }, + 'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, }, + 'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, }, + 'dhcp_proxy_config': {'is_add': 1, }, + 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, }, + 'dslite_add_del_pool_addr_range': {'is_add': 1, }, + 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, }, + 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1, + 'decap_next_index': 4294967295, }, + 'gre_add_del_tunnel': {'instance': 4294967295, 'is_add': 1, }, + 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295, + 'decap_next_index': 4294967295, }, + 'input_acl_set_interface': {'ip4_table_index': 4294967295, + 'ip6_table_index': 4294967295, + 'l2_table_index': 4294967295, }, + 'ip6_add_del_address_using_prefix': {'is_add': 1, }, + 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, }, + 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295, + 'next_hop_weight': 1, 'next_hop_via_label': 1048576, + 'next_hop_id': 4294967295, + 'classify_table_index': 4294967295, 'is_add': 1, }, + 'ip_mroute_add_del': {'is_add': 1, }, + 'ip_neighbor_add_del': {'is_add': 1, }, + 'ip_punt_police': {'is_add': 1, }, + 'ip_punt_redirect': {'is_add': 1, }, + 'ip_table_add_del': {'is_add': 1, }, + 'ip_unnumbered_dump': {'sw_if_index': 4294967295, }, + 'ipip_add_tunnel': {'is_ipv6': 1, 'instance': 4294967295, }, + 'ipsec_interface_add_del_spd': {'is_add': 1, }, + 'ipsec_sad_entry_add_del': {'is_add': 1, }, + 'ipsec_spd_add_del': {'is_add': 1, }, + 'ipsec_spd_dump': {'sa_id': 4294967295, }, + 'ipsec_spd_entry_add_del': {'local_port_stop': 65535, + 'remote_port_stop': 65535, 'priority': 100, + 'is_outbound': 1, + 'is_add': 1, }, + 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, }, + 'l2_emulation': {'enable': 1, }, + 'l2fib_add_del': {'is_add': 1, }, + 'lb_conf': {'sticky_buckets_per_core': 4294967295, + 'flow_timeout': 4294967295}, + 'lisp_add_del_adjacency': {'is_add': 1, }, + 'lisp_add_del_local_eid': {'is_add': 1, }, + 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, }, + 'lisp_add_del_locator_set': {'is_add': 1, }, + 'lisp_add_del_remote_mapping': {'is_add': 1, }, + 'macip_acl_add_replace': {'acl_index': 4294967295, }, + 'macip_acl_dump': {'acl_index': 4294967295, }, + 'macip_acl_interface_add_del': {'is_add': 1, }, + 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, }, + 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295, + 'mr_next_hop_weight': 1, + 'mr_next_hop_via_label': 1048576, + 'mr_is_add': 1, + 'mr_classify_table_index': 4294967295, }, + 'mpls_table_add_del': {'is_add': 1, }, + 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295, + 'next_hop_weight': 1, + 'next_hop_via_label': 1048576, + 'is_add': 1, }, + 'mpls_tunnel_dump': {'sw_if_index': 4294967295, }, + 'nat44_add_del_address_range': {'is_add': 1, 'vrf_id': 4294967295, }, + 'nat44_add_del_identity_mapping': {'ip': b'0', 'sw_if_index': 4294967295, + 'addr_only': 1, 'is_add': 1, }, + 'nat44_add_del_interface_addr': {'is_add': 1, }, + 'nat44_add_del_lb_static_mapping': {'is_add': 1, }, + 'nat44_add_del_static_mapping': {'external_sw_if_index': 4294967295, + 'addr_only': 1, 'is_add': 1, }, + 'nat44_del_session': {'is_in': 1, }, + 'nat44_interface_add_del_feature': {'is_inside': 1, 'is_add': 1, }, + 'nat44_interface_add_del_output_feature': {'is_inside': 1, 'is_add': 1, }, + 'nat44_lb_static_mapping_add_del_local': {'is_add': 1, }, + 'nat64_add_del_interface': {'is_inside': 1, 'is_add': 1, }, + 'nat64_add_del_interface_addr': {'is_add': 1, }, + 'nat64_add_del_pool_addr_range': {'vrf_id': 4294967295, 'is_add': 1, }, + 'nat64_add_del_prefix': {'is_add': 1, }, + 'nat64_add_del_static_bib': {'is_add': 1, }, + 'nat64_bib_dump': {'protocol': 255, }, + 'nat64_st_dump': {'protocol': 255, }, + 'nat66_add_del_interface': {'is_inside': 1, 'is_add': 1, }, + 'nat66_add_del_static_mapping': {'is_add': 1, }, + 'nat_det_add_del_map': {'is_add': 1, }, + 'nat_ha_resync': {'want_resync_event': 1, }, + 'nat_ha_set_failover': {'refresh': 10, }, + 'nat_ha_set_listener': {'path_mtu': 512, }, + 'nat_ipfix_enable_disable': {'domain_id': 1, 'src_port': 4739, + 'enable': 1, }, + 'nat_set_mss_clamping': {'mss_value': 1500, }, + 'nat_set_reass': {'timeout': 2, 'max_reass': 1024, 'max_frag': 5, }, + 'nat_set_timeouts': {'udp': 300, 'tcp_established': 7440, + 'tcp_transitory': 240, 'icmp': 60, }, + 'output_acl_set_interface': {'ip4_table_index': 4294967295, + 'ip6_table_index': 4294967295, + 'l2_table_index': 4294967295, }, + 'pppoe_add_del_session': {'is_add': 1, }, + 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, }, + 'proxy_arp_add_del': {'is_add': 1, }, + 'proxy_arp_intfc_enable_disable': {'is_enable': 1, }, + 'punt_socket_register': {'protocol': 17, 'header_version': 1, + 'is_ip4': 1, }, + 'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, }, + 'punt_socket_dump': {'is_ip6': 1, }, + 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1, + 'proto': 1, }, + 'set_ipfix_exporter': {'collector_port': 4739, }, + 'sr_localsid_add_del': {'sw_if_index': 4294967295, }, + 'sr_policy_add': {'weight': 1, 'is_encap': 1, }, + 'svs_enable_disable': {'is_enable': 1, }, + 'svs_route_add_del': {'is_add': 1, }, + 'svs_table_add_del': {'is_add': 1, }, + 'sw_interface_add_del_address': {'is_add': 1, }, + 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295, + 'pref_lifetime': 4294967295, }, + 'sw_interface_set_ip_directed_broadcast': {'enable': 1, }, + 'sw_interface_set_l2_bridge': {'enable': 1, }, + 'sw_interface_set_mpls_enable': {'enable': 1, }, + 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], }, + 'sw_interface_set_unnumbered': {'is_add': 1, }, + 'sw_interface_span_enable_disable': {'state': 1, }, + 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1, + 'decap_next_index': 4294967295, + 'instance': 4294967295, }, + 'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1, + 'instance': 4294967295, }, + 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, }, + 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1, + 'protocol': 3, }, + 'want_bfd_events': {'enable_disable': 1, }, + 'want_dhcp6_pd_reply_events': {'enable_disable': 1, }, + 'want_dhcp6_reply_events': {'enable_disable': 1, }, + 'want_igmp_events': {'enable': 1, }, + 'want_interface_events': {'enable_disable': 1, }, + 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', }, + 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', }, + 'want_ip6_ra_events': {'enable_disable': 1, }, + 'want_l2_macs_events': {'enable_disable': 1, }, +} + + class UnexpectedApiReturnValueError(Exception): """ exception raised when the API return value is unexpected """ pass @@ -56,34 +224,44 @@ class VppPapiProvider(object): _zero, _negative = range(2) - def __init__(self, name, shm_prefix, test_class): - self.hook = Hook("vpp-papi-provider") + def __init__(self, name, shm_prefix, test_class, read_timeout): + self.hook = Hook(test_class) self.name = name self.shm_prefix = shm_prefix self.test_class = test_class self._expect_api_retval = self._zero self._expect_stack = [] - jsonfiles = [] - install_dir = os.getenv('VPP_TEST_INSTALL_PATH') - for root, dirnames, filenames in os.walk(install_dir): - for filename in fnmatch.filter(filenames, '*.api.json'): - jsonfiles.append(os.path.join(root, filename)) + install_dir = os.getenv('VPP_INSTALL_PATH') + + # Vapi requires 'VPP_API_DIR', not set when run from Makefile. + if 'VPP_API_DIR' not in os.environ: + os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH') - self.vpp = VPP(jsonfiles, logger=test_class.logger) + self.vpp = VPP(logger=test_class.logger, + read_timeout=read_timeout) self._events = deque() def __enter__(self): return self - def expect_negative_api_retval(self): - """ Expect API failure """ + def assert_negative_api_retval(self): + """ Expect API failure - used with with, e.g.: + with self.vapi.assert_negative_api_retval(): + self.vapi. + """ self._expect_stack.append(self._expect_api_retval) self._expect_api_retval = self._negative return self - def expect_zero_api_retval(self): - """ Expect API success """ + def assert_zero_api_retval(self): + """ Expect API success - used with with, e.g.: + with self.vapi.assert_negative_api_retval(): + self.vapi. + + note: this is useful only inside another with block + as success is the default expected value + """ self._expect_stack.append(self._expect_api_retval) self._expect_api_retval = self._zero return self @@ -126,7 +304,7 @@ class VppPapiProvider(object): self.test_class.logger.debug("Returning event %s:%s" % (name, e)) return e - time.sleep(0) # yield + self.test_class.sleep(0) # yield raise Exception("Event did not occur within timeout") def __call__(self, name, event): @@ -136,6 +314,38 @@ class VppPapiProvider(object): self.test_class.logger.debug("New event: %s: %s" % (name, event)) self._events.append(event) + def factory(self, name, apifn): + def f(*a, **ka): + fields = apifn._func.msg.fields + + # add positional and kw arguments + d = ka + for i, o in enumerate(fields[3:]): + try: + d[o] = a[i] + except: + break + + # Default override + if name in defaultmapping: + for k, v in iteritems(defaultmapping[name]): + if k in d: + continue + d[k] = v + return self.api(apifn, d) + + return f + + def __getattribute__(self, name): + try: + method = super(VppPapiProvider, self).__getattribute__(name) + except AttributeError: + method = self.factory(name, getattr(self.papi, name)) + # lazily load the method so we don't need to call factory + # again for this name. + setattr(self, name, method) + return method + def connect(self): """Connect the API to VPP""" self.vpp.connect(self.name, self.shm_prefix) @@ -160,16 +370,16 @@ class VppPapiProvider(object): reply = api_fn(**api_args) if self._expect_api_retval == self._negative: if hasattr(reply, 'retval') and reply.retval >= 0: - msg = "API call passed unexpectedly: expected negative "\ - "return value instead of %d in %s" % \ - (reply.retval, repr(reply)) + msg = "API call passed unexpectedly: expected negative " \ + "return value instead of %d in %s" % \ + (reply.retval, moves.reprlib.repr(reply)) self.test_class.logger.info(msg) raise UnexpectedApiReturnValueError(msg) elif self._expect_api_retval == self._zero: if hasattr(reply, 'retval') and reply.retval != expected_retval: - msg = "API call failed, expected %d return value instead "\ - "of %d in %s" % (expected_retval, reply.retval, - repr(reply)) + msg = "API call failed, expected %d return value instead " \ + "of %d in %s" % (expected_retval, reply.retval, + moves.reprlib.repr(reply)) self.test_class.logger.info(msg) raise UnexpectedApiReturnValueError(msg) else: @@ -188,10 +398,10 @@ class VppPapiProvider(object): """ self.hook.before_cli(cli) cli += '\n' - r = self.papi.cli_inband(length=len(cli), cmd=cli) + r = self.papi.cli_inband(cmd=cli) self.hook.after_cli(cli) if hasattr(r, 'reply'): - return r.reply.decode().rstrip('\x00') + return r.reply def ppcli(self, cli): """ Helper method to print CLI command in case of info logging level. @@ -201,276 +411,16 @@ class VppPapiProvider(object): """ return cli + "\n" + str(self.cli(cli)) - def _convert_mac(self, mac): - return mac.replace(':', '').decode('hex') - - def show_version(self): - """ """ - return self.api(self.papi.show_version, {}) - - def pg_create_interface(self, pg_index): - """ - - :param pg_index: - - """ - return self.api(self.papi.pg_create_interface, - {"interface_id": pg_index}) - - def sw_interface_dump(self, filter=None): - """ - - :param filter: (Default value = None) - - """ - if filter is not None: - args = {"name_filter_valid": 1, "name_filter": filter} - else: - args = {} - return self.api(self.papi.sw_interface_dump, args) - - def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id): - """ Set the IPvX Table-id for the Interface - - :param sw_if_index: - :param is_ipv6: - :param table_id: - - """ - return self.api(self.papi.sw_interface_set_table, - {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6, - 'vrf_id': table_id}) - - def sw_interface_add_del_address(self, sw_if_index, addr, addr_len, - is_ipv6=0, is_add=1, del_all=0): - """ - - :param addr: param is_ipv6: (Default value = 0) - :param sw_if_index: - :param addr_len: - :param is_ipv6: (Default value = 0) - :param is_add: (Default value = 1) - :param del_all: (Default value = 0) - - """ - return self.api(self.papi.sw_interface_add_del_address, - {'sw_if_index': sw_if_index, - 'is_add': is_add, - 'is_ipv6': is_ipv6, - 'del_all': del_all, - 'address_length': addr_len, - 'address': addr}) - - def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index, - is_add=1): - """ Set the Interface to be unnumbered - - :param is_add: (Default value = 1) - :param sw_if_index - interface That will be unnumbered - :param ip_sw_if_index - interface with an IP addres - - """ - return self.api(self.papi.sw_interface_set_unnumbered, - {'sw_if_index': ip_sw_if_index, - 'unnumbered_sw_if_index': sw_if_index, - 'is_add': is_add}) - - def sw_interface_enable_disable_mpls(self, sw_if_index, - is_enable=1): - """ - Enable/Disable MPLS on the interface - :param sw_if_index: - :param is_enable: (Default value = 1) - - """ - return self.api(self.papi.sw_interface_set_mpls_enable, - {'sw_if_index': sw_if_index, - 'enable': is_enable}) - - def sw_interface_ra_suppress(self, sw_if_index, suppress=1): - return self.api(self.papi.sw_interface_ip6nd_ra_config, - {'sw_if_index': sw_if_index, - 'suppress': suppress}) - - def set_ip_flow_hash(self, - table_id, - src=1, - dst=1, - sport=1, - dport=1, - proto=1, - reverse=0, - is_ip6=0): - return self.api(self.papi.set_ip_flow_hash, - {'vrf_id': table_id, - 'src': src, - 'dst': dst, - 'dport': dport, - 'sport': sport, - 'proto': proto, - 'reverse': reverse, - 'is_ipv6': is_ip6}) - - def ip6_nd_proxy(self, address, sw_if_index, is_del=0): - return self.api(self.papi.ip6nd_proxy_add_del, - {'address': address, - 'sw_if_index': sw_if_index, - 'is_del': is_del}) - - def ip6_sw_interface_ra_config(self, sw_if_index, - no, - suppress, - send_unicast): - return self.api(self.papi.sw_interface_ip6nd_ra_config, - {'sw_if_index': sw_if_index, - 'is_no': no, - 'suppress': suppress, - 'send_unicast': send_unicast}) - - def ip6_sw_interface_ra_prefix(self, - sw_if_index, - address, - address_length, - use_default=0, - no_advertise=0, - off_link=0, - no_autoconfig=0, - no_onlink=0, - is_no=0, - val_lifetime=0xffffffff, - pref_lifetime=0xffffffff): - return self.api(self.papi.sw_interface_ip6nd_ra_prefix, - {'sw_if_index': sw_if_index, - 'address': address, - 'address_length': address_length, - 'use_default': use_default, - 'no_advertise': no_advertise, - 'off_link': off_link, - 'no_autoconfig': no_autoconfig, - 'no_onlink': no_onlink, - 'is_no': is_no, - 'val_lifetime': val_lifetime, - 'pref_lifetime': pref_lifetime}) - - def ip6_sw_interface_enable_disable(self, sw_if_index, enable): - """ - Enable/Disable An interface for IPv6 - """ - return self.api(self.papi.sw_interface_ip6_enable_disable, - {'sw_if_index': sw_if_index, - 'enable': enable}) - - def vxlan_add_del_tunnel( - self, - src_addr, - dst_addr, - mcast_sw_if_index=0xFFFFFFFF, - is_add=1, - is_ipv6=0, - encap_vrf_id=0, - decap_next_index=0xFFFFFFFF, - vni=0, - instance=0xFFFFFFFF): - """ - - :param dst_addr: - :param src_addr: - :param is_add: (Default value = 1) - :param is_ipv6: (Default value = 0) - :param encap_vrf_id: (Default value = 0) - :param decap_next_index: (Default value = 0xFFFFFFFF) - :param mcast_sw_if_index: (Default value = 0xFFFFFFFF) - :param vni: (Default value = 0) - :param instance: (Default value = 0xFFFFFFFF) - - """ - return self.api(self.papi.vxlan_add_del_tunnel, - {'is_add': is_add, - 'is_ipv6': is_ipv6, - 'src_address': src_addr, - 'dst_address': dst_addr, - 'mcast_sw_if_index': mcast_sw_if_index, - 'encap_vrf_id': encap_vrf_id, - 'decap_next_index': decap_next_index, - 'vni': vni, - 'instance': instance}) - - def geneve_add_del_tunnel( - self, - local_addr, - remote_addr, - mcast_sw_if_index=0xFFFFFFFF, - is_add=1, - is_ipv6=0, - encap_vrf_id=0, - decap_next_index=0xFFFFFFFF, - vni=0): - """ - - :param remote_addr: - :param local_addr: - :param is_add: (Default value = 1) - :param is_ipv6: (Default value = 0) - :param encap_vrf_id: (Default value = 0) - :param decap_next_index: (Default value = 0xFFFFFFFF) - :param mcast_sw_if_index: (Default value = 0xFFFFFFFF) - :param vni: (Default value = 0) - - """ - return self.api(self.papi.geneve_add_del_tunnel, - {'is_add': is_add, - 'is_ipv6': is_ipv6, - 'local_address': local_addr, - 'remote_address': remote_addr, - 'mcast_sw_if_index': mcast_sw_if_index, - 'encap_vrf_id': encap_vrf_id, - 'decap_next_index': decap_next_index, - 'vni': vni}) - - def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1, - learn=1, arp_term=0, is_add=1): - """Create/delete bridge domain. - - :param int bd_id: Bridge domain index. - :param int flood: Enable/disable bcast/mcast flooding in the BD. - (Default value = 1) - :param int uu_flood: Enable/disable unknown unicast flood in the BD. - (Default value = 1) - :param int forward: Enable/disable forwarding on all interfaces in - the BD. (Default value = 1) - :param int learn: Enable/disable learning on all interfaces in the BD. - (Default value = 1) - :param int arp_term: Enable/disable arp termination in the BD. - (Default value = 1) - :param int is_add: Add or delete flag. (Default value = 1) - """ - return self.api(self.papi.bridge_domain_add_del, - {'bd_id': bd_id, - 'flood': flood, - 'uu_flood': uu_flood, - 'forward': forward, - 'learn': learn, - 'arp_term': arp_term, - 'is_add': is_add}) - - def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1): - return self.api(self.papi.bd_ip_mac_add_del, - {'bd_id': bd_id, - 'is_add': is_add, - 'is_ipv6': is_ipv6, - 'ip_address': ip, - 'mac_address': mac}) - - def want_ip4_arp_events(self, enable_disable=1, address=0): + def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"): return self.api(self.papi.want_ip4_arp_events, {'enable_disable': enable_disable, - 'address': address, + 'ip': ip, 'pid': os.getpid(), }) - def want_ip6_nd_events(self, enable_disable=1, address=0): + def want_ip6_nd_events(self, enable_disable=1, ip="::"): return self.api(self.papi.want_ip6_nd_events, {'enable_disable': enable_disable, - 'address': address, + 'ip': ip, 'pid': os.getpid(), }) def want_ip6_ra_events(self, enable_disable=1): @@ -487,15 +437,13 @@ class VppPapiProvider(object): 'mrd': mrd, 'sw_if_index': sw_if_index}) - def ip6_nd_address_autoconfig(self, sw_if_index, enable, - install_default_routes): - return self.api(self.papi.ip6_nd_address_autoconfig, - {'sw_if_index': sw_if_index, - 'enable': enable, - 'install_default_routes': install_default_routes}) + def want_interface_events(self, enable_disable=1): + return self.api(self.papi.want_interface_events, + {'enable_disable': enable_disable, + 'pid': os.getpid(), }) - def want_macs_learn_events(self, enable_disable=1, scan_delay=0, - max_macs_in_event=0, learn_limit=0): + def want_l2_macs_events(self, enable_disable=1, scan_delay=0, + max_macs_in_event=0, learn_limit=0): return self.api(self.papi.want_l2_macs_events, {'enable_disable': enable_disable, 'scan_delay': scan_delay, @@ -513,28 +461,6 @@ class VppPapiProvider(object): {'enable_disable': enable_disable, 'pid': os.getpid()}) - def dhcp6_clients_enable_disable(self, enable=1): - return self.api(self.papi.dhcp6_clients_enable_disable, - {'enable': enable}) - - def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2, - addresses, server_index=0xFFFFFFFF, - irt=0, mrt=0, mrc=1, mrd=0, stop=0, - ): - return self.api(self.papi.dhcp6_send_client_message, - {'sw_if_index': sw_if_index, - 'server_index': server_index, - 'irt': irt, - 'mrt': mrt, - 'mrc': mrc, - 'mrd': mrd, - 'stop': stop, - 'msg_type': msg_type, - 'T1': T1, - 'T2': T2, - 'n_addresses': len(addresses), - 'addresses': addresses}) - def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2, prefixes, server_index=0xFFFFFFFF, irt=0, mrt=0, mrc=1, mrd=0, stop=0, @@ -576,222 +502,12 @@ class VppPapiProvider(object): 'prefix_length': prefix_length, 'is_add': is_add}) - def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0, - filter_mac=0, bvi_mac=0): - """Create/delete L2 FIB entry. - - :param str mac: MAC address to create FIB entry for. - :param int bd_id: Bridge domain index. - :param int sw_if_index: Software interface index of the interface. - :param int is_add: Add or delete flag. (Default value = 1) - :param int static_mac: Set to 1 to create static MAC entry. - (Default value = 0) - :param int filter_mac: Set to 1 to drop packet that's source or - destination MAC address contains defined MAC address. - (Default value = 0) - :param int bvi_mac: Set to 1 to create entry that points to BVI - interface. (Default value = 0) - """ - return self.api(self.papi.l2fib_add_del, - {'mac': self._convert_mac(mac), - 'bd_id': bd_id, - 'sw_if_index': sw_if_index, - 'is_add': is_add, - 'static_mac': static_mac, - 'filter_mac': filter_mac, - 'bvi_mac': bvi_mac}) - - def l2fib_flush_int(self, sw_if_index): - """Flush L2 FIB entries for sw_if_index. - - :param int sw_if_index: Software interface index of the interface. - """ - return self.api(self.papi.l2fib_flush_int, - {'sw_if_index': sw_if_index}) - - def l2fib_flush_bd(self, bd_id): - """Flush L2 FIB entries for bd_id. - - :param int sw_if_index: Bridge Domain id. - """ - return self.api(self.papi.l2fib_flush_bd, - {'bd_id': bd_id}) - - def l2fib_flush_all(self): - """Flush all L2 FIB. - """ - return self.api(self.papi.l2fib_flush_all, {}) - - def sw_interface_set_l2_bridge(self, sw_if_index, bd_id, - shg=0, bvi=0, enable=1): - """Add/remove interface to/from bridge domain. - - :param int sw_if_index: Software interface index of the interface. - :param int bd_id: Bridge domain index. - :param int shg: Split-horizon group index. (Default value = 0) - :param int bvi: Set interface as a bridge group virtual interface. - (Default value = 0) - :param int enable: Add or remove interface. (Default value = 1) - """ - return self.api(self.papi.sw_interface_set_l2_bridge, - {'rx_sw_if_index': sw_if_index, - 'bd_id': bd_id, - 'shg': shg, - 'bvi': bvi, - 'enable': enable}) - - def bridge_flags(self, bd_id, is_set, feature_bitmap): - """Enable/disable required feature of the bridge domain with defined - ID. - - :param int bd_id: Bridge domain ID. - :param int is_set: Set to 1 to enable, set to 0 to disable the feature. - :param int feature_bitmap: Bitmap value of the feature to be set: - - learn (1 << 0), - - forward (1 << 1), - - flood (1 << 2), - - uu-flood (1 << 3) or - - arp-term (1 << 4). - """ - return self.api(self.papi.bridge_flags, - {'bd_id': bd_id, - 'is_set': is_set, - 'feature_bitmap': feature_bitmap}) - - def bridge_domain_dump(self, bd_id=0): - """ - - :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all - existing bridge domains returned) - :return: Dictionary of bridge domain(s) data. - """ - return self.api(self.papi.bridge_domain_dump, - {'bd_id': bd_id}) - - def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index, - enable): - """Create or delete unidirectional cross-connect from Tx interface to - Rx interface. - - :param int rx_sw_if_index: Software interface index of Rx interface. - :param int tx_sw_if_index: Software interface index of Tx interface. - :param int enable: Create cross-connect if equal to 1, delete - cross-connect if equal to 0. - - """ - return self.api(self.papi.sw_interface_set_l2_xconnect, - {'rx_sw_if_index': rx_sw_if_index, - 'tx_sw_if_index': tx_sw_if_index, - 'enable': enable}) - - def sw_interface_set_l2_tag_rewrite( - self, - sw_if_index, - vtr_oper, - push=0, - tag1=0, - tag2=0): - """L2 interface vlan tag rewrite configure request - :param client_index - opaque cookie to identify the sender - :param context - sender context, to match reply w/ request - :param sw_if_index - interface the operation is applied to - :param vtr_op - Choose from l2_vtr_op_t enum values - :param push_dot1q - first pushed flag dot1q id set, else dot1ad - :param tag1 - Needed for any push or translate vtr op - :param tag2 - Needed for any push 2 or translate x-2 vtr ops - - """ - return self.api(self.papi.l2_interface_vlan_tag_rewrite, - {'sw_if_index': sw_if_index, - 'vtr_op': vtr_oper, - 'push_dot1q': push, - 'tag1': tag1, - 'tag2': tag2}) - - def sw_interface_set_l2_emulation( - self, - sw_if_index, - enable=1): - """L2 Emulation - :param sw_if_index - interface the operation is applied to - - """ - return self.api(self.papi.l2_emulation, - {'sw_if_index': sw_if_index, - 'enable': enable}) - - def sw_interface_set_flags(self, sw_if_index, admin_up_down): - """ - - :param admin_up_down: - :param sw_if_index: - - """ - return self.api(self.papi.sw_interface_set_flags, - {'sw_if_index': sw_if_index, - 'admin_up_down': admin_up_down}) - - def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]): - """ - :param sw_if_index: - :param mtu: - - """ - return self.api(self.papi.sw_interface_set_mtu, - {'sw_if_index': sw_if_index, - 'mtu': mtu}) - - def sw_interface_set_promiscuous(self, sw_if_index, enable): - """ - :param sw_if_index: - :param enable: - - """ - return self.api(self.papi.sw_interface_set_promiscuous, - {'sw_if_index': sw_if_index, - 'enable': enable}) - def sw_interface_set_mac_address(self, sw_if_index, mac): return self.api(self.papi.sw_interface_set_mac_address, {'sw_if_index': sw_if_index, 'mac_address': mac}) - def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan, - no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0, - default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0): - """Create subinterface - from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad - - :param sub_id: param inner_vlan: - :param sw_if_index: - :param outer_vlan: - :param inner_vlan: - :param no_tags: (Default value = 0) - :param one_tag: (Default value = 0) - :param two_tags: (Default value = 0) - :param dot1ad: (Default value = 0) - :param exact_match: (Default value = 0) - :param default_sub: (Default value = 0) - :param outer_vlan_id_any: (Default value = 0) - :param inner_vlan_id_any: (Default value = 0) - - """ - return self.api( - self.papi.create_subif, - {'sw_if_index': sw_if_index, - 'sub_id': sub_id, - 'no_tags': no_tags, - 'one_tag': one_tag, - 'two_tags': two_tags, - 'dot1ad': dot1ad, - 'exact_match': exact_match, - 'default_sub': default_sub, - 'outer_vlan_id_any': outer_vlan_id_any, - 'inner_vlan_id_any': inner_vlan_id_any, - 'outer_vlan_id': outer_vlan, - 'inner_vlan_id': inner_vlan}) - - def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id): + def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id): """Create p2p ethernet subinterface :param sw_if_index: main (parent) interface @@ -804,15 +520,7 @@ class VppPapiProvider(object): 'remote_mac': remote_mac, 'subif_id': subif_id}) - def delete_subif(self, sw_if_index): - """Delete subinterface - - :param sw_if_index: - """ - return self.api(self.papi.delete_subif, - {'sw_if_index': sw_if_index}) - - def delete_p2pethernet_subif(self, sw_if_index, remote_mac): + def p2p_ethernet_del(self, sw_if_index, remote_mac): """Delete p2p ethernet subinterface :param sw_if_index: main (parent) interface @@ -843,165 +551,37 @@ class VppPapiProvider(object): return self.api(self.papi.create_loopback, {'mac_address': mac}) - def delete_loopback(self, sw_if_index): - return self.api(self.papi.delete_loopback, - {'sw_if_index': sw_if_index, }) - - def ip_table_add_del(self, - table_id, - is_add=1, - is_ipv6=0): - """ - - :param table_id - :param is_add: (Default value = 1) - :param is_ipv6: (Default value = 0) - - """ - - return self.api( - self.papi.ip_table_add_del, - {'table_id': table_id, - 'is_add': is_add, - 'is_ipv6': is_ipv6}) - - def ip_add_del_route( - self, - dst_address, - dst_address_length, - next_hop_address, - next_hop_sw_if_index=0xFFFFFFFF, - table_id=0, - next_hop_table_id=0, - next_hop_weight=1, - next_hop_n_out_labels=0, - next_hop_out_label_stack=[], - next_hop_via_label=MPLS_LABEL_INVALID, - next_hop_id=0xFFFFFFFF, - is_resolve_host=0, - is_resolve_attached=0, - classify_table_index=0xFFFFFFFF, - is_add=1, - is_drop=0, - is_unreach=0, - is_prohibit=0, - is_ipv6=0, - is_local=0, - is_classify=0, - is_multipath=0, - is_dvr=0, - is_udp_encap=0, - is_source_lookup=0): - """ - - :param dst_address_length: - :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF) - :param dst_address: - :param next_hop_address: - :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF) - :param vrf_id: (Default value = 0) - :param lookup_in_vrf: (Default value = 0) - :param classify_table_index: (Default value = 0xFFFFFFFF) - :param is_add: (Default value = 1) - :param is_drop: (Default value = 0) - :param is_ipv6: (Default value = 0) - :param is_local: (Default value = 0) - :param is_classify: (Default value = 0) - :param is_multipath: (Default value = 0) - :param is_resolve_host: (Default value = 0) - :param is_resolve_attached: (Default value = 0) - :param is_dvr: (Default value = 0) - :param is_source_lookup: (Default value = 0) - :param next_hop_weight: (Default value = 1) - - """ - - return self.api( - self.papi.ip_add_del_route, - {'next_hop_sw_if_index': next_hop_sw_if_index, - 'table_id': table_id, - 'classify_table_index': classify_table_index, - 'next_hop_table_id': next_hop_table_id, - 'is_add': is_add, - 'is_drop': is_drop, - 'is_unreach': is_unreach, - 'is_prohibit': is_prohibit, - 'is_ipv6': is_ipv6, - 'is_local': is_local, - 'is_classify': is_classify, - 'is_multipath': is_multipath, - 'is_resolve_host': is_resolve_host, - 'is_resolve_attached': is_resolve_attached, - 'is_dvr': is_dvr, - 'is_source_lookup': is_source_lookup, - 'is_udp_encap': is_udp_encap, - 'next_hop_weight': next_hop_weight, - 'dst_address_length': dst_address_length, - 'dst_address': dst_address, - 'next_hop_id': next_hop_id, - 'next_hop_address': next_hop_address, - 'next_hop_n_out_labels': next_hop_n_out_labels, - 'next_hop_via_label': next_hop_via_label, - 'next_hop_out_label_stack': next_hop_out_label_stack}) - - def ip_fib_dump(self): - return self.api(self.papi.ip_fib_dump, {}) - - def ip6_fib_dump(self): - return self.api(self.papi.ip6_fib_dump, {}) - def ip_neighbor_add_del(self, sw_if_index, mac_address, - dst_address, + ip_address, is_add=1, - is_ipv6=0, - is_static=0, - is_no_adj_fib=0, - ): + flags=0): """ Add neighbor MAC to IPv4 or IPv6 address. :param sw_if_index: :param mac_address: :param dst_address: :param is_add: (Default value = 1) - :param is_ipv6: (Default value = 0) - :param is_static: (Default value = 0) - :param is_no_adj_fib: (Default value = 0) + :param flags: (Default value = 0/NONE) """ - return self.api( self.papi.ip_neighbor_add_del, - {'sw_if_index': sw_if_index, - 'is_add': is_add, - 'is_ipv6': is_ipv6, - 'is_static': is_static, - 'is_no_adj_fib': is_no_adj_fib, - 'mac_address': mac_address, - 'dst_address': dst_address - } - ) - - def ip_neighbor_dump(self, - sw_if_index, - is_ipv6=0): - """ Return IP neighbor dump. - - :param sw_if_index: - :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0) - """ - - return self.api( - self.papi.ip_neighbor_dump, - {'is_ipv6': is_ipv6, - 'sw_if_index': sw_if_index - } + { + 'is_add': is_add, + 'neighbor': { + 'sw_if_index': sw_if_index, + 'flags': flags, + 'mac_address': mac_address, + 'ip_address': ip_address + } + } ) def proxy_arp_add_del(self, - low_address, - hi_address, - vrf_id=0, + low, + hi, + table_id=0, is_add=1): """ Config Proxy Arp Range. @@ -1013,12 +593,12 @@ class VppPapiProvider(object): return self.api( self.papi.proxy_arp_add_del, {'proxy': - { - 'vrf_id': vrf_id, - 'low_address': low_address, - 'hi_address': hi_address, - }, - 'is_add': is_add}) + { + 'table_id': table_id, + 'low': low, + 'hi': hi, + }, + 'is_add': is_add}) def proxy_arp_intfc_enable_disable(self, sw_if_index, @@ -1036,71 +616,7 @@ class VppPapiProvider(object): } ) - def reset_vrf(self, - vrf_id, - is_ipv6=0, - ): - """ Reset VRF (remove all routes etc.) request. - - :param int vrf_id: ID of the FIB table / VRF to reset. - :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0) - """ - - return self.api( - self.papi.reset_vrf, - {'vrf_id': vrf_id, - 'is_ipv6': is_ipv6, - } - ) - - def reset_fib(self, - vrf_id, - is_ipv6=0, - ): - """ Reset VRF (remove all routes etc.) request. - - :param int vrf_id: ID of the FIB table / VRF to reset. - :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0) - """ - - return self.api( - self.papi.reset_fib, - {'vrf_id': vrf_id, - 'is_ipv6': is_ipv6, - } - ) - - def ip_dump(self, - is_ipv6=0, - ): - """ Return IP dump. - - :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0) - """ - - return self.api( - self.papi.ip_dump, - {'is_ipv6': is_ipv6, - } - ) - - def sw_interface_span_enable_disable( - self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0): - """ - - :param sw_if_index_from: - :param sw_if_index_to: - :param state: - :param is_l2: - """ - return self.api(self.papi.sw_interface_span_enable_disable, - {'sw_if_index_from': sw_if_index_from, - 'sw_if_index_to': sw_if_index_to, - 'state': state, - 'is_l2': is_l2, - }) - - def gre_tunnel_add_del(self, + def gre_add_del_tunnel(self, src_address, dst_address, outer_fib_id=0, @@ -1116,7 +632,7 @@ class VppPapiProvider(object): :param outer_fib_id: (Default value = 0) :param tunnel_type: (Default value = 0) :param instance: (Default value = 0xFFFFFFFF) - :param session_id: (Defalt value = 0) + :param session_id: (Default value = 0) :param is_add: (Default value = 1) :param is_ipv6: (Default value = 0) """ @@ -1133,48 +649,31 @@ class VppPapiProvider(object): 'session_id': session_id} ) - def udp_encap_add_del(self, - id, - src_ip, - dst_ip, - src_port, - dst_port, - table_id=0, - is_add=1, - is_ip6=0): + def udp_encap_add(self, + src_ip, + dst_ip, + src_port, + dst_port, + table_id=0): """ Add a GRE tunnel - :param id: user provided ID :param src_ip: :param dst_ip: :param src_port: :param dst_port: :param outer_fib_id: (Default value = 0) - :param is_add: (Default value = 1) - :param is_ipv6: (Default value = 0) """ return self.api( - self.papi.udp_encap_add_del, - {'id': id, - 'is_add': is_add, - 'is_ip6': is_ip6, - 'src_ip': src_ip, - 'dst_ip': dst_ip, - 'src_port': src_port, - 'dst_port': dst_port, - 'table_id': table_id} - ) - - def udp_encap_dump(self): - return self.api(self.papi.udp_encap_dump, {}) - - def want_udp_encap_stats(self, enable=1): - return self.api(self.papi.want_udp_encap_stats, - {'enable': enable, - 'pid': os.getpid()}) - - def mpls_fib_dump(self): - return self.api(self.papi.mpls_fib_dump, {}) + self.papi.udp_encap_add, + { + 'udp_encap': { + 'src_ip': src_ip, + 'dst_ip': dst_ip, + 'src_port': src_port, + 'dst_port': dst_port, + 'table_id': table_id + } + }) def mpls_table_add_del( self, @@ -1192,74 +691,6 @@ class VppPapiProvider(object): {'mt_table_id': table_id, 'mt_is_add': is_add}) - def mpls_route_add_del( - self, - label, - eos, - next_hop_proto, - next_hop_address, - next_hop_sw_if_index=0xFFFFFFFF, - table_id=0, - next_hop_table_id=0, - next_hop_weight=1, - next_hop_n_out_labels=0, - next_hop_out_label_stack=[], - next_hop_via_label=MPLS_LABEL_INVALID, - is_resolve_host=0, - is_resolve_attached=0, - is_interface_rx=0, - is_rpf_id=0, - is_multicast=0, - is_add=1, - is_drop=0, - is_multipath=0, - classify_table_index=0xFFFFFFFF, - is_classify=0): - """ - - :param dst_address_length: - :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF) - :param dst_address: - :param next_hop_address: - :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF) - :param vrf_id: (Default value = 0) - :param lookup_in_vrf: (Default value = 0) - :param classify_table_index: (Default value = 0xFFFFFFFF) - :param is_add: (Default value = 1) - :param is_drop: (Default value = 0) - :param is_ipv6: (Default value = 0) - :param is_local: (Default value = 0) - :param is_classify: (Default value = 0) - :param is_multipath: (Default value = 0) - :param is_multicast: (Default value = 0) - :param is_resolve_host: (Default value = 0) - :param is_resolve_attached: (Default value = 0) - :param next_hop_weight: (Default value = 1) - - """ - return self.api( - self.papi.mpls_route_add_del, - {'mr_label': label, - 'mr_eos': eos, - 'mr_table_id': table_id, - 'mr_classify_table_index': classify_table_index, - 'mr_is_add': is_add, - 'mr_is_classify': is_classify, - 'mr_is_multipath': is_multipath, - 'mr_is_multicast': is_multicast, - 'mr_is_resolve_host': is_resolve_host, - 'mr_is_resolve_attached': is_resolve_attached, - 'mr_is_interface_rx': is_interface_rx, - 'mr_is_rpf_id': is_rpf_id, - 'mr_next_hop_proto': next_hop_proto, - 'mr_next_hop_weight': next_hop_weight, - 'mr_next_hop': next_hop_address, - 'mr_next_hop_n_out_labels': next_hop_n_out_labels, - 'mr_next_hop_sw_if_index': next_hop_sw_if_index, - 'mr_next_hop_table_id': next_hop_table_id, - 'mr_next_hop_via_label': next_hop_via_label, - 'mr_next_hop_out_label_stack': next_hop_out_label_stack}) - def mpls_ip_bind_unbind( self, label, @@ -1329,6 +760,7 @@ class VppPapiProvider(object): 'mt_next_hop_n_out_labels': next_hop_n_out_labels, 'mt_next_hop_sw_if_index': next_hop_sw_if_index, 'mt_next_hop_table_id': next_hop_table_id, + 'mt_next_hop_via_label': next_hop_via_label, 'mt_next_hop_out_label_stack': next_hop_out_label_stack}) def nat44_interface_add_del_feature( @@ -1416,7 +848,7 @@ class VppPapiProvider(object): def nat44_add_del_identity_mapping( self, - ip='0', + ip=b'0', sw_if_index=0xFFFFFFFF, port=0, addr_only=1, @@ -1458,7 +890,7 @@ class VppPapiProvider(object): :param first_ip_address: First IP address :param last_ip_address: Last IP address :param vrf_id: VRF id for the address range - :param twice_nat: twice NAT address for extenal hosts + :param twice_nat: twice NAT address for extenral hosts :param is_add: 1 if add, 0 if delete (Default value = 1) """ return self.api( @@ -1469,43 +901,7 @@ class VppPapiProvider(object): 'twice_nat': twice_nat, 'is_add': is_add}) - def nat44_address_dump(self): - """Dump NAT44 addresses - :return: Dictionary of NAT44 addresses - """ - return self.api(self.papi.nat44_address_dump, {}) - - def nat44_interface_dump(self): - """Dump interfaces with NAT44 feature - :return: Dictionary of interfaces with NAT44 feature - """ - return self.api(self.papi.nat44_interface_dump, {}) - - def nat44_interface_output_feature_dump(self): - """Dump interfaces with NAT44 output feature - :return: Dictionary of interfaces with NAT44 output feature - """ - return self.api(self.papi.nat44_interface_output_feature_dump, {}) - - def nat44_static_mapping_dump(self): - """Dump NAT44 static mappings - :return: Dictionary of NAT44 static mappings - """ - return self.api(self.papi.nat44_static_mapping_dump, {}) - - def nat44_identity_mapping_dump(self): - """Dump NAT44 identity mappings - :return: Dictionary of NAT44 identity mappings - """ - return self.api(self.papi.nat44_identity_mapping_dump, {}) - - def nat_show_config(self): - """Show NAT plugin config - :return: NAT plugin config parameters - """ - return self.api(self.papi.nat_show_config, {}) - - def nat44_add_interface_addr( + def nat44_add_del_interface_addr( self, sw_if_index, twice_nat=0, @@ -1513,7 +909,7 @@ class VppPapiProvider(object): """Add/del NAT44 address from interface :param sw_if_index: Software index of the interface - :param twice_nat: twice NAT address for extenal hosts + :param twice_nat: twice NAT address for external hosts :param is_add: 1 if add, 0 if delete (Default value = 1) """ return self.api( @@ -1522,62 +918,16 @@ class VppPapiProvider(object): 'sw_if_index': sw_if_index, 'twice_nat': twice_nat}) - def nat44_interface_addr_dump(self): - """Dump NAT44 addresses interfaces - :return: Dictionary of NAT44 addresses interfaces - """ - return self.api(self.papi.nat44_interface_addr_dump, {}) - - def nat_ipfix( - self, - domain_id=1, - src_port=4739, - enable=1): - """Enable/disable NAT IPFIX logging - - :param domain_id: Observation domain ID (Default value = 1) - :param src_port: Source port number (Default value = 4739) - :param enable: 1 if enable, 0 if disable (Default value = 1) - """ - return self.api( - self.papi.nat_ipfix_enable_disable, - {'domain_id': domain_id, - 'src_port': src_port, - 'enable': enable}) - - def nat44_user_session_dump( - self, - ip_address, - vrf_id): - """Dump NAT44 user's sessions - - :param ip_address: ip adress of the user to be dumped - :param cpu_index: cpu_index on which the user is - :param vrf_id: VRF ID - :return: Dictionary of S-NAT sessions - """ - return self.api( - self.papi.nat44_user_session_dump, - {'ip_address': ip_address, - 'vrf_id': vrf_id}) - - def nat44_user_dump(self): - """Dump NAT44 users - - :return: Dictionary of NAT44 users - """ - return self.api(self.papi.nat44_user_dump, {}) - def nat44_add_del_lb_static_mapping( self, external_addr, external_port, protocol, - vrf_id=0, twice_nat=0, self_twice_nat=0, out2in_only=0, tag='', + affinity=0, local_num=0, locals=[], is_add=1): @@ -1585,6 +935,7 @@ class VppPapiProvider(object): :param twice_nat: 1 if translate external host address and port :param tag: Opaque string tag + :param affinity: if 0 disabled, otherwise client IP affinity timeout :param is_add - 1 if add, 0 if delete """ return self.api( @@ -1593,20 +944,46 @@ class VppPapiProvider(object): 'external_addr': external_addr, 'external_port': external_port, 'protocol': protocol, - 'vrf_id': vrf_id, 'twice_nat': twice_nat, 'self_twice_nat': self_twice_nat, 'out2in_only': out2in_only, 'tag': tag, + 'affinity': affinity, 'local_num': local_num, 'locals': locals}) - def nat44_lb_static_mapping_dump(self): - """Dump NAT44 load balancing static mappings + def nat44_lb_static_mapping_add_del_local( + self, + external_addr, + external_port, + local_addr, + local_port, + protocol, + probability, + vrf_id=0, + is_add=1): + """Add/delete NAT44 load-balancing static mapping rule backend - :return: Dictionary of NAT44 load balancing static mapping + :param external_addr: external IPv4 address of the service + :param external_port: external L4 port number of the service + :param local_addr: IPv4 address of the internal node + :param local_port: L4 port number of the internal node + :param protocol: IP protocol number + :param probability: probability of the internal node + :param vrf_id: VRF id of the internal node + :param is_add: 1 if add, 0 if delete """ - return self.api(self.papi.nat44_lb_static_mapping_dump, {}) + return self.api( + self.papi.nat44_lb_static_mapping_add_del_local, + {'is_add': is_add, + 'external_addr': external_addr, + 'external_port': external_port, + 'local': { + 'addr': local_addr, + 'port': local_port, + 'probability': probability, + 'vrf_id': vrf_id}, + 'protocol': protocol}) def nat44_del_session( self, @@ -1623,7 +1000,7 @@ class VppPapiProvider(object): :param por: port number :param protocol: IP protocol number :param vrf_id: VRF ID - :param is_in: 1 if inside network addres and port pari, 0 if outside + :param is_in: 1 if inside network address and port pair, 0 if outside :param ext_host_address: external host IPv4 address :param ext_host_port: external host port """ @@ -1658,43 +1035,6 @@ class VppPapiProvider(object): self.papi.nat44_forwarding_enable_disable, {'enable': enable}) - def nat_set_reass( - self, - timeout=2, - max_reass=1024, - max_frag=5, - drop_frag=0, - is_ip6=0): - """Set NAT virtual fragmentation reassembly - - :param timeout: reassembly timeout (Default 2sec) - :param max_reass: maximum concurrent reassemblies (Default 1024) - :param max_frag: maximum fragmets per reassembly (Default 5) - :param drop_frag: if 0 translate fragments, otherwise drop fragments - :param is_ip6: 1 if IPv6, 0 if IPv4 - """ - return self.api( - self.papi.nat_set_reass, - {'timeout': timeout, - 'max_reass': max_reass, - 'max_frag': max_frag, - 'drop_frag': drop_frag, - 'is_ip6': is_ip6}) - - def nat_get_reass(self): - """Get NAT virtual fragmentation reassembly configuration - - :return: NAT virtual fragmentation reassembly configuration - """ - return self.api(self.papi.nat_get_reass, {}) - - def nat_reass_dump(self): - """Dump NAT virtual fragmentation reassemblies - - :return: Dictionary of NAT virtual fragmentation reassemblies - """ - return self.api(self.papi.nat_reass_dump, {}) - def nat_det_add_del_map( self, in_addr, @@ -1742,62 +1082,25 @@ class VppPapiProvider(object): """ return self.api( self.papi.nat_det_reverse, - {'out_addr': out_addr, - 'out_port': out_port}) - - def nat_det_map_dump(self): - """Dump deterministic NAT mappings - - :return: Dictionary of deterministic NAT mappings - """ - return self.api(self.papi.nat_det_map_dump, {}) - - def nat_det_set_timeouts( - self, - udp=300, - tcp_established=7440, - tcp_transitory=240, - icmp=60): - """Set values of timeouts for deterministic NAT (in seconds) - - :param udp - UDP timeout (Default value = 300) - :param tcp_established - TCP established timeout (Default value = 7440) - :param tcp_transitory - TCP transitory timeout (Default value = 240) - :param icmp - ICMP timeout (Default value = 60) - """ - return self.api( - self.papi.nat_det_set_timeouts, - {'udp': udp, - 'tcp_established': tcp_established, - 'tcp_transitory': tcp_transitory, - 'icmp': icmp}) + {'out_addr': out_addr, + 'out_port': out_port}) - def nat_det_get_timeouts(self): - """Get values of timeouts for deterministic NAT + def nat_det_map_dump(self): + """Dump deterministic NAT mappings - :return: Timeouts for deterministic NAT (in seconds) + :return: Dictionary of deterministic NAT mappings """ - return self.api(self.papi.nat_det_get_timeouts, {}) + return self.api(self.papi.nat_det_map_dump, {}) - def nat_det_close_session_out( - self, - out_addr, - out_port, - ext_addr, - ext_port): - """Close deterministic NAT session using outside address and port + def nat_set_mss_clamping(self, enable=0, mss_value=1500): + """Set TCP MSS rewriting configuration - :param out_addr - outside IP address - :param out_port - outside port - :param ext_addr - external host IP address - :param ext_port - external host port + :param enable: disable(0)/enable(1) MSS rewriting feature + :param mss_value: MSS value to be used for MSS rewriting """ return self.api( - self.papi.nat_det_close_session_out, - {'out_addr': out_addr, - 'out_port': out_port, - 'ext_addr': ext_addr, - 'ext_port': ext_port}) + self.papi.nat_set_mss_clamping, + {'enable': enable, 'mss_value': mss_value}) def nat_det_close_session_in( self, @@ -1833,32 +1136,6 @@ class VppPapiProvider(object): {'is_nat44': 1, 'user_addr': user_addr}) - def nat64_add_del_pool_addr_range( - self, - start_addr, - end_addr, - vrf_id=0xFFFFFFFF, - is_add=1): - """Add/del address range to NAT64 pool - - :param start_addr: First IP address - :param end_addr: Last IP address - :param vrf_id: VRF id for the address range - :param is_add: 1 if add, 0 if delete (Default value = 1) - """ - return self.api( - self.papi.nat64_add_del_pool_addr_range, - {'start_addr': start_addr, - 'end_addr': end_addr, - 'vrf_id': vrf_id, - 'is_add': is_add}) - - def nat64_pool_addr_dump(self): - """Dump NAT64 pool addresses - :return: Dictionary of NAT64 pool addresses - """ - return self.api(self.papi.nat64_pool_addr_dump, {}) - def nat64_add_del_interface( self, sw_if_index, @@ -1875,12 +1152,6 @@ class VppPapiProvider(object): 'is_inside': is_inside, 'is_add': is_add}) - def nat64_interface_dump(self): - """Dump interfaces with NAT64 feature - :return: Dictionary of interfaces with NAT64 feature - """ - return self.api(self.papi.nat64_interface_dump, {}) - def nat64_add_del_static_bib( self, in_ip, @@ -1918,36 +1189,11 @@ class VppPapiProvider(object): """ return self.api(self.papi.nat64_bib_dump, {'proto': protocol}) - def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440, - tcp_incoming_syn=6): - """Set values of timeouts for NAT64 (in seconds) - - :param udpi: UDP timeout (Default value = 300) - :param icmp: ICMP timeout (Default value = 60) - :param tcp_trans: TCP transitory timeout (Default value = 240) - :param tcp_est: TCP established timeout (Default value = 7440) - :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6) - """ - return self.api( - self.papi.nat64_set_timeouts, - {'udp': udp, - 'icmp': icmp, - 'tcp_trans': tcp_trans, - 'tcp_est': tcp_est, - 'tcp_incoming_syn': tcp_incoming_syn}) - - def nat64_get_timeouts(self): - """Get values of timeouts for NAT64 - - :return: Timeouts for NAT64 (in seconds) - """ - return self.api(self.papi.nat64_get_timeouts, {}) - def nat64_st_dump(self, protocol=255): """Dump NAT64 session table :param protocol: IP protocol (Default value = 255, all STs) - :returns: Dictionary of NAT64 sesstion table entries + :returns: Dictionary of NAT64 session table entries """ return self.api(self.papi.nat64_st_dump, {'proto': protocol}) @@ -1966,14 +1212,7 @@ class VppPapiProvider(object): 'vrf_id': vrf_id, 'is_add': is_add}) - def nat64_prefix_dump(self): - """Dump NAT64 prefix - - :returns: Dictionary of NAT64 prefixes - """ - return self.api(self.papi.nat64_prefix_dump, {}) - - def nat64_add_interface_addr( + def nat64_add_del_interface_addr( self, sw_if_index, is_add=1): @@ -2007,23 +1246,6 @@ class VppPapiProvider(object): {'ip4_addr': ip4, 'ip6_addr': ip6}) - def dslite_add_del_pool_addr_range( - self, - start_addr, - end_addr, - is_add=1): - """Add/del address range to DS-Lite pool - - :param start_addr: First IP address - :param end_addr: Last IP address - :param is_add: 1 if add, 0 if delete (Default value = 1) - """ - return self.api( - self.papi.dslite_add_del_pool_addr_range, - {'start_addr': start_addr, - 'end_addr': end_addr, - 'is_add': is_add}) - def nat66_add_del_interface( self, sw_if_index, @@ -2060,20 +1282,41 @@ class VppPapiProvider(object): 'vrf_id': vrf_id, 'is_add': is_add}) - def nat66_interface_dump(self): - """Dump interfaces with NAT66 feature - :return: Dictionary of interfaces with NAT66 feature + def nat_ha_set_listener(self, addr, port, path_mtu=512): + """Set HA listener (local settings) + + :param addr: local IP4 address + :param port: local UDP port number + :param path_mtu: path MTU (Default value = 512) """ - return self.api(self.papi.nat66_interface_dump, {}) + return self.api(self.papi.nat_ha_set_listener, + {'ip_address': addr, + 'port': port, + 'path_mtu': path_mtu}) + + def nat_ha_get_listener(self): + """Get HA listener/local configuration""" + return self.api(self.papi.nat_ha_get_listener, {}) - def nat66_static_mapping_dump(self): - """Dump NAT66 static mappings - :return: Dictionary of NAT66 static mappings + def nat_ha_set_failover(self, addr, port, refresh=10): + """Set HA failover (remote settings) + + :param addr: failover IP4 address + :param port: failover UDP port number + :param refresh: number of seconds after which to send session refresh """ - return self.api(self.papi.nat66_static_mapping_dump, {}) + return self.api(self.papi.nat_ha_set_failover, + {'ip_address': addr, + 'port': port, + 'session_refresh_interval': refresh}) - def control_ping(self): - self.api(self.papi.control_ping) + def nat_ha_resync(self, want_resync_event=1): + """Resync HA (resend existing sessions to new failover) + :param want_resync_event: if non-zero resync completed event sent + """ + return self.api(self.papi.nat_ha_resync, + {'want_resync_event': want_resync_event, + 'pid': os.getpid()}) def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx, detect_mult, local_addr, peer_addr, is_ipv6=0, @@ -2131,29 +1374,6 @@ class VppPapiProvider(object): 'conf_key_id': conf_key_id, }) - def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr, - is_ipv6=0, is_delayed=False): - return self.api(self.papi.bfd_udp_auth_deactivate, - { - 'sw_if_index': sw_if_index, - 'local_addr': local_addr, - 'peer_addr': peer_addr, - 'is_ipv6': is_ipv6, - 'is_delayed': 1 if is_delayed else 0, - }) - - def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0): - return self.api(self.papi.bfd_udp_del, - { - 'sw_if_index': sw_if_index, - 'local_addr': local_addr, - 'peer_addr': peer_addr, - 'is_ipv6': is_ipv6, - }) - - def bfd_udp_session_dump(self): - return self.api(self.papi.bfd_udp_session_dump, {}) - def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr, peer_addr, is_ipv6=0): return self.api(self.papi.bfd_udp_session_set_flags, { @@ -2178,21 +1398,6 @@ class VppPapiProvider(object): 'key_len': len(key), }) - def bfd_auth_del_key(self, conf_key_id): - return self.api(self.papi.bfd_auth_del_key, { - 'conf_key_id': conf_key_id, - }) - - def bfd_auth_keys_dump(self): - return self.api(self.papi.bfd_auth_keys_dump, {}) - - def bfd_udp_set_echo_source(self, sw_if_index): - return self.api(self.papi.bfd_udp_set_echo_source, - {'sw_if_index': sw_if_index}) - - def bfd_udp_del_echo_source(self): - return self.api(self.papi.bfd_udp_del_echo_source, {}) - def classify_add_del_table( self, is_add, @@ -2220,6 +1425,8 @@ class VppPapiProvider(object): :param current_data_offset: (Default value = 0) """ + mask_len = ((len(mask) - 1) / 16 + 1) * 16 + mask = mask + '\0' * (mask_len - len(mask)) return self.api( self.papi.classify_add_del_table, {'is_add': is_add, @@ -2232,6 +1439,7 @@ class VppPapiProvider(object): 'miss_next_index': miss_next_index, 'current_data_flag': current_data_flag, 'current_data_offset': current_data_offset, + 'mask_len': mask_len, 'mask': mask}) def classify_add_del_session( @@ -2255,6 +1463,8 @@ class VppPapiProvider(object): :param metadata: (Default value = 0) """ + match_len = ((len(match) - 1) / 16 + 1) * 16 + match = match + '\0' * (match_len - len(match)) return self.api( self.papi.classify_add_del_session, {'is_add': is_add, @@ -2264,6 +1474,7 @@ class VppPapiProvider(object): 'advance': advance, 'action': action, 'metadata': metadata, + 'match_len': match_len, 'match': match}) def input_acl_set_interface( @@ -2371,16 +1582,13 @@ class VppPapiProvider(object): 'is_ipv6': is_ip6, }) - def dhcp_client_dump(self): - return self.api(self.papi.dhcp_client_dump, {}) - - def dhcp_client(self, - sw_if_index, - hostname, - client_id='', - is_add=1, - set_broadcast_flag=1, - want_dhcp_events=0): + def dhcp_client_config(self, + sw_if_index, + hostname, + client_id='', + is_add=1, + set_broadcast_flag=1, + want_dhcp_events=0): return self.api( self.papi.dhcp_client_config, { @@ -2429,15 +1637,6 @@ class VppPapiProvider(object): 'src_address': src_address, 'nh_address': next_hop_address}) - def mfib_signal_dump(self): - return self.api(self.papi.mfib_signal_dump, {}) - - def ip_mfib_dump(self): - return self.api(self.papi.ip_mfib_dump, {}) - - def ip6_mfib_dump(self): - return self.api(self.papi.ip6_mfib_dump, {}) - def lisp_enable_disable(self, is_enabled): return self.api( self.papi.lisp_enable_disable, @@ -2445,9 +1644,9 @@ class VppPapiProvider(object): 'is_en': is_enabled, }) - def lisp_locator_set(self, - ls_name, - is_add=1): + def lisp_add_del_locator_set(self, + ls_name, + is_add=1): return self.api( self.papi.lisp_add_del_locator_set, { @@ -2455,15 +1654,12 @@ class VppPapiProvider(object): 'locator_set_name': ls_name }) - def lisp_locator_set_dump(self): - return self.api(self.papi.lisp_locator_set_dump, {}) - - def lisp_locator(self, - ls_name, - sw_if_index, - priority=1, - weight=1, - is_add=1): + def lisp_add_del_locator(self, + ls_name, + sw_if_index, + priority=1, + weight=1, + is_add=1): return self.api( self.papi.lisp_add_del_locator, { @@ -2483,15 +1679,15 @@ class VppPapiProvider(object): 'ls_index': ls_index, }) - def lisp_local_mapping(self, - ls_name, - eid_type, - eid, - prefix_len, - vni=0, - key_id=0, - key="", - is_add=1): + def lisp_add_del_local_eid(self, + ls_name, + eid_type, + eid, + prefix_len, + vni=0, + key_id=0, + key="", + is_add=1): return self.api( self.papi.lisp_add_del_local_eid, { @@ -2523,15 +1719,15 @@ class VppPapiProvider(object): 'filter': filter_opt, }) - def lisp_remote_mapping(self, - eid_type, - eid, - eid_prefix_len=0, - vni=0, - rlocs=[], - rlocs_num=0, - is_src_dst=0, - is_add=1): + def lisp_add_del_remote_mapping(self, + eid_type, + eid, + eid_prefix_len=0, + vni=0, + rlocs=[], + rlocs_num=0, + is_src_dst=0, + is_add=1): return self.api( self.papi.lisp_add_del_remote_mapping, { @@ -2545,14 +1741,14 @@ class VppPapiProvider(object): 'is_src_dst': is_src_dst, }) - def lisp_adjacency(self, - leid, - reid, - leid_len, - reid_len, - eid_type, - is_add=1, - vni=0): + def lisp_add_del_adjacency(self, + leid, + reid, + leid_len, + reid_len, + eid_type, + is_add=1, + vni=0): return self.api( self.papi.lisp_add_del_adjacency, { @@ -2565,43 +1761,6 @@ class VppPapiProvider(object): 'reid_len': reid_len, }) - def lisp_adjacencies_get(self, vni=0): - return self.api( - self.papi.lisp_adjacencies_get, - { - 'vni': vni - }) - - def map_add_domain(self, - ip6_prefix, - ip6_prefix_len, - ip6_src, - ip6_src_prefix_len, - ip4_prefix, - ip4_prefix_len, - ea_bits_len=0, - psid_offset=0, - psid_length=0, - is_translation=0, - is_rfc6052=0, - mtu=1280): - return self.api( - self.papi.map_add_domain, - { - 'ip6_prefix': ip6_prefix, - 'ip6_prefix_len': ip6_prefix_len, - 'ip4_prefix': ip4_prefix, - 'ip4_prefix_len': ip4_prefix_len, - 'ip6_src': ip6_src, - 'ip6_src_prefix_len': ip6_src_prefix_len, - 'ea_bits_len': ea_bits_len, - 'psid_offset': psid_offset, - 'psid_length': psid_length, - 'is_translation': is_translation, - 'is_rfc6052': is_rfc6052, - 'mtu': mtu - }) - def gtpu_add_del_tunnel( self, src_addr, @@ -2669,6 +1828,46 @@ class VppPapiProvider(object): 'protocol': protocol, 'vni': vni}) + def vxlan_gbp_tunnel_add_del( + self, + src, + dst, + mcast_sw_if_index=0xFFFFFFFF, + is_add=1, + is_ipv6=0, + encap_table_id=0, + vni=0, + mode=1, + instance=0xFFFFFFFF): + """ + + :param dst_addr: + :param src_addr: + :param is_add: (Default value = 1) + :param is_ipv6: (Default value = 0) + :param encap_table_id: (Default value = 0) + :param decap_next_index: (Default value = 0xFFFFFFFF) + :param mcast_sw_if_index: (Default value = 0xFFFFFFFF) + :param vni: (Default value = 0) + :param instance: (Default value = 0xFFFFFFFF) + + """ + return self.api(self.papi.vxlan_gbp_tunnel_add_del, + {'is_add': is_add, + 'tunnel': { + 'src': src, + 'dst': dst, + 'mcast_sw_if_index': mcast_sw_if_index, + 'encap_table_id': encap_table_id, + 'vni': vni, + 'instance': instance, + "mode": mode}}) + + def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff): + return self.api(self.papi.vxlan_gbp_tunnel_dump, + {'sw_if_index': sw_if_index, + '_no_type_conversion': True}) + def pppoe_add_del_session( self, client_ip, @@ -2695,6 +1894,18 @@ class VppPapiProvider(object): 'decap_vrf_id': decap_vrf_id, 'client_mac': client_mac}) + def sr_mpls_policy_add(self, bsid, weight, type, segments): + return self.api(self.papi.sr_mpls_policy_add, + {'bsid': bsid, + 'weight': weight, + 'type': type, + 'n_segments': len(segments), + 'segments': segments}) + + def sr_mpls_policy_del(self, bsid): + return self.api(self.papi.sr_mpls_policy_del, + {'bsid': bsid}) + def sr_localsid_add_del(self, localsid, behavior, @@ -2913,15 +2124,6 @@ class VppPapiProvider(object): 'count': len(rules), 'tag': tag}) - def macip_acl_del(self, acl_index): - """ - - :param acl_index: - :return: - """ - return self.api(self.papi.macip_acl_del, - {'acl_index': acl_index}) - def macip_acl_interface_add_del(self, sw_if_index, acl_index, @@ -2938,12 +2140,6 @@ class VppPapiProvider(object): 'sw_if_index': sw_if_index, 'acl_index': acl_index}) - def macip_acl_interface_get(self): - """ Return interface acls dump - """ - return self.api( - self.papi.macip_acl_interface_get, {}) - def macip_acl_dump(self, acl_index=4294967295): """ Return MACIP acl dump """ @@ -2998,15 +2194,18 @@ class VppPapiProvider(object): def ip_punt_redirect(self, rx_sw_if_index, tx_sw_if_index, - nh, - is_ip6=0, + address, is_add=1): return self.api(self.papi.ip_punt_redirect, - {'rx_sw_if_index': rx_sw_if_index, - 'tx_sw_if_index': tx_sw_if_index, - 'nh': nh, - 'is_add': is_add, - 'is_ip6': is_ip6}) + {'punt': {'rx_sw_if_index': rx_sw_if_index, + 'tx_sw_if_index': tx_sw_if_index, + 'nh': address}, + 'is_add': is_add}) + + def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0): + return self.api(self.papi.ip_punt_redirect_dump, + {'sw_if_index': sw_if_index, + 'is_ipv6': is_ipv6}) def bier_table_add_del(self, bti, @@ -3028,7 +2227,8 @@ class VppPapiProvider(object): bti, bp, paths, - is_add=1): + is_add=1, + is_replace=0): """ BIER Route add/del """ return self.api( self.papi.bier_route_add_del, @@ -3038,7 +2238,8 @@ class VppPapiProvider(object): 'br_bp': bp, 'br_n_paths': len(paths), 'br_paths': paths, - 'br_is_add': is_add}) + 'br_is_add': is_add, + 'br_is_replace': is_replace}) def bier_route_dump(self, bti): return self.api( @@ -3116,16 +2317,6 @@ class VppPapiProvider(object): self.papi.bier_disp_entry_dump, {'bde_tbl_id': bdti}) - def add_node_next(self, node_name, next_name): - """ Set the next node for a given node request - - :param node_name: - :param next_name: - """ - return self.api(self.papi.add_node_next, - {'node_name': node_name, - 'next_name': next_name}) - def session_enable_disable(self, is_enabled): return self.api( self.papi.session_enable_disable, @@ -3144,6 +2335,9 @@ class VppPapiProvider(object): self.papi.ipsec_spd_add_del, { 'spd_id': spd_id, 'is_add': is_add}) + def ipsec_spds_dump(self): + return self.api(self.papi.ipsec_spds_dump, {}) + def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1): """ IPSEC interface SPD add/del - \ Wrapper to associate/disassociate SPD to interface in VPP @@ -3160,78 +2354,70 @@ class VppPapiProvider(object): self.papi.ipsec_interface_add_del_spd, {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add}) - def ipsec_sad_add_del_entry(self, + def ipsec_spd_interface_dump(self, spd_index=None): + return self.api(self.papi.ipsec_spd_interface_dump, + {'spd_index': spd_index if spd_index else 0, + 'spd_index_valid': 1 if spd_index else 0}) + + def ipsec_sad_entry_add_del(self, sad_id, spi, + integrity_algorithm, + integrity_key, + crypto_algorithm, + crypto_key, + protocol, tunnel_src_address='', tunnel_dst_address='', - protocol=0, - integrity_algorithm=2, - integrity_key_length=0, - integrity_key='C91KUR9GYMm5GfkEvNjX', - crypto_algorithm=1, - crypto_key_length=0, - crypto_key='JPjyOWBeVEQiMe7h', - is_add=1, - is_tunnel=1, - udp_encap=0): + flags=0, + is_add=1): """ IPSEC SA add/del - Sample CLI : 'ipsec sa add 10 spi 1001 esp \ - crypto-key 4a506a794f574265564551694d653768 \ - crypto-alg aes-cbc-128 \ - integ-key 4339314b55523947594d6d3547666b45764e6a58 \ - integ-alg sha1-96 tunnel-src 192.168.100.3 \ - tunnel-dst 192.168.100.2' - Sample CLI : 'ipsec sa add 20 spi 2001 \ - integ-key 4339314b55523947594d6d3547666b45764e6a58 \ - integ-alg sha1-96' - - :param sad_id - Security Association ID to be \ - created or deleted. mandatory - :param spi - security param index of the SA in decimal. mandatory - :param tunnel_src_address - incase of tunnel mode outer src address .\ - mandatory for tunnel mode - :param tunnel_dst_address - incase of transport mode \ - outer dst address. mandatory for tunnel mode - :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional - :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\ - optional ** - :param integrity_key - value in string \ - (Default C91KUR9GYMm5GfkEvNjX).optional - :param integrity_key_length - length of the key string in bytes\ - (Default 0 - integrity disabled). optional - :param crypto_algorithm - value range 1-11 Default \ - (1- AES_CBC_128).optional ** - :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional - :param crypto_key_length - length of the key string in bytes\ - (Default 0 - crypto disabled). optional - :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\ - optional - :param is_tunnel - tunnel mode (1) or transport mode(0) \ - (Default 1 - tunnel). optional - :returns: reply from the API + :param sad_id: security association ID + :param spi: security param index of the SA in decimal + :param integrity_algorithm: + :param integrity_key: + :param crypto_algorithm: + :param crypto_key: + :param protocol: AH(0) or ESP(1) protocol + :param tunnel_src_address: tunnel mode outer src address + :param tunnel_dst_address: tunnel mode outer dst address + :param is_add: + :param is_tunnel: :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of crypto and ipsec algorithms """ return self.api( - self.papi.ipsec_sad_add_del_entry, - {'sad_id': sad_id, - 'spi': spi, - 'tunnel_src_address': tunnel_src_address, - 'tunnel_dst_address': tunnel_dst_address, - 'protocol': protocol, - 'integrity_algorithm': integrity_algorithm, - 'integrity_key_length': integrity_key_length, - 'integrity_key': integrity_key, - 'crypto_algorithm': crypto_algorithm, - 'crypto_key_length': crypto_key_length, - 'crypto_key': crypto_key, - 'is_add': is_add, - 'is_tunnel': is_tunnel, - 'udp_encap': udp_encap}) + self.papi.ipsec_sad_entry_add_del, + { + 'is_add': is_add, + 'entry': + { + 'sad_id': sad_id, + 'spi': spi, + 'tunnel_src': tunnel_src_address, + 'tunnel_dst': tunnel_dst_address, + 'protocol': protocol, + 'integrity_algorithm': integrity_algorithm, + 'integrity_key': { + 'length': len(integrity_key), + 'data': integrity_key, + }, + 'crypto_algorithm': crypto_algorithm, + 'crypto_key': { + 'length': len(crypto_key), + 'data': crypto_key, + }, + 'flags': flags, + } + }) + + def ipsec_sa_dump(self, sa_id=None): + return self.api(self.papi.ipsec_sa_dump, + {'sa_id': sa_id if sa_id else 0xffffffff}) - def ipsec_spd_add_del_entry(self, + def ipsec_spd_entry_add_del(self, spd_id, + sa_id, local_address_start, local_address_stop, remote_address_start, @@ -3241,65 +2427,103 @@ class VppPapiProvider(object): remote_port_start=0, remote_port_stop=65535, protocol=0, - sa_id=10, policy=0, priority=100, is_outbound=1, is_add=1, + is_ipv6=0, is_ip_any=0): """ IPSEC policy SPD add/del - Wrapper to configure ipsec SPD policy entries in VPP - Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \ - protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \ - remote-ip-range 192.168.3.3 - 192.168.3.3' - - :param spd_id - SPD ID for the policy . mandatory - :param local_address_start - local-ip-range start address . mandatory - :param local_address_stop - local-ip-range stop address . mandatory - :param remote_address_start - remote-ip-range start address . mandatory - :param remote_address_stop - remote-ip-range stop address . mandatory - :param local_port_start - (Default 0) . optional - :param local_port_stop - (Default 65535). optional - :param remote_port_start - (Default 0). optional - :param remote_port_stop - (Default 65535). optional - :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any). - optional - :param sa_id - Security Association ID for mapping it to SPD - (default 10). optional - :param policy - bypass(0), discard(1), resolve(2) or protect(3)action - (Default 0 - bypass). optional - :param priotity - value for the spd action (Default 100). optional - :param is_outbound - flag for inbound(0) or outbound(1) - (Default 1 - outbound). optional - :param is_add flag - for addition(1) or deletion(0) of the spd - (Default 1 - addtion). optional - :returns: reply from the API - """ + :param spd_id: SPD ID for the policy + :param local_address_start: local-ip-range start address + :param local_address_stop : local-ip-range stop address + :param remote_address_start: remote-ip-range start address + :param remote_address_stop : remote-ip-range stop address + :param local_port_start: (Default value = 0) + :param local_port_stop: (Default value = 65535) + :param remote_port_start: (Default value = 0) + :param remote_port_stop: (Default value = 65535) + :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0) + :param sa_id: Security Association ID for mapping it to SPD + :param policy: bypass(0), discard(1), resolve(2) or protect(3) action + (Default value = 0) + :param priority: value for the spd action (Default value = 100) + :param is_outbound: flag for inbound(0) or outbound(1) + (Default value = 1) + :param is_add: (Default value = 1) + """ + return self.api( + self.papi.ipsec_spd_entry_add_del, + { + 'is_add': is_add, + 'entry': + { + 'spd_id': spd_id, + 'sa_id': sa_id, + 'local_address_start': local_address_start, + 'local_address_stop': local_address_stop, + 'remote_address_start': remote_address_start, + 'remote_address_stop': remote_address_stop, + 'local_port_start': local_port_start, + 'local_port_stop': local_port_stop, + 'remote_port_start': remote_port_start, + 'remote_port_stop': remote_port_stop, + 'protocol': protocol, + 'policy': policy, + 'priority': priority, + 'is_outbound': is_outbound, + 'is_ip_any': is_ip_any + } + }) + + def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff): + return self.api(self.papi.ipsec_spd_dump, + {'spd_id': spd_id, + 'sa_id': sa_id}) + + def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi, + remote_spi, crypto_alg, local_crypto_key, + remote_crypto_key, integ_alg, local_integ_key, + remote_integ_key, is_add=1, esn=0, + anti_replay=1, renumber=0, show_instance=0): return self.api( - self.papi.ipsec_spd_add_del_entry, - {'spd_id': spd_id, - 'local_address_start': local_address_start, - 'local_address_stop': local_address_stop, - 'remote_address_start': remote_address_start, - 'remote_address_stop': remote_address_stop, - 'local_port_start': local_port_start, - 'local_port_stop': local_port_stop, - 'remote_port_start': remote_port_start, - 'remote_port_stop': remote_port_stop, - 'is_add': is_add, - 'protocol': protocol, - 'policy': policy, - 'priority': priority, - 'is_outbound': is_outbound, - 'sa_id': sa_id, - 'is_ip_any': is_ip_any}) - - def app_namespace_add(self, - namespace_id, - ip4_fib_id=0, - ip6_fib_id=0, - sw_if_index=0xFFFFFFFF, - secret=0): + self.papi.ipsec_tunnel_if_add_del, + { + 'local_ip': local_ip, + 'remote_ip': remote_ip, + 'local_spi': local_spi, + 'remote_spi': remote_spi, + 'crypto_alg': crypto_alg, + 'local_crypto_key_len': len(local_crypto_key), + 'local_crypto_key': local_crypto_key, + 'remote_crypto_key_len': len(remote_crypto_key), + 'remote_crypto_key': remote_crypto_key, + 'integ_alg': integ_alg, + 'local_integ_key_len': len(local_integ_key), + 'local_integ_key': local_integ_key, + 'remote_integ_key_len': len(remote_integ_key), + 'remote_integ_key': remote_integ_key, + 'is_add': is_add, + 'esn': esn, + 'anti_replay': anti_replay, + 'renumber': renumber, + 'show_instance': show_instance + }) + + def ipsec_select_backend(self, protocol, index): + return self.api(self.papi.ipsec_select_backend, + {'protocol': protocol, 'index': index}) + + def ipsec_backend_dump(self): + return self.api(self.papi.ipsec_backend_dump, {}) + + def app_namespace_add_del(self, + namespace_id, + ip4_fib_id=0, + ip6_fib_id=0, + sw_if_index=0xFFFFFFFF, + secret=0): return self.api( self.papi.app_namespace_add_del, {'secret': secret, @@ -3309,151 +2533,200 @@ class VppPapiProvider(object): 'namespace_id': namespace_id, 'namespace_id_len': len(namespace_id)}) - def punt_socket_register(self, l4_port, pathname, header_version=1, - is_ip4=1, l4_protocol=0x11): - """ Punt to socket """ + def punt_socket_register(self, port, pathname, protocol=0x11, + header_version=1, is_ip4=1): + """ Register punt socket """ return self.api(self.papi.punt_socket_register, - {'is_ip4': is_ip4, - 'l4_protocol': l4_protocol, - 'l4_port': l4_port, - 'pathname': pathname, - 'header_version': header_version}) - - def ip_reassembly_set(self, timeout_ms, max_reassemblies, - expire_walk_interval_ms, is_ip6=0): - """ Set IP reassembly parameters """ - return self.api(self.papi.ip_reassembly_set, - {'is_ip6': is_ip6, - 'timeout_ms': timeout_ms, - 'expire_walk_interval_ms': expire_walk_interval_ms, - 'max_reassemblies': max_reassemblies}) - - def ip_reassembly_get(self, is_ip6=0): - """ Get IP reassembly parameters """ - return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6}) - - def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False, - enable_ip6=False): - """ Enable/disable IP reassembly """ - return self.api(self.papi.ip_reassembly_enable_disable, - {'sw_if_index': sw_if_index, - 'enable_ip4': 1 if enable_ip4 else 0, - 'enable_ip6': 1 if enable_ip6 else 0, - }) - - def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg): - """ GBP endpoint Add/Del """ - return self.api(self.papi.gbp_endpoint_add_del, - {'is_add': is_add, - 'endpoint': { - 'is_ip6': is_ip6, - 'sw_if_index': sw_if_index, - 'address': addr, - 'epg_id': epg}}) + {'header_version': header_version, + 'punt': {'ipv': is_ip4, + 'l4_protocol': protocol, + 'l4_port': port}, + 'pathname': pathname}) + + def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1): + """ Unregister punt socket """ + return self.api(self.papi.punt_socket_deregister, + {'punt': {'ipv': is_ip4, + 'l4_protocol': protocol, + 'l4_port': port}}) + + def punt_socket_dump(self, is_ip6=1): + """ Dump punt socket""" + return self.api(self.papi.punt_socket_dump, + {'is_ipv6': is_ip6}) + + def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags, + tun_src, tun_dst): + """ GBP endpoint Add """ + return self.api(self.papi.gbp_endpoint_add, + {'endpoint': { + 'sw_if_index': sw_if_index, + 'ips': ips, + 'n_ips': len(ips), + 'mac': mac, + 'sclass': sclass, + 'flags': flags, + 'tun': { + 'src': tun_src, + 'dst': tun_dst, + }}}) + + def gbp_endpoint_del(self, handle): + """ GBP endpoint Del """ + return self.api(self.papi.gbp_endpoint_del, + {'handle': handle}) def gbp_endpoint_dump(self): """ GBP endpoint Dump """ - return self.api(self.papi.gbp_endpoint_dump, {}) - - def gbp_endpoint_group_add_del(self, is_add, epg, bd, - ip4_rd, - ip6_rd, - uplink_sw_if_index): - """ GBP endpoint group Add/Del """ - return self.api(self.papi.gbp_endpoint_group_add_del, - {'is_add': is_add, - 'epg': { - 'uplink_sw_if_index': uplink_sw_if_index, - 'bd_id': bd, - 'ip4_table_id': ip4_rd, - 'ip6_table_id': ip6_rd, - 'epg_id': epg}}) - - def gbp_endpoint_group_dump(self): - """ GBP endpoint group Dump """ - return self.api(self.papi.gbp_endpoint_group_dump, {}) - - def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext): + return self.api(self.papi.gbp_endpoint_dump, + {'_no_type_conversion': True}) + + def gbp_endpoint_group_add(self, vnid, sclass, bd, + rd, uplink_sw_if_index, + retention): + """ GBP endpoint group Add """ + return self.api(self.papi.gbp_endpoint_group_add, + {'epg': + { + 'uplink_sw_if_index': uplink_sw_if_index, + 'bd_id': bd, + 'rd_id': rd, + 'vnid': vnid, + 'sclass': sclass, + 'retention': retention + }}) + + def gbp_endpoint_group_del(self, sclass): + """ GBP endpoint group Del """ + return self.api(self.papi.gbp_endpoint_group_del, + {'sclass': sclass}) + + def gbp_bridge_domain_add(self, bd_id, flags, + bvi_sw_if_index, + uu_fwd_sw_if_index, + bm_flood_sw_if_index): + """ GBP bridge-domain Add """ + return self.api(self.papi.gbp_bridge_domain_add, + {'bd': + { + 'flags': flags, + 'bvi_sw_if_index': bvi_sw_if_index, + 'uu_fwd_sw_if_index': uu_fwd_sw_if_index, + 'bm_flood_sw_if_index': bm_flood_sw_if_index, + 'bd_id': bd_id + }}) + + def gbp_bridge_domain_del(self, bd_id): + """ GBP bridge-domain Del """ + return self.api(self.papi.gbp_bridge_domain_del, + {'bd_id': bd_id}) + + def gbp_route_domain_add(self, rd_id, + ip4_table_id, + ip6_table_id, + ip4_uu_sw_if_index, + ip6_uu_sw_if_index): + """ GBP route-domain Add """ + return self.api(self.papi.gbp_route_domain_add, + {'rd': + { + 'ip4_table_id': ip4_table_id, + 'ip6_table_id': ip6_table_id, + 'ip4_uu_sw_if_index': ip4_uu_sw_if_index, + 'ip6_uu_sw_if_index': ip6_uu_sw_if_index, + 'rd_id': rd_id + }}) + + def gbp_route_domain_del(self, rd_id): + """ GBP route-domain Del """ + return self.api(self.papi.gbp_route_domain_del, + {'rd_id': rd_id}) + + def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext): """ GBP recirc Add/Del """ return self.api(self.papi.gbp_recirc_add_del, {'is_add': is_add, 'recirc': { 'is_ext': is_ext, 'sw_if_index': sw_if_index, - 'epg_id': epg}}) + 'sclass': sclass}}) def gbp_recirc_dump(self): """ GBP recirc Dump """ return self.api(self.papi.gbp_recirc_dump, {}) - def gbp_subnet_add_del(self, is_add, table_id, - is_internal, - addr, addr_len, + def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id): + """ GBP recirc Add/Del """ + return self.api(self.papi.gbp_ext_itf_add_del, + {'is_add': is_add, + 'ext_itf': { + 'sw_if_index': sw_if_index, + 'bd_id': bd_id, + 'rd_id': rd_id}}) + + def gbp_ext_itf_dump(self): + """ GBP recirc Dump """ + return self.api(self.papi.gbp_ext_itf_dump, {}) + + def gbp_subnet_add_del(self, is_add, rd_id, + prefix, type, sw_if_index=0xffffffff, - epg_id=0xffffffff, - is_ip6=False): + sclass=0xffff): """ GBP Subnet Add/Del """ return self.api(self.papi.gbp_subnet_add_del, {'is_add': is_add, 'subnet': { - 'is_internal': is_internal, - 'is_ip6': is_ip6, + 'type': type, 'sw_if_index': sw_if_index, - 'epg_id': epg_id, - 'address': addr, - 'address_length': addr_len, - 'table_id': table_id}}) + 'sclass': sclass, + 'prefix': prefix, + 'rd_id': rd_id}}) def gbp_subnet_dump(self): """ GBP Subnet Dump """ - return self.api(self.papi.gbp_subnet_dump, {}) + return self.api(self.papi.gbp_subnet_dump, + {'_no_type_conversion': True}) - def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index): + def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index, + rules, allowed_ethertypes): """ GBP contract Add/Del """ return self.api(self.papi.gbp_contract_add_del, {'is_add': is_add, 'contract': { 'acl_index': acl_index, - 'src_epg': src_epg, - 'dst_epg': dst_epg}}) + 'sclass': sclass, + 'dclass': dclass, + 'n_rules': len(rules), + 'rules': rules, + 'n_ether_types': len(allowed_ethertypes), + 'allowed_ethertypes': allowed_ethertypes}}) def gbp_contract_dump(self): """ GBP contract Dump """ return self.api(self.papi.gbp_contract_dump, {}) - def ipip_6rd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len, - ip4_prefix, ip4_prefix_len, ip4_src, - security_check): - """ 6RD tunnel Add """ - return self.api(self.papi.ipip_6rd_add_tunnel, - {'fib_index': fib_index, - 'ip6_prefix': ip6_prefix, - 'ip6_prefix_len': ip6_prefix_len, - 'ip4_prefix': ip4_prefix, - 'ip4_prefix_len': ip4_prefix_len, - 'ip4_src': ip4_src, - 'security_check': security_check}) - - def ipip_6rd_del_tunnel(self, sw_if_index): - """ 6RD tunnel Delete """ - return self.api(self.papi.ipip_6rd_del_tunnel, - {'sw_if_index': sw_if_index}) - - def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1, - instance=0xFFFFFFFF, fib_index=0, tc_tos=0): - """ IPIP tunnel Add/Del """ - return self.api(self.papi.ipip_add_tunnel, - {'is_ipv6': is_ipv6, - 'instance': instance, - 'src_address': src_address, - 'dst_address': dst_address, - 'fib_index': fib_index, - 'tc_tos': tc_tos}) - - def ipip_del_tunnel(self, sw_if_index): - """ IPIP tunnel Delete """ - return self.api(self.papi.ipip_del_tunnel, - {'sw_if_index': sw_if_index}) + def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src): + """ GBP VXLAN tunnel add """ + return self.api(self.papi.gbp_vxlan_tunnel_add, + { + 'tunnel': { + 'vni': vni, + 'mode': mode, + 'bd_rd_id': bd_rd_id, + 'src': src + } + }) + + def gbp_vxlan_tunnel_del(self, vni): + """ GBP VXLAN tunnel del """ + return self.api(self.papi.gbp_vxlan_tunnel_del, + { + 'vni': vni, + }) + + def gbp_vxlan_tunnel_dump(self): + """ GBP VXLAN tunnel add/del """ + return self.api(self.papi.gbp_vxlan_tunnel_dump, {}) def qos_egress_map_update(self, id, outputs): """ QOS egress map update """ @@ -3477,14 +2750,26 @@ class VppPapiProvider(object): 'output_source': output_source, 'enable': enable}) - def qos_record_enable_disable(self, sw_if_index, input_source, enable): - """ IP QoS recording Enble/Disable """ - return self.api(self.papi.qos_record_enable_disable, - {'sw_if_index': sw_if_index, - 'input_source': input_source, - 'enable': enable}) + def igmp_enable_disable(self, sw_if_index, enable, host): + """ Enable/disable IGMP on a given interface """ + return self.api(self.papi.igmp_enable_disable, + {'enable': enable, + 'mode': host, + 'sw_if_index': sw_if_index}) - def igmp_listen(self, enable, sw_if_index, saddr, gaddr): + def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add): + """ Add/del IGMP proxy device """ + return self.api(self.papi.igmp_proxy_device_add_del, + {'vrf_id': vrf_id, 'sw_if_index': sw_if_index, + 'add': add}) + + def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add): + """ Add/del interface to/from IGMP proxy device """ + return self.api(self.papi.igmp_proxy_device_add_del_interface, + {'vrf_id': vrf_id, 'sw_if_index': sw_if_index, + 'add': add}) + + def igmp_listen(self, filter, sw_if_index, saddrs, gaddr): """ Listen for new (S,G) on specified interface :param enable: add/del @@ -3493,20 +2778,16 @@ class VppPapiProvider(object): :param gaddr: group ip4 addr """ return self.api(self.papi.igmp_listen, - {'enable': enable, - 'sw_if_index': sw_if_index, - 'saddr': saddr, - 'gaddr': gaddr}) - - def igmp_dump(self, sw_if_index=None): - """ Dump all (S,G) interface configurations """ - if sw_if_index is None: - dump_all = 1 - sw_if_index = 0 - else: - dump_all = 0 - return self.api(self.papi.igmp_dump, {'sw_if_index': sw_if_index, - 'dump_all': dump_all}) + { + 'group': + { + 'filter': filter, + 'sw_if_index': sw_if_index, + 'n_srcs': len(saddrs), + 'saddrs': saddrs, + 'gaddr': gaddr + } + }) def igmp_clear_interface(self, sw_if_index): """ Remove all (S,G)s from specified interface @@ -3525,138 +2806,74 @@ class VppPapiProvider(object): mode, lb, use_custom_mac, - mac_address=''): + mac_address='', + interface_id=0xFFFFFFFF): """ :param mode: mode :param lb: load balance :param use_custom_mac: use custom mac :param mac_address: mac address + :param interface_id: custom interface ID """ return self.api( self.papi.bond_create, {'mode': mode, 'lb': lb, 'use_custom_mac': use_custom_mac, - 'mac_address': mac_address - }) - - def bond_delete( - self, - sw_if_index): - """ - :param sw_if_index: interface the operation is applied to - """ - return self.api(self.papi.bond_delete, - {'sw_if_index': sw_if_index}) - - def bond_enslave( - self, - sw_if_index, - bond_sw_if_index, - is_passive, - is_long_timeout): - """ - :param sw_if_index: slave sw_if_index - :param bond_sw_if_index: bond sw_if_index - :param is_passive: is passive lacp speaker - :param is_long_time: 90 seconds timeout instead of 3 seconds timeout - """ - return self.api( - self.papi.bond_enslave, - {'sw_if_index': sw_if_index, - 'bond_sw_if_index': bond_sw_if_index, - 'is_passive': is_passive, - 'is_long_timeout': is_long_timeout - }) - - def bond_detach_slave( - self, - sw_if_index): - """ - :param sw_if_index: slave interface the operation is applied to - """ - return self.api(self.papi.bond_detach_slave, - {'sw_if_index': sw_if_index}) - - def sw_interface_slave_dump( - self, - sw_if_index): - """ - :param sw_if_index: bond sw_if_index - """ - return self.api(self.papi.sw_interface_slave_dump, - {'sw_if_index': sw_if_index}) - - def sw_interface_bond_dump( - self): - """ - - """ - return self.api(self.papi.sw_interface_bond_dump, - {}) - - def create_vhost_user_if( - self, - is_server, - sock_filename, - renumber, - custom_dev_instance, - use_custom_mac, - mac_address, - tag=''): - """ - :param is_server: is server - :param sock_filename: socket name - :param renumber: renumber - :param custom_dev_instance: custom dev instance - :param use_custom_mac: use custom mac - :param mac_address: mac address - :param tag: tag (default '' - """ - return self.api( - self.papi.create_vhost_user_if, - {'is_server': is_server, - 'sock_filename': sock_filename, - 'renumber': renumber, - 'custom_dev_instance': custom_dev_instance, - 'use_custom_mac': use_custom_mac, 'mac_address': mac_address, - 'tag': tag + 'id': interface_id }) - def delete_vhost_user_if( - self, - sw_if_index): - """ - :param sw_if_index: interface the operation is applied to - """ - return self.api(self.papi.delete_vhost_user_if, - {'sw_if_index': sw_if_index, }) - - def sw_interface_vhost_user_dump( - self): - """ - - """ - return self.api(self.papi.sw_interface_vhost_user_dump, - {}) - - def abf_policy_add_del(self, is_add, policy): - return self.api( - self.papi.abf_policy_add_del, - {'is_add': is_add, - 'policy': policy}) + def pipe_delete(self, parent_sw_if_index): + return self.api(self.papi.pipe_delete, + {'parent_sw_if_index': parent_sw_if_index}) - def abf_itf_attach_add_del(self, is_add, attach): - return self.api( - self.papi.abf_itf_attach_add_del, - {'is_add': is_add, - 'attach': attach}) + def memif_create( + self, + role, + mode, + rx_queues=None, + tx_queues=None, + _id=None, + socket_id=None, + secret=None, + ring_size=None, + buffer_size=None, + hw_addr=None): + return self.api(self.papi.memif_create, + {'role': role, + 'mode': mode, + 'rx_queues': rx_queues, + 'tx_queues': tx_queues, + 'id': _id, + 'socket_id': socket_id, + 'secret': secret, + 'ring_size': ring_size, + 'buffer_size': buffer_size, + 'hw_addr': hw_addr}) + + def svs_table_add_del(self, af, table_id, is_add=1): + return self.api(self.papi.svs_table_add_del, + { + 'table_id': table_id, + 'is_add': is_add, + 'af': af, + }) - def abf_policy_dump(self): - return self.api( - self.papi.abf_policy_dump, {}) + def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1): + return self.api(self.papi.svs_route_add_del, + { + 'table_id': table_id, + 'source_table_id': src_table_id, + 'prefix': prefix, + 'is_add': is_add, + }) - def abf_itf_attach_dump(self): - return self.api( - self.papi.abf_itf_attach_dump, {}) + def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1): + return self.api(self.papi.svs_enable_disable, + { + 'af': af, + 'table_id': table_id, + 'sw_if_index': sw_if_index, + 'is_enable': is_enable, + })