test/vpp_papi_provider.py

   1 import os
   2 import socket
   3 import fnmatch
   4 import time
   5 from hook import Hook
   6 from collections import deque
   7
   8 # Sphinx creates auto-generated documentation by importing the python source
   9 # files and collecting the docstrings from them. The NO_VPP_PAPI flag allows
  10 # the vpp_papi_provider.py file to be importable without having to build
  11 # the whole vpp api if the user only wishes to generate the test documentation.
  12 do_import = True
  13 try:
  14     no_vpp_papi = os.getenv("NO_VPP_PAPI")
  15     if no_vpp_papi == "1":
  16         do_import = False
  17 except:
  18     pass
  19
  20 if do_import:
  21     from vpp_papi import VPP
  22
  23 # from vnet/vnet/mpls/mpls_types.h
  24 MPLS_IETF_MAX_LABEL = 0xfffff
  25 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
  26
  27
  28 class L2_VTR_OP:
  29     L2_POP_1 = 3
  30
  31
  32 class VppPapiProvider(object):
  33     """VPP-api provider using vpp-papi
  34
  35     @property hook: hook object providing before and after api/cli hooks
  36     """
  37
  38     _zero, _negative = range(2)
  39
  40     def __init__(self, name, shm_prefix, test_class):
  41         self.hook = Hook("vpp-papi-provider")
  42         self.name = name
  43         self.shm_prefix = shm_prefix
  44         self.test_class = test_class
  45         self._expect_api_retval = self._zero
  46         self._expect_stack = []
  47         jsonfiles = []
  48
  49         install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
  50         for root, dirnames, filenames in os.walk(install_dir):
  51             for filename in fnmatch.filter(filenames, '*.api.json'):
  52                 jsonfiles.append(os.path.join(root, filename))
  53
  54         self.papi = VPP(jsonfiles)
  55         self._events = deque()
  56
  57     def __enter__(self):
  58         return self
  59
  60     def expect_negative_api_retval(self):
  61         """ Expect API failure """
  62         self._expect_stack.append(self._expect_api_retval)
  63         self._expect_api_retval = self._negative
  64         return self
  65
  66     def expect_zero_api_retval(self):
  67         """ Expect API success """
  68         self._expect_stack.append(self._expect_api_retval)
  69         self._expect_api_retval = self._zero
  70         return self
  71
  72     def __exit__(self, exc_type, exc_value, traceback):
  73         self._expect_api_retval = self._expect_stack.pop()
  74
  75     def register_hook(self, hook):
  76         """Replace hook registration with new hook
  77
  78         :param hook:
  79
  80         """
  81         self.hook = hook
  82
  83     def collect_events(self):
  84         """ Collect all events from the internal queue and clear the queue. """
  85         e = self._events
  86         self._events = deque()
  87         return e
  88
  89     def wait_for_event(self, timeout, name=None):
  90         """ Wait for and return next event. """
  91         if name:
  92             self.test_class.logger.debug("Expecting event within %ss",
  93                                          timeout)
  94         else:
  95             self.test_class.logger.debug("Expecting event '%s' within %ss",
  96                                          name, timeout)
  97         if self._events:
  98             self.test_class.logger.debug("Not waiting, event already queued")
  99         limit = time.time() + timeout
 100         while time.time() < limit:
 101             if self._events:
 102                 e = self._events.popleft()
 103                 if name and type(e).__name__ != name:
 104                     raise Exception(
 105                         "Unexpected event received: %s, expected: %s" %
 106                         (type(e).__name__, name))
 107                 self.test_class.logger.debug("Returning event %s:%s" %
 108                                              (name, e))
 109                 return e
 110             time.sleep(0)  # yield
 111         raise Exception("Event did not occur within timeout")
 112
 113     def __call__(self, name, event):
 114         """ Enqueue event in the internal event queue. """
 115         # FIXME use the name instead of relying on type(e).__name__ ?
 116         # FIXME #2 if this throws, it is eaten silently, Ole?
 117         self.test_class.logger.debug("New event: %s: %s" % (name, event))
 118         self._events.append(event)
 119
 120     def connect(self):
 121         """Connect the API to VPP"""
 122         self.papi.connect(self.name, self.shm_prefix)
 123         self.papi.register_event_callback(self)
 124
 125     def disconnect(self):
 126         """Disconnect the API from VPP"""
 127         self.papi.disconnect()
 128
 129     def api(self, api_fn, api_args, expected_retval=0):
 130         """ Call API function and check it's return value.
 131         Call the appropriate hooks before and after the API call
 132
 133         :param api_fn: API function to call
 134         :param api_args: tuple of API function arguments
 135         :param expected_retval: Expected return value (Default value = 0)
 136         :returns: reply from the API
 137
 138         """
 139         self.hook.before_api(api_fn.__name__, api_args)
 140         reply = api_fn(**api_args)
 141         if self._expect_api_retval == self._negative:
 142             if hasattr(reply, 'retval') and reply.retval >= 0:
 143                 msg = "API call passed unexpectedly: expected negative "\
 144                     "return value instead of %d in %s" % \
 145                     (reply.retval, repr(reply))
 146                 self.test_class.logger.info(msg)
 147                 raise Exception(msg)
 148         elif self._expect_api_retval == self._zero:
 149             if hasattr(reply, 'retval') and reply.retval != expected_retval:
 150                 msg = "API call failed, expected zero return value instead "\
 151                     "of %d in %s" % (expected_retval, repr(reply))
 152                 self.test_class.logger.info(msg)
 153                 raise Exception(msg)
 154         else:
 155             raise Exception("Internal error, unexpected value for "
 156                             "self._expect_api_retval %s" %
 157                             self._expect_api_retval)
 158         self.hook.after_api(api_fn.__name__, api_args)
 159         return reply
 160
 161     def cli(self, cli):
 162         """ Execute a CLI, calling the before/after hooks appropriately.
 163
 164         :param cli: CLI to execute
 165         :returns: CLI output
 166
 167         """
 168         self.hook.before_cli(cli)
 169         cli += '\n'
 170         r = self.papi.cli_inband(length=len(cli), cmd=cli)
 171         self.hook.after_cli(cli)
 172         if hasattr(r, 'reply'):
 173             return r.reply.decode().rstrip('\x00')
 174
 175     def ppcli(self, cli):
 176         """ Helper method to print CLI command in case of info logging level.
 177
 178         :param cli: CLI to execute
 179         :returns: CLI output
 180         """
 181         return cli + "\n" + str(self.cli(cli))
 182
 183     def _convert_mac(self, mac):
 184         return int(mac.replace(":", ""), 16) << 16
 185
 186     def show_version(self):
 187         """ """
 188         return self.papi.show_version()
 189
 190     def pg_create_interface(self, pg_index):
 191         """
 192
 193         :param pg_index:
 194
 195         """
 196         return self.api(self.papi.pg_create_interface,
 197                         {"interface_id": pg_index})
 198
 199     def sw_interface_dump(self, filter=None):
 200         """
 201
 202         :param filter:  (Default value = None)
 203
 204         """
 205         if filter is not None:
 206             args = {"name_filter_valid": 1, "name_filter": filter}
 207         else:
 208             args = {}
 209         return self.api(self.papi.sw_interface_dump, args)
 210
 211     def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
 212         """ Set the IPvX Table-id for the Interface
 213
 214         :param sw_if_index:
 215         :param is_ipv6:
 216         :param table_id:
 217
 218         """
 219         return self.api(self.papi.sw_interface_set_table,
 220                         {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
 221                          'vrf_id': table_id})
 222
 223     def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
 224                                      is_ipv6=0, is_add=1, del_all=0):
 225         """
 226
 227         :param addr: param is_ipv6:  (Default value = 0)
 228         :param sw_if_index:
 229         :param addr_len:
 230         :param is_ipv6:  (Default value = 0)
 231         :param is_add:  (Default value = 1)
 232         :param del_all:  (Default value = 0)
 233
 234         """
 235         return self.api(self.papi.sw_interface_add_del_address,
 236                         {'sw_if_index': sw_if_index,
 237                          'is_add': is_add,
 238                          'is_ipv6': is_ipv6,
 239                          'del_all': del_all,
 240                          'address_length': addr_len,
 241                          'address': addr})
 242
 243     def sw_interface_enable_disable_mpls(self, sw_if_index,
 244                                          is_enable=1):
 245         """
 246         Enable/Disable MPLS on the interface
 247         :param sw_if_index:
 248         :param is_enable:  (Default value = 1)
 249
 250         """
 251         return self.api(self.papi.sw_interface_set_mpls_enable,
 252                         {'sw_if_index': sw_if_index,
 253                          'enable': is_enable})
 254
 255     def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
 256         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 257                         {'sw_if_index': sw_if_index,
 258                          'suppress': suppress})
 259
 260     def ip6_sw_interface_ra_config(self, sw_if_index,
 261                                    no,
 262                                    suppress,
 263                                    send_unicast):
 264         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 265                         {'sw_if_index': sw_if_index,
 266                          'is_no': no,
 267                          'suppress': suppress,
 268                          'send_unicast': send_unicast})
 269
 270     def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
 271         """
 272         Enable/Disable An interface for IPv6
 273         """
 274         return self.api(self.papi.sw_interface_ip6_enable_disable,
 275                         {'sw_if_index': sw_if_index,
 276                          'enable': enable})
 277
 278     def vxlan_add_del_tunnel(
 279             self,
 280             src_addr,
 281             dst_addr,
 282             mcast_sw_if_index=0xFFFFFFFF,
 283             is_add=1,
 284             is_ipv6=0,
 285             encap_vrf_id=0,
 286             decap_next_index=0xFFFFFFFF,
 287             vni=0):
 288         """
 289
 290         :param dst_addr:
 291         :param src_addr:
 292         :param is_add:  (Default value = 1)
 293         :param is_ipv6:  (Default value = 0)
 294         :param encap_vrf_id:  (Default value = 0)
 295         :param decap_next_index:  (Default value = 0xFFFFFFFF)
 296         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 297         :param vni:  (Default value = 0)
 298
 299         """
 300         return self.api(self.papi.vxlan_add_del_tunnel,
 301                         {'is_add': is_add,
 302                          'is_ipv6': is_ipv6,
 303                          'src_address': src_addr,
 304                          'dst_address': dst_addr,
 305                          'mcast_sw_if_index': mcast_sw_if_index,
 306                          'encap_vrf_id': encap_vrf_id,
 307                          'decap_next_index': decap_next_index,
 308                          'vni': vni})
 309
 310     def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
 311                               learn=1, arp_term=0, is_add=1):
 312         """Create/delete bridge domain.
 313
 314         :param int bd_id: Bridge domain index.
 315         :param int flood: Enable/disable bcast/mcast flooding in the BD.
 316             (Default value = 1)
 317         :param int uu_flood: Enable/disable unknown unicast flood in the BD.
 318             (Default value = 1)
 319         :param int forward: Enable/disable forwarding on all interfaces in
 320             the BD. (Default value = 1)
 321         :param int learn: Enable/disable learning on all interfaces in the BD.
 322             (Default value = 1)
 323         :param int arp_term: Enable/disable arp termination in the BD.
 324             (Default value = 1)
 325         :param int is_add: Add or delete flag. (Default value = 1)
 326         """
 327         return self.api(self.papi.bridge_domain_add_del,
 328                         {'bd_id': bd_id,
 329                          'flood': flood,
 330                          'uu_flood': uu_flood,
 331                          'forward': forward,
 332                          'learn': learn,
 333                          'arp_term': arp_term,
 334                          'is_add': is_add})
 335
 336     def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
 337                       filter_mac=0, bvi_mac=0):
 338         """Create/delete L2 FIB entry.
 339
 340         :param str mac: MAC address to create FIB entry for.
 341         :param int bd_id: Bridge domain index.
 342         :param int sw_if_index: Software interface index of the interface.
 343         :param int is_add: Add or delete flag. (Default value = 1)
 344         :param int static_mac: Set to 1 to create static MAC entry.
 345             (Default value = 0)
 346         :param int filter_mac: Set to 1 to drop packet that's source or
 347             destination MAC address contains defined MAC address.
 348             (Default value = 0)
 349         :param int bvi_mac: Set to 1 to create entry that points to BVI
 350             interface. (Default value = 0)
 351         """
 352         return self.api(self.papi.l2fib_add_del,
 353                         {'mac': self._convert_mac(mac),
 354                          'bd_id': bd_id,
 355                          'sw_if_index': sw_if_index,
 356                          'is_add': is_add,
 357                          'static_mac': static_mac,
 358                          'filter_mac': filter_mac,
 359                          'bvi_mac': bvi_mac})
 360
 361     def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
 362                                    shg=0, bvi=0, enable=1):
 363         """Add/remove interface to/from bridge domain.
 364
 365         :param int sw_if_index: Software interface index of the interface.
 366         :param int bd_id: Bridge domain index.
 367         :param int shg: Split-horizon group index. (Default value = 0)
 368         :param int bvi: Set interface as a bridge group virtual interface.
 369             (Default value = 0)
 370         :param int enable: Add or remove interface. (Default value = 1)
 371         """
 372         return self.api(self.papi.sw_interface_set_l2_bridge,
 373                         {'rx_sw_if_index': sw_if_index,
 374                          'bd_id': bd_id,
 375                          'shg': shg,
 376                          'bvi': bvi,
 377                          'enable': enable})
 378
 379     def bridge_flags(self, bd_id, is_set, feature_bitmap):
 380         """Enable/disable required feature of the bridge domain with defined ID.
 381
 382         :param int bd_id: Bridge domain ID.
 383         :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
 384         :param int feature_bitmap: Bitmap value of the feature to be set:
 385             - learn (1 << 0),
 386             - forward (1 << 1),
 387             - flood (1 << 2),
 388             - uu-flood (1 << 3) or
 389             - arp-term (1 << 4).
 390         """
 391         return self.api(self.papi.bridge_flags,
 392                         {'bd_id': bd_id,
 393                          'is_set': is_set,
 394                          'feature_bitmap': feature_bitmap})
 395
 396     def bridge_domain_dump(self, bd_id=0):
 397         """
 398
 399         :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
 400             existing bridge domains returned)
 401         :return: Dictionary of bridge domain(s) data.
 402         """
 403         return self.api(self.papi.bridge_domain_dump,
 404                         {'bd_id': bd_id})
 405
 406     def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
 407                                      enable):
 408         """Create or delete unidirectional cross-connect from Tx interface to
 409         Rx interface.
 410
 411         :param int rx_sw_if_index: Software interface index of Rx interface.
 412         :param int tx_sw_if_index: Software interface index of Tx interface.
 413         :param int enable: Create cross-connect if equal to 1, delete
 414             cross-connect if equal to 0.
 415
 416         """
 417         return self.api(self.papi.sw_interface_set_l2_xconnect,
 418                         {'rx_sw_if_index': rx_sw_if_index,
 419                          'tx_sw_if_index': tx_sw_if_index,
 420                          'enable': enable})
 421
 422     def sw_interface_set_l2_tag_rewrite(
 423             self,
 424             sw_if_index,
 425             vtr_oper,
 426             push=0,
 427             tag1=0,
 428             tag2=0):
 429         """L2 interface vlan tag rewrite configure request
 430         :param client_index - opaque cookie to identify the sender
 431         :param context - sender context, to match reply w/ request
 432         :param sw_if_index - interface the operation is applied to
 433         :param vtr_op - Choose from l2_vtr_op_t enum values
 434         :param push_dot1q - first pushed flag dot1q id set, else dot1ad
 435         :param tag1 - Needed for any push or translate vtr op
 436         :param tag2 - Needed for any push 2 or translate x-2 vtr ops
 437
 438         """
 439         return self.api(self.papi.l2_interface_vlan_tag_rewrite,
 440                         {'sw_if_index': sw_if_index,
 441                          'vtr_op': vtr_oper,
 442                          'push_dot1q': push,
 443                          'tag1': tag1,
 444                          'tag2': tag2})
 445
 446     def sw_interface_set_flags(self, sw_if_index, admin_up_down,
 447                                link_up_down=0, deleted=0):
 448         """
 449
 450         :param admin_up_down:
 451         :param sw_if_index:
 452         :param link_up_down:  (Default value = 0)
 453         :param deleted:  (Default value = 0)
 454
 455         """
 456         return self.api(self.papi.sw_interface_set_flags,
 457                         {'sw_if_index': sw_if_index,
 458                          'admin_up_down': admin_up_down,
 459                          'link_up_down': link_up_down,
 460                          'deleted': deleted})
 461
 462     def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
 463                      no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
 464                      default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
 465         """Create subinterface
 466         from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
 467
 468         :param sub_id: param inner_vlan:
 469         :param sw_if_index:
 470         :param outer_vlan:
 471         :param inner_vlan:
 472         :param no_tags:  (Default value = 0)
 473         :param one_tag:  (Default value = 0)
 474         :param two_tags:  (Default value = 0)
 475         :param dot1ad:  (Default value = 0)
 476         :param exact_match:  (Default value = 0)
 477         :param default_sub:  (Default value = 0)
 478         :param outer_vlan_id_any:  (Default value = 0)
 479         :param inner_vlan_id_any:  (Default value = 0)
 480
 481         """
 482         return self.api(
 483             self.papi.create_subif,
 484             {'sw_if_index': sw_if_index,
 485              'sub_id': sub_id,
 486              'no_tags': no_tags,
 487              'one_tag': one_tag,
 488              'two_tags': two_tags,
 489              'dot1ad': dot1ad,
 490              'exact_match': exact_match,
 491              'default_sub': default_sub,
 492              'outer_vlan_id_any': outer_vlan_id_any,
 493              'inner_vlan_id_any': inner_vlan_id_any,
 494              'outer_vlan_id': outer_vlan,
 495              'inner_vlan_id': inner_vlan})
 496
 497     def delete_subif(self, sw_if_index):
 498         """Delete subinterface
 499
 500         :param sw_if_index:
 501         """
 502         return self.api(self.papi.delete_subif,
 503                         {'sw_if_index': sw_if_index})
 504
 505     def create_vlan_subif(self, sw_if_index, vlan):
 506         """
 507
 508         :param vlan:
 509         :param sw_if_index:
 510
 511         """
 512         return self.api(self.papi.create_vlan_subif,
 513                         {'sw_if_index': sw_if_index,
 514                          'vlan_id': vlan})
 515
 516     def create_loopback(self, mac=''):
 517         """
 518
 519         :param mac: (Optional)
 520         """
 521         return self.api(self.papi.create_loopback,
 522                         {'mac_address': mac})
 523
 524     def delete_loopback(self, sw_if_index):
 525         return self.api(self.papi.delete_loopback,
 526                         {'sw_if_index': sw_if_index, })
 527
 528     def ip_add_del_route(
 529             self,
 530             dst_address,
 531             dst_address_length,
 532             next_hop_address,
 533             next_hop_sw_if_index=0xFFFFFFFF,
 534             table_id=0,
 535             next_hop_table_id=0,
 536             next_hop_weight=1,
 537             next_hop_n_out_labels=0,
 538             next_hop_out_label_stack=[],
 539             next_hop_via_label=MPLS_LABEL_INVALID,
 540             create_vrf_if_needed=0,
 541             is_resolve_host=0,
 542             is_resolve_attached=0,
 543             classify_table_index=0xFFFFFFFF,
 544             is_add=1,
 545             is_drop=0,
 546             is_unreach=0,
 547             is_prohibit=0,
 548             is_ipv6=0,
 549             is_local=0,
 550             is_classify=0,
 551             is_multipath=0,
 552             not_last=0):
 553         """
 554
 555         :param dst_address_length:
 556         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 557         :param dst_address:
 558         :param next_hop_address:
 559         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 560         :param vrf_id:  (Default value = 0)
 561         :param lookup_in_vrf:  (Default value = 0)
 562         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 563         :param create_vrf_if_needed:  (Default value = 0)
 564         :param is_add:  (Default value = 1)
 565         :param is_drop:  (Default value = 0)
 566         :param is_ipv6:  (Default value = 0)
 567         :param is_local:  (Default value = 0)
 568         :param is_classify:  (Default value = 0)
 569         :param is_multipath:  (Default value = 0)
 570         :param is_resolve_host:  (Default value = 0)
 571         :param is_resolve_attached:  (Default value = 0)
 572         :param not_last:  (Default value = 0)
 573         :param next_hop_weight:  (Default value = 1)
 574
 575         """
 576
 577         return self.api(
 578             self.papi.ip_add_del_route,
 579             {'next_hop_sw_if_index': next_hop_sw_if_index,
 580              'table_id': table_id,
 581              'classify_table_index': classify_table_index,
 582              'next_hop_table_id': next_hop_table_id,
 583              'create_vrf_if_needed': create_vrf_if_needed,
 584              'is_add': is_add,
 585              'is_drop': is_drop,
 586              'is_unreach': is_unreach,
 587              'is_prohibit': is_prohibit,
 588              'is_ipv6': is_ipv6,
 589              'is_local': is_local,
 590              'is_classify': is_classify,
 591              'is_multipath': is_multipath,
 592              'is_resolve_host': is_resolve_host,
 593              'is_resolve_attached': is_resolve_attached,
 594              'not_last': not_last,
 595              'next_hop_weight': next_hop_weight,
 596              'dst_address_length': dst_address_length,
 597              'dst_address': dst_address,
 598              'next_hop_address': next_hop_address,
 599              'next_hop_n_out_labels': next_hop_n_out_labels,
 600              'next_hop_via_label': next_hop_via_label,
 601              'next_hop_out_label_stack': next_hop_out_label_stack})
 602
 603     def ip_fib_dump(self):
 604         return self.api(self.papi.ip_fib_dump, {})
 605
 606     def ip6_fib_dump(self):
 607         return self.api(self.papi.ip6_fib_dump, {})
 608
 609     def ip_neighbor_add_del(self,
 610                             sw_if_index,
 611                             mac_address,
 612                             dst_address,
 613                             vrf_id=0,
 614                             is_add=1,
 615                             is_ipv6=0,
 616                             is_static=0,
 617                             ):
 618         """ Add neighbor MAC to IPv4 or IPv6 address.
 619
 620         :param sw_if_index:
 621         :param mac_address:
 622         :param dst_address:
 623         :param vrf_id:  (Default value = 0)
 624         :param is_add:  (Default value = 1)
 625         :param is_ipv6:  (Default value = 0)
 626         :param is_static:  (Default value = 0)
 627         """
 628
 629         return self.api(
 630             self.papi.ip_neighbor_add_del,
 631             {'vrf_id': vrf_id,
 632              'sw_if_index': sw_if_index,
 633              'is_add': is_add,
 634              'is_ipv6': is_ipv6,
 635              'is_static': is_static,
 636              'mac_address': mac_address,
 637              'dst_address': dst_address
 638              }
 639         )
 640
 641     def reset_vrf(self,
 642                   vrf_id,
 643                   is_ipv6=0,
 644                   ):
 645         """ Reset VRF (remove all routes etc.) request.
 646
 647         :param int vrf_id: ID of the FIB table / VRF to reset.
 648         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 649         """
 650
 651         return self.api(
 652             self.papi.reset_vrf,
 653             {'vrf_id': vrf_id,
 654              'is_ipv6': is_ipv6,
 655              }
 656         )
 657
 658     def reset_fib(self,
 659                   vrf_id,
 660                   is_ipv6=0,
 661                   ):
 662         """ Reset VRF (remove all routes etc.) request.
 663
 664         :param int vrf_id: ID of the FIB table / VRF to reset.
 665         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 666         """
 667
 668         return self.api(
 669             self.papi.reset_fib,
 670             {'vrf_id': vrf_id,
 671              'is_ipv6': is_ipv6,
 672              }
 673         )
 674
 675     def ip_dump(self,
 676                 is_ipv6=0,
 677                 ):
 678         """ Return IP dump.
 679
 680         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 681         """
 682
 683         return self.api(
 684             self.papi.ip_dump,
 685             {'is_ipv6': is_ipv6,
 686              }
 687         )
 688
 689     def sw_interface_span_enable_disable(
 690             self, sw_if_index_from, sw_if_index_to, state=1):
 691         """
 692
 693         :param sw_if_index_from:
 694         :param sw_if_index_to:
 695         :param state:
 696         """
 697         return self.api(self.papi.sw_interface_span_enable_disable,
 698                         {'sw_if_index_from': sw_if_index_from,
 699                          'sw_if_index_to': sw_if_index_to,
 700                          'state': state})
 701
 702     def gre_tunnel_add_del(self,
 703                            src_address,
 704                            dst_address,
 705                            outer_fib_id=0,
 706                            is_teb=0,
 707                            is_add=1,
 708                            is_ip6=0):
 709         """ Add a GRE tunnel
 710
 711         :param src_address:
 712         :param dst_address:
 713         :param outer_fib_id:  (Default value = 0)
 714         :param is_add:  (Default value = 1)
 715         :param is_ipv6:  (Default value = 0)
 716         :param is_teb:  (Default value = 0)
 717         """
 718
 719         return self.api(
 720             self.papi.gre_add_del_tunnel,
 721             {'is_add': is_add,
 722              'is_ipv6': is_ip6,
 723              'teb': is_teb,
 724              'src_address': src_address,
 725              'dst_address': dst_address,
 726              'outer_fib_id': outer_fib_id}
 727         )
 728
 729     def mpls_fib_dump(self):
 730         return self.api(self.papi.mpls_fib_dump, {})
 731
 732     def mpls_route_add_del(
 733             self,
 734             label,
 735             eos,
 736             next_hop_proto_is_ip4,
 737             next_hop_address,
 738             next_hop_sw_if_index=0xFFFFFFFF,
 739             table_id=0,
 740             next_hop_table_id=0,
 741             next_hop_weight=1,
 742             next_hop_n_out_labels=0,
 743             next_hop_out_label_stack=[],
 744             next_hop_via_label=MPLS_LABEL_INVALID,
 745             create_vrf_if_needed=0,
 746             is_resolve_host=0,
 747             is_resolve_attached=0,
 748             is_add=1,
 749             is_drop=0,
 750             is_multipath=0,
 751             classify_table_index=0xFFFFFFFF,
 752             is_classify=0,
 753             not_last=0):
 754         """
 755
 756         :param dst_address_length:
 757         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 758         :param dst_address:
 759         :param next_hop_address:
 760         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 761         :param vrf_id:  (Default value = 0)
 762         :param lookup_in_vrf:  (Default value = 0)
 763         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 764         :param create_vrf_if_needed:  (Default value = 0)
 765         :param is_add:  (Default value = 1)
 766         :param is_drop:  (Default value = 0)
 767         :param is_ipv6:  (Default value = 0)
 768         :param is_local:  (Default value = 0)
 769         :param is_classify:  (Default value = 0)
 770         :param is_multipath:  (Default value = 0)
 771         :param is_resolve_host:  (Default value = 0)
 772         :param is_resolve_attached:  (Default value = 0)
 773         :param not_last:  (Default value = 0)
 774         :param next_hop_weight:  (Default value = 1)
 775
 776         """
 777
 778         return self.api(
 779             self.papi.mpls_route_add_del,
 780             {'mr_label': label,
 781              'mr_eos': eos,
 782              'mr_table_id': table_id,
 783              'mr_classify_table_index': classify_table_index,
 784              'mr_create_table_if_needed': create_vrf_if_needed,
 785              'mr_is_add': is_add,
 786              'mr_is_classify': is_classify,
 787              'mr_is_multipath': is_multipath,
 788              'mr_is_resolve_host': is_resolve_host,
 789              'mr_is_resolve_attached': is_resolve_attached,
 790              'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
 791              'mr_next_hop_weight': next_hop_weight,
 792              'mr_next_hop': next_hop_address,
 793              'mr_next_hop_n_out_labels': next_hop_n_out_labels,
 794              'mr_next_hop_sw_if_index': next_hop_sw_if_index,
 795              'mr_next_hop_table_id': next_hop_table_id,
 796              'mr_next_hop_via_label': next_hop_via_label,
 797              'mr_next_hop_out_label_stack': next_hop_out_label_stack})
 798
 799     def mpls_ip_bind_unbind(
 800             self,
 801             label,
 802             dst_address,
 803             dst_address_length,
 804             table_id=0,
 805             ip_table_id=0,
 806             is_ip4=1,
 807             create_vrf_if_needed=0,
 808             is_bind=1):
 809         """
 810         """
 811         return self.api(
 812             self.papi.mpls_ip_bind_unbind,
 813             {'mb_mpls_table_id': table_id,
 814              'mb_label': label,
 815              'mb_ip_table_id': ip_table_id,
 816              'mb_create_table_if_needed': create_vrf_if_needed,
 817              'mb_is_bind': is_bind,
 818              'mb_is_ip4': is_ip4,
 819              'mb_address_length': dst_address_length,
 820              'mb_address': dst_address})
 821
 822     def mpls_tunnel_add_del(
 823             self,
 824             tun_sw_if_index,
 825             next_hop_proto_is_ip4,
 826             next_hop_address,
 827             next_hop_sw_if_index=0xFFFFFFFF,
 828             next_hop_table_id=0,
 829             next_hop_weight=1,
 830             next_hop_n_out_labels=0,
 831             next_hop_out_label_stack=[],
 832             next_hop_via_label=MPLS_LABEL_INVALID,
 833             create_vrf_if_needed=0,
 834             is_add=1,
 835             l2_only=0):
 836         """
 837
 838         :param dst_address_length:
 839         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 840         :param dst_address:
 841         :param next_hop_address:
 842         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 843         :param vrf_id:  (Default value = 0)
 844         :param lookup_in_vrf:  (Default value = 0)
 845         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 846         :param create_vrf_if_needed:  (Default value = 0)
 847         :param is_add:  (Default value = 1)
 848         :param is_drop:  (Default value = 0)
 849         :param is_ipv6:  (Default value = 0)
 850         :param is_local:  (Default value = 0)
 851         :param is_classify:  (Default value = 0)
 852         :param is_multipath:  (Default value = 0)
 853         :param is_resolve_host:  (Default value = 0)
 854         :param is_resolve_attached:  (Default value = 0)
 855         :param not_last:  (Default value = 0)
 856         :param next_hop_weight:  (Default value = 1)
 857
 858         """
 859         return self.api(
 860             self.papi.mpls_tunnel_add_del,
 861             {'mt_sw_if_index': tun_sw_if_index,
 862              'mt_is_add': is_add,
 863              'mt_l2_only': l2_only,
 864              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
 865              'mt_next_hop_weight': next_hop_weight,
 866              'mt_next_hop': next_hop_address,
 867              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
 868              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
 869              'mt_next_hop_table_id': next_hop_table_id,
 870              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
 871
 872     def snat_interface_add_del_feature(
 873             self,
 874             sw_if_index,
 875             is_inside=1,
 876             is_add=1):
 877         """Enable/disable S-NAT feature on the interface
 878
 879         :param sw_if_index: Software index of the interface
 880         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
 881         :param is_add: 1 if add, 0 if delete (Default value = 1)
 882         """
 883         return self.api(
 884             self.papi.snat_interface_add_del_feature,
 885             {'is_add': is_add,
 886              'is_inside': is_inside,
 887              'sw_if_index': sw_if_index})
 888
 889     def snat_add_static_mapping(
 890             self,
 891             local_ip,
 892             external_ip=0,
 893             external_sw_if_index=0xFFFFFFFF,
 894             local_port=0,
 895             external_port=0,
 896             addr_only=1,
 897             vrf_id=0,
 898             protocol=0,
 899             is_add=1,
 900             is_ip4=1):
 901         """Add/delete S-NAT static mapping
 902
 903         :param local_ip: Local IP address
 904         :param external_ip: External IP address
 905         :param external_sw_if_index: External interface instead of IP address
 906         :param local_port: Local port number (Default value = 0)
 907         :param external_port: External port number (Default value = 0)
 908         :param addr_only: 1 if address only mapping, 0 if address and port
 909         :param vrf_id: VRF ID
 910         :param protocol: IP protocol (Default value = 0)
 911         :param is_add: 1 if add, 0 if delete (Default value = 1)
 912         :param is_ip4: 1 if address type is IPv4 (Default value = 1)
 913         """
 914         return self.api(
 915             self.papi.snat_add_static_mapping,
 916             {'is_add': is_add,
 917              'is_ip4': is_ip4,
 918              'addr_only': addr_only,
 919              'local_ip_address': local_ip,
 920              'external_ip_address': external_ip,
 921              'local_port': local_port,
 922              'external_port': external_port,
 923              'external_sw_if_index': external_sw_if_index,
 924              'vrf_id': vrf_id,
 925              'protocol': protocol})
 926
 927     def snat_add_address_range(
 928             self,
 929             first_ip_address,
 930             last_ip_address,
 931             is_add=1,
 932             is_ip4=1):
 933         """Add/del S-NAT address range
 934
 935         :param first_ip_address: First IP address
 936         :param last_ip_address: Last IP address
 937         :param is_add: 1 if add, 0 if delete (Default value = 1)
 938         :param is_ip4: 1 if address type is IPv4 (Default value = 1)
 939         """
 940         return self.api(
 941             self.papi.snat_add_address_range,
 942             {'is_ip4': is_ip4,
 943              'first_ip_address': first_ip_address,
 944              'last_ip_address': last_ip_address,
 945              'is_add': is_add})
 946
 947     def snat_address_dump(self):
 948         """Dump S-NAT addresses
 949         :return: Dictionary of S-NAT addresses
 950         """
 951         return self.api(self.papi.snat_address_dump, {})
 952
 953     def snat_interface_dump(self):
 954         """Dump interfaces with S-NAT feature
 955         :return: Dictionary of interfaces with S-NAT feature
 956         """
 957         return self.api(self.papi.snat_interface_dump, {})
 958
 959     def snat_static_mapping_dump(self):
 960         """Dump S-NAT static mappings
 961         :return: Dictionary of S-NAT static mappings
 962         """
 963         return self.api(self.papi.snat_static_mapping_dump, {})
 964
 965     def snat_show_config(self):
 966         """Show S-NAT config
 967         :return: S-NAT config parameters
 968         """
 969         return self.api(self.papi.snat_show_config, {})
 970
 971     def snat_add_interface_addr(
 972             self,
 973             sw_if_index,
 974             is_add=1):
 975         """Add/del S-NAT address from interface
 976
 977         :param sw_if_index: Software index of the interface
 978         :param is_add: 1 if add, 0 if delete (Default value = 1)
 979         """
 980         return self.api(self.papi.snat_add_del_interface_addr,
 981                         {'is_add': is_add, 'sw_if_index': sw_if_index})
 982
 983     def snat_interface_addr_dump(self):
 984         """Dump S-NAT addresses interfaces
 985         :return: Dictionary of S-NAT addresses interfaces
 986         """
 987         return self.api(self.papi.snat_interface_addr_dump, {})
 988
 989     def snat_ipfix(
 990             self,
 991             domain_id=1,
 992             src_port=4739,
 993             enable=1):
 994         """Enable/disable S-NAT IPFIX logging
 995
 996         :param domain_id: Observation domain ID (Default value = 1)
 997         :param src_port: Source port number (Default value = 4739)
 998         :param enable: 1 if enable, 0 if disable (Default value = 1)
 999         """
1000         return self.api(
1001             self.papi.snat_ipfix_enable_disable,
1002             {'domain_id': domain_id,
1003              'src_port': src_port,
1004              'enable': enable})
1005
1006     def control_ping(self):
1007         self.api(self.papi.control_ping)
1008
1009     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1010                     detect_mult, local_addr, peer_addr, is_ipv6=0,
1011                     bfd_key_id=None, conf_key_id=None):
1012         if bfd_key_id is None:
1013             return self.api(self.papi.bfd_udp_add,
1014                             {
1015                                 'sw_if_index': sw_if_index,
1016                                 'desired_min_tx': desired_min_tx,
1017                                 'required_min_rx': required_min_rx,
1018                                 'local_addr': local_addr,
1019                                 'peer_addr': peer_addr,
1020                                 'is_ipv6': is_ipv6,
1021                                 'detect_mult': detect_mult,
1022                             })
1023         else:
1024             return self.api(self.papi.bfd_udp_add,
1025                             {
1026                                 'sw_if_index': sw_if_index,
1027                                 'desired_min_tx': desired_min_tx,
1028                                 'required_min_rx': required_min_rx,
1029                                 'local_addr': local_addr,
1030                                 'peer_addr': peer_addr,
1031                                 'is_ipv6': is_ipv6,
1032                                 'detect_mult': detect_mult,
1033                                 'is_authenticated': 1,
1034                                 'bfd_key_id': bfd_key_id,
1035                                 'conf_key_id': conf_key_id,
1036                             })
1037
1038     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1039                     detect_mult, local_addr, peer_addr, is_ipv6=0):
1040         return self.api(self.papi.bfd_udp_mod,
1041                         {
1042                             'sw_if_index': sw_if_index,
1043                             'desired_min_tx': desired_min_tx,
1044                             'required_min_rx': required_min_rx,
1045                             'local_addr': local_addr,
1046                             'peer_addr': peer_addr,
1047                             'is_ipv6': is_ipv6,
1048                             'detect_mult': detect_mult,
1049                         })
1050
1051     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1052                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1053                               is_delayed=False):
1054         return self.api(self.papi.bfd_udp_auth_activate,
1055                         {
1056                             'sw_if_index': sw_if_index,
1057                             'local_addr': local_addr,
1058                             'peer_addr': peer_addr,
1059                             'is_ipv6': is_ipv6,
1060                             'is_delayed': 1 if is_delayed else 0,
1061                             'bfd_key_id': bfd_key_id,
1062                             'conf_key_id': conf_key_id,
1063                         })
1064
1065     def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1066                                 is_ipv6=0, is_delayed=False):
1067         return self.api(self.papi.bfd_udp_auth_deactivate,
1068                         {
1069                             'sw_if_index': sw_if_index,
1070                             'local_addr': local_addr,
1071                             'peer_addr': peer_addr,
1072                             'is_ipv6': is_ipv6,
1073                             'is_delayed': 1 if is_delayed else 0,
1074                         })
1075
1076     def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1077         return self.api(self.papi.bfd_udp_del,
1078                         {
1079                             'sw_if_index': sw_if_index,
1080                             'local_addr': local_addr,
1081                             'peer_addr': peer_addr,
1082                             'is_ipv6': is_ipv6,
1083                         })
1084
1085     def bfd_udp_session_dump(self):
1086         return self.api(self.papi.bfd_udp_session_dump, {})
1087
1088     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1089                                   peer_addr, is_ipv6=0):
1090         return self.api(self.papi.bfd_udp_session_set_flags, {
1091             'admin_up_down': admin_up_down,
1092             'sw_if_index': sw_if_index,
1093             'local_addr': local_addr,
1094             'peer_addr': peer_addr,
1095             'is_ipv6': is_ipv6,
1096         })
1097
1098     def want_bfd_events(self, enable_disable=1):
1099         return self.api(self.papi.want_bfd_events, {
1100             'enable_disable': enable_disable,
1101             'pid': os.getpid(),
1102         })
1103
1104     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1105         return self.api(self.papi.bfd_auth_set_key, {
1106             'conf_key_id': conf_key_id,
1107             'auth_type': auth_type,
1108             'key': key,
1109             'key_len': len(key),
1110         })
1111
1112     def bfd_auth_del_key(self, conf_key_id):
1113         return self.api(self.papi.bfd_auth_del_key, {
1114             'conf_key_id': conf_key_id,
1115         })
1116
1117     def bfd_auth_keys_dump(self):
1118         return self.api(self.papi.bfd_auth_keys_dump, {})
1119
1120     def classify_add_del_table(
1121             self,
1122             is_add,
1123             mask,
1124             match_n_vectors=1,
1125             table_index=0xFFFFFFFF,
1126             nbuckets=2,
1127             memory_size=2097152,
1128             skip_n_vectors=0,
1129             next_table_index=0xFFFFFFFF,
1130             miss_next_index=0xFFFFFFFF,
1131             current_data_flag=0,
1132             current_data_offset=0):
1133         """
1134         :param is_add:
1135         :param mask:
1136         :param match_n_vectors: (Default value = 1)
1137         :param table_index: (Default value = 0xFFFFFFFF)
1138         :param nbuckets:  (Default value = 2)
1139         :param memory_size:  (Default value = 2097152)
1140         :param skip_n_vectors:  (Default value = 0)
1141         :param next_table_index:  (Default value = 0xFFFFFFFF)
1142         :param miss_next_index:  (Default value = 0xFFFFFFFF)
1143         :param current_data_flag:  (Default value = 0)
1144         :param current_data_offset:  (Default value = 0)
1145         """
1146
1147         return self.api(
1148             self.papi.classify_add_del_table,
1149             {'is_add': is_add,
1150              'table_index': table_index,
1151              'nbuckets': nbuckets,
1152              'memory_size': memory_size,
1153              'skip_n_vectors': skip_n_vectors,
1154              'match_n_vectors': match_n_vectors,
1155              'next_table_index': next_table_index,
1156              'miss_next_index': miss_next_index,
1157              'current_data_flag': current_data_flag,
1158              'current_data_offset': current_data_offset,
1159              'mask': mask})
1160
1161     def classify_add_del_session(
1162             self,
1163             is_add,
1164             table_index,
1165             match,
1166             opaque_index=0xFFFFFFFF,
1167             hit_next_index=0xFFFFFFFF,
1168             advance=0,
1169             action=0,
1170             metadata=0):
1171         """
1172         :param is_add:
1173         :param table_index:
1174         :param match:
1175         :param opaque_index:  (Default value = 0xFFFFFFFF)
1176         :param hit_next_index:  (Default value = 0xFFFFFFFF)
1177         :param advance:  (Default value = 0)
1178         :param action:  (Default value = 0)
1179         :param metadata:  (Default value = 0)
1180         """
1181
1182         return self.api(
1183             self.papi.classify_add_del_session,
1184             {'is_add': is_add,
1185              'table_index': table_index,
1186              'hit_next_index': hit_next_index,
1187              'opaque_index': opaque_index,
1188              'advance': advance,
1189              'action': action,
1190              'metadata': metadata,
1191              'match': match})
1192
1193     def input_acl_set_interface(
1194             self,
1195             is_add,
1196             sw_if_index,
1197             ip4_table_index=0xFFFFFFFF,
1198             ip6_table_index=0xFFFFFFFF,
1199             l2_table_index=0xFFFFFFFF):
1200         """
1201         :param is_add:
1202         :param sw_if_index:
1203         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
1204         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
1205         :param l2_table_index:  (Default value = 0xFFFFFFFF)
1206         """
1207
1208         return self.api(
1209             self.papi.input_acl_set_interface,
1210             {'sw_if_index': sw_if_index,
1211              'ip4_table_index': ip4_table_index,
1212              'ip6_table_index': ip6_table_index,
1213              'l2_table_index': l2_table_index,
1214              'is_add': is_add})
1215
1216     def set_ipfix_exporter(
1217             self,
1218             collector_address,
1219             src_address,
1220             path_mtu,
1221             template_interval,
1222             vrf_id=0,
1223             collector_port=4739,
1224             udp_checksum=0):
1225         return self.api(
1226             self.papi.set_ipfix_exporter,
1227             {
1228                 'collector_address': collector_address,
1229                 'collector_port': collector_port,
1230                 'src_address': src_address,
1231                 'vrf_id': vrf_id,
1232                 'path_mtu': path_mtu,
1233                 'template_interval': template_interval,
1234                 'udp_checksum': udp_checksum,
1235             })
1236
1237     def dhcp_proxy_config(self,
1238                           dhcp_server,
1239                           dhcp_src_address,
1240                           rx_table_id=0,
1241                           server_table_id=0,
1242                           is_add=1,
1243                           is_ipv6=0):
1244         return self.api(
1245             self.papi.dhcp_proxy_config,
1246             {
1247                 'rx_vrf_id': rx_table_id,
1248                 'server_vrf_id': server_table_id,
1249                 'is_ipv6': is_ipv6,
1250                 'is_add': is_add,
1251                 'dhcp_server': dhcp_server,
1252                 'dhcp_src_address': dhcp_src_address,
1253             })
1254
1255     def dhcp_proxy_set_vss(self,
1256                            table_id,
1257                            fib_id,
1258                            oui,
1259                            is_add=1,
1260                            is_ip6=0):
1261         return self.api(
1262             self.papi.dhcp_proxy_set_vss,
1263             {
1264                 'tbl_id': table_id,
1265                 'fib_id': fib_id,
1266                 'is_ipv6': is_ip6,
1267                 'is_add': is_add,
1268                 'oui': oui,
1269             })
1270
1271     def ip_mroute_add_del(self,
1272                           src_address,
1273                           grp_address,
1274                           grp_address_length,
1275                           e_flags,
1276                           next_hop_sw_if_index,
1277                           i_flags,
1278                           table_id=0,
1279                           create_vrf_if_needed=0,
1280                           is_add=1,
1281                           is_ipv6=0,
1282                           is_local=0):
1283         """
1284         """
1285         return self.api(
1286             self.papi.ip_mroute_add_del,
1287             {'next_hop_sw_if_index': next_hop_sw_if_index,
1288              'entry_flags': e_flags,
1289              'itf_flags': i_flags,
1290              'create_vrf_if_needed': create_vrf_if_needed,
1291              'is_add': is_add,
1292              'is_ipv6': is_ipv6,
1293              'is_local': is_local,
1294              'grp_address_length': grp_address_length,
1295              'grp_address': grp_address,
1296              'src_address': src_address})
1297
1298     def mfib_signal_dump(self):
1299         return self.api(self.papi.mfib_signal_dump, {})
1300
1301     def ip_mfib_dump(self):
1302         return self.api(self.papi.ip_mfib_dump, {})
1303
1304     def lisp_enable_disable(self, is_enabled):
1305         return self.api(
1306             self.papi.lisp_enable_disable,
1307             {
1308                 'is_en': is_enabled,
1309             })
1310
1311     def lisp_locator_set(self,
1312                          ls_name,
1313                          is_add=1):
1314         return self.api(
1315             self.papi.lisp_add_del_locator_set,
1316             {
1317                 'is_add': is_add,
1318                 'locator_set_name': ls_name
1319             })
1320
1321     def lisp_locator_set_dump(self):
1322         return self.api(self.papi.lisp_locator_set_dump, {})
1323
1324     def lisp_locator(self,
1325                      ls_name,
1326                      sw_if_index,
1327                      priority=1,
1328                      weight=1,
1329                      is_add=1):
1330         return self.api(
1331             self.papi.lisp_add_del_locator,
1332             {
1333                 'is_add': is_add,
1334                 'locator_set_name': ls_name,
1335                 'sw_if_index': sw_if_index,
1336                 'priority': priority,
1337                 'weight': weight
1338             })
1339
1340     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1341         return self.api(
1342             self.papi.lisp_locator_dump,
1343             {
1344                 'is_index_set': is_index_set,
1345                 'ls_name': ls_name,
1346                 'ls_index': ls_index,
1347             })
1348
1349     def lisp_local_mapping(self,
1350                            ls_name,
1351                            eid_type,
1352                            eid,
1353                            prefix_len,
1354                            vni=0,
1355                            key_id=0,
1356                            key="",
1357                            is_add=1):
1358         return self.api(
1359             self.papi.lisp_add_del_local_eid,
1360             {
1361                 'locator_set_name': ls_name,
1362                 'is_add': is_add,
1363                 'eid_type': eid_type,
1364                 'eid': eid,
1365                 'prefix_len': prefix_len,
1366                 'vni': vni,
1367                 'key_id': key_id,
1368                 'key': key
1369             })
1370
1371     def lisp_eid_table_dump(self,
1372                             eid_set=0,
1373                             prefix_length=0,
1374                             vni=0,
1375                             eid_type=0,
1376                             eid=None,
1377                             filter_opt=0):
1378         return self.api(
1379             self.papi.lisp_eid_table_dump,
1380             {
1381                 'eid_set': eid_set,
1382                 'prefix_length': prefix_length,
1383                 'vni': vni,
1384                 'eid_type': eid_type,
1385                 'eid': eid,
1386                 'filter': filter_opt,
1387             })
1388
1389     def lisp_remote_mapping(self,
1390                             eid_type,
1391                             eid,
1392                             eid_prefix_len=0,
1393                             vni=0,
1394                             rlocs=None,
1395                             rlocs_num=0,
1396                             is_src_dst=0,
1397                             is_add=1):
1398         return self.api(
1399             self.papi.lisp_add_del_remote_mapping,
1400             {
1401                 'is_add': is_add,
1402                 'eid_type': eid_type,
1403                 'eid': eid,
1404                 'eid_len': eid_prefix_len,
1405                 'rloc_num': rlocs_num,
1406                 'rlocs': rlocs,
1407                 'vni': vni,
1408                 'is_src_dst': is_src_dst,
1409             })
1410
1411     def lisp_adjacency(self,
1412                        leid,
1413                        reid,
1414                        leid_len,
1415                        reid_len,
1416                        eid_type,
1417                        is_add=1,
1418                        vni=0):
1419         return self.api(
1420             self.papi.lisp_add_del_adjacency,
1421             {
1422                 'is_add': is_add,
1423                 'vni': vni,
1424                 'eid_type': eid_type,
1425                 'leid': leid,
1426                 'reid': reid,
1427                 'leid_len': leid_len,
1428                 'reid_len': reid_len,
1429             })
1430
1431     def lisp_adjacencies_get(self, vni=0):
1432         return self.api(
1433             self.papi.lisp_adjacencies_get,
1434             {
1435                 'vni': vni
1436             })