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 mac.replace(':', '').decode('hex')
 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             next_hop_id=0xFFFFFFFF,
 739             is_resolve_host=0,
 740             is_resolve_attached=0,
 741             classify_table_index=0xFFFFFFFF,
 742             is_add=1,
 743             is_drop=0,
 744             is_unreach=0,
 745             is_prohibit=0,
 746             is_ipv6=0,
 747             is_local=0,
 748             is_classify=0,
 749             is_multipath=0,
 750             is_l2_bridged=0,
 751             is_udp_encap=0,
 752             is_source_lookup=0):
 753         """
 754
 755         :param dst_address_length:
 756         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 757         :param dst_address:
 758         :param next_hop_address:
 759         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 760         :param vrf_id:  (Default value = 0)
 761         :param lookup_in_vrf:  (Default value = 0)
 762         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 763         :param is_add:  (Default value = 1)
 764         :param is_drop:  (Default value = 0)
 765         :param is_ipv6:  (Default value = 0)
 766         :param is_local:  (Default value = 0)
 767         :param is_classify:  (Default value = 0)
 768         :param is_multipath:  (Default value = 0)
 769         :param is_resolve_host:  (Default value = 0)
 770         :param is_resolve_attached:  (Default value = 0)
 771         :param is_l2_bridged:  (Default value = 0)
 772         :param is_source_lookup:  (Default value = 0)
 773         :param next_hop_weight:  (Default value = 1)
 774
 775         """
 776
 777         return self.api(
 778             self.papi.ip_add_del_route,
 779             {'next_hop_sw_if_index': next_hop_sw_if_index,
 780              'table_id': table_id,
 781              'classify_table_index': classify_table_index,
 782              'next_hop_table_id': next_hop_table_id,
 783              'is_add': is_add,
 784              'is_drop': is_drop,
 785              'is_unreach': is_unreach,
 786              'is_prohibit': is_prohibit,
 787              'is_ipv6': is_ipv6,
 788              'is_local': is_local,
 789              'is_classify': is_classify,
 790              'is_multipath': is_multipath,
 791              'is_resolve_host': is_resolve_host,
 792              'is_resolve_attached': is_resolve_attached,
 793              'is_l2_bridged': is_l2_bridged,
 794              'is_source_lookup': is_source_lookup,
 795              'is_udp_encap': is_udp_encap,
 796              'next_hop_weight': next_hop_weight,
 797              'dst_address_length': dst_address_length,
 798              'dst_address': dst_address,
 799              'next_hop_id': next_hop_id,
 800              'next_hop_address': next_hop_address,
 801              'next_hop_n_out_labels': next_hop_n_out_labels,
 802              'next_hop_via_label': next_hop_via_label,
 803              'next_hop_out_label_stack': next_hop_out_label_stack})
 804
 805     def ip_fib_dump(self):
 806         return self.api(self.papi.ip_fib_dump, {})
 807
 808     def ip6_fib_dump(self):
 809         return self.api(self.papi.ip6_fib_dump, {})
 810
 811     def ip_neighbor_add_del(self,
 812                             sw_if_index,
 813                             mac_address,
 814                             dst_address,
 815                             is_add=1,
 816                             is_ipv6=0,
 817                             is_static=0,
 818                             is_no_adj_fib=0,
 819                             ):
 820         """ Add neighbor MAC to IPv4 or IPv6 address.
 821
 822         :param sw_if_index:
 823         :param mac_address:
 824         :param dst_address:
 825         :param is_add:  (Default value = 1)
 826         :param is_ipv6:  (Default value = 0)
 827         :param is_static:  (Default value = 0)
 828         :param is_no_adj_fib:  (Default value = 0)
 829         """
 830
 831         return self.api(
 832             self.papi.ip_neighbor_add_del,
 833             {'sw_if_index': sw_if_index,
 834              'is_add': is_add,
 835              'is_ipv6': is_ipv6,
 836              'is_static': is_static,
 837              'is_no_adj_fib': is_no_adj_fib,
 838              'mac_address': mac_address,
 839              'dst_address': dst_address
 840              }
 841         )
 842
 843     def ip_neighbor_dump(self,
 844                          sw_if_index,
 845                          is_ipv6=0):
 846         """ Return IP neighbor dump.
 847
 848         :param sw_if_index:
 849         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 850         """
 851
 852         return self.api(
 853             self.papi.ip_neighbor_dump,
 854             {'is_ipv6': is_ipv6,
 855              'sw_if_index': sw_if_index
 856              }
 857         )
 858
 859     def proxy_arp_add_del(self,
 860                           low_address,
 861                           hi_address,
 862                           vrf_id=0,
 863                           is_add=1):
 864         """ Config Proxy Arp Range.
 865
 866         :param low_address: Start address in the rnage to Proxy for
 867         :param hi_address: End address in the rnage to Proxy for
 868         :param vrf_id: The VRF/table in which to proxy
 869         """
 870
 871         return self.api(
 872             self.papi.proxy_arp_add_del,
 873             {'vrf_id': vrf_id,
 874              'is_add': is_add,
 875              'low_address': low_address,
 876              'hi_address': hi_address,
 877              }
 878         )
 879
 880     def proxy_arp_intfc_enable_disable(self,
 881                                        sw_if_index,
 882                                        is_enable=1):
 883         """ Enable/Disable an interface for proxy ARP requests
 884
 885         :param sw_if_index: Interface
 886         :param enable_disable: Enable/Disable
 887         """
 888
 889         return self.api(
 890             self.papi.proxy_arp_intfc_enable_disable,
 891             {'sw_if_index': sw_if_index,
 892              'enable_disable': is_enable
 893              }
 894         )
 895
 896     def reset_vrf(self,
 897                   vrf_id,
 898                   is_ipv6=0,
 899                   ):
 900         """ Reset VRF (remove all routes etc.) request.
 901
 902         :param int vrf_id: ID of the FIB table / VRF to reset.
 903         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 904         """
 905
 906         return self.api(
 907             self.papi.reset_vrf,
 908             {'vrf_id': vrf_id,
 909              'is_ipv6': is_ipv6,
 910              }
 911         )
 912
 913     def reset_fib(self,
 914                   vrf_id,
 915                   is_ipv6=0,
 916                   ):
 917         """ Reset VRF (remove all routes etc.) request.
 918
 919         :param int vrf_id: ID of the FIB table / VRF to reset.
 920         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 921         """
 922
 923         return self.api(
 924             self.papi.reset_fib,
 925             {'vrf_id': vrf_id,
 926              'is_ipv6': is_ipv6,
 927              }
 928         )
 929
 930     def ip_dump(self,
 931                 is_ipv6=0,
 932                 ):
 933         """ Return IP dump.
 934
 935         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 936         """
 937
 938         return self.api(
 939             self.papi.ip_dump,
 940             {'is_ipv6': is_ipv6,
 941              }
 942         )
 943
 944     def sw_interface_span_enable_disable(
 945             self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
 946         """
 947
 948         :param sw_if_index_from:
 949         :param sw_if_index_to:
 950         :param state:
 951         :param is_l2:
 952         """
 953         return self.api(self.papi.sw_interface_span_enable_disable,
 954                         {'sw_if_index_from': sw_if_index_from,
 955                          'sw_if_index_to': sw_if_index_to,
 956                          'state': state,
 957                          'is_l2': is_l2,
 958                          })
 959
 960     def gre_tunnel_add_del(self,
 961                            src_address,
 962                            dst_address,
 963                            outer_fib_id=0,
 964                            is_teb=0,
 965                            is_add=1,
 966                            is_ip6=0):
 967         """ Add a GRE tunnel
 968
 969         :param src_address:
 970         :param dst_address:
 971         :param outer_fib_id:  (Default value = 0)
 972         :param is_add:  (Default value = 1)
 973         :param is_ipv6:  (Default value = 0)
 974         :param is_teb:  (Default value = 0)
 975         """
 976
 977         return self.api(
 978             self.papi.gre_add_del_tunnel,
 979             {'is_add': is_add,
 980              'is_ipv6': is_ip6,
 981              'teb': is_teb,
 982              'src_address': src_address,
 983              'dst_address': dst_address,
 984              'outer_fib_id': outer_fib_id}
 985         )
 986
 987     def udp_encap_add_del(self,
 988                           id,
 989                           src_ip,
 990                           dst_ip,
 991                           src_port,
 992                           dst_port,
 993                           table_id=0,
 994                           is_add=1,
 995                           is_ip6=0):
 996         """ Add a GRE tunnel
 997         :param id: user provided ID
 998         :param src_ip:
 999         :param dst_ip:
1000         :param src_port:
1001         :param dst_port:
1002         :param outer_fib_id:  (Default value = 0)
1003         :param is_add:  (Default value = 1)
1004         :param is_ipv6:  (Default value = 0)
1005         """
1006
1007         return self.api(
1008             self.papi.udp_encap_add_del,
1009             {'id': id,
1010              'is_add': is_add,
1011              'is_ip6': is_ip6,
1012              'src_ip': src_ip,
1013              'dst_ip': dst_ip,
1014              'src_port': src_port,
1015              'dst_port': dst_port,
1016              'table_id': table_id}
1017         )
1018
1019     def udp_encap_dump(self):
1020         return self.api(self.papi.udp_encap_dump, {})
1021
1022     def mpls_fib_dump(self):
1023         return self.api(self.papi.mpls_fib_dump, {})
1024
1025     def mpls_table_add_del(
1026             self,
1027             table_id,
1028             is_add=1):
1029         """
1030
1031         :param table_id
1032         :param is_add:  (Default value = 1)
1033
1034         """
1035
1036         return self.api(
1037             self.papi.mpls_table_add_del,
1038             {'mt_table_id': table_id,
1039              'mt_is_add': is_add})
1040
1041     def mpls_route_add_del(
1042             self,
1043             label,
1044             eos,
1045             next_hop_proto,
1046             next_hop_address,
1047             next_hop_sw_if_index=0xFFFFFFFF,
1048             table_id=0,
1049             next_hop_table_id=0,
1050             next_hop_weight=1,
1051             next_hop_n_out_labels=0,
1052             next_hop_out_label_stack=[],
1053             next_hop_via_label=MPLS_LABEL_INVALID,
1054             is_resolve_host=0,
1055             is_resolve_attached=0,
1056             is_interface_rx=0,
1057             is_rpf_id=0,
1058             is_multicast=0,
1059             is_add=1,
1060             is_drop=0,
1061             is_multipath=0,
1062             classify_table_index=0xFFFFFFFF,
1063             is_classify=0):
1064         """
1065
1066         :param dst_address_length:
1067         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1068         :param dst_address:
1069         :param next_hop_address:
1070         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1071         :param vrf_id:  (Default value = 0)
1072         :param lookup_in_vrf:  (Default value = 0)
1073         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1074         :param is_add:  (Default value = 1)
1075         :param is_drop:  (Default value = 0)
1076         :param is_ipv6:  (Default value = 0)
1077         :param is_local:  (Default value = 0)
1078         :param is_classify:  (Default value = 0)
1079         :param is_multipath:  (Default value = 0)
1080         :param is_multicast:  (Default value = 0)
1081         :param is_resolve_host:  (Default value = 0)
1082         :param is_resolve_attached:  (Default value = 0)
1083         :param next_hop_weight:  (Default value = 1)
1084
1085         """
1086
1087         return self.api(
1088             self.papi.mpls_route_add_del,
1089             {'mr_label': label,
1090              'mr_eos': eos,
1091              'mr_table_id': table_id,
1092              'mr_classify_table_index': classify_table_index,
1093              'mr_is_add': is_add,
1094              'mr_is_classify': is_classify,
1095              'mr_is_multipath': is_multipath,
1096              'mr_is_multicast': is_multicast,
1097              'mr_is_resolve_host': is_resolve_host,
1098              'mr_is_resolve_attached': is_resolve_attached,
1099              'mr_is_interface_rx': is_interface_rx,
1100              'mr_is_rpf_id': is_rpf_id,
1101              'mr_next_hop_proto': next_hop_proto,
1102              'mr_next_hop_weight': next_hop_weight,
1103              'mr_next_hop': next_hop_address,
1104              'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1105              'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1106              'mr_next_hop_table_id': next_hop_table_id,
1107              'mr_next_hop_via_label': next_hop_via_label,
1108              'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1109
1110     def mpls_ip_bind_unbind(
1111             self,
1112             label,
1113             dst_address,
1114             dst_address_length,
1115             table_id=0,
1116             ip_table_id=0,
1117             is_ip4=1,
1118             is_bind=1):
1119         """
1120         """
1121         return self.api(
1122             self.papi.mpls_ip_bind_unbind,
1123             {'mb_mpls_table_id': table_id,
1124              'mb_label': label,
1125              'mb_ip_table_id': ip_table_id,
1126              'mb_is_bind': is_bind,
1127              'mb_is_ip4': is_ip4,
1128              'mb_address_length': dst_address_length,
1129              'mb_address': dst_address})
1130
1131     def mpls_tunnel_add_del(
1132             self,
1133             tun_sw_if_index,
1134             next_hop_proto_is_ip4,
1135             next_hop_address,
1136             next_hop_sw_if_index=0xFFFFFFFF,
1137             next_hop_table_id=0,
1138             next_hop_weight=1,
1139             next_hop_n_out_labels=0,
1140             next_hop_out_label_stack=[],
1141             next_hop_via_label=MPLS_LABEL_INVALID,
1142             is_add=1,
1143             l2_only=0,
1144             is_multicast=0):
1145         """
1146
1147         :param dst_address_length:
1148         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1149         :param dst_address:
1150         :param next_hop_address:
1151         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1152         :param vrf_id:  (Default value = 0)
1153         :param lookup_in_vrf:  (Default value = 0)
1154         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1155         :param is_add:  (Default value = 1)
1156         :param is_drop:  (Default value = 0)
1157         :param is_ipv6:  (Default value = 0)
1158         :param is_local:  (Default value = 0)
1159         :param is_classify:  (Default value = 0)
1160         :param is_multipath:  (Default value = 0)
1161         :param is_resolve_host:  (Default value = 0)
1162         :param is_resolve_attached:  (Default value = 0)
1163         :param next_hop_weight:  (Default value = 1)
1164         :param is_multicast:  (Default value = 0)
1165
1166         """
1167         return self.api(
1168             self.papi.mpls_tunnel_add_del,
1169             {'mt_sw_if_index': tun_sw_if_index,
1170              'mt_is_add': is_add,
1171              'mt_l2_only': l2_only,
1172              'mt_is_multicast': is_multicast,
1173              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1174              'mt_next_hop_weight': next_hop_weight,
1175              'mt_next_hop': next_hop_address,
1176              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1177              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1178              'mt_next_hop_table_id': next_hop_table_id,
1179              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1180
1181     def nat44_interface_add_del_feature(
1182             self,
1183             sw_if_index,
1184             is_inside=1,
1185             is_add=1):
1186         """Enable/disable NAT44 feature on the interface
1187
1188         :param sw_if_index: Software index of the interface
1189         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1190         :param is_add: 1 if add, 0 if delete (Default value = 1)
1191         """
1192         return self.api(
1193             self.papi.nat44_interface_add_del_feature,
1194             {'is_add': is_add,
1195              'is_inside': is_inside,
1196              'sw_if_index': sw_if_index})
1197
1198     def nat44_interface_add_del_output_feature(
1199             self,
1200             sw_if_index,
1201             is_inside=1,
1202             is_add=1):
1203         """Enable/disable NAT44 output feature on the interface
1204
1205         :param sw_if_index: Software index of the interface
1206         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1207         :param is_add: 1 if add, 0 if delete (Default value = 1)
1208         """
1209         return self.api(
1210             self.papi.nat44_interface_add_del_output_feature,
1211             {'is_add': is_add,
1212              'is_inside': is_inside,
1213              'sw_if_index': sw_if_index})
1214
1215     def nat44_add_del_static_mapping(
1216             self,
1217             local_ip,
1218             external_ip=0,
1219             external_sw_if_index=0xFFFFFFFF,
1220             local_port=0,
1221             external_port=0,
1222             addr_only=1,
1223             vrf_id=0,
1224             protocol=0,
1225             is_add=1):
1226         """Add/delete NAT44 static mapping
1227
1228         :param local_ip: Local IP address
1229         :param external_ip: External IP address
1230         :param external_sw_if_index: External interface instead of IP address
1231         :param local_port: Local port number (Default value = 0)
1232         :param external_port: External port number (Default value = 0)
1233         :param addr_only: 1 if address only mapping, 0 if address and port
1234         :param vrf_id: VRF ID
1235         :param protocol: IP protocol (Default value = 0)
1236         :param is_add: 1 if add, 0 if delete (Default value = 1)
1237         """
1238         return self.api(
1239             self.papi.nat44_add_del_static_mapping,
1240             {'is_add': is_add,
1241              'addr_only': addr_only,
1242              'local_ip_address': local_ip,
1243              'external_ip_address': external_ip,
1244              'local_port': local_port,
1245              'external_port': external_port,
1246              'external_sw_if_index': external_sw_if_index,
1247              'vrf_id': vrf_id,
1248              'protocol': protocol})
1249
1250     def nat44_add_del_address_range(
1251             self,
1252             first_ip_address,
1253             last_ip_address,
1254             is_add=1,
1255             vrf_id=0xFFFFFFFF):
1256         """Add/del NAT44 address range
1257
1258         :param first_ip_address: First IP address
1259         :param last_ip_address: Last IP address
1260         :param vrf_id: VRF id for the address range
1261         :param is_add: 1 if add, 0 if delete (Default value = 1)
1262         """
1263         return self.api(
1264             self.papi.nat44_add_del_address_range,
1265             {'first_ip_address': first_ip_address,
1266              'last_ip_address': last_ip_address,
1267              'vrf_id': vrf_id,
1268              'is_add': is_add})
1269
1270     def nat44_address_dump(self):
1271         """Dump NAT44 addresses
1272         :return: Dictionary of NAT44 addresses
1273         """
1274         return self.api(self.papi.nat44_address_dump, {})
1275
1276     def nat44_interface_dump(self):
1277         """Dump interfaces with NAT44 feature
1278         :return: Dictionary of interfaces with NAT44 feature
1279         """
1280         return self.api(self.papi.nat44_interface_dump, {})
1281
1282     def nat44_interface_output_feature_dump(self):
1283         """Dump interfaces with NAT44 output feature
1284         :return: Dictionary of interfaces with NAT44 output feature
1285         """
1286         return self.api(self.papi.nat44_interface_output_feature_dump, {})
1287
1288     def nat44_static_mapping_dump(self):
1289         """Dump NAT44 static mappings
1290         :return: Dictionary of NAT44 static mappings
1291         """
1292         return self.api(self.papi.nat44_static_mapping_dump, {})
1293
1294     def nat_show_config(self):
1295         """Show NAT plugin config
1296         :return: NAT plugin config parameters
1297         """
1298         return self.api(self.papi.nat_show_config, {})
1299
1300     def nat44_add_interface_addr(
1301             self,
1302             sw_if_index,
1303             is_add=1):
1304         """Add/del NAT44 address from interface
1305
1306         :param sw_if_index: Software index of the interface
1307         :param is_add: 1 if add, 0 if delete (Default value = 1)
1308         """
1309         return self.api(self.papi.nat44_add_del_interface_addr,
1310                         {'is_add': is_add, 'sw_if_index': sw_if_index})
1311
1312     def nat44_interface_addr_dump(self):
1313         """Dump NAT44 addresses interfaces
1314         :return: Dictionary of NAT44 addresses interfaces
1315         """
1316         return self.api(self.papi.nat44_interface_addr_dump, {})
1317
1318     def nat_ipfix(
1319             self,
1320             domain_id=1,
1321             src_port=4739,
1322             enable=1):
1323         """Enable/disable NAT IPFIX logging
1324
1325         :param domain_id: Observation domain ID (Default value = 1)
1326         :param src_port: Source port number (Default value = 4739)
1327         :param enable: 1 if enable, 0 if disable (Default value = 1)
1328         """
1329         return self.api(
1330             self.papi.nat_ipfix_enable_disable,
1331             {'domain_id': domain_id,
1332              'src_port': src_port,
1333              'enable': enable})
1334
1335     def nat44_user_session_dump(
1336             self,
1337             ip_address,
1338             vrf_id):
1339         """Dump NAT44 user's sessions
1340
1341         :param ip_address: ip adress of the user to be dumped
1342         :param cpu_index: cpu_index on which the user is
1343         :param vrf_id: VRF ID
1344         :return: Dictionary of S-NAT sessions
1345         """
1346         return self.api(
1347             self.papi.nat44_user_session_dump,
1348             {'ip_address': ip_address,
1349              'vrf_id': vrf_id})
1350
1351     def nat44_user_dump(self):
1352         """Dump NAT44 users
1353
1354         :return: Dictionary of NAT44 users
1355         """
1356         return self.api(self.papi.nat44_user_dump, {})
1357
1358     def nat44_add_del_lb_static_mapping(
1359             self,
1360             external_addr,
1361             external_port,
1362             protocol,
1363             vrf_id=0,
1364             local_num=0,
1365             locals=[],
1366             is_add=1):
1367         """Add/delete NAT44 load balancing static mapping
1368
1369         :param is_add - 1 if add, 0 if delete
1370         """
1371         return self.api(
1372             self.papi.nat44_add_del_lb_static_mapping,
1373             {'is_add': is_add,
1374              'external_addr': external_addr,
1375              'external_port': external_port,
1376              'protocol': protocol,
1377              'vrf_id': vrf_id,
1378              'local_num': local_num,
1379              'locals': locals})
1380
1381     def nat44_lb_static_mapping_dump(self):
1382         """Dump NAT44 load balancing static mappings
1383
1384         :return: Dictionary of NAT44 load balancing static mapping
1385         """
1386         return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1387
1388     def nat44_del_session(
1389             self,
1390             addr,
1391             port,
1392             protocol,
1393             vrf_id=0,
1394             is_in=1):
1395         """Delete NAT44 session
1396
1397         :param addr: IPv4 address
1398         :param por: port number
1399         :param protocol: IP protocol number
1400         :param vrf_id: VRF ID
1401         :param is_in: 1 if inside network addres and port pari, 0 if outside
1402         """
1403         return self.api(
1404             self.papi.nat44_del_session,
1405             {'address': addr,
1406              'port': port,
1407              'protocol': protocol,
1408              'vrf_id': vrf_id,
1409              'is_in': is_in})
1410
1411     def nat_set_reass(
1412             self,
1413             timeout=2,
1414             max_reass=1024,
1415             max_frag=5,
1416             drop_frag=0,
1417             is_ip6=0):
1418         """Set NAT virtual fragmentation reassembly
1419
1420         :param timeout: reassembly timeout (Default 2sec)
1421         :param max_reass: maximum concurrent reassemblies (Default 1024)
1422         :param max_frag: maximum fragmets per reassembly (Default 5)
1423         :param drop_frag: if 0 translate fragments, otherwise drop fragments
1424         :param is_ip6: 1 if IPv6, 0 if IPv4
1425         """
1426         return self.api(
1427             self.papi.nat_set_reass,
1428             {'timeout': timeout,
1429              'max_reass': max_reass,
1430              'max_frag': max_frag,
1431              'drop_frag': drop_frag,
1432              'is_ip6': is_ip6})
1433
1434     def nat_get_reass(self):
1435         """Get NAT virtual fragmentation reassembly configuration
1436
1437         :return: NAT virtual fragmentation reassembly configuration
1438         """
1439         return self.api(self.papi.nat_get_reass, {})
1440
1441     def nat_reass_dump(self):
1442         """Dump NAT virtual fragmentation reassemblies
1443
1444         :return: Dictionary of NAT virtual fragmentation reassemblies
1445         """
1446         return self.api(self.papi.nat_reass_dump, {})
1447
1448     def nat_det_add_del_map(
1449             self,
1450             in_addr,
1451             in_plen,
1452             out_addr,
1453             out_plen,
1454             is_add=1):
1455         """Add/delete deterministic NAT mapping
1456
1457         :param is_add - 1 if add, 0 if delete
1458         :param in_addr - inside IP address
1459         :param in_plen - inside IP address prefix length
1460         :param out_addr - outside IP address
1461         :param out_plen - outside IP address prefix length
1462         """
1463         return self.api(
1464             self.papi.nat_det_add_del_map,
1465             {'is_add': is_add,
1466              'is_nat44': 1,
1467              'in_addr': in_addr,
1468              'in_plen': in_plen,
1469              'out_addr': out_addr,
1470              'out_plen': out_plen})
1471
1472     def nat_det_forward(
1473             self,
1474             in_addr):
1475         """Get outside address and port range from inside address
1476
1477         :param in_addr - inside IP address
1478         """
1479         return self.api(
1480             self.papi.nat_det_forward,
1481             {'in_addr': in_addr,
1482              'is_nat44': 1})
1483
1484     def nat_det_reverse(
1485             self,
1486             out_addr,
1487             out_port):
1488         """Get inside address from outside address and port
1489
1490         :param out_addr - outside IP address
1491         :param out_port - outside port
1492         """
1493         return self.api(
1494             self.papi.nat_det_reverse,
1495             {'out_addr': out_addr,
1496              'out_port': out_port})
1497
1498     def nat_det_map_dump(self):
1499         """Dump deterministic NAT mappings
1500
1501         :return: Dictionary of deterministic NAT mappings
1502         """
1503         return self.api(self.papi.nat_det_map_dump, {})
1504
1505     def nat_det_set_timeouts(
1506             self,
1507             udp=300,
1508             tcp_established=7440,
1509             tcp_transitory=240,
1510             icmp=60):
1511         """Set values of timeouts for deterministic NAT (in seconds)
1512
1513         :param udp - UDP timeout (Default value = 300)
1514         :param tcp_established - TCP established timeout (Default value = 7440)
1515         :param tcp_transitory - TCP transitory timeout (Default value = 240)
1516         :param icmp - ICMP timeout (Default value = 60)
1517         """
1518         return self.api(
1519             self.papi.nat_det_set_timeouts,
1520             {'udp': udp,
1521              'tcp_established': tcp_established,
1522              'tcp_transitory': tcp_transitory,
1523              'icmp': icmp})
1524
1525     def nat_det_get_timeouts(self):
1526         """Get values of timeouts for deterministic NAT
1527
1528         :return: Timeouts for deterministic NAT (in seconds)
1529         """
1530         return self.api(self.papi.nat_det_get_timeouts, {})
1531
1532     def nat_det_close_session_out(
1533             self,
1534             out_addr,
1535             out_port,
1536             ext_addr,
1537             ext_port):
1538         """Close deterministic NAT session using outside address and port
1539
1540         :param out_addr - outside IP address
1541         :param out_port - outside port
1542         :param ext_addr - external host IP address
1543         :param ext_port - external host port
1544         """
1545         return self.api(
1546             self.papi.nat_det_close_session_out,
1547             {'out_addr': out_addr,
1548              'out_port': out_port,
1549              'ext_addr': ext_addr,
1550              'ext_port': ext_port})
1551
1552     def nat_det_close_session_in(
1553             self,
1554             in_addr,
1555             in_port,
1556             ext_addr,
1557             ext_port):
1558         """Close deterministic NAT session using inside address and port
1559
1560         :param in_addr - inside IP address
1561         :param in_port - inside port
1562         :param ext_addr - external host IP address
1563         :param ext_port - external host port
1564         """
1565         return self.api(
1566             self.papi.nat_det_close_session_in,
1567             {'in_addr': in_addr,
1568              'in_port': in_port,
1569              'ext_addr': ext_addr,
1570              'ext_port': ext_port,
1571              'is_nat44': 1})
1572
1573     def nat_det_session_dump(
1574             self,
1575             user_addr):
1576         """Dump deterministic NAT sessions belonging to a user
1577
1578         :param user_addr - inside IP address of the user
1579         :return: Dictionary of deterministic NAT sessions
1580         """
1581         return self.api(
1582             self.papi.nat_det_session_dump,
1583             {'is_nat44': 1,
1584              'user_addr': user_addr})
1585
1586     def nat64_add_del_pool_addr_range(
1587             self,
1588             start_addr,
1589             end_addr,
1590             vrf_id=0xFFFFFFFF,
1591             is_add=1):
1592         """Add/del address range to NAT64 pool
1593
1594         :param start_addr: First IP address
1595         :param end_addr: Last IP address
1596         :param vrf_id: VRF id for the address range
1597         :param is_add: 1 if add, 0 if delete (Default value = 1)
1598         """
1599         return self.api(
1600             self.papi.nat64_add_del_pool_addr_range,
1601             {'start_addr': start_addr,
1602              'end_addr': end_addr,
1603              'vrf_id': vrf_id,
1604              'is_add': is_add})
1605
1606     def nat64_pool_addr_dump(self):
1607         """Dump NAT64 pool addresses
1608         :return: Dictionary of NAT64 pool addresses
1609         """
1610         return self.api(self.papi.nat64_pool_addr_dump, {})
1611
1612     def nat64_add_del_interface(
1613             self,
1614             sw_if_index,
1615             is_inside=1,
1616             is_add=1):
1617         """Enable/disable NAT64 feature on the interface
1618            :param sw_if_index: Index of the interface
1619            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1620            :param is_add: 1 if add, 0 if delete (Default value = 1)
1621         """
1622         return self.api(
1623             self.papi.nat64_add_del_interface,
1624             {'sw_if_index': sw_if_index,
1625              'is_inside': is_inside,
1626              'is_add': is_add})
1627
1628     def nat64_interface_dump(self):
1629         """Dump interfaces with NAT64 feature
1630         :return: Dictionary of interfaces with NAT64 feature
1631         """
1632         return self.api(self.papi.nat64_interface_dump, {})
1633
1634     def nat64_add_del_static_bib(
1635             self,
1636             in_ip,
1637             out_ip,
1638             in_port,
1639             out_port,
1640             protocol,
1641             vrf_id=0,
1642             is_add=1):
1643         """Add/delete S-NAT static BIB entry
1644
1645         :param in_ip: Inside IPv6 address
1646         :param out_ip: Outside IPv4 address
1647         :param in_port: Inside port number
1648         :param out_port: Outside port number
1649         :param protocol: IP protocol
1650         :param vrf_id: VRF ID (Default value = 0)
1651         :param is_add: 1 if add, 0 if delete (Default value = 1)
1652         """
1653         return self.api(
1654             self.papi.nat64_add_del_static_bib,
1655             {'i_addr': in_ip,
1656              'o_addr': out_ip,
1657              'i_port': in_port,
1658              'o_port': out_port,
1659              'vrf_id': vrf_id,
1660              'proto': protocol,
1661              'is_add': is_add})
1662
1663     def nat64_bib_dump(self, protocol=255):
1664         """Dump NAT64 BIB
1665
1666         :param protocol: IP protocol (Default value = 255, all BIBs)
1667         :returns: Dictionary of NAT64 BIB entries
1668         """
1669         return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1670
1671     def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1672                            tcp_incoming_syn=6):
1673         """Set values of timeouts for NAT64 (in seconds)
1674
1675         :param udpi: UDP timeout (Default value = 300)
1676         :param icmp: ICMP timeout (Default value = 60)
1677         :param tcp_trans: TCP transitory timeout (Default value = 240)
1678         :param tcp_est: TCP established timeout (Default value = 7440)
1679         :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1680         """
1681         return self.api(
1682             self.papi.nat64_set_timeouts,
1683             {'udp': udp,
1684              'icmp': icmp,
1685              'tcp_trans': tcp_trans,
1686              'tcp_est': tcp_est,
1687              'tcp_incoming_syn': tcp_incoming_syn})
1688
1689     def nat64_get_timeouts(self):
1690         """Get values of timeouts for NAT64
1691
1692         :return: Timeouts for NAT64 (in seconds)
1693         """
1694         return self.api(self.papi.nat64_get_timeouts, {})
1695
1696     def nat64_st_dump(self, protocol=255):
1697         """Dump NAT64 session table
1698
1699         :param protocol: IP protocol (Default value = 255, all STs)
1700         :returns: Dictionary of NAT64 sesstion table entries
1701         """
1702         return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1703
1704     def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1705         """Add/del NAT64 prefix
1706
1707         :param prefix: NAT64 prefix
1708         :param plen: NAT64 prefix length
1709         :param vrf_id: VRF id of tenant (Default 0)
1710         :param is_add: 1 if add, 0 if delete (Default value = 1)
1711         """
1712         return self.api(
1713             self.papi.nat64_add_del_prefix,
1714             {'prefix': prefix,
1715              'prefix_len': plen,
1716              'vrf_id': vrf_id,
1717              'is_add': is_add})
1718
1719     def nat64_prefix_dump(self):
1720         """Dump NAT64 prefix
1721
1722         :returns: Dictionary of NAT64 prefixes
1723         """
1724         return self.api(self.papi.nat64_prefix_dump, {})
1725
1726     def dslite_set_aftr_addr(self, ip6, ip4):
1727         """Set DS-Lite AFTR addresses
1728
1729         :param ip4: IPv4 address
1730         :param ip6: IPv6 address
1731         """
1732         return self.api(
1733             self.papi.dslite_set_aftr_addr,
1734             {'ip4_addr': ip4,
1735              'ip6_addr': ip6})
1736
1737     def dslite_add_del_pool_addr_range(
1738             self,
1739             start_addr,
1740             end_addr,
1741             is_add=1):
1742         """Add/del address range to DS-Lite pool
1743
1744         :param start_addr: First IP address
1745         :param end_addr: Last IP address
1746         :param is_add: 1 if add, 0 if delete (Default value = 1)
1747         """
1748         return self.api(
1749             self.papi.dslite_add_del_pool_addr_range,
1750             {'start_addr': start_addr,
1751              'end_addr': end_addr,
1752              'is_add': is_add})
1753
1754     def control_ping(self):
1755         self.api(self.papi.control_ping)
1756
1757     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1758                     detect_mult, local_addr, peer_addr, is_ipv6=0,
1759                     bfd_key_id=None, conf_key_id=None):
1760         if bfd_key_id is None:
1761             return self.api(self.papi.bfd_udp_add,
1762                             {
1763                                 'sw_if_index': sw_if_index,
1764                                 'desired_min_tx': desired_min_tx,
1765                                 'required_min_rx': required_min_rx,
1766                                 'local_addr': local_addr,
1767                                 'peer_addr': peer_addr,
1768                                 'is_ipv6': is_ipv6,
1769                                 'detect_mult': detect_mult,
1770                             })
1771         else:
1772             return self.api(self.papi.bfd_udp_add,
1773                             {
1774                                 'sw_if_index': sw_if_index,
1775                                 'desired_min_tx': desired_min_tx,
1776                                 'required_min_rx': required_min_rx,
1777                                 'local_addr': local_addr,
1778                                 'peer_addr': peer_addr,
1779                                 'is_ipv6': is_ipv6,
1780                                 'detect_mult': detect_mult,
1781                                 'is_authenticated': 1,
1782                                 'bfd_key_id': bfd_key_id,
1783                                 'conf_key_id': conf_key_id,
1784                             })
1785
1786     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1787                     detect_mult, local_addr, peer_addr, is_ipv6=0):
1788         return self.api(self.papi.bfd_udp_mod,
1789                         {
1790                             'sw_if_index': sw_if_index,
1791                             'desired_min_tx': desired_min_tx,
1792                             'required_min_rx': required_min_rx,
1793                             'local_addr': local_addr,
1794                             'peer_addr': peer_addr,
1795                             'is_ipv6': is_ipv6,
1796                             'detect_mult': detect_mult,
1797                         })
1798
1799     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1800                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1801                               is_delayed=False):
1802         return self.api(self.papi.bfd_udp_auth_activate,
1803                         {
1804                             'sw_if_index': sw_if_index,
1805                             'local_addr': local_addr,
1806                             'peer_addr': peer_addr,
1807                             'is_ipv6': is_ipv6,
1808                             'is_delayed': 1 if is_delayed else 0,
1809                             'bfd_key_id': bfd_key_id,
1810                             'conf_key_id': conf_key_id,
1811                         })
1812
1813     def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1814                                 is_ipv6=0, is_delayed=False):
1815         return self.api(self.papi.bfd_udp_auth_deactivate,
1816                         {
1817                             'sw_if_index': sw_if_index,
1818                             'local_addr': local_addr,
1819                             'peer_addr': peer_addr,
1820                             'is_ipv6': is_ipv6,
1821                             'is_delayed': 1 if is_delayed else 0,
1822                         })
1823
1824     def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1825         return self.api(self.papi.bfd_udp_del,
1826                         {
1827                             'sw_if_index': sw_if_index,
1828                             'local_addr': local_addr,
1829                             'peer_addr': peer_addr,
1830                             'is_ipv6': is_ipv6,
1831                         })
1832
1833     def bfd_udp_session_dump(self):
1834         return self.api(self.papi.bfd_udp_session_dump, {})
1835
1836     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1837                                   peer_addr, is_ipv6=0):
1838         return self.api(self.papi.bfd_udp_session_set_flags, {
1839             'admin_up_down': admin_up_down,
1840             'sw_if_index': sw_if_index,
1841             'local_addr': local_addr,
1842             'peer_addr': peer_addr,
1843             'is_ipv6': is_ipv6,
1844         })
1845
1846     def want_bfd_events(self, enable_disable=1):
1847         return self.api(self.papi.want_bfd_events, {
1848             'enable_disable': enable_disable,
1849             'pid': os.getpid(),
1850         })
1851
1852     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1853         return self.api(self.papi.bfd_auth_set_key, {
1854             'conf_key_id': conf_key_id,
1855             'auth_type': auth_type,
1856             'key': key,
1857             'key_len': len(key),
1858         })
1859
1860     def bfd_auth_del_key(self, conf_key_id):
1861         return self.api(self.papi.bfd_auth_del_key, {
1862             'conf_key_id': conf_key_id,
1863         })
1864
1865     def bfd_auth_keys_dump(self):
1866         return self.api(self.papi.bfd_auth_keys_dump, {})
1867
1868     def bfd_udp_set_echo_source(self, sw_if_index):
1869         return self.api(self.papi.bfd_udp_set_echo_source,
1870                         {'sw_if_index': sw_if_index})
1871
1872     def bfd_udp_del_echo_source(self):
1873         return self.api(self.papi.bfd_udp_del_echo_source, {})
1874
1875     def classify_add_del_table(
1876             self,
1877             is_add,
1878             mask,
1879             match_n_vectors=1,
1880             table_index=0xFFFFFFFF,
1881             nbuckets=2,
1882             memory_size=2097152,
1883             skip_n_vectors=0,
1884             next_table_index=0xFFFFFFFF,
1885             miss_next_index=0xFFFFFFFF,
1886             current_data_flag=0,
1887             current_data_offset=0):
1888         """
1889         :param is_add:
1890         :param mask:
1891         :param match_n_vectors: (Default value = 1)
1892         :param table_index: (Default value = 0xFFFFFFFF)
1893         :param nbuckets:  (Default value = 2)
1894         :param memory_size:  (Default value = 2097152)
1895         :param skip_n_vectors:  (Default value = 0)
1896         :param next_table_index:  (Default value = 0xFFFFFFFF)
1897         :param miss_next_index:  (Default value = 0xFFFFFFFF)
1898         :param current_data_flag:  (Default value = 0)
1899         :param current_data_offset:  (Default value = 0)
1900         """
1901
1902         return self.api(
1903             self.papi.classify_add_del_table,
1904             {'is_add': is_add,
1905              'table_index': table_index,
1906              'nbuckets': nbuckets,
1907              'memory_size': memory_size,
1908              'skip_n_vectors': skip_n_vectors,
1909              'match_n_vectors': match_n_vectors,
1910              'next_table_index': next_table_index,
1911              'miss_next_index': miss_next_index,
1912              'current_data_flag': current_data_flag,
1913              'current_data_offset': current_data_offset,
1914              'mask': mask})
1915
1916     def classify_add_del_session(
1917             self,
1918             is_add,
1919             table_index,
1920             match,
1921             opaque_index=0xFFFFFFFF,
1922             hit_next_index=0xFFFFFFFF,
1923             advance=0,
1924             action=0,
1925             metadata=0):
1926         """
1927         :param is_add:
1928         :param table_index:
1929         :param match:
1930         :param opaque_index:  (Default value = 0xFFFFFFFF)
1931         :param hit_next_index:  (Default value = 0xFFFFFFFF)
1932         :param advance:  (Default value = 0)
1933         :param action:  (Default value = 0)
1934         :param metadata:  (Default value = 0)
1935         """
1936
1937         return self.api(
1938             self.papi.classify_add_del_session,
1939             {'is_add': is_add,
1940              'table_index': table_index,
1941              'hit_next_index': hit_next_index,
1942              'opaque_index': opaque_index,
1943              'advance': advance,
1944              'action': action,
1945              'metadata': metadata,
1946              'match': match})
1947
1948     def input_acl_set_interface(
1949             self,
1950             is_add,
1951             sw_if_index,
1952             ip4_table_index=0xFFFFFFFF,
1953             ip6_table_index=0xFFFFFFFF,
1954             l2_table_index=0xFFFFFFFF):
1955         """
1956         :param is_add:
1957         :param sw_if_index:
1958         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
1959         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
1960         :param l2_table_index:  (Default value = 0xFFFFFFFF)
1961         """
1962
1963         return self.api(
1964             self.papi.input_acl_set_interface,
1965             {'sw_if_index': sw_if_index,
1966              'ip4_table_index': ip4_table_index,
1967              'ip6_table_index': ip6_table_index,
1968              'l2_table_index': l2_table_index,
1969              'is_add': is_add})
1970
1971     def set_ipfix_exporter(
1972             self,
1973             collector_address,
1974             src_address,
1975             path_mtu,
1976             template_interval,
1977             vrf_id=0,
1978             collector_port=4739,
1979             udp_checksum=0):
1980         return self.api(
1981             self.papi.set_ipfix_exporter,
1982             {
1983                 'collector_address': collector_address,
1984                 'collector_port': collector_port,
1985                 'src_address': src_address,
1986                 'vrf_id': vrf_id,
1987                 'path_mtu': path_mtu,
1988                 'template_interval': template_interval,
1989                 'udp_checksum': udp_checksum,
1990             })
1991
1992     def dhcp_proxy_config(self,
1993                           dhcp_server,
1994                           dhcp_src_address,
1995                           rx_table_id=0,
1996                           server_table_id=0,
1997                           is_add=1,
1998                           is_ipv6=0):
1999         return self.api(
2000             self.papi.dhcp_proxy_config,
2001             {
2002                 'rx_vrf_id': rx_table_id,
2003                 'server_vrf_id': server_table_id,
2004                 'is_ipv6': is_ipv6,
2005                 'is_add': is_add,
2006                 'dhcp_server': dhcp_server,
2007                 'dhcp_src_address': dhcp_src_address,
2008             })
2009
2010     def dhcp_proxy_set_vss(self,
2011                            table_id,
2012                            fib_id,
2013                            oui,
2014                            is_add=1,
2015                            is_ip6=0):
2016         return self.api(
2017             self.papi.dhcp_proxy_set_vss,
2018             {
2019                 'tbl_id': table_id,
2020                 'fib_id': fib_id,
2021                 'is_ipv6': is_ip6,
2022                 'is_add': is_add,
2023                 'oui': oui,
2024             })
2025
2026     def dhcp_client(self,
2027                     sw_if_index,
2028                     hostname,
2029                     client_id='',
2030                     is_add=1,
2031                     want_dhcp_events=0):
2032         return self.api(
2033             self.papi.dhcp_client_config,
2034             {
2035                 'sw_if_index': sw_if_index,
2036                 'hostname': hostname,
2037                 'client_id': client_id,
2038                 'is_add': is_add,
2039                 'want_dhcp_event': want_dhcp_events,
2040                 'pid': os.getpid(),
2041             })
2042
2043     def ip_mroute_add_del(self,
2044                           src_address,
2045                           grp_address,
2046                           grp_address_length,
2047                           e_flags,
2048                           next_hop_sw_if_index,
2049                           i_flags,
2050                           rpf_id=0,
2051                           table_id=0,
2052                           is_add=1,
2053                           is_ipv6=0,
2054                           is_local=0):
2055         """
2056         """
2057         return self.api(
2058             self.papi.ip_mroute_add_del,
2059             {'next_hop_sw_if_index': next_hop_sw_if_index,
2060              'entry_flags': e_flags,
2061              'itf_flags': i_flags,
2062              'table_id': table_id,
2063              'rpf_id': rpf_id,
2064              'is_add': is_add,
2065              'is_ipv6': is_ipv6,
2066              'is_local': is_local,
2067              'grp_address_length': grp_address_length,
2068              'grp_address': grp_address,
2069              'src_address': src_address})
2070
2071     def mfib_signal_dump(self):
2072         return self.api(self.papi.mfib_signal_dump, {})
2073
2074     def ip_mfib_dump(self):
2075         return self.api(self.papi.ip_mfib_dump, {})
2076
2077     def lisp_enable_disable(self, is_enabled):
2078         return self.api(
2079             self.papi.lisp_enable_disable,
2080             {
2081                 'is_en': is_enabled,
2082             })
2083
2084     def lisp_locator_set(self,
2085                          ls_name,
2086                          is_add=1):
2087         return self.api(
2088             self.papi.lisp_add_del_locator_set,
2089             {
2090                 'is_add': is_add,
2091                 'locator_set_name': ls_name
2092             })
2093
2094     def lisp_locator_set_dump(self):
2095         return self.api(self.papi.lisp_locator_set_dump, {})
2096
2097     def lisp_locator(self,
2098                      ls_name,
2099                      sw_if_index,
2100                      priority=1,
2101                      weight=1,
2102                      is_add=1):
2103         return self.api(
2104             self.papi.lisp_add_del_locator,
2105             {
2106                 'is_add': is_add,
2107                 'locator_set_name': ls_name,
2108                 'sw_if_index': sw_if_index,
2109                 'priority': priority,
2110                 'weight': weight
2111             })
2112
2113     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2114         return self.api(
2115             self.papi.lisp_locator_dump,
2116             {
2117                 'is_index_set': is_index_set,
2118                 'ls_name': ls_name,
2119                 'ls_index': ls_index,
2120             })
2121
2122     def lisp_local_mapping(self,
2123                            ls_name,
2124                            eid_type,
2125                            eid,
2126                            prefix_len,
2127                            vni=0,
2128                            key_id=0,
2129                            key="",
2130                            is_add=1):
2131         return self.api(
2132             self.papi.lisp_add_del_local_eid,
2133             {
2134                 'locator_set_name': ls_name,
2135                 'is_add': is_add,
2136                 'eid_type': eid_type,
2137                 'eid': eid,
2138                 'prefix_len': prefix_len,
2139                 'vni': vni,
2140                 'key_id': key_id,
2141                 'key': key
2142             })
2143
2144     def lisp_eid_table_dump(self,
2145                             eid_set=0,
2146                             prefix_length=0,
2147                             vni=0,
2148                             eid_type=0,
2149                             eid=None,
2150                             filter_opt=0):
2151         return self.api(
2152             self.papi.lisp_eid_table_dump,
2153             {
2154                 'eid_set': eid_set,
2155                 'prefix_length': prefix_length,
2156                 'vni': vni,
2157                 'eid_type': eid_type,
2158                 'eid': eid,
2159                 'filter': filter_opt,
2160             })
2161
2162     def lisp_remote_mapping(self,
2163                             eid_type,
2164                             eid,
2165                             eid_prefix_len=0,
2166                             vni=0,
2167                             rlocs=[],
2168                             rlocs_num=0,
2169                             is_src_dst=0,
2170                             is_add=1):
2171         return self.api(
2172             self.papi.lisp_add_del_remote_mapping,
2173             {
2174                 'is_add': is_add,
2175                 'eid_type': eid_type,
2176                 'eid': eid,
2177                 'eid_len': eid_prefix_len,
2178                 'rloc_num': rlocs_num,
2179                 'rlocs': rlocs,
2180                 'vni': vni,
2181                 'is_src_dst': is_src_dst,
2182             })
2183
2184     def lisp_adjacency(self,
2185                        leid,
2186                        reid,
2187                        leid_len,
2188                        reid_len,
2189                        eid_type,
2190                        is_add=1,
2191                        vni=0):
2192         return self.api(
2193             self.papi.lisp_add_del_adjacency,
2194             {
2195                 'is_add': is_add,
2196                 'vni': vni,
2197                 'eid_type': eid_type,
2198                 'leid': leid,
2199                 'reid': reid,
2200                 'leid_len': leid_len,
2201                 'reid_len': reid_len,
2202             })
2203
2204     def lisp_adjacencies_get(self, vni=0):
2205         return self.api(
2206             self.papi.lisp_adjacencies_get,
2207             {
2208                 'vni': vni
2209             })
2210
2211     def map_add_domain(self,
2212                        ip6_prefix,
2213                        ip6_prefix_len,
2214                        ip6_src,
2215                        ip6_src_prefix_len,
2216                        ip4_prefix,
2217                        ip4_prefix_len,
2218                        ea_bits_len=0,
2219                        psid_offset=0,
2220                        psid_length=0,
2221                        is_translation=0,
2222                        mtu=1280):
2223         return self.api(
2224             self.papi.map_add_domain,
2225             {
2226                 'ip6_prefix': ip6_prefix,
2227                 'ip6_prefix_len': ip6_prefix_len,
2228                 'ip4_prefix': ip4_prefix,
2229                 'ip4_prefix_len': ip4_prefix_len,
2230                 'ip6_src': ip6_src,
2231                 'ip6_src_prefix_len': ip6_src_prefix_len,
2232                 'ea_bits_len': ea_bits_len,
2233                 'psid_offset': psid_offset,
2234                 'psid_length': psid_length,
2235                 'is_translation': is_translation,
2236                 'mtu': mtu
2237             })
2238
2239     def gtpu_add_del_tunnel(
2240             self,
2241             src_addr,
2242             dst_addr,
2243             is_add=1,
2244             is_ipv6=0,
2245             mcast_sw_if_index=0xFFFFFFFF,
2246             encap_vrf_id=0,
2247             decap_next_index=0xFFFFFFFF,
2248             teid=0):
2249         """
2250
2251         :param is_add:  (Default value = 1)
2252         :param is_ipv6:  (Default value = 0)
2253         :param src_addr:
2254         :param dst_addr:
2255         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2256         :param encap_vrf_id:  (Default value = 0)
2257         :param decap_next_index:  (Default value = 0xFFFFFFFF)
2258         :param teid:  (Default value = 0)
2259
2260         """
2261         return self.api(self.papi.gtpu_add_del_tunnel,
2262                         {'is_add': is_add,
2263                          'is_ipv6': is_ipv6,
2264                          'src_address': src_addr,
2265                          'dst_address': dst_addr,
2266                          'mcast_sw_if_index': mcast_sw_if_index,
2267                          'encap_vrf_id': encap_vrf_id,
2268                          'decap_next_index': decap_next_index,
2269                          'teid': teid})
2270
2271     def vxlan_gpe_add_del_tunnel(
2272             self,
2273             src_addr,
2274             dst_addr,
2275             mcast_sw_if_index=0xFFFFFFFF,
2276             is_add=1,
2277             is_ipv6=0,
2278             encap_vrf_id=0,
2279             decap_vrf_id=0,
2280             protocol=3,
2281             vni=0):
2282         """
2283
2284         :param local:
2285         :param remote:
2286         :param is_add:  (Default value = 1)
2287         :param is_ipv6:  (Default value = 0)
2288         :param encap_vrf_id:  (Default value = 0)
2289         :param decap_vrf_id:  (Default value = 0)
2290         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2291         :param protocol:  (Default value = 3)
2292         :param vni:  (Default value = 0)
2293
2294         """
2295         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2296                         {'is_add': is_add,
2297                          'is_ipv6': is_ipv6,
2298                          'local': src_addr,
2299                          'remote': dst_addr,
2300                          'mcast_sw_if_index': mcast_sw_if_index,
2301                          'encap_vrf_id': encap_vrf_id,
2302                          'decap_vrf_id': decap_vrf_id,
2303                          'protocol': protocol,
2304                          'vni': vni})
2305
2306     def pppoe_add_del_session(
2307             self,
2308             client_ip,
2309             client_mac,
2310             session_id=0,
2311             is_add=1,
2312             is_ipv6=0,
2313             decap_vrf_id=0):
2314         """
2315
2316         :param is_add:  (Default value = 1)
2317         :param is_ipv6:  (Default value = 0)
2318         :param client_ip:
2319         :param session_id:  (Default value = 0)
2320         :param client_mac:
2321         :param decap_vrf_id:  (Default value = 0)
2322
2323         """
2324         return self.api(self.papi.pppoe_add_del_session,
2325                         {'is_add': is_add,
2326                          'is_ipv6': is_ipv6,
2327                          'session_id': session_id,
2328                          'client_ip': client_ip,
2329                          'decap_vrf_id': decap_vrf_id,
2330                          'client_mac': client_mac})
2331
2332     def sr_localsid_add_del(self,
2333                             localsid_addr,
2334                             behavior,
2335                             nh_addr,
2336                             is_del=0,
2337                             end_psp=0,
2338                             sw_if_index=0xFFFFFFFF,
2339                             vlan_index=0,
2340                             fib_table=0,
2341                             ):
2342         """ Add/del IPv6 SR local-SID.
2343
2344         :param localsid_addr:
2345         :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2346         :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2347         :param nh_addr:
2348         :param is_del:  (Default value = 0)
2349         :param end_psp: (Default value = 0)
2350         :param sw_if_index: (Default value = 0xFFFFFFFF)
2351         :param vlan_index:  (Default value = 0)
2352         :param fib_table:   (Default value = 0)
2353         """
2354         return self.api(
2355             self.papi.sr_localsid_add_del,
2356             {'is_del': is_del,
2357              'localsid_addr': localsid_addr,
2358              'end_psp': end_psp,
2359              'behavior': behavior,
2360              'sw_if_index': sw_if_index,
2361              'vlan_index': vlan_index,
2362              'fib_table': fib_table,
2363              'nh_addr': nh_addr
2364              }
2365         )
2366
2367     def sr_policy_add(
2368             self,
2369             bsid_addr,
2370             weight=1,
2371             is_encap=1,
2372             type=0,
2373             fib_table=0,
2374             n_segments=0,
2375             segments=[]):
2376         """
2377         :param bsid_addr: bindingSID of the SR Policy
2378         :param weight: weight of the sid list. optional. (default: 1)
2379         :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2380             (default: Encap)
2381         :param type: type/behavior of the SR policy. (default or spray) \
2382             (default: default)
2383         :param fib_table: VRF where to install the FIB entry for the BSID \
2384             (default: 0)
2385         :param n_segments: number of segments \
2386             (default: 0)
2387         :param segments: a vector of IPv6 address composing the segment list \
2388             (default: [])
2389         """
2390         return self.api(
2391             self.papi.sr_policy_add,
2392             {'bsid_addr': bsid_addr,
2393              'weight': weight,
2394              'is_encap': is_encap,
2395              'type': type,
2396              'fib_table': fib_table,
2397              'n_segments': n_segments,
2398              'segments': segments
2399              }
2400         )
2401
2402     def sr_policy_del(
2403             self,
2404             bsid_addr,
2405             sr_policy_index=0):
2406         """
2407         :param bsid: bindingSID of the SR Policy
2408         :param sr_policy_index: index of the sr policy (default: 0)
2409         """
2410         return self.api(
2411             self.papi.sr_policy_del,
2412             {'bsid_addr': bsid_addr,
2413              'sr_policy_index': sr_policy_index
2414              })
2415
2416     def sr_steering_add_del(
2417             self,
2418             is_del,
2419             bsid_addr,
2420             sr_policy_index,
2421             table_id,
2422             prefix_addr,
2423             mask_width,
2424             sw_if_index,
2425             traffic_type):
2426         """
2427         Steer traffic L2 and L3 traffic through a given SR policy
2428
2429         :param is_del: delete or add
2430         :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2431         :param sr_policy: is the index of the SR Policy (alt to bsid)
2432         :param table_id: is the VRF where to install the FIB entry for the BSID
2433         :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2434         :param mask_width: is the mask for L3 traffic type
2435         :param sw_if_index: is the incoming interface for L2 traffic
2436         :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2437         """
2438         return self.api(
2439             self.papi.sr_steering_add_del,
2440             {'is_del': is_del,
2441              'bsid_addr': bsid_addr,
2442              'sr_policy_index': sr_policy_index,
2443              'table_id': table_id,
2444              'prefix_addr': prefix_addr,
2445              'mask_width': mask_width,
2446              'sw_if_index': sw_if_index,
2447              'traffic_type': traffic_type
2448              })
2449
2450     def acl_add_replace(self, acl_index, r, tag='',
2451                         expected_retval=0):
2452         """Add/replace an ACL
2453         :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2454         :param acl_rule r: ACL rules array.
2455         :param str tag: symbolic tag (description) for this ACL.
2456         :param int count: number of rules.
2457         """
2458         return self.api(self.papi.acl_add_replace,
2459                         {'acl_index': acl_index,
2460                          'r': r,
2461                          'count': len(r),
2462                          'tag': tag},
2463                         expected_retval=expected_retval)
2464
2465     def acl_del(self, acl_index, expected_retval=0):
2466         """
2467
2468         :param acl_index:
2469         :return:
2470         """
2471         return self.api(self.papi.acl_del,
2472                         {'acl_index': acl_index},
2473                         expected_retval=expected_retval)
2474
2475     def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2476                                    expected_retval=0):
2477         return self.api(self.papi.acl_interface_set_acl_list,
2478                         {'sw_if_index': sw_if_index,
2479                          'count': len(acls),
2480                          'n_input': n_input,
2481                          'acls': acls},
2482                         expected_retval=expected_retval)
2483
2484     def acl_dump(self, acl_index, expected_retval=0):
2485         return self.api(self.papi.acl_dump,
2486                         {'acl_index': acl_index},
2487                         expected_retval=expected_retval)
2488
2489     def macip_acl_add(self, rules, tag=""):
2490         """ Add MACIP acl
2491
2492         :param rules: list of rules for given acl
2493         :param tag: acl tag
2494         """
2495
2496         return self.api(self.papi.macip_acl_add,
2497                         {'r': rules,
2498                          'count': len(rules),
2499                          'tag': tag})
2500
2501     def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2502         """ Add MACIP acl
2503
2504         :param rules: list of rules for given acl
2505         :param tag: acl tag
2506         """
2507
2508         return self.api(self.papi.macip_acl_add_replace,
2509                         {'acl_index': acl_index,
2510                          'r': rules,
2511                          'count': len(rules),
2512                          'tag': tag})
2513
2514     def macip_acl_del(self, acl_index):
2515         """
2516
2517         :param acl_index:
2518         :return:
2519         """
2520         return self.api(self.papi.macip_acl_del,
2521                         {'acl_index': acl_index})
2522
2523     def macip_acl_interface_add_del(self,
2524                                     sw_if_index,
2525                                     acl_index,
2526                                     is_add=1):
2527         """ Add MACIP acl to interface
2528
2529         :param sw_if_index:
2530         :param acl_index:
2531         :param is_add:  (Default value = 1)
2532         """
2533
2534         return self.api(self.papi.macip_acl_interface_add_del,
2535                         {'is_add': is_add,
2536                          'sw_if_index': sw_if_index,
2537                          'acl_index': acl_index})
2538
2539     def macip_acl_interface_get(self):
2540         """ Return interface acls dump
2541         """
2542         return self.api(
2543             self.papi.macip_acl_interface_get, {})
2544
2545     def macip_acl_dump(self, acl_index=4294967295):
2546         """ Return MACIP acl dump
2547         """
2548
2549         return self.api(
2550             self.papi.macip_acl_dump, {'acl_index': acl_index})
2551
2552     def policer_add_del(self,
2553                         name,
2554                         cir,
2555                         eir,
2556                         cb,
2557                         eb,
2558                         is_add=1,
2559                         rate_type=0,
2560                         round_type=0,
2561                         ptype=0,
2562                         color_aware=0,
2563                         conform_action_type=1,
2564                         conform_dscp=0,
2565                         exceed_action_type=0,
2566                         exceed_dscp=0,
2567                         violate_action_type=0,
2568                         violate_dscp=0):
2569         return self.api(self.papi.policer_add_del,
2570                         {'name': name,
2571                          'cir': cir,
2572                          'eir': eir,
2573                          'cb': cb,
2574                          'eb': eb,
2575                          'is_add': is_add,
2576                          'rate_type': rate_type,
2577                          'round_type': round_type,
2578                          'type': ptype,
2579                          'color_aware': color_aware,
2580                          'conform_action_type': conform_action_type,
2581                          'conform_dscp': conform_dscp,
2582                          'exceed_action_type': exceed_action_type,
2583                          'exceed_dscp': exceed_dscp,
2584                          'violate_action_type': violate_action_type,
2585                          'violate_dscp': violate_dscp})
2586
2587     def ip_punt_police(self,
2588                        policer_index,
2589                        is_ip6=0,
2590                        is_add=1):
2591         return self.api(self.papi.ip_punt_police,
2592                         {'policer_index': policer_index,
2593                          'is_add': is_add,
2594                          'is_ip6': is_ip6})
2595
2596     def ip_punt_redirect(self,
2597                          rx_sw_if_index,
2598                          tx_sw_if_index,
2599                          nh,
2600                          is_ip6=0,
2601                          is_add=1):
2602         return self.api(self.papi.ip_punt_redirect,
2603                         {'rx_sw_if_index': rx_sw_if_index,
2604                          'tx_sw_if_index': tx_sw_if_index,
2605                          'nh': nh,
2606                          'is_add': is_add,
2607                          'is_ip6': is_ip6})