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 QOS_SOURCE:
  40     EXT = 0
  41     VLAN = 1
  42     MPLS = 2
  43     IP = 3
  44
  45
  46 class UnexpectedApiReturnValueError(Exception):
  47     """ exception raised when the API return value is unexpected """
  48     pass
  49
  50
  51 class VppPapiProvider(object):
  52     """VPP-api provider using vpp-papi
  53
  54     @property hook: hook object providing before and after api/cli hooks
  55     """
  56
  57     _zero, _negative = range(2)
  58
  59     def __init__(self, name, shm_prefix, test_class):
  60         self.hook = Hook("vpp-papi-provider")
  61         self.name = name
  62         self.shm_prefix = shm_prefix
  63         self.test_class = test_class
  64         self._expect_api_retval = self._zero
  65         self._expect_stack = []
  66         jsonfiles = []
  67
  68         install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
  69         for root, dirnames, filenames in os.walk(install_dir):
  70             for filename in fnmatch.filter(filenames, '*.api.json'):
  71                 jsonfiles.append(os.path.join(root, filename))
  72
  73         self.vpp = VPP(jsonfiles, logger=test_class.logger, read_timeout=5)
  74         self._events = deque()
  75
  76     def __enter__(self):
  77         return self
  78
  79     def expect_negative_api_retval(self):
  80         """ Expect API failure """
  81         self._expect_stack.append(self._expect_api_retval)
  82         self._expect_api_retval = self._negative
  83         return self
  84
  85     def expect_zero_api_retval(self):
  86         """ Expect API success """
  87         self._expect_stack.append(self._expect_api_retval)
  88         self._expect_api_retval = self._zero
  89         return self
  90
  91     def __exit__(self, exc_type, exc_value, traceback):
  92         self._expect_api_retval = self._expect_stack.pop()
  93
  94     def register_hook(self, hook):
  95         """Replace hook registration with new hook
  96
  97         :param hook:
  98
  99         """
 100         self.hook = hook
 101
 102     def collect_events(self):
 103         """ Collect all events from the internal queue and clear the queue. """
 104         e = self._events
 105         self._events = deque()
 106         return e
 107
 108     def wait_for_event(self, timeout, name=None):
 109         """ Wait for and return next event. """
 110         if name:
 111             self.test_class.logger.debug("Expecting event '%s' within %ss",
 112                                          name, timeout)
 113         else:
 114             self.test_class.logger.debug("Expecting event within %ss",
 115                                          timeout)
 116         if self._events:
 117             self.test_class.logger.debug("Not waiting, event already queued")
 118         limit = time.time() + timeout
 119         while time.time() < limit:
 120             if self._events:
 121                 e = self._events.popleft()
 122                 if name and type(e).__name__ != name:
 123                     raise Exception(
 124                         "Unexpected event received: %s, expected: %s" %
 125                         (type(e).__name__, name))
 126                 self.test_class.logger.debug("Returning event %s:%s" %
 127                                              (name, e))
 128                 return e
 129             time.sleep(0)  # yield
 130         raise Exception("Event did not occur within timeout")
 131
 132     def __call__(self, name, event):
 133         """ Enqueue event in the internal event queue. """
 134         # FIXME use the name instead of relying on type(e).__name__ ?
 135         # FIXME #2 if this throws, it is eaten silently, Ole?
 136         self.test_class.logger.debug("New event: %s: %s" % (name, event))
 137         self._events.append(event)
 138
 139     def connect(self):
 140         """Connect the API to VPP"""
 141         self.vpp.connect(self.name, self.shm_prefix)
 142         self.papi = self.vpp.api
 143         self.vpp.register_event_callback(self)
 144
 145     def disconnect(self):
 146         """Disconnect the API from VPP"""
 147         self.vpp.disconnect()
 148
 149     def api(self, api_fn, api_args, expected_retval=0):
 150         """ Call API function and check it's return value.
 151         Call the appropriate hooks before and after the API call
 152
 153         :param api_fn: API function to call
 154         :param api_args: tuple of API function arguments
 155         :param expected_retval: Expected return value (Default value = 0)
 156         :returns: reply from the API
 157
 158         """
 159         self.hook.before_api(api_fn.__name__, api_args)
 160         reply = api_fn(**api_args)
 161         if self._expect_api_retval == self._negative:
 162             if hasattr(reply, 'retval') and reply.retval >= 0:
 163                 msg = "API call passed unexpectedly: expected negative "\
 164                     "return value instead of %d in %s" % \
 165                     (reply.retval, repr(reply))
 166                 self.test_class.logger.info(msg)
 167                 raise UnexpectedApiReturnValueError(msg)
 168         elif self._expect_api_retval == self._zero:
 169             if hasattr(reply, 'retval') and reply.retval != expected_retval:
 170                 msg = "API call failed, expected %d return value instead "\
 171                     "of %d in %s" % (expected_retval, reply.retval,
 172                                      repr(reply))
 173                 self.test_class.logger.info(msg)
 174                 raise UnexpectedApiReturnValueError(msg)
 175         else:
 176             raise Exception("Internal error, unexpected value for "
 177                             "self._expect_api_retval %s" %
 178                             self._expect_api_retval)
 179         self.hook.after_api(api_fn.__name__, api_args)
 180         return reply
 181
 182     def cli(self, cli):
 183         """ Execute a CLI, calling the before/after hooks appropriately.
 184
 185         :param cli: CLI to execute
 186         :returns: CLI output
 187
 188         """
 189         self.hook.before_cli(cli)
 190         cli += '\n'
 191         r = self.papi.cli_inband(length=len(cli), cmd=cli)
 192         self.hook.after_cli(cli)
 193         if hasattr(r, 'reply'):
 194             return r.reply.decode().rstrip('\x00')
 195
 196     def ppcli(self, cli):
 197         """ Helper method to print CLI command in case of info logging level.
 198
 199         :param cli: CLI to execute
 200         :returns: CLI output
 201         """
 202         return cli + "\n" + str(self.cli(cli))
 203
 204     def _convert_mac(self, mac):
 205         return mac.replace(':', '').decode('hex')
 206
 207     def show_version(self):
 208         """ """
 209         return self.api(self.papi.show_version, {})
 210
 211     def pg_create_interface(self, pg_index):
 212         """
 213
 214         :param pg_index:
 215
 216         """
 217         return self.api(self.papi.pg_create_interface,
 218                         {"interface_id": pg_index})
 219
 220     def sw_interface_dump(self, filter=None):
 221         """
 222
 223         :param filter:  (Default value = None)
 224
 225         """
 226         if filter is not None:
 227             args = {"name_filter_valid": 1, "name_filter": filter}
 228         else:
 229             args = {}
 230         return self.api(self.papi.sw_interface_dump, args)
 231
 232     def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
 233         """ Set the IPvX Table-id for the Interface
 234
 235         :param sw_if_index:
 236         :param is_ipv6:
 237         :param table_id:
 238
 239         """
 240         return self.api(self.papi.sw_interface_set_table,
 241                         {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
 242                          'vrf_id': table_id})
 243
 244     def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
 245                                      is_ipv6=0, is_add=1, del_all=0):
 246         """
 247
 248         :param addr: param is_ipv6:  (Default value = 0)
 249         :param sw_if_index:
 250         :param addr_len:
 251         :param is_ipv6:  (Default value = 0)
 252         :param is_add:  (Default value = 1)
 253         :param del_all:  (Default value = 0)
 254
 255         """
 256         return self.api(self.papi.sw_interface_add_del_address,
 257                         {'sw_if_index': sw_if_index,
 258                          'is_add': is_add,
 259                          'is_ipv6': is_ipv6,
 260                          'del_all': del_all,
 261                          'address_length': addr_len,
 262                          'address': addr})
 263
 264     def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
 265                                     is_add=1):
 266         """ Set the Interface to be unnumbered
 267
 268         :param is_add:  (Default value = 1)
 269         :param sw_if_index - interface That will be unnumbered
 270         :param ip_sw_if_index - interface with an IP addres
 271
 272         """
 273         return self.api(self.papi.sw_interface_set_unnumbered,
 274                         {'sw_if_index': ip_sw_if_index,
 275                          'unnumbered_sw_if_index': sw_if_index,
 276                          'is_add': is_add})
 277
 278     def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
 279         return self.api(self.papi.ip_unnumbered_dump,
 280                         {'sw_if_index': sw_if_index})
 281
 282     def sw_interface_enable_disable_mpls(self, sw_if_index,
 283                                          is_enable=1):
 284         """
 285         Enable/Disable MPLS on the interface
 286         :param sw_if_index:
 287         :param is_enable:  (Default value = 1)
 288
 289         """
 290         return self.api(self.papi.sw_interface_set_mpls_enable,
 291                         {'sw_if_index': sw_if_index,
 292                          'enable': is_enable})
 293
 294     def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
 295         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 296                         {'sw_if_index': sw_if_index,
 297                          'suppress': suppress})
 298
 299     def set_ip_flow_hash(self,
 300                          table_id,
 301                          src=1,
 302                          dst=1,
 303                          sport=1,
 304                          dport=1,
 305                          proto=1,
 306                          reverse=0,
 307                          is_ip6=0):
 308         return self.api(self.papi.set_ip_flow_hash,
 309                         {'vrf_id': table_id,
 310                          'src': src,
 311                          'dst': dst,
 312                          'dport': dport,
 313                          'sport': sport,
 314                          'proto': proto,
 315                          'reverse': reverse,
 316                          'is_ipv6': is_ip6})
 317
 318     def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
 319         return self.api(self.papi.ip6nd_proxy_add_del,
 320                         {'address': address,
 321                          'sw_if_index': sw_if_index,
 322                          'is_del': is_del})
 323
 324     def ip6_sw_interface_ra_config(self, sw_if_index,
 325                                    no,
 326                                    suppress,
 327                                    send_unicast):
 328         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 329                         {'sw_if_index': sw_if_index,
 330                          'is_no': no,
 331                          'suppress': suppress,
 332                          'send_unicast': send_unicast})
 333
 334     def ip6_sw_interface_ra_prefix(self,
 335                                    sw_if_index,
 336                                    address,
 337                                    address_length,
 338                                    use_default=0,
 339                                    no_advertise=0,
 340                                    off_link=0,
 341                                    no_autoconfig=0,
 342                                    no_onlink=0,
 343                                    is_no=0,
 344                                    val_lifetime=0xffffffff,
 345                                    pref_lifetime=0xffffffff):
 346         return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
 347                         {'sw_if_index': sw_if_index,
 348                          'address': address,
 349                          'address_length': address_length,
 350                          'use_default': use_default,
 351                          'no_advertise': no_advertise,
 352                          'off_link': off_link,
 353                          'no_autoconfig': no_autoconfig,
 354                          'no_onlink': no_onlink,
 355                          'is_no': is_no,
 356                          'val_lifetime': val_lifetime,
 357                          'pref_lifetime': pref_lifetime})
 358
 359     def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
 360         """
 361         Enable/Disable An interface for IPv6
 362         """
 363         return self.api(self.papi.sw_interface_ip6_enable_disable,
 364                         {'sw_if_index': sw_if_index,
 365                          'enable': enable})
 366
 367     def vxlan_add_del_tunnel(
 368             self,
 369             src_addr,
 370             dst_addr,
 371             mcast_sw_if_index=0xFFFFFFFF,
 372             is_add=1,
 373             is_ipv6=0,
 374             encap_vrf_id=0,
 375             decap_next_index=0xFFFFFFFF,
 376             vni=0,
 377             instance=0xFFFFFFFF):
 378         """
 379
 380         :param dst_addr:
 381         :param src_addr:
 382         :param is_add:  (Default value = 1)
 383         :param is_ipv6:  (Default value = 0)
 384         :param encap_vrf_id:  (Default value = 0)
 385         :param decap_next_index:  (Default value = 0xFFFFFFFF)
 386         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 387         :param vni:  (Default value = 0)
 388         :param instance:  (Default value = 0xFFFFFFFF)
 389
 390         """
 391         return self.api(self.papi.vxlan_add_del_tunnel,
 392                         {'is_add': is_add,
 393                          'is_ipv6': is_ipv6,
 394                          'src_address': src_addr,
 395                          'dst_address': dst_addr,
 396                          'mcast_sw_if_index': mcast_sw_if_index,
 397                          'encap_vrf_id': encap_vrf_id,
 398                          'decap_next_index': decap_next_index,
 399                          'vni': vni,
 400                          'instance': instance})
 401
 402     def geneve_add_del_tunnel(
 403             self,
 404             local_addr,
 405             remote_addr,
 406             mcast_sw_if_index=0xFFFFFFFF,
 407             is_add=1,
 408             is_ipv6=0,
 409             encap_vrf_id=0,
 410             decap_next_index=0xFFFFFFFF,
 411             vni=0):
 412         """
 413
 414         :param remote_addr:
 415         :param local_addr:
 416         :param is_add:  (Default value = 1)
 417         :param is_ipv6:  (Default value = 0)
 418         :param encap_vrf_id:  (Default value = 0)
 419         :param decap_next_index:  (Default value = 0xFFFFFFFF)
 420         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 421         :param vni:  (Default value = 0)
 422
 423         """
 424         return self.api(self.papi.geneve_add_del_tunnel,
 425                         {'is_add': is_add,
 426                          'is_ipv6': is_ipv6,
 427                          'local_address': local_addr,
 428                          'remote_address': remote_addr,
 429                          'mcast_sw_if_index': mcast_sw_if_index,
 430                          'encap_vrf_id': encap_vrf_id,
 431                          'decap_next_index': decap_next_index,
 432                          'vni': vni})
 433
 434     def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
 435                               learn=1, arp_term=0, is_add=1):
 436         """Create/delete bridge domain.
 437
 438         :param int bd_id: Bridge domain index.
 439         :param int flood: Enable/disable bcast/mcast flooding in the BD.
 440             (Default value = 1)
 441         :param int uu_flood: Enable/disable unknown unicast flood in the BD.
 442             (Default value = 1)
 443         :param int forward: Enable/disable forwarding on all interfaces in
 444             the BD. (Default value = 1)
 445         :param int learn: Enable/disable learning on all interfaces in the BD.
 446             (Default value = 1)
 447         :param int arp_term: Enable/disable arp termination in the BD.
 448             (Default value = 1)
 449         :param int is_add: Add or delete flag. (Default value = 1)
 450         """
 451         return self.api(self.papi.bridge_domain_add_del,
 452                         {'bd_id': bd_id,
 453                          'flood': flood,
 454                          'uu_flood': uu_flood,
 455                          'forward': forward,
 456                          'learn': learn,
 457                          'arp_term': arp_term,
 458                          'is_add': is_add})
 459
 460     def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
 461         return self.api(self.papi.bd_ip_mac_add_del,
 462                         {'bd_id': bd_id,
 463                          'is_add': is_add,
 464                          'is_ipv6': is_ipv6,
 465                          'ip_address': ip,
 466                          'mac_address': mac})
 467
 468     def want_ip4_arp_events(self, enable_disable=1, address=0):
 469         return self.api(self.papi.want_ip4_arp_events,
 470                         {'enable_disable': enable_disable,
 471                          'address': address,
 472                          'pid': os.getpid(), })
 473
 474     def want_ip6_nd_events(self, enable_disable=1, address=0):
 475         return self.api(self.papi.want_ip6_nd_events,
 476                         {'enable_disable': enable_disable,
 477                          'address': address,
 478                          'pid': os.getpid(), })
 479
 480     def want_ip6_ra_events(self, enable_disable=1):
 481         return self.api(self.papi.want_ip6_ra_events,
 482                         {'enable_disable': enable_disable,
 483                          'pid': os.getpid(), })
 484
 485     def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
 486                                        mrc=0, mrd=0):
 487         return self.api(self.papi.ip6nd_send_router_solicitation,
 488                         {'irt': irt,
 489                          'mrt': mrt,
 490                          'mrc': mrc,
 491                          'mrd': mrd,
 492                          'sw_if_index': sw_if_index})
 493
 494     def ip6_nd_address_autoconfig(self, sw_if_index, enable,
 495                                   install_default_routes):
 496         return self.api(self.papi.ip6_nd_address_autoconfig,
 497                         {'sw_if_index': sw_if_index,
 498                          'enable': enable,
 499                          'install_default_routes': install_default_routes})
 500
 501     def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
 502                                max_macs_in_event=0, learn_limit=0):
 503         return self.api(self.papi.want_l2_macs_events,
 504                         {'enable_disable': enable_disable,
 505                          'scan_delay': scan_delay,
 506                          'max_macs_in_event': max_macs_in_event,
 507                          'learn_limit': learn_limit,
 508                          'pid': os.getpid(), })
 509
 510     def want_dhcp6_reply_events(self, enable_disable=1):
 511         return self.api(self.papi.want_dhcp6_reply_events,
 512                         {'enable_disable': enable_disable,
 513                          'pid': os.getpid()})
 514
 515     def want_dhcp6_pd_reply_events(self, enable_disable=1):
 516         return self.api(self.papi.want_dhcp6_pd_reply_events,
 517                         {'enable_disable': enable_disable,
 518                          'pid': os.getpid()})
 519
 520     def dhcp6_clients_enable_disable(self, enable=1):
 521         return self.api(self.papi.dhcp6_clients_enable_disable,
 522                         {'enable': enable})
 523
 524     def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
 525                                   addresses, server_index=0xFFFFFFFF,
 526                                   irt=0, mrt=0, mrc=1, mrd=0, stop=0,
 527                                   ):
 528         return self.api(self.papi.dhcp6_send_client_message,
 529                         {'sw_if_index': sw_if_index,
 530                          'server_index': server_index,
 531                          'irt': irt,
 532                          'mrt': mrt,
 533                          'mrc': mrc,
 534                          'mrd': mrd,
 535                          'stop': stop,
 536                          'msg_type': msg_type,
 537                          'T1': T1,
 538                          'T2': T2,
 539                          'n_addresses': len(addresses),
 540                          'addresses': addresses})
 541
 542     def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
 543                                      prefixes, server_index=0xFFFFFFFF,
 544                                      irt=0, mrt=0, mrc=1, mrd=0, stop=0,
 545                                      ):
 546         return self.api(self.papi.dhcp6_pd_send_client_message,
 547                         {'sw_if_index': sw_if_index,
 548                          'server_index': server_index,
 549                          'irt': irt,
 550                          'mrt': mrt,
 551                          'mrc': mrc,
 552                          'mrd': mrd,
 553                          'stop': stop,
 554                          'msg_type': msg_type,
 555                          'T1': T1,
 556                          'T2': T2,
 557                          'n_prefixes': len(prefixes),
 558                          'prefixes': prefixes})
 559
 560     def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
 561                                     enable=1):
 562         return self.api(self.papi.dhcp6_client_enable_disable,
 563                         {'sw_if_index': sw_if_index,
 564                          'enable': enable})
 565
 566     def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
 567                                        enable=1):
 568         return self.api(self.papi.dhcp6_pd_client_enable_disable,
 569                         {'sw_if_index': sw_if_index,
 570                          'prefix_group': prefix_group,
 571                          'enable': enable})
 572
 573     def ip6_add_del_address_using_prefix(self, sw_if_index, address,
 574                                          prefix_length, prefix_group,
 575                                          is_add=1):
 576         return self.api(self.papi.ip6_add_del_address_using_prefix,
 577                         {'sw_if_index': sw_if_index,
 578                          'prefix_group': prefix_group,
 579                          'address': address,
 580                          'prefix_length': prefix_length,
 581                          'is_add': is_add})
 582
 583     def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
 584                       filter_mac=0, bvi_mac=0):
 585         """Create/delete L2 FIB entry.
 586
 587         :param str mac: MAC address to create FIB entry for.
 588         :param int bd_id: Bridge domain index.
 589         :param int sw_if_index: Software interface index of the interface.
 590         :param int is_add: Add or delete flag. (Default value = 1)
 591         :param int static_mac: Set to 1 to create static MAC entry.
 592             (Default value = 0)
 593         :param int filter_mac: Set to 1 to drop packet that's source or
 594             destination MAC address contains defined MAC address.
 595             (Default value = 0)
 596         :param int bvi_mac: Set to 1 to create entry that points to BVI
 597             interface. (Default value = 0)
 598         """
 599         return self.api(self.papi.l2fib_add_del,
 600                         {'mac': self._convert_mac(mac),
 601                          'bd_id': bd_id,
 602                          'sw_if_index': sw_if_index,
 603                          'is_add': is_add,
 604                          'static_mac': static_mac,
 605                          'filter_mac': filter_mac,
 606                          'bvi_mac': bvi_mac})
 607
 608     def l2fib_flush_int(self, sw_if_index):
 609         """Flush L2 FIB entries for sw_if_index.
 610
 611         :param int sw_if_index: Software interface index of the interface.
 612         """
 613         return self.api(self.papi.l2fib_flush_int,
 614                         {'sw_if_index': sw_if_index})
 615
 616     def l2fib_flush_bd(self, bd_id):
 617         """Flush L2 FIB entries for bd_id.
 618
 619         :param int sw_if_index: Bridge Domain id.
 620         """
 621         return self.api(self.papi.l2fib_flush_bd,
 622                         {'bd_id': bd_id})
 623
 624     def l2fib_flush_all(self):
 625         """Flush all L2 FIB.
 626         """
 627         return self.api(self.papi.l2fib_flush_all, {})
 628
 629     def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
 630                                    shg=0, bvi=0, enable=1):
 631         """Add/remove interface to/from bridge domain.
 632
 633         :param int sw_if_index: Software interface index of the interface.
 634         :param int bd_id: Bridge domain index.
 635         :param int shg: Split-horizon group index. (Default value = 0)
 636         :param int bvi: Set interface as a bridge group virtual interface.
 637             (Default value = 0)
 638         :param int enable: Add or remove interface. (Default value = 1)
 639         """
 640         return self.api(self.papi.sw_interface_set_l2_bridge,
 641                         {'rx_sw_if_index': sw_if_index,
 642                          'bd_id': bd_id,
 643                          'shg': shg,
 644                          'bvi': bvi,
 645                          'enable': enable})
 646
 647     def bridge_flags(self, bd_id, is_set, feature_bitmap):
 648         """Enable/disable required feature of the bridge domain with defined
 649         ID.
 650
 651         :param int bd_id: Bridge domain ID.
 652         :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
 653         :param int feature_bitmap: Bitmap value of the feature to be set:
 654             - learn (1 << 0),
 655             - forward (1 << 1),
 656             - flood (1 << 2),
 657             - uu-flood (1 << 3) or
 658             - arp-term (1 << 4).
 659         """
 660         return self.api(self.papi.bridge_flags,
 661                         {'bd_id': bd_id,
 662                          'is_set': is_set,
 663                          'feature_bitmap': feature_bitmap})
 664
 665     def bridge_domain_dump(self, bd_id=0):
 666         """
 667
 668         :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
 669             existing bridge domains returned)
 670         :return: Dictionary of bridge domain(s) data.
 671         """
 672         return self.api(self.papi.bridge_domain_dump,
 673                         {'bd_id': bd_id})
 674
 675     def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
 676                                      enable):
 677         """Create or delete unidirectional cross-connect from Tx interface to
 678         Rx interface.
 679
 680         :param int rx_sw_if_index: Software interface index of Rx interface.
 681         :param int tx_sw_if_index: Software interface index of Tx interface.
 682         :param int enable: Create cross-connect if equal to 1, delete
 683             cross-connect if equal to 0.
 684
 685         """
 686         return self.api(self.papi.sw_interface_set_l2_xconnect,
 687                         {'rx_sw_if_index': rx_sw_if_index,
 688                          'tx_sw_if_index': tx_sw_if_index,
 689                          'enable': enable})
 690
 691     def sw_interface_set_l2_tag_rewrite(
 692             self,
 693             sw_if_index,
 694             vtr_oper,
 695             push=0,
 696             tag1=0,
 697             tag2=0):
 698         """L2 interface vlan tag rewrite configure request
 699         :param client_index - opaque cookie to identify the sender
 700         :param context - sender context, to match reply w/ request
 701         :param sw_if_index - interface the operation is applied to
 702         :param vtr_op - Choose from l2_vtr_op_t enum values
 703         :param push_dot1q - first pushed flag dot1q id set, else dot1ad
 704         :param tag1 - Needed for any push or translate vtr op
 705         :param tag2 - Needed for any push 2 or translate x-2 vtr ops
 706
 707         """
 708         return self.api(self.papi.l2_interface_vlan_tag_rewrite,
 709                         {'sw_if_index': sw_if_index,
 710                          'vtr_op': vtr_oper,
 711                          'push_dot1q': push,
 712                          'tag1': tag1,
 713                          'tag2': tag2})
 714
 715     def sw_interface_set_l2_emulation(
 716             self,
 717             sw_if_index,
 718             enable=1):
 719         """L2 Emulation
 720         :param sw_if_index - interface the operation is applied to
 721
 722         """
 723         return self.api(self.papi.l2_emulation,
 724                         {'sw_if_index': sw_if_index,
 725                          'enable': enable})
 726
 727     def sw_interface_set_ip_directed_broadcast(
 728             self,
 729             sw_if_index,
 730             enable=1):
 731         """IP Directed broadcast
 732         :param sw_if_index - interface the operation is applied to
 733
 734         """
 735         return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
 736                         {'sw_if_index': sw_if_index,
 737                          'enable': enable})
 738
 739     def sw_interface_set_flags(self, sw_if_index, admin_up_down):
 740         """
 741
 742         :param admin_up_down:
 743         :param sw_if_index:
 744
 745         """
 746         return self.api(self.papi.sw_interface_set_flags,
 747                         {'sw_if_index': sw_if_index,
 748                          'admin_up_down': admin_up_down})
 749
 750     def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
 751         """
 752         :param sw_if_index:
 753         :param mtu:
 754
 755         """
 756         return self.api(self.papi.sw_interface_set_mtu,
 757                         {'sw_if_index': sw_if_index,
 758                          'mtu': mtu})
 759
 760     def sw_interface_set_promiscuous(self, sw_if_index, enable):
 761         """
 762         :param sw_if_index:
 763         :param enable:
 764
 765         """
 766         return self.api(self.papi.sw_interface_set_promiscuous,
 767                         {'sw_if_index': sw_if_index,
 768                          'enable': enable})
 769
 770     def sw_interface_set_mac_address(self, sw_if_index, mac):
 771         return self.api(self.papi.sw_interface_set_mac_address,
 772                         {'sw_if_index': sw_if_index,
 773                          'mac_address': mac})
 774
 775     def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
 776                      no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
 777                      default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
 778         """Create subinterface
 779         from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
 780
 781         :param sub_id: param inner_vlan:
 782         :param sw_if_index:
 783         :param outer_vlan:
 784         :param inner_vlan:
 785         :param no_tags:  (Default value = 0)
 786         :param one_tag:  (Default value = 0)
 787         :param two_tags:  (Default value = 0)
 788         :param dot1ad:  (Default value = 0)
 789         :param exact_match:  (Default value = 0)
 790         :param default_sub:  (Default value = 0)
 791         :param outer_vlan_id_any:  (Default value = 0)
 792         :param inner_vlan_id_any:  (Default value = 0)
 793
 794         """
 795         return self.api(
 796             self.papi.create_subif,
 797             {'sw_if_index': sw_if_index,
 798              'sub_id': sub_id,
 799              'no_tags': no_tags,
 800              'one_tag': one_tag,
 801              'two_tags': two_tags,
 802              'dot1ad': dot1ad,
 803              'exact_match': exact_match,
 804              'default_sub': default_sub,
 805              'outer_vlan_id_any': outer_vlan_id_any,
 806              'inner_vlan_id_any': inner_vlan_id_any,
 807              'outer_vlan_id': outer_vlan,
 808              'inner_vlan_id': inner_vlan})
 809
 810     def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
 811         """Create p2p ethernet subinterface
 812
 813         :param sw_if_index: main (parent) interface
 814         :param remote_mac: client (remote) mac address
 815
 816         """
 817         return self.api(
 818             self.papi.p2p_ethernet_add,
 819             {'parent_if_index': sw_if_index,
 820              'remote_mac': remote_mac,
 821              'subif_id': subif_id})
 822
 823     def delete_subif(self, sw_if_index):
 824         """Delete subinterface
 825
 826         :param sw_if_index:
 827         """
 828         return self.api(self.papi.delete_subif,
 829                         {'sw_if_index': sw_if_index})
 830
 831     def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
 832         """Delete p2p ethernet subinterface
 833
 834         :param sw_if_index: main (parent) interface
 835         :param remote_mac: client (remote) mac address
 836
 837         """
 838         return self.api(
 839             self.papi.p2p_ethernet_del,
 840             {'parent_if_index': sw_if_index,
 841              'remote_mac': remote_mac})
 842
 843     def create_vlan_subif(self, sw_if_index, vlan):
 844         """
 845
 846         :param vlan:
 847         :param sw_if_index:
 848
 849         """
 850         return self.api(self.papi.create_vlan_subif,
 851                         {'sw_if_index': sw_if_index,
 852                          'vlan_id': vlan})
 853
 854     def create_loopback(self, mac=''):
 855         """
 856
 857         :param mac: (Optional)
 858         """
 859         return self.api(self.papi.create_loopback,
 860                         {'mac_address': mac})
 861
 862     def delete_loopback(self, sw_if_index):
 863         return self.api(self.papi.delete_loopback,
 864                         {'sw_if_index': sw_if_index, })
 865
 866     def ip_table_add_del(self,
 867                          table_id,
 868                          is_add=1,
 869                          is_ipv6=0):
 870         """
 871
 872         :param table_id
 873         :param is_add:  (Default value = 1)
 874         :param is_ipv6:  (Default value = 0)
 875
 876         """
 877
 878         return self.api(
 879             self.papi.ip_table_add_del,
 880             {'table_id': table_id,
 881              'is_add': is_add,
 882              'is_ipv6': is_ipv6})
 883
 884     def ip_add_del_route(
 885             self,
 886             dst_address,
 887             dst_address_length,
 888             next_hop_address,
 889             next_hop_sw_if_index=0xFFFFFFFF,
 890             table_id=0,
 891             next_hop_table_id=0,
 892             next_hop_weight=1,
 893             next_hop_n_out_labels=0,
 894             next_hop_out_label_stack=[],
 895             next_hop_via_label=MPLS_LABEL_INVALID,
 896             next_hop_id=0xFFFFFFFF,
 897             is_resolve_host=0,
 898             is_resolve_attached=0,
 899             classify_table_index=0xFFFFFFFF,
 900             is_add=1,
 901             is_drop=0,
 902             is_unreach=0,
 903             is_prohibit=0,
 904             is_ipv6=0,
 905             is_local=0,
 906             is_classify=0,
 907             is_multipath=0,
 908             is_dvr=0,
 909             is_udp_encap=0,
 910             is_source_lookup=0):
 911         """
 912
 913         :param dst_address_length:
 914         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 915         :param dst_address:
 916         :param next_hop_address:
 917         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 918         :param vrf_id:  (Default value = 0)
 919         :param lookup_in_vrf:  (Default value = 0)
 920         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 921         :param is_add:  (Default value = 1)
 922         :param is_drop:  (Default value = 0)
 923         :param is_ipv6:  (Default value = 0)
 924         :param is_local:  (Default value = 0)
 925         :param is_classify:  (Default value = 0)
 926         :param is_multipath:  (Default value = 0)
 927         :param is_resolve_host:  (Default value = 0)
 928         :param is_resolve_attached:  (Default value = 0)
 929         :param is_dvr:  (Default value = 0)
 930         :param is_source_lookup:  (Default value = 0)
 931         :param next_hop_weight:  (Default value = 1)
 932
 933         """
 934
 935         return self.api(
 936             self.papi.ip_add_del_route,
 937             {'next_hop_sw_if_index': next_hop_sw_if_index,
 938              'table_id': table_id,
 939              'classify_table_index': classify_table_index,
 940              'next_hop_table_id': next_hop_table_id,
 941              'is_add': is_add,
 942              'is_drop': is_drop,
 943              'is_unreach': is_unreach,
 944              'is_prohibit': is_prohibit,
 945              'is_ipv6': is_ipv6,
 946              'is_local': is_local,
 947              'is_classify': is_classify,
 948              'is_multipath': is_multipath,
 949              'is_resolve_host': is_resolve_host,
 950              'is_resolve_attached': is_resolve_attached,
 951              'is_dvr': is_dvr,
 952              'is_source_lookup': is_source_lookup,
 953              'is_udp_encap': is_udp_encap,
 954              'next_hop_weight': next_hop_weight,
 955              'dst_address_length': dst_address_length,
 956              'dst_address': dst_address,
 957              'next_hop_id': next_hop_id,
 958              'next_hop_address': next_hop_address,
 959              'next_hop_n_out_labels': next_hop_n_out_labels,
 960              'next_hop_via_label': next_hop_via_label,
 961              'next_hop_out_label_stack': next_hop_out_label_stack})
 962
 963     def ip_fib_dump(self):
 964         return self.api(self.papi.ip_fib_dump, {})
 965
 966     def ip6_fib_dump(self):
 967         return self.api(self.papi.ip6_fib_dump, {})
 968
 969     def ip_neighbor_add_del(self,
 970                             sw_if_index,
 971                             mac_address,
 972                             dst_address,
 973                             is_add=1,
 974                             is_ipv6=0,
 975                             is_static=0,
 976                             is_no_adj_fib=0,
 977                             ):
 978         """ Add neighbor MAC to IPv4 or IPv6 address.
 979
 980         :param sw_if_index:
 981         :param mac_address:
 982         :param dst_address:
 983         :param is_add:  (Default value = 1)
 984         :param is_ipv6:  (Default value = 0)
 985         :param is_static:  (Default value = 0)
 986         :param is_no_adj_fib:  (Default value = 0)
 987         """
 988
 989         return self.api(
 990             self.papi.ip_neighbor_add_del,
 991             {'sw_if_index': sw_if_index,
 992              'is_add': is_add,
 993              'is_ipv6': is_ipv6,
 994              'is_static': is_static,
 995              'is_no_adj_fib': is_no_adj_fib,
 996              'mac_address': mac_address,
 997              'dst_address': dst_address
 998              }
 999         )
