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