test/vpp_papi_provider.py

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