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