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