test/vpp_papi_provider.py

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