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