test/vpp_papi_provider.py

   1 import os
   2 import fnmatch
   3 import time
   4 from hook import Hook
   5 from collections import deque
   6
   7 # Sphinx creates auto-generated documentation by importing the python source
   8 # files and collecting the docstrings from them. The NO_VPP_PAPI flag allows the
   9 # vpp_papi_provider.py file to be importable without having to build the whole
  10 # vpp api if the user only wishes to generate the test documentation.
  11 do_import = True
  12 try:
  13     no_vpp_papi = os.getenv("NO_VPP_PAPI")
  14     if no_vpp_papi == "1":
  15         do_import = False
  16 except:
  17     pass
  18
  19 if do_import:
  20     from vpp_papi import VPP
  21
  22 # from vnet/vnet/mpls/mpls_types.h
  23 MPLS_IETF_MAX_LABEL = 0xfffff
  24 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
  25
  26
  27 class L2_VTR_OP:
  28     L2_POP_1 = 3
  29
  30
  31 class VppPapiProvider(object):
  32     """VPP-api provider using vpp-papi
  33
  34     @property hook: hook object providing before and after api/cli hooks
  35
  36
  37     """
  38
  39     def __init__(self, name, shm_prefix, test_class):
  40         self.hook = Hook("vpp-papi-provider")
  41         self.name = name
  42         self.shm_prefix = shm_prefix
  43         self.test_class = test_class
  44         jsonfiles = []
  45
  46         install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
  47         for root, dirnames, filenames in os.walk(install_dir):
  48             for filename in fnmatch.filter(filenames, '*.api.json'):
  49                 jsonfiles.append(os.path.join(root, filename))
  50
  51         self.papi = VPP(jsonfiles)
  52         self._events = deque()
  53
  54     def register_hook(self, hook):
  55         """Replace hook registration with new hook
  56
  57         :param hook:
  58
  59         """
  60         self.hook = hook
  61
  62     def collect_events(self):
  63         """ Collect all events from the internal queue and clear the queue. """
  64         e = self._events
  65         self._events = deque()
  66         return e
  67
  68     def wait_for_event(self, timeout, name=None):
  69         """ Wait for and return next event. """
  70         if self._events:
  71             self.test_class.logger.debug("Not waiting, event already queued")
  72         limit = time.time() + timeout
  73         while time.time() < limit:
  74             if self._events:
  75                 e = self._events.popleft()
  76                 if name and type(e).__name__ != name:
  77                     raise Exception(
  78                         "Unexpected event received: %s, expected: %s" %
  79                         (type(e).__name__, name))
  80                 self.test_class.logger.debug("Returning event %s:%s" %
  81                                              (name, e))
  82                 return e
  83             time.sleep(0)  # yield
  84         if name is not None:
  85             raise Exception("Event %s did not occur within timeout" % name)
  86         raise Exception("Event did not occur within timeout")
  87
  88     def __call__(self, name, event):
  89         """ Enqueue event in the internal event queue. """
  90         # FIXME use the name instead of relying on type(e).__name__ ?
  91         # FIXME #2 if this throws, it is eaten silently, Ole?
  92         self.test_class.logger.debug("New event: %s: %s" % (name, event))
  93         self._events.append(event)
  94
  95     def connect(self):
  96         """Connect the API to VPP"""
  97         self.papi.connect(self.name, self.shm_prefix)
  98         self.papi.register_event_callback(self)
  99
 100     def disconnect(self):
 101         """Disconnect the API from VPP"""
 102         self.papi.disconnect()
 103
 104     def api(self, api_fn, api_args, expected_retval=0):
 105         """ Call API function and check it's return value.
 106         Call the appropriate hooks before and after the API call
 107
 108         :param api_fn: API function to call
 109         :param api_args: tuple of API function arguments
 110         :param expected_retval: Expected return value (Default value = 0)
 111         :returns: reply from the API
 112
 113         """
 114         self.hook.before_api(api_fn.__name__, api_args)
 115         reply = api_fn(**api_args)
 116         if hasattr(reply, 'retval') and reply.retval != expected_retval:
 117             msg = "API call failed, expected retval == %d, got %s" % (
 118                 expected_retval, repr(reply))
 119             self.test_class.logger.info(msg)
 120             raise Exception(msg)
 121         self.hook.after_api(api_fn.__name__, api_args)
 122         return reply
 123
 124     def cli(self, cli):
 125         """ Execute a CLI, calling the before/after hooks appropriately.
 126
 127         :param cli: CLI to execute
 128         :returns: CLI output
 129
 130         """
 131         self.hook.before_cli(cli)
 132         cli += '\n'
 133         r = self.papi.cli_inband(length=len(cli), cmd=cli)
 134         self.hook.after_cli(cli)
 135         if hasattr(r, 'reply'):
 136             return r.reply.decode().rstrip('\x00')
 137
 138     def ppcli(self, cli):
 139         """ Helper method to print CLI command in case of info logging level.
 140
 141         :param cli: CLI to execute
 142         :returns: CLI output
 143         """
 144         return cli + "\n" + str(self.cli(cli))
 145
 146     def _convert_mac(self, mac):
 147         return int(mac.replace(":", ""), 16) << 16
 148
 149     def show_version(self):
 150         """ """
 151         return self.papi.show_version()
 152
 153     def pg_create_interface(self, pg_index):
 154         """
 155
 156         :param pg_index:
 157
 158         """
 159         return self.api(self.papi.pg_create_interface,
 160                         {"interface_id": pg_index})
 161
 162     def sw_interface_dump(self, filter=None):
 163         """
 164
 165         :param filter:  (Default value = None)
 166
 167         """
 168         if filter is not None:
 169             args = {"name_filter_valid": 1, "name_filter": filter}
 170         else:
 171             args = {}
 172         return self.api(self.papi.sw_interface_dump, args)
 173
 174     def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
 175         """ Set the IPvX Table-id for the Interface
 176
 177         :param sw_if_index:
 178         :param is_ipv6:
 179         :param table_id:
 180
 181         """
 182         return self.api(self.papi.sw_interface_set_table,
 183                         {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
 184                          'vrf_id': table_id})
 185
 186     def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
 187                                      is_ipv6=0, is_add=1, del_all=0):
 188         """
 189
 190         :param addr: param is_ipv6:  (Default value = 0)
 191         :param sw_if_index:
 192         :param addr_len:
 193         :param is_ipv6:  (Default value = 0)
 194         :param is_add:  (Default value = 1)
 195         :param del_all:  (Default value = 0)
 196
 197         """
 198         return self.api(self.papi.sw_interface_add_del_address,
 199                         {'sw_if_index': sw_if_index,
 200                          'is_add': is_add,
 201                          'is_ipv6': is_ipv6,
 202                          'del_all': del_all,
 203                          'address_length': addr_len,
 204                          'address': addr})
 205
 206     def sw_interface_enable_disable_mpls(self, sw_if_index,
 207                                          is_enable=1):
 208         """
 209         Enable/Disable MPLS on the interface
 210         :param sw_if_index:
 211         :param is_enable:  (Default value = 1)
 212
 213         """
 214         return self.api(self.papi.sw_interface_set_mpls_enable,
 215                         {'sw_if_index': sw_if_index,
 216                          'enable': is_enable})
 217
 218     def sw_interface_ra_suppress(self, sw_if_index):
 219         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 220                         {'sw_if_index': sw_if_index})
 221
 222     def ip6_sw_interface_ra_config(self, sw_if_index,
 223                                    suppress,
 224                                    send_unicast,):
 225         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 226                         {'sw_if_index': sw_if_index,
 227                          'suppress' : suppress,
 228                          'send_unicast' : send_unicast})
 229
 230     def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
 231         """
 232         Enable/Disable An interface for IPv6
 233         """
 234         return self.api(self.papi.sw_interface_ip6_enable_disable,
 235                         {'sw_if_index': sw_if_index,
 236                          'enable': enable})
 237
 238     def vxlan_add_del_tunnel(
 239             self,
 240             src_addr,
 241             dst_addr,
 242             mcast_sw_if_index=0xFFFFFFFF,
 243             is_add=1,
 244             is_ipv6=0,
 245             encap_vrf_id=0,
 246             decap_next_index=0xFFFFFFFF,
 247             vni=0):
 248         """
 249
 250         :param dst_addr:
 251         :param src_addr:
 252         :param is_add:  (Default value = 1)
 253         :param is_ipv6:  (Default value = 0)
 254         :param encap_vrf_id:  (Default value = 0)
 255         :param decap_next_index:  (Default value = 0xFFFFFFFF)
 256         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 257         :param vni:  (Default value = 0)
 258
 259         """
 260         return self.api(self.papi.vxlan_add_del_tunnel,
 261                         {'is_add': is_add,
 262                          'is_ipv6': is_ipv6,
 263                          'src_address': src_addr,
 264                          'dst_address': dst_addr,
 265                          'mcast_sw_if_index': mcast_sw_if_index,
 266                          'encap_vrf_id': encap_vrf_id,
 267                          'decap_next_index': decap_next_index,
 268                          'vni': vni})
 269
 270     def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
 271                               learn=1, arp_term=0, is_add=1):
 272         """Create/delete bridge domain.
 273
 274         :param int bd_id: Bridge domain index.
 275         :param int flood: Enable/disable bcast/mcast flooding in the BD.
 276             (Default value = 1)
 277         :param int uu_flood: Enable/disable unknown unicast flood in the BD.
 278             (Default value = 1)
 279         :param int forward: Enable/disable forwarding on all interfaces in
 280             the BD. (Default value = 1)
 281         :param int learn: Enable/disable learning on all interfaces in the BD.
 282             (Default value = 1)
 283         :param int arp_term: Enable/disable arp termination in the BD.
 284             (Default value = 1)
 285         :param int is_add: Add or delete flag. (Default value = 1)
 286         """
 287         return self.api(self.papi.bridge_domain_add_del,
 288                         {'bd_id': bd_id,
 289                          'flood': flood,
 290                          'uu_flood': uu_flood,
 291                          'forward': forward,
 292                          'learn': learn,
 293                          'arp_term': arp_term,
 294                          'is_add': is_add})
 295
 296     def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
 297                       filter_mac=0, bvi_mac=0):
 298         """Create/delete L2 FIB entry.
 299
 300         :param str mac: MAC address to create FIB entry for.
 301         :param int bd_id: Bridge domain index.
 302         :param int sw_if_index: Software interface index of the interface.
 303         :param int is_add: Add or delete flag. (Default value = 1)
 304         :param int static_mac: Set to 1 to create static MAC entry.
 305             (Default value = 0)
 306         :param int filter_mac: Set to 1 to drop packet that's source or
 307             destination MAC address contains defined MAC address.
 308             (Default value = 0)
 309         :param int bvi_mac: Set to 1 to create entry that points to BVI
 310             interface. (Default value = 0)
 311         """
 312         return self.api(self.papi.l2fib_add_del,
 313                         {'mac': self._convert_mac(mac),
 314                          'bd_id': bd_id,
 315                          'sw_if_index': sw_if_index,
 316                          'is_add': is_add,
 317                          'static_mac': static_mac,
 318                          'filter_mac': filter_mac,
 319                          'bvi_mac': bvi_mac})
 320
 321     def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
 322                                    shg=0, bvi=0, enable=1):
 323         """Add/remove interface to/from bridge domain.
 324
 325         :param int sw_if_index: Software interface index of the interface.
 326         :param int bd_id: Bridge domain index.
 327         :param int shg: Split-horizon group index. (Default value = 0)
 328         :param int bvi: Set interface as a bridge group virtual interface.
 329             (Default value = 0)
 330         :param int enable: Add or remove interface. (Default value = 1)
 331         """
 332         return self.api(self.papi.sw_interface_set_l2_bridge,
 333                         {'rx_sw_if_index': sw_if_index,
 334                          'bd_id': bd_id,
 335                          'shg': shg,
 336                          'bvi': bvi,
 337                          'enable': enable})
 338
 339     def bridge_flags(self, bd_id, is_set, feature_bitmap):
 340         """Enable/disable required feature of the bridge domain with defined ID.
 341
 342         :param int bd_id: Bridge domain ID.
 343         :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
 344         :param int feature_bitmap: Bitmap value of the feature to be set:
 345             - learn (1 << 0),
 346             - forward (1 << 1),
 347             - flood (1 << 2),
 348             - uu-flood (1 << 3) or
 349             - arp-term (1 << 4).
 350         """
 351         return self.api(self.papi.bridge_flags,
 352                         {'bd_id': bd_id,
 353                          'is_set': is_set,
 354                          'feature_bitmap': feature_bitmap})
 355
 356     def bridge_domain_dump(self, bd_id=0):
 357         """
 358
 359         :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
 360             existing bridge domains returned)
 361         :return: Dictionary of bridge domain(s) data.
 362         """
 363         return self.api(self.papi.bridge_domain_dump,
 364                         {'bd_id': bd_id})
 365
 366     def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
 367                                      enable):
 368         """Create or delete unidirectional cross-connect from Tx interface to
 369         Rx interface.
 370
 371         :param int rx_sw_if_index: Software interface index of Rx interface.
 372         :param int tx_sw_if_index: Software interface index of Tx interface.
 373         :param int enable: Create cross-connect if equal to 1, delete
 374             cross-connect if equal to 0.
 375
 376         """
 377         return self.api(self.papi.sw_interface_set_l2_xconnect,
 378                         {'rx_sw_if_index': rx_sw_if_index,
 379                          'tx_sw_if_index': tx_sw_if_index,
 380                          'enable': enable})
 381
 382     def sw_interface_set_l2_tag_rewrite(
 383             self,
 384             sw_if_index,
 385             vtr_oper,
 386             push=0,
 387             tag1=0,
 388             tag2=0):
 389         """L2 interface vlan tag rewrite configure request
 390         :param client_index - opaque cookie to identify the sender
 391         :param context - sender context, to match reply w/ request
 392         :param sw_if_index - interface the operation is applied to
 393         :param vtr_op - Choose from l2_vtr_op_t enum values
 394         :param push_dot1q - first pushed flag dot1q id set, else dot1ad
 395         :param tag1 - Needed for any push or translate vtr op
 396         :param tag2 - Needed for any push 2 or translate x-2 vtr ops
 397
 398         """
 399         return self.api(self.papi.l2_interface_vlan_tag_rewrite,
 400                         {'sw_if_index': sw_if_index,
 401                          'vtr_op': vtr_oper,
 402                          'push_dot1q': push,
 403                          'tag1': tag1,
 404                          'tag2': tag2})
 405
 406     def sw_interface_set_flags(self, sw_if_index, admin_up_down,
 407                                link_up_down=0, deleted=0):
 408         """
 409
 410         :param admin_up_down:
 411         :param sw_if_index:
 412         :param link_up_down:  (Default value = 0)
 413         :param deleted:  (Default value = 0)
 414
 415         """
 416         return self.api(self.papi.sw_interface_set_flags,
 417                         {'sw_if_index': sw_if_index,
 418                          'admin_up_down': admin_up_down,
 419                          'link_up_down': link_up_down,
 420                          'deleted': deleted})
 421
 422     def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
 423                      no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
 424                      default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
 425         """Create subinterface
 426         from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
 427
 428         :param sub_id: param inner_vlan:
 429         :param sw_if_index:
 430         :param outer_vlan:
 431         :param inner_vlan:
 432         :param no_tags:  (Default value = 0)
 433         :param one_tag:  (Default value = 0)
 434         :param two_tags:  (Default value = 0)
 435         :param dot1ad:  (Default value = 0)
 436         :param exact_match:  (Default value = 0)
 437         :param default_sub:  (Default value = 0)
 438         :param outer_vlan_id_any:  (Default value = 0)
 439         :param inner_vlan_id_any:  (Default value = 0)
 440
 441         """
 442         return self.api(
 443             self.papi.create_subif,
 444             {'sw_if_index': sw_if_index,
 445              'sub_id': sub_id,
 446              'no_tags': no_tags,
 447              'one_tag': one_tag,
 448              'two_tags': two_tags,
 449              'dot1ad': dot1ad,
 450              'exact_match': exact_match,
 451              'default_sub': default_sub,
 452              'outer_vlan_id_any': outer_vlan_id_any,
 453              'inner_vlan_id_any': inner_vlan_id_any,
 454              'outer_vlan_id': outer_vlan,
 455              'inner_vlan_id': inner_vlan})
 456
 457     def delete_subif(self, sw_if_index):
 458         """Delete subinterface
 459
 460         :param sw_if_index:
 461         """
 462         return self.api(self.papi.delete_subif,
 463                         {'sw_if_index': sw_if_index})
 464
 465     def create_vlan_subif(self, sw_if_index, vlan):
 466         """
 467
 468         :param vlan:
 469         :param sw_if_index:
 470
 471         """
 472         return self.api(self.papi.create_vlan_subif,
 473                         {'sw_if_index': sw_if_index,
 474                          'vlan_id': vlan})
 475
 476     def create_loopback(self, mac=''):
 477         """
 478
 479         :param mac: (Optional)
 480         """
 481         return self.api(self.papi.create_loopback,
 482                         {'mac_address': mac})
 483
 484     def delete_loopback(self, sw_if_index):
 485         return self.api(self.papi.delete_loopback,
 486                         {'sw_if_index': sw_if_index, })
 487
 488     def ip_add_del_route(
 489             self,
 490             dst_address,
 491             dst_address_length,
 492             next_hop_address,
 493             next_hop_sw_if_index=0xFFFFFFFF,
 494             table_id=0,
 495             next_hop_table_id=0,
 496             next_hop_weight=1,
 497             next_hop_n_out_labels=0,
 498             next_hop_out_label_stack=[],
 499             next_hop_via_label=MPLS_LABEL_INVALID,
 500             create_vrf_if_needed=0,
 501             is_resolve_host=0,
 502             is_resolve_attached=0,
 503             classify_table_index=0xFFFFFFFF,
 504             is_add=1,
 505             is_drop=0,
 506             is_unreach=0,
 507             is_prohibit=0,
 508             is_ipv6=0,
 509             is_local=0,
 510             is_classify=0,
 511             is_multipath=0,
 512             not_last=0):
 513         """
 514
 515         :param dst_address_length:
 516         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 517         :param dst_address:
 518         :param next_hop_address:
 519         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 520         :param vrf_id:  (Default value = 0)
 521         :param lookup_in_vrf:  (Default value = 0)
 522         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 523         :param create_vrf_if_needed:  (Default value = 0)
 524         :param is_add:  (Default value = 1)
 525         :param is_drop:  (Default value = 0)
 526         :param is_ipv6:  (Default value = 0)
 527         :param is_local:  (Default value = 0)
 528         :param is_classify:  (Default value = 0)
 529         :param is_multipath:  (Default value = 0)
 530         :param is_resolve_host:  (Default value = 0)
 531         :param is_resolve_attached:  (Default value = 0)
 532         :param not_last:  (Default value = 0)
 533         :param next_hop_weight:  (Default value = 1)
 534
 535         """
 536
 537         return self.api(
 538             self.papi.ip_add_del_route,
 539             {'next_hop_sw_if_index': next_hop_sw_if_index,
 540              'table_id': table_id,
 541              'classify_table_index': classify_table_index,
 542              'next_hop_table_id': next_hop_table_id,
 543              'create_vrf_if_needed': create_vrf_if_needed,
 544              'is_add': is_add,
 545              'is_drop': is_drop,
 546              'is_unreach': is_unreach,
 547              'is_prohibit': is_prohibit,
 548              'is_ipv6': is_ipv6,
 549              'is_local': is_local,
 550              'is_classify': is_classify,
 551              'is_multipath': is_multipath,
 552              'is_resolve_host': is_resolve_host,
 553              'is_resolve_attached': is_resolve_attached,
 554              'not_last': not_last,
 555              'next_hop_weight': next_hop_weight,
 556              'dst_address_length': dst_address_length,
 557              'dst_address': dst_address,
 558              'next_hop_address': next_hop_address,
 559              'next_hop_n_out_labels': next_hop_n_out_labels,
 560              'next_hop_via_label': next_hop_via_label,
 561              'next_hop_out_label_stack': next_hop_out_label_stack})
 562
 563     def ip_fib_dump(self):
 564         return self.api(self.papi.ip_fib_dump, {})
 565
 566     def ip_neighbor_add_del(self,
 567                             sw_if_index,
 568                             mac_address,
 569                             dst_address,
 570                             vrf_id=0,
 571                             is_add=1,
 572                             is_ipv6=0,
 573                             is_static=0,
 574                             ):
 575         """ Add neighbor MAC to IPv4 or IPv6 address.
 576
 577         :param sw_if_index:
 578         :param mac_address:
 579         :param dst_address:
 580         :param vrf_id:  (Default value = 0)
 581         :param is_add:  (Default value = 1)
 582         :param is_ipv6:  (Default value = 0)
 583         :param is_static:  (Default value = 0)
 584         """
 585
 586         return self.api(
 587             self.papi.ip_neighbor_add_del,
 588             {'vrf_id': vrf_id,
 589              'sw_if_index': sw_if_index,
 590              'is_add': is_add,
 591              'is_ipv6': is_ipv6,
 592              'is_static': is_static,
 593              'mac_address': mac_address,
 594              'dst_address': dst_address
 595              }
 596         )
 597
 598     def sw_interface_span_enable_disable(
 599             self, sw_if_index_from, sw_if_index_to, state=1):
 600         """
 601
 602         :param sw_if_index_from:
 603         :param sw_if_index_to:
 604         :param state:
 605         """
 606         return self.api(self.papi.sw_interface_span_enable_disable,
 607                         {'sw_if_index_from': sw_if_index_from,
 608                          'sw_if_index_to': sw_if_index_to,
 609                          'state': state})
 610
 611     def gre_tunnel_add_del(self,
 612                            src_address,
 613                            dst_address,
 614                            outer_fib_id=0,
 615                            is_teb=0,
 616                            is_add=1,
 617                            is_ip6=0):
 618         """ Add a GRE tunnel
 619
 620         :param src_address:
 621         :param dst_address:
 622         :param outer_fib_id:  (Default value = 0)
 623         :param is_add:  (Default value = 1)
 624         :param is_ipv6:  (Default value = 0)
 625         :param is_teb:  (Default value = 0)
 626         """
 627
 628         return self.api(
 629             self.papi.gre_add_del_tunnel,
 630             {'is_add': is_add,
 631              'is_ipv6': is_ip6,
 632              'teb': is_teb,
 633              'src_address': src_address,
 634              'dst_address': dst_address,
 635              'outer_fib_id': outer_fib_id}
 636         )
 637
 638     def mpls_route_add_del(
 639             self,
 640             label,
 641             eos,
 642             next_hop_proto_is_ip4,
 643             next_hop_address,
 644             next_hop_sw_if_index=0xFFFFFFFF,
 645             table_id=0,
 646             next_hop_table_id=0,
 647             next_hop_weight=1,
 648             next_hop_n_out_labels=0,
 649             next_hop_out_label_stack=[],
 650             next_hop_via_label=MPLS_LABEL_INVALID,
 651             create_vrf_if_needed=0,
 652             is_resolve_host=0,
 653             is_resolve_attached=0,
 654             is_add=1,
 655             is_drop=0,
 656             is_multipath=0,
 657             classify_table_index=0xFFFFFFFF,
 658             is_classify=0,
 659             not_last=0):
 660         """
 661
 662         :param dst_address_length:
 663         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 664         :param dst_address:
 665         :param next_hop_address:
 666         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 667         :param vrf_id:  (Default value = 0)
 668         :param lookup_in_vrf:  (Default value = 0)
 669         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 670         :param create_vrf_if_needed:  (Default value = 0)
 671         :param is_add:  (Default value = 1)
 672         :param is_drop:  (Default value = 0)
 673         :param is_ipv6:  (Default value = 0)
 674         :param is_local:  (Default value = 0)
 675         :param is_classify:  (Default value = 0)
 676         :param is_multipath:  (Default value = 0)
 677         :param is_resolve_host:  (Default value = 0)
 678         :param is_resolve_attached:  (Default value = 0)
 679         :param not_last:  (Default value = 0)
 680         :param next_hop_weight:  (Default value = 1)
 681
 682         """
 683
 684         return self.api(
 685             self.papi.mpls_route_add_del,
 686             {'mr_label': label,
 687              'mr_eos': eos,
 688              'mr_table_id': table_id,
 689              'mr_classify_table_index': classify_table_index,
 690              'mr_create_table_if_needed': create_vrf_if_needed,
 691              'mr_is_add': is_add,
 692              'mr_is_classify': is_classify,
 693              'mr_is_multipath': is_multipath,
 694              'mr_is_resolve_host': is_resolve_host,
 695              'mr_is_resolve_attached': is_resolve_attached,
 696              'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
 697              'mr_next_hop_weight': next_hop_weight,
 698              'mr_next_hop': next_hop_address,
 699              'mr_next_hop_n_out_labels': next_hop_n_out_labels,
 700              'mr_next_hop_sw_if_index': next_hop_sw_if_index,
 701              'mr_next_hop_table_id': next_hop_table_id,
 702              'mr_next_hop_via_label': next_hop_via_label,
 703              'mr_next_hop_out_label_stack': next_hop_out_label_stack})
 704
 705     def mpls_ip_bind_unbind(
 706             self,
 707             label,
 708             dst_address,
 709             dst_address_length,
 710             table_id=0,
 711             ip_table_id=0,
 712             is_ip4=1,
 713             create_vrf_if_needed=0,
 714             is_bind=1):
 715         """
 716         """
 717         return self.api(
 718             self.papi.mpls_ip_bind_unbind,
 719             {'mb_mpls_table_id': table_id,
 720              'mb_label': label,
 721              'mb_ip_table_id': ip_table_id,
 722              'mb_create_table_if_needed': create_vrf_if_needed,
 723              'mb_is_bind': is_bind,
 724              'mb_is_ip4': is_ip4,
 725              'mb_address_length': dst_address_length,
 726              'mb_address': dst_address})
 727
 728     def mpls_tunnel_add_del(
 729             self,
 730             tun_sw_if_index,
 731             next_hop_proto_is_ip4,
 732             next_hop_address,
 733             next_hop_sw_if_index=0xFFFFFFFF,
 734             next_hop_table_id=0,
 735             next_hop_weight=1,
 736             next_hop_n_out_labels=0,
 737             next_hop_out_label_stack=[],
 738             next_hop_via_label=MPLS_LABEL_INVALID,
 739             create_vrf_if_needed=0,
 740             is_add=1,
 741             l2_only=0):
 742         """
 743
 744         :param dst_address_length:
 745         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 746         :param dst_address:
 747         :param next_hop_address:
 748         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 749         :param vrf_id:  (Default value = 0)
 750         :param lookup_in_vrf:  (Default value = 0)
 751         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 752         :param create_vrf_if_needed:  (Default value = 0)
 753         :param is_add:  (Default value = 1)
 754         :param is_drop:  (Default value = 0)
 755         :param is_ipv6:  (Default value = 0)
 756         :param is_local:  (Default value = 0)
 757         :param is_classify:  (Default value = 0)
 758         :param is_multipath:  (Default value = 0)
 759         :param is_resolve_host:  (Default value = 0)
 760         :param is_resolve_attached:  (Default value = 0)
 761         :param not_last:  (Default value = 0)
 762         :param next_hop_weight:  (Default value = 1)
 763
 764         """
 765         return self.api(
 766             self.papi.mpls_tunnel_add_del,
 767             {'mt_sw_if_index': tun_sw_if_index,
 768              'mt_is_add': is_add,
 769              'mt_l2_only': l2_only,
 770              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
 771              'mt_next_hop_weight': next_hop_weight,
 772              'mt_next_hop': next_hop_address,
 773              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
 774              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
 775              'mt_next_hop_table_id': next_hop_table_id,
 776              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
 777
 778     def snat_interface_add_del_feature(
 779             self,
 780             sw_if_index,
 781             is_inside=1,
 782             is_add=1):
 783         """Enable/disable S-NAT feature on the interface
 784
 785         :param sw_if_index: Software index of the interface
 786         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
 787         :param is_add: 1 if add, 0 if delete (Default value = 1)
 788         """
 789         return self.api(
 790             self.papi.snat_interface_add_del_feature,
 791             {'is_add': is_add,
 792              'is_inside': is_inside,
 793              'sw_if_index': sw_if_index})
 794
 795     def snat_add_static_mapping(
 796             self,
 797             local_ip,
 798             external_ip,
 799             local_port=0,
 800             external_port=0,
 801             addr_only=1,
 802             vrf_id=0,
 803             is_add=1,
 804             is_ip4=1):
 805         """Add/delete S-NAT static mapping
 806
 807         :param local_ip: Local IP address
 808         :param external_ip: External IP address
 809         :param local_port: Local port number (Default value = 0)
 810         :param external_port: External port number (Default value = 0)
 811         :param addr_only: 1 if address only mapping, 0 if address and port
 812         :param vrf_id: VRF ID
 813         :param is_add: 1 if add, 0 if delete (Default value = 1)
 814         :param is_ip4: 1 if address type is IPv4 (Default value = 1)
 815         """
 816         return self.api(
 817             self.papi.snat_add_static_mapping,
 818             {'is_add': is_add,
 819              'is_ip4': is_ip4,
 820              'addr_only': addr_only,
 821              'local_ip_address': local_ip,
 822              'external_ip_address': external_ip,
 823              'local_port': local_port,
 824              'external_port': external_port,
 825              'vrf_id': vrf_id})
 826
 827     def snat_add_address_range(
 828             self,
 829             first_ip_address,
 830             last_ip_address,
 831             is_add=1,
 832             is_ip4=1):
 833         """Add/del S-NAT address range
 834
 835         :param first_ip_address: First IP address
 836         :param last_ip_address: Last IP address
 837         :param is_add: 1 if add, 0 if delete (Default value = 1)
 838         :param is_ip4: 1 if address type is IPv4 (Default value = 1)
 839         """
 840         return self.api(
 841             self.papi.snat_add_address_range,
 842             {'is_ip4': is_ip4,
 843              'first_ip_address': first_ip_address,
 844              'last_ip_address': last_ip_address,
 845              'is_add': is_add})
 846
 847     def snat_address_dump(self):
 848         """Dump S-NAT addresses
 849         :return: Dictionary of S-NAT addresses
 850         """
 851         return self.api(self.papi.snat_address_dump, {})
 852
 853     def snat_interface_dump(self):
 854         """Dump interfaces with S-NAT feature
 855         :return: Dictionary of interfaces with S-NAT feature
 856         """
 857         return self.api(self.papi.snat_interface_dump, {})
 858
 859     def snat_static_mapping_dump(self):
 860         """Dump S-NAT static mappings
 861         :return: Dictionary of S-NAT static mappings
 862         """
 863         return self.api(self.papi.snat_static_mapping_dump, {})
 864
 865     def snat_show_config(self):
 866         """Show S-NAT config
 867         :return: S-NAT config parameters
 868         """
 869         return self.api(self.papi.snat_show_config, {})
 870
 871     def control_ping(self):
 872         self.api(self.papi.control_ping)
 873
 874     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
 875                     detect_mult, local_addr, peer_addr, is_ipv6=0):
 876         return self.api(self.papi.bfd_udp_add,
 877                         {
 878                             'sw_if_index': sw_if_index,
 879                             'desired_min_tx': desired_min_tx,
 880                             'required_min_rx': required_min_rx,
 881                             'local_addr': local_addr,
 882                             'peer_addr': peer_addr,
 883                             'is_ipv6': is_ipv6,
 884                             'detect_mult': detect_mult,
 885                         })
 886
 887     def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
 888         return self.api(self.papi.bfd_udp_del,
 889                         {
 890                             'sw_if_index': sw_if_index,
 891                             'local_addr': local_addr,
 892                             'peer_addr': peer_addr,
 893                             'is_ipv6': is_ipv6,
 894                         })
 895
 896     def bfd_udp_session_dump(self):
 897         return self.api(self.papi.bfd_udp_session_dump, {})
 898
 899     def bfd_session_set_flags(self, bs_idx, admin_up_down):
 900         return self.api(self.papi.bfd_session_set_flags, {
 901             'bs_index': bs_idx,
 902             'admin_up_down': admin_up_down,
 903         })
 904
 905     def want_bfd_events(self, enable_disable=1):
 906         return self.api(self.papi.want_bfd_events, {
 907             'enable_disable': enable_disable,
 908             'pid': os.getpid(),
 909         })
 910
 911     def classify_add_del_table(
 912             self,
 913             is_add,
 914             mask,
 915             match_n_vectors=1,
 916             table_index=0xFFFFFFFF,
 917             nbuckets=2,
 918             memory_size=2097152,
 919             skip_n_vectors=0,
 920             next_table_index=0xFFFFFFFF,
 921             miss_next_index=0xFFFFFFFF,
 922             current_data_flag=0,
 923             current_data_offset=0):
 924         """
 925         :param is_add:
 926         :param mask:
 927         :param match_n_vectors: (Default value = 1):
 928         :param table_index: (Default value = 0xFFFFFFFF)
 929         :param nbuckets:  (Default value = 2)
 930         :param memory_size:  (Default value = 2097152)
 931         :param skip_n_vectors:  (Default value = 0)
 932         :param next_table_index:  (Default value = 0xFFFFFFFF)
 933         :param miss_next_index:  (Default value = 0xFFFFFFFF)
 934         :param current_data_flag:  (Default value = 0)
 935         :param current_data_offset:  (Default value = 0)
 936         """
 937
 938         return self.api(
 939             self.papi.classify_add_del_table,
 940             {'is_add': is_add,
 941              'table_index': table_index,
 942              'nbuckets': nbuckets,
 943              'memory_size': memory_size,
 944              'skip_n_vectors': skip_n_vectors,
 945              'match_n_vectors': match_n_vectors,
 946              'next_table_index': next_table_index,
 947              'miss_next_index': miss_next_index,
 948              'current_data_flag': current_data_flag,
 949              'current_data_offset': current_data_offset,
 950              'mask': mask})
 951
 952     def classify_add_del_session(
 953             self,
 954             is_add,
 955             table_index,
 956             match,
 957             opaque_index=0xFFFFFFFF,
 958             hit_next_index=0xFFFFFFFF,
 959             advance=0,
 960             action=0,
 961             metadata=0):
 962         """
 963         :param is_add:
 964         :param table_index:
 965         :param match:
 966         :param opaque_index:  (Default value = 0xFFFFFFFF)
 967         :param hit_next_index:  (Default value = 0xFFFFFFFF)
 968         :param advance:  (Default value = 0)
 969         :param action:  (Default value = 0)
 970         :param metadata:  (Default value = 0)
 971         """
 972
 973         return self.api(
 974             self.papi.classify_add_del_session,
 975             {'is_add': is_add,
 976              'table_index': table_index,
 977              'hit_next_index': hit_next_index,
 978              'opaque_index': opaque_index,
 979              'advance': advance,
 980              'action': action,
 981              'metadata': metadata,
 982              'match': match})
 983
 984     def input_acl_set_interface(
 985             self,
 986             is_add,
 987             sw_if_index,
 988             ip4_table_index=0xFFFFFFFF,
 989             ip6_table_index=0xFFFFFFFF,
 990             l2_table_index=0xFFFFFFFF):
 991         """
 992         :param is_add:
 993         :param sw_if_index:
 994         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
 995         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
 996         :param l2_table_index:  (Default value = 0xFFFFFFFF)
 997         """
 998
 999         return self.api(
1000             self.papi.input_acl_set_interface,
1001             {'sw_if_index': sw_if_index,
1002              'ip4_table_index': ip4_table_index,
1003              'ip6_table_index': ip6_table_index,
1004              'l2_table_index': l2_table_index,
1005              'is_add': is_add})
1006
1007     def set_ipfix_exporter(
1008             self,
1009             collector_address,
1010             src_address,
1011             path_mtu,
1012             template_interval,
1013             vrf_id=0,
1014             collector_port=4739,
1015             udp_checksum=0):
1016         return self.api(
1017             self.papi.set_ipfix_exporter,
1018             {
1019                 'collector_address': collector_address,
1020                 'collector_port': collector_port,
1021                 'src_address': src_address,
1022                 'vrf_id': vrf_id,
1023                 'path_mtu': path_mtu,
1024                 'template_interval': template_interval,
1025                 'udp_checksum': udp_checksum,
1026             })