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
   9 # the vpp_papi_provider.py file to be importable without having to build
  10 # the whole 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_DISABLED = 0
  29     L2_PUSH_1 = 1
  30     L2_PUSH_2 = 2
  31     L2_POP_1 = 3
  32     L2_POP_2 = 4
  33     L2_TRANSLATE_1_1 = 5
  34     L2_TRANSLATE_1_2 = 6
  35     L2_TRANSLATE_2_1 = 7
  36     L2_TRANSLATE_2_2 = 8
  37
  38
  39 class UnexpectedApiReturnValueError(Exception):
  40     """ exception raised when the API return value is unexpected """
  41     pass
  42
  43
  44 class VppPapiProvider(object):
  45     """VPP-api provider using vpp-papi
  46
  47     @property hook: hook object providing before and after api/cli hooks
  48     """
  49
  50     _zero, _negative = range(2)
  51
  52     def __init__(self, name, shm_prefix, test_class):
  53         self.hook = Hook("vpp-papi-provider")
  54         self.name = name
  55         self.shm_prefix = shm_prefix
  56         self.test_class = test_class
  57         self._expect_api_retval = self._zero
  58         self._expect_stack = []
  59         jsonfiles = []
  60
  61         install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
  62         for root, dirnames, filenames in os.walk(install_dir):
  63             for filename in fnmatch.filter(filenames, '*.api.json'):
  64                 jsonfiles.append(os.path.join(root, filename))
  65
  66         self.vpp = VPP(jsonfiles, logger=test_class.logger)
  67         self._events = deque()
  68
  69     def __enter__(self):
  70         return self
  71
  72     def expect_negative_api_retval(self):
  73         """ Expect API failure """
  74         self._expect_stack.append(self._expect_api_retval)
  75         self._expect_api_retval = self._negative
  76         return self
  77
  78     def expect_zero_api_retval(self):
  79         """ Expect API success """
  80         self._expect_stack.append(self._expect_api_retval)
  81         self._expect_api_retval = self._zero
  82         return self
  83
  84     def __exit__(self, exc_type, exc_value, traceback):
  85         self._expect_api_retval = self._expect_stack.pop()
  86
  87     def register_hook(self, hook):
  88         """Replace hook registration with new hook
  89
  90         :param hook:
  91
  92         """
  93         self.hook = hook
  94
  95     def collect_events(self):
  96         """ Collect all events from the internal queue and clear the queue. """
  97         e = self._events
  98         self._events = deque()
  99         return e
 100
 101     def wait_for_event(self, timeout, name=None):
 102         """ Wait for and return next event. """
 103         if name:
 104             self.test_class.logger.debug("Expecting event within %ss",
 105                                          timeout)
 106         else:
 107             self.test_class.logger.debug("Expecting event '%s' within %ss",
 108                                          name, timeout)
 109         if self._events:
 110             self.test_class.logger.debug("Not waiting, event already queued")
 111         limit = time.time() + timeout
 112         while time.time() < limit:
 113             if self._events:
 114                 e = self._events.popleft()
 115                 if name and type(e).__name__ != name:
 116                     raise Exception(
 117                         "Unexpected event received: %s, expected: %s" %
 118                         (type(e).__name__, name))
 119                 self.test_class.logger.debug("Returning event %s:%s" %
 120                                              (name, e))
 121                 return e
 122             time.sleep(0)  # yield
 123         raise Exception("Event did not occur within timeout")
 124
 125     def __call__(self, name, event):
 126         """ Enqueue event in the internal event queue. """
 127         # FIXME use the name instead of relying on type(e).__name__ ?
 128         # FIXME #2 if this throws, it is eaten silently, Ole?
 129         self.test_class.logger.debug("New event: %s: %s" % (name, event))
 130         self._events.append(event)
 131
 132     def connect(self):
 133         """Connect the API to VPP"""
 134         self.vpp.connect(self.name, self.shm_prefix)
 135         self.papi = self.vpp.api
 136         self.vpp.register_event_callback(self)
 137
 138     def disconnect(self):
 139         """Disconnect the API from VPP"""
 140         self.vpp.disconnect()
 141
 142     def api(self, api_fn, api_args, expected_retval=0):
 143         """ Call API function and check it's return value.
 144         Call the appropriate hooks before and after the API call
 145
 146         :param api_fn: API function to call
 147         :param api_args: tuple of API function arguments
 148         :param expected_retval: Expected return value (Default value = 0)
 149         :returns: reply from the API
 150
 151         """
 152         self.hook.before_api(api_fn.__name__, api_args)
 153         reply = api_fn(**api_args)
 154         if self._expect_api_retval == self._negative:
 155             if hasattr(reply, 'retval') and reply.retval >= 0:
 156                 msg = "API call passed unexpectedly: expected negative "\
 157                     "return value instead of %d in %s" % \
 158                     (reply.retval, repr(reply))
 159                 self.test_class.logger.info(msg)
 160                 raise UnexpectedApiReturnValueError(msg)
 161         elif self._expect_api_retval == self._zero:
 162             if hasattr(reply, 'retval') and reply.retval != expected_retval:
 163                 msg = "API call failed, expected %d return value instead "\
 164                     "of %d in %s" % (expected_retval, reply.retval,
 165                                      repr(reply))
 166                 self.test_class.logger.info(msg)
 167                 raise UnexpectedApiReturnValueError(msg)
 168         else:
 169             raise Exception("Internal error, unexpected value for "
 170                             "self._expect_api_retval %s" %
 171                             self._expect_api_retval)
 172         self.hook.after_api(api_fn.__name__, api_args)
 173         return reply
 174
 175     def cli(self, cli):
 176         """ Execute a CLI, calling the before/after hooks appropriately.
 177
 178         :param cli: CLI to execute
 179         :returns: CLI output
 180
 181         """
 182         self.hook.before_cli(cli)
 183         cli += '\n'
 184         r = self.papi.cli_inband(length=len(cli), cmd=cli)
 185         self.hook.after_cli(cli)
 186         if hasattr(r, 'reply'):
 187             return r.reply.decode().rstrip('\x00')
 188
 189     def ppcli(self, cli):
 190         """ Helper method to print CLI command in case of info logging level.
 191
 192         :param cli: CLI to execute
 193         :returns: CLI output
 194         """
 195         return cli + "\n" + str(self.cli(cli))
 196
 197     def _convert_mac(self, mac):
 198         return int(mac.replace(":", ""), 16) << 16
 199
 200     def show_version(self):
 201         """ """
 202         return self.api(self.papi.show_version, {})
 203
 204     def pg_create_interface(self, pg_index):
 205         """
 206
 207         :param pg_index:
 208
 209         """
 210         return self.api(self.papi.pg_create_interface,
 211                         {"interface_id": pg_index})
 212
 213     def sw_interface_dump(self, filter=None):
 214         """
 215
 216         :param filter:  (Default value = None)
 217
 218         """
 219         if filter is not None:
 220             args = {"name_filter_valid": 1, "name_filter": filter}
 221         else:
 222             args = {}
 223         return self.api(self.papi.sw_interface_dump, args)
 224
 225     def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
 226         """ Set the IPvX Table-id for the Interface
 227
 228         :param sw_if_index:
 229         :param is_ipv6:
 230         :param table_id:
 231
 232         """
 233         return self.api(self.papi.sw_interface_set_table,
 234                         {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
 235                          'vrf_id': table_id})
 236
 237     def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
 238                                      is_ipv6=0, is_add=1, del_all=0):
 239         """
 240
 241         :param addr: param is_ipv6:  (Default value = 0)
 242         :param sw_if_index:
 243         :param addr_len:
 244         :param is_ipv6:  (Default value = 0)
 245         :param is_add:  (Default value = 1)
 246         :param del_all:  (Default value = 0)
 247
 248         """
 249         return self.api(self.papi.sw_interface_add_del_address,
 250                         {'sw_if_index': sw_if_index,
 251                          'is_add': is_add,
 252                          'is_ipv6': is_ipv6,
 253                          'del_all': del_all,
 254                          'address_length': addr_len,
 255                          'address': addr})
 256
 257     def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
 258                                     is_add=1):
 259         """ Set the Interface to be unnumbered
 260
 261         :param is_add:  (Default value = 1)
 262         :param sw_if_index - interface That will be unnumbered
 263         :param ip_sw_if_index - interface with an IP addres
 264
 265         """
 266         return self.api(self.papi.sw_interface_set_unnumbered,
 267                         {'sw_if_index': ip_sw_if_index,
 268                          'unnumbered_sw_if_index': sw_if_index,
 269                          'is_add': is_add})
 270
 271     def sw_interface_enable_disable_mpls(self, sw_if_index,
 272                                          is_enable=1):
 273         """
 274         Enable/Disable MPLS on the interface
 275         :param sw_if_index:
 276         :param is_enable:  (Default value = 1)
 277
 278         """
 279         return self.api(self.papi.sw_interface_set_mpls_enable,
 280                         {'sw_if_index': sw_if_index,
 281                          'enable': is_enable})
 282
 283     def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
 284         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 285                         {'sw_if_index': sw_if_index,
 286                          'suppress': suppress})
 287
 288     def set_ip_flow_hash(self,
 289                          table_id,
 290                          src=1,
 291                          dst=1,
 292                          sport=1,
 293                          dport=1,
 294                          proto=1,
 295                          reverse=0,
 296                          is_ip6=0):
 297         return self.api(self.papi.set_ip_flow_hash,
 298                         {'vrf_id': table_id,
 299                          'src': src,
 300                          'dst': dst,
 301                          'dport': dport,
 302                          'sport': sport,
 303                          'proto': proto,
 304                          'reverse': reverse,
 305                          'is_ipv6': is_ip6})
 306
 307     def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
 308         return self.api(self.papi.ip6nd_proxy_add_del,
 309                         {'address': address,
 310                          'sw_if_index': sw_if_index,
 311                          'is_del': is_del})
 312
 313     def ip6_sw_interface_ra_config(self, sw_if_index,
 314                                    no,
 315                                    suppress,
 316                                    send_unicast):
 317         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 318                         {'sw_if_index': sw_if_index,
 319                          'is_no': no,
 320                          'suppress': suppress,
 321                          'send_unicast': send_unicast})
 322
 323     def ip6_sw_interface_ra_prefix(self,
 324                                    sw_if_index,
 325                                    address,
 326                                    address_length,
 327                                    use_default=0,
 328                                    no_advertise=0,
 329                                    off_link=0,
 330                                    no_autoconfig=0,
 331                                    no_onlink=0,
 332                                    is_no=0,
 333                                    val_lifetime=0xffffffff,
 334                                    pref_lifetime=0xffffffff):
 335         return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
 336                         {'sw_if_index': sw_if_index,
 337                          'address': address,
 338                          'address_length': address_length,
 339                          'use_default': use_default,
 340                          'no_advertise': no_advertise,
 341                          'off_link': off_link,
 342                          'no_autoconfig': no_autoconfig,
 343                          'no_onlink': no_onlink,
 344                          'is_no': is_no,
 345                          'val_lifetime': val_lifetime,
 346                          'pref_lifetime': pref_lifetime})
 347
 348     def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
 349         """
 350         Enable/Disable An interface for IPv6
 351         """
 352         return self.api(self.papi.sw_interface_ip6_enable_disable,
 353                         {'sw_if_index': sw_if_index,
 354                          'enable': enable})
 355
 356     def vxlan_add_del_tunnel(
 357             self,
 358             src_addr,
 359             dst_addr,
 360             mcast_sw_if_index=0xFFFFFFFF,
 361             is_add=1,
 362             is_ipv6=0,
 363             encap_vrf_id=0,
 364             decap_next_index=0xFFFFFFFF,
 365             vni=0):
 366         """
 367
 368         :param dst_addr:
 369         :param src_addr:
 370         :param is_add:  (Default value = 1)
 371         :param is_ipv6:  (Default value = 0)
 372         :param encap_vrf_id:  (Default value = 0)
 373         :param decap_next_index:  (Default value = 0xFFFFFFFF)
 374         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 375         :param vni:  (Default value = 0)
 376
 377         """
 378         return self.api(self.papi.vxlan_add_del_tunnel,
 379                         {'is_add': is_add,
 380                          'is_ipv6': is_ipv6,
 381                          'src_address': src_addr,
 382                          'dst_address': dst_addr,
 383                          'mcast_sw_if_index': mcast_sw_if_index,
 384                          'encap_vrf_id': encap_vrf_id,
 385                          'decap_next_index': decap_next_index,
 386                          'vni': vni})
 387
 388     def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
 389                               learn=1, arp_term=0, is_add=1):
 390         """Create/delete bridge domain.
 391
 392         :param int bd_id: Bridge domain index.
 393         :param int flood: Enable/disable bcast/mcast flooding in the BD.
 394             (Default value = 1)
 395         :param int uu_flood: Enable/disable unknown unicast flood in the BD.
 396             (Default value = 1)
 397         :param int forward: Enable/disable forwarding on all interfaces in
 398             the BD. (Default value = 1)
 399         :param int learn: Enable/disable learning on all interfaces in the BD.
 400             (Default value = 1)
 401         :param int arp_term: Enable/disable arp termination in the BD.
 402             (Default value = 1)
 403         :param int is_add: Add or delete flag. (Default value = 1)
 404         """
 405         return self.api(self.papi.bridge_domain_add_del,
 406                         {'bd_id': bd_id,
 407                          'flood': flood,
 408                          'uu_flood': uu_flood,
 409                          'forward': forward,
 410                          'learn': learn,
 411                          'arp_term': arp_term,
 412                          'is_add': is_add})
 413
 414     def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
 415         return self.api(self.papi.bd_ip_mac_add_del,
 416                         {'bd_id': bd_id,
 417                          'is_add': is_add,
 418                          'is_ipv6': is_ipv6,
 419                          'ip_address': ip,
 420                          'mac_address': mac})
 421
 422     def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
 423                       filter_mac=0, bvi_mac=0):
 424         """Create/delete L2 FIB entry.
 425
 426         :param str mac: MAC address to create FIB entry for.
 427         :param int bd_id: Bridge domain index.
 428         :param int sw_if_index: Software interface index of the interface.
 429         :param int is_add: Add or delete flag. (Default value = 1)
 430         :param int static_mac: Set to 1 to create static MAC entry.
 431             (Default value = 0)
 432         :param int filter_mac: Set to 1 to drop packet that's source or
 433             destination MAC address contains defined MAC address.
 434             (Default value = 0)
 435         :param int bvi_mac: Set to 1 to create entry that points to BVI
 436             interface. (Default value = 0)
 437         """
 438         return self.api(self.papi.l2fib_add_del,
 439                         {'mac': self._convert_mac(mac),
 440                          'bd_id': bd_id,
 441                          'sw_if_index': sw_if_index,
 442                          'is_add': is_add,
 443                          'static_mac': static_mac,
 444                          'filter_mac': filter_mac,
 445                          'bvi_mac': bvi_mac})
 446
 447     def l2fib_flush_int(self, sw_if_index):
 448         """Flush L2 FIB entries for sw_if_index.
 449
 450         :param int sw_if_index: Software interface index of the interface.
 451         """
 452         return self.api(self.papi.l2fib_flush_int,
 453                         {'sw_if_index': sw_if_index})
 454
 455     def l2fib_flush_bd(self, bd_id):
 456         """Flush L2 FIB entries for bd_id.
 457
 458         :param int sw_if_index: Bridge Domain id.
 459         """
 460         return self.api(self.papi.l2fib_flush_bd,
 461                         {'bd_id': bd_id})
 462
 463     def l2fib_flush_all(self):
 464         """Flush all L2 FIB.
 465         """
 466         return self.api(self.papi.l2fib_flush_all, {})
 467
 468     def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
 469                                    shg=0, bvi=0, enable=1):
 470         """Add/remove interface to/from bridge domain.
 471
 472         :param int sw_if_index: Software interface index of the interface.
 473         :param int bd_id: Bridge domain index.
 474         :param int shg: Split-horizon group index. (Default value = 0)
 475         :param int bvi: Set interface as a bridge group virtual interface.
 476             (Default value = 0)
 477         :param int enable: Add or remove interface. (Default value = 1)
 478         """
 479         return self.api(self.papi.sw_interface_set_l2_bridge,
 480                         {'rx_sw_if_index': sw_if_index,
 481                          'bd_id': bd_id,
 482                          'shg': shg,
 483                          'bvi': bvi,
 484                          'enable': enable})
 485
 486     def bridge_flags(self, bd_id, is_set, feature_bitmap):
 487         """Enable/disable required feature of the bridge domain with defined ID.
 488
 489         :param int bd_id: Bridge domain ID.
 490         :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
 491         :param int feature_bitmap: Bitmap value of the feature to be set:
 492             - learn (1 << 0),
 493             - forward (1 << 1),
 494             - flood (1 << 2),
 495             - uu-flood (1 << 3) or
 496             - arp-term (1 << 4).
 497         """
 498         return self.api(self.papi.bridge_flags,
 499                         {'bd_id': bd_id,
 500                          'is_set': is_set,
 501                          'feature_bitmap': feature_bitmap})
 502
 503     def bridge_domain_dump(self, bd_id=0):
 504         """
 505
 506         :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
 507             existing bridge domains returned)
 508         :return: Dictionary of bridge domain(s) data.
 509         """
 510         return self.api(self.papi.bridge_domain_dump,
 511                         {'bd_id': bd_id})
 512
 513     def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
 514                                      enable):
 515         """Create or delete unidirectional cross-connect from Tx interface to
 516         Rx interface.
 517
 518         :param int rx_sw_if_index: Software interface index of Rx interface.
 519         :param int tx_sw_if_index: Software interface index of Tx interface.
 520         :param int enable: Create cross-connect if equal to 1, delete
 521             cross-connect if equal to 0.
 522
 523         """
 524         return self.api(self.papi.sw_interface_set_l2_xconnect,
 525                         {'rx_sw_if_index': rx_sw_if_index,
 526                          'tx_sw_if_index': tx_sw_if_index,
 527                          'enable': enable})
 528
 529     def sw_interface_set_l2_tag_rewrite(
 530             self,
 531             sw_if_index,
 532             vtr_oper,
 533             push=0,
 534             tag1=0,
 535             tag2=0):
 536         """L2 interface vlan tag rewrite configure request
 537         :param client_index - opaque cookie to identify the sender
 538         :param context - sender context, to match reply w/ request
 539         :param sw_if_index - interface the operation is applied to
 540         :param vtr_op - Choose from l2_vtr_op_t enum values
 541         :param push_dot1q - first pushed flag dot1q id set, else dot1ad
 542         :param tag1 - Needed for any push or translate vtr op
 543         :param tag2 - Needed for any push 2 or translate x-2 vtr ops
 544
 545         """
 546         return self.api(self.papi.l2_interface_vlan_tag_rewrite,
 547                         {'sw_if_index': sw_if_index,
 548                          'vtr_op': vtr_oper,
 549                          'push_dot1q': push,
 550                          'tag1': tag1,
 551                          'tag2': tag2})
 552
 553     def sw_interface_set_flags(self, sw_if_index, admin_up_down,
 554                                link_up_down=0, deleted=0):
 555         """
 556
 557         :param admin_up_down:
 558         :param sw_if_index:
 559         :param link_up_down:  (Default value = 0)
 560         :param deleted:  (Default value = 0)
 561
 562         """
 563         return self.api(self.papi.sw_interface_set_flags,
 564                         {'sw_if_index': sw_if_index,
 565                          'admin_up_down': admin_up_down,
 566                          'link_up_down': link_up_down,
 567                          'deleted': deleted})
 568
 569     def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
 570                      no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
 571                      default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
 572         """Create subinterface
 573         from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
 574
 575         :param sub_id: param inner_vlan:
 576         :param sw_if_index:
 577         :param outer_vlan:
 578         :param inner_vlan:
 579         :param no_tags:  (Default value = 0)
 580         :param one_tag:  (Default value = 0)
 581         :param two_tags:  (Default value = 0)
 582         :param dot1ad:  (Default value = 0)
 583         :param exact_match:  (Default value = 0)
 584         :param default_sub:  (Default value = 0)
 585         :param outer_vlan_id_any:  (Default value = 0)
 586         :param inner_vlan_id_any:  (Default value = 0)
 587
 588         """
 589         return self.api(
 590             self.papi.create_subif,
 591             {'sw_if_index': sw_if_index,
 592              'sub_id': sub_id,
 593              'no_tags': no_tags,
 594              'one_tag': one_tag,
 595              'two_tags': two_tags,
 596              'dot1ad': dot1ad,
 597              'exact_match': exact_match,
 598              'default_sub': default_sub,
 599              'outer_vlan_id_any': outer_vlan_id_any,
 600              'inner_vlan_id_any': inner_vlan_id_any,
 601              'outer_vlan_id': outer_vlan,
 602              'inner_vlan_id': inner_vlan})
 603
 604     def delete_subif(self, sw_if_index):
 605         """Delete subinterface
 606
 607         :param sw_if_index:
 608         """
 609         return self.api(self.papi.delete_subif,
 610                         {'sw_if_index': sw_if_index})
 611
 612     def create_vlan_subif(self, sw_if_index, vlan):
 613         """
 614
 615         :param vlan:
 616         :param sw_if_index:
 617
 618         """
 619         return self.api(self.papi.create_vlan_subif,
 620                         {'sw_if_index': sw_if_index,
 621                          'vlan_id': vlan})
 622
 623     def create_loopback(self, mac=''):
 624         """
 625
 626         :param mac: (Optional)
 627         """
 628         return self.api(self.papi.create_loopback,
 629                         {'mac_address': mac})
 630
 631     def delete_loopback(self, sw_if_index):
 632         return self.api(self.papi.delete_loopback,
 633                         {'sw_if_index': sw_if_index, })
 634
 635     def ip_add_del_route(
 636             self,
 637             dst_address,
 638             dst_address_length,
 639             next_hop_address,
 640             next_hop_sw_if_index=0xFFFFFFFF,
 641             table_id=0,
 642             next_hop_table_id=0,
 643             next_hop_weight=1,
 644             next_hop_n_out_labels=0,
 645             next_hop_out_label_stack=[],
 646             next_hop_via_label=MPLS_LABEL_INVALID,
 647             create_vrf_if_needed=0,
 648             is_resolve_host=0,
 649             is_resolve_attached=0,
 650             classify_table_index=0xFFFFFFFF,
 651             is_add=1,
 652             is_drop=0,
 653             is_unreach=0,
 654             is_prohibit=0,
 655             is_ipv6=0,
 656             is_local=0,
 657             is_classify=0,
 658             is_multipath=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.ip_add_del_route,
 686             {'next_hop_sw_if_index': next_hop_sw_if_index,
 687              'table_id': table_id,
 688              'classify_table_index': classify_table_index,
 689              'next_hop_table_id': next_hop_table_id,
 690              'create_vrf_if_needed': create_vrf_if_needed,
 691              'is_add': is_add,
 692              'is_drop': is_drop,
 693              'is_unreach': is_unreach,
 694              'is_prohibit': is_prohibit,
 695              'is_ipv6': is_ipv6,
 696              'is_local': is_local,
 697              'is_classify': is_classify,
 698              'is_multipath': is_multipath,
 699              'is_resolve_host': is_resolve_host,
 700              'is_resolve_attached': is_resolve_attached,
 701              'not_last': not_last,
 702              'next_hop_weight': next_hop_weight,
 703              'dst_address_length': dst_address_length,
 704              'dst_address': dst_address,
 705              'next_hop_address': next_hop_address,
 706              'next_hop_n_out_labels': next_hop_n_out_labels,
 707              'next_hop_via_label': next_hop_via_label,
 708              'next_hop_out_label_stack': next_hop_out_label_stack})
 709
 710     def ip_fib_dump(self):
 711         return self.api(self.papi.ip_fib_dump, {})
 712
 713     def ip6_fib_dump(self):
 714         return self.api(self.papi.ip6_fib_dump, {})
 715
 716     def ip_neighbor_add_del(self,
 717                             sw_if_index,
 718                             mac_address,
 719                             dst_address,
 720                             is_add=1,
 721                             is_ipv6=0,
 722                             is_static=0,
 723                             is_no_adj_fib=0,
 724                             ):
 725         """ Add neighbor MAC to IPv4 or IPv6 address.
 726
 727         :param sw_if_index:
 728         :param mac_address:
 729         :param dst_address:
 730         :param is_add:  (Default value = 1)
 731         :param is_ipv6:  (Default value = 0)
 732         :param is_static:  (Default value = 0)
 733         :param is_no_adj_fib:  (Default value = 0)
 734         """
 735
 736         return self.api(
 737             self.papi.ip_neighbor_add_del,
 738             {'sw_if_index': sw_if_index,
 739              'is_add': is_add,
 740              'is_ipv6': is_ipv6,
 741              'is_static': is_static,
 742              'is_no_adj_fib': is_no_adj_fib,
 743              'mac_address': mac_address,
 744              'dst_address': dst_address
 745              }
 746         )
 747
 748     def ip_neighbor_dump(self,
 749                          sw_if_index,
 750                          is_ipv6=0):
 751         """ Return IP neighbor dump.
 752
 753         :param sw_if_index:
 754         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 755         """
 756
 757         return self.api(
 758             self.papi.ip_neighbor_dump,
 759             {'is_ipv6': is_ipv6,
 760              'sw_if_index': sw_if_index
 761              }
 762         )
 763
 764     def proxy_arp_add_del(self,
 765                           low_address,
 766                           hi_address,
 767                           vrf_id=0,
 768                           is_add=1):
 769         """ Config Proxy Arp Range.
 770
 771         :param low_address: Start address in the rnage to Proxy for
 772         :param hi_address: End address in the rnage to Proxy for
 773         :param vrf_id: The VRF/table in which to proxy
 774         """
 775
 776         return self.api(
 777             self.papi.proxy_arp_add_del,
 778             {'vrf_id': vrf_id,
 779              'is_add': is_add,
 780              'low_address': low_address,
 781              'hi_address': hi_address,
 782              }
 783         )
 784
 785     def proxy_arp_intfc_enable_disable(self,
 786                                        sw_if_index,
 787                                        is_enable=1):
 788         """ Enable/Disable an interface for proxy ARP requests
 789
 790         :param sw_if_index: Interface
 791         :param enable_disable: Enable/Disable
 792         """
 793
 794         return self.api(
 795             self.papi.proxy_arp_intfc_enable_disable,
 796             {'sw_if_index': sw_if_index,
 797              'enable_disable': is_enable
 798              }
 799         )
 800
 801     def reset_vrf(self,
 802                   vrf_id,
 803                   is_ipv6=0,
 804                   ):
 805         """ Reset VRF (remove all routes etc.) request.
 806
 807         :param int vrf_id: ID of the FIB table / VRF to reset.
 808         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 809         """
 810
 811         return self.api(
 812             self.papi.reset_vrf,
 813             {'vrf_id': vrf_id,
 814              'is_ipv6': is_ipv6,
 815              }
 816         )
 817
 818     def reset_fib(self,
 819                   vrf_id,
 820                   is_ipv6=0,
 821                   ):
 822         """ Reset VRF (remove all routes etc.) request.
 823
 824         :param int vrf_id: ID of the FIB table / VRF to reset.
 825         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 826         """
 827
 828         return self.api(
 829             self.papi.reset_fib,
 830             {'vrf_id': vrf_id,
 831              'is_ipv6': is_ipv6,
 832              }
 833         )
 834
 835     def ip_dump(self,
 836                 is_ipv6=0,
 837                 ):
 838         """ Return IP dump.
 839
 840         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 841         """
 842
 843         return self.api(
 844             self.papi.ip_dump,
 845             {'is_ipv6': is_ipv6,
 846              }
 847         )
 848
 849     def sw_interface_span_enable_disable(
 850             self, sw_if_index_from, sw_if_index_to, state=1):
 851         """
 852
 853         :param sw_if_index_from:
 854         :param sw_if_index_to:
 855         :param state:
 856         """
 857         return self.api(self.papi.sw_interface_span_enable_disable,
 858                         {'sw_if_index_from': sw_if_index_from,
 859                          'sw_if_index_to': sw_if_index_to,
 860                          'state': state})
 861
 862     def gre_tunnel_add_del(self,
 863                            src_address,
 864                            dst_address,
 865                            outer_fib_id=0,
 866                            is_teb=0,
 867                            is_add=1,
 868                            is_ip6=0):
 869         """ Add a GRE tunnel
 870
 871         :param src_address:
 872         :param dst_address:
 873         :param outer_fib_id:  (Default value = 0)
 874         :param is_add:  (Default value = 1)
 875         :param is_ipv6:  (Default value = 0)
 876         :param is_teb:  (Default value = 0)
 877         """
 878
 879         return self.api(
 880             self.papi.gre_add_del_tunnel,
 881             {'is_add': is_add,
 882              'is_ipv6': is_ip6,
 883              'teb': is_teb,
 884              'src_address': src_address,
 885              'dst_address': dst_address,
 886              'outer_fib_id': outer_fib_id}
 887         )
 888
 889     def mpls_fib_dump(self):
 890         return self.api(self.papi.mpls_fib_dump, {})
 891
 892     def mpls_route_add_del(
 893             self,
 894             label,
 895             eos,
 896             next_hop_proto_is_ip4,
 897             next_hop_address,
 898             next_hop_sw_if_index=0xFFFFFFFF,
 899             table_id=0,
 900             next_hop_table_id=0,
 901             next_hop_weight=1,
 902             next_hop_n_out_labels=0,
 903             next_hop_out_label_stack=[],
 904             next_hop_via_label=MPLS_LABEL_INVALID,
 905             create_vrf_if_needed=0,
 906             is_resolve_host=0,
 907             is_resolve_attached=0,
 908             is_interface_rx=0,
 909             is_rpf_id=0,
 910             is_multicast=0,
 911             is_add=1,
 912             is_drop=0,
 913             is_multipath=0,
 914             classify_table_index=0xFFFFFFFF,
 915             is_classify=0,
 916             not_last=0):
 917         """
 918
 919         :param dst_address_length:
 920         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 921         :param dst_address:
 922         :param next_hop_address:
 923         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 924         :param vrf_id:  (Default value = 0)
 925         :param lookup_in_vrf:  (Default value = 0)
 926         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 927         :param create_vrf_if_needed:  (Default value = 0)
 928         :param is_add:  (Default value = 1)
 929         :param is_drop:  (Default value = 0)
 930         :param is_ipv6:  (Default value = 0)
 931         :param is_local:  (Default value = 0)
 932         :param is_classify:  (Default value = 0)
 933         :param is_multipath:  (Default value = 0)
 934         :param is_multicast:  (Default value = 0)
 935         :param is_resolve_host:  (Default value = 0)
 936         :param is_resolve_attached:  (Default value = 0)
 937         :param not_last:  (Default value = 0)
 938         :param next_hop_weight:  (Default value = 1)
 939
 940         """
 941
 942         return self.api(
 943             self.papi.mpls_route_add_del,
 944             {'mr_label': label,
 945              'mr_eos': eos,
 946              'mr_table_id': table_id,
 947              'mr_classify_table_index': classify_table_index,
 948              'mr_create_table_if_needed': create_vrf_if_needed,
 949              'mr_is_add': is_add,
 950              'mr_is_classify': is_classify,
 951              'mr_is_multipath': is_multipath,
 952              'mr_is_multicast': is_multicast,
 953              'mr_is_resolve_host': is_resolve_host,
 954              'mr_is_resolve_attached': is_resolve_attached,
 955              'mr_is_interface_rx': is_interface_rx,
 956              'mr_is_rpf_id': is_rpf_id,
 957              'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
 958              'mr_next_hop_weight': next_hop_weight,
 959              'mr_next_hop': next_hop_address,
 960              'mr_next_hop_n_out_labels': next_hop_n_out_labels,
 961              'mr_next_hop_sw_if_index': next_hop_sw_if_index,
 962              'mr_next_hop_table_id': next_hop_table_id,
 963              'mr_next_hop_via_label': next_hop_via_label,
 964              'mr_next_hop_out_label_stack': next_hop_out_label_stack})
 965
 966     def mpls_ip_bind_unbind(
 967             self,
 968             label,
 969             dst_address,
 970             dst_address_length,
 971             table_id=0,
 972             ip_table_id=0,
 973             is_ip4=1,
 974             create_vrf_if_needed=0,
 975             is_bind=1):
 976         """
 977         """
 978         return self.api(
 979             self.papi.mpls_ip_bind_unbind,
 980             {'mb_mpls_table_id': table_id,
 981              'mb_label': label,
 982              'mb_ip_table_id': ip_table_id,
 983              'mb_create_table_if_needed': create_vrf_if_needed,
 984              'mb_is_bind': is_bind,
 985              'mb_is_ip4': is_ip4,
 986              'mb_address_length': dst_address_length,
 987              'mb_address': dst_address})
 988
 989     def mpls_tunnel_add_del(
 990             self,
 991             tun_sw_if_index,
 992             next_hop_proto_is_ip4,
 993             next_hop_address,
 994             next_hop_sw_if_index=0xFFFFFFFF,
 995             next_hop_table_id=0,
 996             next_hop_weight=1,
 997             next_hop_n_out_labels=0,
 998             next_hop_out_label_stack=[],
 999             next_hop_via_label=MPLS_LABEL_INVALID,
1000             create_vrf_if_needed=0,
1001             is_add=1,
1002             l2_only=0,
1003             is_multicast=0):
1004         """
1005
1006         :param dst_address_length:
1007         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1008         :param dst_address:
1009         :param next_hop_address:
1010         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1011         :param vrf_id:  (Default value = 0)
1012         :param lookup_in_vrf:  (Default value = 0)
1013         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1014         :param create_vrf_if_needed:  (Default value = 0)
1015         :param is_add:  (Default value = 1)
1016         :param is_drop:  (Default value = 0)
1017         :param is_ipv6:  (Default value = 0)
1018         :param is_local:  (Default value = 0)
1019         :param is_classify:  (Default value = 0)
1020         :param is_multipath:  (Default value = 0)
1021         :param is_resolve_host:  (Default value = 0)
1022         :param is_resolve_attached:  (Default value = 0)
1023         :param next_hop_weight:  (Default value = 1)
1024         :param is_multicast:  (Default value = 0)
1025
1026         """
1027         return self.api(
1028             self.papi.mpls_tunnel_add_del,
1029             {'mt_sw_if_index': tun_sw_if_index,
1030              'mt_is_add': is_add,
1031              'mt_l2_only': l2_only,
1032              'mt_is_multicast': is_multicast,
1033              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1034              'mt_next_hop_weight': next_hop_weight,
1035              'mt_next_hop': next_hop_address,
1036              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1037              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1038              'mt_next_hop_table_id': next_hop_table_id,
1039              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1040
1041     def snat_interface_add_del_feature(
1042             self,
1043             sw_if_index,
1044             is_inside=1,
1045             is_add=1):
1046         """Enable/disable S-NAT feature on the interface
1047
1048         :param sw_if_index: Software index of the interface
1049         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1050         :param is_add: 1 if add, 0 if delete (Default value = 1)
1051         """
1052         return self.api(
1053             self.papi.snat_interface_add_del_feature,
1054             {'is_add': is_add,
1055              'is_inside': is_inside,
1056              'sw_if_index': sw_if_index})
1057
1058     def snat_interface_add_del_output_feature(
1059             self,
1060             sw_if_index,
1061             is_inside=1,
1062             is_add=1):
1063         """Enable/disable S-NAT output feature on the interface
1064
1065         :param sw_if_index: Software index of the interface
1066         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1067         :param is_add: 1 if add, 0 if delete (Default value = 1)
1068         """
1069         return self.api(
1070             self.papi.snat_interface_add_del_output_feature,
1071             {'is_add': is_add,
1072              'is_inside': is_inside,
1073              'sw_if_index': sw_if_index})
1074
1075     def snat_add_static_mapping(
1076             self,
1077             local_ip,
1078             external_ip=0,
1079             external_sw_if_index=0xFFFFFFFF,
1080             local_port=0,
1081             external_port=0,
1082             addr_only=1,
1083             vrf_id=0,
1084             protocol=0,
1085             is_add=1,
1086             is_ip4=1):
1087         """Add/delete S-NAT static mapping
1088
1089         :param local_ip: Local IP address
1090         :param external_ip: External IP address
1091         :param external_sw_if_index: External interface instead of IP address
1092         :param local_port: Local port number (Default value = 0)
1093         :param external_port: External port number (Default value = 0)
1094         :param addr_only: 1 if address only mapping, 0 if address and port
1095         :param vrf_id: VRF ID
1096         :param protocol: IP protocol (Default value = 0)
1097         :param is_add: 1 if add, 0 if delete (Default value = 1)
1098         :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1099         """
1100         return self.api(
1101             self.papi.snat_add_static_mapping,
1102             {'is_add': is_add,
1103              'is_ip4': is_ip4,
1104              'addr_only': addr_only,
1105              'local_ip_address': local_ip,
1106              'external_ip_address': external_ip,
1107              'local_port': local_port,
1108              'external_port': external_port,
1109              'external_sw_if_index': external_sw_if_index,
1110              'vrf_id': vrf_id,
1111              'protocol': protocol})
1112
1113     def snat_add_address_range(
1114             self,
1115             first_ip_address,
1116             last_ip_address,
1117             is_add=1,
1118             is_ip4=1,
1119             vrf_id=0xFFFFFFFF):
1120         """Add/del S-NAT address range
1121
1122         :param first_ip_address: First IP address
1123         :param last_ip_address: Last IP address
1124         :param vrf_id: VRF id for the address range
1125         :param is_add: 1 if add, 0 if delete (Default value = 1)
1126         :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1127         """
1128         return self.api(
1129             self.papi.snat_add_address_range,
1130             {'is_ip4': is_ip4,
1131              'first_ip_address': first_ip_address,
1132              'last_ip_address': last_ip_address,
1133              'vrf_id': vrf_id,
1134              'is_add': is_add})
1135
1136     def snat_address_dump(self):
1137         """Dump S-NAT addresses
1138         :return: Dictionary of S-NAT addresses
1139         """
1140         return self.api(self.papi.snat_address_dump, {})
1141
1142     def snat_interface_dump(self):
1143         """Dump interfaces with S-NAT feature
1144         :return: Dictionary of interfaces with S-NAT feature
1145         """
1146         return self.api(self.papi.snat_interface_dump, {})
1147
1148     def snat_interface_output_feature_dump(self):
1149         """Dump interfaces with S-NAT output feature
1150         :return: Dictionary of interfaces with S-NAT output feature
1151         """
1152         return self.api(self.papi.snat_interface_output_feature_dump, {})
1153
1154     def snat_static_mapping_dump(self):
1155         """Dump S-NAT static mappings
1156         :return: Dictionary of S-NAT static mappings
1157         """
1158         return self.api(self.papi.snat_static_mapping_dump, {})
1159
1160     def snat_show_config(self):
1161         """Show S-NAT config
1162         :return: S-NAT config parameters
1163         """
1164         return self.api(self.papi.snat_show_config, {})
1165
1166     def snat_add_interface_addr(
1167             self,
1168             sw_if_index,
1169             is_add=1):
1170         """Add/del S-NAT address from interface
1171
1172         :param sw_if_index: Software index of the interface
1173         :param is_add: 1 if add, 0 if delete (Default value = 1)
1174         """
1175         return self.api(self.papi.snat_add_del_interface_addr,
1176                         {'is_add': is_add, 'sw_if_index': sw_if_index})
1177
1178     def snat_interface_addr_dump(self):
1179         """Dump S-NAT addresses interfaces
1180         :return: Dictionary of S-NAT addresses interfaces
1181         """
1182         return self.api(self.papi.snat_interface_addr_dump, {})
1183
1184     def snat_ipfix(
1185             self,
1186             domain_id=1,
1187             src_port=4739,
1188             enable=1):
1189         """Enable/disable S-NAT IPFIX logging
1190
1191         :param domain_id: Observation domain ID (Default value = 1)
1192         :param src_port: Source port number (Default value = 4739)
1193         :param enable: 1 if enable, 0 if disable (Default value = 1)
1194         """
1195         return self.api(
1196             self.papi.snat_ipfix_enable_disable,
1197             {'domain_id': domain_id,
1198              'src_port': src_port,
1199              'enable': enable})
1200
1201     def snat_user_session_dump(
1202             self,
1203             ip_address,
1204             vrf_id,
1205             is_ip4=1):
1206         """Dump S-NAT user's sessions
1207
1208         :param ip_address: ip adress of the user to be dumped
1209         :param cpu_index: cpu_index on which the user is
1210         :param vrf_id: VRF ID
1211         :return: Dictionary of S-NAT sessions
1212         """
1213         return self.api(
1214             self.papi.snat_user_session_dump,
1215             {'ip_address': ip_address,
1216              'vrf_id': vrf_id,
1217              'is_ip4': is_ip4})
1218
1219     def snat_user_dump(self):
1220         """Dump S-NAT users
1221
1222         :return: Dictionary of S-NAT users
1223         """
1224         return self.api(self.papi.snat_user_dump, {})
1225
1226     def snat_add_det_map(
1227             self,
1228             in_addr,
1229             in_plen,
1230             out_addr,
1231             out_plen,
1232             is_add=1):
1233         """Add/delete S-NAT deterministic mapping
1234
1235         :param is_add - 1 if add, 0 if delete
1236         :param in_addr - inside IP address
1237         :param in_plen - inside IP address prefix length
1238         :param out_addr - outside IP address
1239         :param out_plen - outside IP address prefix length
1240         """
1241         return self.api(
1242             self.papi.snat_add_det_map,
1243             {'is_add': is_add,
1244              'in_addr': in_addr,
1245              'in_plen': in_plen,
1246              'out_addr': out_addr,
1247              'out_plen': out_plen})
1248
1249     def snat_det_forward(
1250             self,
1251             in_addr):
1252         """Get outside address and port range from inside address
1253
1254         :param in_addr - inside IP address
1255         """
1256         return self.api(
1257             self.papi.snat_det_forward,
1258             {'in_addr': in_addr})
1259
1260     def snat_det_reverse(
1261             self,
1262             out_addr,
1263             out_port):
1264         """Get inside address from outside address and port
1265
1266         :param out_addr - outside IP address
1267         :param out_port - outside port
1268         """
1269         return self.api(
1270             self.papi.snat_det_reverse,
1271             {'out_addr': out_addr,
1272              'out_port': out_port})
1273
1274     def snat_det_map_dump(self):
1275         """Dump S-NAT deterministic mappings
1276
1277         :return: Dictionary of S-NAT deterministic mappings
1278         """
1279         return self.api(self.papi.snat_det_map_dump, {})
1280
1281     def snat_det_set_timeouts(
1282             self,
1283             udp=300,
1284             tcp_established=7440,
1285             tcp_transitory=240,
1286             icmp=60):
1287         """Set values of timeouts for deterministic NAT (in seconds)
1288
1289         :param udp - UDP timeout (Default value = 300)
1290         :param tcp_established - TCP established timeout (Default value = 7440)
1291         :param tcp_transitory - TCP transitory timeout (Default value = 240)
1292         :param icmp - ICMP timeout (Default value = 60)
1293         """
1294         return self.api(
1295             self.papi.snat_det_set_timeouts,
1296             {'udp': udp,
1297              'tcp_established': tcp_established,
1298              'tcp_transitory': tcp_transitory,
1299              'icmp': icmp})
1300
1301     def snat_det_get_timeouts(self):
1302         """Get values of timeouts for deterministic NAT
1303
1304         :return: Timeouts for deterministic NAT (in seconds)
1305         """
1306         return self.api(self.papi.snat_det_get_timeouts, {})
1307
1308     def snat_det_close_session_out(
1309             self,
1310             out_addr,
1311             out_port,
1312             ext_addr,
1313             ext_port,
1314             is_ip4=1):
1315         """Close CGN session using outside address and port
1316
1317         :param out_addr - outside IP address
1318         :param out_port - outside port
1319         :param ext_addr - external host IP address
1320         :param ext_port - external host port
1321         :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1322         """
1323         return self.api(
1324             self.papi.snat_det_close_session_out,
1325             {'out_addr': out_addr,
1326              'out_port': out_port,
1327              'ext_addr': ext_addr,
1328              'ext_port': ext_port,
1329              'is_ip4': is_ip4})
1330
1331     def snat_det_close_session_in(
1332             self,
1333             in_addr,
1334             in_port,
1335             ext_addr,
1336             ext_port,
1337             is_ip4=1):
1338         """Close CGN session using inside address and port
1339
1340         :param in_addr - inside IP address
1341         :param in_port - inside port
1342         :param ext_addr - external host IP address
1343         :param ext_port - external host port
1344         :param is_ip4: 1 if address type is IPv4 (Default value = 1)
1345         """
1346         return self.api(
1347             self.papi.snat_det_close_session_in,
1348             {'in_addr': in_addr,
1349              'in_port': in_port,
1350              'ext_addr': ext_addr,
1351              'ext_port': ext_port,
1352              'is_ip4': is_ip4})
1353
1354     def snat_det_session_dump(
1355             self,
1356             user_addr,
1357             is_ip4=1):
1358         """Dump S-NAT deterministic sessions belonging to a user
1359
1360         :param user_addr - inside IP address of the user
1361         :param is_ip4: - 1 if address type is IPv4 (Default value = 1)
1362         :return: Dictionary of S-NAT deterministic sessions
1363         """
1364         return self.api(
1365             self.papi.snat_det_session_dump,
1366             {'is_ip4': is_ip4,
1367              'user_addr': user_addr})
1368
1369     def nat64_add_del_pool_addr_range(
1370             self,
1371             start_addr,
1372             end_addr,
1373             vrf_id=0xFFFFFFFF,
1374             is_add=1):
1375         """Add/del address range to NAT64 pool
1376
1377         :param start_addr: First IP address
1378         :param end_addr: Last IP address
1379         :param vrf_id: VRF id for the address range
1380         :param is_add: 1 if add, 0 if delete (Default value = 1)
1381         """
1382         return self.api(
1383             self.papi.nat64_add_del_pool_addr_range,
1384             {'start_addr': start_addr,
1385              'end_addr': end_addr,
1386              'vrf_id': vrf_id,
1387              'is_add': is_add})
1388
1389     def nat64_pool_addr_dump(self):
1390         """Dump NAT64 pool addresses
1391         :return: Dictionary of NAT64 pool addresses
1392         """
1393         return self.api(self.papi.nat64_pool_addr_dump, {})
1394
1395     def nat64_add_del_interface(
1396             self,
1397             sw_if_index,
1398             is_inside=1,
1399             is_add=1):
1400         """Enable/disable NAT64 feature on the interface
1401            :param sw_if_index: Index of the interface
1402            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1403            :param is_add: 1 if add, 0 if delete (Default value = 1)
1404         """
1405         return self.api(
1406             self.papi.nat64_add_del_interface,
1407             {'sw_if_index': sw_if_index,
1408              'is_inside': is_inside,
1409              'is_add': is_add})
1410
1411     def nat64_interface_dump(self):
1412         """Dump interfaces with NAT64 feature
1413         :return: Dictionary of interfaces with NAT64 feature
1414         """
1415         return self.api(self.papi.nat64_interface_dump, {})
1416
1417     def nat64_add_del_static_bib(
1418             self,
1419             in_ip,
1420             out_ip,
1421             in_port,
1422             out_port,
1423             protocol,
1424             vrf_id=0,
1425             is_add=1):
1426         """Add/delete S-NAT static BIB entry
1427
1428         :param in_ip: Inside IPv6 address
1429         :param out_ip: Outside IPv4 address
1430         :param in_port: Inside port number
1431         :param out_port: Outside port number
1432         :param protocol: IP protocol
1433         :param vrf_id: VRF ID (Default value = 0)
1434         :param is_add: 1 if add, 0 if delete (Default value = 1)
1435         """
1436         return self.api(
1437             self.papi.nat64_add_del_static_bib,
1438             {'i_addr': in_ip,
1439              'o_addr': out_ip,
1440              'i_port': in_port,
1441              'o_port': out_port,
1442              'vrf_id': vrf_id,
1443              'proto': protocol,
1444              'is_add': is_add})
1445
1446     def nat64_bib_dump(self, protocol):
1447         """Dump NAT64 BIB
1448
1449         :param protocol: IP protocol
1450         :returns: Dictionary of NAT64 BIB entries
1451         """
1452         return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1453
1454     def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1455                            tcp_incoming_syn=6):
1456         """Set values of timeouts for NAT64 (in seconds)
1457
1458         :param udpi: UDP timeout (Default value = 300)
1459         :param icmp: ICMP timeout (Default value = 60)
1460         :param tcp_trans: TCP transitory timeout (Default value = 240)
1461         :param tcp_est: TCP established timeout (Default value = 7440)
1462         :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1463         """
1464         return self.api(
1465             self.papi.nat64_set_timeouts,
1466             {'udp': udp,
1467              'icmp': icmp,
1468              'tcp_trans': tcp_trans,
1469              'tcp_est': tcp_est,
1470              'tcp_incoming_syn': tcp_incoming_syn})
1471
1472     def nat64_get_timeouts(self):
1473         """Get values of timeouts for NAT64
1474
1475         :return: Timeouts for NAT64 (in seconds)
1476         """
1477         return self.api(self.papi.nat64_get_timeouts, {})
1478
1479     def nat64_st_dump(self, protocol):
1480         """Dump NAT64 session table
1481
1482         :param protocol: IP protocol
1483         :returns: Dictionary of NAT64 sesstion table entries
1484         """
1485         return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1486
1487     def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1488         """Add/del NAT64 prefix
1489
1490         :param prefix: NAT64 prefix
1491         :param plen: NAT64 prefix length
1492         :param vrf_id: VRF id of tenant (Default 0)
1493         :param is_add: 1 if add, 0 if delete (Default value = 1)
1494         """
1495         return self.api(
1496             self.papi.nat64_add_del_prefix,
1497             {'prefix': prefix,
1498              'prefix_len': plen,
1499              'vrf_id': vrf_id,
1500              'is_add': is_add})
1501
1502     def nat64_prefix_dump(self):
1503         """Dump NAT64 prefix
1504
1505         :returns: Dictionary of NAT64 prefixes
1506         """
1507         return self.api(self.papi.nat64_prefix_dump, {})
1508
1509     def control_ping(self):
1510         self.api(self.papi.control_ping)
1511
1512     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1513                     detect_mult, local_addr, peer_addr, is_ipv6=0,
1514                     bfd_key_id=None, conf_key_id=None):
1515         if bfd_key_id is None:
1516             return self.api(self.papi.bfd_udp_add,
1517                             {
1518                                 'sw_if_index': sw_if_index,
1519                                 'desired_min_tx': desired_min_tx,
1520                                 'required_min_rx': required_min_rx,
1521                                 'local_addr': local_addr,
1522                                 'peer_addr': peer_addr,
1523                                 'is_ipv6': is_ipv6,
1524                                 'detect_mult': detect_mult,
1525                             })
1526         else:
1527             return self.api(self.papi.bfd_udp_add,
1528                             {
1529                                 'sw_if_index': sw_if_index,
1530                                 'desired_min_tx': desired_min_tx,
1531                                 'required_min_rx': required_min_rx,
1532                                 'local_addr': local_addr,
1533                                 'peer_addr': peer_addr,
1534                                 'is_ipv6': is_ipv6,
1535                                 'detect_mult': detect_mult,
1536                                 'is_authenticated': 1,
1537                                 'bfd_key_id': bfd_key_id,
1538                                 'conf_key_id': conf_key_id,
1539                             })
1540
1541     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1542                     detect_mult, local_addr, peer_addr, is_ipv6=0):
1543         return self.api(self.papi.bfd_udp_mod,
1544                         {
1545                             'sw_if_index': sw_if_index,
1546                             'desired_min_tx': desired_min_tx,
1547                             'required_min_rx': required_min_rx,
1548                             'local_addr': local_addr,
1549                             'peer_addr': peer_addr,
1550                             'is_ipv6': is_ipv6,
1551                             'detect_mult': detect_mult,
1552                         })
1553
1554     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1555                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1556                               is_delayed=False):
1557         return self.api(self.papi.bfd_udp_auth_activate,
1558                         {
1559                             'sw_if_index': sw_if_index,
1560                             'local_addr': local_addr,
1561                             'peer_addr': peer_addr,
1562                             'is_ipv6': is_ipv6,
1563                             'is_delayed': 1 if is_delayed else 0,
1564                             'bfd_key_id': bfd_key_id,
1565                             'conf_key_id': conf_key_id,
1566                         })
1567
1568     def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1569                                 is_ipv6=0, is_delayed=False):
1570         return self.api(self.papi.bfd_udp_auth_deactivate,
1571                         {
1572                             'sw_if_index': sw_if_index,
1573                             'local_addr': local_addr,
1574                             'peer_addr': peer_addr,
1575                             'is_ipv6': is_ipv6,
1576                             'is_delayed': 1 if is_delayed else 0,
1577                         })
1578
1579     def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1580         return self.api(self.papi.bfd_udp_del,
1581                         {
1582                             'sw_if_index': sw_if_index,
1583                             'local_addr': local_addr,
1584                             'peer_addr': peer_addr,
1585                             'is_ipv6': is_ipv6,
1586                         })
1587
1588     def bfd_udp_session_dump(self):
1589         return self.api(self.papi.bfd_udp_session_dump, {})
1590
1591     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1592                                   peer_addr, is_ipv6=0):
1593         return self.api(self.papi.bfd_udp_session_set_flags, {
1594             'admin_up_down': admin_up_down,
1595             'sw_if_index': sw_if_index,
1596             'local_addr': local_addr,
1597             'peer_addr': peer_addr,
1598             'is_ipv6': is_ipv6,
1599         })
1600
1601     def want_bfd_events(self, enable_disable=1):
1602         return self.api(self.papi.want_bfd_events, {
1603             'enable_disable': enable_disable,
1604             'pid': os.getpid(),
1605         })
1606
1607     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1608         return self.api(self.papi.bfd_auth_set_key, {
1609             'conf_key_id': conf_key_id,
1610             'auth_type': auth_type,
1611             'key': key,
1612             'key_len': len(key),
1613         })
1614
1615     def bfd_auth_del_key(self, conf_key_id):
1616         return self.api(self.papi.bfd_auth_del_key, {
1617             'conf_key_id': conf_key_id,
1618         })
1619
1620     def bfd_auth_keys_dump(self):
1621         return self.api(self.papi.bfd_auth_keys_dump, {})
1622
1623     def bfd_udp_set_echo_source(self, sw_if_index):
1624         return self.api(self.papi.bfd_udp_set_echo_source,
1625                         {'sw_if_index': sw_if_index})
1626
1627     def bfd_udp_del_echo_source(self):
1628         return self.api(self.papi.bfd_udp_del_echo_source, {})
1629
1630     def classify_add_del_table(
1631             self,
1632             is_add,
1633             mask,
1634             match_n_vectors=1,
1635             table_index=0xFFFFFFFF,
1636             nbuckets=2,
1637             memory_size=2097152,
1638             skip_n_vectors=0,
1639             next_table_index=0xFFFFFFFF,
1640             miss_next_index=0xFFFFFFFF,
1641             current_data_flag=0,
1642             current_data_offset=0):
1643         """
1644         :param is_add:
1645         :param mask:
1646         :param match_n_vectors: (Default value = 1)
1647         :param table_index: (Default value = 0xFFFFFFFF)
1648         :param nbuckets:  (Default value = 2)
1649         :param memory_size:  (Default value = 2097152)
1650         :param skip_n_vectors:  (Default value = 0)
1651         :param next_table_index:  (Default value = 0xFFFFFFFF)
1652         :param miss_next_index:  (Default value = 0xFFFFFFFF)
1653         :param current_data_flag:  (Default value = 0)
1654         :param current_data_offset:  (Default value = 0)
1655         """
1656
1657         return self.api(
1658             self.papi.classify_add_del_table,
1659             {'is_add': is_add,
1660              'table_index': table_index,
1661              'nbuckets': nbuckets,
1662              'memory_size': memory_size,
1663              'skip_n_vectors': skip_n_vectors,
1664              'match_n_vectors': match_n_vectors,
1665              'next_table_index': next_table_index,
1666              'miss_next_index': miss_next_index,
1667              'current_data_flag': current_data_flag,
1668              'current_data_offset': current_data_offset,
1669              'mask': mask})
1670
1671     def classify_add_del_session(
1672             self,
1673             is_add,
1674             table_index,
1675             match,
1676             opaque_index=0xFFFFFFFF,
1677             hit_next_index=0xFFFFFFFF,
1678             advance=0,
1679             action=0,
1680             metadata=0):
1681         """
1682         :param is_add:
1683         :param table_index:
1684         :param match:
1685         :param opaque_index:  (Default value = 0xFFFFFFFF)
1686         :param hit_next_index:  (Default value = 0xFFFFFFFF)
1687         :param advance:  (Default value = 0)
1688         :param action:  (Default value = 0)
1689         :param metadata:  (Default value = 0)
1690         """
1691
1692         return self.api(
1693             self.papi.classify_add_del_session,
1694             {'is_add': is_add,
1695              'table_index': table_index,
1696              'hit_next_index': hit_next_index,
1697              'opaque_index': opaque_index,
1698              'advance': advance,
1699              'action': action,
1700              'metadata': metadata,
1701              'match': match})
1702
1703     def input_acl_set_interface(
1704             self,
1705             is_add,
1706             sw_if_index,
1707             ip4_table_index=0xFFFFFFFF,
1708             ip6_table_index=0xFFFFFFFF,
1709             l2_table_index=0xFFFFFFFF):
1710         """
1711         :param is_add:
1712         :param sw_if_index:
1713         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
1714         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
1715         :param l2_table_index:  (Default value = 0xFFFFFFFF)
1716         """
1717
1718         return self.api(
1719             self.papi.input_acl_set_interface,
1720             {'sw_if_index': sw_if_index,
1721              'ip4_table_index': ip4_table_index,
1722              'ip6_table_index': ip6_table_index,
1723              'l2_table_index': l2_table_index,
1724              'is_add': is_add})
1725
1726     def set_ipfix_exporter(
1727             self,
1728             collector_address,
1729             src_address,
1730             path_mtu,
1731             template_interval,
1732             vrf_id=0,
1733             collector_port=4739,
1734             udp_checksum=0):
1735         return self.api(
1736             self.papi.set_ipfix_exporter,
1737             {
1738                 'collector_address': collector_address,
1739                 'collector_port': collector_port,
1740                 'src_address': src_address,
1741                 'vrf_id': vrf_id,
1742                 'path_mtu': path_mtu,
1743                 'template_interval': template_interval,
1744                 'udp_checksum': udp_checksum,
1745             })
1746
1747     def dhcp_proxy_config(self,
1748                           dhcp_server,
1749                           dhcp_src_address,
1750                           rx_table_id=0,
1751                           server_table_id=0,
1752                           is_add=1,
1753                           is_ipv6=0):
1754         return self.api(
1755             self.papi.dhcp_proxy_config,
1756             {
1757                 'rx_vrf_id': rx_table_id,
1758                 'server_vrf_id': server_table_id,
1759                 'is_ipv6': is_ipv6,
1760                 'is_add': is_add,
1761                 'dhcp_server': dhcp_server,
1762                 'dhcp_src_address': dhcp_src_address,
1763             })
1764
1765     def dhcp_proxy_set_vss(self,
1766                            table_id,
1767                            fib_id,
1768                            oui,
1769                            is_add=1,
1770                            is_ip6=0):
1771         return self.api(
1772             self.papi.dhcp_proxy_set_vss,
1773             {
1774                 'tbl_id': table_id,
1775                 'fib_id': fib_id,
1776                 'is_ipv6': is_ip6,
1777                 'is_add': is_add,
1778                 'oui': oui,
1779             })
1780
1781     def dhcp_client(self,
1782                     sw_if_index,
1783                     hostname,
1784                     client_id='',
1785                     is_add=1,
1786                     want_dhcp_events=0):
1787         return self.api(
1788             self.papi.dhcp_client_config,
1789             {
1790                 'sw_if_index': sw_if_index,
1791                 'hostname': hostname,
1792                 'client_id': client_id,
1793                 'is_add': is_add,
1794                 'want_dhcp_event': want_dhcp_events,
1795                 'pid': os.getpid(),
1796             })
1797
1798     def ip_mroute_add_del(self,
1799                           src_address,
1800                           grp_address,
1801                           grp_address_length,
1802                           e_flags,
1803                           next_hop_sw_if_index,
1804                           i_flags,
1805                           rpf_id=0,
1806                           table_id=0,
1807                           create_vrf_if_needed=0,
1808                           is_add=1,
1809                           is_ipv6=0,
1810                           is_local=0):
1811         """
1812         """
1813         return self.api(
1814             self.papi.ip_mroute_add_del,
1815             {'next_hop_sw_if_index': next_hop_sw_if_index,
1816              'entry_flags': e_flags,
1817              'itf_flags': i_flags,
1818              'table_id': table_id,
1819              'rpf_id': rpf_id,
1820              'create_vrf_if_needed': create_vrf_if_needed,
1821              'is_add': is_add,
1822              'is_ipv6': is_ipv6,
1823              'is_local': is_local,
1824              'grp_address_length': grp_address_length,
1825              'grp_address': grp_address,
1826              'src_address': src_address})
1827
1828     def mfib_signal_dump(self):
1829         return self.api(self.papi.mfib_signal_dump, {})
1830
1831     def ip_mfib_dump(self):
1832         return self.api(self.papi.ip_mfib_dump, {})
1833
1834     def lisp_enable_disable(self, is_enabled):
1835         return self.api(
1836             self.papi.lisp_enable_disable,
1837             {
1838                 'is_en': is_enabled,
1839             })
1840
1841     def lisp_locator_set(self,
1842                          ls_name,
1843                          is_add=1):
1844         return self.api(
1845             self.papi.lisp_add_del_locator_set,
1846             {
1847                 'is_add': is_add,
1848                 'locator_set_name': ls_name
1849             })
1850
1851     def lisp_locator_set_dump(self):
1852         return self.api(self.papi.lisp_locator_set_dump, {})
1853
1854     def lisp_locator(self,
1855                      ls_name,
1856                      sw_if_index,
1857                      priority=1,
1858                      weight=1,
1859                      is_add=1):
1860         return self.api(
1861             self.papi.lisp_add_del_locator,
1862             {
1863                 'is_add': is_add,
1864                 'locator_set_name': ls_name,
1865                 'sw_if_index': sw_if_index,
1866                 'priority': priority,
1867                 'weight': weight
1868             })
1869
1870     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1871         return self.api(
1872             self.papi.lisp_locator_dump,
1873             {
1874                 'is_index_set': is_index_set,
1875                 'ls_name': ls_name,
1876                 'ls_index': ls_index,
1877             })
1878
1879     def lisp_local_mapping(self,
1880                            ls_name,
1881                            eid_type,
1882                            eid,
1883                            prefix_len,
1884                            vni=0,
1885                            key_id=0,
1886                            key="",
1887                            is_add=1):
1888         return self.api(
1889             self.papi.lisp_add_del_local_eid,
1890             {
1891                 'locator_set_name': ls_name,
1892                 'is_add': is_add,
1893                 'eid_type': eid_type,
1894                 'eid': eid,
1895                 'prefix_len': prefix_len,
1896                 'vni': vni,
1897                 'key_id': key_id,
1898                 'key': key
1899             })
1900
1901     def lisp_eid_table_dump(self,
1902                             eid_set=0,
1903                             prefix_length=0,
1904                             vni=0,
1905                             eid_type=0,
1906                             eid=None,
1907                             filter_opt=0):
1908         return self.api(
1909             self.papi.lisp_eid_table_dump,
1910             {
1911                 'eid_set': eid_set,
1912                 'prefix_length': prefix_length,
1913                 'vni': vni,
1914                 'eid_type': eid_type,
1915                 'eid': eid,
1916                 'filter': filter_opt,
1917             })
1918
1919     def lisp_remote_mapping(self,
1920                             eid_type,
1921                             eid,
1922                             eid_prefix_len=0,
1923                             vni=0,
1924                             rlocs=None,
1925                             rlocs_num=0,
1926                             is_src_dst=0,
1927                             is_add=1):
1928         return self.api(
1929             self.papi.lisp_add_del_remote_mapping,
1930             {
1931                 'is_add': is_add,
1932                 'eid_type': eid_type,
1933                 'eid': eid,
1934                 'eid_len': eid_prefix_len,
1935                 'rloc_num': rlocs_num,
1936                 'rlocs': rlocs,
1937                 'vni': vni,
1938                 'is_src_dst': is_src_dst,
1939             })
1940
1941     def lisp_adjacency(self,
1942                        leid,
1943                        reid,
1944                        leid_len,
1945                        reid_len,
1946                        eid_type,
1947                        is_add=1,
1948                        vni=0):
1949         return self.api(
1950             self.papi.lisp_add_del_adjacency,
1951             {
1952                 'is_add': is_add,
1953                 'vni': vni,
1954                 'eid_type': eid_type,
1955                 'leid': leid,
1956                 'reid': reid,
1957                 'leid_len': leid_len,
1958                 'reid_len': reid_len,
1959             })
1960
1961     def lisp_adjacencies_get(self, vni=0):
1962         return self.api(
1963             self.papi.lisp_adjacencies_get,
1964             {
1965                 'vni': vni
1966             })
1967
1968     def map_add_domain(self,
1969                        ip6_prefix,
1970                        ip6_prefix_len,
1971                        ip6_src,
1972                        ip6_src_prefix_len,
1973                        ip4_prefix,
1974                        ip4_prefix_len,
1975                        ea_bits_len=0,
1976                        psid_offset=0,
1977                        psid_length=0,
1978                        is_translation=0,
1979                        mtu=1280):
1980         return self.api(
1981             self.papi.map_add_domain,
1982             {
1983                 'ip6_prefix': ip6_prefix,
1984                 'ip6_prefix_len': ip6_prefix_len,
1985                 'ip4_prefix': ip4_prefix,
1986                 'ip4_prefix_len': ip4_prefix_len,
1987                 'ip6_src': ip6_src,
1988                 'ip6_src_prefix_len': ip6_src_prefix_len,
1989                 'ea_bits_len': ea_bits_len,
1990                 'psid_offset': psid_offset,
1991                 'psid_length': psid_length,
1992                 'is_translation': is_translation,
1993                 'mtu': mtu
1994             })
1995
1996     def gtpu_add_del_tunnel(
1997             self,
1998             src_addr,
1999             dst_addr,
2000             is_add=1,
2001             is_ipv6=0,
2002             mcast_sw_if_index=0xFFFFFFFF,
2003             encap_vrf_id=0,
2004             decap_next_index=0xFFFFFFFF,
2005             teid=0):
2006         """
2007
2008         :param is_add:  (Default value = 1)
2009         :param is_ipv6:  (Default value = 0)
2010         :param src_addr:
2011         :param dst_addr:
2012         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2013         :param encap_vrf_id:  (Default value = 0)
2014         :param decap_next_index:  (Default value = 0xFFFFFFFF)
2015         :param teid:  (Default value = 0)
2016
2017         """
2018         return self.api(self.papi.gtpu_add_del_tunnel,
2019                         {'is_add': is_add,
2020                          'is_ipv6': is_ipv6,
2021                          'src_address': src_addr,
2022                          'dst_address': dst_addr,
2023                          'mcast_sw_if_index': mcast_sw_if_index,
2024                          'encap_vrf_id': encap_vrf_id,
2025                          'decap_next_index': decap_next_index,
2026                          'teid': teid})
2027
2028     def vxlan_gpe_add_del_tunnel(
2029             self,
2030             src_addr,
2031             dst_addr,
2032             mcast_sw_if_index=0xFFFFFFFF,
2033             is_add=1,
2034             is_ipv6=0,
2035             encap_vrf_id=0,
2036             decap_vrf_id=0,
2037             protocol=3,
2038             vni=0):
2039         """
2040
2041         :param local:
2042         :param remote:
2043         :param is_add:  (Default value = 1)
2044         :param is_ipv6:  (Default value = 0)
2045         :param encap_vrf_id:  (Default value = 0)
2046         :param decap_vrf_id:  (Default value = 0)
2047         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2048         :param protocol:  (Default value = 3)
2049         :param vni:  (Default value = 0)
2050
2051         """
2052         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2053                         {'is_add': is_add,
2054                          'is_ipv6': is_ipv6,
2055                          'local': src_addr,
2056                          'remote': dst_addr,
2057                          'mcast_sw_if_index': mcast_sw_if_index,
2058                          'encap_vrf_id': encap_vrf_id,
2059                          'decap_vrf_id': decap_vrf_id,
2060                          'protocol': protocol,
2061                          'vni': vni})