test/vpp_papi_provider.py

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