test/vpp_papi_provider.py

   1 import os
   2 import fnmatch
   3 import time
   4 from hook import Hook
   5 from collections import deque
   6
   7 # Sphinx creates auto-generated documentation by importing the python source
   8 # files and collecting the docstrings from them. The NO_VPP_PAPI flag allows
   9 # the vpp_papi_provider.py file to be importable without having to build
  10 # the whole vpp api if the user only wishes to generate the test documentation.
  11 do_import = True
  12 try:
  13     no_vpp_papi = os.getenv("NO_VPP_PAPI")
  14     if no_vpp_papi == "1":
  15         do_import = False
  16 except:
  17     pass
  18
  19 if do_import:
  20     from vpp_papi import VPP
  21
  22 # from vnet/vnet/mpls/mpls_types.h
  23 MPLS_IETF_MAX_LABEL = 0xfffff
  24 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
  25
  26
  27 class L2_VTR_OP:
  28     L2_DISABLED = 0
  29     L2_PUSH_1 = 1
  30     L2_PUSH_2 = 2
  31     L2_POP_1 = 3
  32     L2_POP_2 = 4
  33     L2_TRANSLATE_1_1 = 5
  34     L2_TRANSLATE_1_2 = 6
  35     L2_TRANSLATE_2_1 = 7
  36     L2_TRANSLATE_2_2 = 8
  37
  38
  39 class UnexpectedApiReturnValueError(Exception):
  40     """ exception raised when the API return value is unexpected """
  41     pass
  42
  43
  44 class VppPapiProvider(object):
  45     """VPP-api provider using vpp-papi
  46
  47     @property hook: hook object providing before and after api/cli hooks
  48     """
  49
  50     _zero, _negative = range(2)
  51
  52     def __init__(self, name, shm_prefix, test_class):
  53         self.hook = Hook("vpp-papi-provider")
  54         self.name = name
  55         self.shm_prefix = shm_prefix
  56         self.test_class = test_class
  57         self._expect_api_retval = self._zero
  58         self._expect_stack = []
  59         jsonfiles = []
  60
  61         install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
  62         for root, dirnames, filenames in os.walk(install_dir):
  63             for filename in fnmatch.filter(filenames, '*.api.json'):
  64                 jsonfiles.append(os.path.join(root, filename))
  65
  66         self.vpp = VPP(jsonfiles, logger=test_class.logger)
  67         self._events = deque()
  68
  69     def __enter__(self):
  70         return self
  71
  72     def expect_negative_api_retval(self):
  73         """ Expect API failure """
  74         self._expect_stack.append(self._expect_api_retval)
  75         self._expect_api_retval = self._negative
  76         return self
  77
  78     def expect_zero_api_retval(self):
  79         """ Expect API success """
  80         self._expect_stack.append(self._expect_api_retval)
  81         self._expect_api_retval = self._zero
  82         return self
  83
  84     def __exit__(self, exc_type, exc_value, traceback):
  85         self._expect_api_retval = self._expect_stack.pop()
  86
  87     def register_hook(self, hook):
  88         """Replace hook registration with new hook
  89
  90         :param hook:
  91
  92         """
  93         self.hook = hook
  94
  95     def collect_events(self):
  96         """ Collect all events from the internal queue and clear the queue. """
  97         e = self._events
  98         self._events = deque()
  99         return e
 100
 101     def wait_for_event(self, timeout, name=None):
 102         """ Wait for and return next event. """
 103         if name:
 104             self.test_class.logger.debug("Expecting event '%s' within %ss",
 105                                          name, timeout)
 106         else:
 107             self.test_class.logger.debug("Expecting event within %ss",
 108                                          timeout)
 109         if self._events:
 110             self.test_class.logger.debug("Not waiting, event already queued")
 111         limit = time.time() + timeout
 112         while time.time() < limit:
 113             if self._events:
 114                 e = self._events.popleft()
 115                 if name and type(e).__name__ != name:
 116                     raise Exception(
 117                         "Unexpected event received: %s, expected: %s" %
 118                         (type(e).__name__, name))
 119                 self.test_class.logger.debug("Returning event %s:%s" %
 120                                              (name, e))
 121                 return e
 122             time.sleep(0)  # yield
 123         raise Exception("Event did not occur within timeout")
 124
 125     def __call__(self, name, event):
 126         """ Enqueue event in the internal event queue. """
 127         # FIXME use the name instead of relying on type(e).__name__ ?
 128         # FIXME #2 if this throws, it is eaten silently, Ole?
 129         self.test_class.logger.debug("New event: %s: %s" % (name, event))
 130         self._events.append(event)
 131
 132     def connect(self):
 133         """Connect the API to VPP"""
 134         self.vpp.connect(self.name, self.shm_prefix)
 135         self.papi = self.vpp.api
 136         self.vpp.register_event_callback(self)
 137
 138     def disconnect(self):
 139         """Disconnect the API from VPP"""
 140         self.vpp.disconnect()
 141
 142     def api(self, api_fn, api_args, expected_retval=0):
 143         """ Call API function and check it's return value.
 144         Call the appropriate hooks before and after the API call
 145
 146         :param api_fn: API function to call
 147         :param api_args: tuple of API function arguments
 148         :param expected_retval: Expected return value (Default value = 0)
 149         :returns: reply from the API
 150
 151         """
 152         self.hook.before_api(api_fn.__name__, api_args)
 153         reply = api_fn(**api_args)
 154         if self._expect_api_retval == self._negative:
 155             if hasattr(reply, 'retval') and reply.retval >= 0:
 156                 msg = "API call passed unexpectedly: expected negative "\
 157                     "return value instead of %d in %s" % \
 158                     (reply.retval, repr(reply))
 159                 self.test_class.logger.info(msg)
 160                 raise UnexpectedApiReturnValueError(msg)
 161         elif self._expect_api_retval == self._zero:
 162             if hasattr(reply, 'retval') and reply.retval != expected_retval:
 163                 msg = "API call failed, expected %d return value instead "\
 164                     "of %d in %s" % (expected_retval, reply.retval,
 165                                      repr(reply))
 166                 self.test_class.logger.info(msg)
 167                 raise UnexpectedApiReturnValueError(msg)
 168         else:
 169             raise Exception("Internal error, unexpected value for "
 170                             "self._expect_api_retval %s" %
 171                             self._expect_api_retval)
 172         self.hook.after_api(api_fn.__name__, api_args)
 173         return reply
 174
 175     def cli(self, cli):
 176         """ Execute a CLI, calling the before/after hooks appropriately.
 177
 178         :param cli: CLI to execute
 179         :returns: CLI output
 180
 181         """
 182         self.hook.before_cli(cli)
 183         cli += '\n'
 184         r = self.papi.cli_inband(length=len(cli), cmd=cli)
 185         self.hook.after_cli(cli)
 186         if hasattr(r, 'reply'):
 187             return r.reply.decode().rstrip('\x00')
 188
 189     def ppcli(self, cli):
 190         """ Helper method to print CLI command in case of info logging level.
 191
 192         :param cli: CLI to execute
 193         :returns: CLI output
 194         """
 195         return cli + "\n" + str(self.cli(cli))
 196
 197     def _convert_mac(self, mac):
 198         return mac.replace(':', '').decode('hex')
 199
 200     def show_version(self):
 201         """ """
 202         return self.api(self.papi.show_version, {})
 203
 204     def pg_create_interface(self, pg_index):
 205         """
 206
 207         :param pg_index:
 208
 209         """
 210         return self.api(self.papi.pg_create_interface,
 211                         {"interface_id": pg_index})
 212
 213     def sw_interface_dump(self, filter=None):
 214         """
 215
 216         :param filter:  (Default value = None)
 217
 218         """
 219         if filter is not None:
 220             args = {"name_filter_valid": 1, "name_filter": filter}
 221         else:
 222             args = {}
 223         return self.api(self.papi.sw_interface_dump, args)
 224
 225     def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
 226         """ Set the IPvX Table-id for the Interface
 227
 228         :param sw_if_index:
 229         :param is_ipv6:
 230         :param table_id:
 231
 232         """
 233         return self.api(self.papi.sw_interface_set_table,
 234                         {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
 235                          'vrf_id': table_id})
 236
 237     def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
 238                                      is_ipv6=0, is_add=1, del_all=0):
 239         """
 240
 241         :param addr: param is_ipv6:  (Default value = 0)
 242         :param sw_if_index:
 243         :param addr_len:
 244         :param is_ipv6:  (Default value = 0)
 245         :param is_add:  (Default value = 1)
 246         :param del_all:  (Default value = 0)
 247
 248         """
 249         return self.api(self.papi.sw_interface_add_del_address,
 250                         {'sw_if_index': sw_if_index,
 251                          'is_add': is_add,
 252                          'is_ipv6': is_ipv6,
 253                          'del_all': del_all,
 254                          'address_length': addr_len,
 255                          'address': addr})
 256
 257     def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
 258                                     is_add=1):
 259         """ Set the Interface to be unnumbered
 260
 261         :param is_add:  (Default value = 1)
 262         :param sw_if_index - interface That will be unnumbered
 263         :param ip_sw_if_index - interface with an IP addres
 264
 265         """
 266         return self.api(self.papi.sw_interface_set_unnumbered,
 267                         {'sw_if_index': ip_sw_if_index,
 268                          'unnumbered_sw_if_index': sw_if_index,
 269                          'is_add': is_add})
 270
 271     def sw_interface_enable_disable_mpls(self, sw_if_index,
 272                                          is_enable=1):
 273         """
 274         Enable/Disable MPLS on the interface
 275         :param sw_if_index:
 276         :param is_enable:  (Default value = 1)
 277
 278         """
 279         return self.api(self.papi.sw_interface_set_mpls_enable,
 280                         {'sw_if_index': sw_if_index,
 281                          'enable': is_enable})
 282
 283     def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
 284         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 285                         {'sw_if_index': sw_if_index,
 286                          'suppress': suppress})
 287
 288     def set_ip_flow_hash(self,
 289                          table_id,
 290                          src=1,
 291                          dst=1,
 292                          sport=1,
 293                          dport=1,
 294                          proto=1,
 295                          reverse=0,
 296                          is_ip6=0):
 297         return self.api(self.papi.set_ip_flow_hash,
 298                         {'vrf_id': table_id,
 299                          'src': src,
 300                          'dst': dst,
 301                          'dport': dport,
 302                          'sport': sport,
 303                          'proto': proto,
 304                          'reverse': reverse,
 305                          'is_ipv6': is_ip6})
 306
 307     def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
 308         return self.api(self.papi.ip6nd_proxy_add_del,
 309                         {'address': address,
 310                          'sw_if_index': sw_if_index,
 311                          'is_del': is_del})
 312
 313     def ip6_sw_interface_ra_config(self, sw_if_index,
 314                                    no,
 315                                    suppress,
 316                                    send_unicast):
 317         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 318                         {'sw_if_index': sw_if_index,
 319                          'is_no': no,
 320                          'suppress': suppress,
 321                          'send_unicast': send_unicast})
 322
 323     def ip6_sw_interface_ra_prefix(self,
 324                                    sw_if_index,
 325                                    address,
 326                                    address_length,
 327                                    use_default=0,
 328                                    no_advertise=0,
 329                                    off_link=0,
 330                                    no_autoconfig=0,
 331                                    no_onlink=0,
 332                                    is_no=0,
 333                                    val_lifetime=0xffffffff,
 334                                    pref_lifetime=0xffffffff):
 335         return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
 336                         {'sw_if_index': sw_if_index,
 337                          'address': address,
 338                          'address_length': address_length,
 339                          'use_default': use_default,
 340                          'no_advertise': no_advertise,
 341                          'off_link': off_link,
 342                          'no_autoconfig': no_autoconfig,
 343                          'no_onlink': no_onlink,
 344                          'is_no': is_no,
 345                          'val_lifetime': val_lifetime,
 346                          'pref_lifetime': pref_lifetime})
 347
 348     def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
 349         """
 350         Enable/Disable An interface for IPv6
 351         """
 352         return self.api(self.papi.sw_interface_ip6_enable_disable,
 353                         {'sw_if_index': sw_if_index,
 354                          'enable': enable})
 355
 356     def vxlan_add_del_tunnel(
 357             self,
 358             src_addr,
 359             dst_addr,
 360             mcast_sw_if_index=0xFFFFFFFF,
 361             is_add=1,
 362             is_ipv6=0,
 363             encap_vrf_id=0,
 364             decap_next_index=0xFFFFFFFF,
 365             vni=0):
 366         """
 367
 368         :param dst_addr:
 369         :param src_addr:
 370         :param is_add:  (Default value = 1)
 371         :param is_ipv6:  (Default value = 0)
 372         :param encap_vrf_id:  (Default value = 0)
 373         :param decap_next_index:  (Default value = 0xFFFFFFFF)
 374         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 375         :param vni:  (Default value = 0)
 376
 377         """
 378         return self.api(self.papi.vxlan_add_del_tunnel,
 379                         {'is_add': is_add,
 380                          'is_ipv6': is_ipv6,
 381                          'src_address': src_addr,
 382                          'dst_address': dst_addr,
 383                          'mcast_sw_if_index': mcast_sw_if_index,
 384                          'encap_vrf_id': encap_vrf_id,
 385                          'decap_next_index': decap_next_index,
 386                          'vni': vni})
 387
 388     def geneve_add_del_tunnel(
 389             self,
 390             local_addr,
 391             remote_addr,
 392             mcast_sw_if_index=0xFFFFFFFF,
 393             is_add=1,
 394             is_ipv6=0,
 395             encap_vrf_id=0,
 396             decap_next_index=0xFFFFFFFF,
 397             vni=0):
 398         """
 399
 400         :param remote_addr:
 401         :param local_addr:
 402         :param is_add:  (Default value = 1)
 403         :param is_ipv6:  (Default value = 0)
 404         :param encap_vrf_id:  (Default value = 0)
 405         :param decap_next_index:  (Default value = 0xFFFFFFFF)
 406         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 407         :param vni:  (Default value = 0)
 408
 409         """
 410         return self.api(self.papi.geneve_add_del_tunnel,
 411                         {'is_add': is_add,
 412                          'is_ipv6': is_ipv6,
 413                          'local_address': local_addr,
 414                          'remote_address': remote_addr,
 415                          'mcast_sw_if_index': mcast_sw_if_index,
 416                          'encap_vrf_id': encap_vrf_id,
 417                          'decap_next_index': decap_next_index,
 418                          'vni': vni})
 419
 420     def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
 421                               learn=1, arp_term=0, is_add=1):
 422         """Create/delete bridge domain.
 423
 424         :param int bd_id: Bridge domain index.
 425         :param int flood: Enable/disable bcast/mcast flooding in the BD.
 426             (Default value = 1)
 427         :param int uu_flood: Enable/disable unknown unicast flood in the BD.
 428             (Default value = 1)
 429         :param int forward: Enable/disable forwarding on all interfaces in
 430             the BD. (Default value = 1)
 431         :param int learn: Enable/disable learning on all interfaces in the BD.
 432             (Default value = 1)
 433         :param int arp_term: Enable/disable arp termination in the BD.
 434             (Default value = 1)
 435         :param int is_add: Add or delete flag. (Default value = 1)
 436         """
 437         return self.api(self.papi.bridge_domain_add_del,
 438                         {'bd_id': bd_id,
 439                          'flood': flood,
 440                          'uu_flood': uu_flood,
 441                          'forward': forward,
 442                          'learn': learn,
 443                          'arp_term': arp_term,
 444                          'is_add': is_add})
 445
 446     def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
 447         return self.api(self.papi.bd_ip_mac_add_del,
 448                         {'bd_id': bd_id,
 449                          'is_add': is_add,
 450                          'is_ipv6': is_ipv6,
 451                          'ip_address': ip,
 452                          'mac_address': mac})
 453
 454     def want_ip4_arp_events(self, enable_disable=1, address=0):
 455         return self.api(self.papi.want_ip4_arp_events,
 456                         {'enable_disable': enable_disable,
 457                          'address': address,
 458                          'pid': os.getpid(), })
 459
 460     def want_ip6_nd_events(self, enable_disable=1, address=0):
 461         return self.api(self.papi.want_ip6_nd_events,
 462                         {'enable_disable': enable_disable,
 463                          'address': address,
 464                          'pid': os.getpid(), })
 465
 466     def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
 467                                max_macs_in_event=0, learn_limit=0):
 468         return self.api(self.papi.want_l2_macs_events,
 469                         {'enable_disable': enable_disable,
 470                          'scan_delay': scan_delay,
 471                          'max_macs_in_event': max_macs_in_event,
 472                          'learn_limit': learn_limit,
 473                          'pid': os.getpid(), })
 474
 475     def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
 476                       filter_mac=0, bvi_mac=0):
 477         """Create/delete L2 FIB entry.
 478
 479         :param str mac: MAC address to create FIB entry for.
 480         :param int bd_id: Bridge domain index.
 481         :param int sw_if_index: Software interface index of the interface.
 482         :param int is_add: Add or delete flag. (Default value = 1)
 483         :param int static_mac: Set to 1 to create static MAC entry.
 484             (Default value = 0)
 485         :param int filter_mac: Set to 1 to drop packet that's source or
 486             destination MAC address contains defined MAC address.
 487             (Default value = 0)
 488         :param int bvi_mac: Set to 1 to create entry that points to BVI
 489             interface. (Default value = 0)
 490         """
 491         return self.api(self.papi.l2fib_add_del,
 492                         {'mac': self._convert_mac(mac),
 493                          'bd_id': bd_id,
 494                          'sw_if_index': sw_if_index,
 495                          'is_add': is_add,
 496                          'static_mac': static_mac,
 497                          'filter_mac': filter_mac,
 498                          'bvi_mac': bvi_mac})
 499
 500     def l2fib_flush_int(self, sw_if_index):
 501         """Flush L2 FIB entries for sw_if_index.
 502
 503         :param int sw_if_index: Software interface index of the interface.
 504         """
 505         return self.api(self.papi.l2fib_flush_int,
 506                         {'sw_if_index': sw_if_index})
 507
 508     def l2fib_flush_bd(self, bd_id):
 509         """Flush L2 FIB entries for bd_id.
 510
 511         :param int sw_if_index: Bridge Domain id.
 512         """
 513         return self.api(self.papi.l2fib_flush_bd,
 514                         {'bd_id': bd_id})
 515
 516     def l2fib_flush_all(self):
 517         """Flush all L2 FIB.
 518         """
 519         return self.api(self.papi.l2fib_flush_all, {})
 520
 521     def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
 522                                    shg=0, bvi=0, enable=1):
 523         """Add/remove interface to/from bridge domain.
 524
 525         :param int sw_if_index: Software interface index of the interface.
 526         :param int bd_id: Bridge domain index.
 527         :param int shg: Split-horizon group index. (Default value = 0)
 528         :param int bvi: Set interface as a bridge group virtual interface.
 529             (Default value = 0)
 530         :param int enable: Add or remove interface. (Default value = 1)
 531         """
 532         return self.api(self.papi.sw_interface_set_l2_bridge,
 533                         {'rx_sw_if_index': sw_if_index,
 534                          'bd_id': bd_id,
 535                          'shg': shg,
 536                          'bvi': bvi,
 537                          'enable': enable})
 538
 539     def bridge_flags(self, bd_id, is_set, feature_bitmap):
 540         """Enable/disable required feature of the bridge domain with defined ID.
 541
 542         :param int bd_id: Bridge domain ID.
 543         :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
 544         :param int feature_bitmap: Bitmap value of the feature to be set:
 545             - learn (1 << 0),
 546             - forward (1 << 1),
 547             - flood (1 << 2),
 548             - uu-flood (1 << 3) or
 549             - arp-term (1 << 4).
 550         """
 551         return self.api(self.papi.bridge_flags,
 552                         {'bd_id': bd_id,
 553                          'is_set': is_set,
 554                          'feature_bitmap': feature_bitmap})
 555
 556     def bridge_domain_dump(self, bd_id=0):
 557         """
 558
 559         :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
 560             existing bridge domains returned)
 561         :return: Dictionary of bridge domain(s) data.
 562         """
 563         return self.api(self.papi.bridge_domain_dump,
 564                         {'bd_id': bd_id})
 565
 566     def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
 567                                      enable):
 568         """Create or delete unidirectional cross-connect from Tx interface to
 569         Rx interface.
 570
 571         :param int rx_sw_if_index: Software interface index of Rx interface.
 572         :param int tx_sw_if_index: Software interface index of Tx interface.
 573         :param int enable: Create cross-connect if equal to 1, delete
 574             cross-connect if equal to 0.
 575
 576         """
 577         return self.api(self.papi.sw_interface_set_l2_xconnect,
 578                         {'rx_sw_if_index': rx_sw_if_index,
 579                          'tx_sw_if_index': tx_sw_if_index,
 580                          'enable': enable})
 581
 582     def sw_interface_set_l2_tag_rewrite(
 583             self,
 584             sw_if_index,
 585             vtr_oper,
 586             push=0,
 587             tag1=0,
 588             tag2=0):
 589         """L2 interface vlan tag rewrite configure request
 590         :param client_index - opaque cookie to identify the sender
 591         :param context - sender context, to match reply w/ request
 592         :param sw_if_index - interface the operation is applied to
 593         :param vtr_op - Choose from l2_vtr_op_t enum values
 594         :param push_dot1q - first pushed flag dot1q id set, else dot1ad
 595         :param tag1 - Needed for any push or translate vtr op
 596         :param tag2 - Needed for any push 2 or translate x-2 vtr ops
 597
 598         """
 599         return self.api(self.papi.l2_interface_vlan_tag_rewrite,
 600                         {'sw_if_index': sw_if_index,
 601                          'vtr_op': vtr_oper,
 602                          'push_dot1q': push,
 603                          'tag1': tag1,
 604                          'tag2': tag2})
 605
 606     def sw_interface_set_l2_emulation(
 607             self,
 608             sw_if_index,
 609             enable=1):
 610         """L2 Emulation
 611         :param sw_if_index - interface the operation is applied to
 612
 613         """
 614         return self.api(self.papi.l2_emulation,
 615                         {'sw_if_index': sw_if_index,
 616                          'enable': enable})
 617
 618     def sw_interface_set_flags(self, sw_if_index, admin_up_down):
 619         """
 620
 621         :param admin_up_down:
 622         :param sw_if_index:
 623
 624         """
 625         return self.api(self.papi.sw_interface_set_flags,
 626                         {'sw_if_index': sw_if_index,
 627                          'admin_up_down': admin_up_down})
 628
 629     def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
 630                      no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
 631                      default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
 632         """Create subinterface
 633         from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
 634
 635         :param sub_id: param inner_vlan:
 636         :param sw_if_index:
 637         :param outer_vlan:
 638         :param inner_vlan:
 639         :param no_tags:  (Default value = 0)
 640         :param one_tag:  (Default value = 0)
 641         :param two_tags:  (Default value = 0)
 642         :param dot1ad:  (Default value = 0)
 643         :param exact_match:  (Default value = 0)
 644         :param default_sub:  (Default value = 0)
 645         :param outer_vlan_id_any:  (Default value = 0)
 646         :param inner_vlan_id_any:  (Default value = 0)
 647
 648         """
 649         return self.api(
 650             self.papi.create_subif,
 651             {'sw_if_index': sw_if_index,
 652              'sub_id': sub_id,
 653              'no_tags': no_tags,
 654              'one_tag': one_tag,
 655              'two_tags': two_tags,
 656              'dot1ad': dot1ad,
 657              'exact_match': exact_match,
 658              'default_sub': default_sub,
 659              'outer_vlan_id_any': outer_vlan_id_any,
 660              'inner_vlan_id_any': inner_vlan_id_any,
 661              'outer_vlan_id': outer_vlan,
 662              'inner_vlan_id': inner_vlan})
 663
 664     def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
 665         """Create p2p ethernet subinterface
 666
 667         :param sw_if_index: main (parent) interface
 668         :param remote_mac: client (remote) mac address
 669
 670         """
 671         return self.api(
 672             self.papi.p2p_ethernet_add,
 673             {'parent_if_index': sw_if_index,
 674              'remote_mac': remote_mac,
 675              'subif_id': subif_id})
 676
 677     def delete_subif(self, sw_if_index):
 678         """Delete subinterface
 679
 680         :param sw_if_index:
 681         """
 682         return self.api(self.papi.delete_subif,
 683                         {'sw_if_index': sw_if_index})
 684
 685     def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
 686         """Delete p2p ethernet subinterface
 687
 688         :param sw_if_index: main (parent) interface
 689         :param remote_mac: client (remote) mac address
 690
 691         """
 692         return self.api(
 693             self.papi.p2p_ethernet_del,
 694             {'parent_if_index': sw_if_index,
 695              'remote_mac': remote_mac})
 696
 697     def create_vlan_subif(self, sw_if_index, vlan):
 698         """
 699
 700         :param vlan:
 701         :param sw_if_index:
 702
 703         """
 704         return self.api(self.papi.create_vlan_subif,
 705                         {'sw_if_index': sw_if_index,
 706                          'vlan_id': vlan})
 707
 708     def create_loopback(self, mac=''):
 709         """
 710
 711         :param mac: (Optional)
 712         """
 713         return self.api(self.papi.create_loopback,
 714                         {'mac_address': mac})
 715
 716     def delete_loopback(self, sw_if_index):
 717         return self.api(self.papi.delete_loopback,
 718                         {'sw_if_index': sw_if_index, })
 719
 720     def ip_table_add_del(self,
 721                          table_id,
 722                          is_add=1,
 723                          is_ipv6=0):
 724         """
 725
 726         :param table_id
 727         :param is_add:  (Default value = 1)
 728         :param is_ipv6:  (Default value = 0)
 729
 730         """
 731
 732         return self.api(
 733             self.papi.ip_table_add_del,
 734             {'table_id': table_id,
 735              'is_add': is_add,
 736              'is_ipv6': is_ipv6})
 737
 738     def ip_add_del_route(
 739             self,
 740             dst_address,
 741             dst_address_length,
 742             next_hop_address,
 743             next_hop_sw_if_index=0xFFFFFFFF,
 744             table_id=0,
 745             next_hop_table_id=0,
 746             next_hop_weight=1,
 747             next_hop_n_out_labels=0,
 748             next_hop_out_label_stack=[],
 749             next_hop_via_label=MPLS_LABEL_INVALID,
 750             next_hop_id=0xFFFFFFFF,
 751             is_resolve_host=0,
 752             is_resolve_attached=0,
 753             classify_table_index=0xFFFFFFFF,
 754             is_add=1,
 755             is_drop=0,
 756             is_unreach=0,
 757             is_prohibit=0,
 758             is_ipv6=0,
 759             is_local=0,
 760             is_classify=0,
 761             is_multipath=0,
 762             is_dvr=0,
 763             is_udp_encap=0,
 764             is_source_lookup=0):
 765         """
 766
 767         :param dst_address_length:
 768         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 769         :param dst_address:
 770         :param next_hop_address:
 771         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 772         :param vrf_id:  (Default value = 0)
 773         :param lookup_in_vrf:  (Default value = 0)
 774         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 775         :param is_add:  (Default value = 1)
 776         :param is_drop:  (Default value = 0)
 777         :param is_ipv6:  (Default value = 0)
 778         :param is_local:  (Default value = 0)
 779         :param is_classify:  (Default value = 0)
 780         :param is_multipath:  (Default value = 0)
 781         :param is_resolve_host:  (Default value = 0)
 782         :param is_resolve_attached:  (Default value = 0)
 783         :param is_dvr:  (Default value = 0)
 784         :param is_source_lookup:  (Default value = 0)
 785         :param next_hop_weight:  (Default value = 1)
 786
 787         """
 788
 789         return self.api(
 790             self.papi.ip_add_del_route,
 791             {'next_hop_sw_if_index': next_hop_sw_if_index,
 792              'table_id': table_id,
 793              'classify_table_index': classify_table_index,
 794              'next_hop_table_id': next_hop_table_id,
 795              'is_add': is_add,
 796              'is_drop': is_drop,
 797              'is_unreach': is_unreach,
 798              'is_prohibit': is_prohibit,
 799              'is_ipv6': is_ipv6,
 800              'is_local': is_local,
 801              'is_classify': is_classify,
 802              'is_multipath': is_multipath,
 803              'is_resolve_host': is_resolve_host,
 804              'is_resolve_attached': is_resolve_attached,
 805              'is_dvr': is_dvr,
 806              'is_source_lookup': is_source_lookup,
 807              'is_udp_encap': is_udp_encap,
 808              'next_hop_weight': next_hop_weight,
 809              'dst_address_length': dst_address_length,
 810              'dst_address': dst_address,
 811              'next_hop_id': next_hop_id,
 812              'next_hop_address': next_hop_address,
 813              'next_hop_n_out_labels': next_hop_n_out_labels,
 814              'next_hop_via_label': next_hop_via_label,
 815              'next_hop_out_label_stack': next_hop_out_label_stack})
 816
 817     def ip_fib_dump(self):
 818         return self.api(self.papi.ip_fib_dump, {})
 819
 820     def ip6_fib_dump(self):
 821         return self.api(self.papi.ip6_fib_dump, {})
 822
 823     def ip_neighbor_add_del(self,
 824                             sw_if_index,
 825                             mac_address,
 826                             dst_address,
 827                             is_add=1,
 828                             is_ipv6=0,
 829                             is_static=0,
 830                             is_no_adj_fib=0,
 831                             ):
 832         """ Add neighbor MAC to IPv4 or IPv6 address.
 833
 834         :param sw_if_index:
 835         :param mac_address:
 836         :param dst_address:
 837         :param is_add:  (Default value = 1)
 838         :param is_ipv6:  (Default value = 0)
 839         :param is_static:  (Default value = 0)
 840         :param is_no_adj_fib:  (Default value = 0)
 841         """
 842
 843         return self.api(
 844             self.papi.ip_neighbor_add_del,
 845             {'sw_if_index': sw_if_index,
 846              'is_add': is_add,
 847              'is_ipv6': is_ipv6,
 848              'is_static': is_static,
 849              'is_no_adj_fib': is_no_adj_fib,
 850              'mac_address': mac_address,
 851              'dst_address': dst_address
 852              }
 853         )
 854
 855     def ip_neighbor_dump(self,
 856                          sw_if_index,
 857                          is_ipv6=0):
 858         """ Return IP neighbor dump.
 859
 860         :param sw_if_index:
 861         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 862         """
 863
 864         return self.api(
 865             self.papi.ip_neighbor_dump,
 866             {'is_ipv6': is_ipv6,
 867              'sw_if_index': sw_if_index
 868              }
 869         )
 870
 871     def proxy_arp_add_del(self,
 872                           low_address,
 873                           hi_address,
 874                           vrf_id=0,
 875                           is_add=1):
 876         """ Config Proxy Arp Range.
 877
 878         :param low_address: Start address in the rnage to Proxy for
 879         :param hi_address: End address in the rnage to Proxy for
 880         :param vrf_id: The VRF/table in which to proxy
 881         """
 882
 883         return self.api(
 884             self.papi.proxy_arp_add_del,
 885             {'vrf_id': vrf_id,
 886              'is_add': is_add,
 887              'low_address': low_address,
 888              'hi_address': hi_address,
 889              }
 890         )
 891
 892     def proxy_arp_intfc_enable_disable(self,
 893                                        sw_if_index,
 894                                        is_enable=1):
 895         """ Enable/Disable an interface for proxy ARP requests
 896
 897         :param sw_if_index: Interface
 898         :param enable_disable: Enable/Disable
 899         """
 900
 901         return self.api(
 902             self.papi.proxy_arp_intfc_enable_disable,
 903             {'sw_if_index': sw_if_index,
 904              'enable_disable': is_enable
 905              }
 906         )
 907
 908     def reset_vrf(self,
 909                   vrf_id,
 910                   is_ipv6=0,
 911                   ):
 912         """ Reset VRF (remove all routes etc.) request.
 913
 914         :param int vrf_id: ID of the FIB table / VRF to reset.
 915         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 916         """
 917
 918         return self.api(
 919             self.papi.reset_vrf,
 920             {'vrf_id': vrf_id,
 921              'is_ipv6': is_ipv6,
 922              }
 923         )
 924
 925     def reset_fib(self,
 926                   vrf_id,
 927                   is_ipv6=0,
 928                   ):
 929         """ Reset VRF (remove all routes etc.) request.
 930
 931         :param int vrf_id: ID of the FIB table / VRF to reset.
 932         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 933         """
 934
 935         return self.api(
 936             self.papi.reset_fib,
 937             {'vrf_id': vrf_id,
 938              'is_ipv6': is_ipv6,
 939              }
 940         )
 941
 942     def ip_dump(self,
 943                 is_ipv6=0,
 944                 ):
 945         """ Return IP dump.
 946
 947         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 948         """
 949
 950         return self.api(
 951             self.papi.ip_dump,
 952             {'is_ipv6': is_ipv6,
 953              }
 954         )
 955
 956     def sw_interface_span_enable_disable(
 957             self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
 958         """
 959
 960         :param sw_if_index_from:
 961         :param sw_if_index_to:
 962         :param state:
 963         :param is_l2:
 964         """
 965         return self.api(self.papi.sw_interface_span_enable_disable,
 966                         {'sw_if_index_from': sw_if_index_from,
 967                          'sw_if_index_to': sw_if_index_to,
 968                          'state': state,
 969                          'is_l2': is_l2,
 970                          })
 971
 972     def gre_tunnel_add_del(self,
 973                            src_address,
 974                            dst_address,
 975                            outer_fib_id=0,
 976                            is_teb=0,
 977                            is_add=1,
 978                            is_ip6=0):
 979         """ Add a GRE tunnel
 980
 981         :param src_address:
 982         :param dst_address:
 983         :param outer_fib_id:  (Default value = 0)
 984         :param is_add:  (Default value = 1)
 985         :param is_ipv6:  (Default value = 0)
 986         :param is_teb:  (Default value = 0)
 987         """
 988
 989         return self.api(
 990             self.papi.gre_add_del_tunnel,
 991             {'is_add': is_add,
 992              'is_ipv6': is_ip6,
 993              'teb': is_teb,
 994              'src_address': src_address,
 995              'dst_address': dst_address,
 996              'outer_fib_id': outer_fib_id}
 997         )
 998
 999     def udp_encap_add_del(self,
1000                           id,
1001                           src_ip,
1002                           dst_ip,
1003                           src_port,
1004                           dst_port,
1005                           table_id=0,
1006                           is_add=1,
1007                           is_ip6=0):
1008         """ Add a GRE tunnel
1009         :param id: user provided ID
1010         :param src_ip:
1011         :param dst_ip:
1012         :param src_port:
1013         :param dst_port:
1014         :param outer_fib_id:  (Default value = 0)
1015         :param is_add:  (Default value = 1)
1016         :param is_ipv6:  (Default value = 0)
1017         """
1018
1019         return self.api(
1020             self.papi.udp_encap_add_del,
1021             {'id': id,
1022              'is_add': is_add,
1023              'is_ip6': is_ip6,
1024              'src_ip': src_ip,
1025              'dst_ip': dst_ip,
1026              'src_port': src_port,
1027              'dst_port': dst_port,
1028              'table_id': table_id}
1029         )
1030
1031     def udp_encap_dump(self):
1032         return self.api(self.papi.udp_encap_dump, {})
1033
1034     def mpls_fib_dump(self):
1035         return self.api(self.papi.mpls_fib_dump, {})
1036
1037     def mpls_table_add_del(
1038             self,
1039             table_id,
1040             is_add=1):
1041         """
1042
1043         :param table_id
1044         :param is_add:  (Default value = 1)
1045
1046         """
1047
1048         return self.api(
1049             self.papi.mpls_table_add_del,
1050             {'mt_table_id': table_id,
1051              'mt_is_add': is_add})
1052
1053     def mpls_route_add_del(
1054             self,
1055             label,
1056             eos,
1057             next_hop_proto,
1058             next_hop_address,
1059             next_hop_sw_if_index=0xFFFFFFFF,
1060             table_id=0,
1061             next_hop_table_id=0,
1062             next_hop_weight=1,
1063             next_hop_n_out_labels=0,
1064             next_hop_out_label_stack=[],
1065             next_hop_via_label=MPLS_LABEL_INVALID,
1066             is_resolve_host=0,
1067             is_resolve_attached=0,
1068             is_interface_rx=0,
1069             is_rpf_id=0,
1070             is_multicast=0,
1071             is_add=1,
1072             is_drop=0,
1073             is_multipath=0,
1074             classify_table_index=0xFFFFFFFF,
1075             is_classify=0):
1076         """
1077
1078         :param dst_address_length:
1079         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1080         :param dst_address:
1081         :param next_hop_address:
1082         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1083         :param vrf_id:  (Default value = 0)
1084         :param lookup_in_vrf:  (Default value = 0)
1085         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1086         :param is_add:  (Default value = 1)
1087         :param is_drop:  (Default value = 0)
1088         :param is_ipv6:  (Default value = 0)
1089         :param is_local:  (Default value = 0)
1090         :param is_classify:  (Default value = 0)
1091         :param is_multipath:  (Default value = 0)
1092         :param is_multicast:  (Default value = 0)
1093         :param is_resolve_host:  (Default value = 0)
1094         :param is_resolve_attached:  (Default value = 0)
1095         :param next_hop_weight:  (Default value = 1)
1096
1097         """
1098
1099         return self.api(
1100             self.papi.mpls_route_add_del,
1101             {'mr_label': label,
1102              'mr_eos': eos,
1103              'mr_table_id': table_id,
1104              'mr_classify_table_index': classify_table_index,
1105              'mr_is_add': is_add,
1106              'mr_is_classify': is_classify,
1107              'mr_is_multipath': is_multipath,
1108              'mr_is_multicast': is_multicast,
1109              'mr_is_resolve_host': is_resolve_host,
1110              'mr_is_resolve_attached': is_resolve_attached,
1111              'mr_is_interface_rx': is_interface_rx,
1112              'mr_is_rpf_id': is_rpf_id,
1113              'mr_next_hop_proto': next_hop_proto,
1114              'mr_next_hop_weight': next_hop_weight,
1115              'mr_next_hop': next_hop_address,
1116              'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1117              'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1118              'mr_next_hop_table_id': next_hop_table_id,
1119              'mr_next_hop_via_label': next_hop_via_label,
1120              'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1121
1122     def mpls_ip_bind_unbind(
1123             self,
1124             label,
1125             dst_address,
1126             dst_address_length,
1127             table_id=0,
1128             ip_table_id=0,
1129             is_ip4=1,
1130             is_bind=1):
1131         """
1132         """
1133         return self.api(
1134             self.papi.mpls_ip_bind_unbind,
1135             {'mb_mpls_table_id': table_id,
1136              'mb_label': label,
1137              'mb_ip_table_id': ip_table_id,
1138              'mb_is_bind': is_bind,
1139              'mb_is_ip4': is_ip4,
1140              'mb_address_length': dst_address_length,
1141              'mb_address': dst_address})
1142
1143     def mpls_tunnel_add_del(
1144             self,
1145             tun_sw_if_index,
1146             next_hop_proto_is_ip4,
1147             next_hop_address,
1148             next_hop_sw_if_index=0xFFFFFFFF,
1149             next_hop_table_id=0,
1150             next_hop_weight=1,
1151             next_hop_n_out_labels=0,
1152             next_hop_out_label_stack=[],
1153             next_hop_via_label=MPLS_LABEL_INVALID,
1154             is_add=1,
1155             l2_only=0,
1156             is_multicast=0):
1157         """
1158
1159         :param dst_address_length:
1160         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1161         :param dst_address:
1162         :param next_hop_address:
1163         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1164         :param vrf_id:  (Default value = 0)
1165         :param lookup_in_vrf:  (Default value = 0)
1166         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1167         :param is_add:  (Default value = 1)
1168         :param is_drop:  (Default value = 0)
1169         :param is_ipv6:  (Default value = 0)
1170         :param is_local:  (Default value = 0)
1171         :param is_classify:  (Default value = 0)
1172         :param is_multipath:  (Default value = 0)
1173         :param is_resolve_host:  (Default value = 0)
1174         :param is_resolve_attached:  (Default value = 0)
1175         :param next_hop_weight:  (Default value = 1)
1176         :param is_multicast:  (Default value = 0)
1177
1178         """
1179         return self.api(
1180             self.papi.mpls_tunnel_add_del,
1181             {'mt_sw_if_index': tun_sw_if_index,
1182              'mt_is_add': is_add,
1183              'mt_l2_only': l2_only,
1184              'mt_is_multicast': is_multicast,
1185              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1186              'mt_next_hop_weight': next_hop_weight,
1187              'mt_next_hop': next_hop_address,
1188              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1189              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1190              'mt_next_hop_table_id': next_hop_table_id,
1191              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1192
1193     def nat44_interface_add_del_feature(
1194             self,
1195             sw_if_index,
1196             is_inside=1,
1197             is_add=1):
1198         """Enable/disable NAT44 feature on the interface
1199
1200         :param sw_if_index: Software index of the interface
1201         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1202         :param is_add: 1 if add, 0 if delete (Default value = 1)
1203         """
1204         return self.api(
1205             self.papi.nat44_interface_add_del_feature,
1206             {'is_add': is_add,
1207              'is_inside': is_inside,
1208              'sw_if_index': sw_if_index})
1209
1210     def nat44_interface_add_del_output_feature(
1211             self,
1212             sw_if_index,
1213             is_inside=1,
1214             is_add=1):
1215         """Enable/disable NAT44 output feature on the interface
1216
1217         :param sw_if_index: Software index of the interface
1218         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1219         :param is_add: 1 if add, 0 if delete (Default value = 1)
1220         """
1221         return self.api(
1222             self.papi.nat44_interface_add_del_output_feature,
1223             {'is_add': is_add,
1224              'is_inside': is_inside,
1225              'sw_if_index': sw_if_index})
1226
1227     def nat44_add_del_static_mapping(
1228             self,
1229             local_ip,
1230             external_ip=0,
1231             external_sw_if_index=0xFFFFFFFF,
1232             local_port=0,
1233             external_port=0,
1234             addr_only=1,
1235             vrf_id=0,
1236             protocol=0,
1237             twice_nat=0,
1238             out2in_only=0,
1239             is_add=1):
1240         """Add/delete NAT44 static mapping
1241
1242         :param local_ip: Local IP address
1243         :param external_ip: External IP address
1244         :param external_sw_if_index: External interface instead of IP address
1245         :param local_port: Local port number (Default value = 0)
1246         :param external_port: External port number (Default value = 0)
1247         :param addr_only: 1 if address only mapping, 0 if address and port
1248         :param vrf_id: VRF ID
1249         :param protocol: IP protocol (Default value = 0)
1250         :param twice_nat: 1 if translate external host address and port
1251         :param out2in_only: if 1 rule is matching only out2in direction
1252         :param is_add: 1 if add, 0 if delete (Default value = 1)
1253         """
1254         return self.api(
1255             self.papi.nat44_add_del_static_mapping,
1256             {'is_add': is_add,
1257              'addr_only': addr_only,
1258              'local_ip_address': local_ip,
1259              'external_ip_address': external_ip,
1260              'local_port': local_port,
1261              'external_port': external_port,
1262              'external_sw_if_index': external_sw_if_index,
1263              'vrf_id': vrf_id,
1264              'protocol': protocol,
1265              'twice_nat': twice_nat,
1266              'out2in_only': out2in_only})
1267
1268     def nat44_add_del_identity_mapping(
1269             self,
1270             ip='0',
1271             sw_if_index=0xFFFFFFFF,
1272             port=0,
1273             addr_only=1,
1274             vrf_id=0,
1275             protocol=0,
1276             is_add=1):
1277         """Add/delete NAT44 identity mapping
1278
1279         :param ip: IP address (Default value = 0)
1280         :param sw_if_index: Interface instead of IP address
1281         :param port: Port number (Default value = 0)
1282         :param addr_only: 1 if address only mapping, 0 if address and port
1283         :param vrf_id: VRF ID
1284         :param protocol: IP protocol (Default value = 0)
1285         :param is_add: 1 if add, 0 if delete (Default value = 1)
1286         """
1287         return self.api(
1288             self.papi.nat44_add_del_identity_mapping,
1289             {'is_add': is_add,
1290              'addr_only': addr_only,
1291              'ip_address': ip,
1292              'port': port,
1293              'sw_if_index': sw_if_index,
1294              'vrf_id': vrf_id,
1295              'protocol': protocol})
1296
1297     def nat44_add_del_address_range(
1298             self,
1299             first_ip_address,
1300             last_ip_address,
1301             is_add=1,
1302             vrf_id=0xFFFFFFFF,
1303             twice_nat=0):
1304         """Add/del NAT44 address range
1305
1306         :param first_ip_address: First IP address
1307         :param last_ip_address: Last IP address
1308         :param vrf_id: VRF id for the address range
1309         :param twice_nat: twice NAT address for extenal hosts
1310         :param is_add: 1 if add, 0 if delete (Default value = 1)
1311         """
1312         return self.api(
1313             self.papi.nat44_add_del_address_range,
1314             {'first_ip_address': first_ip_address,
1315              'last_ip_address': last_ip_address,
1316              'vrf_id': vrf_id,
1317              'twice_nat': twice_nat,
1318              'is_add': is_add})
1319
1320     def nat44_address_dump(self):
1321         """Dump NAT44 addresses
1322         :return: Dictionary of NAT44 addresses
1323         """
1324         return self.api(self.papi.nat44_address_dump, {})
1325
1326     def nat44_interface_dump(self):
1327         """Dump interfaces with NAT44 feature
1328         :return: Dictionary of interfaces with NAT44 feature
1329         """
1330         return self.api(self.papi.nat44_interface_dump, {})
1331
1332     def nat44_interface_output_feature_dump(self):
1333         """Dump interfaces with NAT44 output feature
1334         :return: Dictionary of interfaces with NAT44 output feature
1335         """
1336         return self.api(self.papi.nat44_interface_output_feature_dump, {})
1337
1338     def nat44_static_mapping_dump(self):
1339         """Dump NAT44 static mappings
1340         :return: Dictionary of NAT44 static mappings
1341         """
1342         return self.api(self.papi.nat44_static_mapping_dump, {})
1343
1344     def nat44_identity_mapping_dump(self):
1345         """Dump NAT44 identity mappings
1346         :return: Dictionary of NAT44 identity mappings
1347         """
1348         return self.api(self.papi.nat44_identity_mapping_dump, {})
1349
1350     def nat_show_config(self):
1351         """Show NAT plugin config
1352         :return: NAT plugin config parameters
1353         """
1354         return self.api(self.papi.nat_show_config, {})
1355
1356     def nat44_add_interface_addr(
1357             self,
1358             sw_if_index,
1359             twice_nat=0,
1360             is_add=1):
1361         """Add/del NAT44 address from interface
1362
1363         :param sw_if_index: Software index of the interface
1364         :param twice_nat: twice NAT address for extenal hosts
1365         :param is_add: 1 if add, 0 if delete (Default value = 1)
1366         """
1367         return self.api(
1368             self.papi.nat44_add_del_interface_addr,
1369             {'is_add': is_add,
1370              'sw_if_index': sw_if_index,
1371              'twice_nat': twice_nat})
1372
1373     def nat44_interface_addr_dump(self):
1374         """Dump NAT44 addresses interfaces
1375         :return: Dictionary of NAT44 addresses interfaces
1376         """
1377         return self.api(self.papi.nat44_interface_addr_dump, {})
1378
1379     def nat_ipfix(
1380             self,
1381             domain_id=1,
1382             src_port=4739,
1383             enable=1):
1384         """Enable/disable NAT IPFIX logging
1385
1386         :param domain_id: Observation domain ID (Default value = 1)
1387         :param src_port: Source port number (Default value = 4739)
1388         :param enable: 1 if enable, 0 if disable (Default value = 1)
1389         """
1390         return self.api(
1391             self.papi.nat_ipfix_enable_disable,
1392             {'domain_id': domain_id,
1393              'src_port': src_port,
1394              'enable': enable})
1395
1396     def nat44_user_session_dump(
1397             self,
1398             ip_address,
1399             vrf_id):
1400         """Dump NAT44 user's sessions
1401
1402         :param ip_address: ip adress of the user to be dumped
1403         :param cpu_index: cpu_index on which the user is
1404         :param vrf_id: VRF ID
1405         :return: Dictionary of S-NAT sessions
1406         """
1407         return self.api(
1408             self.papi.nat44_user_session_dump,
1409             {'ip_address': ip_address,
1410              'vrf_id': vrf_id})
1411
1412     def nat44_user_dump(self):
1413         """Dump NAT44 users
1414
1415         :return: Dictionary of NAT44 users
1416         """
1417         return self.api(self.papi.nat44_user_dump, {})
1418
1419     def nat44_add_del_lb_static_mapping(
1420             self,
1421             external_addr,
1422             external_port,
1423             protocol,
1424             vrf_id=0,
1425             twice_nat=0,
1426             out2in_only=0,
1427             local_num=0,
1428             locals=[],
1429             is_add=1):
1430         """Add/delete NAT44 load balancing static mapping
1431
1432         :param twice_nat: 1 if translate external host address and port
1433         :param is_add - 1 if add, 0 if delete
1434         """
1435         return self.api(
1436             self.papi.nat44_add_del_lb_static_mapping,
1437             {'is_add': is_add,
1438              'external_addr': external_addr,
1439              'external_port': external_port,
1440              'protocol': protocol,
1441              'vrf_id': vrf_id,
1442              'twice_nat': twice_nat,
1443              'out2in_only': out2in_only,
1444              'local_num': local_num,
1445              'locals': locals})
1446
1447     def nat44_lb_static_mapping_dump(self):
1448         """Dump NAT44 load balancing static mappings
1449
1450         :return: Dictionary of NAT44 load balancing static mapping
1451         """
1452         return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1453
1454     def nat44_del_session(
1455             self,
1456             addr,
1457             port,
1458             protocol,
1459             vrf_id=0,
1460             is_in=1):
1461         """Delete NAT44 session
1462
1463         :param addr: IPv4 address
1464         :param por: port number
1465         :param protocol: IP protocol number
1466         :param vrf_id: VRF ID
1467         :param is_in: 1 if inside network addres and port pari, 0 if outside
1468         """
1469         return self.api(
1470             self.papi.nat44_del_session,
1471             {'address': addr,
1472              'port': port,
1473              'protocol': protocol,
1474              'vrf_id': vrf_id,
1475              'is_in': is_in})
1476
1477     def nat44_forwarding_enable_disable(
1478             self,
1479             enable):
1480         """Enable/disable forwarding for NAT44
1481
1482         :param enable: 1 for enable, 0 for disable
1483         """
1484         return self.api(
1485             self.papi.nat44_forwarding_enable_disable,
1486             {'enable': enable})
1487
1488     def nat_set_reass(
1489             self,
1490             timeout=2,
1491             max_reass=1024,
1492             max_frag=5,
1493             drop_frag=0,
1494             is_ip6=0):
1495         """Set NAT virtual fragmentation reassembly
1496
1497         :param timeout: reassembly timeout (Default 2sec)
1498         :param max_reass: maximum concurrent reassemblies (Default 1024)
1499         :param max_frag: maximum fragmets per reassembly (Default 5)
1500         :param drop_frag: if 0 translate fragments, otherwise drop fragments
1501         :param is_ip6: 1 if IPv6, 0 if IPv4
1502         """
1503         return self.api(
1504             self.papi.nat_set_reass,
1505             {'timeout': timeout,
1506              'max_reass': max_reass,
1507              'max_frag': max_frag,
1508              'drop_frag': drop_frag,
1509              'is_ip6': is_ip6})
1510
1511     def nat_get_reass(self):
1512         """Get NAT virtual fragmentation reassembly configuration
1513
1514         :return: NAT virtual fragmentation reassembly configuration
1515         """
1516         return self.api(self.papi.nat_get_reass, {})
1517
1518     def nat_reass_dump(self):
1519         """Dump NAT virtual fragmentation reassemblies
1520
1521         :return: Dictionary of NAT virtual fragmentation reassemblies
1522         """
1523         return self.api(self.papi.nat_reass_dump, {})
1524
1525     def nat_det_add_del_map(
1526             self,
1527             in_addr,
1528             in_plen,
1529             out_addr,
1530             out_plen,
1531             is_add=1):
1532         """Add/delete deterministic NAT mapping
1533
1534         :param is_add - 1 if add, 0 if delete
1535         :param in_addr - inside IP address
1536         :param in_plen - inside IP address prefix length
1537         :param out_addr - outside IP address
1538         :param out_plen - outside IP address prefix length
1539         """
1540         return self.api(
1541             self.papi.nat_det_add_del_map,
1542             {'is_add': is_add,
1543              'is_nat44': 1,
1544              'in_addr': in_addr,
1545              'in_plen': in_plen,
1546              'out_addr': out_addr,
1547              'out_plen': out_plen})
1548
1549     def nat_det_forward(
1550             self,
1551             in_addr):
1552         """Get outside address and port range from inside address
1553
1554         :param in_addr - inside IP address
1555         """
1556         return self.api(
1557             self.papi.nat_det_forward,
1558             {'in_addr': in_addr,
1559              'is_nat44': 1})
1560
1561     def nat_det_reverse(
1562             self,
1563             out_addr,
1564             out_port):
1565         """Get inside address from outside address and port
1566
1567         :param out_addr - outside IP address
1568         :param out_port - outside port
1569         """
1570         return self.api(
1571             self.papi.nat_det_reverse,
1572             {'out_addr': out_addr,
1573              'out_port': out_port})
1574
1575     def nat_det_map_dump(self):
1576         """Dump deterministic NAT mappings
1577
1578         :return: Dictionary of deterministic NAT mappings
1579         """
1580         return self.api(self.papi.nat_det_map_dump, {})
1581
1582     def nat_det_set_timeouts(
1583             self,
1584             udp=300,
1585             tcp_established=7440,
1586             tcp_transitory=240,
1587             icmp=60):
1588         """Set values of timeouts for deterministic NAT (in seconds)
1589
1590         :param udp - UDP timeout (Default value = 300)
1591         :param tcp_established - TCP established timeout (Default value = 7440)
1592         :param tcp_transitory - TCP transitory timeout (Default value = 240)
1593         :param icmp - ICMP timeout (Default value = 60)
1594         """
1595         return self.api(
1596             self.papi.nat_det_set_timeouts,
1597             {'udp': udp,
1598              'tcp_established': tcp_established,
1599              'tcp_transitory': tcp_transitory,
1600              'icmp': icmp})
1601
1602     def nat_det_get_timeouts(self):
1603         """Get values of timeouts for deterministic NAT
1604
1605         :return: Timeouts for deterministic NAT (in seconds)
1606         """
1607         return self.api(self.papi.nat_det_get_timeouts, {})
1608
1609     def nat_det_close_session_out(
1610             self,
1611             out_addr,
1612             out_port,
1613             ext_addr,
1614             ext_port):
1615         """Close deterministic NAT session using outside address and port
1616
1617         :param out_addr - outside IP address
1618         :param out_port - outside port
1619         :param ext_addr - external host IP address
1620         :param ext_port - external host port
1621         """
1622         return self.api(
1623             self.papi.nat_det_close_session_out,
1624             {'out_addr': out_addr,
1625              'out_port': out_port,
1626              'ext_addr': ext_addr,
1627              'ext_port': ext_port})
1628
1629     def nat_det_close_session_in(
1630             self,
1631             in_addr,
1632             in_port,
1633             ext_addr,
1634             ext_port):
1635         """Close deterministic NAT session using inside address and port
1636
1637         :param in_addr - inside IP address
1638         :param in_port - inside port
1639         :param ext_addr - external host IP address
1640         :param ext_port - external host port
1641         """
1642         return self.api(
1643             self.papi.nat_det_close_session_in,
1644             {'in_addr': in_addr,
1645              'in_port': in_port,
1646              'ext_addr': ext_addr,
1647              'ext_port': ext_port,
1648              'is_nat44': 1})
1649
1650     def nat_det_session_dump(
1651             self,
1652             user_addr):
1653         """Dump deterministic NAT sessions belonging to a user
1654
1655         :param user_addr - inside IP address of the user
1656         :return: Dictionary of deterministic NAT sessions
1657         """
1658         return self.api(
1659             self.papi.nat_det_session_dump,
1660             {'is_nat44': 1,
1661              'user_addr': user_addr})
1662
1663     def nat64_add_del_pool_addr_range(
1664             self,
1665             start_addr,
1666             end_addr,
1667             vrf_id=0xFFFFFFFF,
1668             is_add=1):
1669         """Add/del address range to NAT64 pool
1670
1671         :param start_addr: First IP address
1672         :param end_addr: Last IP address
1673         :param vrf_id: VRF id for the address range
1674         :param is_add: 1 if add, 0 if delete (Default value = 1)
1675         """
1676         return self.api(
1677             self.papi.nat64_add_del_pool_addr_range,
1678             {'start_addr': start_addr,
1679              'end_addr': end_addr,
1680              'vrf_id': vrf_id,
1681              'is_add': is_add})
1682
1683     def nat64_pool_addr_dump(self):
1684         """Dump NAT64 pool addresses
1685         :return: Dictionary of NAT64 pool addresses
1686         """
1687         return self.api(self.papi.nat64_pool_addr_dump, {})
1688
1689     def nat64_add_del_interface(
1690             self,
1691             sw_if_index,
1692             is_inside=1,
1693             is_add=1):
1694         """Enable/disable NAT64 feature on the interface
1695            :param sw_if_index: Index of the interface
1696            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1697            :param is_add: 1 if add, 0 if delete (Default value = 1)
1698         """
1699         return self.api(
1700             self.papi.nat64_add_del_interface,
1701             {'sw_if_index': sw_if_index,
1702              'is_inside': is_inside,
1703              'is_add': is_add})
1704
1705     def nat64_interface_dump(self):
1706         """Dump interfaces with NAT64 feature
1707         :return: Dictionary of interfaces with NAT64 feature
1708         """
1709         return self.api(self.papi.nat64_interface_dump, {})
1710
1711     def nat64_add_del_static_bib(
1712             self,
1713             in_ip,
1714             out_ip,
1715             in_port,
1716             out_port,
1717             protocol,
1718             vrf_id=0,
1719             is_add=1):
1720         """Add/delete S-NAT static BIB entry
1721
1722         :param in_ip: Inside IPv6 address
1723         :param out_ip: Outside IPv4 address
1724         :param in_port: Inside port number
1725         :param out_port: Outside port number
1726         :param protocol: IP protocol
1727         :param vrf_id: VRF ID (Default value = 0)
1728         :param is_add: 1 if add, 0 if delete (Default value = 1)
1729         """
1730         return self.api(
1731             self.papi.nat64_add_del_static_bib,
1732             {'i_addr': in_ip,
1733              'o_addr': out_ip,
1734              'i_port': in_port,
1735              'o_port': out_port,
1736              'vrf_id': vrf_id,
1737              'proto': protocol,
1738              'is_add': is_add})
1739
1740     def nat64_bib_dump(self, protocol=255):
1741         """Dump NAT64 BIB
1742
1743         :param protocol: IP protocol (Default value = 255, all BIBs)
1744         :returns: Dictionary of NAT64 BIB entries
1745         """
1746         return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1747
1748     def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1749                            tcp_incoming_syn=6):
1750         """Set values of timeouts for NAT64 (in seconds)
1751
1752         :param udpi: UDP timeout (Default value = 300)
1753         :param icmp: ICMP timeout (Default value = 60)
1754         :param tcp_trans: TCP transitory timeout (Default value = 240)
1755         :param tcp_est: TCP established timeout (Default value = 7440)
1756         :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1757         """
1758         return self.api(
1759             self.papi.nat64_set_timeouts,
1760             {'udp': udp,
1761              'icmp': icmp,
1762              'tcp_trans': tcp_trans,
1763              'tcp_est': tcp_est,
1764              'tcp_incoming_syn': tcp_incoming_syn})
1765
1766     def nat64_get_timeouts(self):
1767         """Get values of timeouts for NAT64
1768
1769         :return: Timeouts for NAT64 (in seconds)
1770         """
1771         return self.api(self.papi.nat64_get_timeouts, {})
1772
1773     def nat64_st_dump(self, protocol=255):
1774         """Dump NAT64 session table
1775
1776         :param protocol: IP protocol (Default value = 255, all STs)
1777         :returns: Dictionary of NAT64 sesstion table entries
1778         """
1779         return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1780
1781     def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1782         """Add/del NAT64 prefix
1783
1784         :param prefix: NAT64 prefix
1785         :param plen: NAT64 prefix length
1786         :param vrf_id: VRF id of tenant (Default 0)
1787         :param is_add: 1 if add, 0 if delete (Default value = 1)
1788         """
1789         return self.api(
1790             self.papi.nat64_add_del_prefix,
1791             {'prefix': prefix,
1792              'prefix_len': plen,
1793              'vrf_id': vrf_id,
1794              'is_add': is_add})
1795
1796     def nat64_prefix_dump(self):
1797         """Dump NAT64 prefix
1798
1799         :returns: Dictionary of NAT64 prefixes
1800         """
1801         return self.api(self.papi.nat64_prefix_dump, {})
1802
1803     def nat64_add_interface_addr(
1804             self,
1805             sw_if_index,
1806             is_add=1):
1807         """Add/del NAT64 address from interface
1808
1809         :param sw_if_index: Software index of the interface
1810         :param is_add: 1 if add, 0 if delete (Default value = 1)
1811         """
1812         return self.api(self.papi.nat64_add_del_interface_addr,
1813                         {'is_add': is_add, 'sw_if_index': sw_if_index})
1814
1815     def dslite_set_aftr_addr(self, ip6, ip4):
1816         """Set DS-Lite AFTR addresses
1817
1818         :param ip4: IPv4 address
1819         :param ip6: IPv6 address
1820         """
1821         return self.api(
1822             self.papi.dslite_set_aftr_addr,
1823             {'ip4_addr': ip4,
1824              'ip6_addr': ip6})
1825
1826     def dslite_set_b4_addr(self, ip6, ip4):
1827         """Set DS-Lite B4 IPv6 address
1828
1829         :param ip4: IPv4 address
1830         :param ip6: IPv6 address
1831         """
1832         return self.api(
1833             self.papi.dslite_set_b4_addr,
1834             {'ip4_addr': ip4,
1835              'ip6_addr': ip6})
1836
1837     def dslite_add_del_pool_addr_range(
1838             self,
1839             start_addr,
1840             end_addr,
1841             is_add=1):
1842         """Add/del address range to DS-Lite pool
1843
1844         :param start_addr: First IP address
1845         :param end_addr: Last IP address
1846         :param is_add: 1 if add, 0 if delete (Default value = 1)
1847         """
1848         return self.api(
1849             self.papi.dslite_add_del_pool_addr_range,
1850             {'start_addr': start_addr,
1851              'end_addr': end_addr,
1852              'is_add': is_add})
1853
1854     def control_ping(self):
1855         self.api(self.papi.control_ping)
1856
1857     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1858                     detect_mult, local_addr, peer_addr, is_ipv6=0,
1859                     bfd_key_id=None, conf_key_id=None):
1860         if bfd_key_id is None:
1861             return self.api(self.papi.bfd_udp_add,
1862                             {
1863                                 'sw_if_index': sw_if_index,
1864                                 'desired_min_tx': desired_min_tx,
1865                                 'required_min_rx': required_min_rx,
1866                                 'local_addr': local_addr,
1867                                 'peer_addr': peer_addr,
1868                                 'is_ipv6': is_ipv6,
1869                                 'detect_mult': detect_mult,
1870                             })
1871         else:
1872             return self.api(self.papi.bfd_udp_add,
1873                             {
1874                                 'sw_if_index': sw_if_index,
1875                                 'desired_min_tx': desired_min_tx,
1876                                 'required_min_rx': required_min_rx,
1877                                 'local_addr': local_addr,
1878                                 'peer_addr': peer_addr,
1879                                 'is_ipv6': is_ipv6,
1880                                 'detect_mult': detect_mult,
1881                                 'is_authenticated': 1,
1882                                 'bfd_key_id': bfd_key_id,
1883                                 'conf_key_id': conf_key_id,
1884                             })
1885
1886     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1887                     detect_mult, local_addr, peer_addr, is_ipv6=0):
1888         return self.api(self.papi.bfd_udp_mod,
1889                         {
1890                             'sw_if_index': sw_if_index,
1891                             'desired_min_tx': desired_min_tx,
1892                             'required_min_rx': required_min_rx,
1893                             'local_addr': local_addr,
1894                             'peer_addr': peer_addr,
1895                             'is_ipv6': is_ipv6,
1896                             'detect_mult': detect_mult,
1897                         })
1898
1899     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1900                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1901                               is_delayed=False):
1902         return self.api(self.papi.bfd_udp_auth_activate,
1903                         {
1904                             'sw_if_index': sw_if_index,
1905                             'local_addr': local_addr,
1906                             'peer_addr': peer_addr,
1907                             'is_ipv6': is_ipv6,
1908                             'is_delayed': 1 if is_delayed else 0,
1909                             'bfd_key_id': bfd_key_id,
1910                             'conf_key_id': conf_key_id,
1911                         })
1912
1913     def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1914                                 is_ipv6=0, is_delayed=False):
1915         return self.api(self.papi.bfd_udp_auth_deactivate,
1916                         {
1917                             'sw_if_index': sw_if_index,
1918                             'local_addr': local_addr,
1919                             'peer_addr': peer_addr,
1920                             'is_ipv6': is_ipv6,
1921                             'is_delayed': 1 if is_delayed else 0,
1922                         })
1923
1924     def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1925         return self.api(self.papi.bfd_udp_del,
1926                         {
1927                             'sw_if_index': sw_if_index,
1928                             'local_addr': local_addr,
1929                             'peer_addr': peer_addr,
1930                             'is_ipv6': is_ipv6,
1931                         })
1932
1933     def bfd_udp_session_dump(self):
1934         return self.api(self.papi.bfd_udp_session_dump, {})
1935
1936     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1937                                   peer_addr, is_ipv6=0):
1938         return self.api(self.papi.bfd_udp_session_set_flags, {
1939             'admin_up_down': admin_up_down,
1940             'sw_if_index': sw_if_index,
1941             'local_addr': local_addr,
1942             'peer_addr': peer_addr,
1943             'is_ipv6': is_ipv6,
1944         })
1945
1946     def want_bfd_events(self, enable_disable=1):
1947         return self.api(self.papi.want_bfd_events, {
1948             'enable_disable': enable_disable,
1949             'pid': os.getpid(),
1950         })
1951
1952     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1953         return self.api(self.papi.bfd_auth_set_key, {
1954             'conf_key_id': conf_key_id,
1955             'auth_type': auth_type,
1956             'key': key,
1957             'key_len': len(key),
1958         })
1959
1960     def bfd_auth_del_key(self, conf_key_id):
1961         return self.api(self.papi.bfd_auth_del_key, {
1962             'conf_key_id': conf_key_id,
1963         })
1964
1965     def bfd_auth_keys_dump(self):
1966         return self.api(self.papi.bfd_auth_keys_dump, {})
1967
1968     def bfd_udp_set_echo_source(self, sw_if_index):
1969         return self.api(self.papi.bfd_udp_set_echo_source,
1970                         {'sw_if_index': sw_if_index})
1971
1972     def bfd_udp_del_echo_source(self):
1973         return self.api(self.papi.bfd_udp_del_echo_source, {})
1974
1975     def classify_add_del_table(
1976             self,
1977             is_add,
1978             mask,
1979             match_n_vectors=1,
1980             table_index=0xFFFFFFFF,
1981             nbuckets=2,
1982             memory_size=2097152,
1983             skip_n_vectors=0,
1984             next_table_index=0xFFFFFFFF,
1985             miss_next_index=0xFFFFFFFF,
1986             current_data_flag=0,
1987             current_data_offset=0):
1988         """
1989         :param is_add:
1990         :param mask:
1991         :param match_n_vectors: (Default value = 1)
1992         :param table_index: (Default value = 0xFFFFFFFF)
1993         :param nbuckets:  (Default value = 2)
1994         :param memory_size:  (Default value = 2097152)
1995         :param skip_n_vectors:  (Default value = 0)
1996         :param next_table_index:  (Default value = 0xFFFFFFFF)
1997         :param miss_next_index:  (Default value = 0xFFFFFFFF)
1998         :param current_data_flag:  (Default value = 0)
1999         :param current_data_offset:  (Default value = 0)
2000         """
2001
2002         return self.api(
2003             self.papi.classify_add_del_table,
2004             {'is_add': is_add,
2005              'table_index': table_index,
2006              'nbuckets': nbuckets,
2007              'memory_size': memory_size,
2008              'skip_n_vectors': skip_n_vectors,
2009              'match_n_vectors': match_n_vectors,
2010              'next_table_index': next_table_index,
2011              'miss_next_index': miss_next_index,
2012              'current_data_flag': current_data_flag,
2013              'current_data_offset': current_data_offset,
2014              'mask': mask})
2015
2016     def classify_add_del_session(
2017             self,
2018             is_add,
2019             table_index,
2020             match,
2021             opaque_index=0xFFFFFFFF,
2022             hit_next_index=0xFFFFFFFF,
2023             advance=0,
2024             action=0,
2025             metadata=0):
2026         """
2027         :param is_add:
2028         :param table_index:
2029         :param match:
2030         :param opaque_index:  (Default value = 0xFFFFFFFF)
2031         :param hit_next_index:  (Default value = 0xFFFFFFFF)
2032         :param advance:  (Default value = 0)
2033         :param action:  (Default value = 0)
2034         :param metadata:  (Default value = 0)
2035         """
2036
2037         return self.api(
2038             self.papi.classify_add_del_session,
2039             {'is_add': is_add,
2040              'table_index': table_index,
2041              'hit_next_index': hit_next_index,
2042              'opaque_index': opaque_index,
2043              'advance': advance,
2044              'action': action,
2045              'metadata': metadata,
2046              'match': match})
2047
2048     def input_acl_set_interface(
2049             self,
2050             is_add,
2051             sw_if_index,
2052             ip4_table_index=0xFFFFFFFF,
2053             ip6_table_index=0xFFFFFFFF,
2054             l2_table_index=0xFFFFFFFF):
2055         """
2056         :param is_add:
2057         :param sw_if_index:
2058         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
2059         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
2060         :param l2_table_index:  (Default value = 0xFFFFFFFF)
2061         """
2062
2063         return self.api(
2064             self.papi.input_acl_set_interface,
2065             {'sw_if_index': sw_if_index,
2066              'ip4_table_index': ip4_table_index,
2067              'ip6_table_index': ip6_table_index,
2068              'l2_table_index': l2_table_index,
2069              'is_add': is_add})
2070
2071     def set_ipfix_exporter(
2072             self,
2073             collector_address,
2074             src_address,
2075             path_mtu,
2076             template_interval,
2077             vrf_id=0,
2078             collector_port=4739,
2079             udp_checksum=0):
2080         return self.api(
2081             self.papi.set_ipfix_exporter,
2082             {
2083                 'collector_address': collector_address,
2084                 'collector_port': collector_port,
2085                 'src_address': src_address,
2086                 'vrf_id': vrf_id,
2087                 'path_mtu': path_mtu,
2088                 'template_interval': template_interval,
2089                 'udp_checksum': udp_checksum,
2090             })
2091
2092     def dhcp_proxy_config(self,
2093                           dhcp_server,
2094                           dhcp_src_address,
2095                           rx_table_id=0,
2096                           server_table_id=0,
2097                           is_add=1,
2098                           is_ipv6=0):
2099         return self.api(
2100             self.papi.dhcp_proxy_config,
2101             {
2102                 'rx_vrf_id': rx_table_id,
2103                 'server_vrf_id': server_table_id,
2104                 'is_ipv6': is_ipv6,
2105                 'is_add': is_add,
2106                 'dhcp_server': dhcp_server,
2107                 'dhcp_src_address': dhcp_src_address,
2108             })
2109
2110     def dhcp_proxy_set_vss(self,
2111                            table_id,
2112                            vss_type=255,
2113                            vpn_ascii_id="",
2114                            oui=0,
2115                            vpn_index=0,
2116                            is_add=1,
2117                            is_ip6=0):
2118         return self.api(
2119             self.papi.dhcp_proxy_set_vss,
2120             {
2121                 'tbl_id': table_id,
2122                 'vss_type': vss_type,
2123                 'vpn_ascii_id': vpn_ascii_id,
2124                 'oui': oui,
2125                 'vpn_index': vpn_index,
2126                 'is_add': is_add,
2127                 'is_ipv6': is_ip6,
2128             })
2129
2130     def dhcp_client(self,
2131                     sw_if_index,
2132                     hostname,
2133                     client_id='',
2134                     is_add=1,
2135                     want_dhcp_events=0):
2136         return self.api(
2137             self.papi.dhcp_client_config,
2138             {
2139                 'sw_if_index': sw_if_index,
2140                 'hostname': hostname,
2141                 'client_id': client_id,
2142                 'is_add': is_add,
2143                 'want_dhcp_event': want_dhcp_events,
2144                 'pid': os.getpid(),
2145             })
2146
2147     def ip_mroute_add_del(self,
2148                           src_address,
2149                           grp_address,
2150                           grp_address_length,
2151                           e_flags,
2152                           next_hop_afi,
2153                           next_hop_sw_if_index,
2154                           i_flags,
2155                           bier_imp=0,
2156                           rpf_id=0,
2157                           table_id=0,
2158                           is_add=1,
2159                           is_ipv6=0,
2160                           is_local=0):
2161         """
2162         IP Multicast Route add/del
2163         """
2164         return self.api(
2165             self.papi.ip_mroute_add_del,
2166             {'next_hop_sw_if_index': next_hop_sw_if_index,
2167              'entry_flags': e_flags,
2168              'itf_flags': i_flags,
2169              'table_id': table_id,
2170              'rpf_id': rpf_id,
2171              'is_add': is_add,
2172              'is_ipv6': is_ipv6,
2173              'is_local': is_local,
2174              'bier_imp': bier_imp,
2175              'next_hop_afi': next_hop_afi,
2176              'grp_address_length': grp_address_length,
2177              'grp_address': grp_address,
2178              'src_address': src_address})
2179
2180     def mfib_signal_dump(self):
2181         return self.api(self.papi.mfib_signal_dump, {})
2182
2183     def ip_mfib_dump(self):
2184         return self.api(self.papi.ip_mfib_dump, {})
2185
2186     def ip6_mfib_dump(self):
2187         return self.api(self.papi.ip6_mfib_dump, {})
2188
2189     def lisp_enable_disable(self, is_enabled):
2190         return self.api(
2191             self.papi.lisp_enable_disable,
2192             {
2193                 'is_en': is_enabled,
2194             })
2195
2196     def lisp_locator_set(self,
2197                          ls_name,
2198                          is_add=1):
2199         return self.api(
2200             self.papi.lisp_add_del_locator_set,
2201             {
2202                 'is_add': is_add,
2203                 'locator_set_name': ls_name
2204             })
2205
2206     def lisp_locator_set_dump(self):
2207         return self.api(self.papi.lisp_locator_set_dump, {})
2208
2209     def lisp_locator(self,
2210                      ls_name,
2211                      sw_if_index,
2212                      priority=1,
2213                      weight=1,
2214                      is_add=1):
2215         return self.api(
2216             self.papi.lisp_add_del_locator,
2217             {
2218                 'is_add': is_add,
2219                 'locator_set_name': ls_name,
2220                 'sw_if_index': sw_if_index,
2221                 'priority': priority,
2222                 'weight': weight
2223             })
2224
2225     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2226         return self.api(
2227             self.papi.lisp_locator_dump,
2228             {
2229                 'is_index_set': is_index_set,
2230                 'ls_name': ls_name,
2231                 'ls_index': ls_index,
2232             })
2233
2234     def lisp_local_mapping(self,
2235                            ls_name,
2236                            eid_type,
2237                            eid,
2238                            prefix_len,
2239                            vni=0,
2240                            key_id=0,
2241                            key="",
2242                            is_add=1):
2243         return self.api(
2244             self.papi.lisp_add_del_local_eid,
2245             {
2246                 'locator_set_name': ls_name,
2247                 'is_add': is_add,
2248                 'eid_type': eid_type,
2249                 'eid': eid,
2250                 'prefix_len': prefix_len,
2251                 'vni': vni,
2252                 'key_id': key_id,
2253                 'key': key
2254             })
2255
2256     def lisp_eid_table_dump(self,
2257                             eid_set=0,
2258                             prefix_length=0,
2259                             vni=0,
2260                             eid_type=0,
2261                             eid=None,
2262                             filter_opt=0):
2263         return self.api(
2264             self.papi.lisp_eid_table_dump,
2265             {
2266                 'eid_set': eid_set,
2267                 'prefix_length': prefix_length,
2268                 'vni': vni,
2269                 'eid_type': eid_type,
2270                 'eid': eid,
2271                 'filter': filter_opt,
2272             })
2273
2274     def lisp_remote_mapping(self,
2275                             eid_type,
2276                             eid,
2277                             eid_prefix_len=0,
2278                             vni=0,
2279                             rlocs=[],
2280                             rlocs_num=0,
2281                             is_src_dst=0,
2282                             is_add=1):
2283         return self.api(
2284             self.papi.lisp_add_del_remote_mapping,
2285             {
2286                 'is_add': is_add,
2287                 'eid_type': eid_type,
2288                 'eid': eid,
2289                 'eid_len': eid_prefix_len,
2290                 'rloc_num': rlocs_num,
2291                 'rlocs': rlocs,
2292                 'vni': vni,
2293                 'is_src_dst': is_src_dst,
2294             })
2295
2296     def lisp_adjacency(self,
2297                        leid,
2298                        reid,
2299                        leid_len,
2300                        reid_len,
2301                        eid_type,
2302                        is_add=1,
2303                        vni=0):
2304         return self.api(
2305             self.papi.lisp_add_del_adjacency,
2306             {
2307                 'is_add': is_add,
2308                 'vni': vni,
2309                 'eid_type': eid_type,
2310                 'leid': leid,
2311                 'reid': reid,
2312                 'leid_len': leid_len,
2313                 'reid_len': reid_len,
2314             })
2315
2316     def lisp_adjacencies_get(self, vni=0):
2317         return self.api(
2318             self.papi.lisp_adjacencies_get,
2319             {
2320                 'vni': vni
2321             })
2322
2323     def map_add_domain(self,
2324                        ip6_prefix,
2325                        ip6_prefix_len,
2326                        ip6_src,
2327                        ip6_src_prefix_len,
2328                        ip4_prefix,
2329                        ip4_prefix_len,
2330                        ea_bits_len=0,
2331                        psid_offset=0,
2332                        psid_length=0,
2333                        is_translation=0,
2334                        is_rfc6052=0,
2335                        mtu=1280):
2336         return self.api(
2337             self.papi.map_add_domain,
2338             {
2339                 'ip6_prefix': ip6_prefix,
2340                 'ip6_prefix_len': ip6_prefix_len,
2341                 'ip4_prefix': ip4_prefix,
2342                 'ip4_prefix_len': ip4_prefix_len,
2343                 'ip6_src': ip6_src,
2344                 'ip6_src_prefix_len': ip6_src_prefix_len,
2345                 'ea_bits_len': ea_bits_len,
2346                 'psid_offset': psid_offset,
2347                 'psid_length': psid_length,
2348                 'is_translation': is_translation,
2349                 'is_rfc6052': is_rfc6052,
2350                 'mtu': mtu
2351             })
2352
2353     def gtpu_add_del_tunnel(
2354             self,
2355             src_addr,
2356             dst_addr,
2357             is_add=1,
2358             is_ipv6=0,
2359             mcast_sw_if_index=0xFFFFFFFF,
2360             encap_vrf_id=0,
2361             decap_next_index=0xFFFFFFFF,
2362             teid=0):
2363         """
2364
2365         :param is_add:  (Default value = 1)
2366         :param is_ipv6:  (Default value = 0)
2367         :param src_addr:
2368         :param dst_addr:
2369         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2370         :param encap_vrf_id:  (Default value = 0)
2371         :param decap_next_index:  (Default value = 0xFFFFFFFF)
2372         :param teid:  (Default value = 0)
2373
2374         """
2375         return self.api(self.papi.gtpu_add_del_tunnel,
2376                         {'is_add': is_add,
2377                          'is_ipv6': is_ipv6,
2378                          'src_address': src_addr,
2379                          'dst_address': dst_addr,
2380                          'mcast_sw_if_index': mcast_sw_if_index,
2381                          'encap_vrf_id': encap_vrf_id,
2382                          'decap_next_index': decap_next_index,
2383                          'teid': teid})
2384
2385     def vxlan_gpe_add_del_tunnel(
2386             self,
2387             src_addr,
2388             dst_addr,
2389             mcast_sw_if_index=0xFFFFFFFF,
2390             is_add=1,
2391             is_ipv6=0,
2392             encap_vrf_id=0,
2393             decap_vrf_id=0,
2394             protocol=3,
2395             vni=0):
2396         """
2397
2398         :param local:
2399         :param remote:
2400         :param is_add:  (Default value = 1)
2401         :param is_ipv6:  (Default value = 0)
2402         :param encap_vrf_id:  (Default value = 0)
2403         :param decap_vrf_id:  (Default value = 0)
2404         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2405         :param protocol:  (Default value = 3)
2406         :param vni:  (Default value = 0)
2407
2408         """
2409         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2410                         {'is_add': is_add,
2411                          'is_ipv6': is_ipv6,
2412                          'local': src_addr,
2413                          'remote': dst_addr,
2414                          'mcast_sw_if_index': mcast_sw_if_index,
2415                          'encap_vrf_id': encap_vrf_id,
2416                          'decap_vrf_id': decap_vrf_id,
2417                          'protocol': protocol,
2418                          'vni': vni})
2419
2420     def pppoe_add_del_session(
2421             self,
2422             client_ip,
2423             client_mac,
2424             session_id=0,
2425             is_add=1,
2426             is_ipv6=0,
2427             decap_vrf_id=0):
2428         """
2429
2430         :param is_add:  (Default value = 1)
2431         :param is_ipv6:  (Default value = 0)
2432         :param client_ip:
2433         :param session_id:  (Default value = 0)
2434         :param client_mac:
2435         :param decap_vrf_id:  (Default value = 0)
2436
2437         """
2438         return self.api(self.papi.pppoe_add_del_session,
2439                         {'is_add': is_add,
2440                          'is_ipv6': is_ipv6,
2441                          'session_id': session_id,
2442                          'client_ip': client_ip,
2443                          'decap_vrf_id': decap_vrf_id,
2444                          'client_mac': client_mac})
2445
2446     def sr_localsid_add_del(self,
2447                             localsid_addr,
2448                             behavior,
2449                             nh_addr,
2450                             is_del=0,
2451                             end_psp=0,
2452                             sw_if_index=0xFFFFFFFF,
2453                             vlan_index=0,
2454                             fib_table=0,
2455                             ):
2456         """ Add/del IPv6 SR local-SID.
2457
2458         :param localsid_addr:
2459         :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2460         :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2461         :param nh_addr:
2462         :param is_del:  (Default value = 0)
2463         :param end_psp: (Default value = 0)
2464         :param sw_if_index: (Default value = 0xFFFFFFFF)
2465         :param vlan_index:  (Default value = 0)
2466         :param fib_table:   (Default value = 0)
2467         """
2468         return self.api(
2469             self.papi.sr_localsid_add_del,
2470             {'is_del': is_del,
2471              'localsid_addr': localsid_addr,
2472              'end_psp': end_psp,
2473              'behavior': behavior,
2474              'sw_if_index': sw_if_index,
2475              'vlan_index': vlan_index,
2476              'fib_table': fib_table,
2477              'nh_addr': nh_addr
2478              }
2479         )
2480
2481     def sr_policy_add(
2482             self,
2483             bsid_addr,
2484             weight=1,
2485             is_encap=1,
2486             type=0,
2487             fib_table=0,
2488             n_segments=0,
2489             segments=[]):
2490         """
2491         :param bsid_addr: bindingSID of the SR Policy
2492         :param weight: weight of the sid list. optional. (default: 1)
2493         :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2494             (default: Encap)
2495         :param type: type/behavior of the SR policy. (default or spray) \
2496             (default: default)
2497         :param fib_table: VRF where to install the FIB entry for the BSID \
2498             (default: 0)
2499         :param n_segments: number of segments \
2500             (default: 0)
2501         :param segments: a vector of IPv6 address composing the segment list \
2502             (default: [])
2503         """
2504         return self.api(
2505             self.papi.sr_policy_add,
2506             {'bsid_addr': bsid_addr,
2507              'weight': weight,
2508              'is_encap': is_encap,
2509              'type': type,
2510              'fib_table': fib_table,
2511              'n_segments': n_segments,
2512              'segments': segments
2513              }
2514         )
2515
2516     def sr_policy_del(
2517             self,
2518             bsid_addr,
2519             sr_policy_index=0):
2520         """
2521         :param bsid: bindingSID of the SR Policy
2522         :param sr_policy_index: index of the sr policy (default: 0)
2523         """
2524         return self.api(
2525             self.papi.sr_policy_del,
2526             {'bsid_addr': bsid_addr,
2527              'sr_policy_index': sr_policy_index
2528              })
2529
2530     def sr_steering_add_del(
2531             self,
2532             is_del,
2533             bsid_addr,
2534             sr_policy_index,
2535             table_id,
2536             prefix_addr,
2537             mask_width,
2538             sw_if_index,
2539             traffic_type):
2540         """
2541         Steer traffic L2 and L3 traffic through a given SR policy
2542
2543         :param is_del: delete or add
2544         :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2545         :param sr_policy: is the index of the SR Policy (alt to bsid)
2546         :param table_id: is the VRF where to install the FIB entry for the BSID
2547         :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2548         :param mask_width: is the mask for L3 traffic type
2549         :param sw_if_index: is the incoming interface for L2 traffic
2550         :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2551         """
2552         return self.api(
2553             self.papi.sr_steering_add_del,
2554             {'is_del': is_del,
2555              'bsid_addr': bsid_addr,
2556              'sr_policy_index': sr_policy_index,
2557              'table_id': table_id,
2558              'prefix_addr': prefix_addr,
2559              'mask_width': mask_width,
2560              'sw_if_index': sw_if_index,
2561              'traffic_type': traffic_type
2562              })
2563
2564     def acl_add_replace(self, acl_index, r, tag='',
2565                         expected_retval=0):
2566         """Add/replace an ACL
2567         :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2568         :param acl_rule r: ACL rules array.
2569         :param str tag: symbolic tag (description) for this ACL.
2570         :param int count: number of rules.
2571         """
2572         return self.api(self.papi.acl_add_replace,
2573                         {'acl_index': acl_index,
2574                          'r': r,
2575                          'count': len(r),
2576                          'tag': tag},
2577                         expected_retval=expected_retval)
2578
2579     def acl_del(self, acl_index, expected_retval=0):
2580         """
2581
2582         :param acl_index:
2583         :return:
2584         """
2585         return self.api(self.papi.acl_del,
2586                         {'acl_index': acl_index},
2587                         expected_retval=expected_retval)
2588
2589     def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2590                                    expected_retval=0):
2591         return self.api(self.papi.acl_interface_set_acl_list,
2592                         {'sw_if_index': sw_if_index,
2593                          'count': len(acls),
2594                          'n_input': n_input,
2595                          'acls': acls},
2596                         expected_retval=expected_retval)
2597
2598     def acl_interface_add_del(self,
2599                               sw_if_index,
2600                               acl_index,
2601                               is_add=1):
2602         """ Add/Delete ACL to/from interface
2603
2604         :param sw_if_index:
2605         :param acl_index:
2606         :param is_add:  (Default value = 1)
2607         """
2608
2609         return self.api(self.papi.acl_interface_add_del,
2610                         {'is_add': is_add,
2611                          'is_input': 1,
2612                          'sw_if_index': sw_if_index,
2613                          'acl_index': acl_index})
2614
2615     def acl_dump(self, acl_index, expected_retval=0):
2616         return self.api(self.papi.acl_dump,
2617                         {'acl_index': acl_index},
2618                         expected_retval=expected_retval)
2619
2620     def macip_acl_add(self, rules, tag=""):
2621         """ Add MACIP acl
2622
2623         :param rules: list of rules for given acl
2624         :param tag: acl tag
2625         """
2626
2627         return self.api(self.papi.macip_acl_add,
2628                         {'r': rules,
2629                          'count': len(rules),
2630                          'tag': tag})
2631
2632     def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2633         """ Add MACIP acl
2634
2635         :param rules: list of rules for given acl
2636         :param tag: acl tag
2637         """
2638
2639         return self.api(self.papi.macip_acl_add_replace,
2640                         {'acl_index': acl_index,
2641                          'r': rules,
2642                          'count': len(rules),
2643                          'tag': tag})
2644
2645     def macip_acl_del(self, acl_index):
2646         """
2647
2648         :param acl_index:
2649         :return:
2650         """
2651         return self.api(self.papi.macip_acl_del,
2652                         {'acl_index': acl_index})
2653
2654     def macip_acl_interface_add_del(self,
2655                                     sw_if_index,
2656                                     acl_index,
2657                                     is_add=1):
2658         """ Add MACIP acl to interface
2659
2660         :param sw_if_index:
2661         :param acl_index:
2662         :param is_add:  (Default value = 1)
2663         """
2664
2665         return self.api(self.papi.macip_acl_interface_add_del,
2666                         {'is_add': is_add,
2667                          'sw_if_index': sw_if_index,
2668                          'acl_index': acl_index})
2669
2670     def macip_acl_interface_get(self):
2671         """ Return interface acls dump
2672         """
2673         return self.api(
2674             self.papi.macip_acl_interface_get, {})
2675
2676     def macip_acl_dump(self, acl_index=4294967295):
2677         """ Return MACIP acl dump
2678         """
2679
2680         return self.api(
2681             self.papi.macip_acl_dump, {'acl_index': acl_index})
2682
2683     def policer_add_del(self,
2684                         name,
2685                         cir,
2686                         eir,
2687                         cb,
2688                         eb,
2689                         is_add=1,
2690                         rate_type=0,
2691                         round_type=0,
2692                         ptype=0,
2693                         color_aware=0,
2694                         conform_action_type=1,
2695                         conform_dscp=0,
2696                         exceed_action_type=0,
2697                         exceed_dscp=0,
2698                         violate_action_type=0,
2699                         violate_dscp=0):
2700         return self.api(self.papi.policer_add_del,
2701                         {'name': name,
2702                          'cir': cir,
2703                          'eir': eir,
2704                          'cb': cb,
2705                          'eb': eb,
2706                          'is_add': is_add,
2707                          'rate_type': rate_type,
2708                          'round_type': round_type,
2709                          'type': ptype,
2710                          'color_aware': color_aware,
2711                          'conform_action_type': conform_action_type,
2712                          'conform_dscp': conform_dscp,
2713                          'exceed_action_type': exceed_action_type,
2714                          'exceed_dscp': exceed_dscp,
2715                          'violate_action_type': violate_action_type,
2716                          'violate_dscp': violate_dscp})
2717
2718     def ip_punt_police(self,
2719                        policer_index,
2720                        is_ip6=0,
2721                        is_add=1):
2722         return self.api(self.papi.ip_punt_police,
2723                         {'policer_index': policer_index,
2724                          'is_add': is_add,
2725                          'is_ip6': is_ip6})
2726
2727     def ip_punt_redirect(self,
2728                          rx_sw_if_index,
2729                          tx_sw_if_index,
2730                          nh,
2731                          is_ip6=0,
2732                          is_add=1):
2733         return self.api(self.papi.ip_punt_redirect,
2734                         {'rx_sw_if_index': rx_sw_if_index,
2735                          'tx_sw_if_index': tx_sw_if_index,
2736                          'nh': nh,
2737                          'is_add': is_add,
2738                          'is_ip6': is_ip6})
2739
2740     def bier_table_add_del(self,
2741                            bti,
2742                            mpls_label,
2743                            is_add=1):
2744         """ BIER Table add/del """
2745         return self.api(
2746             self.papi.bier_table_add_del,
2747             {'bt_tbl_id': {"bt_set": bti.set_id,
2748                            "bt_sub_domain": bti.sub_domain_id,
2749                            "bt_hdr_len_id": bti.hdr_len_id},
2750              'bt_label': mpls_label,
2751              'bt_is_add': is_add})
2752
2753     def bier_table_dump(self):
2754         return self.api(self.papi.bier_table_dump, {})
2755
2756     def bier_route_add_del(self,
2757                            bti,
2758                            bp,
2759                            paths,
2760                            is_add=1):
2761         """ BIER Route add/del """
2762         br_paths = []
2763         for p in paths:
2764             br_paths.append({'next_hop': p.nh_addr,
2765                              'weight': 1,
2766                              'afi': 0,
2767                              'preference': 0,
2768                              'table_id': p.nh_table_id,
2769                              'next_hop_id': p.next_hop_id,
2770                              'is_udp_encap': p.is_udp_encap,
2771                              'n_labels': len(p.nh_labels),
2772                              'label_stack': p.nh_labels})
2773         return self.api(
2774             self.papi.bier_route_add_del,
2775             {'br_tbl_id': {"bt_set": bti.set_id,
2776                            "bt_sub_domain": bti.sub_domain_id,
2777                            "bt_hdr_len_id": bti.hdr_len_id},
2778              'br_bp': bp,
2779              'br_n_paths': len(br_paths),
2780              'br_paths': br_paths,
2781              'br_is_add': is_add})
2782
2783     def bier_route_dump(self, bti):
2784         return self.api(
2785             self.papi.bier_route_dump,
2786             {'br_tbl_id': {"bt_set": bti.set_id,
2787                            "bt_sub_domain": bti.sub_domain_id,
2788                            "bt_hdr_len_id": bti.hdr_len_id}})
2789
2790     def bier_imp_add(self,
2791                      bti,
2792                      src,
2793                      ibytes,
2794                      is_add=1):
2795         """ BIER Imposition Add """
2796         return self.api(
2797             self.papi.bier_imp_add,
2798             {'bi_tbl_id': {"bt_set": bti.set_id,
2799                            "bt_sub_domain": bti.sub_domain_id,
2800                            "bt_hdr_len_id": bti.hdr_len_id},
2801              'bi_src': src,
2802              'bi_n_bytes': len(ibytes),
2803              'bi_bytes': ibytes})
2804
2805     def bier_imp_del(self, bi_index):
2806         """ BIER Imposition del """
2807         return self.api(
2808             self.papi.bier_imp_del,
2809             {'bi_index': bi_index})
2810
2811     def bier_imp_dump(self):
2812         return self.api(self.papi.bier_imp_dump, {})
2813
2814     def bier_disp_table_add_del(self,
2815                                 bdti,
2816                                 is_add=1):
2817         """ BIER Disposition Table add/del """
2818         return self.api(
2819             self.papi.bier_disp_table_add_del,
2820             {'bdt_tbl_id': bdti,
2821              'bdt_is_add': is_add})
2822
2823     def bier_disp_table_dump(self):
2824         return self.api(self.papi.bier_disp_table_dump, {})
2825
2826     def bier_disp_entry_add_del(self,
2827                                 bdti,
2828                                 bp,
2829                                 payload_proto,
2830                                 next_hop,
2831                                 next_hop_tbl_id=0,
2832                                 next_hop_rpf_id=~0,
2833                                 next_hop_is_ip4=1,
2834                                 is_add=1):
2835         """ BIER Route add/del """
2836         return self.api(
2837             self.papi.bier_disp_entry_add_del,
2838             {'bde_tbl_id': bdti,
2839              'bde_bp': bp,
2840              'bde_payload_proto': payload_proto,
2841              'bde_n_paths': 1,
2842              'bde_paths': [{'next_hop': next_hop,
2843                             'table_id': next_hop_tbl_id,
2844                             'afi': 0,
2845                             'rpf_id': next_hop_rpf_id,
2846                             'n_labels': 0,
2847                             'label_stack': [0]}],
2848              'bde_is_add': is_add})
2849
2850     def bier_disp_entry_dump(self, bdti):
2851         return self.api(
2852             self.papi.bier_disp_entry_dump,
2853             {'bde_tbl_id': bdti})
2854
2855     def add_node_next(self, node_name, next_name):
2856         """ Set the next node for a given node request
2857
2858         :param node_name:
2859         :param next_name:
2860         """
2861         return self.api(self.papi.add_node_next,
2862                         {'node_name': node_name,
2863                          'next_name': next_name})
2864
2865     def session_enable_disable(self, is_enabled):
2866         return self.api(
2867             self.papi.session_enable_disable,
2868             {'is_enable': is_enabled})
2869
2870     def ipsec_spd_add_del(self, spd_id, is_add=1):
2871         """ SPD add/del - Wrapper to add or del ipsec SPD
2872         Sample CLI : 'ipsec spd add 1'
2873
2874         :param spd_id - SPD ID to be created in the vpp . mandatory
2875         :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2876               optional
2877         :returns: reply from the API
2878         """
2879         return self.api(
2880             self.papi.ipsec_spd_add_del, {
2881                 'spd_id': spd_id, 'is_add': is_add})
2882
2883     def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2884         """ IPSEC interface SPD add/del - \
2885              Wrapper to associate/disassociate SPD to interface in VPP
2886         Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2887
2888         :param spd_id - SPD ID to associate with the interface . mandatory
2889         :param sw_if_index - Interface Index which needs to ipsec \
2890             association mandatory
2891         :param is_add - add(1) or del(0) association with interface \
2892                 (Default 1 - add) . optional
2893         :returns: reply from the API
2894         """
2895         return self.api(
2896             self.papi.ipsec_interface_add_del_spd, {
2897                 'spd_id': spd_id,
2898                 'sw_if_index': sw_if_index, 'is_add': is_add})
2899
2900     def ipsec_sad_add_del_entry(self,
2901                                 sad_id,
2902                                 spi,
2903                                 tunnel_src_address='',
2904                                 tunnel_dst_address='',
2905                                 protocol=0,
2906                                 integrity_algorithm=2,
2907                                 integrity_key_length=0,
2908                                 integrity_key='C91KUR9GYMm5GfkEvNjX',
2909                                 crypto_algorithm=1,
2910                                 crypto_key_length=0,
2911                                 crypto_key='JPjyOWBeVEQiMe7h',
2912                                 is_add=1,
2913                                 is_tunnel=1):
2914         """ IPSEC SA add/del
2915         Sample CLI : 'ipsec sa add 10 spi 1001 esp \
2916             crypto-key 4a506a794f574265564551694d653768 \
2917             crypto-alg aes-cbc-128 \
2918             integ-key 4339314b55523947594d6d3547666b45764e6a58 \
2919             integ-alg sha1-96 tunnel-src 192.168.100.3 \
2920             tunnel-dst 192.168.100.2'
2921         Sample CLI : 'ipsec sa add 20 spi 2001 \
2922             integ-key 4339314b55523947594d6d3547666b45764e6a58 \
2923             integ-alg sha1-96'
2924
2925         :param sad_id -  Security Association ID to be \
2926             created or deleted. mandatory
2927         :param spi - security param index of the SA in decimal. mandatory
2928         :param tunnel_src_address - incase of tunnel mode outer src address .\
2929              mandatory for tunnel mode
2930         :param tunnel_dst_address - incase of transport mode \
2931              outer dst address. mandatory for tunnel mode
2932         :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional
2933         :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\
2934              optional **
2935         :param integrity_key - value in string \
2936              (Default C91KUR9GYMm5GfkEvNjX).optional
2937         :param integrity_key_length - length of the key string in bytes\
2938              (Default 0 - integrity disabled). optional
2939         :param crypto_algorithm - value range 1-11 Default \
2940              (1- AES_CBC_128).optional **
2941         :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional
2942         :param crypto_key_length - length of the key string in bytes\
2943              (Default 0 - crypto disabled). optional
2944         :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\
2945              optional
2946         :param is_tunnel - tunnel mode (1) or transport mode(0) \
2947              (Default 1 - tunnel). optional
2948         :returns: reply from the API
2949         :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
2950              crypto and ipsec algorithms
2951         """
2952         return self.api(
2953             self.papi.ipsec_sad_add_del_entry,
2954             {'sad_id': sad_id,
2955              'spi': spi,
2956              'tunnel_src_address': tunnel_src_address,
2957              'tunnel_dst_address': tunnel_dst_address,
2958              'protocol': protocol,
2959              'integrity_algorithm': integrity_algorithm,
2960              'integrity_key_length': integrity_key_length,
2961              'integrity_key': integrity_key,
2962              'crypto_algorithm': crypto_algorithm,
2963              'crypto_key_length': crypto_key_length,
2964              'crypto_key': crypto_key,
2965              'is_add': is_add,
2966              'is_tunnel': is_tunnel})
2967
2968     def ipsec_spd_add_del_entry(self,
2969                                 spd_id,
2970                                 local_address_start,
2971                                 local_address_stop,
2972                                 remote_address_start,
2973                                 remote_address_stop,
2974                                 local_port_start=0,
2975                                 local_port_stop=65535,
2976                                 remote_port_start=0,
2977                                 remote_port_stop=65535,
2978                                 protocol=0,
2979                                 sa_id=10,
2980                                 policy=0,
2981                                 priority=100,
2982                                 is_outbound=1,
2983                                 is_add=1,
2984                                 is_ip_any=0):
2985         """ IPSEC policy SPD add/del   -
2986                     Wrapper to configure ipsec SPD policy entries in VPP
2987         Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \
2988                      protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \
2989                      remote-ip-range 192.168.3.3 - 192.168.3.3'
2990
2991         :param spd_id -  SPD ID for the policy . mandatory
2992         :param local_address_start - local-ip-range start address . mandatory
2993         :param local_address_stop  - local-ip-range stop address . mandatory
2994         :param remote_address_start - remote-ip-range start address . mandatory
2995         :param remote_address_stop  - remote-ip-range stop address . mandatory
2996         :param local_port_start - (Default 0) . optional
2997         :param local_port_stop - (Default 65535). optional
2998         :param remote_port_start - (Default 0). optional
2999         :param remote_port_stop - (Default 65535). optional
3000         :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any).
3001                optional
3002         :param sa_id -  Security Association ID for mapping it to SPD
3003                (default 10).   optional
3004         :param policy - bypass(0), discard(1), resolve(2) or protect(3)action
3005                (Default 0 - bypass). optional
3006         :param priotity - value for the spd action (Default 100). optional
3007         :param is_outbound - flag for inbound(0) or outbound(1)
3008                (Default 1 - outbound). optional
3009         :param is_add flag - for addition(1) or deletion(0) of the spd
3010                (Default 1 - addtion). optional
3011         :returns: reply from the API
3012         """
3013         return self.api(
3014             self.papi.ipsec_spd_add_del_entry,
3015             {'spd_id': spd_id,
3016              'local_address_start': local_address_start,
3017              'local_address_stop': local_address_stop,
3018              'remote_address_start': remote_address_start,
3019              'remote_address_stop': remote_address_stop,
3020              'local_port_start': local_port_start,
3021              'local_port_stop': local_port_stop,
3022              'remote_port_start': remote_port_start,
3023              'remote_port_stop': remote_port_stop,
3024              'is_add': is_add,
3025              'protocol': protocol,
3026              'policy': policy,
3027              'priority': priority,
3028              'is_outbound': is_outbound,
3029              'sa_id': sa_id,
3030              'is_ip_any': is_ip_any})
3031
3032     def app_namespace_add(self,
3033                           namespace_id,
3034                           ip4_fib_id=0,
3035                           ip6_fib_id=0,
3036                           sw_if_index=0xFFFFFFFF,
3037                           secret=0):
3038         return self.api(
3039             self.papi.app_namespace_add_del,
3040             {'secret': secret,
3041              'sw_if_index': sw_if_index,
3042              'ip4_fib_id': ip4_fib_id,
3043              'ip6_fib_id': ip6_fib_id,
3044              'namespace_id': namespace_id,
3045              'namespace_id_len': len(namespace_id)})