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 within %ss",
 105                                          timeout)
 106         else:
 107             self.test_class.logger.debug("Expecting event '%s' within %ss",
 108                                          name, 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 l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
 423                       filter_mac=0, bvi_mac=0):
 424         """Create/delete L2 FIB entry.
 425
 426         :param str mac: MAC address to create FIB entry for.
 427         :param int bd_id: Bridge domain index.
 428         :param int sw_if_index: Software interface index of the interface.
 429         :param int is_add: Add or delete flag. (Default value = 1)
 430         :param int static_mac: Set to 1 to create static MAC entry.
 431             (Default value = 0)
 432         :param int filter_mac: Set to 1 to drop packet that's source or
 433             destination MAC address contains defined MAC address.
 434             (Default value = 0)
 435         :param int bvi_mac: Set to 1 to create entry that points to BVI
 436             interface. (Default value = 0)
 437         """
 438         return self.api(self.papi.l2fib_add_del,
 439                         {'mac': self._convert_mac(mac),
 440                          'bd_id': bd_id,
 441                          'sw_if_index': sw_if_index,
 442                          'is_add': is_add,
 443                          'static_mac': static_mac,
 444                          'filter_mac': filter_mac,
 445                          'bvi_mac': bvi_mac})
 446
 447     def l2fib_flush_int(self, sw_if_index):
 448         """Flush L2 FIB entries for sw_if_index.
 449
 450         :param int sw_if_index: Software interface index of the interface.
 451         """
 452         return self.api(self.papi.l2fib_flush_int,
 453                         {'sw_if_index': sw_if_index})
 454
 455     def l2fib_flush_bd(self, bd_id):
 456         """Flush L2 FIB entries for bd_id.
 457
 458         :param int sw_if_index: Bridge Domain id.
 459         """
 460         return self.api(self.papi.l2fib_flush_bd,
 461                         {'bd_id': bd_id})
 462
 463     def l2fib_flush_all(self):
 464         """Flush all L2 FIB.
 465         """
 466         return self.api(self.papi.l2fib_flush_all, {})
 467
 468     def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
 469                                    shg=0, bvi=0, enable=1):
 470         """Add/remove interface to/from bridge domain.
 471
 472         :param int sw_if_index: Software interface index of the interface.
 473         :param int bd_id: Bridge domain index.
 474         :param int shg: Split-horizon group index. (Default value = 0)
 475         :param int bvi: Set interface as a bridge group virtual interface.
 476             (Default value = 0)
 477         :param int enable: Add or remove interface. (Default value = 1)
 478         """
 479         return self.api(self.papi.sw_interface_set_l2_bridge,
 480                         {'rx_sw_if_index': sw_if_index,
 481                          'bd_id': bd_id,
 482                          'shg': shg,
 483                          'bvi': bvi,
 484                          'enable': enable})
 485
 486     def bridge_flags(self, bd_id, is_set, feature_bitmap):
 487         """Enable/disable required feature of the bridge domain with defined ID.
 488
 489         :param int bd_id: Bridge domain ID.
 490         :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
 491         :param int feature_bitmap: Bitmap value of the feature to be set:
 492             - learn (1 << 0),
 493             - forward (1 << 1),
 494             - flood (1 << 2),
 495             - uu-flood (1 << 3) or
 496             - arp-term (1 << 4).
 497         """
 498         return self.api(self.papi.bridge_flags,
 499                         {'bd_id': bd_id,
 500                          'is_set': is_set,
 501                          'feature_bitmap': feature_bitmap})
 502
 503     def bridge_domain_dump(self, bd_id=0):
 504         """
 505
 506         :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
 507             existing bridge domains returned)
 508         :return: Dictionary of bridge domain(s) data.
 509         """
 510         return self.api(self.papi.bridge_domain_dump,
 511                         {'bd_id': bd_id})
 512
 513     def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
 514                                      enable):
 515         """Create or delete unidirectional cross-connect from Tx interface to
 516         Rx interface.
 517
 518         :param int rx_sw_if_index: Software interface index of Rx interface.
 519         :param int tx_sw_if_index: Software interface index of Tx interface.
 520         :param int enable: Create cross-connect if equal to 1, delete
 521             cross-connect if equal to 0.
 522
 523         """
 524         return self.api(self.papi.sw_interface_set_l2_xconnect,
 525                         {'rx_sw_if_index': rx_sw_if_index,
 526                          'tx_sw_if_index': tx_sw_if_index,
 527                          'enable': enable})
 528
 529     def sw_interface_set_l2_tag_rewrite(
 530             self,
 531             sw_if_index,
 532             vtr_oper,
 533             push=0,
 534             tag1=0,
 535             tag2=0):
 536         """L2 interface vlan tag rewrite configure request
 537         :param client_index - opaque cookie to identify the sender
 538         :param context - sender context, to match reply w/ request
 539         :param sw_if_index - interface the operation is applied to
 540         :param vtr_op - Choose from l2_vtr_op_t enum values
 541         :param push_dot1q - first pushed flag dot1q id set, else dot1ad
 542         :param tag1 - Needed for any push or translate vtr op
 543         :param tag2 - Needed for any push 2 or translate x-2 vtr ops
 544
 545         """
 546         return self.api(self.papi.l2_interface_vlan_tag_rewrite,
 547                         {'sw_if_index': sw_if_index,
 548                          'vtr_op': vtr_oper,
 549                          'push_dot1q': push,
 550                          'tag1': tag1,
 551                          'tag2': tag2})
 552
 553     def sw_interface_set_flags(self, sw_if_index, admin_up_down):
 554         """
 555
 556         :param admin_up_down:
 557         :param sw_if_index:
 558
 559         """
 560         return self.api(self.papi.sw_interface_set_flags,
 561                         {'sw_if_index': sw_if_index,
 562                          'admin_up_down': admin_up_down})
 563
 564     def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
 565                      no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
 566                      default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
 567         """Create subinterface
 568         from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
 569
 570         :param sub_id: param inner_vlan:
 571         :param sw_if_index:
 572         :param outer_vlan:
 573         :param inner_vlan:
 574         :param no_tags:  (Default value = 0)
 575         :param one_tag:  (Default value = 0)
 576         :param two_tags:  (Default value = 0)
 577         :param dot1ad:  (Default value = 0)
 578         :param exact_match:  (Default value = 0)
 579         :param default_sub:  (Default value = 0)
 580         :param outer_vlan_id_any:  (Default value = 0)
 581         :param inner_vlan_id_any:  (Default value = 0)
 582
 583         """
 584         return self.api(
 585             self.papi.create_subif,
 586             {'sw_if_index': sw_if_index,
 587              'sub_id': sub_id,
 588              'no_tags': no_tags,
 589              'one_tag': one_tag,
 590              'two_tags': two_tags,
 591              'dot1ad': dot1ad,
 592              'exact_match': exact_match,
 593              'default_sub': default_sub,
 594              'outer_vlan_id_any': outer_vlan_id_any,
 595              'inner_vlan_id_any': inner_vlan_id_any,
 596              'outer_vlan_id': outer_vlan,
 597              'inner_vlan_id': inner_vlan})
 598
 599     def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
 600         """Create p2p ethernet subinterface
 601
 602         :param sw_if_index: main (parent) interface
 603         :param remote_mac: client (remote) mac address
 604
 605         """
 606         return self.api(
 607             self.papi.p2p_ethernet_add,
 608             {'parent_if_index': sw_if_index,
 609              'remote_mac': remote_mac,
 610              'subif_id': subif_id})
 611
 612     def delete_subif(self, sw_if_index):
 613         """Delete subinterface
 614
 615         :param sw_if_index:
 616         """
 617         return self.api(self.papi.delete_subif,
 618                         {'sw_if_index': sw_if_index})
 619
 620     def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
 621         """Delete p2p ethernet subinterface
 622
 623         :param sw_if_index: main (parent) interface
 624         :param remote_mac: client (remote) mac address
 625
 626         """
 627         return self.api(
 628             self.papi.p2p_ethernet_del,
 629             {'parent_if_index': sw_if_index,
 630              'remote_mac': remote_mac})
 631
 632     def create_vlan_subif(self, sw_if_index, vlan):
 633         """
 634
 635         :param vlan:
 636         :param sw_if_index:
 637
 638         """
 639         return self.api(self.papi.create_vlan_subif,
 640                         {'sw_if_index': sw_if_index,
 641                          'vlan_id': vlan})
 642
 643     def create_loopback(self, mac=''):
 644         """
 645
 646         :param mac: (Optional)
 647         """
 648         return self.api(self.papi.create_loopback,
 649                         {'mac_address': mac})
 650
 651     def delete_loopback(self, sw_if_index):
 652         return self.api(self.papi.delete_loopback,
 653                         {'sw_if_index': sw_if_index, })
 654
 655     def ip_add_del_route(
 656             self,
 657             dst_address,
 658             dst_address_length,
 659             next_hop_address,
 660             next_hop_sw_if_index=0xFFFFFFFF,
 661             table_id=0,
 662             next_hop_table_id=0,
 663             next_hop_weight=1,
 664             next_hop_n_out_labels=0,
 665             next_hop_out_label_stack=[],
 666             next_hop_via_label=MPLS_LABEL_INVALID,
 667             create_vrf_if_needed=0,
 668             is_resolve_host=0,
 669             is_resolve_attached=0,
 670             classify_table_index=0xFFFFFFFF,
 671             is_add=1,
 672             is_drop=0,
 673             is_unreach=0,
 674             is_prohibit=0,
 675             is_ipv6=0,
 676             is_local=0,
 677             is_classify=0,
 678             is_multipath=0,
 679             not_last=0):
 680         """
 681
 682         :param dst_address_length:
 683         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 684         :param dst_address:
 685         :param next_hop_address:
 686         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 687         :param vrf_id:  (Default value = 0)
 688         :param lookup_in_vrf:  (Default value = 0)
 689         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 690         :param create_vrf_if_needed:  (Default value = 0)
 691         :param is_add:  (Default value = 1)
 692         :param is_drop:  (Default value = 0)
 693         :param is_ipv6:  (Default value = 0)
 694         :param is_local:  (Default value = 0)
 695         :param is_classify:  (Default value = 0)
 696         :param is_multipath:  (Default value = 0)
 697         :param is_resolve_host:  (Default value = 0)
 698         :param is_resolve_attached:  (Default value = 0)
 699         :param not_last:  (Default value = 0)
 700         :param next_hop_weight:  (Default value = 1)
 701
 702         """
 703
 704         return self.api(
 705             self.papi.ip_add_del_route,
 706             {'next_hop_sw_if_index': next_hop_sw_if_index,
 707              'table_id': table_id,
 708              'classify_table_index': classify_table_index,
 709              'next_hop_table_id': next_hop_table_id,
 710              'create_vrf_if_needed': create_vrf_if_needed,
 711              'is_add': is_add,
 712              'is_drop': is_drop,
 713              'is_unreach': is_unreach,
 714              'is_prohibit': is_prohibit,
 715              'is_ipv6': is_ipv6,
 716              'is_local': is_local,
 717              'is_classify': is_classify,
 718              'is_multipath': is_multipath,
 719              'is_resolve_host': is_resolve_host,
 720              'is_resolve_attached': is_resolve_attached,
 721              'not_last': not_last,
 722              'next_hop_weight': next_hop_weight,
 723              'dst_address_length': dst_address_length,
 724              'dst_address': dst_address,
 725              'next_hop_address': next_hop_address,
 726              'next_hop_n_out_labels': next_hop_n_out_labels,
 727              'next_hop_via_label': next_hop_via_label,
 728              'next_hop_out_label_stack': next_hop_out_label_stack})
 729
 730     def ip_fib_dump(self):
 731         return self.api(self.papi.ip_fib_dump, {})
 732
 733     def ip6_fib_dump(self):
 734         return self.api(self.papi.ip6_fib_dump, {})
 735
 736     def ip_neighbor_add_del(self,
 737                             sw_if_index,
 738                             mac_address,
 739                             dst_address,
 740                             is_add=1,
 741                             is_ipv6=0,
 742                             is_static=0,
 743                             is_no_adj_fib=0,
 744                             ):
 745         """ Add neighbor MAC to IPv4 or IPv6 address.
 746
 747         :param sw_if_index:
 748         :param mac_address:
 749         :param dst_address:
 750         :param is_add:  (Default value = 1)
 751         :param is_ipv6:  (Default value = 0)
 752         :param is_static:  (Default value = 0)
 753         :param is_no_adj_fib:  (Default value = 0)
 754         """
 755
 756         return self.api(
 757             self.papi.ip_neighbor_add_del,
 758             {'sw_if_index': sw_if_index,
 759              'is_add': is_add,
 760              'is_ipv6': is_ipv6,
 761              'is_static': is_static,
 762              'is_no_adj_fib': is_no_adj_fib,
 763              'mac_address': mac_address,
 764              'dst_address': dst_address
 765              }
 766         )
 767
 768     def ip_neighbor_dump(self,
 769                          sw_if_index,
 770                          is_ipv6=0):
 771         """ Return IP neighbor dump.
 772
 773         :param sw_if_index:
 774         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 775         """
 776
 777         return self.api(
 778             self.papi.ip_neighbor_dump,
 779             {'is_ipv6': is_ipv6,
 780              'sw_if_index': sw_if_index
 781              }
 782         )
 783
 784     def proxy_arp_add_del(self,
 785                           low_address,
 786                           hi_address,
 787                           vrf_id=0,
 788                           is_add=1):
 789         """ Config Proxy Arp Range.
 790
 791         :param low_address: Start address in the rnage to Proxy for
 792         :param hi_address: End address in the rnage to Proxy for
 793         :param vrf_id: The VRF/table in which to proxy
 794         """
 795
 796         return self.api(
 797             self.papi.proxy_arp_add_del,
 798             {'vrf_id': vrf_id,
 799              'is_add': is_add,
 800              'low_address': low_address,
 801              'hi_address': hi_address,
 802              }
 803         )
 804
 805     def proxy_arp_intfc_enable_disable(self,
 806                                        sw_if_index,
 807                                        is_enable=1):
 808         """ Enable/Disable an interface for proxy ARP requests
 809
 810         :param sw_if_index: Interface
 811         :param enable_disable: Enable/Disable
 812         """
 813
 814         return self.api(
 815             self.papi.proxy_arp_intfc_enable_disable,
 816             {'sw_if_index': sw_if_index,
 817              'enable_disable': is_enable
 818              }
 819         )
 820
 821     def reset_vrf(self,
 822                   vrf_id,
 823                   is_ipv6=0,
 824                   ):
 825         """ Reset VRF (remove all routes etc.) request.
 826
 827         :param int vrf_id: ID of the FIB table / VRF to reset.
 828         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 829         """
 830
 831         return self.api(
 832             self.papi.reset_vrf,
 833             {'vrf_id': vrf_id,
 834              'is_ipv6': is_ipv6,
 835              }
 836         )
 837
 838     def reset_fib(self,
 839                   vrf_id,
 840                   is_ipv6=0,
 841                   ):
 842         """ Reset VRF (remove all routes etc.) request.
 843
 844         :param int vrf_id: ID of the FIB table / VRF to reset.
 845         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 846         """
 847
 848         return self.api(
 849             self.papi.reset_fib,
 850             {'vrf_id': vrf_id,
 851              'is_ipv6': is_ipv6,
 852              }
 853         )
 854
 855     def ip_dump(self,
 856                 is_ipv6=0,
 857                 ):
 858         """ Return IP dump.
 859
 860         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 861         """
 862
 863         return self.api(
 864             self.papi.ip_dump,
 865             {'is_ipv6': is_ipv6,
 866              }
 867         )
 868
 869     def sw_interface_span_enable_disable(
 870             self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
 871         """
 872
 873         :param sw_if_index_from:
 874         :param sw_if_index_to:
 875         :param state:
 876         :param is_l2:
 877         """
 878         return self.api(self.papi.sw_interface_span_enable_disable,
 879                         {'sw_if_index_from': sw_if_index_from,
 880                          'sw_if_index_to': sw_if_index_to,
 881                          'state': state,
 882                          'is_l2': is_l2,
 883                          })
 884
 885     def gre_tunnel_add_del(self,
 886                            src_address,
 887                            dst_address,
 888                            outer_fib_id=0,
 889                            is_teb=0,
 890                            is_add=1,
 891                            is_ip6=0):
 892         """ Add a GRE tunnel
 893
 894         :param src_address:
 895         :param dst_address:
 896         :param outer_fib_id:  (Default value = 0)
 897         :param is_add:  (Default value = 1)
 898         :param is_ipv6:  (Default value = 0)
 899         :param is_teb:  (Default value = 0)
 900         """
 901
 902         return self.api(
 903             self.papi.gre_add_del_tunnel,
 904             {'is_add': is_add,
 905              'is_ipv6': is_ip6,
 906              'teb': is_teb,
 907              'src_address': src_address,
 908              'dst_address': dst_address,
 909              'outer_fib_id': outer_fib_id}
 910         )
 911
 912     def mpls_fib_dump(self):
 913         return self.api(self.papi.mpls_fib_dump, {})
 914
 915     def mpls_route_add_del(
 916             self,
 917             label,
 918             eos,
 919             next_hop_proto,
 920             next_hop_address,
 921             next_hop_sw_if_index=0xFFFFFFFF,
 922             table_id=0,
 923             next_hop_table_id=0,
 924             next_hop_weight=1,
 925             next_hop_n_out_labels=0,
 926             next_hop_out_label_stack=[],
 927             next_hop_via_label=MPLS_LABEL_INVALID,
 928             create_vrf_if_needed=0,
 929             is_resolve_host=0,
 930             is_resolve_attached=0,
 931             is_interface_rx=0,
 932             is_rpf_id=0,
 933             is_multicast=0,
 934             is_add=1,
 935             is_drop=0,
 936             is_multipath=0,
 937             classify_table_index=0xFFFFFFFF,
 938             is_classify=0,
 939             not_last=0):
 940         """
 941
 942         :param dst_address_length:
 943         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 944         :param dst_address:
 945         :param next_hop_address:
 946         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 947         :param vrf_id:  (Default value = 0)
 948         :param lookup_in_vrf:  (Default value = 0)
 949         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 950         :param create_vrf_if_needed:  (Default value = 0)
 951         :param is_add:  (Default value = 1)
 952         :param is_drop:  (Default value = 0)
 953         :param is_ipv6:  (Default value = 0)
 954         :param is_local:  (Default value = 0)
 955         :param is_classify:  (Default value = 0)
 956         :param is_multipath:  (Default value = 0)
 957         :param is_multicast:  (Default value = 0)
 958         :param is_resolve_host:  (Default value = 0)
 959         :param is_resolve_attached:  (Default value = 0)
 960         :param not_last:  (Default value = 0)
 961         :param next_hop_weight:  (Default value = 1)
 962
 963         """
 964
 965         return self.api(
 966             self.papi.mpls_route_add_del,
 967             {'mr_label': label,
 968              'mr_eos': eos,
 969              'mr_table_id': table_id,
 970              'mr_classify_table_index': classify_table_index,
 971              'mr_create_table_if_needed': create_vrf_if_needed,
 972              'mr_is_add': is_add,
 973              'mr_is_classify': is_classify,
 974              'mr_is_multipath': is_multipath,
 975              'mr_is_multicast': is_multicast,
 976              'mr_is_resolve_host': is_resolve_host,
 977              'mr_is_resolve_attached': is_resolve_attached,
 978              'mr_is_interface_rx': is_interface_rx,
 979              'mr_is_rpf_id': is_rpf_id,
 980              'mr_next_hop_proto': next_hop_proto,
 981              'mr_next_hop_weight': next_hop_weight,
 982              'mr_next_hop': next_hop_address,
 983              'mr_next_hop_n_out_labels': next_hop_n_out_labels,
 984              'mr_next_hop_sw_if_index': next_hop_sw_if_index,
 985              'mr_next_hop_table_id': next_hop_table_id,
 986              'mr_next_hop_via_label': next_hop_via_label,
 987              'mr_next_hop_out_label_stack': next_hop_out_label_stack})
 988
 989     def mpls_ip_bind_unbind(
 990             self,
 991             label,
 992             dst_address,
 993             dst_address_length,
 994             table_id=0,
 995             ip_table_id=0,
 996             is_ip4=1,
 997             create_vrf_if_needed=0,
 998             is_bind=1):
 999         """
1000         """
1001         return self.api(
1002             self.papi.mpls_ip_bind_unbind,
1003             {'mb_mpls_table_id': table_id,
1004              'mb_label': label,
1005              'mb_ip_table_id': ip_table_id,
1006              'mb_create_table_if_needed': create_vrf_if_needed,
1007              'mb_is_bind': is_bind,
1008              'mb_is_ip4': is_ip4,
1009              'mb_address_length': dst_address_length,
1010              'mb_address': dst_address})
1011
1012     def mpls_tunnel_add_del(
1013             self,
1014             tun_sw_if_index,
1015             next_hop_proto_is_ip4,
1016             next_hop_address,
1017             next_hop_sw_if_index=0xFFFFFFFF,
1018             next_hop_table_id=0,
1019             next_hop_weight=1,
1020             next_hop_n_out_labels=0,
1021             next_hop_out_label_stack=[],
1022             next_hop_via_label=MPLS_LABEL_INVALID,
1023             create_vrf_if_needed=0,
1024             is_add=1,
1025             l2_only=0,
1026             is_multicast=0):
1027         """
1028
1029         :param dst_address_length:
1030         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1031         :param dst_address:
1032         :param next_hop_address:
1033         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1034         :param vrf_id:  (Default value = 0)
1035         :param lookup_in_vrf:  (Default value = 0)
1036         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1037         :param create_vrf_if_needed:  (Default value = 0)
1038         :param is_add:  (Default value = 1)
1039         :param is_drop:  (Default value = 0)
1040         :param is_ipv6:  (Default value = 0)
1041         :param is_local:  (Default value = 0)
1042         :param is_classify:  (Default value = 0)
1043         :param is_multipath:  (Default value = 0)
1044         :param is_resolve_host:  (Default value = 0)
1045         :param is_resolve_attached:  (Default value = 0)
1046         :param next_hop_weight:  (Default value = 1)
1047         :param is_multicast:  (Default value = 0)
1048
1049         """
1050         return self.api(
1051             self.papi.mpls_tunnel_add_del,
1052             {'mt_sw_if_index': tun_sw_if_index,
1053              'mt_is_add': is_add,
1054              'mt_l2_only': l2_only,
1055              'mt_is_multicast': is_multicast,
1056              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1057              'mt_next_hop_weight': next_hop_weight,
1058              'mt_next_hop': next_hop_address,
1059              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1060              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1061              'mt_next_hop_table_id': next_hop_table_id,
1062              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1063
1064     def nat44_interface_add_del_feature(
1065             self,
1066             sw_if_index,
1067             is_inside=1,
1068             is_add=1):
1069         """Enable/disable NAT44 feature on the interface
1070
1071         :param sw_if_index: Software index of the interface
1072         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1073         :param is_add: 1 if add, 0 if delete (Default value = 1)
1074         """
1075         return self.api(
1076             self.papi.nat44_interface_add_del_feature,
1077             {'is_add': is_add,
1078              'is_inside': is_inside,
1079              'sw_if_index': sw_if_index})
1080
1081     def nat44_interface_add_del_output_feature(
1082             self,
1083             sw_if_index,
1084             is_inside=1,
1085             is_add=1):
1086         """Enable/disable NAT44 output feature on the interface
1087
1088         :param sw_if_index: Software index of the interface
1089         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1090         :param is_add: 1 if add, 0 if delete (Default value = 1)
1091         """
1092         return self.api(
1093             self.papi.nat44_interface_add_del_output_feature,
1094             {'is_add': is_add,
1095              'is_inside': is_inside,
1096              'sw_if_index': sw_if_index})
1097
1098     def nat44_add_del_static_mapping(
1099             self,
1100             local_ip,
1101             external_ip=0,
1102             external_sw_if_index=0xFFFFFFFF,
1103             local_port=0,
1104             external_port=0,
1105             addr_only=1,
1106             vrf_id=0,
1107             protocol=0,
1108             is_add=1):
1109         """Add/delete NAT44 static mapping
1110
1111         :param local_ip: Local IP address
1112         :param external_ip: External IP address
1113         :param external_sw_if_index: External interface instead of IP address
1114         :param local_port: Local port number (Default value = 0)
1115         :param external_port: External port number (Default value = 0)
1116         :param addr_only: 1 if address only mapping, 0 if address and port
1117         :param vrf_id: VRF ID
1118         :param protocol: IP protocol (Default value = 0)
1119         :param is_add: 1 if add, 0 if delete (Default value = 1)
1120         """
1121         return self.api(
1122             self.papi.nat44_add_del_static_mapping,
1123             {'is_add': is_add,
1124              'addr_only': addr_only,
1125              'local_ip_address': local_ip,
1126              'external_ip_address': external_ip,
1127              'local_port': local_port,
1128              'external_port': external_port,
1129              'external_sw_if_index': external_sw_if_index,
1130              'vrf_id': vrf_id,
1131              'protocol': protocol})
1132
1133     def nat44_add_del_address_range(
1134             self,
1135             first_ip_address,
1136             last_ip_address,
1137             is_add=1,
1138             vrf_id=0xFFFFFFFF):
1139         """Add/del NAT44 address range
1140
1141         :param first_ip_address: First IP address
1142         :param last_ip_address: Last IP address
1143         :param vrf_id: VRF id for the address range
1144         :param is_add: 1 if add, 0 if delete (Default value = 1)
1145         """
1146         return self.api(
1147             self.papi.nat44_add_del_address_range,
1148             {'first_ip_address': first_ip_address,
1149              'last_ip_address': last_ip_address,
1150              'vrf_id': vrf_id,
1151              'is_add': is_add})
1152
1153     def nat44_address_dump(self):
1154         """Dump NAT44 addresses
1155         :return: Dictionary of NAT44 addresses
1156         """
1157         return self.api(self.papi.nat44_address_dump, {})
1158
1159     def nat44_interface_dump(self):
1160         """Dump interfaces with NAT44 feature
1161         :return: Dictionary of interfaces with NAT44 feature
1162         """
1163         return self.api(self.papi.nat44_interface_dump, {})
1164
1165     def nat44_interface_output_feature_dump(self):
1166         """Dump interfaces with NAT44 output feature
1167         :return: Dictionary of interfaces with NAT44 output feature
1168         """
1169         return self.api(self.papi.nat44_interface_output_feature_dump, {})
1170
1171     def nat44_static_mapping_dump(self):
1172         """Dump NAT44 static mappings
1173         :return: Dictionary of NAT44 static mappings
1174         """
1175         return self.api(self.papi.nat44_static_mapping_dump, {})
1176
1177     def nat_show_config(self):
1178         """Show NAT plugin config
1179         :return: NAT plugin config parameters
1180         """
1181         return self.api(self.papi.nat_show_config, {})
1182
1183     def nat44_add_interface_addr(
1184             self,
1185             sw_if_index,
1186             is_add=1):
1187         """Add/del NAT44 address from interface
1188
1189         :param sw_if_index: Software index of the interface
1190         :param is_add: 1 if add, 0 if delete (Default value = 1)
1191         """
1192         return self.api(self.papi.nat44_add_del_interface_addr,
1193                         {'is_add': is_add, 'sw_if_index': sw_if_index})
1194
1195     def nat44_interface_addr_dump(self):
1196         """Dump NAT44 addresses interfaces
1197         :return: Dictionary of NAT44 addresses interfaces
1198         """
1199         return self.api(self.papi.nat44_interface_addr_dump, {})
1200
1201     def nat_ipfix(
1202             self,
1203             domain_id=1,
1204             src_port=4739,
1205             enable=1):
1206         """Enable/disable NAT IPFIX logging
1207
1208         :param domain_id: Observation domain ID (Default value = 1)
1209         :param src_port: Source port number (Default value = 4739)
1210         :param enable: 1 if enable, 0 if disable (Default value = 1)
1211         """
1212         return self.api(
1213             self.papi.nat_ipfix_enable_disable,
1214             {'domain_id': domain_id,
1215              'src_port': src_port,
1216              'enable': enable})
1217
1218     def nat44_user_session_dump(
1219             self,
1220             ip_address,
1221             vrf_id):
1222         """Dump NAT44 user's sessions
1223
1224         :param ip_address: ip adress of the user to be dumped
1225         :param cpu_index: cpu_index on which the user is
1226         :param vrf_id: VRF ID
1227         :return: Dictionary of S-NAT sessions
1228         """
1229         return self.api(
1230             self.papi.nat44_user_session_dump,
1231             {'ip_address': ip_address,
1232              'vrf_id': vrf_id})
1233
1234     def nat44_user_dump(self):
1235         """Dump NAT44 users
1236
1237         :return: Dictionary of NAT44 users
1238         """
1239         return self.api(self.papi.nat44_user_dump, {})
1240
1241     def nat44_add_del_lb_static_mapping(
1242             self,
1243             external_addr,
1244             external_port,
1245             protocol,
1246             vrf_id=0,
1247             local_num=0,
1248             locals=None,
1249             is_add=1):
1250         """Add/delete NAT44 load balancing static mapping
1251
1252         :param is_add - 1 if add, 0 if delete
1253         """
1254         return self.api(
1255             self.papi.nat44_add_del_lb_static_mapping,
1256             {'is_add': is_add,
1257              'external_addr': external_addr,
1258              'external_port': external_port,
1259              'protocol': protocol,
1260              'vrf_id': vrf_id,
1261              'local_num': local_num,
1262              'locals': locals})
1263
1264     def nat44_lb_static_mapping_dump(self):
1265         """Dump NAT44 load balancing static mappings
1266
1267         :return: Dictionary of NAT44 load balancing static mapping
1268         """
1269         return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1270
1271     def nat_det_add_del_map(
1272             self,
1273             in_addr,
1274             in_plen,
1275             out_addr,
1276             out_plen,
1277             is_add=1):
1278         """Add/delete deterministic NAT mapping
1279
1280         :param is_add - 1 if add, 0 if delete
1281         :param in_addr - inside IP address
1282         :param in_plen - inside IP address prefix length
1283         :param out_addr - outside IP address
1284         :param out_plen - outside IP address prefix length
1285         """
1286         return self.api(
1287             self.papi.nat_det_add_del_map,
1288             {'is_add': is_add,
1289              'is_nat44': 1,
1290              'in_addr': in_addr,
1291              'in_plen': in_plen,
1292              'out_addr': out_addr,
1293              'out_plen': out_plen})
1294
1295     def nat_det_forward(
1296             self,
1297             in_addr):
1298         """Get outside address and port range from inside address
1299
1300         :param in_addr - inside IP address
1301         """
1302         return self.api(
1303             self.papi.nat_det_forward,
1304             {'in_addr': in_addr,
1305              'is_nat44': 1})
1306
1307     def nat_det_reverse(
1308             self,
1309             out_addr,
1310             out_port):
1311         """Get inside address from outside address and port
1312
1313         :param out_addr - outside IP address
1314         :param out_port - outside port
1315         """
1316         return self.api(
1317             self.papi.nat_det_reverse,
1318             {'out_addr': out_addr,
1319              'out_port': out_port})
1320
1321     def nat_det_map_dump(self):
1322         """Dump deterministic NAT mappings
1323
1324         :return: Dictionary of deterministic NAT mappings
1325         """
1326         return self.api(self.papi.nat_det_map_dump, {})
1327
1328     def nat_det_set_timeouts(
1329             self,
1330             udp=300,
1331             tcp_established=7440,
1332             tcp_transitory=240,
1333             icmp=60):
1334         """Set values of timeouts for deterministic NAT (in seconds)
1335
1336         :param udp - UDP timeout (Default value = 300)
1337         :param tcp_established - TCP established timeout (Default value = 7440)
1338         :param tcp_transitory - TCP transitory timeout (Default value = 240)
1339         :param icmp - ICMP timeout (Default value = 60)
1340         """
1341         return self.api(
1342             self.papi.nat_det_set_timeouts,
1343             {'udp': udp,
1344              'tcp_established': tcp_established,
1345              'tcp_transitory': tcp_transitory,
1346              'icmp': icmp})
1347
1348     def nat_det_get_timeouts(self):
1349         """Get values of timeouts for deterministic NAT
1350
1351         :return: Timeouts for deterministic NAT (in seconds)
1352         """
1353         return self.api(self.papi.nat_det_get_timeouts, {})
1354
1355     def nat_det_close_session_out(
1356             self,
1357             out_addr,
1358             out_port,
1359             ext_addr,
1360             ext_port):
1361         """Close deterministic NAT session using outside address and port
1362
1363         :param out_addr - outside IP address
1364         :param out_port - outside port
1365         :param ext_addr - external host IP address
1366         :param ext_port - external host port
1367         """
1368         return self.api(
1369             self.papi.nat_det_close_session_out,
1370             {'out_addr': out_addr,
1371              'out_port': out_port,
1372              'ext_addr': ext_addr,
1373              'ext_port': ext_port})
1374
1375     def nat_det_close_session_in(
1376             self,
1377             in_addr,
1378             in_port,
1379             ext_addr,
1380             ext_port):
1381         """Close deterministic NAT session using inside address and port
1382
1383         :param in_addr - inside IP address
1384         :param in_port - inside port
1385         :param ext_addr - external host IP address
1386         :param ext_port - external host port
1387         """
1388         return self.api(
1389             self.papi.nat_det_close_session_in,
1390             {'in_addr': in_addr,
1391              'in_port': in_port,
1392              'ext_addr': ext_addr,
1393              'ext_port': ext_port,
1394              'is_nat44': 1})
1395
1396     def nat_det_session_dump(
1397             self,
1398             user_addr):
1399         """Dump deterministic NAT sessions belonging to a user
1400
1401         :param user_addr - inside IP address of the user
1402         :return: Dictionary of deterministic NAT sessions
1403         """
1404         return self.api(
1405             self.papi.nat_det_session_dump,
1406             {'is_nat44': 1,
1407              'user_addr': user_addr})
1408
1409     def nat64_add_del_pool_addr_range(
1410             self,
1411             start_addr,
1412             end_addr,
1413             vrf_id=0xFFFFFFFF,
1414             is_add=1):
1415         """Add/del address range to NAT64 pool
1416
1417         :param start_addr: First IP address
1418         :param end_addr: Last IP address
1419         :param vrf_id: VRF id for the address range
1420         :param is_add: 1 if add, 0 if delete (Default value = 1)
1421         """
1422         return self.api(
1423             self.papi.nat64_add_del_pool_addr_range,
1424             {'start_addr': start_addr,
1425              'end_addr': end_addr,
1426              'vrf_id': vrf_id,
1427              'is_add': is_add})
1428
1429     def nat64_pool_addr_dump(self):
1430         """Dump NAT64 pool addresses
1431         :return: Dictionary of NAT64 pool addresses
1432         """
1433         return self.api(self.papi.nat64_pool_addr_dump, {})
1434
1435     def nat64_add_del_interface(
1436             self,
1437             sw_if_index,
1438             is_inside=1,
1439             is_add=1):
1440         """Enable/disable NAT64 feature on the interface
1441            :param sw_if_index: Index of the interface
1442            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1443            :param is_add: 1 if add, 0 if delete (Default value = 1)
1444         """
1445         return self.api(
1446             self.papi.nat64_add_del_interface,
1447             {'sw_if_index': sw_if_index,
1448              'is_inside': is_inside,
1449              'is_add': is_add})
1450
1451     def nat64_interface_dump(self):
1452         """Dump interfaces with NAT64 feature
1453         :return: Dictionary of interfaces with NAT64 feature
1454         """
1455         return self.api(self.papi.nat64_interface_dump, {})
1456
1457     def nat64_add_del_static_bib(
1458             self,
1459             in_ip,
1460             out_ip,
1461             in_port,
1462             out_port,
1463             protocol,
1464             vrf_id=0,
1465             is_add=1):
1466         """Add/delete S-NAT static BIB entry
1467
1468         :param in_ip: Inside IPv6 address
1469         :param out_ip: Outside IPv4 address
1470         :param in_port: Inside port number
1471         :param out_port: Outside port number
1472         :param protocol: IP protocol
1473         :param vrf_id: VRF ID (Default value = 0)
1474         :param is_add: 1 if add, 0 if delete (Default value = 1)
1475         """
1476         return self.api(
1477             self.papi.nat64_add_del_static_bib,
1478             {'i_addr': in_ip,
1479              'o_addr': out_ip,
1480              'i_port': in_port,
1481              'o_port': out_port,
1482              'vrf_id': vrf_id,
1483              'proto': protocol,
1484              'is_add': is_add})
1485
1486     def nat64_bib_dump(self, protocol=255):
1487         """Dump NAT64 BIB
1488
1489         :param protocol: IP protocol (Default value = 255, all BIBs)
1490         :returns: Dictionary of NAT64 BIB entries
1491         """
1492         return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1493
1494     def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1495                            tcp_incoming_syn=6):
1496         """Set values of timeouts for NAT64 (in seconds)
1497
1498         :param udpi: UDP timeout (Default value = 300)
1499         :param icmp: ICMP timeout (Default value = 60)
1500         :param tcp_trans: TCP transitory timeout (Default value = 240)
1501         :param tcp_est: TCP established timeout (Default value = 7440)
1502         :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1503         """
1504         return self.api(
1505             self.papi.nat64_set_timeouts,
1506             {'udp': udp,
1507              'icmp': icmp,
1508              'tcp_trans': tcp_trans,
1509              'tcp_est': tcp_est,
1510              'tcp_incoming_syn': tcp_incoming_syn})
1511
1512     def nat64_get_timeouts(self):
1513         """Get values of timeouts for NAT64
1514
1515         :return: Timeouts for NAT64 (in seconds)
1516         """
1517         return self.api(self.papi.nat64_get_timeouts, {})
1518
1519     def nat64_st_dump(self, protocol=255):
1520         """Dump NAT64 session table
1521
1522         :param protocol: IP protocol (Default value = 255, all STs)
1523         :returns: Dictionary of NAT64 sesstion table entries
1524         """
1525         return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1526
1527     def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1528         """Add/del NAT64 prefix
1529
1530         :param prefix: NAT64 prefix
1531         :param plen: NAT64 prefix length
1532         :param vrf_id: VRF id of tenant (Default 0)
1533         :param is_add: 1 if add, 0 if delete (Default value = 1)
1534         """
1535         return self.api(
1536             self.papi.nat64_add_del_prefix,
1537             {'prefix': prefix,
1538              'prefix_len': plen,
1539              'vrf_id': vrf_id,
1540              'is_add': is_add})
1541
1542     def nat64_prefix_dump(self):
1543         """Dump NAT64 prefix
1544
1545         :returns: Dictionary of NAT64 prefixes
1546         """
1547         return self.api(self.papi.nat64_prefix_dump, {})
1548
1549     def control_ping(self):
1550         self.api(self.papi.control_ping)
1551
1552     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1553                     detect_mult, local_addr, peer_addr, is_ipv6=0,
1554                     bfd_key_id=None, conf_key_id=None):
1555         if bfd_key_id is None:
1556             return self.api(self.papi.bfd_udp_add,
1557                             {
1558                                 'sw_if_index': sw_if_index,
1559                                 'desired_min_tx': desired_min_tx,
1560                                 'required_min_rx': required_min_rx,
1561                                 'local_addr': local_addr,
1562                                 'peer_addr': peer_addr,
1563                                 'is_ipv6': is_ipv6,
1564                                 'detect_mult': detect_mult,
1565                             })
1566         else:
1567             return self.api(self.papi.bfd_udp_add,
1568                             {
1569                                 'sw_if_index': sw_if_index,
1570                                 'desired_min_tx': desired_min_tx,
1571                                 'required_min_rx': required_min_rx,
1572                                 'local_addr': local_addr,
1573                                 'peer_addr': peer_addr,
1574                                 'is_ipv6': is_ipv6,
1575                                 'detect_mult': detect_mult,
1576                                 'is_authenticated': 1,
1577                                 'bfd_key_id': bfd_key_id,
1578                                 'conf_key_id': conf_key_id,
1579                             })
1580
1581     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1582                     detect_mult, local_addr, peer_addr, is_ipv6=0):
1583         return self.api(self.papi.bfd_udp_mod,
1584                         {
1585                             'sw_if_index': sw_if_index,
1586                             'desired_min_tx': desired_min_tx,
1587                             'required_min_rx': required_min_rx,
1588                             'local_addr': local_addr,
1589                             'peer_addr': peer_addr,
1590                             'is_ipv6': is_ipv6,
1591                             'detect_mult': detect_mult,
1592                         })
1593
1594     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1595                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1596                               is_delayed=False):
1597         return self.api(self.papi.bfd_udp_auth_activate,
1598                         {
1599                             'sw_if_index': sw_if_index,
1600                             'local_addr': local_addr,
1601                             'peer_addr': peer_addr,
1602                             'is_ipv6': is_ipv6,
1603                             'is_delayed': 1 if is_delayed else 0,
1604                             'bfd_key_id': bfd_key_id,
1605                             'conf_key_id': conf_key_id,
1606                         })
1607
1608     def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1609                                 is_ipv6=0, is_delayed=False):
1610         return self.api(self.papi.bfd_udp_auth_deactivate,
1611                         {
1612                             'sw_if_index': sw_if_index,
1613                             'local_addr': local_addr,
1614                             'peer_addr': peer_addr,
1615                             'is_ipv6': is_ipv6,
1616                             'is_delayed': 1 if is_delayed else 0,
1617                         })
1618
1619     def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1620         return self.api(self.papi.bfd_udp_del,
1621                         {
1622                             'sw_if_index': sw_if_index,
1623                             'local_addr': local_addr,
1624                             'peer_addr': peer_addr,
1625                             'is_ipv6': is_ipv6,
1626                         })
1627
1628     def bfd_udp_session_dump(self):
1629         return self.api(self.papi.bfd_udp_session_dump, {})
1630
1631     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1632                                   peer_addr, is_ipv6=0):
1633         return self.api(self.papi.bfd_udp_session_set_flags, {
1634             'admin_up_down': admin_up_down,
1635             'sw_if_index': sw_if_index,
1636             'local_addr': local_addr,
1637             'peer_addr': peer_addr,
1638             'is_ipv6': is_ipv6,
1639         })
1640
1641     def want_bfd_events(self, enable_disable=1):
1642         return self.api(self.papi.want_bfd_events, {
1643             'enable_disable': enable_disable,
1644             'pid': os.getpid(),
1645         })
1646
1647     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1648         return self.api(self.papi.bfd_auth_set_key, {
1649             'conf_key_id': conf_key_id,
1650             'auth_type': auth_type,
1651             'key': key,
1652             'key_len': len(key),
1653         })
1654
1655     def bfd_auth_del_key(self, conf_key_id):
1656         return self.api(self.papi.bfd_auth_del_key, {
1657             'conf_key_id': conf_key_id,
1658         })
1659
1660     def bfd_auth_keys_dump(self):
1661         return self.api(self.papi.bfd_auth_keys_dump, {})
1662
1663     def bfd_udp_set_echo_source(self, sw_if_index):
1664         return self.api(self.papi.bfd_udp_set_echo_source,
1665                         {'sw_if_index': sw_if_index})
1666
1667     def bfd_udp_del_echo_source(self):
1668         return self.api(self.papi.bfd_udp_del_echo_source, {})
1669
1670     def classify_add_del_table(
1671             self,
1672             is_add,
1673             mask,
1674             match_n_vectors=1,
1675             table_index=0xFFFFFFFF,
1676             nbuckets=2,
1677             memory_size=2097152,
1678             skip_n_vectors=0,
1679             next_table_index=0xFFFFFFFF,
1680             miss_next_index=0xFFFFFFFF,
1681             current_data_flag=0,
1682             current_data_offset=0):
1683         """
1684         :param is_add:
1685         :param mask:
1686         :param match_n_vectors: (Default value = 1)
1687         :param table_index: (Default value = 0xFFFFFFFF)
1688         :param nbuckets:  (Default value = 2)
1689         :param memory_size:  (Default value = 2097152)
1690         :param skip_n_vectors:  (Default value = 0)
1691         :param next_table_index:  (Default value = 0xFFFFFFFF)
1692         :param miss_next_index:  (Default value = 0xFFFFFFFF)
1693         :param current_data_flag:  (Default value = 0)
1694         :param current_data_offset:  (Default value = 0)
1695         """
1696
1697         return self.api(
1698             self.papi.classify_add_del_table,
1699             {'is_add': is_add,
1700              'table_index': table_index,
1701              'nbuckets': nbuckets,
1702              'memory_size': memory_size,
1703              'skip_n_vectors': skip_n_vectors,
1704              'match_n_vectors': match_n_vectors,
1705              'next_table_index': next_table_index,
1706              'miss_next_index': miss_next_index,
1707              'current_data_flag': current_data_flag,
1708              'current_data_offset': current_data_offset,
1709              'mask': mask})
1710
1711     def classify_add_del_session(
1712             self,
1713             is_add,
1714             table_index,
1715             match,
1716             opaque_index=0xFFFFFFFF,
1717             hit_next_index=0xFFFFFFFF,
1718             advance=0,
1719             action=0,
1720             metadata=0):
1721         """
1722         :param is_add:
1723         :param table_index:
1724         :param match:
1725         :param opaque_index:  (Default value = 0xFFFFFFFF)
1726         :param hit_next_index:  (Default value = 0xFFFFFFFF)
1727         :param advance:  (Default value = 0)
1728         :param action:  (Default value = 0)
1729         :param metadata:  (Default value = 0)
1730         """
1731
1732         return self.api(
1733             self.papi.classify_add_del_session,
1734             {'is_add': is_add,
1735              'table_index': table_index,
1736              'hit_next_index': hit_next_index,
1737              'opaque_index': opaque_index,
1738              'advance': advance,
1739              'action': action,
1740              'metadata': metadata,
1741              'match': match})
1742
1743     def input_acl_set_interface(
1744             self,
1745             is_add,
1746             sw_if_index,
1747             ip4_table_index=0xFFFFFFFF,
1748             ip6_table_index=0xFFFFFFFF,
1749             l2_table_index=0xFFFFFFFF):
1750         """
1751         :param is_add:
1752         :param sw_if_index:
1753         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
1754         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
1755         :param l2_table_index:  (Default value = 0xFFFFFFFF)
1756         """
1757
1758         return self.api(
1759             self.papi.input_acl_set_interface,
1760             {'sw_if_index': sw_if_index,
1761              'ip4_table_index': ip4_table_index,
1762              'ip6_table_index': ip6_table_index,
1763              'l2_table_index': l2_table_index,
1764              'is_add': is_add})
1765
1766     def set_ipfix_exporter(
1767             self,
1768             collector_address,
1769             src_address,
1770             path_mtu,
1771             template_interval,
1772             vrf_id=0,
1773             collector_port=4739,
1774             udp_checksum=0):
1775         return self.api(
1776             self.papi.set_ipfix_exporter,
1777             {
1778                 'collector_address': collector_address,
1779                 'collector_port': collector_port,
1780                 'src_address': src_address,
1781                 'vrf_id': vrf_id,
1782                 'path_mtu': path_mtu,
1783                 'template_interval': template_interval,
1784                 'udp_checksum': udp_checksum,
1785             })
1786
1787     def dhcp_proxy_config(self,
1788                           dhcp_server,
1789                           dhcp_src_address,
1790                           rx_table_id=0,
1791                           server_table_id=0,
1792                           is_add=1,
1793                           is_ipv6=0):
1794         return self.api(
1795             self.papi.dhcp_proxy_config,
1796             {
1797                 'rx_vrf_id': rx_table_id,
1798                 'server_vrf_id': server_table_id,
1799                 'is_ipv6': is_ipv6,
1800                 'is_add': is_add,
1801                 'dhcp_server': dhcp_server,
1802                 'dhcp_src_address': dhcp_src_address,
1803             })
1804
1805     def dhcp_proxy_set_vss(self,
1806                            table_id,
1807                            fib_id,
1808                            oui,
1809                            is_add=1,
1810                            is_ip6=0):
1811         return self.api(
1812             self.papi.dhcp_proxy_set_vss,
1813             {
1814                 'tbl_id': table_id,
1815                 'fib_id': fib_id,
1816                 'is_ipv6': is_ip6,
1817                 'is_add': is_add,
1818                 'oui': oui,
1819             })
1820
1821     def dhcp_client(self,
1822                     sw_if_index,
1823                     hostname,
1824                     client_id='',
1825                     is_add=1,
1826                     want_dhcp_events=0):
1827         return self.api(
1828             self.papi.dhcp_client_config,
1829             {
1830                 'sw_if_index': sw_if_index,
1831                 'hostname': hostname,
1832                 'client_id': client_id,
1833                 'is_add': is_add,
1834                 'want_dhcp_event': want_dhcp_events,
1835                 'pid': os.getpid(),
1836             })
1837
1838     def ip_mroute_add_del(self,
1839                           src_address,
1840                           grp_address,
1841                           grp_address_length,
1842                           e_flags,
1843                           next_hop_sw_if_index,
1844                           i_flags,
1845                           rpf_id=0,
1846                           table_id=0,
1847                           create_vrf_if_needed=0,
1848                           is_add=1,
1849                           is_ipv6=0,
1850                           is_local=0):
1851         """
1852         """
1853         return self.api(
1854             self.papi.ip_mroute_add_del,
1855             {'next_hop_sw_if_index': next_hop_sw_if_index,
1856              'entry_flags': e_flags,
1857              'itf_flags': i_flags,
1858              'table_id': table_id,
1859              'rpf_id': rpf_id,
1860              'create_vrf_if_needed': create_vrf_if_needed,
1861              'is_add': is_add,
1862              'is_ipv6': is_ipv6,
1863              'is_local': is_local,
1864              'grp_address_length': grp_address_length,
1865              'grp_address': grp_address,
1866              'src_address': src_address})
1867
1868     def mfib_signal_dump(self):
1869         return self.api(self.papi.mfib_signal_dump, {})
1870
1871     def ip_mfib_dump(self):
1872         return self.api(self.papi.ip_mfib_dump, {})
1873
1874     def lisp_enable_disable(self, is_enabled):
1875         return self.api(
1876             self.papi.lisp_enable_disable,
1877             {
1878                 'is_en': is_enabled,
1879             })
1880
1881     def lisp_locator_set(self,
1882                          ls_name,
1883                          is_add=1):
1884         return self.api(
1885             self.papi.lisp_add_del_locator_set,
1886             {
1887                 'is_add': is_add,
1888                 'locator_set_name': ls_name
1889             })
1890
1891     def lisp_locator_set_dump(self):
1892         return self.api(self.papi.lisp_locator_set_dump, {})
1893
1894     def lisp_locator(self,
1895                      ls_name,
1896                      sw_if_index,
1897                      priority=1,
1898                      weight=1,
1899                      is_add=1):
1900         return self.api(
1901             self.papi.lisp_add_del_locator,
1902             {
1903                 'is_add': is_add,
1904                 'locator_set_name': ls_name,
1905                 'sw_if_index': sw_if_index,
1906                 'priority': priority,
1907                 'weight': weight
1908             })
1909
1910     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1911         return self.api(
1912             self.papi.lisp_locator_dump,
1913             {
1914                 'is_index_set': is_index_set,
1915                 'ls_name': ls_name,
1916                 'ls_index': ls_index,
1917             })
1918
1919     def lisp_local_mapping(self,
1920                            ls_name,
1921                            eid_type,
1922                            eid,
1923                            prefix_len,
1924                            vni=0,
1925                            key_id=0,
1926                            key="",
1927                            is_add=1):
1928         return self.api(
1929             self.papi.lisp_add_del_local_eid,
1930             {
1931                 'locator_set_name': ls_name,
1932                 'is_add': is_add,
1933                 'eid_type': eid_type,
1934                 'eid': eid,
1935                 'prefix_len': prefix_len,
1936                 'vni': vni,
1937                 'key_id': key_id,
1938                 'key': key
1939             })
1940
1941     def lisp_eid_table_dump(self,
1942                             eid_set=0,
1943                             prefix_length=0,
1944                             vni=0,
1945                             eid_type=0,
1946                             eid=None,
1947                             filter_opt=0):
1948         return self.api(
1949             self.papi.lisp_eid_table_dump,
1950             {
1951                 'eid_set': eid_set,
1952                 'prefix_length': prefix_length,
1953                 'vni': vni,
1954                 'eid_type': eid_type,
1955                 'eid': eid,
1956                 'filter': filter_opt,
1957             })
1958
1959     def lisp_remote_mapping(self,
1960                             eid_type,
1961                             eid,
1962                             eid_prefix_len=0,
1963                             vni=0,
1964                             rlocs=None,
1965                             rlocs_num=0,
1966                             is_src_dst=0,
1967                             is_add=1):
1968         return self.api(
1969             self.papi.lisp_add_del_remote_mapping,
1970             {
1971                 'is_add': is_add,
1972                 'eid_type': eid_type,
1973                 'eid': eid,
1974                 'eid_len': eid_prefix_len,
1975                 'rloc_num': rlocs_num,
1976                 'rlocs': rlocs,
1977                 'vni': vni,
1978                 'is_src_dst': is_src_dst,
1979             })
1980
1981     def lisp_adjacency(self,
1982                        leid,
1983                        reid,
1984                        leid_len,
1985                        reid_len,
1986                        eid_type,
1987                        is_add=1,
1988                        vni=0):
1989         return self.api(
1990             self.papi.lisp_add_del_adjacency,
1991             {
1992                 'is_add': is_add,
1993                 'vni': vni,
1994                 'eid_type': eid_type,
1995                 'leid': leid,
1996                 'reid': reid,
1997                 'leid_len': leid_len,
1998                 'reid_len': reid_len,
1999             })
2000
2001     def lisp_adjacencies_get(self, vni=0):
2002         return self.api(
2003             self.papi.lisp_adjacencies_get,
2004             {
2005                 'vni': vni
2006             })
2007
2008     def map_add_domain(self,
2009                        ip6_prefix,
2010                        ip6_prefix_len,
2011                        ip6_src,
2012                        ip6_src_prefix_len,
2013                        ip4_prefix,
2014                        ip4_prefix_len,
2015                        ea_bits_len=0,
2016                        psid_offset=0,
2017                        psid_length=0,
2018                        is_translation=0,
2019                        mtu=1280):
2020         return self.api(
2021             self.papi.map_add_domain,
2022             {
2023                 'ip6_prefix': ip6_prefix,
2024                 'ip6_prefix_len': ip6_prefix_len,
2025                 'ip4_prefix': ip4_prefix,
2026                 'ip4_prefix_len': ip4_prefix_len,
2027                 'ip6_src': ip6_src,
2028                 'ip6_src_prefix_len': ip6_src_prefix_len,
2029                 'ea_bits_len': ea_bits_len,
2030                 'psid_offset': psid_offset,
2031                 'psid_length': psid_length,
2032                 'is_translation': is_translation,
2033                 'mtu': mtu
2034             })
2035
2036     def gtpu_add_del_tunnel(
2037             self,
2038             src_addr,
2039             dst_addr,
2040             is_add=1,
2041             is_ipv6=0,
2042             mcast_sw_if_index=0xFFFFFFFF,
2043             encap_vrf_id=0,
2044             decap_next_index=0xFFFFFFFF,
2045             teid=0):
2046         """
2047
2048         :param is_add:  (Default value = 1)
2049         :param is_ipv6:  (Default value = 0)
2050         :param src_addr:
2051         :param dst_addr:
2052         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2053         :param encap_vrf_id:  (Default value = 0)
2054         :param decap_next_index:  (Default value = 0xFFFFFFFF)
2055         :param teid:  (Default value = 0)
2056
2057         """
2058         return self.api(self.papi.gtpu_add_del_tunnel,
2059                         {'is_add': is_add,
2060                          'is_ipv6': is_ipv6,
2061                          'src_address': src_addr,
2062                          'dst_address': dst_addr,
2063                          'mcast_sw_if_index': mcast_sw_if_index,
2064                          'encap_vrf_id': encap_vrf_id,
2065                          'decap_next_index': decap_next_index,
2066                          'teid': teid})
2067
2068     def vxlan_gpe_add_del_tunnel(
2069             self,
2070             src_addr,
2071             dst_addr,
2072             mcast_sw_if_index=0xFFFFFFFF,
2073             is_add=1,
2074             is_ipv6=0,
2075             encap_vrf_id=0,
2076             decap_vrf_id=0,
2077             protocol=3,
2078             vni=0):
2079         """
2080
2081         :param local:
2082         :param remote:
2083         :param is_add:  (Default value = 1)
2084         :param is_ipv6:  (Default value = 0)
2085         :param encap_vrf_id:  (Default value = 0)
2086         :param decap_vrf_id:  (Default value = 0)
2087         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2088         :param protocol:  (Default value = 3)
2089         :param vni:  (Default value = 0)
2090
2091         """
2092         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2093                         {'is_add': is_add,
2094                          'is_ipv6': is_ipv6,
2095                          'local': src_addr,
2096                          'remote': dst_addr,
2097                          'mcast_sw_if_index': mcast_sw_if_index,
2098                          'encap_vrf_id': encap_vrf_id,
2099                          'decap_vrf_id': decap_vrf_id,
2100                          'protocol': protocol,
2101                          'vni': vni})
2102
2103     def pppoe_add_del_session(
2104             self,
2105             client_ip,
2106             client_mac,
2107             session_id=0,
2108             is_add=1,
2109             is_ipv6=0,
2110             decap_vrf_id=0):
2111         """
2112
2113         :param is_add:  (Default value = 1)
2114         :param is_ipv6:  (Default value = 0)
2115         :param client_ip:
2116         :param session_id:  (Default value = 0)
2117         :param client_mac:
2118         :param decap_vrf_id:  (Default value = 0)
2119
2120         """
2121         return self.api(self.papi.pppoe_add_del_session,
2122                         {'is_add': is_add,
2123                          'is_ipv6': is_ipv6,
2124                          'session_id': session_id,
2125                          'client_ip': client_ip,
2126                          'decap_vrf_id': decap_vrf_id,
2127                          'client_mac': client_mac})
2128
2129     def sr_localsid_add_del(self,
2130                             localsid_addr,
2131                             behavior,
2132                             nh_addr,
2133                             is_del=0,
2134                             end_psp=0,
2135                             sw_if_index=0xFFFFFFFF,
2136                             vlan_index=0,
2137                             fib_table=0,
2138                             ):
2139         """ Add/del IPv6 SR local-SID.
2140
2141         :param localsid_addr:
2142         :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2143         :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2144         :param nh_addr:
2145         :param is_del:  (Default value = 0)
2146         :param end_psp: (Default value = 0)
2147         :param sw_if_index: (Default value = 0xFFFFFFFF)
2148         :param vlan_index:  (Default value = 0)
2149         :param fib_table:   (Default value = 0)
2150         """
2151         return self.api(
2152             self.papi.sr_localsid_add_del,
2153             {'is_del': is_del,
2154              'localsid_addr': localsid_addr,
2155              'end_psp': end_psp,
2156              'behavior': behavior,
2157              'sw_if_index': sw_if_index,
2158              'vlan_index': vlan_index,
2159              'fib_table': fib_table,
2160              'nh_addr': nh_addr
2161              }
2162         )
2163
2164     def sr_policy_add(
2165             self,
2166             bsid_addr,
2167             weight=1,
2168             is_encap=1,
2169             type=0,
2170             fib_table=0,
2171             n_segments=0,
2172             segments=[]):
2173         """
2174         :param bsid_addr: bindingSID of the SR Policy
2175         :param weight: weight of the sid list. optional. (default: 1)
2176         :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2177             (default: Encap)
2178         :param type: type/behavior of the SR policy. (default or spray) \
2179             (default: default)
2180         :param fib_table: VRF where to install the FIB entry for the BSID \
2181             (default: 0)
2182         :param n_segments: number of segments \
2183             (default: 0)
2184         :param segments: a vector of IPv6 address composing the segment list \
2185             (default: [])
2186         """
2187         return self.api(
2188             self.papi.sr_policy_add,
2189             {'bsid_addr': bsid_addr,
2190              'weight': weight,
2191              'is_encap': is_encap,
2192              'type': type,
2193              'fib_table': fib_table,
2194              'n_segments': n_segments,
2195              'segments': segments
2196              }
2197         )
2198
2199     def sr_policy_del(
2200             self,
2201             bsid_addr,
2202             sr_policy_index=0):
2203         """
2204         :param bsid: bindingSID of the SR Policy
2205         :param sr_policy_index: index of the sr policy (default: 0)
2206         """
2207         return self.api(
2208             self.papi.sr_policy_del,
2209             {'bsid_addr': bsid_addr,
2210              'sr_policy_index': sr_policy_index
2211              })
2212
2213     def sr_steering_add_del(
2214             self,
2215             is_del,
2216             bsid_addr,
2217             sr_policy_index,
2218             table_id,
2219             prefix_addr,
2220             mask_width,
2221             sw_if_index,
2222             traffic_type):
2223         """
2224         Steer traffic L2 and L3 traffic through a given SR policy
2225
2226         :param is_del: delete or add
2227         :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2228         :param sr_policy: is the index of the SR Policy (alt to bsid)
2229         :param table_id: is the VRF where to install the FIB entry for the BSID
2230         :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2231         :param mask_width: is the mask for L3 traffic type
2232         :param sw_if_index: is the incoming interface for L2 traffic
2233         :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2234         """
2235         return self.api(
2236             self.papi.sr_steering_add_del,
2237             {'is_del': is_del,
2238              'bsid_addr': bsid_addr,
2239              'sr_policy_index': sr_policy_index,
2240              'table_id': table_id,
2241              'prefix_addr': prefix_addr,
2242              'mask_width': mask_width,
2243              'sw_if_index': sw_if_index,
2244              'traffic_type': traffic_type
2245              })
2246
2247     def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2248         """ Add MACIP acl
2249
2250         :param rules: list of rules for given acl
2251         :param tag: acl tag
2252         """
2253
2254         # return self.api(self.papi.macip_acl_add_replace,
2255         #                 {'acl_index': acl_index,
2256         #                  'r': rules,
2257         #                  'count': len(rules),
2258         #                  'tag': tag})
2259         return self.api(self.papi.macip_acl_add,
2260                         {'r': rules,
2261                          'count': len(rules),
2262                          'tag': tag})
2263
2264     def macip_acl_del(self, acl_index):
2265         """
2266
2267         :param acl_index:
2268         :return:
2269         """
2270         return self.api(self.papi.macip_acl_del,
2271                         {'acl_index': acl_index})
2272
2273     def macip_acl_interface_add_del(self,
2274                                     sw_if_index,
2275                                     acl_index,
2276                                     is_add=1):
2277         """ Add MACIP acl to interface
2278
2279         :param sw_if_index:
2280         :param acl_index:
2281         :param is_add:  (Default value = 1)
2282         """
2283
2284         return self.api(self.papi.macip_acl_interface_add_del,
2285                         {'is_add': is_add,
2286                          'sw_if_index': sw_if_index,
2287                          'acl_index': acl_index})
2288
2289     def macip_acl_interface_get(self):
2290         """ Return interface acls dump
2291         """
2292         return self.api(
2293             self.papi.macip_acl_interface_get, {})
2294
2295     def macip_acl_dump(self, acl_index=4294967295):
2296         """ Return MACIP acl dump
2297         """
2298
2299         return self.api(
2300             self.papi.macip_acl_dump, {'acl_index': acl_index})