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             is_add=1):
1239         """Add/delete NAT44 static mapping
1240
1241         :param local_ip: Local IP address
1242         :param external_ip: External IP address
1243         :param external_sw_if_index: External interface instead of IP address
1244         :param local_port: Local port number (Default value = 0)
1245         :param external_port: External port number (Default value = 0)
1246         :param addr_only: 1 if address only mapping, 0 if address and port
1247         :param vrf_id: VRF ID
1248         :param protocol: IP protocol (Default value = 0)
1249         :param twice_nat: 1 if translate external host address and port
1250         :param is_add: 1 if add, 0 if delete (Default value = 1)
1251         """
1252         return self.api(
1253             self.papi.nat44_add_del_static_mapping,
1254             {'is_add': is_add,
1255              'addr_only': addr_only,
1256              'local_ip_address': local_ip,
1257              'external_ip_address': external_ip,
1258              'local_port': local_port,
1259              'external_port': external_port,
1260              'external_sw_if_index': external_sw_if_index,
1261              'vrf_id': vrf_id,
1262              'protocol': protocol,
1263              'twice_nat': twice_nat})
1264
1265     def nat44_add_del_identity_mapping(
1266             self,
1267             ip='0',
1268             sw_if_index=0xFFFFFFFF,
1269             port=0,
1270             addr_only=1,
1271             vrf_id=0,
1272             protocol=0,
1273             is_add=1):
1274         """Add/delete NAT44 identity mapping
1275
1276         :param ip: IP address (Default value = 0)
1277         :param sw_if_index: Interface instead of IP address
1278         :param port: Port number (Default value = 0)
1279         :param addr_only: 1 if address only mapping, 0 if address and port
1280         :param vrf_id: VRF ID
1281         :param protocol: IP protocol (Default value = 0)
1282         :param is_add: 1 if add, 0 if delete (Default value = 1)
1283         """
1284         return self.api(
1285             self.papi.nat44_add_del_identity_mapping,
1286             {'is_add': is_add,
1287              'addr_only': addr_only,
1288              'ip_address': ip,
1289              'port': port,
1290              'sw_if_index': sw_if_index,
1291              'vrf_id': vrf_id,
1292              'protocol': protocol})
1293
1294     def nat44_add_del_address_range(
1295             self,
1296             first_ip_address,
1297             last_ip_address,
1298             is_add=1,
1299             vrf_id=0xFFFFFFFF,
1300             twice_nat=0):
1301         """Add/del NAT44 address range
1302
1303         :param first_ip_address: First IP address
1304         :param last_ip_address: Last IP address
1305         :param vrf_id: VRF id for the address range
1306         :param twice_nat: twice NAT address for extenal hosts
1307         :param is_add: 1 if add, 0 if delete (Default value = 1)
1308         """
1309         return self.api(
1310             self.papi.nat44_add_del_address_range,
1311             {'first_ip_address': first_ip_address,
1312              'last_ip_address': last_ip_address,
1313              'vrf_id': vrf_id,
1314              'twice_nat': twice_nat,
1315              'is_add': is_add})
1316
1317     def nat44_address_dump(self):
1318         """Dump NAT44 addresses
1319         :return: Dictionary of NAT44 addresses
1320         """
1321         return self.api(self.papi.nat44_address_dump, {})
1322
1323     def nat44_interface_dump(self):
1324         """Dump interfaces with NAT44 feature
1325         :return: Dictionary of interfaces with NAT44 feature
1326         """
1327         return self.api(self.papi.nat44_interface_dump, {})
1328
1329     def nat44_interface_output_feature_dump(self):
1330         """Dump interfaces with NAT44 output feature
1331         :return: Dictionary of interfaces with NAT44 output feature
1332         """
1333         return self.api(self.papi.nat44_interface_output_feature_dump, {})
1334
1335     def nat44_static_mapping_dump(self):
1336         """Dump NAT44 static mappings
1337         :return: Dictionary of NAT44 static mappings
1338         """
1339         return self.api(self.papi.nat44_static_mapping_dump, {})
1340
1341     def nat44_identity_mapping_dump(self):
1342         """Dump NAT44 identity mappings
1343         :return: Dictionary of NAT44 identity mappings
1344         """
1345         return self.api(self.papi.nat44_identity_mapping_dump, {})
1346
1347     def nat_show_config(self):
1348         """Show NAT plugin config
1349         :return: NAT plugin config parameters
1350         """
1351         return self.api(self.papi.nat_show_config, {})
1352
1353     def nat44_add_interface_addr(
1354             self,
1355             sw_if_index,
1356             twice_nat=0,
1357             is_add=1):
1358         """Add/del NAT44 address from interface
1359
1360         :param sw_if_index: Software index of the interface
1361         :param twice_nat: twice NAT address for extenal hosts
1362         :param is_add: 1 if add, 0 if delete (Default value = 1)
1363         """
1364         return self.api(
1365             self.papi.nat44_add_del_interface_addr,
1366             {'is_add': is_add,
1367              'sw_if_index': sw_if_index,
1368              'twice_nat': twice_nat})
1369
1370     def nat44_interface_addr_dump(self):
1371         """Dump NAT44 addresses interfaces
1372         :return: Dictionary of NAT44 addresses interfaces
1373         """
1374         return self.api(self.papi.nat44_interface_addr_dump, {})
1375
1376     def nat_ipfix(
1377             self,
1378             domain_id=1,
1379             src_port=4739,
1380             enable=1):
1381         """Enable/disable NAT IPFIX logging
1382
1383         :param domain_id: Observation domain ID (Default value = 1)
1384         :param src_port: Source port number (Default value = 4739)
1385         :param enable: 1 if enable, 0 if disable (Default value = 1)
1386         """
1387         return self.api(
1388             self.papi.nat_ipfix_enable_disable,
1389             {'domain_id': domain_id,
1390              'src_port': src_port,
1391              'enable': enable})
1392
1393     def nat44_user_session_dump(
1394             self,
1395             ip_address,
1396             vrf_id):
1397         """Dump NAT44 user's sessions
1398
1399         :param ip_address: ip adress of the user to be dumped
1400         :param cpu_index: cpu_index on which the user is
1401         :param vrf_id: VRF ID
1402         :return: Dictionary of S-NAT sessions
1403         """
1404         return self.api(
1405             self.papi.nat44_user_session_dump,
1406             {'ip_address': ip_address,
1407              'vrf_id': vrf_id})
1408
1409     def nat44_user_dump(self):
1410         """Dump NAT44 users
1411
1412         :return: Dictionary of NAT44 users
1413         """
1414         return self.api(self.papi.nat44_user_dump, {})
1415
1416     def nat44_add_del_lb_static_mapping(
1417             self,
1418             external_addr,
1419             external_port,
1420             protocol,
1421             vrf_id=0,
1422             twice_nat=0,
1423             out2in_only=0,
1424             local_num=0,
1425             locals=[],
1426             is_add=1):
1427         """Add/delete NAT44 load balancing static mapping
1428
1429         :param twice_nat: 1 if translate external host address and port
1430         :param is_add - 1 if add, 0 if delete
1431         """
1432         return self.api(
1433             self.papi.nat44_add_del_lb_static_mapping,
1434             {'is_add': is_add,
1435              'external_addr': external_addr,
1436              'external_port': external_port,
1437              'protocol': protocol,
1438              'vrf_id': vrf_id,
1439              'twice_nat': twice_nat,
1440              'out2in_only': out2in_only,
1441              'local_num': local_num,
1442              'locals': locals})
1443
1444     def nat44_lb_static_mapping_dump(self):
1445         """Dump NAT44 load balancing static mappings
1446
1447         :return: Dictionary of NAT44 load balancing static mapping
1448         """
1449         return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1450
1451     def nat44_del_session(
1452             self,
1453             addr,
1454             port,
1455             protocol,
1456             vrf_id=0,
1457             is_in=1):
1458         """Delete NAT44 session
1459
1460         :param addr: IPv4 address
1461         :param por: port number
1462         :param protocol: IP protocol number
1463         :param vrf_id: VRF ID
1464         :param is_in: 1 if inside network addres and port pari, 0 if outside
1465         """
1466         return self.api(
1467             self.papi.nat44_del_session,
1468             {'address': addr,
1469              'port': port,
1470              'protocol': protocol,
1471              'vrf_id': vrf_id,
1472              'is_in': is_in})
1473
1474     def nat44_forwarding_enable_disable(
1475             self,
1476             enable):
1477         """Enable/disable forwarding for NAT44
1478
1479         :param enable: 1 for enable, 0 for disable
1480         """
1481         return self.api(
1482             self.papi.nat44_forwarding_enable_disable,
1483             {'enable': enable})
1484
1485     def nat_set_reass(
1486             self,
1487             timeout=2,
1488             max_reass=1024,
1489             max_frag=5,
1490             drop_frag=0,
1491             is_ip6=0):
1492         """Set NAT virtual fragmentation reassembly
1493
1494         :param timeout: reassembly timeout (Default 2sec)
1495         :param max_reass: maximum concurrent reassemblies (Default 1024)
1496         :param max_frag: maximum fragmets per reassembly (Default 5)
1497         :param drop_frag: if 0 translate fragments, otherwise drop fragments
1498         :param is_ip6: 1 if IPv6, 0 if IPv4
1499         """
1500         return self.api(
1501             self.papi.nat_set_reass,
1502             {'timeout': timeout,
1503              'max_reass': max_reass,
1504              'max_frag': max_frag,
1505              'drop_frag': drop_frag,
1506              'is_ip6': is_ip6})
1507
1508     def nat_get_reass(self):
1509         """Get NAT virtual fragmentation reassembly configuration
1510
1511         :return: NAT virtual fragmentation reassembly configuration
1512         """
1513         return self.api(self.papi.nat_get_reass, {})
1514
1515     def nat_reass_dump(self):
1516         """Dump NAT virtual fragmentation reassemblies
1517
1518         :return: Dictionary of NAT virtual fragmentation reassemblies
1519         """
1520         return self.api(self.papi.nat_reass_dump, {})
1521
1522     def nat_det_add_del_map(
1523             self,
1524             in_addr,
1525             in_plen,
1526             out_addr,
1527             out_plen,
1528             is_add=1):
1529         """Add/delete deterministic NAT mapping
1530
1531         :param is_add - 1 if add, 0 if delete
1532         :param in_addr - inside IP address
1533         :param in_plen - inside IP address prefix length
1534         :param out_addr - outside IP address
1535         :param out_plen - outside IP address prefix length
1536         """
1537         return self.api(
1538             self.papi.nat_det_add_del_map,
1539             {'is_add': is_add,
1540              'is_nat44': 1,
1541              'in_addr': in_addr,
1542              'in_plen': in_plen,
1543              'out_addr': out_addr,
1544              'out_plen': out_plen})
1545
1546     def nat_det_forward(
1547             self,
1548             in_addr):
1549         """Get outside address and port range from inside address
1550
1551         :param in_addr - inside IP address
1552         """
1553         return self.api(
1554             self.papi.nat_det_forward,
1555             {'in_addr': in_addr,
1556              'is_nat44': 1})
1557
1558     def nat_det_reverse(
1559             self,
1560             out_addr,
1561             out_port):
1562         """Get inside address from outside address and port
1563
1564         :param out_addr - outside IP address
1565         :param out_port - outside port
1566         """
1567         return self.api(
1568             self.papi.nat_det_reverse,
1569             {'out_addr': out_addr,
1570              'out_port': out_port})
1571
1572     def nat_det_map_dump(self):
1573         """Dump deterministic NAT mappings
1574
1575         :return: Dictionary of deterministic NAT mappings
1576         """
1577         return self.api(self.papi.nat_det_map_dump, {})
1578
1579     def nat_det_set_timeouts(
1580             self,
1581             udp=300,
1582             tcp_established=7440,
1583             tcp_transitory=240,
1584             icmp=60):
1585         """Set values of timeouts for deterministic NAT (in seconds)
1586
1587         :param udp - UDP timeout (Default value = 300)
1588         :param tcp_established - TCP established timeout (Default value = 7440)
1589         :param tcp_transitory - TCP transitory timeout (Default value = 240)
1590         :param icmp - ICMP timeout (Default value = 60)
1591         """
1592         return self.api(
1593             self.papi.nat_det_set_timeouts,
1594             {'udp': udp,
1595              'tcp_established': tcp_established,
1596              'tcp_transitory': tcp_transitory,
1597              'icmp': icmp})
1598
1599     def nat_det_get_timeouts(self):
1600         """Get values of timeouts for deterministic NAT
1601
1602         :return: Timeouts for deterministic NAT (in seconds)
1603         """
1604         return self.api(self.papi.nat_det_get_timeouts, {})
1605
1606     def nat_det_close_session_out(
1607             self,
1608             out_addr,
1609             out_port,
1610             ext_addr,
1611             ext_port):
1612         """Close deterministic NAT session using outside address and port
1613
1614         :param out_addr - outside IP address
1615         :param out_port - outside port
1616         :param ext_addr - external host IP address
1617         :param ext_port - external host port
1618         """
1619         return self.api(
1620             self.papi.nat_det_close_session_out,
1621             {'out_addr': out_addr,
1622              'out_port': out_port,
1623              'ext_addr': ext_addr,
1624              'ext_port': ext_port})
1625
1626     def nat_det_close_session_in(
1627             self,
1628             in_addr,
1629             in_port,
1630             ext_addr,
1631             ext_port):
1632         """Close deterministic NAT session using inside address and port
1633
1634         :param in_addr - inside IP address
1635         :param in_port - inside port
1636         :param ext_addr - external host IP address
1637         :param ext_port - external host port
1638         """
1639         return self.api(
1640             self.papi.nat_det_close_session_in,
1641             {'in_addr': in_addr,
1642              'in_port': in_port,
1643              'ext_addr': ext_addr,
1644              'ext_port': ext_port,
1645              'is_nat44': 1})
1646
1647     def nat_det_session_dump(
1648             self,
1649             user_addr):
1650         """Dump deterministic NAT sessions belonging to a user
1651
1652         :param user_addr - inside IP address of the user
1653         :return: Dictionary of deterministic NAT sessions
1654         """
1655         return self.api(
1656             self.papi.nat_det_session_dump,
1657             {'is_nat44': 1,
1658              'user_addr': user_addr})
1659
1660     def nat64_add_del_pool_addr_range(
1661             self,
1662             start_addr,
1663             end_addr,
1664             vrf_id=0xFFFFFFFF,
1665             is_add=1):
1666         """Add/del address range to NAT64 pool
1667
1668         :param start_addr: First IP address
1669         :param end_addr: Last IP address
1670         :param vrf_id: VRF id for the address range
1671         :param is_add: 1 if add, 0 if delete (Default value = 1)
1672         """
1673         return self.api(
1674             self.papi.nat64_add_del_pool_addr_range,
1675             {'start_addr': start_addr,
1676              'end_addr': end_addr,
1677              'vrf_id': vrf_id,
1678              'is_add': is_add})
1679
1680     def nat64_pool_addr_dump(self):
1681         """Dump NAT64 pool addresses
1682         :return: Dictionary of NAT64 pool addresses
1683         """
1684         return self.api(self.papi.nat64_pool_addr_dump, {})
1685
1686     def nat64_add_del_interface(
1687             self,
1688             sw_if_index,
1689             is_inside=1,
1690             is_add=1):
1691         """Enable/disable NAT64 feature on the interface
1692            :param sw_if_index: Index of the interface
1693            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1694            :param is_add: 1 if add, 0 if delete (Default value = 1)
1695         """
1696         return self.api(
1697             self.papi.nat64_add_del_interface,
1698             {'sw_if_index': sw_if_index,
1699              'is_inside': is_inside,
1700              'is_add': is_add})
1701
1702     def nat64_interface_dump(self):
1703         """Dump interfaces with NAT64 feature
1704         :return: Dictionary of interfaces with NAT64 feature
1705         """
1706         return self.api(self.papi.nat64_interface_dump, {})
1707
1708     def nat64_add_del_static_bib(
1709             self,
1710             in_ip,
1711             out_ip,
1712             in_port,
1713             out_port,
1714             protocol,
1715             vrf_id=0,
1716             is_add=1):
1717         """Add/delete S-NAT static BIB entry
1718
1719         :param in_ip: Inside IPv6 address
1720         :param out_ip: Outside IPv4 address
1721         :param in_port: Inside port number
1722         :param out_port: Outside port number
1723         :param protocol: IP protocol
1724         :param vrf_id: VRF ID (Default value = 0)
1725         :param is_add: 1 if add, 0 if delete (Default value = 1)
1726         """
1727         return self.api(
1728             self.papi.nat64_add_del_static_bib,
1729             {'i_addr': in_ip,
1730              'o_addr': out_ip,
1731              'i_port': in_port,
1732              'o_port': out_port,
1733              'vrf_id': vrf_id,
1734              'proto': protocol,
1735              'is_add': is_add})
1736
1737     def nat64_bib_dump(self, protocol=255):
1738         """Dump NAT64 BIB
1739
1740         :param protocol: IP protocol (Default value = 255, all BIBs)
1741         :returns: Dictionary of NAT64 BIB entries
1742         """
1743         return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1744
1745     def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1746                            tcp_incoming_syn=6):
1747         """Set values of timeouts for NAT64 (in seconds)
1748
1749         :param udpi: UDP timeout (Default value = 300)
1750         :param icmp: ICMP timeout (Default value = 60)
1751         :param tcp_trans: TCP transitory timeout (Default value = 240)
1752         :param tcp_est: TCP established timeout (Default value = 7440)
1753         :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1754         """
1755         return self.api(
1756             self.papi.nat64_set_timeouts,
1757             {'udp': udp,
1758              'icmp': icmp,
1759              'tcp_trans': tcp_trans,
1760              'tcp_est': tcp_est,
1761              'tcp_incoming_syn': tcp_incoming_syn})
1762
1763     def nat64_get_timeouts(self):
1764         """Get values of timeouts for NAT64
1765
1766         :return: Timeouts for NAT64 (in seconds)
1767         """
1768         return self.api(self.papi.nat64_get_timeouts, {})
1769
1770     def nat64_st_dump(self, protocol=255):
1771         """Dump NAT64 session table
1772
1773         :param protocol: IP protocol (Default value = 255, all STs)
1774         :returns: Dictionary of NAT64 sesstion table entries
1775         """
1776         return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1777
1778     def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1779         """Add/del NAT64 prefix
1780
1781         :param prefix: NAT64 prefix
1782         :param plen: NAT64 prefix length
1783         :param vrf_id: VRF id of tenant (Default 0)
1784         :param is_add: 1 if add, 0 if delete (Default value = 1)
1785         """
1786         return self.api(
1787             self.papi.nat64_add_del_prefix,
1788             {'prefix': prefix,
1789              'prefix_len': plen,
1790              'vrf_id': vrf_id,
1791              'is_add': is_add})
1792
1793     def nat64_prefix_dump(self):
1794         """Dump NAT64 prefix
1795
1796         :returns: Dictionary of NAT64 prefixes
1797         """
1798         return self.api(self.papi.nat64_prefix_dump, {})
1799
1800     def nat64_add_interface_addr(
1801             self,
1802             sw_if_index,
1803             is_add=1):
1804         """Add/del NAT64 address from interface
1805
1806         :param sw_if_index: Software index of the interface
1807         :param is_add: 1 if add, 0 if delete (Default value = 1)
1808         """
1809         return self.api(self.papi.nat64_add_del_interface_addr,
1810                         {'is_add': is_add, 'sw_if_index': sw_if_index})
1811
1812     def dslite_set_aftr_addr(self, ip6, ip4):
1813         """Set DS-Lite AFTR addresses
1814
1815         :param ip4: IPv4 address
1816         :param ip6: IPv6 address
1817         """
1818         return self.api(
1819             self.papi.dslite_set_aftr_addr,
1820             {'ip4_addr': ip4,
1821              'ip6_addr': ip6})
1822
1823     def dslite_set_b4_addr(self, ip6, ip4):
1824         """Set DS-Lite B4 IPv6 address
1825
1826         :param ip4: IPv4 address
1827         :param ip6: IPv6 address
1828         """
1829         return self.api(
1830             self.papi.dslite_set_b4_addr,
1831             {'ip4_addr': ip4,
1832              'ip6_addr': ip6})
1833
1834     def dslite_add_del_pool_addr_range(
1835             self,
1836             start_addr,
1837             end_addr,
1838             is_add=1):
1839         """Add/del address range to DS-Lite pool
1840
1841         :param start_addr: First IP address
1842         :param end_addr: Last IP address
1843         :param is_add: 1 if add, 0 if delete (Default value = 1)
1844         """
1845         return self.api(
1846             self.papi.dslite_add_del_pool_addr_range,
1847             {'start_addr': start_addr,
1848              'end_addr': end_addr,
1849              'is_add': is_add})
1850
1851     def control_ping(self):
1852         self.api(self.papi.control_ping)
1853
1854     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1855                     detect_mult, local_addr, peer_addr, is_ipv6=0,
1856                     bfd_key_id=None, conf_key_id=None):
1857         if bfd_key_id is None:
1858             return self.api(self.papi.bfd_udp_add,
1859                             {
1860                                 'sw_if_index': sw_if_index,
1861                                 'desired_min_tx': desired_min_tx,
1862                                 'required_min_rx': required_min_rx,
1863                                 'local_addr': local_addr,
1864                                 'peer_addr': peer_addr,
1865                                 'is_ipv6': is_ipv6,
1866                                 'detect_mult': detect_mult,
1867                             })
1868         else:
1869             return self.api(self.papi.bfd_udp_add,
1870                             {
1871                                 'sw_if_index': sw_if_index,
1872                                 'desired_min_tx': desired_min_tx,
1873                                 'required_min_rx': required_min_rx,
1874                                 'local_addr': local_addr,
1875                                 'peer_addr': peer_addr,
1876                                 'is_ipv6': is_ipv6,
1877                                 'detect_mult': detect_mult,
1878                                 'is_authenticated': 1,
1879                                 'bfd_key_id': bfd_key_id,
1880                                 'conf_key_id': conf_key_id,
1881                             })
1882
1883     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1884                     detect_mult, local_addr, peer_addr, is_ipv6=0):
1885         return self.api(self.papi.bfd_udp_mod,
1886                         {
1887                             'sw_if_index': sw_if_index,
1888                             'desired_min_tx': desired_min_tx,
1889                             'required_min_rx': required_min_rx,
1890                             'local_addr': local_addr,
1891                             'peer_addr': peer_addr,
1892                             'is_ipv6': is_ipv6,
1893                             'detect_mult': detect_mult,
1894                         })
1895
1896     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1897                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1898                               is_delayed=False):
1899         return self.api(self.papi.bfd_udp_auth_activate,
1900                         {
1901                             'sw_if_index': sw_if_index,
1902                             'local_addr': local_addr,
1903                             'peer_addr': peer_addr,
1904                             'is_ipv6': is_ipv6,
1905                             'is_delayed': 1 if is_delayed else 0,
1906                             'bfd_key_id': bfd_key_id,
1907                             'conf_key_id': conf_key_id,
1908                         })
1909
1910     def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1911                                 is_ipv6=0, is_delayed=False):
1912         return self.api(self.papi.bfd_udp_auth_deactivate,
1913                         {
1914                             'sw_if_index': sw_if_index,
1915                             'local_addr': local_addr,
1916                             'peer_addr': peer_addr,
1917                             'is_ipv6': is_ipv6,
1918                             'is_delayed': 1 if is_delayed else 0,
1919                         })
1920
1921     def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1922         return self.api(self.papi.bfd_udp_del,
1923                         {
1924                             'sw_if_index': sw_if_index,
1925                             'local_addr': local_addr,
1926                             'peer_addr': peer_addr,
1927                             'is_ipv6': is_ipv6,
1928                         })
1929
1930     def bfd_udp_session_dump(self):
1931         return self.api(self.papi.bfd_udp_session_dump, {})
1932
1933     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1934                                   peer_addr, is_ipv6=0):
1935         return self.api(self.papi.bfd_udp_session_set_flags, {
1936             'admin_up_down': admin_up_down,
1937             'sw_if_index': sw_if_index,
1938             'local_addr': local_addr,
1939             'peer_addr': peer_addr,
1940             'is_ipv6': is_ipv6,
1941         })
1942
1943     def want_bfd_events(self, enable_disable=1):
1944         return self.api(self.papi.want_bfd_events, {
1945             'enable_disable': enable_disable,
1946             'pid': os.getpid(),
1947         })
1948
1949     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1950         return self.api(self.papi.bfd_auth_set_key, {
1951             'conf_key_id': conf_key_id,
1952             'auth_type': auth_type,
1953             'key': key,
1954             'key_len': len(key),
1955         })
1956
1957     def bfd_auth_del_key(self, conf_key_id):
1958         return self.api(self.papi.bfd_auth_del_key, {
1959             'conf_key_id': conf_key_id,
1960         })
1961
1962     def bfd_auth_keys_dump(self):
1963         return self.api(self.papi.bfd_auth_keys_dump, {})
1964
1965     def bfd_udp_set_echo_source(self, sw_if_index):
1966         return self.api(self.papi.bfd_udp_set_echo_source,
1967                         {'sw_if_index': sw_if_index})
1968
1969     def bfd_udp_del_echo_source(self):
1970         return self.api(self.papi.bfd_udp_del_echo_source, {})
1971
1972     def classify_add_del_table(
1973             self,
1974             is_add,
1975             mask,
1976             match_n_vectors=1,
1977             table_index=0xFFFFFFFF,
1978             nbuckets=2,
1979             memory_size=2097152,
1980             skip_n_vectors=0,
1981             next_table_index=0xFFFFFFFF,
1982             miss_next_index=0xFFFFFFFF,
1983             current_data_flag=0,
1984             current_data_offset=0):
1985         """
1986         :param is_add:
1987         :param mask:
1988         :param match_n_vectors: (Default value = 1)
1989         :param table_index: (Default value = 0xFFFFFFFF)
1990         :param nbuckets:  (Default value = 2)
1991         :param memory_size:  (Default value = 2097152)
1992         :param skip_n_vectors:  (Default value = 0)
1993         :param next_table_index:  (Default value = 0xFFFFFFFF)
1994         :param miss_next_index:  (Default value = 0xFFFFFFFF)
1995         :param current_data_flag:  (Default value = 0)
1996         :param current_data_offset:  (Default value = 0)
1997         """
1998
1999         return self.api(
2000             self.papi.classify_add_del_table,
2001             {'is_add': is_add,
2002              'table_index': table_index,
2003              'nbuckets': nbuckets,
2004              'memory_size': memory_size,
2005              'skip_n_vectors': skip_n_vectors,
2006              'match_n_vectors': match_n_vectors,
2007              'next_table_index': next_table_index,
2008              'miss_next_index': miss_next_index,
2009              'current_data_flag': current_data_flag,
2010              'current_data_offset': current_data_offset,
2011              'mask': mask})
2012
2013     def classify_add_del_session(
2014             self,
2015             is_add,
2016             table_index,
2017             match,
2018             opaque_index=0xFFFFFFFF,
2019             hit_next_index=0xFFFFFFFF,
2020             advance=0,
2021             action=0,
2022             metadata=0):
2023         """
2024         :param is_add:
2025         :param table_index:
2026         :param match:
2027         :param opaque_index:  (Default value = 0xFFFFFFFF)
2028         :param hit_next_index:  (Default value = 0xFFFFFFFF)
2029         :param advance:  (Default value = 0)
2030         :param action:  (Default value = 0)
2031         :param metadata:  (Default value = 0)
2032         """
2033
2034         return self.api(
2035             self.papi.classify_add_del_session,
2036             {'is_add': is_add,
2037              'table_index': table_index,
2038              'hit_next_index': hit_next_index,
2039              'opaque_index': opaque_index,
2040              'advance': advance,
2041              'action': action,
2042              'metadata': metadata,
2043              'match': match})
2044
2045     def input_acl_set_interface(
2046             self,
2047             is_add,
2048             sw_if_index,
2049             ip4_table_index=0xFFFFFFFF,
2050             ip6_table_index=0xFFFFFFFF,
2051             l2_table_index=0xFFFFFFFF):
2052         """
2053         :param is_add:
2054         :param sw_if_index:
2055         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
2056         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
2057         :param l2_table_index:  (Default value = 0xFFFFFFFF)
2058         """
2059
2060         return self.api(
2061             self.papi.input_acl_set_interface,
2062             {'sw_if_index': sw_if_index,
2063              'ip4_table_index': ip4_table_index,
2064              'ip6_table_index': ip6_table_index,
2065              'l2_table_index': l2_table_index,
2066              'is_add': is_add})
2067
2068     def set_ipfix_exporter(
2069             self,
2070             collector_address,
2071             src_address,
2072             path_mtu,
2073             template_interval,
2074             vrf_id=0,
2075             collector_port=4739,
2076             udp_checksum=0):
2077         return self.api(
2078             self.papi.set_ipfix_exporter,
2079             {
2080                 'collector_address': collector_address,
2081                 'collector_port': collector_port,
2082                 'src_address': src_address,
2083                 'vrf_id': vrf_id,
2084                 'path_mtu': path_mtu,
2085                 'template_interval': template_interval,
2086                 'udp_checksum': udp_checksum,
2087             })
2088
2089     def dhcp_proxy_config(self,
2090                           dhcp_server,
2091                           dhcp_src_address,
2092                           rx_table_id=0,
2093                           server_table_id=0,
2094                           is_add=1,
2095                           is_ipv6=0):
2096         return self.api(
2097             self.papi.dhcp_proxy_config,
2098             {
2099                 'rx_vrf_id': rx_table_id,
2100                 'server_vrf_id': server_table_id,
2101                 'is_ipv6': is_ipv6,
2102                 'is_add': is_add,
2103                 'dhcp_server': dhcp_server,
2104                 'dhcp_src_address': dhcp_src_address,
2105             })
2106
2107     def dhcp_proxy_set_vss(self,
2108                            table_id,
2109                            vss_type=255,
2110                            vpn_ascii_id="",
2111                            oui=0,
2112                            vpn_index=0,
2113                            is_add=1,
2114                            is_ip6=0):
2115         return self.api(
2116             self.papi.dhcp_proxy_set_vss,
2117             {
2118                 'tbl_id': table_id,
2119                 'vss_type': vss_type,
2120                 'vpn_ascii_id': vpn_ascii_id,
2121                 'oui': oui,
2122                 'vpn_index': vpn_index,
2123                 'is_add': is_add,
2124                 'is_ipv6': is_ip6,
2125             })
2126
2127     def dhcp_client(self,
2128                     sw_if_index,
2129                     hostname,
2130                     client_id='',
2131                     is_add=1,
2132                     want_dhcp_events=0):
2133         return self.api(
2134             self.papi.dhcp_client_config,
2135             {
2136                 'sw_if_index': sw_if_index,
2137                 'hostname': hostname,
2138                 'client_id': client_id,
2139                 'is_add': is_add,
2140                 'want_dhcp_event': want_dhcp_events,
2141                 'pid': os.getpid(),
2142             })
2143
2144     def ip_mroute_add_del(self,
2145                           src_address,
2146                           grp_address,
2147                           grp_address_length,
2148                           e_flags,
2149                           next_hop_afi,
2150                           next_hop_sw_if_index,
2151                           i_flags,
2152                           bier_imp=0,
2153                           rpf_id=0,
2154                           table_id=0,
2155                           is_add=1,
2156                           is_ipv6=0,
2157                           is_local=0):
2158         """
2159         IP Multicast Route add/del
2160         """
2161         return self.api(
2162             self.papi.ip_mroute_add_del,
2163             {'next_hop_sw_if_index': next_hop_sw_if_index,
2164              'entry_flags': e_flags,
2165              'itf_flags': i_flags,
2166              'table_id': table_id,
2167              'rpf_id': rpf_id,
2168              'is_add': is_add,
2169              'is_ipv6': is_ipv6,
2170              'is_local': is_local,
2171              'bier_imp': bier_imp,
2172              'next_hop_afi': next_hop_afi,
2173              'grp_address_length': grp_address_length,
2174              'grp_address': grp_address,
2175              'src_address': src_address})
2176
2177     def mfib_signal_dump(self):
2178         return self.api(self.papi.mfib_signal_dump, {})
2179
2180     def ip_mfib_dump(self):
2181         return self.api(self.papi.ip_mfib_dump, {})
2182
2183     def ip6_mfib_dump(self):
2184         return self.api(self.papi.ip6_mfib_dump, {})
2185
2186     def lisp_enable_disable(self, is_enabled):
2187         return self.api(
2188             self.papi.lisp_enable_disable,
2189             {
2190                 'is_en': is_enabled,
2191             })
2192
2193     def lisp_locator_set(self,
2194                          ls_name,
2195                          is_add=1):
2196         return self.api(
2197             self.papi.lisp_add_del_locator_set,
2198             {
2199                 'is_add': is_add,
2200                 'locator_set_name': ls_name
2201             })
2202
2203     def lisp_locator_set_dump(self):
2204         return self.api(self.papi.lisp_locator_set_dump, {})
2205
2206     def lisp_locator(self,
2207                      ls_name,
2208                      sw_if_index,
2209                      priority=1,
2210                      weight=1,
2211                      is_add=1):
2212         return self.api(
2213             self.papi.lisp_add_del_locator,
2214             {
2215                 'is_add': is_add,
2216                 'locator_set_name': ls_name,
2217                 'sw_if_index': sw_if_index,
2218                 'priority': priority,
2219                 'weight': weight
2220             })
2221
2222     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2223         return self.api(
2224             self.papi.lisp_locator_dump,
2225             {
2226                 'is_index_set': is_index_set,
2227                 'ls_name': ls_name,
2228                 'ls_index': ls_index,
2229             })
2230
2231     def lisp_local_mapping(self,
2232                            ls_name,
2233                            eid_type,
2234                            eid,
2235                            prefix_len,
2236                            vni=0,
2237                            key_id=0,
2238                            key="",
2239                            is_add=1):
2240         return self.api(
2241             self.papi.lisp_add_del_local_eid,
2242             {
2243                 'locator_set_name': ls_name,
2244                 'is_add': is_add,
2245                 'eid_type': eid_type,
2246                 'eid': eid,
2247                 'prefix_len': prefix_len,
2248                 'vni': vni,
2249                 'key_id': key_id,
2250                 'key': key
2251             })
2252
2253     def lisp_eid_table_dump(self,
2254                             eid_set=0,
2255                             prefix_length=0,
2256                             vni=0,
2257                             eid_type=0,
2258                             eid=None,
2259                             filter_opt=0):
2260         return self.api(
2261             self.papi.lisp_eid_table_dump,
2262             {
2263                 'eid_set': eid_set,
2264                 'prefix_length': prefix_length,
2265                 'vni': vni,
2266                 'eid_type': eid_type,
2267                 'eid': eid,
2268                 'filter': filter_opt,
2269             })
2270
2271     def lisp_remote_mapping(self,
2272                             eid_type,
2273                             eid,
2274                             eid_prefix_len=0,
2275                             vni=0,
2276                             rlocs=[],
2277                             rlocs_num=0,
2278                             is_src_dst=0,
2279                             is_add=1):
2280         return self.api(
2281             self.papi.lisp_add_del_remote_mapping,
2282             {
2283                 'is_add': is_add,
2284                 'eid_type': eid_type,
2285                 'eid': eid,
2286                 'eid_len': eid_prefix_len,
2287                 'rloc_num': rlocs_num,
2288                 'rlocs': rlocs,
2289                 'vni': vni,
2290                 'is_src_dst': is_src_dst,
2291             })
2292
2293     def lisp_adjacency(self,
2294                        leid,
2295                        reid,
2296                        leid_len,
2297                        reid_len,
2298                        eid_type,
2299                        is_add=1,
2300                        vni=0):
2301         return self.api(
2302             self.papi.lisp_add_del_adjacency,
2303             {
2304                 'is_add': is_add,
2305                 'vni': vni,
2306                 'eid_type': eid_type,
2307                 'leid': leid,
2308                 'reid': reid,
2309                 'leid_len': leid_len,
2310                 'reid_len': reid_len,
2311             })
2312
2313     def lisp_adjacencies_get(self, vni=0):
2314         return self.api(
2315             self.papi.lisp_adjacencies_get,
2316             {
2317                 'vni': vni
2318             })
2319
2320     def map_add_domain(self,
2321                        ip6_prefix,
2322                        ip6_prefix_len,
2323                        ip6_src,
2324                        ip6_src_prefix_len,
2325                        ip4_prefix,
2326                        ip4_prefix_len,
2327                        ea_bits_len=0,
2328                        psid_offset=0,
2329                        psid_length=0,
2330                        is_translation=0,
2331                        is_rfc6052=0,
2332                        mtu=1280):
2333         return self.api(
2334             self.papi.map_add_domain,
2335             {
2336                 'ip6_prefix': ip6_prefix,
2337                 'ip6_prefix_len': ip6_prefix_len,
2338                 'ip4_prefix': ip4_prefix,
2339                 'ip4_prefix_len': ip4_prefix_len,
2340                 'ip6_src': ip6_src,
2341                 'ip6_src_prefix_len': ip6_src_prefix_len,
2342                 'ea_bits_len': ea_bits_len,
2343                 'psid_offset': psid_offset,
2344                 'psid_length': psid_length,
2345                 'is_translation': is_translation,
2346                 'is_rfc6052': is_rfc6052,
2347                 'mtu': mtu
2348             })
2349
2350     def gtpu_add_del_tunnel(
2351             self,
2352             src_addr,
2353             dst_addr,
2354             is_add=1,
2355             is_ipv6=0,
2356             mcast_sw_if_index=0xFFFFFFFF,
2357             encap_vrf_id=0,
2358             decap_next_index=0xFFFFFFFF,
2359             teid=0):
2360         """
2361
2362         :param is_add:  (Default value = 1)
2363         :param is_ipv6:  (Default value = 0)
2364         :param src_addr:
2365         :param dst_addr:
2366         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2367         :param encap_vrf_id:  (Default value = 0)
2368         :param decap_next_index:  (Default value = 0xFFFFFFFF)
2369         :param teid:  (Default value = 0)
2370
2371         """
2372         return self.api(self.papi.gtpu_add_del_tunnel,
2373                         {'is_add': is_add,
2374                          'is_ipv6': is_ipv6,
2375                          'src_address': src_addr,
2376                          'dst_address': dst_addr,
2377                          'mcast_sw_if_index': mcast_sw_if_index,
2378                          'encap_vrf_id': encap_vrf_id,
2379                          'decap_next_index': decap_next_index,
2380                          'teid': teid})
2381
2382     def vxlan_gpe_add_del_tunnel(
2383             self,
2384             src_addr,
2385             dst_addr,
2386             mcast_sw_if_index=0xFFFFFFFF,
2387             is_add=1,
2388             is_ipv6=0,
2389             encap_vrf_id=0,
2390             decap_vrf_id=0,
2391             protocol=3,
2392             vni=0):
2393         """
2394
2395         :param local:
2396         :param remote:
2397         :param is_add:  (Default value = 1)
2398         :param is_ipv6:  (Default value = 0)
2399         :param encap_vrf_id:  (Default value = 0)
2400         :param decap_vrf_id:  (Default value = 0)
2401         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2402         :param protocol:  (Default value = 3)
2403         :param vni:  (Default value = 0)
2404
2405         """
2406         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2407                         {'is_add': is_add,
2408                          'is_ipv6': is_ipv6,
2409                          'local': src_addr,
2410                          'remote': dst_addr,
2411                          'mcast_sw_if_index': mcast_sw_if_index,
2412                          'encap_vrf_id': encap_vrf_id,
2413                          'decap_vrf_id': decap_vrf_id,
2414                          'protocol': protocol,
2415                          'vni': vni})
2416
2417     def pppoe_add_del_session(
2418             self,
2419             client_ip,
2420             client_mac,
2421             session_id=0,
2422             is_add=1,
2423             is_ipv6=0,
2424             decap_vrf_id=0):
2425         """
2426
2427         :param is_add:  (Default value = 1)
2428         :param is_ipv6:  (Default value = 0)
2429         :param client_ip:
2430         :param session_id:  (Default value = 0)
2431         :param client_mac:
2432         :param decap_vrf_id:  (Default value = 0)
2433
2434         """
2435         return self.api(self.papi.pppoe_add_del_session,
2436                         {'is_add': is_add,
2437                          'is_ipv6': is_ipv6,
2438                          'session_id': session_id,
2439                          'client_ip': client_ip,
2440                          'decap_vrf_id': decap_vrf_id,
2441                          'client_mac': client_mac})
2442
2443     def sr_localsid_add_del(self,
2444                             localsid_addr,
2445                             behavior,
2446                             nh_addr,
2447                             is_del=0,
2448                             end_psp=0,
2449                             sw_if_index=0xFFFFFFFF,
2450                             vlan_index=0,
2451                             fib_table=0,
2452                             ):
2453         """ Add/del IPv6 SR local-SID.
2454
2455         :param localsid_addr:
2456         :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2457         :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2458         :param nh_addr:
2459         :param is_del:  (Default value = 0)
2460         :param end_psp: (Default value = 0)
2461         :param sw_if_index: (Default value = 0xFFFFFFFF)
2462         :param vlan_index:  (Default value = 0)
2463         :param fib_table:   (Default value = 0)
2464         """
2465         return self.api(
2466             self.papi.sr_localsid_add_del,
2467             {'is_del': is_del,
2468              'localsid_addr': localsid_addr,
2469              'end_psp': end_psp,
2470              'behavior': behavior,
2471              'sw_if_index': sw_if_index,
2472              'vlan_index': vlan_index,
2473              'fib_table': fib_table,
2474              'nh_addr': nh_addr
2475              }
2476         )
2477
2478     def sr_policy_add(
2479             self,
2480             bsid_addr,
2481             weight=1,
2482             is_encap=1,
2483             type=0,
2484             fib_table=0,
2485             n_segments=0,
2486             segments=[]):
2487         """
2488         :param bsid_addr: bindingSID of the SR Policy
2489         :param weight: weight of the sid list. optional. (default: 1)
2490         :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2491             (default: Encap)
2492         :param type: type/behavior of the SR policy. (default or spray) \
2493             (default: default)
2494         :param fib_table: VRF where to install the FIB entry for the BSID \
2495             (default: 0)
2496         :param n_segments: number of segments \
2497             (default: 0)
2498         :param segments: a vector of IPv6 address composing the segment list \
2499             (default: [])
2500         """
2501         return self.api(
2502             self.papi.sr_policy_add,
2503             {'bsid_addr': bsid_addr,
2504              'weight': weight,
2505              'is_encap': is_encap,
2506              'type': type,
2507              'fib_table': fib_table,
2508              'n_segments': n_segments,
2509              'segments': segments
2510              }
2511         )
2512
2513     def sr_policy_del(
2514             self,
2515             bsid_addr,
2516             sr_policy_index=0):
2517         """
2518         :param bsid: bindingSID of the SR Policy
2519         :param sr_policy_index: index of the sr policy (default: 0)
2520         """
2521         return self.api(
2522             self.papi.sr_policy_del,
2523             {'bsid_addr': bsid_addr,
2524              'sr_policy_index': sr_policy_index
2525              })
2526
2527     def sr_steering_add_del(
2528             self,
2529             is_del,
2530             bsid_addr,
2531             sr_policy_index,
2532             table_id,
2533             prefix_addr,
2534             mask_width,
2535             sw_if_index,
2536             traffic_type):
2537         """
2538         Steer traffic L2 and L3 traffic through a given SR policy
2539
2540         :param is_del: delete or add
2541         :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2542         :param sr_policy: is the index of the SR Policy (alt to bsid)
2543         :param table_id: is the VRF where to install the FIB entry for the BSID
2544         :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2545         :param mask_width: is the mask for L3 traffic type
2546         :param sw_if_index: is the incoming interface for L2 traffic
2547         :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2548         """
2549         return self.api(
2550             self.papi.sr_steering_add_del,
2551             {'is_del': is_del,
2552              'bsid_addr': bsid_addr,
2553              'sr_policy_index': sr_policy_index,
2554              'table_id': table_id,
2555              'prefix_addr': prefix_addr,
2556              'mask_width': mask_width,
2557              'sw_if_index': sw_if_index,
2558              'traffic_type': traffic_type
2559              })
2560
2561     def acl_add_replace(self, acl_index, r, tag='',
2562                         expected_retval=0):
2563         """Add/replace an ACL
2564         :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2565         :param acl_rule r: ACL rules array.
2566         :param str tag: symbolic tag (description) for this ACL.
2567         :param int count: number of rules.
2568         """
2569         return self.api(self.papi.acl_add_replace,
2570                         {'acl_index': acl_index,
2571                          'r': r,
2572                          'count': len(r),
2573                          'tag': tag},
2574                         expected_retval=expected_retval)
2575
2576     def acl_del(self, acl_index, expected_retval=0):
2577         """
2578
2579         :param acl_index:
2580         :return:
2581         """
2582         return self.api(self.papi.acl_del,
2583                         {'acl_index': acl_index},
2584                         expected_retval=expected_retval)
2585
2586     def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2587                                    expected_retval=0):
2588         return self.api(self.papi.acl_interface_set_acl_list,
2589                         {'sw_if_index': sw_if_index,
2590                          'count': len(acls),
2591                          'n_input': n_input,
2592                          'acls': acls},
2593                         expected_retval=expected_retval)
2594
2595     def acl_interface_add_del(self,
2596                               sw_if_index,
2597                               acl_index,
2598                               is_add=1):
2599         """ Add/Delete ACL to/from interface
2600
2601         :param sw_if_index:
2602         :param acl_index:
2603         :param is_add:  (Default value = 1)
2604         """
2605
2606         return self.api(self.papi.acl_interface_add_del,
2607                         {'is_add': is_add,
2608                          'is_input': 1,
2609                          'sw_if_index': sw_if_index,
2610                          'acl_index': acl_index})
2611
2612     def acl_dump(self, acl_index, expected_retval=0):
2613         return self.api(self.papi.acl_dump,
2614                         {'acl_index': acl_index},
2615                         expected_retval=expected_retval)
2616
2617     def macip_acl_add(self, rules, tag=""):
2618         """ Add MACIP acl
2619
2620         :param rules: list of rules for given acl
2621         :param tag: acl tag
2622         """
2623
2624         return self.api(self.papi.macip_acl_add,
2625                         {'r': rules,
2626                          'count': len(rules),
2627                          'tag': tag})
2628
2629     def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2630         """ Add MACIP acl
2631
2632         :param rules: list of rules for given acl
2633         :param tag: acl tag
2634         """
2635
2636         return self.api(self.papi.macip_acl_add_replace,
2637                         {'acl_index': acl_index,
2638                          'r': rules,
2639                          'count': len(rules),
2640                          'tag': tag})
2641
2642     def macip_acl_del(self, acl_index):
2643         """
2644
2645         :param acl_index:
2646         :return:
2647         """
2648         return self.api(self.papi.macip_acl_del,
2649                         {'acl_index': acl_index})
2650
2651     def macip_acl_interface_add_del(self,
2652                                     sw_if_index,
2653                                     acl_index,
2654                                     is_add=1):
2655         """ Add MACIP acl to interface
2656
2657         :param sw_if_index:
2658         :param acl_index:
2659         :param is_add:  (Default value = 1)
2660         """
2661
2662         return self.api(self.papi.macip_acl_interface_add_del,
2663                         {'is_add': is_add,
2664                          'sw_if_index': sw_if_index,
2665                          'acl_index': acl_index})
2666
2667     def macip_acl_interface_get(self):
2668         """ Return interface acls dump
2669         """
2670         return self.api(
2671             self.papi.macip_acl_interface_get, {})
2672
2673     def macip_acl_dump(self, acl_index=4294967295):
2674         """ Return MACIP acl dump
2675         """
2676
2677         return self.api(
2678             self.papi.macip_acl_dump, {'acl_index': acl_index})
2679
2680     def policer_add_del(self,
2681                         name,
2682                         cir,
2683                         eir,
2684                         cb,
2685                         eb,
2686                         is_add=1,
2687                         rate_type=0,
2688                         round_type=0,
2689                         ptype=0,
2690                         color_aware=0,
2691                         conform_action_type=1,
2692                         conform_dscp=0,
2693                         exceed_action_type=0,
2694                         exceed_dscp=0,
2695                         violate_action_type=0,
2696                         violate_dscp=0):
2697         return self.api(self.papi.policer_add_del,
2698                         {'name': name,
2699                          'cir': cir,
2700                          'eir': eir,
2701                          'cb': cb,
2702                          'eb': eb,
2703                          'is_add': is_add,
2704                          'rate_type': rate_type,
2705                          'round_type': round_type,
2706                          'type': ptype,
2707                          'color_aware': color_aware,
2708                          'conform_action_type': conform_action_type,
2709                          'conform_dscp': conform_dscp,
2710                          'exceed_action_type': exceed_action_type,
2711                          'exceed_dscp': exceed_dscp,
2712                          'violate_action_type': violate_action_type,
2713                          'violate_dscp': violate_dscp})
2714
2715     def ip_punt_police(self,
2716                        policer_index,
2717                        is_ip6=0,
2718                        is_add=1):
2719         return self.api(self.papi.ip_punt_police,
2720                         {'policer_index': policer_index,
2721                          'is_add': is_add,
2722                          'is_ip6': is_ip6})
2723
2724     def ip_punt_redirect(self,
2725                          rx_sw_if_index,
2726                          tx_sw_if_index,
2727                          nh,
2728                          is_ip6=0,
2729                          is_add=1):
2730         return self.api(self.papi.ip_punt_redirect,
2731                         {'rx_sw_if_index': rx_sw_if_index,
2732                          'tx_sw_if_index': tx_sw_if_index,
2733                          'nh': nh,
2734                          'is_add': is_add,
2735                          'is_ip6': is_ip6})
2736
2737     def bier_table_add_del(self,
2738                            bti,
2739                            mpls_label,
2740                            is_add=1):
2741         """ BIER Table add/del """
2742         return self.api(
2743             self.papi.bier_table_add_del,
2744             {'bt_tbl_id': {"bt_set": bti.set_id,
2745                            "bt_sub_domain": bti.sub_domain_id,
2746                            "bt_hdr_len_id": bti.hdr_len_id},
2747              'bt_label': mpls_label,
2748              'bt_is_add': is_add})
2749
2750     def bier_table_dump(self):
2751         return self.api(self.papi.bier_table_dump, {})
2752
2753     def bier_route_add_del(self,
2754                            bti,
2755                            bp,
2756                            paths,
2757                            is_add=1):
2758         """ BIER Route add/del """
2759         br_paths = []
2760         for p in paths:
2761             br_paths.append({'next_hop': p.nh_addr,
2762                              'weight': 1,
2763                              'afi': 0,
2764                              'preference': 0,
2765                              'table_id': p.nh_table_id,
2766                              'next_hop_id': p.next_hop_id,
2767                              'is_udp_encap': p.is_udp_encap,
2768                              'n_labels': len(p.nh_labels),
2769                              'label_stack': p.nh_labels})
2770         return self.api(
2771             self.papi.bier_route_add_del,
2772             {'br_tbl_id': {"bt_set": bti.set_id,
2773                            "bt_sub_domain": bti.sub_domain_id,
2774                            "bt_hdr_len_id": bti.hdr_len_id},
2775              'br_bp': bp,
2776              'br_n_paths': len(br_paths),
2777              'br_paths': br_paths,
2778              'br_is_add': is_add})
2779
2780     def bier_route_dump(self, bti):
2781         return self.api(
2782             self.papi.bier_route_dump,
2783             {'br_tbl_id': {"bt_set": bti.set_id,
2784                            "bt_sub_domain": bti.sub_domain_id,
2785                            "bt_hdr_len_id": bti.hdr_len_id}})
2786
2787     def bier_imp_add(self,
2788                      bti,
2789                      src,
2790                      ibytes,
2791                      is_add=1):
2792         """ BIER Imposition Add """
2793         return self.api(
2794             self.papi.bier_imp_add,
2795             {'bi_tbl_id': {"bt_set": bti.set_id,
2796                            "bt_sub_domain": bti.sub_domain_id,
2797                            "bt_hdr_len_id": bti.hdr_len_id},
2798              'bi_src': src,
2799              'bi_n_bytes': len(ibytes),
2800              'bi_bytes': ibytes})
2801
2802     def bier_imp_del(self, bi_index):
2803         """ BIER Imposition del """
2804         return self.api(
2805             self.papi.bier_imp_del,
2806             {'bi_index': bi_index})
2807
2808     def bier_imp_dump(self):
2809         return self.api(self.papi.bier_imp_dump, {})
2810
2811     def bier_disp_table_add_del(self,
2812                                 bdti,
2813                                 is_add=1):
2814         """ BIER Disposition Table add/del """
2815         return self.api(
2816             self.papi.bier_disp_table_add_del,
2817             {'bdt_tbl_id': bdti,
2818              'bdt_is_add': is_add})
2819
2820     def bier_disp_table_dump(self):
2821         return self.api(self.papi.bier_disp_table_dump, {})
2822
2823     def bier_disp_entry_add_del(self,
2824                                 bdti,
2825                                 bp,
2826                                 payload_proto,
2827                                 next_hop,
2828                                 next_hop_tbl_id=0,
2829                                 next_hop_rpf_id=~0,
2830                                 next_hop_is_ip4=1,
2831                                 is_add=1):
2832         """ BIER Route add/del """
2833         return self.api(
2834             self.papi.bier_disp_entry_add_del,
2835             {'bde_tbl_id': bdti,
2836              'bde_bp': bp,
2837              'bde_payload_proto': payload_proto,
2838              'bde_n_paths': 1,
2839              'bde_paths': [{'next_hop': next_hop,
2840                             'table_id': next_hop_tbl_id,
2841                             'afi': 0,
2842                             'rpf_id': next_hop_rpf_id,
2843                             'n_labels': 0,
2844                             'label_stack': [0]}],
2845              'bde_is_add': is_add})
2846
2847     def bier_disp_entry_dump(self, bdti):
2848         return self.api(
2849             self.papi.bier_disp_entry_dump,
2850             {'bde_tbl_id': bdti})
2851
2852     def add_node_next(self, node_name, next_name):
2853         """ Set the next node for a given node request
2854
2855         :param node_name:
2856         :param next_name:
2857         """
2858         return self.api(self.papi.add_node_next,
2859                         {'node_name': node_name,
2860                          'next_name': next_name})
2861
2862     def session_enable_disable(self, is_enabled):
2863         return self.api(
2864             self.papi.session_enable_disable,
2865             {'is_enable': is_enabled})
2866
2867     def ipsec_spd_add_del(self, spd_id, is_add=1):
2868         """ SPD add/del - Wrapper to add or del ipsec SPD
2869         Sample CLI : 'ipsec spd add 1'
2870
2871         :param spd_id - SPD ID to be created in the vpp . mandatory
2872         :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2873               optional
2874         :returns: reply from the API
2875         """
2876         return self.api(
2877             self.papi.ipsec_spd_add_del, {
2878                 'spd_id': spd_id, 'is_add': is_add})
2879
2880     def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2881         """ IPSEC interface SPD add/del - \
2882              Wrapper to associate/disassociate SPD to interface in VPP
2883         Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2884
2885         :param spd_id - SPD ID to associate with the interface . mandatory
2886         :param sw_if_index - Interface Index which needs to ipsec \
2887             association mandatory
2888         :param is_add - add(1) or del(0) association with interface \
2889                 (Default 1 - add) . optional
2890         :returns: reply from the API
2891         """
2892         return self.api(
2893             self.papi.ipsec_interface_add_del_spd, {
2894                 'spd_id': spd_id,
2895                 'sw_if_index': sw_if_index, 'is_add': is_add})
2896
2897     def ipsec_sad_add_del_entry(self,
2898                                 sad_id,
2899                                 spi,
2900                                 tunnel_src_address='',
2901                                 tunnel_dst_address='',
2902                                 protocol=0,
2903                                 integrity_algorithm=2,
2904                                 integrity_key_length=0,
2905                                 integrity_key='C91KUR9GYMm5GfkEvNjX',
2906                                 crypto_algorithm=1,
2907                                 crypto_key_length=0,
2908                                 crypto_key='JPjyOWBeVEQiMe7h',
2909                                 is_add=1,
2910                                 is_tunnel=1):
2911         """ IPSEC SA add/del
2912         Sample CLI : 'ipsec sa add 10 spi 1001 esp \
2913             crypto-key 4a506a794f574265564551694d653768 \
2914             crypto-alg aes-cbc-128 \
2915             integ-key 4339314b55523947594d6d3547666b45764e6a58 \
2916             integ-alg sha1-96 tunnel-src 192.168.100.3 \
2917             tunnel-dst 192.168.100.2'
2918         Sample CLI : 'ipsec sa add 20 spi 2001 \
2919             integ-key 4339314b55523947594d6d3547666b45764e6a58 \
2920             integ-alg sha1-96'
2921
2922         :param sad_id -  Security Association ID to be \
2923             created or deleted. mandatory
2924         :param spi - security param index of the SA in decimal. mandatory
2925         :param tunnel_src_address - incase of tunnel mode outer src address .\
2926              mandatory for tunnel mode
2927         :param tunnel_dst_address - incase of transport mode \
2928              outer dst address. mandatory for tunnel mode
2929         :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional
2930         :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\
2931              optional **
2932         :param integrity_key - value in string \
2933              (Default C91KUR9GYMm5GfkEvNjX).optional
2934         :param integrity_key_length - length of the key string in bytes\
2935              (Default 0 - integrity disabled). optional
2936         :param crypto_algorithm - value range 1-11 Default \
2937              (1- AES_CBC_128).optional **
2938         :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional
2939         :param crypto_key_length - length of the key string in bytes\
2940              (Default 0 - crypto disabled). optional
2941         :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\
2942              optional
2943         :param is_tunnel - tunnel mode (1) or transport mode(0) \
2944              (Default 1 - tunnel). optional
2945         :returns: reply from the API
2946         :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
2947              crypto and ipsec algorithms
2948         """
2949         return self.api(
2950             self.papi.ipsec_sad_add_del_entry,
2951             {'sad_id': sad_id,
2952              'spi': spi,
2953              'tunnel_src_address': tunnel_src_address,
2954              'tunnel_dst_address': tunnel_dst_address,
2955              'protocol': protocol,
2956              'integrity_algorithm': integrity_algorithm,
2957              'integrity_key_length': integrity_key_length,
2958              'integrity_key': integrity_key,
2959              'crypto_algorithm': crypto_algorithm,
2960              'crypto_key_length': crypto_key_length,
2961              'crypto_key': crypto_key,
2962              'is_add': is_add,
2963              'is_tunnel': is_tunnel})
2964
2965     def ipsec_spd_add_del_entry(self,
2966                                 spd_id,
2967                                 local_address_start,
2968                                 local_address_stop,
2969                                 remote_address_start,
2970                                 remote_address_stop,
2971                                 local_port_start=0,
2972                                 local_port_stop=65535,
2973                                 remote_port_start=0,
2974                                 remote_port_stop=65535,
2975                                 protocol=0,
2976                                 sa_id=10,
2977                                 policy=0,
2978                                 priority=100,
2979                                 is_outbound=1,
2980                                 is_add=1,
2981                                 is_ip_any=0):
2982         """ IPSEC policy SPD add/del   -
2983                     Wrapper to configure ipsec SPD policy entries in VPP
2984         Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \
2985                      protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \
2986                      remote-ip-range 192.168.3.3 - 192.168.3.3'
2987
2988         :param spd_id -  SPD ID for the policy . mandatory
2989         :param local_address_start - local-ip-range start address . mandatory
2990         :param local_address_stop  - local-ip-range stop address . mandatory
2991         :param remote_address_start - remote-ip-range start address . mandatory
2992         :param remote_address_stop  - remote-ip-range stop address . mandatory
2993         :param local_port_start - (Default 0) . optional
2994         :param local_port_stop - (Default 65535). optional
2995         :param remote_port_start - (Default 0). optional
2996         :param remote_port_stop - (Default 65535). optional
2997         :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any).
2998                optional
2999         :param sa_id -  Security Association ID for mapping it to SPD
3000                (default 10).   optional
3001         :param policy - bypass(0), discard(1), resolve(2) or protect(3)action
3002                (Default 0 - bypass). optional
3003         :param priotity - value for the spd action (Default 100). optional
3004         :param is_outbound - flag for inbound(0) or outbound(1)
3005                (Default 1 - outbound). optional
3006         :param is_add flag - for addition(1) or deletion(0) of the spd
3007                (Default 1 - addtion). optional
3008         :returns: reply from the API
3009         """
3010         return self.api(
3011             self.papi.ipsec_spd_add_del_entry,
3012             {'spd_id': spd_id,
3013              'local_address_start': local_address_start,
3014              'local_address_stop': local_address_stop,
3015              'remote_address_start': remote_address_start,
3016              'remote_address_stop': remote_address_stop,
3017              'local_port_start': local_port_start,
3018              'local_port_stop': local_port_stop,
3019              'remote_port_start': remote_port_start,
3020              'remote_port_stop': remote_port_stop,
3021              'is_add': is_add,
3022              'protocol': protocol,
3023              'policy': policy,
3024              'priority': priority,
3025              'is_outbound': is_outbound,
3026              'sa_id': sa_id,
3027              'is_ip_any': is_ip_any})
3028
3029     def app_namespace_add(self,
3030                           namespace_id,
3031                           ip4_fib_id=0,
3032                           ip6_fib_id=0,
3033                           sw_if_index=0xFFFFFFFF,
3034                           secret=0):
3035         return self.api(
3036             self.papi.app_namespace_add_del,
3037             {'secret': secret,
3038              'sw_if_index': sw_if_index,
3039              'ip4_fib_id': ip4_fib_id,
3040              'ip6_fib_id': ip6_fib_id,
3041              'namespace_id': namespace_id,
3042              'namespace_id_len': len(namespace_id)})