X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=test%2Fvpp_papi_provider.py;h=f9bb470ec1defcbdb88dfc797d4ffe8a711c8704;hb=038e1dfbd;hp=828f0302db12cc2967b5c454fcebcfd9d4429a0c;hpb=1c17e2ecac42e001ce905418463edcb26fe58b01;p=vpp.git diff --git a/test/vpp_papi_provider.py b/test/vpp_papi_provider.py index 828f0302db1..f9bb470ec1d 100644 --- a/test/vpp_papi_provider.py +++ b/test/vpp_papi_provider.py @@ -1,58 +1,156 @@ -import fnmatch +# 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 time from collections import deque -from six import moves -from vpp_papi import mac_pton +from six import moves, iteritems +from vpp_papi import VPPApiClient, mac_pton from hook import Hook -from vpp_l2 import L2_PORT_TYPE - -# 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. - -try: - from vpp_papi import VPP -except ImportError: - if not os.getenv("NO_VPP_PAPI") == 1: - raise - pass - -# from vnet/vnet/mpls/mpls_types.h -MPLS_IETF_MAX_LABEL = 0xfffff -MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1 - - -class L2_VTR_OP: - L2_DISABLED = 0 - L2_PUSH_1 = 1 - L2_PUSH_2 = 2 - L2_POP_1 = 3 - L2_POP_2 = 4 - L2_TRANSLATE_1_1 = 5 - L2_TRANSLATE_1_2 = 6 - L2_TRANSLATE_2_1 = 7 - L2_TRANSLATE_2_2 = 8 - - -class QOS_SOURCE: - EXT = 0 - VLAN = 1 - MPLS = 2 - IP = 3 - - -class SYSLOG_SEVERITY: - EMERG = 0 - ALERT = 1 - CRIT = 2 - ERR = 3 - WARN = 4 - NOTICE = 5 - INFO = 6 - DBG = 7 +from vpp_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID + + +# +# 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, }, + 'bvi_create': {'user_instance': 4294967295, }, + 'bvi_delete': {}, + '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, }, + '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_tunnel_add_del': {'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, + '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_route_add_del': {'is_add': 1, }, + 'ip_table_add_del': {'is_add': 1, }, + 'ip_unnumbered_dump': {'sw_if_index': 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, }, + '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, }, + '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_dump': {'sw_if_index': 4294967295, }, + '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_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 CliFailedCommandError(Exception): + """ cli command failed.""" + + +class CliSyntaxError(Exception): + """ cli command had a syntax error.""" class UnexpectedApiReturnValueError(Exception): @@ -69,21 +167,28 @@ class VppPapiProvider(object): _zero, _negative = range(2) def __init__(self, name, shm_prefix, test_class, read_timeout): - self.hook = Hook("vpp-papi-provider") + 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_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)) - self.vpp = VPP(jsonfiles, logger=test_class.logger, - read_timeout=read_timeout) + # install_dir is a class attribute. We need to set it before + # calling the constructor. + VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH') + + use_socket = False + try: + if os.environ['SOCKET'] == '1': + use_socket = True + except KeyError: + pass + + self.vpp = VPPApiClient(logger=test_class.logger, + read_timeout=read_timeout, + use_socket=use_socket, + server_address=test_class.api_sock) self._events = deque() def __enter__(self): @@ -148,7 +253,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): @@ -158,6 +263,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) @@ -182,16 +319,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, moves.reprlib.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, - moves.reprlib.repr(reply)) + msg = "API call failed, expected %d return value instead " \ + "of %d in %s" % (expected_retval, reply.retval, + repr(reply)) self.test_class.logger.info(msg) raise UnexpectedApiReturnValueError(msg) else: @@ -212,6 +349,10 @@ class VppPapiProvider(object): cli += '\n' r = self.papi.cli_inband(cmd=cli) self.hook.after_cli(cli) + if r.retval == -156: + raise CliSyntaxError(r.reply) + if r.retval != 0: + raise CliFailedCommandError(r.reply) if hasattr(r, 'reply'): return r.reply @@ -223,296 +364,16 @@ class VppPapiProvider(object): """ return cli + "\n" + str(self.cli(cli)) - 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_get_table(self, sw_if_index, is_ipv6): - """ Get the IPvX Table-id for the Interface - - :param sw_if_index: - :param is_ipv6: - :return table_id - - """ - return self.api(self.papi.sw_interface_get_table, - {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6}) - - 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 ip_address_dump(self, sw_if_index, is_ipv6=0): - return self.api(self.papi.ip_address_dump, - {'sw_if_index': sw_if_index, - 'is_ipv6': is_ipv6}) - - 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 ip_unnumbered_dump(self, sw_if_index=0xffffffff): - return self.api(self.papi.ip_unnumbered_dump, - {'sw_if_index': sw_if_index}) - - 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, - 'ip': ip, - 'mac': mac}) - - def bd_ip_mac_dump(self, bd_id): - return self.api(self.papi.bd_ip_mac_dump, - {'bd_id': bd_id}) - - 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): @@ -529,20 +390,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, @@ -560,28 +414,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, @@ -623,240 +455,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': 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 l2_fib_table_dump(self, bd_id): - """ Dump the L2 FIB """ - return self.api(self.papi.l2_fib_table_dump, - {'bd_id': bd_id}) - - def sw_interface_set_l2_bridge(self, sw_if_index, bd_id, - shg=0, port_type=L2_PORT_TYPE.NORMAL, - 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, - 'port_type': port_type, - '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 flags: 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, - 'flags': 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_ip_directed_broadcast( - self, - sw_if_index, - enable=1): - """IP Directed broadcast - :param sw_if_index - interface the operation is applied to - - """ - return self.api(self.papi.sw_interface_set_ip_directed_broadcast, - {'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 @@ -869,15 +473,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 @@ -908,10 +504,6 @@ 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, @@ -926,146 +518,54 @@ class VppPapiProvider(object): 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) + {'table': + { + 'table_id': table_id, + 'is_ip6': is_ipv6 + }, + 'is_add': is_add}) - """ + def ip_table_dump(self): + return self.api(self.papi.ip_table_dump, {}) - 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_route_dump(self, table_id, is_ip6=False): + return self.api(self.papi.ip_route_dump, + {'table': { + 'table_id': table_id, + 'is_ip6': is_ip6 + }}) 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. @@ -1077,12 +577,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, @@ -1100,79 +600,14 @@ 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, - src_address, - dst_address, + src, + dst, outer_fib_id=0, tunnel_type=0, instance=0xFFFFFFFF, session_id=0, - is_add=1, - is_ip6=0): + is_add=1): """ Add a GRE tunnel :param src_address: @@ -1180,21 +615,23 @@ 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) """ return self.api( - self.papi.gre_add_del_tunnel, + self.papi.gre_tunnel_add_del, {'is_add': is_add, - 'is_ipv6': is_ip6, - 'tunnel_type': tunnel_type, - 'instance': instance, - 'src_address': src_address, - 'dst_address': dst_address, - 'outer_fib_id': outer_fib_id, - 'session_id': session_id} + 'tunnel': + { + 'type': tunnel_type, + 'instance': instance, + 'src': src, + 'dst': dst, + 'outer_fib_id': outer_fib_id, + 'session_id': session_id} + } ) def udp_encap_add(self, @@ -1234,990 +671,96 @@ class VppPapiProvider(object): {'enable': enable, 'pid': os.getpid()}) - def mpls_fib_dump(self): - return self.api(self.papi.mpls_fib_dump, {}) - - def mpls_table_add_del( - self, - table_id, - is_add=1): - """ - - :param table_id - :param is_add: (Default value = 1) - - """ - - return self.api( - self.papi.mpls_table_add_del, - {'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, - dst_address, - dst_address_length, - table_id=0, - ip_table_id=0, - is_ip4=1, - is_bind=1): - """ - """ - return self.api( - self.papi.mpls_ip_bind_unbind, - {'mb_mpls_table_id': table_id, - 'mb_label': label, - 'mb_ip_table_id': ip_table_id, - 'mb_is_bind': is_bind, - 'mb_is_ip4': is_ip4, - 'mb_address_length': dst_address_length, - 'mb_address': dst_address}) - - def mpls_tunnel_add_del( - self, - tun_sw_if_index, - next_hop_proto_is_ip4, - next_hop_address, - next_hop_sw_if_index=0xFFFFFFFF, - 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_add=1, - l2_only=0, - is_multicast=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 next_hop_weight: (Default value = 1) - :param is_multicast: (Default value = 0) + def mpls_route_dump(self, table_id): + return self.api(self.papi.mpls_route_dump, + {'table': { + 'mt_table_id': table_id + }}) - """ - return self.api( - self.papi.mpls_tunnel_add_del, - {'mt_sw_if_index': tun_sw_if_index, - 'mt_is_add': is_add, - 'mt_l2_only': l2_only, - 'mt_is_multicast': is_multicast, - 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4, - 'mt_next_hop_weight': next_hop_weight, - 'mt_next_hop': next_hop_address, - '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 mpls_tunnel_dump(self, sw_if_index=0xffffffff): - return self.api(self.papi.mpls_tunnel_dump, - {'sw_if_index': sw_if_index}) - - def nat44_interface_add_del_feature( - self, - sw_if_index, - is_inside=1, - is_add=1): - """Enable/disable NAT44 feature on the interface - - :param sw_if_index: Software index of the interface - :param is_inside: 1 if inside, 0 if outside (Default value = 1) - :param is_add: 1 if add, 0 if delete (Default value = 1) - """ - return self.api( - self.papi.nat44_interface_add_del_feature, - {'is_add': is_add, - 'is_inside': is_inside, - 'sw_if_index': sw_if_index}) - - def nat44_interface_add_del_output_feature( - self, - sw_if_index, - is_inside=1, - is_add=1): - """Enable/disable NAT44 output feature on the interface - - :param sw_if_index: Software index of the interface - :param is_inside: 1 if inside, 0 if outside (Default value = 1) - :param is_add: 1 if add, 0 if delete (Default value = 1) - """ - return self.api( - self.papi.nat44_interface_add_del_output_feature, - {'is_add': is_add, - 'is_inside': is_inside, - 'sw_if_index': sw_if_index}) - - def nat44_add_del_static_mapping( - self, - local_ip, - external_ip=0, - external_sw_if_index=0xFFFFFFFF, - local_port=0, - external_port=0, - addr_only=1, - vrf_id=0, - protocol=0, - twice_nat=0, - self_twice_nat=0, - out2in_only=0, - tag="", - is_add=1): - """Add/delete NAT44 static mapping - - :param local_ip: Local IP address - :param external_ip: External IP address - :param external_sw_if_index: External interface instead of IP address - :param local_port: Local port number (Default value = 0) - :param external_port: External port number (Default value = 0) - :param addr_only: 1 if address only mapping, 0 if address and port - :param vrf_id: VRF ID - :param protocol: IP protocol (Default value = 0) - :param twice_nat: 1 if translate external host address and port - :param self_twice_nat: 1 if translate external host address and port - whenever external host address equals - local address of internal host - :param out2in_only: if 1 rule is matching only out2in direction - :param tag: Opaque string tag - :param is_add: 1 if add, 0 if delete (Default value = 1) - """ - return self.api( - self.papi.nat44_add_del_static_mapping, - {'is_add': is_add, - 'addr_only': addr_only, - 'local_ip_address': local_ip, - 'external_ip_address': external_ip, - 'local_port': local_port, - 'external_port': external_port, - 'external_sw_if_index': external_sw_if_index, - 'vrf_id': vrf_id, - 'protocol': protocol, - 'twice_nat': twice_nat, - 'self_twice_nat': self_twice_nat, - 'out2in_only': out2in_only, - 'tag': tag}) - - def nat44_add_del_identity_mapping( - self, - ip='0', - sw_if_index=0xFFFFFFFF, - port=0, - addr_only=1, - vrf_id=0, - protocol=0, - tag='', - is_add=1): - """Add/delete NAT44 identity mapping - - :param ip: IP address (Default value = 0) - :param sw_if_index: Interface instead of IP address - :param port: Port number (Default value = 0) - :param addr_only: 1 if address only mapping, 0 if address and port - :param vrf_id: VRF ID - :param protocol: IP protocol (Default value = 0) - :param tag: Opaque string tag - :param is_add: 1 if add, 0 if delete (Default value = 1) - """ - return self.api( - self.papi.nat44_add_del_identity_mapping, - {'is_add': is_add, - 'addr_only': addr_only, - 'ip_address': ip, - 'port': port, - 'sw_if_index': sw_if_index, - 'vrf_id': vrf_id, - 'tag': tag, - 'protocol': protocol}) - - def nat44_add_del_address_range( - self, - first_ip_address, - last_ip_address, - is_add=1, - vrf_id=0xFFFFFFFF, - twice_nat=0): - """Add/del NAT44 address range - - :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 is_add: 1 if add, 0 if delete (Default value = 1) - """ - return self.api( - self.papi.nat44_add_del_address_range, - {'first_ip_address': first_ip_address, - 'last_ip_address': last_ip_address, - 'vrf_id': vrf_id, - '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( - self, - sw_if_index, - twice_nat=0, - is_add=1): - """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 is_add: 1 if add, 0 if delete (Default value = 1) - """ - return self.api( - self.papi.nat44_add_del_interface_addr, - {'is_add': is_add, - '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, - twice_nat=0, - self_twice_nat=0, - out2in_only=0, - tag='', - affinity=0, - local_num=0, - locals=[], - is_add=1): - """Add/delete NAT44 load balancing static mapping - - :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( - self.papi.nat44_add_del_lb_static_mapping, - {'is_add': is_add, - 'external_addr': external_addr, - 'external_port': external_port, - 'protocol': protocol, - '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_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 - - :param external_addr: external IPv4 address of the servic - :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_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_lb_static_mapping_dump(self): - """Dump NAT44 load balancing static mappings - - :return: Dictionary of NAT44 load balancing static mapping - """ - return self.api(self.papi.nat44_lb_static_mapping_dump, {}) - - def nat44_del_session( - self, - addr, - port, - protocol, - vrf_id=0, - is_in=1, - ext_host_address=None, - ext_host_port=0): - """Delete NAT44 session - - :param addr: IPv4 address - :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 ext_host_address: external host IPv4 address - :param ext_host_port: external host port - """ - if ext_host_address is None: - return self.api( - self.papi.nat44_del_session, - {'address': addr, - 'port': port, - 'protocol': protocol, - 'vrf_id': vrf_id, - 'is_in': is_in}) - else: - return self.api( - self.papi.nat44_del_session, - {'address': addr, - 'port': port, - 'protocol': protocol, - 'vrf_id': vrf_id, - 'is_in': is_in, - 'ext_host_valid': 1, - 'ext_host_address': ext_host_address, - 'ext_host_port': ext_host_port}) - - def nat44_forwarding_enable_disable( - self, - enable): - """Enable/disable forwarding for NAT44 - - :param enable: 1 for enable, 0 for disable - """ - return self.api( - 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, - in_plen, - out_addr, - out_plen, - is_add=1): - """Add/delete deterministic NAT mapping - - :param is_add - 1 if add, 0 if delete - :param in_addr - inside IP address - :param in_plen - inside IP address prefix length - :param out_addr - outside IP address - :param out_plen - outside IP address prefix length - """ - return self.api( - self.papi.nat_det_add_del_map, - {'is_add': is_add, - 'is_nat44': 1, - 'in_addr': in_addr, - 'in_plen': in_plen, - 'out_addr': out_addr, - 'out_plen': out_plen}) - - def nat_det_forward( - self, - in_addr): - """Get outside address and port range from inside address - - :param in_addr - inside IP address - """ - return self.api( - self.papi.nat_det_forward, - {'in_addr': in_addr, - 'is_nat44': 1}) - - def nat_det_reverse( - self, - out_addr, - out_port): - """Get inside address from outside address and port - - :param out_addr - outside IP address - :param out_port - outside port - """ - 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_set_timeouts( - self, - udp=300, - tcp_established=7440, - tcp_transitory=240, - icmp=60): - """Set values of timeouts for NAT sessions (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_set_timeouts, - {'udp': udp, - 'tcp_established': tcp_established, - 'tcp_transitory': tcp_transitory, - 'icmp': icmp}) - - def nat_get_timeouts(self): - """Get values of timeouts for NAT sessions - - :return: Timeouts for NAT sessions (in seconds) - """ - return self.api(self.papi.nat_get_timeouts, {}) - - def nat_set_addr_and_port_alloc_alg( - self, - alg=0, - psid_offset=0, - psid_length=0, - psid=0, - start_port=0, - end_port=0): - """Set address and port assignment algorithm - - :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range - :param psid_offset: number of offset bits (valid only for MAP-E alg) - :param psid_length: length of PSID (valid only for MAP-E alg) - :param psid: Port Set Identifier value (valid only for MAP-E alg) - :param start_port: beginning of the port range - :param end_port: end of the port range - """ - return self.api( - self.papi.nat_set_addr_and_port_alloc_alg, - {'alg': alg, - 'psid_offset': psid_offset, - 'psid_length': psid_length, - 'psid': psid, - 'start_port': start_port, - 'end_port': end_port}) - - def nat_get_addr_and_port_alloc_alg(self): - """Get address and port assignment algorithm""" - return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {}) - - def nat_set_mss_clamping(self, enable=0, mss_value=1500): - """Set TCP MSS rewriting configuration - - :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_set_mss_clamping, - {'enable': enable, 'mss_value': mss_value}) - - def nat_get_mss_clamping(self): - """Get TCP MSS rewriting configuration""" - return self.api(self.papi.nat_get_mss_clamping, {}) - - def nat_det_close_session_out( - self, - out_addr, - out_port, - ext_addr, - ext_port): - """Close deterministic NAT session using outside address and port - - :param out_addr - outside IP address - :param out_port - outside port - :param ext_addr - external host IP address - :param ext_port - external host port - """ - 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}) - - def nat_det_close_session_in( - self, - in_addr, - in_port, - ext_addr, - ext_port): - """Close deterministic NAT session using inside address and port - - :param in_addr - inside IP address - :param in_port - inside port - :param ext_addr - external host IP address - :param ext_port - external host port - """ - return self.api( - self.papi.nat_det_close_session_in, - {'in_addr': in_addr, - 'in_port': in_port, - 'ext_addr': ext_addr, - 'ext_port': ext_port, - 'is_nat44': 1}) - - def nat_det_session_dump( - self, - user_addr): - """Dump deterministic NAT sessions belonging to a user - - :param user_addr - inside IP address of the user - :return: Dictionary of deterministic NAT sessions - """ - return self.api( - self.papi.nat_det_session_dump, - {'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, - is_inside=1, - is_add=1): - """Enable/disable NAT64 feature on the interface - :param sw_if_index: Index of the interface - :param is_inside: 1 if inside, 0 if outside (Default value = 1) - :param is_add: 1 if add, 0 if delete (Default value = 1) - """ - return self.api( - self.papi.nat64_add_del_interface, - {'sw_if_index': sw_if_index, - '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, - out_ip, - in_port, - out_port, - protocol, - vrf_id=0, - is_add=1): - """Add/delete S-NAT static BIB entry - - :param in_ip: Inside IPv6 address - :param out_ip: Outside IPv4 address - :param in_port: Inside port number - :param out_port: Outside port number - :param protocol: IP protocol - :param vrf_id: VRF ID (Default value = 0) - :param is_add: 1 if add, 0 if delete (Default value = 1) - """ - return self.api( - self.papi.nat64_add_del_static_bib, - {'i_addr': in_ip, - 'o_addr': out_ip, - 'i_port': in_port, - 'o_port': out_port, - 'vrf_id': vrf_id, - 'proto': protocol, - 'is_add': is_add}) - - def nat64_bib_dump(self, protocol=255): - """Dump NAT64 BIB - - :param protocol: IP protocol (Default value = 255, all BIBs) - :returns: Dictionary of NAT64 BIB entries - """ - 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 - """ - return self.api(self.papi.nat64_st_dump, {'proto': protocol}) - - def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1): - """Add/del NAT64 prefix - - :param prefix: NAT64 prefix - :param plen: NAT64 prefix length - :param vrf_id: VRF id of tenant (Default 0) - :param is_add: 1 if add, 0 if delete (Default value = 1) - """ - return self.api( - self.papi.nat64_add_del_prefix, - {'prefix': prefix, - 'prefix_len': plen, - '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 mpls_table_dump(self): + return self.api(self.papi.mpls_table_dump, {}) - def nat64_add_interface_addr( + def mpls_table_add_del( self, - sw_if_index, + table_id, is_add=1): - """Add/del NAT64 address from interface - - :param sw_if_index: Software index of the interface - :param is_add: 1 if add, 0 if delete (Default value = 1) """ - return self.api(self.papi.nat64_add_del_interface_addr, - {'is_add': is_add, 'sw_if_index': sw_if_index}) - def dslite_set_aftr_addr(self, ip6, ip4): - """Set DS-Lite AFTR addresses + :param table_id + :param is_add: (Default value = 1) - :param ip4: IPv4 address - :param ip6: IPv6 address """ - return self.api( - self.papi.dslite_set_aftr_addr, - {'ip4_addr': ip4, - 'ip6_addr': ip6}) - - def dslite_set_b4_addr(self, ip6, ip4): - """Set DS-Lite B4 IPv6 address - :param ip4: IPv4 address - :param ip6: IPv6 address - """ return self.api( - self.papi.dslite_set_b4_addr, - {'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 + self.papi.mpls_table_add_del, + {'mt_table': + { + 'mt_table_id': table_id, + }, + 'mt_is_add': is_add}) - :param start_addr: First IP address - :param end_addr: Last IP address - :param is_add: 1 if add, 0 if delete (Default value = 1) - """ + def mpls_route_add_del(self, + table_id, + label, + eos, + eos_proto, + is_multicast, + paths, + is_add, + is_multipath): + """ MPLS Route add/del """ return self.api( - self.papi.dslite_add_del_pool_addr_range, - {'start_addr': start_addr, - 'end_addr': end_addr, - 'is_add': is_add}) + self.papi.mpls_route_add_del, + {'mr_route': + { + 'mr_table_id': table_id, + 'mr_label': label, + 'mr_eos': eos, + 'mr_eos_proto': eos_proto, + 'mr_is_multicast': is_multicast, + 'mr_n_paths': len(paths), + 'mr_paths': paths, + }, + 'mr_is_add': is_add, + 'mr_is_multipath': is_multipath}) - def nat66_add_del_interface( + def mpls_ip_bind_unbind( self, - sw_if_index, - is_inside=1, - is_add=1): - """Enable/disable NAT66 feature on the interface - :param sw_if_index: Index of the interface - :param is_inside: 1 if inside, 0 if outside (Default value = 1) - :param is_add: 1 if add, 0 if delete (Default value = 1) + label, + prefix, + table_id=0, + ip_table_id=0, + is_bind=1): """ - return self.api( - self.papi.nat66_add_del_interface, - {'sw_if_index': sw_if_index, - 'is_inside': is_inside, - 'is_add': is_add}) - - def nat66_add_del_static_mapping( - self, - in_ip, - out_ip, - vrf_id=0, - is_add=1): - """Add/delete NAT66 static mapping - - :param in_ip: Inside IPv6 address - :param out_ip: Outside IPv6 address - :param vrf_id: VRF ID (Default value = 0) - :param is_add: 1 if add, 0 if delete (Default value = 1) """ return self.api( - self.papi.nat66_add_del_static_mapping, - {'local_ip_address': in_ip, - 'external_ip_address': out_ip, - 'vrf_id': vrf_id, - 'is_add': is_add}) + self.papi.mpls_ip_bind_unbind, + {'mb_mpls_table_id': table_id, + 'mb_label': label, + 'mb_ip_table_id': ip_table_id, + 'mb_is_bind': is_bind, + 'mb_prefix': prefix}) - def nat66_interface_dump(self): - """Dump interfaces with NAT66 feature - :return: Dictionary of interfaces with NAT66 feature + def mpls_tunnel_add_del( + self, + tun_sw_if_index, + paths, + is_add=1, + l2_only=0, + is_multicast=0): """ - return self.api(self.papi.nat66_interface_dump, {}) - - def nat66_static_mapping_dump(self): - """Dump NAT66 static mappings - :return: Dictionary of NAT66 static mappings """ - return self.api(self.papi.nat66_static_mapping_dump, {}) - - def control_ping(self): - self.api(self.papi.control_ping) + return self.api( + self.papi.mpls_tunnel_add_del, + {'mt_is_add': is_add, + 'mt_tunnel': + { + 'mt_sw_if_index': tun_sw_if_index, + 'mt_l2_only': l2_only, + 'mt_is_multicast': is_multicast, + 'mt_n_paths': len(paths), + 'mt_paths': paths, + }}) def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx, detect_mult, local_addr, peer_addr, is_ipv6=0, @@ -2275,29 +818,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, { @@ -2322,24 +842,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 bfd_udp_get_echo_source(self): - return self.api(self.papi.bfd_udp_get_echo_source, {}) - def classify_add_del_table( self, is_add, @@ -2524,16 +1026,14 @@ 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, + dscp=0): return self.api( self.papi.dhcp_client_config, { @@ -2544,52 +1044,45 @@ class VppPapiProvider(object): 'id': client_id, 'want_dhcp_event': want_dhcp_events, 'set_broadcast_flag': set_broadcast_flag, + 'dscp': dscp, 'pid': os.getpid()} }) def ip_mroute_add_del(self, - src_address, - grp_address, - grp_address_length, + table_id, + prefix, e_flags, - next_hop_afi, - next_hop_sw_if_index, - next_hop_address, - i_flags, - bier_imp=0, - rpf_id=0, - table_id=0, + rpf_id, + paths, is_add=1, - is_ipv6=0, - is_local=0): + is_multipath=1): """ IP Multicast Route add/del """ return self.api( self.papi.ip_mroute_add_del, - {'next_hop_sw_if_index': next_hop_sw_if_index, - 'entry_flags': e_flags, - 'itf_flags': i_flags, - 'table_id': table_id, - 'rpf_id': rpf_id, - 'is_add': is_add, - 'is_ipv6': is_ipv6, - 'is_local': is_local, - 'bier_imp': bier_imp, - 'next_hop_afi': next_hop_afi, - 'grp_address_length': grp_address_length, - 'grp_address': grp_address, - 'src_address': src_address, - 'nh_address': next_hop_address}) + { + 'is_add': is_add, + 'is_multipath': is_multipath, + 'route': { + 'table_id': table_id, + 'entry_flags': e_flags, + 'rpf_id': rpf_id, + 'prefix': prefix, + 'n_paths': len(paths), + 'paths': paths, + } + }) 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 ip_mroute_dump(self, table_id, is_ip6=False): + return self.api(self.papi.ip_mroute_dump, + {'table': { + 'table_id': table_id, + 'is_ip6': is_ip6 + }}) def lisp_enable_disable(self, is_enabled): return self.api( @@ -2598,9 +1091,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, { @@ -2608,15 +1101,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, { @@ -2636,15 +1126,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, { @@ -2676,15 +1166,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, { @@ -2698,14 +1188,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, { @@ -2718,50 +1208,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_src, - ip4_prefix, - ea_bits_len=0, - psid_offset=0, - psid_length=0, - mtu=1280): - - return self.api( - self.papi.map_add_domain, - { - 'ip6_prefix': ip6_prefix, - 'ip4_prefix': ip4_prefix, - 'ip6_src': ip6_src, - 'ea_bits_len': ea_bits_len, - 'psid_offset': psid_offset, - 'psid_length': psid_length, - 'mtu': mtu - }) - - def map_if_enable_disable(self, is_enable, sw_if_index, is_translation): - return self.api( - self.papi.map_if_enable_disable, - { - 'is_enable': is_enable, - 'sw_if_index': sw_if_index, - 'is_translation': is_translation, - }) - - def map_param_set_tcp(self, tcp_mss): - return self.api( - self.papi.map_param_set_tcp, - { - 'tcp_mss': tcp_mss, - }) - def gtpu_add_del_tunnel( self, src_addr, @@ -2829,39 +1275,6 @@ 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, - 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}}) - 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, @@ -3123,15 +1536,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, @@ -3148,12 +1552,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 """ @@ -3246,14 +1644,18 @@ class VppPapiProvider(object): """ BIER Route add/del """ return self.api( self.papi.bier_route_add_del, - {'br_tbl_id': {"bt_set": bti.set_id, - "bt_sub_domain": bti.sub_domain_id, - "bt_hdr_len_id": bti.hdr_len_id}, - 'br_bp': bp, - 'br_n_paths': len(paths), - 'br_paths': paths, - 'br_is_add': is_add, - 'br_is_replace': is_replace}) + { + 'br_route': { + 'br_tbl_id': {"bt_set": bti.set_id, + "bt_sub_domain": bti.sub_domain_id, + "bt_hdr_len_id": bti.hdr_len_id}, + 'br_bp': bp, + 'br_n_paths': len(paths), + 'br_paths': paths, + }, + 'br_is_add': is_add, + 'br_is_replace': is_replace + }) def bier_route_dump(self, bti): return self.api( @@ -3318,9 +1720,7 @@ class VppPapiProvider(object): 'bde_bp': bp, 'bde_payload_proto': payload_proto, 'bde_n_paths': 1, - 'bde_paths': [{'next_hop': next_hop, - 'table_id': next_hop_tbl_id, - 'afi': next_hop_afi, + 'bde_paths': [{'table_id': next_hop_tbl_id, 'rpf_id': next_hop_rpf_id, 'n_labels': 0, 'label_stack': lstack}], @@ -3331,16 +1731,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, @@ -3359,6 +1749,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 @@ -3375,7 +1768,12 @@ 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, @@ -3385,12 +1783,9 @@ class VppPapiProvider(object): protocol, tunnel_src_address='', tunnel_dst_address='', - is_tunnel=1, - is_tunnel_ipv6=0, - is_add=1, - udp_encap=0, - use_anti_replay=0, - use_extended_sequence_number=0): + flags=0, + salt=0, + is_add=1): """ IPSEC SA add/del :param sad_id: security association ID :param spi: security param index of the SA in decimal @@ -3407,27 +1802,36 @@ class VppPapiProvider(object): 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': len(integrity_key), - 'integrity_key': integrity_key, - 'crypto_algorithm': crypto_algorithm, - 'crypto_key_length': len(crypto_key) if crypto_key is not None - else 0, - 'crypto_key': crypto_key, - 'is_add': is_add, - 'is_tunnel': is_tunnel, - 'is_tunnel_ipv6': is_tunnel_ipv6, - 'udp_encap': udp_encap, - 'use_extended_sequence_number': use_extended_sequence_number, - 'use_anti_replay': use_anti_replay}) - - def ipsec_spd_add_del_entry(self, + 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, + 'salt': salt, + } + }) + + 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_entry_add_del(self, spd_id, sa_id, local_address_start, @@ -3466,46 +1870,64 @@ class VppPapiProvider(object): :param is_add: (Default value = 1) """ return self.api( - self.papi.ipsec_spd_add_del_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, - 'is_add': is_add, - 'protocol': protocol, - 'policy': policy, - 'priority': priority, - 'is_outbound': is_outbound, - 'is_ipv6': is_ipv6, - 'is_ip_any': is_ip_any}) + 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, + } + }) + + 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): + remote_integ_key, is_add=1, esn=0, salt=0, + anti_replay=1, renumber=0, + udp_encap=0, show_instance=0): return self.api( 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 - }) + { + '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, + 'udp_encap': udp_encap, + 'salt': salt + }) def ipsec_select_backend(self, protocol, index): return self.api(self.papi.ipsec_select_backend, @@ -3514,12 +1936,12 @@ class VppPapiProvider(object): def ipsec_backend_dump(self): return self.api(self.papi.ipsec_backend_dump, {}) - def app_namespace_add(self, - namespace_id, - ip4_fib_id=0, - ip6_fib_id=0, - sw_if_index=0xFFFFFFFF, - secret=0): + 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, @@ -3529,61 +1951,29 @@ class VppPapiProvider(object): 'namespace_id': namespace_id, 'namespace_id_len': len(namespace_id)}) - def punt_socket_register(self, port, pathname, protocol=0x11, - header_version=1, is_ip4=1): + def punt_socket_register(self, reg, pathname, + header_version=1): """ Register punt socket """ return self.api(self.papi.punt_socket_register, {'header_version': header_version, - 'punt': {'ipv': is_ip4, - 'l4_protocol': protocol, - 'l4_port': port}, + 'punt': reg, 'pathname': pathname}) - def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1): + def punt_socket_deregister(self, reg): """ 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 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, - }) + {'punt': reg}) - def gbp_endpoint_add(self, sw_if_index, ips, mac, epg, flags, + 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, - 'flags': 0, 'ips': ips, 'n_ips': len(ips), 'mac': mac, - 'epg_id': epg, + 'sclass': sclass, 'flags': flags, 'tun': { 'src': tun_src, @@ -3600,50 +1990,49 @@ class VppPapiProvider(object): return self.api(self.papi.gbp_endpoint_dump, {'_no_type_conversion': True}) - def gbp_endpoint_group_add(self, epg, bd, - rd, uplink_sw_if_index): + 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, - 'epg_id': epg - }}) - - def gbp_endpoint_group_del(self, 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, - {'epg_id': epg}) - - def gbp_endpoint_group_dump(self): - """ GBP endpoint group Dump """ - return self.api(self.papi.gbp_endpoint_group_dump, {}) + {'sclass': sclass}) - def gbp_bridge_domain_add(self, bd_id, flags, + def gbp_bridge_domain_add(self, bd_id, rd_id, flags, bvi_sw_if_index, - uu_fwd_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, - 'bd_id': bd_id - }}) + { + '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, + 'rd_id': rd_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_bridge_domain_dump(self): - """ GBP Bridge Domain Dump """ - return self.api(self.papi.gbp_bridge_domain_dump, {}) - def gbp_route_domain_add(self, rd_id, + scope, ip4_table_id, ip6_table_id, ip4_uu_sw_if_index, @@ -3651,44 +2040,42 @@ class VppPapiProvider(object): """ 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 - }}) + { + 'scope': scope, + '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_route_domain_dump(self): - """ GBP Route Domain Dump """ - return self.api(self.papi.gbp_route_domain_dump, {}) - - def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext): + 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_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id): + def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags): """ 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}}) + 'rd_id': rd_id, + 'flags': flags}}) def gbp_ext_itf_dump(self): """ GBP recirc Dump """ @@ -3697,14 +2084,14 @@ class VppPapiProvider(object): def gbp_subnet_add_del(self, is_add, rd_id, prefix, type, sw_if_index=0xffffffff, - epg_id=0xffff): + sclass=0xffff): """ GBP Subnet Add/Del """ return self.api(self.papi.gbp_subnet_add_del, {'is_add': is_add, 'subnet': { 'type': type, 'sw_if_index': sw_if_index, - 'epg_id': epg_id, + 'sclass': sclass, 'prefix': prefix, 'rd_id': rd_id}}) @@ -3713,37 +2100,19 @@ class VppPapiProvider(object): 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, - 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, - '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 gbp_endpoint_learn_set_inactive_threshold(self, threshold): - """ GBP set inactive threshold """ - return self.api(self.papi.gbp_endpoint_learn_set_inactive_threshold, - {'threshold': threshold}) - - def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode): + 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 + 'bd_rd_id': bd_rd_id, + 'src': src } }) @@ -3758,70 +2127,6 @@ class VppPapiProvider(object): """ GBP VXLAN tunnel add/del """ return self.api(self.papi.gbp_vxlan_tunnel_dump, {}) - def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len, - ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src, - security_check): - """ 6RD tunnel Add """ - return self.api(self.papi.ipip_6rd_add_tunnel, - {'ip4_table_id': ip4_table_id, - 'ip6_table_id': ip6_table_id, - '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, table_id=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, - 'table_id': table_id, - '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 qos_egress_map_update(self, id, outputs): - """ QOS egress map update """ - return self.api(self.papi.qos_egress_map_update, - {'map_id': id, - 'rows': outputs}) - - def qos_egress_map_delete(self, id): - """ QOS egress map delete """ - return self.api(self.papi.qos_egress_map_delete, - {'map_id': id}) - - def qos_mark_enable_disable(self, sw_if_index, - output_source, - map_id, - enable): - """ QOS Mark Enable/Disable """ - return self.api(self.papi.qos_mark_enable_disable, - {'map_id': map_id, - 'sw_if_index': sw_if_index, - '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, @@ -3852,22 +2157,15 @@ class VppPapiProvider(object): return self.api(self.papi.igmp_listen, { 'group': - { - 'filter': filter, - 'sw_if_index': sw_if_index, - 'n_srcs': len(saddrs), - 'saddrs': saddrs, - 'gaddr': gaddr - } + { + 'filter': filter, + 'sw_if_index': sw_if_index, + 'n_srcs': len(saddrs), + 'saddrs': saddrs, + 'gaddr': gaddr + } }) - def igmp_dump(self, sw_if_index=None): - """ Dump all (S,G) interface configurations """ - if sw_if_index is None: - sw_if_index = 0xffffffff - return self.api(self.papi.igmp_dump, - {'sw_if_index': sw_if_index}) - def igmp_clear_interface(self, sw_if_index): """ Remove all (S,G)s from specified interface doesn't send IGMP report! @@ -3884,202 +2182,32 @@ class VppPapiProvider(object): self, mode, lb, + numa_only, use_custom_mac, - mac_address=''): + mac_address='', + interface_id=0xFFFFFFFF): """ :param mode: mode :param lb: load balance + :param numa_only: tx on local numa node for lacp mode :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, - disable_mrg_rxbuf, - disable_indirect_desc, - custom_dev_instance, - use_custom_mac, - mac_address, - tag=''): - """ - :param is_server: is server - :param sock_filename: socket name - :param renumber: renumber - :param disable_mrg_rxbuf: disable mergable rx buffers - :param disable_indirect_desc: disable indirect descriptors - :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, - 'disable_mrg_rxbuf': disable_mrg_rxbuf, - 'disable_indirect_desc': disable_indirect_desc, - 'custom_dev_instance': custom_dev_instance, + 'numa_only': numa_only, '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 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 abf_policy_dump(self): - return self.api( - self.papi.abf_policy_dump, {}) - - def abf_itf_attach_dump(self): - return self.api( - self.papi.abf_itf_attach_dump, {}) - - def pipe_create(self, is_specified, user_instance): - return self.api(self.papi.pipe_create, - {'is_specified': is_specified, - 'user_instance': user_instance}) - def pipe_delete(self, parent_sw_if_index): return self.api(self.papi.pipe_delete, {'parent_sw_if_index': parent_sw_if_index}) - def pipe_dump(self): - return self.api(self.papi.pipe_dump, {}) - - 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 memif_delete(self, sw_if_index): - return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index}) - - def memif_dump(self): - return self.api(self.papi.memif_dump, {}) - - def memif_socket_filename_add_del( - self, is_add, socket_id, socket_filename): - return self.api( - self.papi.memif_socket_filename_add_del, - {'is_add': is_add, - 'socket_id': socket_id, - 'socket_filename': socket_filename}) - - def memif_socket_filename_dump(self): - return self.api(self.papi.memif_socket_filename_dump, {}) - def svs_table_add_del(self, af, table_id, is_add=1): return self.api(self.papi.svs_table_add_del, { @@ -4105,43 +2233,3 @@ class VppPapiProvider(object): 'sw_if_index': sw_if_index, 'is_enable': is_enable, }) - - def svs_dump(self): - return self.api(self.papi.svs_dump, {}) - - def syslog_set_sender( - self, - collector, - src, - collector_port=514, - vrf_id=0, - max_msg_size=480): - """Set syslog sender configuration - - :param collector: colector IP address - :param src: source IP address - :param collector_port: collector UDP port (Default value = 514) - :param vrf_id: VRF id (Default value = 0) - :param max_msg_size: maximum message length (Default value = 480) - """ - return self.api(self.papi.syslog_set_sender, - {'collector_address': collector, - 'src_address': src, - 'collector_port': collector_port, - 'vrf_id': vrf_id, - 'max_msg_size': max_msg_size}) - - def syslog_get_sender(self): - """Return syslog sender configuration""" - return self.api(self.papi.syslog_get_sender, {}) - - def syslog_set_filter(self, severity): - """Set syslog filter parameters - - :param severity: severity filter (specified severity and greater match) - """ - return self.api(self.papi.syslog_set_filter, {'severity': severity}) - - def syslog_get_filter(self): - """Return syslog filter parameters""" - return self.api(self.papi.syslog_get_filter, {})