X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=test%2Fvpp_papi_provider.py;h=f9bb470ec1defcbdb88dfc797d4ffe8a711c8704;hb=038e1dfbd;hp=ed2eee1dc84e275d1e119860373ce8418277e1d7;hpb=8feeaff56fa9a4fbdfc06131f28a1060ffd9645d;p=vpp.git diff --git a/test/vpp_papi_provider.py b/test/vpp_papi_provider.py index ed2eee1dc84..f9bb470ec1d 100644 --- a/test/vpp_papi_provider.py +++ b/test/vpp_papi_provider.py @@ -10,42 +10,11 @@ import time from collections import deque from six import moves, iteritems -from vpp_papi import VPP, mac_pton +from vpp_papi import VPPApiClient, mac_pton from hook import Hook -from vpp_l2 import L2_PORT_TYPE from vpp_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID -class L2_VTR_OP: - 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 - - # # Dictionary keyed on message name to override default values for # named parameters @@ -66,6 +35,8 @@ defaultmapping = { '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, @@ -77,11 +48,10 @@ defaultmapping = { 'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, }, 'dhcp_proxy_config': {'is_add': 1, }, 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, }, - 'dslite_add_del_pool_addr_range': {'is_add': 1, }, 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, }, 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1, 'decap_next_index': 4294967295, }, - 'gre_add_del_tunnel': {'instance': 4294967295, 'is_add': 1, }, + '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, @@ -91,15 +61,14 @@ defaultmapping = { 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, }, 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295, 'next_hop_weight': 1, 'next_hop_via_label': 1048576, - 'next_hop_id': 4294967295, 'classify_table_index': 4294967295, 'is_add': 1, }, 'ip_mroute_add_del': {'is_add': 1, }, 'ip_neighbor_add_del': {'is_add': 1, }, 'ip_punt_police': {'is_add': 1, }, 'ip_punt_redirect': {'is_add': 1, }, + 'ip_route_add_del': {'is_add': 1, }, 'ip_table_add_del': {'is_add': 1, }, 'ip_unnumbered_dump': {'sw_if_index': 4294967295, }, - 'ipip_add_tunnel': {'is_ipv6': 1, 'instance': 4294967295, }, 'ipsec_interface_add_del_spd': {'is_add': 1, }, 'ipsec_sad_entry_add_del': {'is_add': 1, }, 'ipsec_spd_add_del': {'is_add': 1, }, @@ -133,36 +102,6 @@ defaultmapping = { 'next_hop_via_label': 1048576, 'is_add': 1, }, 'mpls_tunnel_dump': {'sw_if_index': 4294967295, }, - 'nat44_add_del_address_range': {'is_add': 1, 'vrf_id': 4294967295, }, - 'nat44_add_del_identity_mapping': {'ip': b'0', 'sw_if_index': 4294967295, - 'addr_only': 1, 'is_add': 1, }, - 'nat44_add_del_interface_addr': {'is_add': 1, }, - 'nat44_add_del_lb_static_mapping': {'is_add': 1, }, - 'nat44_add_del_static_mapping': {'external_sw_if_index': 4294967295, - 'addr_only': 1, 'is_add': 1, }, - 'nat44_del_session': {'is_in': 1, }, - 'nat44_interface_add_del_feature': {'is_inside': 1, 'is_add': 1, }, - 'nat44_interface_add_del_output_feature': {'is_inside': 1, 'is_add': 1, }, - 'nat44_lb_static_mapping_add_del_local': {'is_add': 1, }, - 'nat64_add_del_interface': {'is_inside': 1, 'is_add': 1, }, - 'nat64_add_del_interface_addr': {'is_add': 1, }, - 'nat64_add_del_pool_addr_range': {'vrf_id': 4294967295, 'is_add': 1, }, - 'nat64_add_del_prefix': {'is_add': 1, }, - 'nat64_add_del_static_bib': {'is_add': 1, }, - 'nat64_bib_dump': {'protocol': 255, }, - 'nat64_st_dump': {'protocol': 255, }, - 'nat66_add_del_interface': {'is_inside': 1, 'is_add': 1, }, - 'nat66_add_del_static_mapping': {'is_add': 1, }, - 'nat_det_add_del_map': {'is_add': 1, }, - 'nat_ha_resync': {'want_resync_event': 1, }, - 'nat_ha_set_failover': {'refresh': 10, }, - 'nat_ha_set_listener': {'path_mtu': 512, }, - 'nat_ipfix_enable_disable': {'domain_id': 1, 'src_port': 4739, - 'enable': 1, }, - 'nat_set_mss_clamping': {'mss_value': 1500, }, - 'nat_set_reass': {'timeout': 2, 'max_reass': 1024, 'max_frag': 5, }, - 'nat_set_timeouts': {'udp': 300, 'tcp_established': 7440, - 'tcp_transitory': 240, 'icmp': 60, }, 'output_acl_set_interface': {'ip4_table_index': 4294967295, 'ip6_table_index': 4294967295, 'l2_table_index': 4294967295, }, @@ -170,10 +109,6 @@ defaultmapping = { 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, }, 'proxy_arp_add_del': {'is_add': 1, }, 'proxy_arp_intfc_enable_disable': {'is_enable': 1, }, - 'punt_socket_register': {'protocol': 17, 'header_version': 1, - 'is_ip4': 1, }, - 'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, }, - 'punt_socket_dump': {'is_ip6': 1, }, 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1, 'proto': 1, }, 'set_ipfix_exporter': {'collector_port': 4739, }, @@ -183,6 +118,7 @@ defaultmapping = { '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, }, @@ -194,8 +130,6 @@ defaultmapping = { 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1, 'decap_next_index': 4294967295, 'instance': 4294967295, }, - 'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1, - 'instance': 4294967295, }, 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, }, 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1, 'protocol': 3, }, @@ -211,6 +145,14 @@ defaultmapping = { } +class CliFailedCommandError(Exception): + """ cli command failed.""" + + +class CliSyntaxError(Exception): + """ cli command had a syntax error.""" + + class UnexpectedApiReturnValueError(Exception): """ exception raised when the API return value is unexpected """ pass @@ -232,14 +174,21 @@ class VppPapiProvider(object): self._expect_api_retval = self._zero self._expect_stack = [] - install_dir = os.getenv('VPP_INSTALL_PATH') - - # Vapi requires 'VPP_API_DIR', not set when run from Makefile. - if 'VPP_API_DIR' not in os.environ: - os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH') + # install_dir is a class attribute. We need to set it before + # calling the constructor. + VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH') - self.vpp = VPP(logger=test_class.logger, - read_timeout=read_timeout) + 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): @@ -379,7 +328,7 @@ class VppPapiProvider(object): 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)) + repr(reply)) self.test_class.logger.info(msg) raise UnexpectedApiReturnValueError(msg) else: @@ -400,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 @@ -551,6 +504,37 @@ class VppPapiProvider(object): return self.api(self.papi.create_loopback, {'mac_address': mac}) + def ip_table_add_del(self, + table_id, + is_add=1, + is_ipv6=0): + """ + + :param table_id + :param is_add: (Default value = 1) + :param is_ipv6: (Default value = 0) + + """ + + return self.api( + self.papi.ip_table_add_del, + {'table': + { + '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, {}) + + 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, @@ -616,15 +600,14 @@ class VppPapiProvider(object): } ) - def gre_add_del_tunnel(self, - src_address, - dst_address, + def gre_tunnel_add_del(self, + 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: @@ -638,15 +621,17 @@ class VppPapiProvider(object): """ 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, @@ -675,6 +660,26 @@ class VppPapiProvider(object): } }) + def udp_encap_del(self, id): + return self.api(self.papi.udp_encap_del, {'id': id}) + + def udp_encap_dump(self): + return self.api(self.papi.udp_encap_dump, {}) + + def want_udp_encap_stats(self, enable=1): + return self.api(self.papi.want_udp_encap_stats, + {'enable': enable, + 'pid': os.getpid()}) + + def mpls_route_dump(self, table_id): + return self.api(self.papi.mpls_route_dump, + {'table': { + 'mt_table_id': table_id + }}) + + def mpls_table_dump(self): + return self.api(self.papi.mpls_table_dump, {}) + def mpls_table_add_del( self, table_id, @@ -688,17 +693,43 @@ class VppPapiProvider(object): return self.api( self.papi.mpls_table_add_del, - {'mt_table_id': table_id, + {'mt_table': + { + 'mt_table_id': table_id, + }, 'mt_is_add': is_add}) + 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.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 mpls_ip_bind_unbind( self, label, - dst_address, - dst_address_length, + prefix, table_id=0, ip_table_id=0, - is_ip4=1, is_bind=1): """ """ @@ -708,615 +739,28 @@ class VppPapiProvider(object): '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}) + 'mb_prefix': prefix}) 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, + paths, 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) - """ 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 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=b'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 extenral 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_add_del_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 external 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_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 service - :param external_port: external L4 port number of the service - :param local_addr: IPv4 address of the internal node - :param local_port: L4 port number of the internal node - :param protocol: IP protocol number - :param probability: probability of the internal node - :param vrf_id: VRF id of the internal node - :param is_add: 1 if add, 0 if delete - """ - return self.api( - self.papi.nat44_lb_static_mapping_add_del_local, - {'is_add': is_add, - 'external_addr': external_addr, - 'external_port': external_port, - 'local': { - 'addr': local_addr, - 'port': local_port, - 'probability': probability, - 'vrf_id': vrf_id}, - 'protocol': protocol}) - - def nat44_del_session( - self, - 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 address and port pair, 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_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_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_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_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_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_st_dump(self, protocol=255): - """Dump NAT64 session table - - :param protocol: IP protocol (Default value = 255, all STs) - :returns: Dictionary of NAT64 session 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_add_del_interface_addr( - self, - sw_if_index, - 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 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 nat66_add_del_interface( - 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) - """ - 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}) - - def nat_ha_set_listener(self, addr, port, path_mtu=512): - """Set HA listener (local settings) - - :param addr: local IP4 address - :param port: local UDP port number - :param path_mtu: path MTU (Default value = 512) - """ - return self.api(self.papi.nat_ha_set_listener, - {'ip_address': addr, - 'port': port, - 'path_mtu': path_mtu}) - - def nat_ha_get_listener(self): - """Get HA listener/local configuration""" - return self.api(self.papi.nat_ha_get_listener, {}) - - def nat_ha_set_failover(self, addr, port, refresh=10): - """Set HA failover (remote settings) - - :param addr: failover IP4 address - :param port: failover UDP port number - :param refresh: number of seconds after which to send session refresh - """ - return self.api(self.papi.nat_ha_set_failover, - {'ip_address': addr, - 'port': port, - 'session_refresh_interval': refresh}) - - def nat_ha_resync(self, want_resync_event=1): - """Resync HA (resend existing sessions to new failover) - :param want_resync_event: if non-zero resync completed event sent - """ - return self.api(self.papi.nat_ha_resync, - {'want_resync_event': want_resync_event, - 'pid': os.getpid()}) + {'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, @@ -1588,7 +1032,8 @@ class VppPapiProvider(object): client_id='', is_add=1, set_broadcast_flag=1, - want_dhcp_events=0): + want_dhcp_events=0, + dscp=0): return self.api( self.papi.dhcp_client_config, { @@ -1599,43 +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_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( @@ -1828,41 +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, - mode=1, - instance=0xFFFFFFFF): - """ - - :param dst_addr: - :param src_addr: - :param is_add: (Default value = 1) - :param is_ipv6: (Default value = 0) - :param encap_table_id: (Default value = 0) - :param decap_next_index: (Default value = 0xFFFFFFFF) - :param mcast_sw_if_index: (Default value = 0xFFFFFFFF) - :param vni: (Default value = 0) - :param instance: (Default value = 0xFFFFFFFF) - - """ - return self.api(self.papi.vxlan_gbp_tunnel_add_del, - {'is_add': is_add, - 'tunnel': { - 'src': src, - 'dst': dst, - 'mcast_sw_if_index': mcast_sw_if_index, - 'encap_table_id': encap_table_id, - 'vni': vni, - 'instance': instance, - "mode": mode}}) - def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff): return self.api(self.papi.vxlan_gbp_tunnel_dump, {'sw_if_index': sw_if_index, @@ -2232,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( @@ -2304,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}], @@ -2370,6 +1784,7 @@ class VppPapiProvider(object): tunnel_src_address='', tunnel_dst_address='', flags=0, + salt=0, is_add=1): """ IPSEC SA add/del :param sad_id: security association ID @@ -2408,6 +1823,7 @@ class VppPapiProvider(object): 'data': crypto_key, }, 'flags': flags, + 'salt': salt, } }) @@ -2473,7 +1889,6 @@ class VppPapiProvider(object): 'policy': policy, 'priority': priority, 'is_outbound': is_outbound, - 'is_ip_any': is_ip_any } }) @@ -2485,8 +1900,9 @@ class VppPapiProvider(object): 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, { @@ -2508,7 +1924,9 @@ class VppPapiProvider(object): 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber, - 'show_instance': show_instance + 'show_instance': show_instance, + 'udp_encap': udp_encap, + 'salt': salt }) def ipsec_select_backend(self, protocol, index): @@ -2533,27 +1951,18 @@ 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}) + {'punt': reg}) def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags, tun_src, tun_dst): @@ -2601,7 +2010,7 @@ class VppPapiProvider(object): return self.api(self.papi.gbp_endpoint_group_del, {'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, bm_flood_sw_if_index): @@ -2613,7 +2022,8 @@ class VppPapiProvider(object): '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 + 'bd_id': bd_id, + 'rd_id': rd_id }}) def gbp_bridge_domain_del(self, bd_id): @@ -2622,6 +2032,7 @@ class VppPapiProvider(object): {'bd_id': bd_id}) def gbp_route_domain_add(self, rd_id, + scope, ip4_table_id, ip6_table_id, ip4_uu_sw_if_index, @@ -2630,6 +2041,7 @@ class VppPapiProvider(object): return self.api(self.papi.gbp_route_domain_add, {'rd': { + 'scope': scope, 'ip4_table_id': ip4_table_id, 'ip6_table_id': ip6_table_id, 'ip4_uu_sw_if_index': ip4_uu_sw_if_index, @@ -2655,14 +2067,15 @@ class VppPapiProvider(object): """ 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 """ @@ -2687,20 +2100,6 @@ class VppPapiProvider(object): return self.api(self.papi.gbp_subnet_dump, {'_no_type_conversion': True}) - def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index, - rules, allowed_ethertypes): - """ GBP contract Add/Del """ - return self.api(self.papi.gbp_contract_add_del, - {'is_add': is_add, - 'contract': { - 'acl_index': acl_index, - 'sclass': sclass, - 'dclass': dclass, - 'n_rules': len(rules), - 'rules': rules, - 'n_ether_types': len(allowed_ethertypes), - 'allowed_ethertypes': allowed_ethertypes}}) - def gbp_contract_dump(self): """ GBP contract Dump """ return self.api(self.papi.gbp_contract_dump, {}) @@ -2728,28 +2127,6 @@ class VppPapiProvider(object): """ GBP VXLAN tunnel add/del """ return self.api(self.papi.gbp_vxlan_tunnel_dump, {}) - def qos_egress_map_update(self, id, outputs): - """ QOS egress map update """ - 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 igmp_enable_disable(self, sw_if_index, enable, host): """ Enable/disable IGMP on a given interface """ return self.api(self.papi.igmp_enable_disable, @@ -2805,12 +2182,14 @@ class VppPapiProvider(object): self, mode, lb, + numa_only, use_custom_mac, 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 @@ -2819,6 +2198,7 @@ class VppPapiProvider(object): self.papi.bond_create, {'mode': mode, 'lb': lb, + 'numa_only': numa_only, 'use_custom_mac': use_custom_mac, 'mac_address': mac_address, 'id': interface_id @@ -2828,30 +2208,6 @@ class VppPapiProvider(object): return self.api(self.papi.pipe_delete, {'parent_sw_if_index': parent_sw_if_index}) - def memif_create( - self, - role, - mode, - rx_queues=None, - tx_queues=None, - _id=None, - socket_id=None, - secret=None, - ring_size=None, - buffer_size=None, - hw_addr=None): - return self.api(self.papi.memif_create, - {'role': role, - 'mode': mode, - 'rx_queues': rx_queues, - 'tx_queues': tx_queues, - 'id': _id, - 'socket_id': socket_id, - 'secret': secret, - 'ring_size': ring_size, - 'buffer_size': buffer_size, - 'hw_addr': hw_addr}) - def svs_table_add_del(self, af, table_id, is_add=1): return self.api(self.papi.svs_table_add_del, {