X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=test%2Fvpp_papi_provider.py;h=3fdb428e19ff0aabbc0e1e9ff8e2419f9faf8d7f;hb=16a14cdb160160573e2d1ed69a52998cc30ce34f;hp=10445de625cb77d0eecadc41c11cd277b409c0d2;hpb=0178d52384e0428368f1acf3163e664ecda7b64c;p=vpp.git diff --git a/test/vpp_papi_provider.py b/test/vpp_papi_provider.py index 10445de625c..3fdb428e19f 100644 --- a/test/vpp_papi_provider.py +++ b/test/vpp_papi_provider.py @@ -1,7 +1,13 @@ import os -from logging import error +import fnmatch +import time from hook import Hook +from collections import deque +# Sphinx creates auto-generated documentation by importing the python source +# files and collecting the docstrings from them. The NO_VPP_PAPI flag allows the +# vpp_papi_provider.py file to be importable without having to build the whole +# vpp api if the user only wishes to generate the test documentation. do_import = True try: no_vpp_papi = os.getenv("NO_VPP_PAPI") @@ -11,14 +17,17 @@ except: pass if do_import: - import vpp_papi - + from vpp_papi import VPP # from vnet/vnet/mpls/mpls_types.h MPLS_IETF_MAX_LABEL = 0xfffff MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1 +class L2_VTR_OP: + L2_POP_1 = 3 + + class VppPapiProvider(object): """VPP-api provider using vpp-papi @@ -27,10 +36,20 @@ class VppPapiProvider(object): """ - def __init__(self, name, shm_prefix): + def __init__(self, name, shm_prefix, test_class): self.hook = Hook("vpp-papi-provider") self.name = name self.shm_prefix = shm_prefix + self.test_class = test_class + jsonfiles = [] + + install_dir = os.getenv('VPP_TEST_INSTALL_PATH') + for root, dirnames, filenames in os.walk(install_dir): + for filename in fnmatch.filter(filenames, '*.api.json'): + jsonfiles.append(os.path.join(root, filename)) + + self.papi = VPP(jsonfiles) + self._events = deque() def register_hook(self, hook): """Replace hook registration with new hook @@ -40,16 +59,50 @@ class VppPapiProvider(object): """ self.hook = hook + def collect_events(self): + """ Collect all events from the internal queue and clear the queue. """ + e = self._events + self._events = deque() + return e + + def wait_for_event(self, timeout, name=None): + """ Wait for and return next event. """ + if self._events: + self.test_class.logger.debug("Not waiting, event already queued") + limit = time.time() + timeout + while time.time() < limit: + if self._events: + e = self._events.popleft() + if name and type(e).__name__ != name: + raise Exception( + "Unexpected event received: %s, expected: %s" % + (type(e).__name__, name)) + self.test_class.logger.debug("Returning event %s:%s" % + (name, e)) + return e + time.sleep(0) # yield + if name is not None: + raise Exception("Event %s did not occur within timeout" % name) + raise Exception("Event did not occur within timeout") + + def __call__(self, name, event): + """ Enqueue event in the internal event queue. """ + # FIXME use the name instead of relying on type(e).__name__ ? + # FIXME #2 if this throws, it is eaten silently, Ole? + self.test_class.logger.debug("New event: %s: %s" % (name, event)) + self._events.append(event) + def connect(self): """Connect the API to VPP""" - vpp_papi.connect(self.name, self.shm_prefix) + self.papi.connect(self.name, self.shm_prefix) + self.papi.register_event_callback(self) def disconnect(self): """Disconnect the API from VPP""" - vpp_papi.disconnect() + self.papi.disconnect() def api(self, api_fn, api_args, expected_retval=0): - """Call API function and check it's return value + """ Call API function and check it's return value. Call the appropriate hooks before and after the API call :param api_fn: API function to call @@ -59,17 +112,17 @@ class VppPapiProvider(object): """ self.hook.before_api(api_fn.__name__, api_args) - reply = api_fn(*api_args) + reply = api_fn(**api_args) if hasattr(reply, 'retval') and reply.retval != expected_retval: msg = "API call failed, expected retval == %d, got %s" % ( expected_retval, repr(reply)) - error(msg) + self.test_class.logger.info(msg) raise Exception(msg) self.hook.after_api(api_fn.__name__, api_args) return reply def cli(self, cli): - """Execute a CLI, calling the before/after hooks appropriately + """ Execute a CLI, calling the before/after hooks appropriately. :param cli: CLI to execute :returns: CLI output @@ -77,14 +130,25 @@ class VppPapiProvider(object): """ self.hook.before_cli(cli) cli += '\n' - r = vpp_papi.cli_inband(len(cli), cli) + r = self.papi.cli_inband(length=len(cli), cmd=cli) self.hook.after_cli(cli) - if(hasattr(r, 'reply')): - return r.reply[0].decode().rstrip('\x00') + if hasattr(r, 'reply'): + return r.reply.decode().rstrip('\x00') + + def ppcli(self, cli): + """ Helper method to print CLI command in case of info logging level. + + :param cli: CLI to execute + :returns: CLI output + """ + return cli + "\n" + str(self.cli(cli)) + + def _convert_mac(self, mac): + return int(mac.replace(":", ""), 16) << 16 def show_version(self): """ """ - return vpp_papi.show_version() + return self.papi.show_version() def pg_create_interface(self, pg_index): """ @@ -92,7 +156,8 @@ class VppPapiProvider(object): :param pg_index: """ - return self.api(vpp_papi.pg_create_interface, (pg_index, )) + return self.api(self.papi.pg_create_interface, + {"interface_id": pg_index}) def sw_interface_dump(self, filter=None): """ @@ -101,22 +166,22 @@ class VppPapiProvider(object): """ if filter is not None: - args = (1, filter) + args = {"name_filter_valid": 1, "name_filter": filter} else: - args = (0, b'') - return self.api(vpp_papi.sw_interface_dump, args) + 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 + """ Set the IPvX Table-id for the Interface :param sw_if_index: :param is_ipv6: :param table_id: """ - return self.api(vpp_papi.sw_interface_set_table, - (sw_if_index, is_ipv6, table_id)) + return self.api(self.papi.sw_interface_set_table, + {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6, + 'vrf_id': table_id}) def sw_interface_add_del_address(self, sw_if_index, addr, addr_len, is_ipv6=0, is_add=1, del_all=0): @@ -130,8 +195,13 @@ class VppPapiProvider(object): :param del_all: (Default value = 0) """ - return self.api(vpp_papi.sw_interface_add_del_address, - (sw_if_index, is_add, is_ipv6, del_all, addr_len, addr)) + return self.api(self.papi.sw_interface_add_del_address, + {'sw_if_index': sw_if_index, + 'is_add': is_add, + 'is_ipv6': is_ipv6, + 'del_all': del_all, + 'address_length': addr_len, + 'address': addr}) def sw_interface_enable_disable_mpls(self, sw_if_index, is_enable=1): @@ -141,34 +211,19 @@ class VppPapiProvider(object): :param is_enable: (Default value = 1) """ - return self.api(vpp_papi.sw_interface_set_mpls_enable, - (sw_if_index, is_enable)) + 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 - managed = 0 - other = 0 - ll_option = 0 - send_unicast = 0 - cease = 0 - is_no = 0 - default_router = 0 - max_interval = 0 - min_interval = 0 - lifetime = 0 - initial_count = 0 - initial_interval = 0 - async = False - return self.api(vpp_papi.sw_interface_ip6nd_ra_config, - (sw_if_index, suppress, managed, other, - ll_option, send_unicast, cease, is_no, - default_router, max_interval, min_interval, - lifetime, initial_count, initial_interval, async)) + return self.api(self.papi.sw_interface_ip6nd_ra_config, + {'sw_if_index': sw_if_index}) 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, @@ -182,43 +237,155 @@ class VppPapiProvider(object): :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(vpp_papi.vxlan_add_del_tunnel, - (is_add, is_ipv6, src_addr, dst_addr, encap_vrf_id, - decap_next_index, vni)) + 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}) + + 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 l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0, + filter_mac=0, bvi_mac=0): + """Create/delete L2 FIB entry. + + :param str mac: MAC address to create FIB entry for. + :param int bd_id: Bridge domain index. + :param int sw_if_index: Software interface index of the interface. + :param int is_add: Add or delete flag. (Default value = 1) + :param int static_mac: Set to 1 to create static MAC entry. + (Default value = 0) + :param int filter_mac: Set to 1 to drop packet that's source or + destination MAC address contains defined MAC address. + (Default value = 0) + :param int bvi_mac: Set to 1 to create entry that points to BVI + interface. (Default value = 0) + """ + return self.api(self.papi.l2fib_add_del, + {'mac': self._convert_mac(mac), + 'bd_id': bd_id, + 'sw_if_index': sw_if_index, + 'is_add': is_add, + 'static_mac': static_mac, + 'filter_mac': filter_mac, + 'bvi_mac': bvi_mac}) def sw_interface_set_l2_bridge(self, sw_if_index, bd_id, shg=0, bvi=0, enable=1): + """Add/remove interface to/from bridge domain. + + :param int sw_if_index: Software interface index of the interface. + :param int bd_id: Bridge domain index. + :param int shg: Split-horizon group index. (Default value = 0) + :param int bvi: Set interface as a bridge group virtual interface. + (Default value = 0) + :param int enable: Add or remove interface. (Default value = 1) + """ + return self.api(self.papi.sw_interface_set_l2_bridge, + {'rx_sw_if_index': sw_if_index, + 'bd_id': bd_id, + 'shg': shg, + 'bvi': bvi, + 'enable': enable}) + + def bridge_flags(self, bd_id, is_set, feature_bitmap): + """Enable/disable required feature of the bridge domain with defined ID. + + :param int bd_id: Bridge domain ID. + :param int is_set: Set to 1 to enable, set to 0 to disable the feature. + :param int feature_bitmap: Bitmap value of the feature to be set: + - learn (1 << 0), + - forward (1 << 1), + - flood (1 << 2), + - uu-flood (1 << 3) or + - arp-term (1 << 4). """ + return self.api(self.papi.bridge_flags, + {'bd_id': bd_id, + 'is_set': is_set, + 'feature_bitmap': feature_bitmap}) - :param bd_id: - :param sw_if_index: - :param shg: (Default value = 0) - :param bvi: (Default value = 0) - :param enable: (Default value = 1) + 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(vpp_papi.sw_interface_set_l2_bridge, - (sw_if_index, bd_id, shg, bvi, enable)) + 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 rx_sw_if_index: Software interface index of Rx interface. - :param tx_sw_if_index: Software interface index of Tx interface. - :param enable: Create cross-connect if equal to 1, delete cross-connect - if equal to 0. - :type rx_sw_if_index: str or int - :type rx_sw_if_index: str or int - :type enable: int + :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(vpp_papi.sw_interface_set_l2_xconnect, - (rx_sw_if_index, tx_sw_if_index, enable)) + 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_flags(self, sw_if_index, admin_up_down, link_up_down=0, deleted=0): @@ -230,8 +397,11 @@ class VppPapiProvider(object): :param deleted: (Default value = 0) """ - return self.api(vpp_papi.sw_interface_set_flags, - (sw_if_index, admin_up_down, link_up_down, deleted)) + return self.api(self.papi.sw_interface_set_flags, + {'sw_if_index': sw_if_index, + 'admin_up_down': admin_up_down, + 'link_up_down': link_up_down, + 'deleted': deleted}) 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, @@ -254,19 +424,27 @@ class VppPapiProvider(object): """ return self.api( - vpp_papi.create_subif, - (sw_if_index, - sub_id, - no_tags, - one_tag, - two_tags, - dot1ad, - exact_match, - default_sub, - outer_vlan_id_any, - inner_vlan_id_any, - outer_vlan, - inner_vlan)) + 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 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 create_vlan_subif(self, sw_if_index, vlan): """ @@ -275,14 +453,17 @@ class VppPapiProvider(object): :param sw_if_index: """ - return self.api(vpp_papi.create_vlan_subif, (sw_if_index, vlan)) + return self.api(self.papi.create_vlan_subif, + {'sw_if_index': sw_if_index, + 'vlan_id': vlan}) def create_loopback(self, mac=''): """ :param mac: (Optional) """ - return self.api(vpp_papi.create_loopback, (mac,)) + return self.api(self.papi.create_loopback, + {'mac_address': mac}) def ip_add_del_route( self, @@ -291,12 +472,15 @@ class VppPapiProvider(object): next_hop_address, next_hop_sw_if_index=0xFFFFFFFF, table_id=0, - resolve_attempts=0, - classify_table_index=0xFFFFFFFF, - next_hop_out_label=MPLS_LABEL_INVALID, 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, create_vrf_if_needed=0, - resolve_if_needed=0, + is_resolve_host=0, + is_resolve_attached=0, + classify_table_index=0xFFFFFFFF, is_add=1, is_drop=0, is_unreach=0, @@ -305,10 +489,7 @@ class VppPapiProvider(object): is_local=0, is_classify=0, is_multipath=0, - is_resolve_host=0, - is_resolve_attached=0, - not_last=0, - next_hop_weight=1): + not_last=0): """ :param dst_address_length: @@ -318,10 +499,8 @@ class VppPapiProvider(object): :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF) :param vrf_id: (Default value = 0) :param lookup_in_vrf: (Default value = 0) - :param resolve_attempts: (Default value = 0) :param classify_table_index: (Default value = 0xFFFFFFFF) :param create_vrf_if_needed: (Default value = 0) - :param resolve_if_needed: (Default value = 0) :param is_add: (Default value = 1) :param is_drop: (Default value = 0) :param is_ipv6: (Default value = 0) @@ -334,31 +513,35 @@ class VppPapiProvider(object): :param next_hop_weight: (Default value = 1) """ + return self.api( - vpp_papi.ip_add_del_route, - (next_hop_sw_if_index, - table_id, - resolve_attempts, - classify_table_index, - next_hop_out_label, - next_hop_table_id, - create_vrf_if_needed, - resolve_if_needed, - is_add, - is_drop, - is_unreach, - is_prohibit, - is_ipv6, - is_local, - is_classify, - is_multipath, - is_resolve_host, - is_resolve_attached, - not_last, - next_hop_weight, - dst_address_length, - dst_address, - next_hop_address)) + 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, + 'create_vrf_if_needed': create_vrf_if_needed, + '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, + 'not_last': not_last, + 'next_hop_weight': next_hop_weight, + 'dst_address_length': dst_address_length, + 'dst_address': dst_address, + '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 ip_neighbor_add_del(self, sw_if_index, @@ -381,13 +564,321 @@ class VppPapiProvider(object): """ return self.api( - vpp_papi.ip_neighbor_add_del, - (vrf_id, - sw_if_index, - is_add, - is_ipv6, - is_static, - mac_address, - dst_address - ) + self.papi.ip_neighbor_add_del, + {'vrf_id': vrf_id, + 'sw_if_index': sw_if_index, + 'is_add': is_add, + 'is_ipv6': is_ipv6, + 'is_static': is_static, + 'mac_address': mac_address, + 'dst_address': dst_address + } + ) + + def sw_interface_span_enable_disable( + self, sw_if_index_from, sw_if_index_to, state=1): + """ + + :param sw_if_index_from: + :param sw_if_index_to: + :param enable + + """ + 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}) + + def gre_tunnel_add_del(self, + src_address, + dst_address, + outer_fib_id=0, + is_teb=0, + is_add=1, + is_ip6=0): + """ Add a GRE tunnel + + :param src_address: + :param dst_address: + :param outer_fib_id: (Default value = 0) + :param is_add: (Default value = 1) + :param is_ipv6: (Default value = 0) + :param is_teb: (Default value = 0) + """ + + return self.api( + self.papi.gre_add_del_tunnel, + {'is_add': is_add, + 'is_ipv6': is_ip6, + 'teb': is_teb, + 'src_address': src_address, + 'dst_address': dst_address, + 'outer_fib_id': outer_fib_id} ) + + def mpls_route_add_del( + self, + label, + eos, + next_hop_proto_is_ip4, + 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, + create_vrf_if_needed=0, + is_resolve_host=0, + is_resolve_attached=0, + is_add=1, + is_drop=0, + is_multipath=0, + classify_table_index=0xFFFFFFFF, + is_classify=0, + not_last=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 create_vrf_if_needed: (Default value = 0) + :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 not_last: (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_create_table_if_needed': create_vrf_if_needed, + 'mr_is_add': is_add, + 'mr_is_classify': is_classify, + 'mr_is_multipath': is_multipath, + 'mr_is_resolve_host': is_resolve_host, + 'mr_is_resolve_attached': is_resolve_attached, + 'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4, + '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, + create_vrf_if_needed=0, + 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_create_table_if_needed': create_vrf_if_needed, + '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, + create_vrf_if_needed=0, + is_add=1, + l2_only=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 create_vrf_if_needed: (Default value = 0) + :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 not_last: (Default value = 0) + :param next_hop_weight: (Default value = 1) + + """ + 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_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_out_label_stack': next_hop_out_label_stack}) + + def snat_interface_add_del_feature( + self, + sw_if_index, + is_inside=1, + is_add=1): + """Enable/disable S-NAT 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.snat_interface_add_del_feature, + {'is_add': is_add, + 'is_inside': is_inside, + 'sw_if_index': sw_if_index}) + + def snat_add_static_mapping( + self, + local_ip, + external_ip, + local_port=0, + external_port=0, + addr_only=1, + vrf_id=0, + is_add=1, + is_ip4=1): + """Add/delete S-NAT static mapping + + :param local_ip: Local IP address + :param external_ip: External 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 is_add: 1 if add, 0 if delete (Default value = 1) + :param is_ip4: 1 if address type is IPv4 (Default value = 1) + """ + return self.api( + self.papi.snat_add_static_mapping, + {'is_add': is_add, + 'is_ip4': is_ip4, + 'addr_only': addr_only, + 'local_ip_address': local_ip, + 'external_ip_address': external_ip, + 'local_port': local_port, + 'external_port': external_port, + 'vrf_id': vrf_id}) + + def snat_add_address_range( + self, + first_ip_address, + last_ip_address, + is_add=1, + is_ip4=1): + """Add/del S-NAT address range + + :param first_ip_address: First IP address + :param last_ip_address: Last IP address + :param is_add: 1 if add, 0 if delete (Default value = 1) + :param is_ip4: 1 if address type is IPv4 (Default value = 1) + """ + return self.api( + self.papi.snat_add_address_range, + {'is_ip4': is_ip4, + 'first_ip_address': first_ip_address, + 'last_ip_address': last_ip_address, + 'is_add': is_add}) + + def snat_address_dump(self): + """Dump S-NAT addresses + :return: Dictionary of S-NAT addresses + """ + return self.api(self.papi.snat_address_dump, {}) + + def snat_interface_dump(self): + """Dump interfaces with S-NAT feature + :return: Dictionary of interfaces with S-NAT feature + """ + return self.api(self.papi.snat_interface_dump, {}) + + def snat_static_mapping_dump(self): + """Dump S-NAT static mappings + :return: Dictionary of S-NAT static mappings + """ + return self.api(self.papi.snat_static_mapping_dump, {}) + + def control_ping(self): + self.api(self.papi.control_ping) + + def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx, + detect_mult, local_addr, peer_addr, is_ipv6=0): + return self.api(self.papi.bfd_udp_add, + { + 'sw_if_index': sw_if_index, + 'desired_min_tx': desired_min_tx, + 'required_min_rx': required_min_rx, + 'local_addr': local_addr, + 'peer_addr': peer_addr, + 'is_ipv6': is_ipv6, + 'detect_mult': detect_mult, + }) + + 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_session_set_flags(self, bs_idx, admin_up_down): + return self.api(self.papi.bfd_session_set_flags, { + 'bs_index': bs_idx, + 'admin_up_down': admin_up_down, + }) + + def want_bfd_events(self, enable_disable=1): + return self.api(self.papi.want_bfd_events, { + 'enable_disable': enable_disable, + 'pid': os.getpid(), + })