test/vpp_papi_provider.py

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