test/vpp_papi_provider.py

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