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