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