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