test/vpp_papi_provider.py

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