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