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 int(mac.replace(":", ""), 16) << 16
 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 bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
 389                               learn=1, arp_term=0, is_add=1):
 390         """Create/delete bridge domain.
 391
 392         :param int bd_id: Bridge domain index.
 393         :param int flood: Enable/disable bcast/mcast flooding in the BD.
 394             (Default value = 1)
 395         :param int uu_flood: Enable/disable unknown unicast flood in the BD.
 396             (Default value = 1)
 397         :param int forward: Enable/disable forwarding on all interfaces in
 398             the BD. (Default value = 1)
 399         :param int learn: Enable/disable learning on all interfaces in the BD.
 400             (Default value = 1)
 401         :param int arp_term: Enable/disable arp termination in the BD.
 402             (Default value = 1)
 403         :param int is_add: Add or delete flag. (Default value = 1)
 404         """
 405         return self.api(self.papi.bridge_domain_add_del,
 406                         {'bd_id': bd_id,
 407                          'flood': flood,
 408                          'uu_flood': uu_flood,
 409                          'forward': forward,
 410                          'learn': learn,
 411                          'arp_term': arp_term,
 412                          'is_add': is_add})
 413
 414     def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
 415         return self.api(self.papi.bd_ip_mac_add_del,
 416                         {'bd_id': bd_id,
 417                          'is_add': is_add,
 418                          'is_ipv6': is_ipv6,
 419                          'ip_address': ip,
 420                          'mac_address': mac})
 421
 422     def want_ip4_arp_events(self, enable_disable=1, address=0):
 423         return self.api(self.papi.want_ip4_arp_events,
 424                         {'enable_disable': enable_disable,
 425                          'address': address,
 426                          'pid': os.getpid(), })
 427
 428     def want_ip6_nd_events(self, enable_disable=1, address=0):
 429         return self.api(self.papi.want_ip6_nd_events,
 430                         {'enable_disable': enable_disable,
 431                          'address': address,
 432                          'pid': os.getpid(), })
 433
 434     def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
 435                                max_macs_in_event=0, learn_limit=0):
 436         return self.api(self.papi.want_l2_macs_events,
 437                         {'enable_disable': enable_disable,
 438                          'scan_delay': scan_delay,
 439                          'max_macs_in_event': max_macs_in_event,
 440                          'learn_limit': learn_limit,
 441                          'pid': os.getpid(), })
 442
 443     def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
 444                       filter_mac=0, bvi_mac=0):
 445         """Create/delete L2 FIB entry.
 446
 447         :param str mac: MAC address to create FIB entry for.
 448         :param int bd_id: Bridge domain index.
 449         :param int sw_if_index: Software interface index of the interface.
 450         :param int is_add: Add or delete flag. (Default value = 1)
 451         :param int static_mac: Set to 1 to create static MAC entry.
 452             (Default value = 0)
 453         :param int filter_mac: Set to 1 to drop packet that's source or
 454             destination MAC address contains defined MAC address.
 455             (Default value = 0)
 456         :param int bvi_mac: Set to 1 to create entry that points to BVI
 457             interface. (Default value = 0)
 458         """
 459         return self.api(self.papi.l2fib_add_del,
 460                         {'mac': self._convert_mac(mac),
 461                          'bd_id': bd_id,
 462                          'sw_if_index': sw_if_index,
 463                          'is_add': is_add,
 464                          'static_mac': static_mac,
 465                          'filter_mac': filter_mac,
 466                          'bvi_mac': bvi_mac})
 467
 468     def l2fib_flush_int(self, sw_if_index):
 469         """Flush L2 FIB entries for sw_if_index.
 470
 471         :param int sw_if_index: Software interface index of the interface.
 472         """
 473         return self.api(self.papi.l2fib_flush_int,
 474                         {'sw_if_index': sw_if_index})
 475
 476     def l2fib_flush_bd(self, bd_id):
 477         """Flush L2 FIB entries for bd_id.
 478
 479         :param int sw_if_index: Bridge Domain id.
 480         """
 481         return self.api(self.papi.l2fib_flush_bd,
 482                         {'bd_id': bd_id})
 483
 484     def l2fib_flush_all(self):
 485         """Flush all L2 FIB.
 486         """
 487         return self.api(self.papi.l2fib_flush_all, {})
 488
 489     def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
 490                                    shg=0, bvi=0, enable=1):
 491         """Add/remove interface to/from bridge domain.
 492
 493         :param int sw_if_index: Software interface index of the interface.
 494         :param int bd_id: Bridge domain index.
 495         :param int shg: Split-horizon group index. (Default value = 0)
 496         :param int bvi: Set interface as a bridge group virtual interface.
 497             (Default value = 0)
 498         :param int enable: Add or remove interface. (Default value = 1)
 499         """
 500         return self.api(self.papi.sw_interface_set_l2_bridge,
 501                         {'rx_sw_if_index': sw_if_index,
 502                          'bd_id': bd_id,
 503                          'shg': shg,
 504                          'bvi': bvi,
 505                          'enable': enable})
 506
 507     def bridge_flags(self, bd_id, is_set, feature_bitmap):
 508         """Enable/disable required feature of the bridge domain with defined ID.
 509
 510         :param int bd_id: Bridge domain ID.
 511         :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
 512         :param int feature_bitmap: Bitmap value of the feature to be set:
 513             - learn (1 << 0),
 514             - forward (1 << 1),
 515             - flood (1 << 2),
 516             - uu-flood (1 << 3) or
 517             - arp-term (1 << 4).
 518         """
 519         return self.api(self.papi.bridge_flags,
 520                         {'bd_id': bd_id,
 521                          'is_set': is_set,
 522                          'feature_bitmap': feature_bitmap})
 523
 524     def bridge_domain_dump(self, bd_id=0):
 525         """
 526
 527         :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
 528             existing bridge domains returned)
 529         :return: Dictionary of bridge domain(s) data.
 530         """
 531         return self.api(self.papi.bridge_domain_dump,
 532                         {'bd_id': bd_id})
 533
 534     def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
 535                                      enable):
 536         """Create or delete unidirectional cross-connect from Tx interface to
 537         Rx interface.
 538
 539         :param int rx_sw_if_index: Software interface index of Rx interface.
 540         :param int tx_sw_if_index: Software interface index of Tx interface.
 541         :param int enable: Create cross-connect if equal to 1, delete
 542             cross-connect if equal to 0.
 543
 544         """
 545         return self.api(self.papi.sw_interface_set_l2_xconnect,
 546                         {'rx_sw_if_index': rx_sw_if_index,
 547                          'tx_sw_if_index': tx_sw_if_index,
 548                          'enable': enable})
 549
 550     def sw_interface_set_l2_tag_rewrite(
 551             self,
 552             sw_if_index,
 553             vtr_oper,
 554             push=0,
 555             tag1=0,
 556             tag2=0):
 557         """L2 interface vlan tag rewrite configure request
 558         :param client_index - opaque cookie to identify the sender
 559         :param context - sender context, to match reply w/ request
 560         :param sw_if_index - interface the operation is applied to
 561         :param vtr_op - Choose from l2_vtr_op_t enum values
 562         :param push_dot1q - first pushed flag dot1q id set, else dot1ad
 563         :param tag1 - Needed for any push or translate vtr op
 564         :param tag2 - Needed for any push 2 or translate x-2 vtr ops
 565
 566         """
 567         return self.api(self.papi.l2_interface_vlan_tag_rewrite,
 568                         {'sw_if_index': sw_if_index,
 569                          'vtr_op': vtr_oper,
 570                          'push_dot1q': push,
 571                          'tag1': tag1,
 572                          'tag2': tag2})
 573
 574     def sw_interface_set_flags(self, sw_if_index, admin_up_down):
 575         """
 576
 577         :param admin_up_down:
 578         :param sw_if_index:
 579
 580         """
 581         return self.api(self.papi.sw_interface_set_flags,
 582                         {'sw_if_index': sw_if_index,
 583                          'admin_up_down': admin_up_down})
 584
 585     def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
 586                      no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
 587                      default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
 588         """Create subinterface
 589         from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
 590
 591         :param sub_id: param inner_vlan:
 592         :param sw_if_index:
 593         :param outer_vlan:
 594         :param inner_vlan:
 595         :param no_tags:  (Default value = 0)
 596         :param one_tag:  (Default value = 0)
 597         :param two_tags:  (Default value = 0)
 598         :param dot1ad:  (Default value = 0)
 599         :param exact_match:  (Default value = 0)
 600         :param default_sub:  (Default value = 0)
 601         :param outer_vlan_id_any:  (Default value = 0)
 602         :param inner_vlan_id_any:  (Default value = 0)
 603
 604         """
 605         return self.api(
 606             self.papi.create_subif,
 607             {'sw_if_index': sw_if_index,
 608              'sub_id': sub_id,
 609              'no_tags': no_tags,
 610              'one_tag': one_tag,
 611              'two_tags': two_tags,
 612              'dot1ad': dot1ad,
 613              'exact_match': exact_match,
 614              'default_sub': default_sub,
 615              'outer_vlan_id_any': outer_vlan_id_any,
 616              'inner_vlan_id_any': inner_vlan_id_any,
 617              'outer_vlan_id': outer_vlan,
 618              'inner_vlan_id': inner_vlan})
 619
 620     def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
 621         """Create p2p ethernet subinterface
 622
 623         :param sw_if_index: main (parent) interface
 624         :param remote_mac: client (remote) mac address
 625
 626         """
 627         return self.api(
 628             self.papi.p2p_ethernet_add,
 629             {'parent_if_index': sw_if_index,
 630              'remote_mac': remote_mac,
 631              'subif_id': subif_id})
 632
 633     def delete_subif(self, sw_if_index):
 634         """Delete subinterface
 635
 636         :param sw_if_index:
 637         """
 638         return self.api(self.papi.delete_subif,
 639                         {'sw_if_index': sw_if_index})
 640
 641     def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
 642         """Delete p2p ethernet subinterface
 643
 644         :param sw_if_index: main (parent) interface
 645         :param remote_mac: client (remote) mac address
 646
 647         """
 648         return self.api(
 649             self.papi.p2p_ethernet_del,
 650             {'parent_if_index': sw_if_index,
 651              'remote_mac': remote_mac})
 652
 653     def create_vlan_subif(self, sw_if_index, vlan):
 654         """
 655
 656         :param vlan:
 657         :param sw_if_index:
 658
 659         """
 660         return self.api(self.papi.create_vlan_subif,
 661                         {'sw_if_index': sw_if_index,
 662                          'vlan_id': vlan})
 663
 664     def create_loopback(self, mac=''):
 665         """
 666
 667         :param mac: (Optional)
 668         """
 669         return self.api(self.papi.create_loopback,
 670                         {'mac_address': mac})
 671
 672     def delete_loopback(self, sw_if_index):
 673         return self.api(self.papi.delete_loopback,
 674                         {'sw_if_index': sw_if_index, })
 675
 676     def ip_table_add_del(self,
 677                          table_id,
 678                          is_add=1,
 679                          is_ipv6=0):
 680         """
 681
 682         :param table_id
 683         :param is_add:  (Default value = 1)
 684         :param is_ipv6:  (Default value = 0)
 685
 686         """
 687
 688         return self.api(
 689             self.papi.ip_table_add_del,
 690             {'table_id': table_id,
 691              'is_add': is_add,
 692              'is_ipv6': is_ipv6})
 693
 694     def ip_add_del_route(
 695             self,
 696             dst_address,
 697             dst_address_length,
 698             next_hop_address,
 699             next_hop_sw_if_index=0xFFFFFFFF,
 700             table_id=0,
 701             next_hop_table_id=0,
 702             next_hop_weight=1,
 703             next_hop_n_out_labels=0,
 704             next_hop_out_label_stack=[],
 705             next_hop_via_label=MPLS_LABEL_INVALID,
 706             is_resolve_host=0,
 707             is_resolve_attached=0,
 708             classify_table_index=0xFFFFFFFF,
 709             is_add=1,
 710             is_drop=0,
 711             is_unreach=0,
 712             is_prohibit=0,
 713             is_ipv6=0,
 714             is_local=0,
 715             is_classify=0,
 716             is_multipath=0,
 717             not_last=0):
 718         """
 719
 720         :param dst_address_length:
 721         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 722         :param dst_address:
 723         :param next_hop_address:
 724         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 725         :param vrf_id:  (Default value = 0)
 726         :param lookup_in_vrf:  (Default value = 0)
 727         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 728         :param is_add:  (Default value = 1)
 729         :param is_drop:  (Default value = 0)
 730         :param is_ipv6:  (Default value = 0)
 731         :param is_local:  (Default value = 0)
 732         :param is_classify:  (Default value = 0)
 733         :param is_multipath:  (Default value = 0)
 734         :param is_resolve_host:  (Default value = 0)
 735         :param is_resolve_attached:  (Default value = 0)
 736         :param not_last:  (Default value = 0)
 737         :param next_hop_weight:  (Default value = 1)
 738
 739         """
 740
 741         return self.api(
 742             self.papi.ip_add_del_route,
 743             {'next_hop_sw_if_index': next_hop_sw_if_index,
 744              'table_id': table_id,
 745              'classify_table_index': classify_table_index,
 746              'next_hop_table_id': next_hop_table_id,
 747              'is_add': is_add,
 748              'is_drop': is_drop,
 749              'is_unreach': is_unreach,
 750              'is_prohibit': is_prohibit,
 751              'is_ipv6': is_ipv6,
 752              'is_local': is_local,
 753              'is_classify': is_classify,
 754              'is_multipath': is_multipath,
 755              'is_resolve_host': is_resolve_host,
 756              'is_resolve_attached': is_resolve_attached,
 757              'not_last': not_last,
 758              'next_hop_weight': next_hop_weight,
 759              'dst_address_length': dst_address_length,
 760              'dst_address': dst_address,
 761              'next_hop_address': next_hop_address,
 762              'next_hop_n_out_labels': next_hop_n_out_labels,
 763              'next_hop_via_label': next_hop_via_label,
 764              'next_hop_out_label_stack': next_hop_out_label_stack})
 765
 766     def ip_fib_dump(self):
 767         return self.api(self.papi.ip_fib_dump, {})
 768
 769     def ip6_fib_dump(self):
 770         return self.api(self.papi.ip6_fib_dump, {})
 771
 772     def ip_neighbor_add_del(self,
 773                             sw_if_index,
 774                             mac_address,
 775                             dst_address,
 776                             is_add=1,
 777                             is_ipv6=0,
 778                             is_static=0,
 779                             is_no_adj_fib=0,
 780                             ):
 781         """ Add neighbor MAC to IPv4 or IPv6 address.
 782
 783         :param sw_if_index:
 784         :param mac_address:
 785         :param dst_address:
 786         :param is_add:  (Default value = 1)
 787         :param is_ipv6:  (Default value = 0)
 788         :param is_static:  (Default value = 0)
 789         :param is_no_adj_fib:  (Default value = 0)
 790         """
 791
 792         return self.api(
 793             self.papi.ip_neighbor_add_del,
 794             {'sw_if_index': sw_if_index,
 795              'is_add': is_add,
 796              'is_ipv6': is_ipv6,
 797              'is_static': is_static,
 798              'is_no_adj_fib': is_no_adj_fib,
 799              'mac_address': mac_address,
 800              'dst_address': dst_address
 801              }
 802         )
 803
 804     def ip_neighbor_dump(self,
 805                          sw_if_index,
 806                          is_ipv6=0):
 807         """ Return IP neighbor dump.
 808
 809         :param sw_if_index:
 810         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 811         """
 812
 813         return self.api(
 814             self.papi.ip_neighbor_dump,
 815             {'is_ipv6': is_ipv6,
 816              'sw_if_index': sw_if_index
 817              }
 818         )
 819
 820     def proxy_arp_add_del(self,
 821                           low_address,
 822                           hi_address,
 823                           vrf_id=0,
 824                           is_add=1):
 825         """ Config Proxy Arp Range.
 826
 827         :param low_address: Start address in the rnage to Proxy for
 828         :param hi_address: End address in the rnage to Proxy for
 829         :param vrf_id: The VRF/table in which to proxy
 830         """
 831
 832         return self.api(
 833             self.papi.proxy_arp_add_del,
 834             {'vrf_id': vrf_id,
 835              'is_add': is_add,
 836              'low_address': low_address,
 837              'hi_address': hi_address,
 838              }
 839         )
 840
 841     def proxy_arp_intfc_enable_disable(self,
 842                                        sw_if_index,
 843                                        is_enable=1):
 844         """ Enable/Disable an interface for proxy ARP requests
 845
 846         :param sw_if_index: Interface
 847         :param enable_disable: Enable/Disable
 848         """
 849
 850         return self.api(
 851             self.papi.proxy_arp_intfc_enable_disable,
 852             {'sw_if_index': sw_if_index,
 853              'enable_disable': is_enable
 854              }
 855         )
 856
 857     def reset_vrf(self,
 858                   vrf_id,
 859                   is_ipv6=0,
 860                   ):
 861         """ Reset VRF (remove all routes etc.) request.
 862
 863         :param int vrf_id: ID of the FIB table / VRF to reset.
 864         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 865         """
 866
 867         return self.api(
 868             self.papi.reset_vrf,
 869             {'vrf_id': vrf_id,
 870              'is_ipv6': is_ipv6,
 871              }
 872         )
 873
 874     def reset_fib(self,
 875                   vrf_id,
 876                   is_ipv6=0,
 877                   ):
 878         """ Reset VRF (remove all routes etc.) request.
 879
 880         :param int vrf_id: ID of the FIB table / VRF to reset.
 881         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 882         """
 883
 884         return self.api(
 885             self.papi.reset_fib,
 886             {'vrf_id': vrf_id,
 887              'is_ipv6': is_ipv6,
 888              }
 889         )
 890
 891     def ip_dump(self,
 892                 is_ipv6=0,
 893                 ):
 894         """ Return IP dump.
 895
 896         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 897         """
 898
 899         return self.api(
 900             self.papi.ip_dump,
 901             {'is_ipv6': is_ipv6,
 902              }
 903         )
 904
 905     def sw_interface_span_enable_disable(
 906             self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
 907         """
 908
 909         :param sw_if_index_from:
 910         :param sw_if_index_to:
 911         :param state:
 912         :param is_l2:
 913         """
 914         return self.api(self.papi.sw_interface_span_enable_disable,
 915                         {'sw_if_index_from': sw_if_index_from,
 916                          'sw_if_index_to': sw_if_index_to,
 917                          'state': state,
 918                          'is_l2': is_l2,
 919                          })
 920
 921     def gre_tunnel_add_del(self,
 922                            src_address,
 923                            dst_address,
 924                            outer_fib_id=0,
 925                            is_teb=0,
 926                            is_add=1,
 927                            is_ip6=0):
 928         """ Add a GRE tunnel
 929
 930         :param src_address:
 931         :param dst_address:
 932         :param outer_fib_id:  (Default value = 0)
 933         :param is_add:  (Default value = 1)
 934         :param is_ipv6:  (Default value = 0)
 935         :param is_teb:  (Default value = 0)
 936         """
 937
 938         return self.api(
 939             self.papi.gre_add_del_tunnel,
 940             {'is_add': is_add,
 941              'is_ipv6': is_ip6,
 942              'teb': is_teb,
 943              'src_address': src_address,
 944              'dst_address': dst_address,
 945              'outer_fib_id': outer_fib_id}
 946         )
 947
 948     def mpls_fib_dump(self):
 949         return self.api(self.papi.mpls_fib_dump, {})
 950
 951     def mpls_table_add_del(
 952             self,
 953             table_id,
 954             is_add=1):
 955         """
 956
 957         :param table_id
 958         :param is_add:  (Default value = 1)
 959
 960         """
 961
 962         return self.api(
 963             self.papi.mpls_table_add_del,
 964             {'mt_table_id': table_id,
 965              'mt_is_add': is_add})
 966
 967     def mpls_route_add_del(
 968             self,
 969             label,
 970             eos,
 971             next_hop_proto,
 972             next_hop_address,
 973             next_hop_sw_if_index=0xFFFFFFFF,
 974             table_id=0,
 975             next_hop_table_id=0,
 976             next_hop_weight=1,
 977             next_hop_n_out_labels=0,
 978             next_hop_out_label_stack=[],
 979             next_hop_via_label=MPLS_LABEL_INVALID,
 980             is_resolve_host=0,
 981             is_resolve_attached=0,
 982             is_interface_rx=0,
 983             is_rpf_id=0,
 984             is_multicast=0,
 985             is_add=1,
 986             is_drop=0,
 987             is_multipath=0,
 988             classify_table_index=0xFFFFFFFF,
 989             is_classify=0,
 990             not_last=0):
 991         """
 992
 993         :param dst_address_length:
 994         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 995         :param dst_address:
 996         :param next_hop_address:
 997         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 998         :param vrf_id:  (Default value = 0)
 999         :param lookup_in_vrf:  (Default value = 0)
1000         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1001         :param is_add:  (Default value = 1)
1002         :param is_drop:  (Default value = 0)
1003         :param is_ipv6:  (Default value = 0)
1004         :param is_local:  (Default value = 0)
1005         :param is_classify:  (Default value = 0)
1006         :param is_multipath:  (Default value = 0)
1007         :param is_multicast:  (Default value = 0)
1008         :param is_resolve_host:  (Default value = 0)
1009         :param is_resolve_attached:  (Default value = 0)
1010         :param not_last:  (Default value = 0)
1011         :param next_hop_weight:  (Default value = 1)
1012
1013         """
1014
1015         return self.api(
1016             self.papi.mpls_route_add_del,
1017             {'mr_label': label,
1018              'mr_eos': eos,
1019              'mr_table_id': table_id,
1020              'mr_classify_table_index': classify_table_index,
1021              'mr_is_add': is_add,
1022              'mr_is_classify': is_classify,
1023              'mr_is_multipath': is_multipath,
1024              'mr_is_multicast': is_multicast,
1025              'mr_is_resolve_host': is_resolve_host,
1026              'mr_is_resolve_attached': is_resolve_attached,
1027              'mr_is_interface_rx': is_interface_rx,
1028              'mr_is_rpf_id': is_rpf_id,
1029              'mr_next_hop_proto': next_hop_proto,
1030              'mr_next_hop_weight': next_hop_weight,
1031              'mr_next_hop': next_hop_address,
1032              'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1033              'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1034              'mr_next_hop_table_id': next_hop_table_id,
1035              'mr_next_hop_via_label': next_hop_via_label,
1036              'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1037
1038     def mpls_ip_bind_unbind(
1039             self,
1040             label,
1041             dst_address,
1042             dst_address_length,
1043             table_id=0,
1044             ip_table_id=0,
1045             is_ip4=1,
1046             is_bind=1):
1047         """
1048         """
1049         return self.api(
1050             self.papi.mpls_ip_bind_unbind,
1051             {'mb_mpls_table_id': table_id,
1052              'mb_label': label,
1053              'mb_ip_table_id': ip_table_id,
1054              'mb_is_bind': is_bind,
1055              'mb_is_ip4': is_ip4,
1056              'mb_address_length': dst_address_length,
1057              'mb_address': dst_address})
1058
1059     def mpls_tunnel_add_del(
1060             self,
1061             tun_sw_if_index,
1062             next_hop_proto_is_ip4,
1063             next_hop_address,
1064             next_hop_sw_if_index=0xFFFFFFFF,
1065             next_hop_table_id=0,
1066             next_hop_weight=1,
1067             next_hop_n_out_labels=0,
1068             next_hop_out_label_stack=[],
1069             next_hop_via_label=MPLS_LABEL_INVALID,
1070             is_add=1,
1071             l2_only=0,
1072             is_multicast=0):
1073         """
1074
1075         :param dst_address_length:
1076         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1077         :param dst_address:
1078         :param next_hop_address:
1079         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1080         :param vrf_id:  (Default value = 0)
1081         :param lookup_in_vrf:  (Default value = 0)
1082         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1083         :param is_add:  (Default value = 1)
1084         :param is_drop:  (Default value = 0)
1085         :param is_ipv6:  (Default value = 0)
1086         :param is_local:  (Default value = 0)
1087         :param is_classify:  (Default value = 0)
1088         :param is_multipath:  (Default value = 0)
1089         :param is_resolve_host:  (Default value = 0)
1090         :param is_resolve_attached:  (Default value = 0)
1091         :param next_hop_weight:  (Default value = 1)
1092         :param is_multicast:  (Default value = 0)
1093
1094         """
1095         return self.api(
1096             self.papi.mpls_tunnel_add_del,
1097             {'mt_sw_if_index': tun_sw_if_index,
1098              'mt_is_add': is_add,
1099              'mt_l2_only': l2_only,
1100              'mt_is_multicast': is_multicast,
1101              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1102              'mt_next_hop_weight': next_hop_weight,
1103              'mt_next_hop': next_hop_address,
1104              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1105              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1106              'mt_next_hop_table_id': next_hop_table_id,
1107              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1108
1109     def nat44_interface_add_del_feature(
1110             self,
1111             sw_if_index,
1112             is_inside=1,
1113             is_add=1):
1114         """Enable/disable NAT44 feature on the interface
1115
1116         :param sw_if_index: Software index of the interface
1117         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1118         :param is_add: 1 if add, 0 if delete (Default value = 1)
1119         """
1120         return self.api(
1121             self.papi.nat44_interface_add_del_feature,
1122             {'is_add': is_add,
1123              'is_inside': is_inside,
1124              'sw_if_index': sw_if_index})
1125
1126     def nat44_interface_add_del_output_feature(
1127             self,
1128             sw_if_index,
1129             is_inside=1,
1130             is_add=1):
1131         """Enable/disable NAT44 output feature on the interface
1132
1133         :param sw_if_index: Software index of the interface
1134         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1135         :param is_add: 1 if add, 0 if delete (Default value = 1)
1136         """
1137         return self.api(
1138             self.papi.nat44_interface_add_del_output_feature,
1139             {'is_add': is_add,
1140              'is_inside': is_inside,
1141              'sw_if_index': sw_if_index})
1142
1143     def nat44_add_del_static_mapping(
1144             self,
1145             local_ip,
1146             external_ip=0,
1147             external_sw_if_index=0xFFFFFFFF,
1148             local_port=0,
1149             external_port=0,
1150             addr_only=1,
1151             vrf_id=0,
1152             protocol=0,
1153             is_add=1):
1154         """Add/delete NAT44 static mapping
1155
1156         :param local_ip: Local IP address
1157         :param external_ip: External IP address
1158         :param external_sw_if_index: External interface instead of IP address
1159         :param local_port: Local port number (Default value = 0)
1160         :param external_port: External port number (Default value = 0)
1161         :param addr_only: 1 if address only mapping, 0 if address and port
1162         :param vrf_id: VRF ID
1163         :param protocol: IP protocol (Default value = 0)
1164         :param is_add: 1 if add, 0 if delete (Default value = 1)
1165         """
1166         return self.api(
1167             self.papi.nat44_add_del_static_mapping,
1168             {'is_add': is_add,
1169              'addr_only': addr_only,
1170              'local_ip_address': local_ip,
1171              'external_ip_address': external_ip,
1172              'local_port': local_port,
1173              'external_port': external_port,
1174              'external_sw_if_index': external_sw_if_index,
1175              'vrf_id': vrf_id,
1176              'protocol': protocol})
1177
1178     def nat44_add_del_address_range(
1179             self,
1180             first_ip_address,
1181             last_ip_address,
1182             is_add=1,
1183             vrf_id=0xFFFFFFFF):
1184         """Add/del NAT44 address range
1185
1186         :param first_ip_address: First IP address
1187         :param last_ip_address: Last IP address
1188         :param vrf_id: VRF id for the address range
1189         :param is_add: 1 if add, 0 if delete (Default value = 1)
1190         """
1191         return self.api(
1192             self.papi.nat44_add_del_address_range,
1193             {'first_ip_address': first_ip_address,
1194              'last_ip_address': last_ip_address,
1195              'vrf_id': vrf_id,
1196              'is_add': is_add})
1197
1198     def nat44_address_dump(self):
1199         """Dump NAT44 addresses
1200         :return: Dictionary of NAT44 addresses
1201         """
1202         return self.api(self.papi.nat44_address_dump, {})
1203
1204     def nat44_interface_dump(self):
1205         """Dump interfaces with NAT44 feature
1206         :return: Dictionary of interfaces with NAT44 feature
1207         """
1208         return self.api(self.papi.nat44_interface_dump, {})
1209
1210     def nat44_interface_output_feature_dump(self):
1211         """Dump interfaces with NAT44 output feature
1212         :return: Dictionary of interfaces with NAT44 output feature
1213         """
1214         return self.api(self.papi.nat44_interface_output_feature_dump, {})
1215
1216     def nat44_static_mapping_dump(self):
1217         """Dump NAT44 static mappings
1218         :return: Dictionary of NAT44 static mappings
1219         """
1220         return self.api(self.papi.nat44_static_mapping_dump, {})
1221
1222     def nat_show_config(self):
1223         """Show NAT plugin config
1224         :return: NAT plugin config parameters
1225         """
1226         return self.api(self.papi.nat_show_config, {})
1227
1228     def nat44_add_interface_addr(
1229             self,
1230             sw_if_index,
1231             is_add=1):
1232         """Add/del NAT44 address from interface
1233
1234         :param sw_if_index: Software index of the interface
1235         :param is_add: 1 if add, 0 if delete (Default value = 1)
1236         """
1237         return self.api(self.papi.nat44_add_del_interface_addr,
1238                         {'is_add': is_add, 'sw_if_index': sw_if_index})
1239
1240     def nat44_interface_addr_dump(self):
1241         """Dump NAT44 addresses interfaces
1242         :return: Dictionary of NAT44 addresses interfaces
1243         """
1244         return self.api(self.papi.nat44_interface_addr_dump, {})
1245
1246     def nat_ipfix(
1247             self,
1248             domain_id=1,
1249             src_port=4739,
1250             enable=1):
1251         """Enable/disable NAT IPFIX logging
1252
1253         :param domain_id: Observation domain ID (Default value = 1)
1254         :param src_port: Source port number (Default value = 4739)
1255         :param enable: 1 if enable, 0 if disable (Default value = 1)
1256         """
1257         return self.api(
1258             self.papi.nat_ipfix_enable_disable,
1259             {'domain_id': domain_id,
1260              'src_port': src_port,
1261              'enable': enable})
1262
1263     def nat44_user_session_dump(
1264             self,
1265             ip_address,
1266             vrf_id):
1267         """Dump NAT44 user's sessions
1268
1269         :param ip_address: ip adress of the user to be dumped
1270         :param cpu_index: cpu_index on which the user is
1271         :param vrf_id: VRF ID
1272         :return: Dictionary of S-NAT sessions
1273         """
1274         return self.api(
1275             self.papi.nat44_user_session_dump,
1276             {'ip_address': ip_address,
1277              'vrf_id': vrf_id})
1278
1279     def nat44_user_dump(self):
1280         """Dump NAT44 users
1281
1282         :return: Dictionary of NAT44 users
1283         """
1284         return self.api(self.papi.nat44_user_dump, {})
1285
1286     def nat44_add_del_lb_static_mapping(
1287             self,
1288             external_addr,
1289             external_port,
1290             protocol,
1291             vrf_id=0,
1292             local_num=0,
1293             locals=None,
1294             is_add=1):
1295         """Add/delete NAT44 load balancing static mapping
1296
1297         :param is_add - 1 if add, 0 if delete
1298         """
1299         return self.api(
1300             self.papi.nat44_add_del_lb_static_mapping,
1301             {'is_add': is_add,
1302              'external_addr': external_addr,
1303              'external_port': external_port,
1304              'protocol': protocol,
1305              'vrf_id': vrf_id,
1306              'local_num': local_num,
1307              'locals': locals})
1308
1309     def nat44_lb_static_mapping_dump(self):
1310         """Dump NAT44 load balancing static mappings
1311
1312         :return: Dictionary of NAT44 load balancing static mapping
1313         """
1314         return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1315
1316     def nat_det_add_del_map(
1317             self,
1318             in_addr,
1319             in_plen,
1320             out_addr,
1321             out_plen,
1322             is_add=1):
1323         """Add/delete deterministic NAT mapping
1324
1325         :param is_add - 1 if add, 0 if delete
1326         :param in_addr - inside IP address
1327         :param in_plen - inside IP address prefix length
1328         :param out_addr - outside IP address
1329         :param out_plen - outside IP address prefix length
1330         """
1331         return self.api(
1332             self.papi.nat_det_add_del_map,
1333             {'is_add': is_add,
1334              'is_nat44': 1,
1335              'in_addr': in_addr,
1336              'in_plen': in_plen,
1337              'out_addr': out_addr,
1338              'out_plen': out_plen})
1339
1340     def nat_det_forward(
1341             self,
1342             in_addr):
1343         """Get outside address and port range from inside address
1344
1345         :param in_addr - inside IP address
1346         """
1347         return self.api(
1348             self.papi.nat_det_forward,
1349             {'in_addr': in_addr,
1350              'is_nat44': 1})
1351
1352     def nat_det_reverse(
1353             self,
1354             out_addr,
1355             out_port):
1356         """Get inside address from outside address and port
1357
1358         :param out_addr - outside IP address
1359         :param out_port - outside port
1360         """
1361         return self.api(
1362             self.papi.nat_det_reverse,
1363             {'out_addr': out_addr,
1364              'out_port': out_port})
1365
1366     def nat_det_map_dump(self):
1367         """Dump deterministic NAT mappings
1368
1369         :return: Dictionary of deterministic NAT mappings
1370         """
1371         return self.api(self.papi.nat_det_map_dump, {})
1372
1373     def nat_det_set_timeouts(
1374             self,
1375             udp=300,
1376             tcp_established=7440,
1377             tcp_transitory=240,
1378             icmp=60):
1379         """Set values of timeouts for deterministic NAT (in seconds)
1380
1381         :param udp - UDP timeout (Default value = 300)
1382         :param tcp_established - TCP established timeout (Default value = 7440)
1383         :param tcp_transitory - TCP transitory timeout (Default value = 240)
1384         :param icmp - ICMP timeout (Default value = 60)
1385         """
1386         return self.api(
1387             self.papi.nat_det_set_timeouts,
1388             {'udp': udp,
1389              'tcp_established': tcp_established,
1390              'tcp_transitory': tcp_transitory,
1391              'icmp': icmp})
1392
1393     def nat_det_get_timeouts(self):
1394         """Get values of timeouts for deterministic NAT
1395
1396         :return: Timeouts for deterministic NAT (in seconds)
1397         """
1398         return self.api(self.papi.nat_det_get_timeouts, {})
1399
1400     def nat_det_close_session_out(
1401             self,
1402             out_addr,
1403             out_port,
1404             ext_addr,
1405             ext_port):
1406         """Close deterministic NAT session using outside address and port
1407
1408         :param out_addr - outside IP address
1409         :param out_port - outside port
1410         :param ext_addr - external host IP address
1411         :param ext_port - external host port
1412         """
1413         return self.api(
1414             self.papi.nat_det_close_session_out,
1415             {'out_addr': out_addr,
1416              'out_port': out_port,
1417              'ext_addr': ext_addr,
1418              'ext_port': ext_port})
1419
1420     def nat_det_close_session_in(
1421             self,
1422             in_addr,
1423             in_port,
1424             ext_addr,
1425             ext_port):
1426         """Close deterministic NAT session using inside address and port
1427
1428         :param in_addr - inside IP address
1429         :param in_port - inside port
1430         :param ext_addr - external host IP address
1431         :param ext_port - external host port
1432         """
1433         return self.api(
1434             self.papi.nat_det_close_session_in,
1435             {'in_addr': in_addr,
1436              'in_port': in_port,
1437              'ext_addr': ext_addr,
1438              'ext_port': ext_port,
1439              'is_nat44': 1})
1440
1441     def nat_det_session_dump(
1442             self,
1443             user_addr):
1444         """Dump deterministic NAT sessions belonging to a user
1445
1446         :param user_addr - inside IP address of the user
1447         :return: Dictionary of deterministic NAT sessions
1448         """
1449         return self.api(
1450             self.papi.nat_det_session_dump,
1451             {'is_nat44': 1,
1452              'user_addr': user_addr})
1453
1454     def nat64_add_del_pool_addr_range(
1455             self,
1456             start_addr,
1457             end_addr,
1458             vrf_id=0xFFFFFFFF,
1459             is_add=1):
1460         """Add/del address range to NAT64 pool
1461
1462         :param start_addr: First IP address
1463         :param end_addr: Last IP address
1464         :param vrf_id: VRF id for the address range
1465         :param is_add: 1 if add, 0 if delete (Default value = 1)
1466         """
1467         return self.api(
1468             self.papi.nat64_add_del_pool_addr_range,
1469             {'start_addr': start_addr,
1470              'end_addr': end_addr,
1471              'vrf_id': vrf_id,
1472              'is_add': is_add})
1473
1474     def nat64_pool_addr_dump(self):
1475         """Dump NAT64 pool addresses
1476         :return: Dictionary of NAT64 pool addresses
1477         """
1478         return self.api(self.papi.nat64_pool_addr_dump, {})
1479
1480     def nat64_add_del_interface(
1481             self,
1482             sw_if_index,
1483             is_inside=1,
1484             is_add=1):
1485         """Enable/disable NAT64 feature on the interface
1486            :param sw_if_index: Index of the interface
1487            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1488            :param is_add: 1 if add, 0 if delete (Default value = 1)
1489         """
1490         return self.api(
1491             self.papi.nat64_add_del_interface,
1492             {'sw_if_index': sw_if_index,
1493              'is_inside': is_inside,
1494              'is_add': is_add})
1495
1496     def nat64_interface_dump(self):
1497         """Dump interfaces with NAT64 feature
1498         :return: Dictionary of interfaces with NAT64 feature
1499         """
1500         return self.api(self.papi.nat64_interface_dump, {})
1501
1502     def nat64_add_del_static_bib(
1503             self,
1504             in_ip,
1505             out_ip,
1506             in_port,
1507             out_port,
1508             protocol,
1509             vrf_id=0,
1510             is_add=1):
1511         """Add/delete S-NAT static BIB entry
1512
1513         :param in_ip: Inside IPv6 address
1514         :param out_ip: Outside IPv4 address
1515         :param in_port: Inside port number
1516         :param out_port: Outside port number
1517         :param protocol: IP protocol
1518         :param vrf_id: VRF ID (Default value = 0)
1519         :param is_add: 1 if add, 0 if delete (Default value = 1)
1520         """
1521         return self.api(
1522             self.papi.nat64_add_del_static_bib,
1523             {'i_addr': in_ip,
1524              'o_addr': out_ip,
1525              'i_port': in_port,
1526              'o_port': out_port,
1527              'vrf_id': vrf_id,
1528              'proto': protocol,
1529              'is_add': is_add})
1530
1531     def nat64_bib_dump(self, protocol=255):
1532         """Dump NAT64 BIB
1533
1534         :param protocol: IP protocol (Default value = 255, all BIBs)
1535         :returns: Dictionary of NAT64 BIB entries
1536         """
1537         return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1538
1539     def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1540                            tcp_incoming_syn=6):
1541         """Set values of timeouts for NAT64 (in seconds)
1542
1543         :param udpi: UDP timeout (Default value = 300)
1544         :param icmp: ICMP timeout (Default value = 60)
1545         :param tcp_trans: TCP transitory timeout (Default value = 240)
1546         :param tcp_est: TCP established timeout (Default value = 7440)
1547         :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1548         """
1549         return self.api(
1550             self.papi.nat64_set_timeouts,
1551             {'udp': udp,
1552              'icmp': icmp,
1553              'tcp_trans': tcp_trans,
1554              'tcp_est': tcp_est,
1555              'tcp_incoming_syn': tcp_incoming_syn})
1556
1557     def nat64_get_timeouts(self):
1558         """Get values of timeouts for NAT64
1559
1560         :return: Timeouts for NAT64 (in seconds)
1561         """
1562         return self.api(self.papi.nat64_get_timeouts, {})
1563
1564     def nat64_st_dump(self, protocol=255):
1565         """Dump NAT64 session table
1566
1567         :param protocol: IP protocol (Default value = 255, all STs)
1568         :returns: Dictionary of NAT64 sesstion table entries
1569         """
1570         return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1571
1572     def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1573         """Add/del NAT64 prefix
1574
1575         :param prefix: NAT64 prefix
1576         :param plen: NAT64 prefix length
1577         :param vrf_id: VRF id of tenant (Default 0)
1578         :param is_add: 1 if add, 0 if delete (Default value = 1)
1579         """
1580         return self.api(
1581             self.papi.nat64_add_del_prefix,
1582             {'prefix': prefix,
1583              'prefix_len': plen,
1584              'vrf_id': vrf_id,
1585              'is_add': is_add})
1586
1587     def nat64_prefix_dump(self):
1588         """Dump NAT64 prefix
1589
1590         :returns: Dictionary of NAT64 prefixes
1591         """
1592         return self.api(self.papi.nat64_prefix_dump, {})
1593
1594     def control_ping(self):
1595         self.api(self.papi.control_ping)
1596
1597     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1598                     detect_mult, local_addr, peer_addr, is_ipv6=0,
1599                     bfd_key_id=None, conf_key_id=None):
1600         if bfd_key_id is None:
1601             return self.api(self.papi.bfd_udp_add,
1602                             {
1603                                 'sw_if_index': sw_if_index,
1604                                 'desired_min_tx': desired_min_tx,
1605                                 'required_min_rx': required_min_rx,
1606                                 'local_addr': local_addr,
1607                                 'peer_addr': peer_addr,
1608                                 'is_ipv6': is_ipv6,
1609                                 'detect_mult': detect_mult,
1610                             })
1611         else:
1612             return self.api(self.papi.bfd_udp_add,
1613                             {
1614                                 'sw_if_index': sw_if_index,
1615                                 'desired_min_tx': desired_min_tx,
1616                                 'required_min_rx': required_min_rx,
1617                                 'local_addr': local_addr,
1618                                 'peer_addr': peer_addr,
1619                                 'is_ipv6': is_ipv6,
1620                                 'detect_mult': detect_mult,
1621                                 'is_authenticated': 1,
1622                                 'bfd_key_id': bfd_key_id,
1623                                 'conf_key_id': conf_key_id,
1624                             })
1625
1626     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1627                     detect_mult, local_addr, peer_addr, is_ipv6=0):
1628         return self.api(self.papi.bfd_udp_mod,
1629                         {
1630                             'sw_if_index': sw_if_index,
1631                             'desired_min_tx': desired_min_tx,
1632                             'required_min_rx': required_min_rx,
1633                             'local_addr': local_addr,
1634                             'peer_addr': peer_addr,
1635                             'is_ipv6': is_ipv6,
1636                             'detect_mult': detect_mult,
1637                         })
1638
1639     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1640                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1641                               is_delayed=False):
1642         return self.api(self.papi.bfd_udp_auth_activate,
1643                         {
1644                             'sw_if_index': sw_if_index,
1645                             'local_addr': local_addr,
1646                             'peer_addr': peer_addr,
1647                             'is_ipv6': is_ipv6,
1648                             'is_delayed': 1 if is_delayed else 0,
1649                             'bfd_key_id': bfd_key_id,
1650                             'conf_key_id': conf_key_id,
1651                         })
1652
1653     def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1654                                 is_ipv6=0, is_delayed=False):
1655         return self.api(self.papi.bfd_udp_auth_deactivate,
1656                         {
1657                             'sw_if_index': sw_if_index,
1658                             'local_addr': local_addr,
1659                             'peer_addr': peer_addr,
1660                             'is_ipv6': is_ipv6,
1661                             'is_delayed': 1 if is_delayed else 0,
1662                         })
1663
1664     def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1665         return self.api(self.papi.bfd_udp_del,
1666                         {
1667                             'sw_if_index': sw_if_index,
1668                             'local_addr': local_addr,
1669                             'peer_addr': peer_addr,
1670                             'is_ipv6': is_ipv6,
1671                         })
1672
1673     def bfd_udp_session_dump(self):
1674         return self.api(self.papi.bfd_udp_session_dump, {})
1675
1676     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1677                                   peer_addr, is_ipv6=0):
1678         return self.api(self.papi.bfd_udp_session_set_flags, {
1679             'admin_up_down': admin_up_down,
1680             'sw_if_index': sw_if_index,
1681             'local_addr': local_addr,
1682             'peer_addr': peer_addr,
1683             'is_ipv6': is_ipv6,
1684         })
1685
1686     def want_bfd_events(self, enable_disable=1):
1687         return self.api(self.papi.want_bfd_events, {
1688             'enable_disable': enable_disable,
1689             'pid': os.getpid(),
1690         })
1691
1692     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1693         return self.api(self.papi.bfd_auth_set_key, {
1694             'conf_key_id': conf_key_id,
1695             'auth_type': auth_type,
1696             'key': key,
1697             'key_len': len(key),
1698         })
1699
1700     def bfd_auth_del_key(self, conf_key_id):
1701         return self.api(self.papi.bfd_auth_del_key, {
1702             'conf_key_id': conf_key_id,
1703         })
1704
1705     def bfd_auth_keys_dump(self):
1706         return self.api(self.papi.bfd_auth_keys_dump, {})
1707
1708     def bfd_udp_set_echo_source(self, sw_if_index):
1709         return self.api(self.papi.bfd_udp_set_echo_source,
1710                         {'sw_if_index': sw_if_index})
1711
1712     def bfd_udp_del_echo_source(self):
1713         return self.api(self.papi.bfd_udp_del_echo_source, {})
1714
1715     def classify_add_del_table(
1716             self,
1717             is_add,
1718             mask,
1719             match_n_vectors=1,
1720             table_index=0xFFFFFFFF,
1721             nbuckets=2,
1722             memory_size=2097152,
1723             skip_n_vectors=0,
1724             next_table_index=0xFFFFFFFF,
1725             miss_next_index=0xFFFFFFFF,
1726             current_data_flag=0,
1727             current_data_offset=0):
1728         """
1729         :param is_add:
1730         :param mask:
1731         :param match_n_vectors: (Default value = 1)
1732         :param table_index: (Default value = 0xFFFFFFFF)
1733         :param nbuckets:  (Default value = 2)
1734         :param memory_size:  (Default value = 2097152)
1735         :param skip_n_vectors:  (Default value = 0)
1736         :param next_table_index:  (Default value = 0xFFFFFFFF)
1737         :param miss_next_index:  (Default value = 0xFFFFFFFF)
1738         :param current_data_flag:  (Default value = 0)
1739         :param current_data_offset:  (Default value = 0)
1740         """
1741
1742         return self.api(
1743             self.papi.classify_add_del_table,
1744             {'is_add': is_add,
1745              'table_index': table_index,
1746              'nbuckets': nbuckets,
1747              'memory_size': memory_size,
1748              'skip_n_vectors': skip_n_vectors,
1749              'match_n_vectors': match_n_vectors,
1750              'next_table_index': next_table_index,
1751              'miss_next_index': miss_next_index,
1752              'current_data_flag': current_data_flag,
1753              'current_data_offset': current_data_offset,
1754              'mask': mask})
1755
1756     def classify_add_del_session(
1757             self,
1758             is_add,
1759             table_index,
1760             match,
1761             opaque_index=0xFFFFFFFF,
1762             hit_next_index=0xFFFFFFFF,
1763             advance=0,
1764             action=0,
1765             metadata=0):
1766         """
1767         :param is_add:
1768         :param table_index:
1769         :param match:
1770         :param opaque_index:  (Default value = 0xFFFFFFFF)
1771         :param hit_next_index:  (Default value = 0xFFFFFFFF)
1772         :param advance:  (Default value = 0)
1773         :param action:  (Default value = 0)
1774         :param metadata:  (Default value = 0)
1775         """
1776
1777         return self.api(
1778             self.papi.classify_add_del_session,
1779             {'is_add': is_add,
1780              'table_index': table_index,
1781              'hit_next_index': hit_next_index,
1782              'opaque_index': opaque_index,
1783              'advance': advance,
1784              'action': action,
1785              'metadata': metadata,
1786              'match': match})
1787
1788     def input_acl_set_interface(
1789             self,
1790             is_add,
1791             sw_if_index,
1792             ip4_table_index=0xFFFFFFFF,
1793             ip6_table_index=0xFFFFFFFF,
1794             l2_table_index=0xFFFFFFFF):
1795         """
1796         :param is_add:
1797         :param sw_if_index:
1798         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
1799         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
1800         :param l2_table_index:  (Default value = 0xFFFFFFFF)
1801         """
1802
1803         return self.api(
1804             self.papi.input_acl_set_interface,
1805             {'sw_if_index': sw_if_index,
1806              'ip4_table_index': ip4_table_index,
1807              'ip6_table_index': ip6_table_index,
1808              'l2_table_index': l2_table_index,
1809              'is_add': is_add})
1810
1811     def set_ipfix_exporter(
1812             self,
1813             collector_address,
1814             src_address,
1815             path_mtu,
1816             template_interval,
1817             vrf_id=0,
1818             collector_port=4739,
1819             udp_checksum=0):
1820         return self.api(
1821             self.papi.set_ipfix_exporter,
1822             {
1823                 'collector_address': collector_address,
1824                 'collector_port': collector_port,
1825                 'src_address': src_address,
1826                 'vrf_id': vrf_id,
1827                 'path_mtu': path_mtu,
1828                 'template_interval': template_interval,
1829                 'udp_checksum': udp_checksum,
1830             })
1831
1832     def dhcp_proxy_config(self,
1833                           dhcp_server,
1834                           dhcp_src_address,
1835                           rx_table_id=0,
1836                           server_table_id=0,
1837                           is_add=1,
1838                           is_ipv6=0):
1839         return self.api(
1840             self.papi.dhcp_proxy_config,
1841             {
1842                 'rx_vrf_id': rx_table_id,
1843                 'server_vrf_id': server_table_id,
1844                 'is_ipv6': is_ipv6,
1845                 'is_add': is_add,
1846                 'dhcp_server': dhcp_server,
1847                 'dhcp_src_address': dhcp_src_address,
1848             })
1849
1850     def dhcp_proxy_set_vss(self,
1851                            table_id,
1852                            fib_id,
1853                            oui,
1854                            is_add=1,
1855                            is_ip6=0):
1856         return self.api(
1857             self.papi.dhcp_proxy_set_vss,
1858             {
1859                 'tbl_id': table_id,
1860                 'fib_id': fib_id,
1861                 'is_ipv6': is_ip6,
1862                 'is_add': is_add,
1863                 'oui': oui,
1864             })
1865
1866     def dhcp_client(self,
1867                     sw_if_index,
1868                     hostname,
1869                     client_id='',
1870                     is_add=1,
1871                     want_dhcp_events=0):
1872         return self.api(
1873             self.papi.dhcp_client_config,
1874             {
1875                 'sw_if_index': sw_if_index,
1876                 'hostname': hostname,
1877                 'client_id': client_id,
1878                 'is_add': is_add,
1879                 'want_dhcp_event': want_dhcp_events,
1880                 'pid': os.getpid(),
1881             })
1882
1883     def ip_mroute_add_del(self,
1884                           src_address,
1885                           grp_address,
1886                           grp_address_length,
1887                           e_flags,
1888                           next_hop_sw_if_index,
1889                           i_flags,
1890                           rpf_id=0,
1891                           table_id=0,
1892                           is_add=1,
1893                           is_ipv6=0,
1894                           is_local=0):
1895         """
1896         """
1897         return self.api(
1898             self.papi.ip_mroute_add_del,
1899             {'next_hop_sw_if_index': next_hop_sw_if_index,
1900              'entry_flags': e_flags,
1901              'itf_flags': i_flags,
1902              'table_id': table_id,
1903              'rpf_id': rpf_id,
1904              'is_add': is_add,
1905              'is_ipv6': is_ipv6,
1906              'is_local': is_local,
1907              'grp_address_length': grp_address_length,
1908              'grp_address': grp_address,
1909              'src_address': src_address})
1910
1911     def mfib_signal_dump(self):
1912         return self.api(self.papi.mfib_signal_dump, {})
1913
1914     def ip_mfib_dump(self):
1915         return self.api(self.papi.ip_mfib_dump, {})
1916
1917     def lisp_enable_disable(self, is_enabled):
1918         return self.api(
1919             self.papi.lisp_enable_disable,
1920             {
1921                 'is_en': is_enabled,
1922             })
1923
1924     def lisp_locator_set(self,
1925                          ls_name,
1926                          is_add=1):
1927         return self.api(
1928             self.papi.lisp_add_del_locator_set,
1929             {
1930                 'is_add': is_add,
1931                 'locator_set_name': ls_name
1932             })
1933
1934     def lisp_locator_set_dump(self):
1935         return self.api(self.papi.lisp_locator_set_dump, {})
1936
1937     def lisp_locator(self,
1938                      ls_name,
1939                      sw_if_index,
1940                      priority=1,
1941                      weight=1,
1942                      is_add=1):
1943         return self.api(
1944             self.papi.lisp_add_del_locator,
1945             {
1946                 'is_add': is_add,
1947                 'locator_set_name': ls_name,
1948                 'sw_if_index': sw_if_index,
1949                 'priority': priority,
1950                 'weight': weight
1951             })
1952
1953     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1954         return self.api(
1955             self.papi.lisp_locator_dump,
1956             {
1957                 'is_index_set': is_index_set,
1958                 'ls_name': ls_name,
1959                 'ls_index': ls_index,
1960             })
1961
1962     def lisp_local_mapping(self,
1963                            ls_name,
1964                            eid_type,
1965                            eid,
1966                            prefix_len,
1967                            vni=0,
1968                            key_id=0,
1969                            key="",
1970                            is_add=1):
1971         return self.api(
1972             self.papi.lisp_add_del_local_eid,
1973             {
1974                 'locator_set_name': ls_name,
1975                 'is_add': is_add,
1976                 'eid_type': eid_type,
1977                 'eid': eid,
1978                 'prefix_len': prefix_len,
1979                 'vni': vni,
1980                 'key_id': key_id,
1981                 'key': key
1982             })
1983
1984     def lisp_eid_table_dump(self,
1985                             eid_set=0,
1986                             prefix_length=0,
1987                             vni=0,
1988                             eid_type=0,
1989                             eid=None,
1990                             filter_opt=0):
1991         return self.api(
1992             self.papi.lisp_eid_table_dump,
1993             {
1994                 'eid_set': eid_set,
1995                 'prefix_length': prefix_length,
1996                 'vni': vni,
1997                 'eid_type': eid_type,
1998                 'eid': eid,
1999                 'filter': filter_opt,
2000             })
2001
2002     def lisp_remote_mapping(self,
2003                             eid_type,
2004                             eid,
2005                             eid_prefix_len=0,
2006                             vni=0,
2007                             rlocs=None,
2008                             rlocs_num=0,
2009                             is_src_dst=0,
2010                             is_add=1):
2011         return self.api(
2012             self.papi.lisp_add_del_remote_mapping,
2013             {
2014                 'is_add': is_add,
2015                 'eid_type': eid_type,
2016                 'eid': eid,
2017                 'eid_len': eid_prefix_len,
2018                 'rloc_num': rlocs_num,
2019                 'rlocs': rlocs,
2020                 'vni': vni,
2021                 'is_src_dst': is_src_dst,
2022             })
2023
2024     def lisp_adjacency(self,
2025                        leid,
2026                        reid,
2027                        leid_len,
2028                        reid_len,
2029                        eid_type,
2030                        is_add=1,
2031                        vni=0):
2032         return self.api(
2033             self.papi.lisp_add_del_adjacency,
2034             {
2035                 'is_add': is_add,
2036                 'vni': vni,
2037                 'eid_type': eid_type,
2038                 'leid': leid,
2039                 'reid': reid,
2040                 'leid_len': leid_len,
2041                 'reid_len': reid_len,
2042             })
2043
2044     def lisp_adjacencies_get(self, vni=0):
2045         return self.api(
2046             self.papi.lisp_adjacencies_get,
2047             {
2048                 'vni': vni
2049             })
2050
2051     def map_add_domain(self,
2052                        ip6_prefix,
2053                        ip6_prefix_len,
2054                        ip6_src,
2055                        ip6_src_prefix_len,
2056                        ip4_prefix,
2057                        ip4_prefix_len,
2058                        ea_bits_len=0,
2059                        psid_offset=0,
2060                        psid_length=0,
2061                        is_translation=0,
2062                        mtu=1280):
2063         return self.api(
2064             self.papi.map_add_domain,
2065             {
2066                 'ip6_prefix': ip6_prefix,
2067                 'ip6_prefix_len': ip6_prefix_len,
2068                 'ip4_prefix': ip4_prefix,
2069                 'ip4_prefix_len': ip4_prefix_len,
2070                 'ip6_src': ip6_src,
2071                 'ip6_src_prefix_len': ip6_src_prefix_len,
2072                 'ea_bits_len': ea_bits_len,
2073                 'psid_offset': psid_offset,
2074                 'psid_length': psid_length,
2075                 'is_translation': is_translation,
2076                 'mtu': mtu
2077             })
2078
2079     def gtpu_add_del_tunnel(
2080             self,
2081             src_addr,
2082             dst_addr,
2083             is_add=1,
2084             is_ipv6=0,
2085             mcast_sw_if_index=0xFFFFFFFF,
2086             encap_vrf_id=0,
2087             decap_next_index=0xFFFFFFFF,
2088             teid=0):
2089         """
2090
2091         :param is_add:  (Default value = 1)
2092         :param is_ipv6:  (Default value = 0)
2093         :param src_addr:
2094         :param dst_addr:
2095         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2096         :param encap_vrf_id:  (Default value = 0)
2097         :param decap_next_index:  (Default value = 0xFFFFFFFF)
2098         :param teid:  (Default value = 0)
2099
2100         """
2101         return self.api(self.papi.gtpu_add_del_tunnel,
2102                         {'is_add': is_add,
2103                          'is_ipv6': is_ipv6,
2104                          'src_address': src_addr,
2105                          'dst_address': dst_addr,
2106                          'mcast_sw_if_index': mcast_sw_if_index,
2107                          'encap_vrf_id': encap_vrf_id,
2108                          'decap_next_index': decap_next_index,
2109                          'teid': teid})
2110
2111     def vxlan_gpe_add_del_tunnel(
2112             self,
2113             src_addr,
2114             dst_addr,
2115             mcast_sw_if_index=0xFFFFFFFF,
2116             is_add=1,
2117             is_ipv6=0,
2118             encap_vrf_id=0,
2119             decap_vrf_id=0,
2120             protocol=3,
2121             vni=0):
2122         """
2123
2124         :param local:
2125         :param remote:
2126         :param is_add:  (Default value = 1)
2127         :param is_ipv6:  (Default value = 0)
2128         :param encap_vrf_id:  (Default value = 0)
2129         :param decap_vrf_id:  (Default value = 0)
2130         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2131         :param protocol:  (Default value = 3)
2132         :param vni:  (Default value = 0)
2133
2134         """
2135         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2136                         {'is_add': is_add,
2137                          'is_ipv6': is_ipv6,
2138                          'local': src_addr,
2139                          'remote': dst_addr,
2140                          'mcast_sw_if_index': mcast_sw_if_index,
2141                          'encap_vrf_id': encap_vrf_id,
2142                          'decap_vrf_id': decap_vrf_id,
2143                          'protocol': protocol,
2144                          'vni': vni})
2145
2146     def pppoe_add_del_session(
2147             self,
2148             client_ip,
2149             client_mac,
2150             session_id=0,
2151             is_add=1,
2152             is_ipv6=0,
2153             decap_vrf_id=0):
2154         """
2155
2156         :param is_add:  (Default value = 1)
2157         :param is_ipv6:  (Default value = 0)
2158         :param client_ip:
2159         :param session_id:  (Default value = 0)
2160         :param client_mac:
2161         :param decap_vrf_id:  (Default value = 0)
2162
2163         """
2164         return self.api(self.papi.pppoe_add_del_session,
2165                         {'is_add': is_add,
2166                          'is_ipv6': is_ipv6,
2167                          'session_id': session_id,
2168                          'client_ip': client_ip,
2169                          'decap_vrf_id': decap_vrf_id,
2170                          'client_mac': client_mac})
2171
2172     def sr_localsid_add_del(self,
2173                             localsid_addr,
2174                             behavior,
2175                             nh_addr,
2176                             is_del=0,
2177                             end_psp=0,
2178                             sw_if_index=0xFFFFFFFF,
2179                             vlan_index=0,
2180                             fib_table=0,
2181                             ):
2182         """ Add/del IPv6 SR local-SID.
2183
2184         :param localsid_addr:
2185         :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2186         :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2187         :param nh_addr:
2188         :param is_del:  (Default value = 0)
2189         :param end_psp: (Default value = 0)
2190         :param sw_if_index: (Default value = 0xFFFFFFFF)
2191         :param vlan_index:  (Default value = 0)
2192         :param fib_table:   (Default value = 0)
2193         """
2194         return self.api(
2195             self.papi.sr_localsid_add_del,
2196             {'is_del': is_del,
2197              'localsid_addr': localsid_addr,
2198              'end_psp': end_psp,
2199              'behavior': behavior,
2200              'sw_if_index': sw_if_index,
2201              'vlan_index': vlan_index,
2202              'fib_table': fib_table,
2203              'nh_addr': nh_addr
2204              }
2205         )
2206
2207     def sr_policy_add(
2208             self,
2209             bsid_addr,
2210             weight=1,
2211             is_encap=1,
2212             type=0,
2213             fib_table=0,
2214             n_segments=0,
2215             segments=[]):
2216         """
2217         :param bsid_addr: bindingSID of the SR Policy
2218         :param weight: weight of the sid list. optional. (default: 1)
2219         :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2220             (default: Encap)
2221         :param type: type/behavior of the SR policy. (default or spray) \
2222             (default: default)
2223         :param fib_table: VRF where to install the FIB entry for the BSID \
2224             (default: 0)
2225         :param n_segments: number of segments \
2226             (default: 0)
2227         :param segments: a vector of IPv6 address composing the segment list \
2228             (default: [])
2229         """
2230         return self.api(
2231             self.papi.sr_policy_add,
2232             {'bsid_addr': bsid_addr,
2233              'weight': weight,
2234              'is_encap': is_encap,
2235              'type': type,
2236              'fib_table': fib_table,
2237              'n_segments': n_segments,
2238              'segments': segments
2239              }
2240         )
2241
2242     def sr_policy_del(
2243             self,
2244             bsid_addr,
2245             sr_policy_index=0):
2246         """
2247         :param bsid: bindingSID of the SR Policy
2248         :param sr_policy_index: index of the sr policy (default: 0)
2249         """
2250         return self.api(
2251             self.papi.sr_policy_del,
2252             {'bsid_addr': bsid_addr,
2253              'sr_policy_index': sr_policy_index
2254              })
2255
2256     def sr_steering_add_del(
2257             self,
2258             is_del,
2259             bsid_addr,
2260             sr_policy_index,
2261             table_id,
2262             prefix_addr,
2263             mask_width,
2264             sw_if_index,
2265             traffic_type):
2266         """
2267         Steer traffic L2 and L3 traffic through a given SR policy
2268
2269         :param is_del: delete or add
2270         :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2271         :param sr_policy: is the index of the SR Policy (alt to bsid)
2272         :param table_id: is the VRF where to install the FIB entry for the BSID
2273         :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2274         :param mask_width: is the mask for L3 traffic type
2275         :param sw_if_index: is the incoming interface for L2 traffic
2276         :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2277         """
2278         return self.api(
2279             self.papi.sr_steering_add_del,
2280             {'is_del': is_del,
2281              'bsid_addr': bsid_addr,
2282              'sr_policy_index': sr_policy_index,
2283              'table_id': table_id,
2284              'prefix_addr': prefix_addr,
2285              'mask_width': mask_width,
2286              'sw_if_index': sw_if_index,
2287              'traffic_type': traffic_type
2288              })
2289
2290     def acl_add_replace(self, acl_index, r, tag='',
2291                         expected_retval=0):
2292         """Add/replace an ACL
2293         :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2294         :param acl_rule r: ACL rules array.
2295         :param str tag: symbolic tag (description) for this ACL.
2296         :param int count: number of rules.
2297         """
2298         return self.api(self.papi.acl_add_replace,
2299                         {'acl_index': acl_index,
2300                          'r': r,
2301                          'count': len(r),
2302                          'tag': tag},
2303                         expected_retval=expected_retval)
2304
2305     def acl_del(self, acl_index, expected_retval=0):
2306         """
2307
2308         :param acl_index:
2309         :return:
2310         """
2311         return self.api(self.papi.acl_del,
2312                         {'acl_index': acl_index},
2313                         expected_retval=expected_retval)
2314
2315     def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2316                                    expected_retval=0):
2317         return self.api(self.papi.acl_interface_set_acl_list,
2318                         {'sw_if_index': sw_if_index,
2319                          'count': len(acls),
2320                          'n_input': n_input,
2321                          'acls': acls},
2322                         expected_retval=expected_retval)
2323
2324     def acl_dump(self, acl_index, expected_retval=0):
2325         return self.api(self.papi.acl_dump,
2326                         {'acl_index': acl_index},
2327                         expected_retval=expected_retval)
2328
2329     def macip_acl_add(self, rules, tag=""):
2330         """ Add MACIP acl
2331
2332         :param rules: list of rules for given acl
2333         :param tag: acl tag
2334         """
2335
2336         return self.api(self.papi.macip_acl_add,
2337                         {'r': rules,
2338                          'count': len(rules),
2339                          'tag': tag})
2340
2341     def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2342         """ Add MACIP acl
2343
2344         :param rules: list of rules for given acl
2345         :param tag: acl tag
2346         """
2347
2348         return self.api(self.papi.macip_acl_add_replace,
2349                         {'acl_index': acl_index,
2350                          'r': rules,
2351                          'count': len(rules),
2352                          'tag': tag})
2353
2354     def macip_acl_del(self, acl_index):
2355         """
2356
2357         :param acl_index:
2358         :return:
2359         """
2360         return self.api(self.papi.macip_acl_del,
2361                         {'acl_index': acl_index})
2362
2363     def macip_acl_interface_add_del(self,
2364                                     sw_if_index,
2365                                     acl_index,
2366                                     is_add=1):
2367         """ Add MACIP acl to interface
2368
2369         :param sw_if_index:
2370         :param acl_index:
2371         :param is_add:  (Default value = 1)
2372         """
2373
2374         return self.api(self.papi.macip_acl_interface_add_del,
2375                         {'is_add': is_add,
2376                          'sw_if_index': sw_if_index,
2377                          'acl_index': acl_index})
2378
2379     def macip_acl_interface_get(self):
2380         """ Return interface acls dump
2381         """
2382         return self.api(
2383             self.papi.macip_acl_interface_get, {})
2384
2385     def macip_acl_dump(self, acl_index=4294967295):
2386         """ Return MACIP acl dump
2387         """
2388
2389         return self.api(
2390             self.papi.macip_acl_dump, {'acl_index': acl_index})