1000
1001     def ip_neighbor_dump(self,
1002                          sw_if_index,
1003                          is_ipv6=0):
1004         """ Return IP neighbor dump.
1005
1006         :param sw_if_index:
1007         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1008         """
1009
1010         return self.api(
1011             self.papi.ip_neighbor_dump,
1012             {'is_ipv6': is_ipv6,
1013              'sw_if_index': sw_if_index
1014              }
1015         )
1016
1017     def proxy_arp_add_del(self,
1018                           low_address,
1019                           hi_address,
1020                           vrf_id=0,
1021                           is_add=1):
1022         """ Config Proxy Arp Range.
1023
1024         :param low_address: Start address in the rnage to Proxy for
1025         :param hi_address: End address in the rnage to Proxy for
1026         :param vrf_id: The VRF/table in which to proxy
1027         """
1028
1029         return self.api(
1030             self.papi.proxy_arp_add_del,
1031             {'proxy':
1032              {
1033                  'vrf_id': vrf_id,
1034                  'low_address': low_address,
1035                  'hi_address': hi_address,
1036              },
1037              'is_add': is_add})
1038
1039     def proxy_arp_intfc_enable_disable(self,
1040                                        sw_if_index,
1041                                        is_enable=1):
1042         """ Enable/Disable an interface for proxy ARP requests
1043
1044         :param sw_if_index: Interface
1045         :param enable_disable: Enable/Disable
1046         """
1047
1048         return self.api(
1049             self.papi.proxy_arp_intfc_enable_disable,
1050             {'sw_if_index': sw_if_index,
1051              'enable_disable': is_enable
1052              }
1053         )
1054
1055     def reset_vrf(self,
1056                   vrf_id,
1057                   is_ipv6=0,
1058                   ):
1059         """ Reset VRF (remove all routes etc.) request.
1060
1061         :param int vrf_id: ID of the FIB table / VRF to reset.
1062         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1063         """
1064
1065         return self.api(
1066             self.papi.reset_vrf,
1067             {'vrf_id': vrf_id,
1068              'is_ipv6': is_ipv6,
1069              }
1070         )
1071
1072     def reset_fib(self,
1073                   vrf_id,
1074                   is_ipv6=0,
1075                   ):
1076         """ Reset VRF (remove all routes etc.) request.
1077
1078         :param int vrf_id: ID of the FIB table / VRF to reset.
1079         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1080         """
1081
1082         return self.api(
1083             self.papi.reset_fib,
1084             {'vrf_id': vrf_id,
1085              'is_ipv6': is_ipv6,
1086              }
1087         )
1088
1089     def ip_dump(self,
1090                 is_ipv6=0,
1091                 ):
1092         """ Return IP dump.
1093
1094         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1095         """
1096
1097         return self.api(
1098             self.papi.ip_dump,
1099             {'is_ipv6': is_ipv6,
1100              }
1101         )
1102
1103     def sw_interface_span_enable_disable(
1104             self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1105         """
1106
1107         :param sw_if_index_from:
1108         :param sw_if_index_to:
1109         :param state:
1110         :param is_l2:
1111         """
1112         return self.api(self.papi.sw_interface_span_enable_disable,
1113                         {'sw_if_index_from': sw_if_index_from,
1114                          'sw_if_index_to': sw_if_index_to,
1115                          'state': state,
1116                          'is_l2': is_l2,
1117                          })
1118
1119     def gre_tunnel_add_del(self,
1120                            src_address,
1121                            dst_address,
1122                            outer_fib_id=0,
1123                            tunnel_type=0,
1124                            instance=0xFFFFFFFF,
1125                            session_id=0,
1126                            is_add=1,
1127                            is_ip6=0):
1128         """ Add a GRE tunnel
1129
1130         :param src_address:
1131         :param dst_address:
1132         :param outer_fib_id:  (Default value = 0)
1133         :param tunnel_type:  (Default value = 0)
1134         :param instance:  (Default value = 0xFFFFFFFF)
1135         :param session_id: (Defalt value = 0)
1136         :param is_add:  (Default value = 1)
1137         :param is_ipv6:  (Default value = 0)
1138         """
1139
1140         return self.api(
1141             self.papi.gre_add_del_tunnel,
1142             {'is_add': is_add,
1143              'is_ipv6': is_ip6,
1144              'tunnel_type': tunnel_type,
1145              'instance': instance,
1146              'src_address': src_address,
1147              'dst_address': dst_address,
1148              'outer_fib_id': outer_fib_id,
1149              'session_id': session_id}
1150         )
1151
1152     def udp_encap_add(self,
1153                       src_ip,
1154                       dst_ip,
1155                       src_port,
1156                       dst_port,
1157                       table_id=0):
1158         """ Add a GRE tunnel
1159         :param src_ip:
1160         :param dst_ip:
1161         :param src_port:
1162         :param dst_port:
1163         :param outer_fib_id:  (Default value = 0)
1164         """
1165
1166         return self.api(
1167             self.papi.udp_encap_add,
1168             {
1169                 'udp_encap': {
1170                     'src_ip': src_ip,
1171                     'dst_ip': dst_ip,
1172                     'src_port': src_port,
1173                     'dst_port': dst_port,
1174                     'table_id': table_id
1175                 }
1176             })
1177
1178     def udp_encap_del(self, id):
1179         return self.api(self.papi.udp_encap_del, {'id': id})
1180
1181     def udp_encap_dump(self):
1182         return self.api(self.papi.udp_encap_dump, {})
1183
1184     def want_udp_encap_stats(self, enable=1):
1185         return self.api(self.papi.want_udp_encap_stats,
1186                         {'enable': enable,
1187                          'pid': os.getpid()})
1188
1189     def mpls_fib_dump(self):
1190         return self.api(self.papi.mpls_fib_dump, {})
1191
1192     def mpls_table_add_del(
1193             self,
1194             table_id,
1195             is_add=1):
1196         """
1197
1198         :param table_id
1199         :param is_add:  (Default value = 1)
1200
1201         """
1202
1203         return self.api(
1204             self.papi.mpls_table_add_del,
1205             {'mt_table_id': table_id,
1206              'mt_is_add': is_add})
1207
1208     def mpls_route_add_del(
1209             self,
1210             label,
1211             eos,
1212             next_hop_proto,
1213             next_hop_address,
1214             next_hop_sw_if_index=0xFFFFFFFF,
1215             table_id=0,
1216             next_hop_table_id=0,
1217             next_hop_weight=1,
1218             next_hop_n_out_labels=0,
1219             next_hop_out_label_stack=[],
1220             next_hop_via_label=MPLS_LABEL_INVALID,
1221             is_resolve_host=0,
1222             is_resolve_attached=0,
1223             is_interface_rx=0,
1224             is_rpf_id=0,
1225             is_multicast=0,
1226             is_add=1,
1227             is_drop=0,
1228             is_multipath=0,
1229             classify_table_index=0xFFFFFFFF,
1230             is_classify=0):
1231         """
1232
1233         :param dst_address_length:
1234         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1235         :param dst_address:
1236         :param next_hop_address:
1237         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1238         :param vrf_id:  (Default value = 0)
1239         :param lookup_in_vrf:  (Default value = 0)
1240         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1241         :param is_add:  (Default value = 1)
1242         :param is_drop:  (Default value = 0)
1243         :param is_ipv6:  (Default value = 0)
1244         :param is_local:  (Default value = 0)
1245         :param is_classify:  (Default value = 0)
1246         :param is_multipath:  (Default value = 0)
1247         :param is_multicast:  (Default value = 0)
1248         :param is_resolve_host:  (Default value = 0)
1249         :param is_resolve_attached:  (Default value = 0)
1250         :param next_hop_weight:  (Default value = 1)
1251
1252         """
1253         return self.api(
1254             self.papi.mpls_route_add_del,
1255             {'mr_label': label,
1256              'mr_eos': eos,
1257              'mr_table_id': table_id,
1258              'mr_classify_table_index': classify_table_index,
1259              'mr_is_add': is_add,
1260              'mr_is_classify': is_classify,
1261              'mr_is_multipath': is_multipath,
1262              'mr_is_multicast': is_multicast,
1263              'mr_is_resolve_host': is_resolve_host,
1264              'mr_is_resolve_attached': is_resolve_attached,
1265              'mr_is_interface_rx': is_interface_rx,
1266              'mr_is_rpf_id': is_rpf_id,
1267              'mr_next_hop_proto': next_hop_proto,
1268              'mr_next_hop_weight': next_hop_weight,
1269              'mr_next_hop': next_hop_address,
1270              'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1271              'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1272              'mr_next_hop_table_id': next_hop_table_id,
1273              'mr_next_hop_via_label': next_hop_via_label,
1274              'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1275
1276     def mpls_ip_bind_unbind(
1277             self,
1278             label,
1279             dst_address,
1280             dst_address_length,
1281             table_id=0,
1282             ip_table_id=0,
1283             is_ip4=1,
1284             is_bind=1):
1285         """
1286         """
1287         return self.api(
1288             self.papi.mpls_ip_bind_unbind,
1289             {'mb_mpls_table_id': table_id,
1290              'mb_label': label,
1291              'mb_ip_table_id': ip_table_id,
1292              'mb_is_bind': is_bind,
1293              'mb_is_ip4': is_ip4,
1294              'mb_address_length': dst_address_length,
1295              'mb_address': dst_address})
1296
1297     def mpls_tunnel_add_del(
1298             self,
1299             tun_sw_if_index,
1300             next_hop_proto_is_ip4,
1301             next_hop_address,
1302             next_hop_sw_if_index=0xFFFFFFFF,
1303             next_hop_table_id=0,
1304             next_hop_weight=1,
1305             next_hop_n_out_labels=0,
1306             next_hop_out_label_stack=[],
1307             next_hop_via_label=MPLS_LABEL_INVALID,
1308             is_add=1,
1309             l2_only=0,
1310             is_multicast=0):
1311         """
1312
1313         :param dst_address_length:
1314         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1315         :param dst_address:
1316         :param next_hop_address:
1317         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1318         :param vrf_id:  (Default value = 0)
1319         :param lookup_in_vrf:  (Default value = 0)
1320         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1321         :param is_add:  (Default value = 1)
1322         :param is_drop:  (Default value = 0)
1323         :param is_ipv6:  (Default value = 0)
1324         :param is_local:  (Default value = 0)
1325         :param is_classify:  (Default value = 0)
1326         :param is_multipath:  (Default value = 0)
1327         :param is_resolve_host:  (Default value = 0)
1328         :param is_resolve_attached:  (Default value = 0)
1329         :param next_hop_weight:  (Default value = 1)
1330         :param is_multicast:  (Default value = 0)
1331
1332         """
1333         return self.api(
1334             self.papi.mpls_tunnel_add_del,
1335             {'mt_sw_if_index': tun_sw_if_index,
1336              'mt_is_add': is_add,
1337              'mt_l2_only': l2_only,
1338              'mt_is_multicast': is_multicast,
1339              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1340              'mt_next_hop_weight': next_hop_weight,
1341              'mt_next_hop': next_hop_address,
1342              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1343              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1344              'mt_next_hop_table_id': next_hop_table_id,
1345              'mt_next_hop_via_label': next_hop_via_label,
1346              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1347
1348     def mpls_tunnel_dump(self):
1349         return self.api(self.papi.mpls_tunnel_dump, {})
1350
1351     def nat44_interface_add_del_feature(
1352             self,
1353             sw_if_index,
1354             is_inside=1,
1355             is_add=1):
1356         """Enable/disable NAT44 feature on the interface
1357
1358         :param sw_if_index: Software index of the interface
1359         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1360         :param is_add: 1 if add, 0 if delete (Default value = 1)
1361         """
1362         return self.api(
1363             self.papi.nat44_interface_add_del_feature,
1364             {'is_add': is_add,
1365              'is_inside': is_inside,
1366              'sw_if_index': sw_if_index})
1367
1368     def nat44_interface_add_del_output_feature(
1369             self,
1370             sw_if_index,
1371             is_inside=1,
1372             is_add=1):
1373         """Enable/disable NAT44 output feature on the interface
1374
1375         :param sw_if_index: Software index of the interface
1376         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1377         :param is_add: 1 if add, 0 if delete (Default value = 1)
1378         """
1379         return self.api(
1380             self.papi.nat44_interface_add_del_output_feature,
1381             {'is_add': is_add,
1382              'is_inside': is_inside,
1383              'sw_if_index': sw_if_index})
1384
1385     def nat44_add_del_static_mapping(
1386             self,
1387             local_ip,
1388             external_ip=0,
1389             external_sw_if_index=0xFFFFFFFF,
1390             local_port=0,
1391             external_port=0,
1392             addr_only=1,
1393             vrf_id=0,
1394             protocol=0,
1395             twice_nat=0,
1396             self_twice_nat=0,
1397             out2in_only=0,
1398             tag="",
1399             is_add=1):
1400         """Add/delete NAT44 static mapping
1401
1402         :param local_ip: Local IP address
1403         :param external_ip: External IP address
1404         :param external_sw_if_index: External interface instead of IP address
1405         :param local_port: Local port number (Default value = 0)
1406         :param external_port: External port number (Default value = 0)
1407         :param addr_only: 1 if address only mapping, 0 if address and port
1408         :param vrf_id: VRF ID
1409         :param protocol: IP protocol (Default value = 0)
1410         :param twice_nat: 1 if translate external host address and port
1411         :param self_twice_nat: 1 if translate external host address and port
1412                                whenever external host address equals
1413                                local address of internal host
1414         :param out2in_only: if 1 rule is matching only out2in direction
1415         :param tag: Opaque string tag
1416         :param is_add: 1 if add, 0 if delete (Default value = 1)
1417         """
1418         return self.api(
1419             self.papi.nat44_add_del_static_mapping,
1420             {'is_add': is_add,
1421              'addr_only': addr_only,
1422              'local_ip_address': local_ip,
1423              'external_ip_address': external_ip,
1424              'local_port': local_port,
1425              'external_port': external_port,
1426              'external_sw_if_index': external_sw_if_index,
1427              'vrf_id': vrf_id,
1428              'protocol': protocol,
1429              'twice_nat': twice_nat,
1430              'self_twice_nat': self_twice_nat,
1431              'out2in_only': out2in_only,
1432              'tag': tag})
1433
1434     def nat44_add_del_identity_mapping(
1435             self,
1436             ip='0',
1437             sw_if_index=0xFFFFFFFF,
1438             port=0,
1439             addr_only=1,
1440             vrf_id=0,
1441             protocol=0,
1442             tag='',
1443             is_add=1):
1444         """Add/delete NAT44 identity mapping
1445
1446         :param ip: IP address (Default value = 0)
1447         :param sw_if_index: Interface instead of IP address
1448         :param port: Port number (Default value = 0)
1449         :param addr_only: 1 if address only mapping, 0 if address and port
1450         :param vrf_id: VRF ID
1451         :param protocol: IP protocol (Default value = 0)
1452         :param tag: Opaque string tag
1453         :param is_add: 1 if add, 0 if delete (Default value = 1)
1454         """
1455         return self.api(
1456             self.papi.nat44_add_del_identity_mapping,
1457             {'is_add': is_add,
1458              'addr_only': addr_only,
1459              'ip_address': ip,
1460              'port': port,
1461              'sw_if_index': sw_if_index,
1462              'vrf_id': vrf_id,
1463              'tag': tag,
1464              'protocol': protocol})
1465
1466     def nat44_add_del_address_range(
1467             self,
1468             first_ip_address,
1469             last_ip_address,
1470             is_add=1,
1471             vrf_id=0xFFFFFFFF,
1472             twice_nat=0):
1473         """Add/del NAT44 address range
1474
1475         :param first_ip_address: First IP address
1476         :param last_ip_address: Last IP address
1477         :param vrf_id: VRF id for the address range
1478         :param twice_nat: twice NAT address for extenal hosts
1479         :param is_add: 1 if add, 0 if delete (Default value = 1)
1480         """
1481         return self.api(
1482             self.papi.nat44_add_del_address_range,
1483             {'first_ip_address': first_ip_address,
1484              'last_ip_address': last_ip_address,
1485              'vrf_id': vrf_id,
1486              'twice_nat': twice_nat,
1487              'is_add': is_add})
1488
1489     def nat44_address_dump(self):
1490         """Dump NAT44 addresses
1491         :return: Dictionary of NAT44 addresses
1492         """
1493         return self.api(self.papi.nat44_address_dump, {})
1494
1495     def nat44_interface_dump(self):
1496         """Dump interfaces with NAT44 feature
1497         :return: Dictionary of interfaces with NAT44 feature
1498         """
1499         return self.api(self.papi.nat44_interface_dump, {})
1500
1501     def nat44_interface_output_feature_dump(self):
1502         """Dump interfaces with NAT44 output feature
1503         :return: Dictionary of interfaces with NAT44 output feature
1504         """
1505         return self.api(self.papi.nat44_interface_output_feature_dump, {})
1506
1507     def nat44_static_mapping_dump(self):
1508         """Dump NAT44 static mappings
1509         :return: Dictionary of NAT44 static mappings
1510         """
1511         return self.api(self.papi.nat44_static_mapping_dump, {})
1512
1513     def nat44_identity_mapping_dump(self):
1514         """Dump NAT44 identity mappings
1515         :return: Dictionary of NAT44 identity mappings
1516         """
1517         return self.api(self.papi.nat44_identity_mapping_dump, {})
1518
1519     def nat_show_config(self):
1520         """Show NAT plugin config
1521         :return: NAT plugin config parameters
1522         """
1523         return self.api(self.papi.nat_show_config, {})
1524
1525     def nat44_add_interface_addr(
1526             self,
1527             sw_if_index,
1528             twice_nat=0,
1529             is_add=1):
1530         """Add/del NAT44 address from interface
1531
1532         :param sw_if_index: Software index of the interface
1533         :param twice_nat: twice NAT address for extenal hosts
1534         :param is_add: 1 if add, 0 if delete (Default value = 1)
1535         """
1536         return self.api(
1537             self.papi.nat44_add_del_interface_addr,
1538             {'is_add': is_add,
1539              'sw_if_index': sw_if_index,
1540              'twice_nat': twice_nat})
1541
1542     def nat44_interface_addr_dump(self):
1543         """Dump NAT44 addresses interfaces
1544         :return: Dictionary of NAT44 addresses interfaces
1545         """
1546         return self.api(self.papi.nat44_interface_addr_dump, {})
1547
1548     def nat_ipfix(
1549             self,
1550             domain_id=1,
1551             src_port=4739,
1552             enable=1):
1553         """Enable/disable NAT IPFIX logging
1554
1555         :param domain_id: Observation domain ID (Default value = 1)
1556         :param src_port: Source port number (Default value = 4739)
1557         :param enable: 1 if enable, 0 if disable (Default value = 1)
1558         """
1559         return self.api(
1560             self.papi.nat_ipfix_enable_disable,
1561             {'domain_id': domain_id,
1562              'src_port': src_port,
1563              'enable': enable})
1564
1565     def nat44_user_session_dump(
1566             self,
1567             ip_address,
1568             vrf_id):
1569         """Dump NAT44 user's sessions
1570
1571         :param ip_address: ip adress of the user to be dumped
1572         :param cpu_index: cpu_index on which the user is
1573         :param vrf_id: VRF ID
1574         :return: Dictionary of S-NAT sessions
1575         """
1576         return self.api(
1577             self.papi.nat44_user_session_dump,
1578             {'ip_address': ip_address,
1579              'vrf_id': vrf_id})
1580
1581     def nat44_user_dump(self):
1582         """Dump NAT44 users
1583
1584         :return: Dictionary of NAT44 users
1585         """
1586         return self.api(self.papi.nat44_user_dump, {})
1587
1588     def nat44_add_del_lb_static_mapping(
1589             self,
1590             external_addr,
1591             external_port,
1592             protocol,
1593             twice_nat=0,
1594             self_twice_nat=0,
1595             out2in_only=0,
1596             tag='',
1597             affinity=0,
1598             local_num=0,
1599             locals=[],
1600             is_add=1):
1601         """Add/delete NAT44 load balancing static mapping
1602
1603         :param twice_nat: 1 if translate external host address and port
1604         :param tag: Opaque string tag
1605         :param affinity: if 0 disabled, otherwise client IP affinity timeout
1606         :param is_add - 1 if add, 0 if delete
1607         """
1608         return self.api(
1609             self.papi.nat44_add_del_lb_static_mapping,
1610             {'is_add': is_add,
1611              'external_addr': external_addr,
1612              'external_port': external_port,
1613              'protocol': protocol,
1614              'twice_nat': twice_nat,
1615              'self_twice_nat': self_twice_nat,
1616              'out2in_only': out2in_only,
1617              'tag': tag,
1618              'affinity': affinity,
1619              'local_num': local_num,
1620              'locals': locals})
1621
1622     def nat44_lb_static_mapping_dump(self):
1623         """Dump NAT44 load balancing static mappings
1624
1625         :return: Dictionary of NAT44 load balancing static mapping
1626         """
1627         return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1628
1629     def nat44_del_session(
1630             self,
1631             addr,
1632             port,
1633             protocol,
1634             vrf_id=0,
1635             is_in=1,
1636             ext_host_address=None,
1637             ext_host_port=0):
1638         """Delete NAT44 session
1639
1640         :param addr: IPv4 address
1641         :param por: port number
1642         :param protocol: IP protocol number
1643         :param vrf_id: VRF ID
1644         :param is_in: 1 if inside network addres and port pari, 0 if outside
1645         :param ext_host_address: external host IPv4 address
1646         :param ext_host_port: external host port
1647         """
1648         if ext_host_address is None:
1649             return self.api(
1650                 self.papi.nat44_del_session,
1651                 {'address': addr,
1652                  'port': port,
1653                  'protocol': protocol,
1654                  'vrf_id': vrf_id,
1655                  'is_in': is_in})
1656         else:
1657             return self.api(
1658                 self.papi.nat44_del_session,
1659                 {'address': addr,
1660                  'port': port,
1661                  'protocol': protocol,
1662                  'vrf_id': vrf_id,
1663                  'is_in': is_in,
1664                  'ext_host_valid': 1,
1665                  'ext_host_address': ext_host_address,
1666                  'ext_host_port': ext_host_port})
1667
1668     def nat44_forwarding_enable_disable(
1669             self,
1670             enable):
1671         """Enable/disable forwarding for NAT44
1672
1673         :param enable: 1 for enable, 0 for disable
1674         """
1675         return self.api(
1676             self.papi.nat44_forwarding_enable_disable,
1677             {'enable': enable})
1678
1679     def nat_set_reass(
1680             self,
1681             timeout=2,
1682             max_reass=1024,
1683             max_frag=5,
1684             drop_frag=0,
1685             is_ip6=0):
1686         """Set NAT virtual fragmentation reassembly
1687
1688         :param timeout: reassembly timeout (Default 2sec)
1689         :param max_reass: maximum concurrent reassemblies (Default 1024)
1690         :param max_frag: maximum fragmets per reassembly (Default 5)
1691         :param drop_frag: if 0 translate fragments, otherwise drop fragments
1692         :param is_ip6: 1 if IPv6, 0 if IPv4
1693         """
1694         return self.api(
1695             self.papi.nat_set_reass,
1696             {'timeout': timeout,
1697              'max_reass': max_reass,
1698              'max_frag': max_frag,
1699              'drop_frag': drop_frag,
1700              'is_ip6': is_ip6})
1701
1702     def nat_get_reass(self):
1703         """Get NAT virtual fragmentation reassembly configuration
1704
1705         :return: NAT virtual fragmentation reassembly configuration
1706         """
1707         return self.api(self.papi.nat_get_reass, {})
1708
1709     def nat_reass_dump(self):
1710         """Dump NAT virtual fragmentation reassemblies
1711
1712         :return: Dictionary of NAT virtual fragmentation reassemblies
1713         """
1714         return self.api(self.papi.nat_reass_dump, {})
1715
1716     def nat_det_add_del_map(
1717             self,
1718             in_addr,
1719             in_plen,
1720             out_addr,
1721             out_plen,
1722             is_add=1):
1723         """Add/delete deterministic NAT mapping
1724
1725         :param is_add - 1 if add, 0 if delete
1726         :param in_addr - inside IP address
1727         :param in_plen - inside IP address prefix length
1728         :param out_addr - outside IP address
1729         :param out_plen - outside IP address prefix length
1730         """
1731         return self.api(
1732             self.papi.nat_det_add_del_map,
1733             {'is_add': is_add,
1734              'is_nat44': 1,
1735              'in_addr': in_addr,
1736              'in_plen': in_plen,
1737              'out_addr': out_addr,
1738              'out_plen': out_plen})
1739
1740     def nat_det_forward(
1741             self,
1742             in_addr):
1743         """Get outside address and port range from inside address
1744
1745         :param in_addr - inside IP address
1746         """
1747         return self.api(
1748             self.papi.nat_det_forward,
1749             {'in_addr': in_addr,
1750              'is_nat44': 1})
1751
1752     def nat_det_reverse(
1753             self,
1754             out_addr,
1755             out_port):
1756         """Get inside address from outside address and port
1757
1758         :param out_addr - outside IP address
1759         :param out_port - outside port
1760         """
1761         return self.api(
1762             self.papi.nat_det_reverse,
1763             {'out_addr': out_addr,
1764              'out_port': out_port})
1765
1766     def nat_det_map_dump(self):
1767         """Dump deterministic NAT mappings
1768
1769         :return: Dictionary of deterministic NAT mappings
1770         """
1771         return self.api(self.papi.nat_det_map_dump, {})
1772
1773     def nat_set_timeouts(
1774             self,
1775             udp=300,
1776             tcp_established=7440,
1777             tcp_transitory=240,
1778             icmp=60):
1779         """Set values of timeouts for NAT sessions (in seconds)
1780
1781         :param udp - UDP timeout (Default value = 300)
1782         :param tcp_established - TCP established timeout (Default value = 7440)
1783         :param tcp_transitory - TCP transitory timeout (Default value = 240)
1784         :param icmp - ICMP timeout (Default value = 60)
1785         """
1786         return self.api(
1787             self.papi.nat_set_timeouts,
1788             {'udp': udp,
1789              'tcp_established': tcp_established,
1790              'tcp_transitory': tcp_transitory,
1791              'icmp': icmp})
1792
1793     def nat_get_timeouts(self):
1794         """Get values of timeouts for NAT sessions
1795
1796         :return: Timeouts for NAT sessions (in seconds)
1797         """
1798         return self.api(self.papi.nat_get_timeouts, {})
1799
1800     def nat_set_addr_and_port_alloc_alg(
1801             self,
1802             alg=0,
1803             psid_offset=0,
1804             psid_length=0,
1805             psid=0,
1806             start_port=0,
1807             end_port=0):
1808         """Set address and port assignment algorithm
1809
1810         :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1811         :param psid_offset: number of offset bits (valid only for MAP-E alg)
1812         :param psid_length: length of PSID (valid only for MAP-E alg)
1813         :param psid: Port Set Identifier value (valid only for MAP-E alg)
1814         :param start_port: beginning of the port range
1815         :param end_port: end of the port range
1816         """
1817         return self.api(
1818             self.papi.nat_set_addr_and_port_alloc_alg,
1819             {'alg': alg,
1820              'psid_offset': psid_offset,
1821              'psid_length': psid_length,
1822              'psid': psid,
1823              'start_port': start_port,
1824              'end_port': end_port})
1825
1826     def nat_get_addr_and_port_alloc_alg(self):
1827         """Get address and port assignment algorithm"""
1828         return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1829
1830     def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1831         """Set TCP MSS rewriting configuration
1832
1833         :param enable: disable(0)/enable(1) MSS rewriting feature
1834         :param mss_value: MSS value to be used for MSS rewriting
1835         """
1836         return self.api(
1837             self.papi.nat_set_mss_clamping,
1838             {'enable': enable, 'mss_value': mss_value})
1839
1840     def nat_get_mss_clamping(self):
1841         """Get TCP MSS rewriting configuration"""
1842         return self.api(self.papi.nat_get_mss_clamping, {})
1843
1844     def nat_det_close_session_out(
1845             self,
1846             out_addr,
1847             out_port,
1848             ext_addr,
1849             ext_port):
1850         """Close deterministic NAT session using outside address and port
1851
1852         :param out_addr - outside IP address
1853         :param out_port - outside port
1854         :param ext_addr - external host IP address
1855         :param ext_port - external host port
1856         """
1857         return self.api(
1858             self.papi.nat_det_close_session_out,
1859             {'out_addr': out_addr,
1860              'out_port': out_port,
1861              'ext_addr': ext_addr,
1862              'ext_port': ext_port})
1863
1864     def nat_det_close_session_in(
1865             self,
1866             in_addr,
1867             in_port,
1868             ext_addr,
1869             ext_port):
1870         """Close deterministic NAT session using inside address and port
1871
1872         :param in_addr - inside IP address
1873         :param in_port - inside port
1874         :param ext_addr - external host IP address
1875         :param ext_port - external host port
1876         """
1877         return self.api(
1878             self.papi.nat_det_close_session_in,
1879             {'in_addr': in_addr,
1880              'in_port': in_port,
1881              'ext_addr': ext_addr,
1882              'ext_port': ext_port,
1883              'is_nat44': 1})
1884
1885     def nat_det_session_dump(
1886             self,
1887             user_addr):
1888         """Dump deterministic NAT sessions belonging to a user
1889
1890         :param user_addr - inside IP address of the user
1891         :return: Dictionary of deterministic NAT sessions
1892         """
1893         return self.api(
1894             self.papi.nat_det_session_dump,
1895             {'is_nat44': 1,
1896              'user_addr': user_addr})
1897
1898     def nat64_add_del_pool_addr_range(
1899             self,
1900             start_addr,
1901             end_addr,
1902             vrf_id=0xFFFFFFFF,
1903             is_add=1):
1904         """Add/del address range to NAT64 pool
1905
1906         :param start_addr: First IP address
1907         :param end_addr: Last IP address
1908         :param vrf_id: VRF id for the address range
1909         :param is_add: 1 if add, 0 if delete (Default value = 1)
1910         """
1911         return self.api(
1912             self.papi.nat64_add_del_pool_addr_range,
1913             {'start_addr': start_addr,
1914              'end_addr': end_addr,
1915              'vrf_id': vrf_id,
1916              'is_add': is_add})
1917
1918     def nat64_pool_addr_dump(self):
1919         """Dump NAT64 pool addresses
1920         :return: Dictionary of NAT64 pool addresses
1921         """
1922         return self.api(self.papi.nat64_pool_addr_dump, {})
1923
1924     def nat64_add_del_interface(
1925             self,
1926             sw_if_index,
1927             is_inside=1,
1928             is_add=1):
1929         """Enable/disable NAT64 feature on the interface
1930            :param sw_if_index: Index of the interface
1931            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1932            :param is_add: 1 if add, 0 if delete (Default value = 1)
1933         """
1934         return self.api(
1935             self.papi.nat64_add_del_interface,
1936             {'sw_if_index': sw_if_index,
1937              'is_inside': is_inside,
1938              'is_add': is_add})
1939
1940     def nat64_interface_dump(self):
1941         """Dump interfaces with NAT64 feature
1942         :return: Dictionary of interfaces with NAT64 feature
1943         """
1944         return self.api(self.papi.nat64_interface_dump, {})
1945
1946     def nat64_add_del_static_bib(
1947             self,
1948             in_ip,
1949             out_ip,
1950             in_port,
1951             out_port,
1952             protocol,
1953             vrf_id=0,
1954             is_add=1):
1955         """Add/delete S-NAT static BIB entry
1956
1957         :param in_ip: Inside IPv6 address
1958         :param out_ip: Outside IPv4 address
1959         :param in_port: Inside port number
1960         :param out_port: Outside port number
1961         :param protocol: IP protocol
1962         :param vrf_id: VRF ID (Default value = 0)
1963         :param is_add: 1 if add, 0 if delete (Default value = 1)
1964         """
1965         return self.api(
1966             self.papi.nat64_add_del_static_bib,
1967             {'i_addr': in_ip,
1968              'o_addr': out_ip,
1969              'i_port': in_port,
1970              'o_port': out_port,
1971              'vrf_id': vrf_id,
1972              'proto': protocol,
1973              'is_add': is_add})
1974
1975     def nat64_bib_dump(self, protocol=255):
1976         """Dump NAT64 BIB
1977
1978         :param protocol: IP protocol (Default value = 255, all BIBs)
1979         :returns: Dictionary of NAT64 BIB entries
1980         """
1981         return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1982
1983     def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1984                            tcp_incoming_syn=6):
1985         """Set values of timeouts for NAT64 (in seconds)
1986
1987         :param udpi: UDP timeout (Default value = 300)
1988         :param icmp: ICMP timeout (Default value = 60)
1989         :param tcp_trans: TCP transitory timeout (Default value = 240)
1990         :param tcp_est: TCP established timeout (Default value = 7440)
1991         :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1992         """
1993         return self.api(
1994             self.papi.nat64_set_timeouts,
1995             {'udp': udp,
1996              'icmp': icmp,
1997              'tcp_trans': tcp_trans,
1998              'tcp_est': tcp_est,
1999              'tcp_incoming_syn': tcp_incoming_syn})
2000
2001     def nat64_get_timeouts(self):
2002         """Get values of timeouts for NAT64
2003
2004         :return: Timeouts for NAT64 (in seconds)
2005         """
2006         return self.api(self.papi.nat64_get_timeouts, {})
2007
2008     def nat64_st_dump(self, protocol=255):
2009         """Dump NAT64 session table
2010
2011         :param protocol: IP protocol (Default value = 255, all STs)
2012         :returns: Dictionary of NAT64 sesstion table entries
2013         """
2014         return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2015
2016     def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2017         """Add/del NAT64 prefix
2018
2019         :param prefix: NAT64 prefix
2020         :param plen: NAT64 prefix length
2021         :param vrf_id: VRF id of tenant (Default 0)
2022         :param is_add: 1 if add, 0 if delete (Default value = 1)
2023         """
2024         return self.api(
2025             self.papi.nat64_add_del_prefix,
2026             {'prefix': prefix,
2027              'prefix_len': plen,
2028              'vrf_id': vrf_id,
2029              'is_add': is_add})
2030
2031     def nat64_prefix_dump(self):
2032         """Dump NAT64 prefix
2033
2034         :returns: Dictionary of NAT64 prefixes
2035         """
2036         return self.api(self.papi.nat64_prefix_dump, {})
2037
2038     def nat64_add_interface_addr(
2039             self,
2040             sw_if_index,
2041             is_add=1):
2042         """Add/del NAT64 address from interface
2043
2044         :param sw_if_index: Software index of the interface
2045         :param is_add: 1 if add, 0 if delete (Default value = 1)
2046         """
2047         return self.api(self.papi.nat64_add_del_interface_addr,
2048                         {'is_add': is_add, 'sw_if_index': sw_if_index})
2049
2050     def dslite_set_aftr_addr(self, ip6, ip4):
2051         """Set DS-Lite AFTR addresses
2052
2053         :param ip4: IPv4 address
2054         :param ip6: IPv6 address
2055         """
2056         return self.api(
2057             self.papi.dslite_set_aftr_addr,
2058             {'ip4_addr': ip4,
2059              'ip6_addr': ip6})
2060
2061     def dslite_set_b4_addr(self, ip6, ip4):
2062         """Set DS-Lite B4 IPv6 address
2063
2064         :param ip4: IPv4 address
2065         :param ip6: IPv6 address
2066         """
2067         return self.api(
2068             self.papi.dslite_set_b4_addr,
2069             {'ip4_addr': ip4,
2070              'ip6_addr': ip6})
2071
2072     def dslite_add_del_pool_addr_range(
2073             self,
2074             start_addr,
2075             end_addr,
2076             is_add=1):
2077         """Add/del address range to DS-Lite pool
2078
2079         :param start_addr: First IP address
2080         :param end_addr: Last IP address
2081         :param is_add: 1 if add, 0 if delete (Default value = 1)
2082         """
2083         return self.api(
2084             self.papi.dslite_add_del_pool_addr_range,
2085             {'start_addr': start_addr,
2086              'end_addr': end_addr,
2087              'is_add': is_add})
2088
2089     def nat66_add_del_interface(
2090             self,
2091             sw_if_index,
2092             is_inside=1,
2093             is_add=1):
2094         """Enable/disable NAT66 feature on the interface
2095            :param sw_if_index: Index of the interface
2096            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2097            :param is_add: 1 if add, 0 if delete (Default value = 1)
2098         """
2099         return self.api(
2100             self.papi.nat66_add_del_interface,
2101             {'sw_if_index': sw_if_index,
2102              'is_inside': is_inside,
2103              'is_add': is_add})
2104
2105     def nat66_add_del_static_mapping(
2106             self,
2107             in_ip,
2108             out_ip,
2109             vrf_id=0,
2110             is_add=1):
2111         """Add/delete NAT66 static mapping
2112
2113         :param in_ip: Inside IPv6 address
2114         :param out_ip: Outside IPv6 address
2115         :param vrf_id: VRF ID (Default value = 0)
2116         :param is_add: 1 if add, 0 if delete (Default value = 1)
2117         """
2118         return self.api(
2119             self.papi.nat66_add_del_static_mapping,
2120             {'local_ip_address': in_ip,
2121              'external_ip_address': out_ip,
2122              'vrf_id': vrf_id,
2123              'is_add': is_add})
2124
2125     def nat66_interface_dump(self):
2126         """Dump interfaces with NAT66 feature
2127         :return: Dictionary of interfaces with NAT66 feature
2128         """
2129         return self.api(self.papi.nat66_interface_dump, {})
2130
2131     def nat66_static_mapping_dump(self):
2132         """Dump NAT66 static mappings
2133         :return: Dictionary of NAT66 static mappings
2134         """
2135         return self.api(self.papi.nat66_static_mapping_dump, {})
2136
2137     def control_ping(self):
2138         self.api(self.papi.control_ping)
2139
2140     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2141                     detect_mult, local_addr, peer_addr, is_ipv6=0,
2142                     bfd_key_id=None, conf_key_id=None):
2143         if bfd_key_id is None:
2144             return self.api(self.papi.bfd_udp_add,
2145                             {
2146                                 'sw_if_index': sw_if_index,
2147                                 'desired_min_tx': desired_min_tx,
2148                                 'required_min_rx': required_min_rx,
2149                                 'local_addr': local_addr,
2150                                 'peer_addr': peer_addr,
2151                                 'is_ipv6': is_ipv6,
2152                                 'detect_mult': detect_mult,
2153                             })
2154         else:
2155             return self.api(self.papi.bfd_udp_add,
2156                             {
2157                                 'sw_if_index': sw_if_index,
2158                                 'desired_min_tx': desired_min_tx,
2159                                 'required_min_rx': required_min_rx,
2160                                 'local_addr': local_addr,
2161                                 'peer_addr': peer_addr,
2162                                 'is_ipv6': is_ipv6,
2163                                 'detect_mult': detect_mult,
2164                                 'is_authenticated': 1,
2165                                 'bfd_key_id': bfd_key_id,
2166                                 'conf_key_id': conf_key_id,
2167                             })
2168
2169     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2170                     detect_mult, local_addr, peer_addr, is_ipv6=0):
2171         return self.api(self.papi.bfd_udp_mod,
2172                         {
2173                             'sw_if_index': sw_if_index,
2174                             'desired_min_tx': desired_min_tx,
2175                             'required_min_rx': required_min_rx,
2176                             'local_addr': local_addr,
2177                             'peer_addr': peer_addr,
2178                             'is_ipv6': is_ipv6,
2179                             'detect_mult': detect_mult,
2180                         })
2181
2182     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2183                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2184                               is_delayed=False):
2185         return self.api(self.papi.bfd_udp_auth_activate,
2186                         {
2187                             'sw_if_index': sw_if_index,
2188                             'local_addr': local_addr,
2189                             'peer_addr': peer_addr,
2190                             'is_ipv6': is_ipv6,
2191                             'is_delayed': 1 if is_delayed else 0,
2192                             'bfd_key_id': bfd_key_id,
2193                             'conf_key_id': conf_key_id,
2194                         })
2195
2196     def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2197                                 is_ipv6=0, is_delayed=False):
2198         return self.api(self.papi.bfd_udp_auth_deactivate,
2199                         {
2200                             'sw_if_index': sw_if_index,
2201                             'local_addr': local_addr,
2202                             'peer_addr': peer_addr,
2203                             'is_ipv6': is_ipv6,
2204                             'is_delayed': 1 if is_delayed else 0,
2205                         })
2206
2207     def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2208         return self.api(self.papi.bfd_udp_del,
2209                         {
2210                             'sw_if_index': sw_if_index,
2211                             'local_addr': local_addr,
2212                             'peer_addr': peer_addr,
2213                             'is_ipv6': is_ipv6,
2214                         })
2215
2216     def bfd_udp_session_dump(self):
2217         return self.api(self.papi.bfd_udp_session_dump, {})
2218
2219     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2220                                   peer_addr, is_ipv6=0):
2221         return self.api(self.papi.bfd_udp_session_set_flags, {
2222             'admin_up_down': admin_up_down,
2223             'sw_if_index': sw_if_index,
2224             'local_addr': local_addr,
2225             'peer_addr': peer_addr,
2226             'is_ipv6': is_ipv6,
2227         })
2228
2229     def want_bfd_events(self, enable_disable=1):
2230         return self.api(self.papi.want_bfd_events, {
2231             'enable_disable': enable_disable,
2232             'pid': os.getpid(),
2233         })
2234
2235     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2236         return self.api(self.papi.bfd_auth_set_key, {
2237             'conf_key_id': conf_key_id,
2238             'auth_type': auth_type,
2239             'key': key,
2240             'key_len': len(key),
2241         })
2242
2243     def bfd_auth_del_key(self, conf_key_id):
2244         return self.api(self.papi.bfd_auth_del_key, {
2245             'conf_key_id': conf_key_id,
2246         })
2247
2248     def bfd_auth_keys_dump(self):
2249         return self.api(self.papi.bfd_auth_keys_dump, {})
2250
2251     def bfd_udp_set_echo_source(self, sw_if_index):
2252         return self.api(self.papi.bfd_udp_set_echo_source,
2253                         {'sw_if_index': sw_if_index})
2254
2255     def bfd_udp_del_echo_source(self):
2256         return self.api(self.papi.bfd_udp_del_echo_source, {})
2257
2258     def classify_add_del_table(
2259             self,
2260             is_add,
2261             mask,
2262             match_n_vectors=1,
2263             table_index=0xFFFFFFFF,
2264             nbuckets=2,
2265             memory_size=2097152,
2266             skip_n_vectors=0,
2267             next_table_index=0xFFFFFFFF,
2268             miss_next_index=0xFFFFFFFF,
2269             current_data_flag=0,
2270             current_data_offset=0):
2271         """
2272         :param is_add:
2273         :param mask:
2274         :param match_n_vectors: (Default value = 1)
2275         :param table_index: (Default value = 0xFFFFFFFF)
2276         :param nbuckets:  (Default value = 2)
2277         :param memory_size:  (Default value = 2097152)
2278         :param skip_n_vectors:  (Default value = 0)
2279         :param next_table_index:  (Default value = 0xFFFFFFFF)
2280         :param miss_next_index:  (Default value = 0xFFFFFFFF)
2281         :param current_data_flag:  (Default value = 0)
2282         :param current_data_offset:  (Default value = 0)
2283         """
2284
2285         mask_len = ((len(mask) - 1) / 16 + 1) * 16
2286         mask = mask + '\0' * (mask_len - len(mask))
2287         return self.api(
2288             self.papi.classify_add_del_table,
2289             {'is_add': is_add,
2290              'table_index': table_index,
2291              'nbuckets': nbuckets,
2292              'memory_size': memory_size,
2293              'skip_n_vectors': skip_n_vectors,
2294              'match_n_vectors': match_n_vectors,
2295              'next_table_index': next_table_index,
2296              'miss_next_index': miss_next_index,
2297              'current_data_flag': current_data_flag,
2298              'current_data_offset': current_data_offset,
2299              'mask_len': mask_len,
2300              'mask': mask})
2301
2302     def classify_add_del_session(
2303             self,
2304             is_add,
2305             table_index,
2306             match,
2307             opaque_index=0xFFFFFFFF,
2308             hit_next_index=0xFFFFFFFF,
2309             advance=0,
2310             action=0,
2311             metadata=0):
2312         """
2313         :param is_add:
2314         :param table_index:
2315         :param match:
2316         :param opaque_index:  (Default value = 0xFFFFFFFF)
2317         :param hit_next_index:  (Default value = 0xFFFFFFFF)
2318         :param advance:  (Default value = 0)
2319         :param action:  (Default value = 0)
2320         :param metadata:  (Default value = 0)
2321         """
2322
2323         match_len = ((len(match) - 1) / 16 + 1) * 16
2324         match = match + '\0' * (match_len - len(match))
2325         return self.api(
2326             self.papi.classify_add_del_session,
2327             {'is_add': is_add,
2328              'table_index': table_index,
2329              'hit_next_index': hit_next_index,
2330              'opaque_index': opaque_index,
2331              'advance': advance,
2332              'action': action,
2333              'metadata': metadata,
2334              'match_len': match_len,
2335              'match': match})
2336
2337     def input_acl_set_interface(
2338             self,
2339             is_add,
2340             sw_if_index,
2341             ip4_table_index=0xFFFFFFFF,
2342             ip6_table_index=0xFFFFFFFF,
2343             l2_table_index=0xFFFFFFFF):
2344         """
2345         :param is_add:
2346         :param sw_if_index:
2347         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
2348         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
2349         :param l2_table_index:  (Default value = 0xFFFFFFFF)
2350         """
2351
2352         return self.api(
2353             self.papi.input_acl_set_interface,
2354             {'sw_if_index': sw_if_index,
2355              'ip4_table_index': ip4_table_index,
2356              'ip6_table_index': ip6_table_index,
2357              'l2_table_index': l2_table_index,
2358              'is_add': is_add})
2359
2360     def output_acl_set_interface(
2361             self,
2362             is_add,
2363             sw_if_index,
2364             ip4_table_index=0xFFFFFFFF,
2365             ip6_table_index=0xFFFFFFFF,
2366             l2_table_index=0xFFFFFFFF):
2367         """
2368         :param is_add:
2369         :param sw_if_index:
2370         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
2371         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
2372         :param l2_table_index:  (Default value = 0xFFFFFFFF)
2373         """
2374
2375         return self.api(
2376             self.papi.output_acl_set_interface,
2377             {'sw_if_index': sw_if_index,
2378              'ip4_table_index': ip4_table_index,
2379              'ip6_table_index': ip6_table_index,
2380              'l2_table_index': l2_table_index,
2381              'is_add': is_add})
2382
2383     def set_ipfix_exporter(
2384             self,
2385             collector_address,
2386             src_address,
2387             path_mtu,
2388             template_interval,
2389             vrf_id=0,
2390             collector_port=4739,
2391             udp_checksum=0):
2392         return self.api(
2393             self.papi.set_ipfix_exporter,
2394             {
2395                 'collector_address': collector_address,
2396                 'collector_port': collector_port,
2397                 'src_address': src_address,
2398                 'vrf_id': vrf_id,
2399                 'path_mtu': path_mtu,
2400                 'template_interval': template_interval,
2401                 'udp_checksum': udp_checksum,
2402             })
2403
2404     def dhcp_proxy_config(self,
2405                           dhcp_server,
2406                           dhcp_src_address,
2407                           rx_table_id=0,
2408                           server_table_id=0,
2409                           is_add=1,
2410                           is_ipv6=0):
2411         return self.api(
2412             self.papi.dhcp_proxy_config,
2413             {
2414                 'rx_vrf_id': rx_table_id,
2415                 'server_vrf_id': server_table_id,
2416                 'is_ipv6': is_ipv6,
2417                 'is_add': is_add,
2418                 'dhcp_server': dhcp_server,
2419                 'dhcp_src_address': dhcp_src_address,
2420             })
2421
2422     def dhcp_proxy_set_vss(self,
2423                            table_id,
2424                            vss_type=255,
2425                            vpn_ascii_id="",
2426                            oui=0,
2427                            vpn_index=0,
2428                            is_add=1,
2429                            is_ip6=0):
2430         return self.api(
2431             self.papi.dhcp_proxy_set_vss,
2432             {
2433                 'tbl_id': table_id,
2434                 'vss_type': vss_type,
2435                 'vpn_ascii_id': vpn_ascii_id,
2436                 'oui': oui,
2437                 'vpn_index': vpn_index,
2438                 'is_add': is_add,
2439                 'is_ipv6': is_ip6,
2440             })
2441
2442     def dhcp_client_dump(self):
2443         return self.api(self.papi.dhcp_client_dump, {})
2444
2445     def dhcp_client(self,
2446                     sw_if_index,
2447                     hostname,
2448                     client_id='',
2449                     is_add=1,
2450                     set_broadcast_flag=1,
2451                     want_dhcp_events=0):
2452         return self.api(
2453             self.papi.dhcp_client_config,
2454             {
2455                 'is_add': is_add,
2456                 'client': {
2457                     'sw_if_index': sw_if_index,
2458                     'hostname': hostname,
2459                     'id': client_id,
2460                     'want_dhcp_event': want_dhcp_events,
2461                     'set_broadcast_flag': set_broadcast_flag,
2462                     'pid': os.getpid()}
2463             })
2464
2465     def ip_mroute_add_del(self,
2466                           src_address,
2467                           grp_address,
2468                           grp_address_length,
2469                           e_flags,
2470                           next_hop_afi,
2471                           next_hop_sw_if_index,
2472                           next_hop_address,
2473                           i_flags,
2474                           bier_imp=0,
2475                           rpf_id=0,
2476                           table_id=0,
2477                           is_add=1,
2478                           is_ipv6=0,
2479                           is_local=0):
2480         """
2481         IP Multicast Route add/del
2482         """
2483         return self.api(
2484             self.papi.ip_mroute_add_del,
2485             {'next_hop_sw_if_index': next_hop_sw_if_index,
2486              'entry_flags': e_flags,
2487              'itf_flags': i_flags,
2488              'table_id': table_id,
2489              'rpf_id': rpf_id,
2490              'is_add': is_add,
2491              'is_ipv6': is_ipv6,
2492              'is_local': is_local,
2493              'bier_imp': bier_imp,
2494              'next_hop_afi': next_hop_afi,
2495              'grp_address_length': grp_address_length,
2496              'grp_address': grp_address,
2497              'src_address': src_address,
2498              'nh_address': next_hop_address})
2499
2500     def mfib_signal_dump(self):
2501         return self.api(self.papi.mfib_signal_dump, {})
2502
2503     def ip_mfib_dump(self):
2504         return self.api(self.papi.ip_mfib_dump, {})
2505
2506     def ip6_mfib_dump(self):
2507         return self.api(self.papi.ip6_mfib_dump, {})
2508
2509     def lisp_enable_disable(self, is_enabled):
2510         return self.api(
2511             self.papi.lisp_enable_disable,
2512             {
2513                 'is_en': is_enabled,
2514             })
2515
2516     def lisp_locator_set(self,
2517                          ls_name,
2518                          is_add=1):
2519         return self.api(
2520             self.papi.lisp_add_del_locator_set,
2521             {
2522                 'is_add': is_add,
2523                 'locator_set_name': ls_name
2524             })
2525
2526     def lisp_locator_set_dump(self):
2527         return self.api(self.papi.lisp_locator_set_dump, {})
2528
2529     def lisp_locator(self,
2530                      ls_name,
2531                      sw_if_index,
2532                      priority=1,
2533                      weight=1,
2534                      is_add=1):
2535         return self.api(
2536             self.papi.lisp_add_del_locator,
2537             {
2538                 'is_add': is_add,
2539                 'locator_set_name': ls_name,
2540                 'sw_if_index': sw_if_index,
2541                 'priority': priority,
2542                 'weight': weight
2543             })
2544
2545     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2546         return self.api(
2547             self.papi.lisp_locator_dump,
2548             {
2549                 'is_index_set': is_index_set,
2550                 'ls_name': ls_name,
2551                 'ls_index': ls_index,
2552             })
2553
2554     def lisp_local_mapping(self,
2555                            ls_name,
2556                            eid_type,
2557                            eid,
2558                            prefix_len,
2559                            vni=0,
2560                            key_id=0,
2561                            key="",
2562                            is_add=1):
2563         return self.api(
2564             self.papi.lisp_add_del_local_eid,
2565             {
2566                 'locator_set_name': ls_name,
2567                 'is_add': is_add,
2568                 'eid_type': eid_type,
2569                 'eid': eid,
2570                 'prefix_len': prefix_len,
2571                 'vni': vni,
2572                 'key_id': key_id,
2573                 'key': key
2574             })
2575
2576     def lisp_eid_table_dump(self,
2577                             eid_set=0,
2578                             prefix_length=0,
2579                             vni=0,
2580                             eid_type=0,
2581                             eid=None,
2582                             filter_opt=0):
2583         return self.api(
2584             self.papi.lisp_eid_table_dump,
2585             {
2586                 'eid_set': eid_set,
2587                 'prefix_length': prefix_length,
2588                 'vni': vni,
2589                 'eid_type': eid_type,
2590                 'eid': eid,
2591                 'filter': filter_opt,
2592             })
2593
2594     def lisp_remote_mapping(self,
2595                             eid_type,
2596                             eid,
2597                             eid_prefix_len=0,
2598                             vni=0,
2599                             rlocs=[],
2600                             rlocs_num=0,
2601                             is_src_dst=0,
2602                             is_add=1):
2603         return self.api(
2604             self.papi.lisp_add_del_remote_mapping,
2605             {
2606                 'is_add': is_add,
2607                 'eid_type': eid_type,
2608                 'eid': eid,
2609                 'eid_len': eid_prefix_len,
2610                 'rloc_num': rlocs_num,
2611                 'rlocs': rlocs,
2612                 'vni': vni,
2613                 'is_src_dst': is_src_dst,
2614             })
2615
2616     def lisp_adjacency(self,
2617                        leid,
2618                        reid,
2619                        leid_len,
2620                        reid_len,
2621                        eid_type,
2622                        is_add=1,
2623                        vni=0):
2624         return self.api(
2625             self.papi.lisp_add_del_adjacency,
2626             {
2627                 'is_add': is_add,
2628                 'vni': vni,
2629                 'eid_type': eid_type,
2630                 'leid': leid,
2631                 'reid': reid,
2632                 'leid_len': leid_len,
2633                 'reid_len': reid_len,
2634             })
2635
2636     def lisp_adjacencies_get(self, vni=0):
2637         return self.api(
2638             self.papi.lisp_adjacencies_get,
2639             {
2640                 'vni': vni
2641             })
2642
2643     def map_add_domain(self,
2644                        ip6_prefix,
2645                        ip6_prefix_len,
2646                        ip6_src,
2647                        ip6_src_prefix_len,
2648                        ip4_prefix,
2649                        ip4_prefix_len,
2650                        ea_bits_len=0,
2651                        psid_offset=0,
2652                        psid_length=0,
2653                        is_translation=0,
2654                        is_rfc6052=0,
2655                        mtu=1280):
2656         return self.api(
2657             self.papi.map_add_domain,
2658             {
2659                 'ip6_prefix': ip6_prefix,
2660                 'ip6_prefix_len': ip6_prefix_len,
2661                 'ip4_prefix': ip4_prefix,
2662                 'ip4_prefix_len': ip4_prefix_len,
2663                 'ip6_src': ip6_src,
2664                 'ip6_src_prefix_len': ip6_src_prefix_len,
2665                 'ea_bits_len': ea_bits_len,
2666                 'psid_offset': psid_offset,
2667                 'psid_length': psid_length,
2668                 'is_translation': is_translation,
2669                 'is_rfc6052': is_rfc6052,
2670                 'mtu': mtu
2671             })
2672
2673     def gtpu_add_del_tunnel(
2674             self,
2675             src_addr,
2676             dst_addr,
2677             is_add=1,
2678             is_ipv6=0,
2679             mcast_sw_if_index=0xFFFFFFFF,
2680             encap_vrf_id=0,
2681             decap_next_index=0xFFFFFFFF,
2682             teid=0):
2683         """
2684
2685         :param is_add:  (Default value = 1)
2686         :param is_ipv6:  (Default value = 0)
2687         :param src_addr:
2688         :param dst_addr:
2689         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2690         :param encap_vrf_id:  (Default value = 0)
2691         :param decap_next_index:  (Default value = 0xFFFFFFFF)
2692         :param teid:  (Default value = 0)
2693
2694         """
2695         return self.api(self.papi.gtpu_add_del_tunnel,
2696                         {'is_add': is_add,
2697                          'is_ipv6': is_ipv6,
2698                          'src_address': src_addr,
2699                          'dst_address': dst_addr,
2700                          'mcast_sw_if_index': mcast_sw_if_index,
2701                          'encap_vrf_id': encap_vrf_id,
2702                          'decap_next_index': decap_next_index,
2703                          'teid': teid})
2704
2705     def vxlan_gpe_add_del_tunnel(
2706             self,
2707             src_addr,
2708             dst_addr,
2709             mcast_sw_if_index=0xFFFFFFFF,
2710             is_add=1,
2711             is_ipv6=0,
2712             encap_vrf_id=0,
2713             decap_vrf_id=0,
2714             protocol=3,
2715             vni=0):
2716         """
2717
2718         :param local:
2719         :param remote:
2720         :param is_add:  (Default value = 1)
2721         :param is_ipv6:  (Default value = 0)
2722         :param encap_vrf_id:  (Default value = 0)
2723         :param decap_vrf_id:  (Default value = 0)
2724         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2725         :param protocol:  (Default value = 3)
2726         :param vni:  (Default value = 0)
2727
2728         """
2729         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2730                         {'is_add': is_add,
2731                          'is_ipv6': is_ipv6,
2732                          'local': src_addr,
2733                          'remote': dst_addr,
2734                          'mcast_sw_if_index': mcast_sw_if_index,
2735                          'encap_vrf_id': encap_vrf_id,
2736                          'decap_vrf_id': decap_vrf_id,
2737                          'protocol': protocol,
2738                          'vni': vni})
2739
2740     def vxlan_gbp_tunnel_add_del(
2741             self,
2742             src,
2743             dst,
2744             mcast_sw_if_index=0xFFFFFFFF,
2745             is_add=1,
2746             is_ipv6=0,
2747             encap_table_id=0,
2748             decap_next_index=0xFFFFFFFF,
2749             vni=0,
2750             instance=0xFFFFFFFF):
2751         """
2752
2753         :param dst_addr:
2754         :param src_addr:
2755         :param is_add:  (Default value = 1)
2756         :param is_ipv6:  (Default value = 0)
2757         :param encap_table_id:  (Default value = 0)
2758         :param decap_next_index:  (Default value = 0xFFFFFFFF)
2759         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2760         :param vni:  (Default value = 0)
2761         :param instance:  (Default value = 0xFFFFFFFF)
2762
2763         """
2764         return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2765                         {'is_add': is_add,
2766                          'tunnel': {
2767                              'src': src,
2768                              'dst': dst,
2769                              'mcast_sw_if_index': mcast_sw_if_index,
2770                              'encap_table_id': encap_table_id,
2771                              'decap_next_index': decap_next_index,
2772                              'vni': vni,
2773                              'instance': instance}})
2774
2775     def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2776         return self.api(self.papi.vxlan_gbp_tunnel_dump,
2777                         {'sw_if_index': sw_if_index})
2778
2779     def pppoe_add_del_session(
2780             self,
2781             client_ip,
2782             client_mac,
2783             session_id=0,
2784             is_add=1,
2785             is_ipv6=0,
2786             decap_vrf_id=0):
2787         """
2788
2789         :param is_add:  (Default value = 1)
2790         :param is_ipv6:  (Default value = 0)
2791         :param client_ip:
2792         :param session_id:  (Default value = 0)
2793         :param client_mac:
2794         :param decap_vrf_id:  (Default value = 0)
2795
2796         """
2797         return self.api(self.papi.pppoe_add_del_session,
2798                         {'is_add': is_add,
2799                          'is_ipv6': is_ipv6,
2800                          'session_id': session_id,
2801                          'client_ip': client_ip,
2802                          'decap_vrf_id': decap_vrf_id,
2803                          'client_mac': client_mac})
2804
2805     def sr_mpls_policy_add(self, bsid, weight, type, segments):
2806         return self.api(self.papi.sr_mpls_policy_add,
2807                         {'bsid': bsid,
2808                          'weight': weight,
2809                          'type': type,
2810                          'n_segments': len(segments),
2811                          'segments': segments})
2812
2813     def sr_mpls_policy_del(self, bsid):
2814         return self.api(self.papi.sr_mpls_policy_del,
2815                         {'bsid': bsid})
2816
2817     def sr_localsid_add_del(self,
2818                             localsid,
2819                             behavior,
2820                             nh_addr4,
2821                             nh_addr6,
2822                             is_del=0,
2823                             end_psp=0,
2824                             sw_if_index=0xFFFFFFFF,
2825                             vlan_index=0,
2826                             fib_table=0,
2827                             ):
2828         """ Add/del IPv6 SR local-SID.
2829
2830         :param localsid:
2831         :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2832         :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2833         :param nh_addr4:
2834         :param nh_addr6:
2835         :param is_del:  (Default value = 0)
2836         :param end_psp: (Default value = 0)
2837         :param sw_if_index: (Default value = 0xFFFFFFFF)
2838         :param vlan_index:  (Default value = 0)
2839         :param fib_table:   (Default value = 0)
2840         """
2841         return self.api(
2842             self.papi.sr_localsid_add_del,
2843             {'is_del': is_del,
2844              'localsid': localsid,
2845              'end_psp': end_psp,
2846              'behavior': behavior,
2847              'sw_if_index': sw_if_index,
2848              'vlan_index': vlan_index,
2849              'fib_table': fib_table,
2850              'nh_addr4': nh_addr4,
2851              'nh_addr6': nh_addr6
2852              }
2853         )
2854
2855     def sr_policy_add(
2856             self,
2857             bsid_addr,
2858             weight=1,
2859             is_encap=1,
2860             type=0,
2861             fib_table=0,
2862             n_segments=0,
2863             segments=[]):
2864         """
2865         :param bsid_addr: bindingSID of the SR Policy
2866         :param weight: weight of the sid list. optional. (default: 1)
2867         :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2868             (default: Encap)
2869         :param type: type/behavior of the SR policy. (default or spray) \
2870             (default: default)
2871         :param fib_table: VRF where to install the FIB entry for the BSID \
2872             (default: 0)
2873         :param n_segments: number of segments \
2874             (default: 0)
2875         :param segments: a vector of IPv6 address composing the segment list \
2876             (default: [])
2877         """
2878         return self.api(
2879             self.papi.sr_policy_add,
2880             {'bsid_addr': bsid_addr,
2881              'weight': weight,
2882              'is_encap': is_encap,
2883              'type': type,
2884              'fib_table': fib_table,
2885              'n_segments': n_segments,
2886              'segments': segments
2887              }
2888         )
2889
2890     def sr_policy_del(
2891             self,
2892             bsid_addr,
2893             sr_policy_index=0):
2894         """
2895         :param bsid: bindingSID of the SR Policy
2896         :param sr_policy_index: index of the sr policy (default: 0)
2897         """
2898         return self.api(
2899             self.papi.sr_policy_del,
2900             {'bsid_addr': bsid_addr,
2901              'sr_policy_index': sr_policy_index
2902              })
2903
2904     def sr_steering_add_del(
2905             self,
2906             is_del,
2907             bsid_addr,
2908             sr_policy_index,
2909             table_id,
2910             prefix_addr,
2911             mask_width,
2912             sw_if_index,
2913             traffic_type):
2914         """
2915         Steer traffic L2 and L3 traffic through a given SR policy
2916
2917         :param is_del: delete or add
2918         :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2919         :param sr_policy: is the index of the SR Policy (alt to bsid)
2920         :param table_id: is the VRF where to install the FIB entry for the BSID
2921         :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2922         :param mask_width: is the mask for L3 traffic type
2923         :param sw_if_index: is the incoming interface for L2 traffic
2924         :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2925         """
2926         return self.api(
2927             self.papi.sr_steering_add_del,
2928             {'is_del': is_del,
2929              'bsid_addr': bsid_addr,
2930              'sr_policy_index': sr_policy_index,
2931              'table_id': table_id,
2932              'prefix_addr': prefix_addr,
2933              'mask_width': mask_width,
2934              'sw_if_index': sw_if_index,
2935              'traffic_type': traffic_type
2936              })
2937
2938     def acl_add_replace(self, acl_index, r, tag='',
2939                         expected_retval=0):
2940         """Add/replace an ACL
2941         :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2942         :param acl_rule r: ACL rules array.
2943         :param str tag: symbolic tag (description) for this ACL.
2944         :param int count: number of rules.
2945         """
2946         return self.api(self.papi.acl_add_replace,
2947                         {'acl_index': acl_index,
2948                          'r': r,
2949                          'count': len(r),
2950                          'tag': tag},
2951                         expected_retval=expected_retval)
2952
2953     def acl_del(self, acl_index, expected_retval=0):
2954         """
2955
2956         :param acl_index:
2957         :return:
2958         """
2959         return self.api(self.papi.acl_del,
2960                         {'acl_index': acl_index},
2961                         expected_retval=expected_retval)
2962
2963     def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2964                                    expected_retval=0):
2965         return self.api(self.papi.acl_interface_set_acl_list,
2966                         {'sw_if_index': sw_if_index,
2967                          'count': len(acls),
2968                          'n_input': n_input,
2969                          'acls': acls},
2970                         expected_retval=expected_retval)
2971
2972     def acl_interface_set_etype_whitelist(self, sw_if_index,
2973                                           n_input, whitelist,
2974                                           expected_retval=0):
2975         return self.api(self.papi.acl_interface_set_etype_whitelist,
2976                         {'sw_if_index': sw_if_index,
2977                          'count': len(whitelist),
2978                          'n_input': n_input,
2979                          'whitelist': whitelist},
2980                         expected_retval=expected_retval)
2981
2982     def acl_interface_add_del(self,
2983                               sw_if_index,
2984                               acl_index,
2985                               is_add=1):
2986         """ Add/Delete ACL to/from interface
2987
2988         :param sw_if_index:
2989         :param acl_index:
2990         :param is_add:  (Default value = 1)
2991         """
2992
2993         return self.api(self.papi.acl_interface_add_del,
2994                         {'is_add': is_add,
2995                          'is_input': 1,
2996                          'sw_if_index': sw_if_index,
2997                          'acl_index': acl_index})
2998
2999     def acl_dump(self, acl_index, expected_retval=0):
3000         return self.api(self.papi.acl_dump,
3001                         {'acl_index': acl_index},
3002                         expected_retval=expected_retval)
3003
3004     def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3005                                 expected_retval=0):
3006         return self.api(self.papi.acl_interface_list_dump,
3007                         {'sw_if_index': sw_if_index},
3008                         expected_retval=expected_retval)
3009
3010     def macip_acl_add(self, rules, tag=""):
3011         """ Add MACIP acl
3012
3013         :param rules: list of rules for given acl
3014         :param tag: acl tag
3015         """
3016
3017         return self.api(self.papi.macip_acl_add,
3018                         {'r': rules,
3019                          'count': len(rules),
3020                          'tag': tag})
3021
3022     def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3023         """ Add MACIP acl
3024
3025         :param rules: list of rules for given acl
3026         :param tag: acl tag
3027         """
3028
3029         return self.api(self.papi.macip_acl_add_replace,
3030                         {'acl_index': acl_index,
3031                          'r': rules,
3032                          'count': len(rules),
3033                          'tag': tag})
3034
3035     def macip_acl_del(self, acl_index):
3036         """
3037
3038         :param acl_index:
3039         :return:
3040         """
3041         return self.api(self.papi.macip_acl_del,
3042                         {'acl_index': acl_index})
3043
3044     def macip_acl_interface_add_del(self,
3045                                     sw_if_index,
3046                                     acl_index,
3047                                     is_add=1):
3048         """ Add MACIP acl to interface
3049
3050         :param sw_if_index:
3051         :param acl_index:
3052         :param is_add:  (Default value = 1)
3053         """
3054
3055         return self.api(self.papi.macip_acl_interface_add_del,
3056                         {'is_add': is_add,
3057                          'sw_if_index': sw_if_index,
3058                          'acl_index': acl_index})
3059
3060     def macip_acl_interface_get(self):
3061         """ Return interface acls dump
3062         """
3063         return self.api(
3064             self.papi.macip_acl_interface_get, {})
3065
3066     def macip_acl_dump(self, acl_index=4294967295):
3067         """ Return MACIP acl dump
3068         """
3069
3070         return self.api(
3071             self.papi.macip_acl_dump, {'acl_index': acl_index})
3072
3073     def policer_add_del(self,
3074                         name,
3075                         cir,
3076                         eir,
3077                         cb,
3078                         eb,
3079                         is_add=1,
3080                         rate_type=0,
3081                         round_type=0,
3082                         ptype=0,
3083                         color_aware=0,
3084                         conform_action_type=1,
3085                         conform_dscp=0,
3086                         exceed_action_type=0,
3087                         exceed_dscp=0,
3088                         violate_action_type=0,
3089                         violate_dscp=0):
3090         return self.api(self.papi.policer_add_del,
3091                         {'name': name,
3092                          'cir': cir,
3093                          'eir': eir,
3094                          'cb': cb,
3095                          'eb': eb,
3096                          'is_add': is_add,
3097                          'rate_type': rate_type,
3098                          'round_type': round_type,
3099                          'type': ptype,
3100                          'color_aware': color_aware,
3101                          'conform_action_type': conform_action_type,
3102                          'conform_dscp': conform_dscp,
3103                          'exceed_action_type': exceed_action_type,
3104                          'exceed_dscp': exceed_dscp,
3105                          'violate_action_type': violate_action_type,
3106                          'violate_dscp': violate_dscp})
3107
3108     def ip_punt_police(self,
3109                        policer_index,
3110                        is_ip6=0,
3111                        is_add=1):
3112         return self.api(self.papi.ip_punt_police,
3113                         {'policer_index': policer_index,
3114                          'is_add': is_add,
3115                          'is_ip6': is_ip6})
3116
3117     def ip_punt_redirect(self,
3118                          rx_sw_if_index,
3119                          tx_sw_if_index,
3120                          nh,
3121                          is_ip6=0,
3122                          is_add=1):
3123         return self.api(self.papi.ip_punt_redirect,
3124                         {'rx_sw_if_index': rx_sw_if_index,
3125                          'tx_sw_if_index': tx_sw_if_index,
3126                          'nh': nh,
3127                          'is_add': is_add,
3128                          'is_ip6': is_ip6})
3129
3130     def bier_table_add_del(self,
3131                            bti,
3132                            mpls_label,
3133                            is_add=1):
3134         """ BIER Table add/del """
3135         return self.api(
3136             self.papi.bier_table_add_del,
3137             {'bt_tbl_id': {"bt_set": bti.set_id,
3138                            "bt_sub_domain": bti.sub_domain_id,
3139                            "bt_hdr_len_id": bti.hdr_len_id},
3140              'bt_label': mpls_label,
3141              'bt_is_add': is_add})
3142
3143     def bier_table_dump(self):
3144         return self.api(self.papi.bier_table_dump, {})
3145
3146     def bier_route_add_del(self,
3147                            bti,
3148                            bp,
3149                            paths,
3150                            is_add=1,
3151                            is_replace=0):
3152         """ BIER Route add/del """
3153         return self.api(
3154             self.papi.bier_route_add_del,
3155             {'br_tbl_id': {"bt_set": bti.set_id,
3156                            "bt_sub_domain": bti.sub_domain_id,
3157                            "bt_hdr_len_id": bti.hdr_len_id},
3158              'br_bp': bp,
3159              'br_n_paths': len(paths),
3160              'br_paths': paths,
3161              'br_is_add': is_add,
3162              'br_is_replace': is_replace})
3163
3164     def bier_route_dump(self, bti):
3165         return self.api(
3166             self.papi.bier_route_dump,
3167             {'br_tbl_id': {"bt_set": bti.set_id,
3168                            "bt_sub_domain": bti.sub_domain_id,
3169                            "bt_hdr_len_id": bti.hdr_len_id}})
3170
3171     def bier_imp_add(self,
3172                      bti,
3173                      src,
3174                      ibytes,
3175                      is_add=1):
3176         """ BIER Imposition Add """
3177         return self.api(
3178             self.papi.bier_imp_add,
3179             {'bi_tbl_id': {"bt_set": bti.set_id,
3180                            "bt_sub_domain": bti.sub_domain_id,
3181                            "bt_hdr_len_id": bti.hdr_len_id},
3182              'bi_src': src,
3183              'bi_n_bytes': len(ibytes),
3184              'bi_bytes': ibytes})
3185
3186     def bier_imp_del(self, bi_index):
3187         """ BIER Imposition del """
3188         return self.api(
3189             self.papi.bier_imp_del,
3190             {'bi_index': bi_index})
3191
3192     def bier_imp_dump(self):
3193         return self.api(self.papi.bier_imp_dump, {})
3194
3195     def bier_disp_table_add_del(self,
3196                                 bdti,
3197                                 is_add=1):
3198         """ BIER Disposition Table add/del """
3199         return self.api(
3200             self.papi.bier_disp_table_add_del,
3201             {'bdt_tbl_id': bdti,
3202              'bdt_is_add': is_add})
3203
3204     def bier_disp_table_dump(self):
3205         return self.api(self.papi.bier_disp_table_dump, {})
3206
3207     def bier_disp_entry_add_del(self,
3208                                 bdti,
3209                                 bp,
3210                                 payload_proto,
3211                                 next_hop_afi,
3212                                 next_hop,
3213                                 next_hop_tbl_id=0,
3214                                 next_hop_rpf_id=~0,
3215                                 next_hop_is_ip4=1,
3216                                 is_add=1):
3217         """ BIER Route add/del """
3218         lstack = []
3219         while (len(lstack) < 16):
3220             lstack.append({})
3221         return self.api(
3222             self.papi.bier_disp_entry_add_del,
3223             {'bde_tbl_id': bdti,
3224              'bde_bp': bp,
3225              'bde_payload_proto': payload_proto,
3226              'bde_n_paths': 1,
3227              'bde_paths': [{'next_hop': next_hop,
3228                             'table_id': next_hop_tbl_id,
3229                             'afi': next_hop_afi,
3230                             'rpf_id': next_hop_rpf_id,
3231                             'n_labels': 0,
3232                             'label_stack': lstack}],
3233              'bde_is_add': is_add})
3234
3235     def bier_disp_entry_dump(self, bdti):
3236         return self.api(
3237             self.papi.bier_disp_entry_dump,
3238             {'bde_tbl_id': bdti})
3239
3240     def add_node_next(self, node_name, next_name):
3241         """ Set the next node for a given node request
3242
3243         :param node_name:
3244         :param next_name:
3245         """
3246         return self.api(self.papi.add_node_next,
3247                         {'node_name': node_name,
3248                          'next_name': next_name})
3249
3250     def session_enable_disable(self, is_enabled):
3251         return self.api(
3252             self.papi.session_enable_disable,
3253             {'is_enable': is_enabled})
3254
3255     def ipsec_spd_add_del(self, spd_id, is_add=1):
3256         """ SPD add/del - Wrapper to add or del ipsec SPD
3257         Sample CLI : 'ipsec spd add 1'
3258
3259         :param spd_id - SPD ID to be created in the vpp . mandatory
3260         :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3261               optional
3262         :returns: reply from the API
3263         """
3264         return self.api(
3265             self.papi.ipsec_spd_add_del, {
3266                 'spd_id': spd_id, 'is_add': is_add})
3267
3268     def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3269         """ IPSEC interface SPD add/del - \
3270              Wrapper to associate/disassociate SPD to interface in VPP
3271         Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3272
3273         :param spd_id - SPD ID to associate with the interface . mandatory
3274         :param sw_if_index - Interface Index which needs to ipsec \
3275             association mandatory
3276         :param is_add - add(1) or del(0) association with interface \
3277                 (Default 1 - add) . optional
3278         :returns: reply from the API
3279         """
3280         return self.api(
3281             self.papi.ipsec_interface_add_del_spd,
3282             {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3283
3284     def ipsec_sad_add_del_entry(self,
3285                                 sad_id,
3286                                 spi,
3287                                 integrity_algorithm,
3288                                 integrity_key,
3289                                 crypto_algorithm,
3290                                 crypto_key,
3291                                 protocol,
3292                                 tunnel_src_address='',
3293                                 tunnel_dst_address='',
3294                                 is_tunnel=1,
3295                                 is_add=1,
3296                                 udp_encap=0):
3297         """ IPSEC SA add/del
3298         :param sad_id: security association ID
3299         :param spi: security param index of the SA in decimal
3300         :param integrity_algorithm:
3301         :param integrity_key:
3302         :param crypto_algorithm:
3303         :param crypto_key:
3304         :param protocol: AH(0) or ESP(1) protocol
3305         :param tunnel_src_address: tunnel mode outer src address
3306         :param tunnel_dst_address: tunnel mode outer dst address
3307         :param is_add:
3308         :param is_tunnel:
3309         :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3310              crypto and ipsec algorithms
3311         """
3312         return self.api(
3313             self.papi.ipsec_sad_add_del_entry,
3314             {'sad_id': sad_id,
3315              'spi': spi,
3316              'tunnel_src_address': tunnel_src_address,
3317              'tunnel_dst_address': tunnel_dst_address,
3318              'protocol': protocol,
3319              'integrity_algorithm': integrity_algorithm,
3320              'integrity_key_length': len(integrity_key),
3321              'integrity_key': integrity_key,
3322              'crypto_algorithm': crypto_algorithm,
3323              'crypto_key_length': len(crypto_key) if crypto_key is not None
3324              else 0,
3325              'crypto_key': crypto_key,
3326              'is_add': is_add,
3327              'is_tunnel': is_tunnel,
3328              'udp_encap': udp_encap})
3329
3330     def ipsec_spd_add_del_entry(self,
3331                                 spd_id,
3332                                 sa_id,
3333                                 local_address_start,
3334                                 local_address_stop,
3335                                 remote_address_start,
3336                                 remote_address_stop,
3337                                 local_port_start=0,
3338                                 local_port_stop=65535,
3339                                 remote_port_start=0,
3340                                 remote_port_stop=65535,
3341                                 protocol=0,
3342                                 policy=0,
3343                                 priority=100,
3344                                 is_outbound=1,
3345                                 is_add=1,
3346                                 is_ip_any=0):
3347         """ IPSEC policy SPD add/del   -
3348                     Wrapper to configure ipsec SPD policy entries in VPP
3349         :param spd_id: SPD ID for the policy
3350         :param local_address_start: local-ip-range start address
3351         :param local_address_stop : local-ip-range stop address
3352         :param remote_address_start: remote-ip-range start address
3353         :param remote_address_stop : remote-ip-range stop address
3354         :param local_port_start: (Default value = 0)
3355         :param local_port_stop: (Default value = 65535)
3356         :param remote_port_start: (Default value = 0)
3357         :param remote_port_stop: (Default value = 65535)
3358         :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3359         :param sa_id: Security Association ID for mapping it to SPD
3360         :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3361                (Default value = 0)
3362         :param priority: value for the spd action (Default value = 100)
3363         :param is_outbound: flag for inbound(0) or outbound(1)
3364                (Default value = 1)
3365         :param is_add: (Default value = 1)
3366         """
3367         return self.api(
3368             self.papi.ipsec_spd_add_del_entry,
3369             {'spd_id': spd_id,
3370              'sa_id': sa_id,
3371              'local_address_start': local_address_start,
3372              'local_address_stop': local_address_stop,
3373              'remote_address_start': remote_address_start,
3374              'remote_address_stop': remote_address_stop,
3375              'local_port_start': local_port_start,
3376              'local_port_stop': local_port_stop,
3377              'remote_port_start': remote_port_start,
3378              'remote_port_stop': remote_port_stop,
3379              'is_add': is_add,
3380              'protocol': protocol,
3381              'policy': policy,
3382              'priority': priority,
3383              'is_outbound': is_outbound,
3384              'is_ip_any': is_ip_any})
3385
3386     def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3387                                 remote_spi, crypto_alg, local_crypto_key,
3388                                 remote_crypto_key, integ_alg, local_integ_key,
3389                                 remote_integ_key, is_add=1, esn=0,
3390                                 anti_replay=1, renumber=0, show_instance=0):
3391         return self.api(
3392             self.papi.ipsec_tunnel_if_add_del,
3393             {'local_ip': local_ip, 'remote_ip': remote_ip,
3394              'local_spi': local_spi, 'remote_spi': remote_spi,
3395              'crypto_alg': crypto_alg,
3396              'local_crypto_key_len': len(local_crypto_key),
3397              'local_crypto_key': local_crypto_key,
3398              'remote_crypto_key_len': len(remote_crypto_key),
3399              'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3400              'local_integ_key_len': len(local_integ_key),
3401              'local_integ_key': local_integ_key,
3402              'remote_integ_key_len': len(remote_integ_key),
3403              'remote_integ_key': remote_integ_key, 'is_add': is_add,
3404              'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3405              'show_instance': show_instance
3406              })
3407
3408     def app_namespace_add(self,
3409                           namespace_id,
3410                           ip4_fib_id=0,
3411                           ip6_fib_id=0,
3412                           sw_if_index=0xFFFFFFFF,
3413                           secret=0):
3414         return self.api(
3415             self.papi.app_namespace_add_del,
3416             {'secret': secret,
3417              'sw_if_index': sw_if_index,
3418              'ip4_fib_id': ip4_fib_id,
3419              'ip6_fib_id': ip6_fib_id,
3420              'namespace_id': namespace_id,
3421              'namespace_id_len': len(namespace_id)})
3422
3423     def punt_socket_register(self, l4_port, pathname, header_version=1,
3424                              is_ip4=1, l4_protocol=0x11):
3425         """ Punt to socket """
3426         return self.api(self.papi.punt_socket_register,
3427                         {'is_ip4': is_ip4,
3428                          'l4_protocol': l4_protocol,
3429                          'l4_port': l4_port,
3430                          'pathname': pathname,
3431                          'header_version': header_version})
3432
3433     def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3434                           expire_walk_interval_ms, is_ip6=0):
3435         """ Set IP reassembly parameters """
3436         return self.api(self.papi.ip_reassembly_set,
3437                         {'is_ip6': is_ip6,
3438                          'timeout_ms': timeout_ms,
3439                          'expire_walk_interval_ms': expire_walk_interval_ms,
3440                          'max_reassemblies': max_reassemblies})
3441
3442     def ip_reassembly_get(self, is_ip6=0):
3443         """ Get IP reassembly parameters """
3444         return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3445
3446     def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3447                                      enable_ip6=False):
3448         """ Enable/disable IP reassembly """
3449         return self.api(self.papi.ip_reassembly_enable_disable,
3450                         {'sw_if_index': sw_if_index,
3451                          'enable_ip4': 1 if enable_ip4 else 0,
3452                          'enable_ip6': 1 if enable_ip6 else 0,
3453                          })
3454
3455     def gbp_endpoint_add(self, sw_if_index, ips, mac, epg):
3456         """ GBP endpoint Add """
3457         return self.api(self.papi.gbp_endpoint_add,
3458                         {'endpoint': {
3459                             'sw_if_index': sw_if_index,
3460                             'ips': ips,
3461                             'n_ips': len(ips),
3462                             'mac': mac,
3463                             'epg_id': epg}})
3464
3465     def gbp_endpoint_del(self, handle):
3466         """ GBP endpoint Del """
3467         return self.api(self.papi.gbp_endpoint_del,
3468                         {'handle': handle})
3469
3470     def gbp_endpoint_dump(self):
3471         """ GBP endpoint Dump """
3472         return self.api(self.papi.gbp_endpoint_dump, {})
3473
3474     def gbp_endpoint_group_add_del(self, is_add, epg, bd,
3475                                    ip4_rd,
3476                                    ip6_rd,
3477                                    uplink_sw_if_index):
3478         """ GBP endpoint group Add/Del """
3479         return self.api(self.papi.gbp_endpoint_group_add_del,
3480                         {'is_add': is_add,
3481                          'epg': {
3482                              'uplink_sw_if_index': uplink_sw_if_index,
3483                              'bd_id': bd,
3484                              'ip4_table_id': ip4_rd,
3485                              'ip6_table_id': ip6_rd,
3486                              'epg_id': epg}})
3487
3488     def gbp_endpoint_group_dump(self):
3489         """ GBP endpoint group Dump """
3490         return self.api(self.papi.gbp_endpoint_group_dump, {})
3491
3492     def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3493         """ GBP recirc Add/Del """
3494         return self.api(self.papi.gbp_recirc_add_del,
3495                         {'is_add': is_add,
3496                          'recirc': {
3497                              'is_ext': is_ext,
3498                              'sw_if_index': sw_if_index,
3499                              'epg_id': epg}})
3500
3501     def gbp_recirc_dump(self):
3502         """ GBP recirc Dump """
3503         return self.api(self.papi.gbp_recirc_dump, {})
3504
3505     def gbp_subnet_add_del(self, is_add, table_id,
3506                            is_internal,
3507                            prefix,
3508                            sw_if_index=0xffffffff,
3509                            epg_id=0xffff,
3510                            is_ip6=False):
3511         """ GBP Subnet Add/Del """
3512         return self.api(self.papi.gbp_subnet_add_del,
3513                         {'is_add': is_add,
3514                          'subnet': {
3515                              'is_internal': is_internal,
3516                              'is_ip6': is_ip6,
3517                              'sw_if_index': sw_if_index,
3518                              'epg_id': epg_id,
3519                              'prefix': prefix,
3520                              'table_id': table_id}})
3521
3522     def gbp_subnet_dump(self):
3523         """ GBP Subnet Dump """
3524         return self.api(self.papi.gbp_subnet_dump, {})
3525
3526     def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
3527         """ GBP contract Add/Del """
3528         return self.api(self.papi.gbp_contract_add_del,
3529                         {'is_add': is_add,
3530                          'contract': {
3531                              'acl_index': acl_index,
3532                              'src_epg': src_epg,
3533                              'dst_epg': dst_epg}})
3534
3535     def gbp_contract_dump(self):
3536         """ GBP contract Dump """
3537         return self.api(self.papi.gbp_contract_dump, {})
3538
3539     def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3540                             ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3541                             security_check):
3542         """ 6RD tunnel Add """
3543         return self.api(self.papi.ipip_6rd_add_tunnel,
3544                         {'ip4_table_id': ip4_table_id,
3545                          'ip6_table_id': ip6_table_id,
3546                          'ip6_prefix': ip6_prefix,
3547                          'ip6_prefix_len': ip6_prefix_len,
3548                          'ip4_prefix': ip4_prefix,
3549                          'ip4_prefix_len': ip4_prefix_len,
3550                          'ip4_src': ip4_src,
3551                          'security_check': security_check})
3552
3553     def ipip_6rd_del_tunnel(self, sw_if_index):
3554         """ 6RD tunnel Delete """
3555         return self.api(self.papi.ipip_6rd_del_tunnel,
3556                         {'sw_if_index': sw_if_index})
3557
3558     def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3559                         instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3560         """ IPIP tunnel Add/Del """
3561         return self.api(self.papi.ipip_add_tunnel,
3562                         {'is_ipv6': is_ipv6,
3563                          'instance': instance,
3564                          'src_address': src_address,
3565                          'dst_address': dst_address,
3566                          'table_id': table_id,
3567                          'tc_tos': tc_tos})
3568
3569     def ipip_del_tunnel(self, sw_if_index):
3570         """ IPIP tunnel Delete """
3571         return self.api(self.papi.ipip_del_tunnel,
3572                         {'sw_if_index': sw_if_index})
3573
3574     def qos_egress_map_update(self, id, outputs):
3575         """ QOS egress map update """
3576         return self.api(self.papi.qos_egress_map_update,
3577                         {'map_id': id,
3578                          'rows': outputs})
3579
3580     def qos_egress_map_delete(self, id):
3581         """ QOS egress map delete """
3582         return self.api(self.papi.qos_egress_map_delete,
3583                         {'map_id': id})
3584
3585     def qos_mark_enable_disable(self, sw_if_index,
3586                                 output_source,
3587                                 map_id,
3588                                 enable):
3589         """ QOS Mark Enable/Disable """
3590         return self.api(self.papi.qos_mark_enable_disable,
3591                         {'map_id': map_id,
3592                          'sw_if_index': sw_if_index,
3593                          'output_source': output_source,
3594                          'enable': enable})
3595
3596     def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3597         """ IP QoS recording Enble/Disable """
3598         return self.api(self.papi.qos_record_enable_disable,
3599                         {'sw_if_index': sw_if_index,
3600                          'input_source': input_source,
3601                          'enable': enable})
3602
3603     def igmp_enable_disable(self, sw_if_index, enable, host):
3604         """ Enable/disable IGMP on a given interface """
3605         return self.api(self.papi.igmp_enable_disable,
3606                         {'enable': enable,
3607                          'mode': host,
3608                          'sw_if_index': sw_if_index})
3609
3610     def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3611         """ Listen for new (S,G) on specified interface
3612
3613         :param enable: add/del
3614         :param sw_if_index: interface sw index
3615         :param saddr: source ip4 addr
3616         :param gaddr: group ip4 addr
3617         """
3618         return self.api(self.papi.igmp_listen,
3619                         {
3620                             'group':
3621                             {
3622                                 'filter': filter,
3623                                 'sw_if_index': sw_if_index,
3624                                 'n_srcs': len(saddrs),
3625                                 'saddrs': saddrs,
3626                                 'gaddr':
3627                                 {
3628                                     'address': gaddr
3629                                 }
3630                             }
3631                         })
3632
3633     def igmp_dump(self, sw_if_index=None):
3634         """ Dump all (S,G) interface configurations """
3635         if sw_if_index is None:
3636             sw_if_index = 0xffffffff
3637         return self.api(self.papi.igmp_dump,
3638                         {'sw_if_index': sw_if_index})
3639
3640     def igmp_clear_interface(self, sw_if_index):
3641         """ Remove all (S,G)s from specified interface
3642             doesn't send IGMP report!
3643         """
3644         return self.api(
3645             self.papi.igmp_clear_interface, {
3646                 'sw_if_index': sw_if_index})
3647
3648     def want_igmp_events(self, enable=1):
3649         return self.api(self.papi.want_igmp_events, {'enable': enable,
3650                                                      'pid': os.getpid()})
3651
3652     def bond_create(
3653             self,
3654             mode,
3655             lb,
3656             use_custom_mac,
3657             mac_address=''):
3658         """
3659         :param mode: mode
3660         :param lb: load balance
3661         :param use_custom_mac: use custom mac
3662         :param mac_address: mac address
3663         """
3664         return self.api(
3665             self.papi.bond_create,
3666             {'mode': mode,
3667              'lb': lb,
3668              'use_custom_mac': use_custom_mac,
3669              'mac_address': mac_address
3670              })
3671
3672     def bond_delete(
3673             self,
3674             sw_if_index):
3675         """
3676         :param sw_if_index: interface the operation is applied to
3677         """
3678         return self.api(self.papi.bond_delete,
3679                         {'sw_if_index': sw_if_index})
3680
3681     def bond_enslave(
3682             self,
3683             sw_if_index,
3684             bond_sw_if_index,
3685             is_passive,
3686             is_long_timeout):
3687         """
3688         :param sw_if_index: slave sw_if_index
3689         :param bond_sw_if_index: bond sw_if_index
3690         :param is_passive: is passive lacp speaker
3691         :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3692         """
3693         return self.api(
3694             self.papi.bond_enslave,
3695             {'sw_if_index': sw_if_index,
3696              'bond_sw_if_index': bond_sw_if_index,
3697              'is_passive': is_passive,
3698              'is_long_timeout': is_long_timeout
3699              })
3700
3701     def bond_detach_slave(
3702             self,
3703             sw_if_index):
3704         """
3705         :param sw_if_index: slave interface the operation is applied to
3706         """
3707         return self.api(self.papi.bond_detach_slave,
3708                         {'sw_if_index': sw_if_index})
3709
3710     def sw_interface_slave_dump(
3711             self,
3712             sw_if_index):
3713         """
3714         :param sw_if_index: bond sw_if_index
3715         """
3716         return self.api(self.papi.sw_interface_slave_dump,
3717                         {'sw_if_index': sw_if_index})
3718
3719     def sw_interface_bond_dump(
3720             self):
3721         """
3722
3723         """
3724         return self.api(self.papi.sw_interface_bond_dump,
3725                         {})
3726
3727     def create_vhost_user_if(
3728             self,
3729             is_server,
3730             sock_filename,
3731             renumber,
3732             disable_mrg_rxbuf,
3733             disable_indirect_desc,
3734             custom_dev_instance,
3735             use_custom_mac,
3736             mac_address,
3737             tag=''):
3738         """
3739         :param is_server: is server
3740         :param sock_filename: socket name
3741         :param renumber: renumber
3742         :param disable_mrg_rxbuf: disable mergable rx buffers
3743         :param disable_indirect_desc: disable indirect descriptors
3744         :param custom_dev_instance: custom dev instance
3745         :param use_custom_mac: use custom mac
3746         :param mac_address: mac address
3747         :param tag: tag (default '')
3748         """
3749         return self.api(
3750             self.papi.create_vhost_user_if,
3751             {'is_server': is_server,
3752              'sock_filename': sock_filename,
3753              'renumber': renumber,
3754              'disable_mrg_rxbuf': disable_mrg_rxbuf,
3755              'disable_indirect_desc': disable_indirect_desc,
3756              'custom_dev_instance': custom_dev_instance,
3757              'use_custom_mac': use_custom_mac,
3758              'mac_address': mac_address,
3759              'tag': tag
3760              })
3761
3762     def delete_vhost_user_if(
3763             self,
3764             sw_if_index):
3765         """
3766         :param sw_if_index: interface the operation is applied to
3767         """
3768         return self.api(self.papi.delete_vhost_user_if,
3769                         {'sw_if_index': sw_if_index, })
3770
3771     def sw_interface_vhost_user_dump(
3772             self):
3773         """
3774
3775         """
3776         return self.api(self.papi.sw_interface_vhost_user_dump,
3777                         {})
3778
3779     def abf_policy_add_del(self, is_add, policy):
3780         return self.api(
3781             self.papi.abf_policy_add_del,
3782             {'is_add': is_add,
3783              'policy': policy})
3784
3785     def abf_itf_attach_add_del(self, is_add, attach):
3786         return self.api(
3787             self.papi.abf_itf_attach_add_del,
3788             {'is_add': is_add,
3789              'attach': attach})
3790
3791     def abf_policy_dump(self):
3792         return self.api(
3793             self.papi.abf_policy_dump, {})
3794
3795     def abf_itf_attach_dump(self):
3796         return self.api(
3797             self.papi.abf_itf_attach_dump, {})
3798
3799     def pipe_create(self, is_specified, user_instance):
3800         return self.api(self.papi.pipe_create,
3801                         {'is_specified': is_specified,
3802                          'user_instance': user_instance})
3803
3804     def pipe_delete(self, parent_sw_if_index):
3805         return self.api(self.papi.pipe_delete,
3806                         {'parent_sw_if_index': parent_sw_if_index})
3807
3808     def pipe_dump(self):
3809         return self.api(self.papi.pipe_dump, {})