test/vpp_papi_provider.py

   1 import os
   2 import time
   3 from collections import deque
   4
   5 from six import moves
   6 from vpp_papi import VPP, mac_pton
   7 from hook import Hook
   8 from vpp_l2 import L2_PORT_TYPE
   9
  10 # from vnet/vnet/mpls/mpls_types.h
  11 MPLS_IETF_MAX_LABEL = 0xfffff
  12 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
  13
  14
  15 class L2_VTR_OP:
  16     L2_DISABLED = 0
  17     L2_PUSH_1 = 1
  18     L2_PUSH_2 = 2
  19     L2_POP_1 = 3
  20     L2_POP_2 = 4
  21     L2_TRANSLATE_1_1 = 5
  22     L2_TRANSLATE_1_2 = 6
  23     L2_TRANSLATE_2_1 = 7
  24     L2_TRANSLATE_2_2 = 8
  25
  26
  27 class QOS_SOURCE:
  28     EXT = 0
  29     VLAN = 1
  30     MPLS = 2
  31     IP = 3
  32
  33
  34 class SYSLOG_SEVERITY:
  35     EMERG = 0
  36     ALERT = 1
  37     CRIT = 2
  38     ERR = 3
  39     WARN = 4
  40     NOTICE = 5
  41     INFO = 6
  42     DBG = 7
  43
  44
  45 class UnexpectedApiReturnValueError(Exception):
  46     """ exception raised when the API return value is unexpected """
  47     pass
  48
  49
  50 class VppPapiProvider(object):
  51     """VPP-api provider using vpp-papi
  52
  53     @property hook: hook object providing before and after api/cli hooks
  54     """
  55
  56     _zero, _negative = range(2)
  57
  58     def __init__(self, name, shm_prefix, test_class, read_timeout):
  59         self.hook = Hook(test_class)
  60         self.name = name
  61         self.shm_prefix = shm_prefix
  62         self.test_class = test_class
  63         self._expect_api_retval = self._zero
  64         self._expect_stack = []
  65
  66         install_dir = os.getenv('VPP_INSTALL_PATH')
  67
  68         # Vapi requires 'VPP_API_DIR', not set when run from Makefile.
  69         if 'VPP_API_DIR' not in os.environ:
  70             os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH')
  71
  72         self.vpp = VPP(logger=test_class.logger,
  73                        read_timeout=read_timeout)
  74         self._events = deque()
  75
  76     def __enter__(self):
  77         return self
  78
  79     def assert_negative_api_retval(self):
  80         """ Expect API failure - used with with, e.g.:
  81             with self.vapi.assert_negative_api_retval():
  82                 self.vapi.<api call expected to fail>
  83         """
  84         self._expect_stack.append(self._expect_api_retval)
  85         self._expect_api_retval = self._negative
  86         return self
  87
  88     def assert_zero_api_retval(self):
  89         """ Expect API success - used with with, e.g.:
  90             with self.vapi.assert_negative_api_retval():
  91                 self.vapi.<api call expected to succeed>
  92
  93             note: this is useful only inside another with block
  94                   as success is the default expected value
  95         """
  96         self._expect_stack.append(self._expect_api_retval)
  97         self._expect_api_retval = self._zero
  98         return self
  99
 100     def __exit__(self, exc_type, exc_value, traceback):
 101         self._expect_api_retval = self._expect_stack.pop()
 102
 103     def register_hook(self, hook):
 104         """Replace hook registration with new hook
 105
 106         :param hook:
 107
 108         """
 109         self.hook = hook
 110
 111     def collect_events(self):
 112         """ Collect all events from the internal queue and clear the queue. """
 113         e = self._events
 114         self._events = deque()
 115         return e
 116
 117     def wait_for_event(self, timeout, name=None):
 118         """ Wait for and return next event. """
 119         if name:
 120             self.test_class.logger.debug("Expecting event '%s' within %ss",
 121                                          name, timeout)
 122         else:
 123             self.test_class.logger.debug("Expecting event within %ss",
 124                                          timeout)
 125         if self._events:
 126             self.test_class.logger.debug("Not waiting, event already queued")
 127         limit = time.time() + timeout
 128         while time.time() < limit:
 129             if self._events:
 130                 e = self._events.popleft()
 131                 if name and type(e).__name__ != name:
 132                     raise Exception(
 133                         "Unexpected event received: %s, expected: %s" %
 134                         (type(e).__name__, name))
 135                 self.test_class.logger.debug("Returning event %s:%s" %
 136                                              (name, e))
 137                 return e
 138             time.sleep(0)  # yield
 139         raise Exception("Event did not occur within timeout")
 140
 141     def __call__(self, name, event):
 142         """ Enqueue event in the internal event queue. """
 143         # FIXME use the name instead of relying on type(e).__name__ ?
 144         # FIXME #2 if this throws, it is eaten silently, Ole?
 145         self.test_class.logger.debug("New event: %s: %s" % (name, event))
 146         self._events.append(event)
 147
 148     def connect(self):
 149         """Connect the API to VPP"""
 150         self.vpp.connect(self.name, self.shm_prefix)
 151         self.papi = self.vpp.api
 152         self.vpp.register_event_callback(self)
 153
 154     def disconnect(self):
 155         """Disconnect the API from VPP"""
 156         self.vpp.disconnect()
 157
 158     def api(self, api_fn, api_args, expected_retval=0):
 159         """ Call API function and check it's return value.
 160         Call the appropriate hooks before and after the API call
 161
 162         :param api_fn: API function to call
 163         :param api_args: tuple of API function arguments
 164         :param expected_retval: Expected return value (Default value = 0)
 165         :returns: reply from the API
 166
 167         """
 168         self.hook.before_api(api_fn.__name__, api_args)
 169         reply = api_fn(**api_args)
 170         if self._expect_api_retval == self._negative:
 171             if hasattr(reply, 'retval') and reply.retval >= 0:
 172                 msg = "API call passed unexpectedly: expected negative "\
 173                     "return value instead of %d in %s" % \
 174                     (reply.retval, moves.reprlib.repr(reply))
 175                 self.test_class.logger.info(msg)
 176                 raise UnexpectedApiReturnValueError(msg)
 177         elif self._expect_api_retval == self._zero:
 178             if hasattr(reply, 'retval') and reply.retval != expected_retval:
 179                 msg = "API call failed, expected %d return value instead "\
 180                     "of %d in %s" % (expected_retval, reply.retval,
 181                                      moves.reprlib.repr(reply))
 182                 self.test_class.logger.info(msg)
 183                 raise UnexpectedApiReturnValueError(msg)
 184         else:
 185             raise Exception("Internal error, unexpected value for "
 186                             "self._expect_api_retval %s" %
 187                             self._expect_api_retval)
 188         self.hook.after_api(api_fn.__name__, api_args)
 189         return reply
 190
 191     def cli(self, cli):
 192         """ Execute a CLI, calling the before/after hooks appropriately.
 193
 194         :param cli: CLI to execute
 195         :returns: CLI output
 196
 197         """
 198         self.hook.before_cli(cli)
 199         cli += '\n'
 200         r = self.papi.cli_inband(cmd=cli)
 201         self.hook.after_cli(cli)
 202         if hasattr(r, 'reply'):
 203             return r.reply
 204
 205     def ppcli(self, cli):
 206         """ Helper method to print CLI command in case of info logging level.
 207
 208         :param cli: CLI to execute
 209         :returns: CLI output
 210         """
 211         return cli + "\n" + str(self.cli(cli))
 212
 213     def show_version(self):
 214         """ """
 215         return self.api(self.papi.show_version, {})
 216
 217     def pg_create_interface(self, pg_index):
 218         """
 219
 220         :param pg_index:
 221
 222         """
 223         return self.api(self.papi.pg_create_interface,
 224                         {"interface_id": pg_index})
 225
 226     def sw_interface_dump(self, filter=None):
 227         """
 228
 229         :param filter:  (Default value = None)
 230
 231         """
 232         if filter is not None:
 233             args = {"name_filter_valid": 1, "name_filter": filter}
 234         else:
 235             args = {}
 236         return self.api(self.papi.sw_interface_dump, args)
 237
 238     def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
 239         """ Set the IPvX Table-id for the Interface
 240
 241         :param sw_if_index:
 242         :param is_ipv6:
 243         :param table_id:
 244
 245         """
 246         return self.api(self.papi.sw_interface_set_table,
 247                         {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
 248                          'vrf_id': table_id})
 249
 250     def sw_interface_get_table(self, sw_if_index, is_ipv6):
 251         """ Get the IPvX Table-id for the Interface
 252
 253         :param sw_if_index:
 254         :param is_ipv6:
 255         :return table_id
 256
 257         """
 258         return self.api(self.papi.sw_interface_get_table,
 259                         {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6})
 260
 261     def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
 262                                      is_ipv6=0, is_add=1, del_all=0):
 263         """
 264
 265         :param addr: param is_ipv6:  (Default value = 0)
 266         :param sw_if_index:
 267         :param addr_len:
 268         :param is_ipv6:  (Default value = 0)
 269         :param is_add:  (Default value = 1)
 270         :param del_all:  (Default value = 0)
 271
 272         """
 273         return self.api(self.papi.sw_interface_add_del_address,
 274                         {'sw_if_index': sw_if_index,
 275                          'is_add': is_add,
 276                          'is_ipv6': is_ipv6,
 277                          'del_all': del_all,
 278                          'address_length': addr_len,
 279                          'address': addr})
 280
 281     def ip_address_dump(self, sw_if_index, is_ipv6=0):
 282         return self.api(self.papi.ip_address_dump,
 283                         {'sw_if_index': sw_if_index,
 284                          'is_ipv6': is_ipv6})
 285
 286     def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
 287                                     is_add=1):
 288         """ Set the Interface to be unnumbered
 289
 290         :param is_add:  (Default value = 1)
 291         :param sw_if_index - interface That will be unnumbered
 292         :param ip_sw_if_index - interface with an IP addres
 293
 294         """
 295         return self.api(self.papi.sw_interface_set_unnumbered,
 296                         {'sw_if_index': ip_sw_if_index,
 297                          'unnumbered_sw_if_index': sw_if_index,
 298                          'is_add': is_add})
 299
 300     def ip_unnumbered_dump(self, sw_if_index=0xffffffff):
 301         return self.api(self.papi.ip_unnumbered_dump,
 302                         {'sw_if_index': sw_if_index})
 303
 304     def sw_interface_enable_disable_mpls(self, sw_if_index,
 305                                          is_enable=1):
 306         """
 307         Enable/Disable MPLS on the interface
 308         :param sw_if_index:
 309         :param is_enable:  (Default value = 1)
 310
 311         """
 312         return self.api(self.papi.sw_interface_set_mpls_enable,
 313                         {'sw_if_index': sw_if_index,
 314                          'enable': is_enable})
 315
 316     def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
 317         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 318                         {'sw_if_index': sw_if_index,
 319                          'suppress': suppress})
 320
 321     def set_ip_flow_hash(self,
 322                          table_id,
 323                          src=1,
 324                          dst=1,
 325                          sport=1,
 326                          dport=1,
 327                          proto=1,
 328                          reverse=0,
 329                          is_ip6=0):
 330         return self.api(self.papi.set_ip_flow_hash,
 331                         {'vrf_id': table_id,
 332                          'src': src,
 333                          'dst': dst,
 334                          'dport': dport,
 335                          'sport': sport,
 336                          'proto': proto,
 337                          'reverse': reverse,
 338                          'is_ipv6': is_ip6})
 339
 340     def ip6_nd_proxy(self, ip, sw_if_index, is_del=0):
 341         return self.api(self.papi.ip6nd_proxy_add_del,
 342                         {'ip': ip,
 343                          'sw_if_index': sw_if_index,
 344                          'is_del': is_del})
 345
 346     def ip6_sw_interface_ra_config(self, sw_if_index,
 347                                    no,
 348                                    suppress,
 349                                    send_unicast):
 350         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 351                         {'sw_if_index': sw_if_index,
 352                          'is_no': no,
 353                          'suppress': suppress,
 354                          'send_unicast': send_unicast})
 355
 356     def ip6_sw_interface_ra_prefix(self,
 357                                    sw_if_index,
 358                                    address,
 359                                    address_length,
 360                                    use_default=0,
 361                                    no_advertise=0,
 362                                    off_link=0,
 363                                    no_autoconfig=0,
 364                                    no_onlink=0,
 365                                    is_no=0,
 366                                    val_lifetime=0xffffffff,
 367                                    pref_lifetime=0xffffffff):
 368         return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
 369                         {'sw_if_index': sw_if_index,
 370                          'prefix': {
 371                              'address': address,
 372                              'address_length': address_length,
 373                          },
 374                          'use_default': use_default,
 375                          'no_advertise': no_advertise,
 376                          'off_link': off_link,
 377                          'no_autoconfig': no_autoconfig,
 378                          'no_onlink': no_onlink,
 379                          'is_no': is_no,
 380                          'val_lifetime': val_lifetime,
 381                          'pref_lifetime': pref_lifetime})
 382
 383     def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
 384         """
 385         Enable/Disable An interface for IPv6
 386         """
 387         return self.api(self.papi.sw_interface_ip6_enable_disable,
 388                         {'sw_if_index': sw_if_index,
 389                          'enable': enable})
 390
 391     def vxlan_add_del_tunnel(
 392             self,
 393             src_addr,
 394             dst_addr,
 395             mcast_sw_if_index=0xFFFFFFFF,
 396             is_add=1,
 397             is_ipv6=0,
 398             encap_vrf_id=0,
 399             decap_next_index=0xFFFFFFFF,
 400             vni=0,
 401             instance=0xFFFFFFFF):
 402         """
 403
 404         :param dst_addr:
 405         :param src_addr:
 406         :param is_add:  (Default value = 1)
 407         :param is_ipv6:  (Default value = 0)
 408         :param encap_vrf_id:  (Default value = 0)
 409         :param decap_next_index:  (Default value = 0xFFFFFFFF)
 410         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 411         :param vni:  (Default value = 0)
 412         :param instance:  (Default value = 0xFFFFFFFF)
 413
 414         """
 415         return self.api(self.papi.vxlan_add_del_tunnel,
 416                         {'is_add': is_add,
 417                          'is_ipv6': is_ipv6,
 418                          'src_address': src_addr,
 419                          'dst_address': dst_addr,
 420                          'mcast_sw_if_index': mcast_sw_if_index,
 421                          'encap_vrf_id': encap_vrf_id,
 422                          'decap_next_index': decap_next_index,
 423                          'vni': vni,
 424                          'instance': instance})
 425
 426     def geneve_add_del_tunnel(
 427             self,
 428             local_addr,
 429             remote_addr,
 430             mcast_sw_if_index=0xFFFFFFFF,
 431             is_add=1,
 432             is_ipv6=0,
 433             encap_vrf_id=0,
 434             decap_next_index=0xFFFFFFFF,
 435             vni=0):
 436         """
 437
 438         :param remote_addr:
 439         :param local_addr:
 440         :param is_add:  (Default value = 1)
 441         :param is_ipv6:  (Default value = 0)
 442         :param encap_vrf_id:  (Default value = 0)
 443         :param decap_next_index:  (Default value = 0xFFFFFFFF)
 444         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 445         :param vni:  (Default value = 0)
 446
 447         """
 448         return self.api(self.papi.geneve_add_del_tunnel,
 449                         {'is_add': is_add,
 450                          'is_ipv6': is_ipv6,
 451                          'local_address': local_addr,
 452                          'remote_address': remote_addr,
 453                          'mcast_sw_if_index': mcast_sw_if_index,
 454                          'encap_vrf_id': encap_vrf_id,
 455                          'decap_next_index': decap_next_index,
 456                          'vni': vni})
 457
 458     def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
 459                               learn=1, arp_term=0, is_add=1):
 460         """Create/delete bridge domain.
 461
 462         :param int bd_id: Bridge domain index.
 463         :param int flood: Enable/disable bcast/mcast flooding in the BD.
 464             (Default value = 1)
 465         :param int uu_flood: Enable/disable unknown unicast flood in the BD.
 466             (Default value = 1)
 467         :param int forward: Enable/disable forwarding on all interfaces in
 468             the BD. (Default value = 1)
 469         :param int learn: Enable/disable learning on all interfaces in the BD.
 470             (Default value = 1)
 471         :param int arp_term: Enable/disable arp termination in the BD.
 472             (Default value = 1)
 473         :param int is_add: Add or delete flag. (Default value = 1)
 474         """
 475         return self.api(self.papi.bridge_domain_add_del,
 476                         {'bd_id': bd_id,
 477                          'flood': flood,
 478                          'uu_flood': uu_flood,
 479                          'forward': forward,
 480                          'learn': learn,
 481                          'arp_term': arp_term,
 482                          'is_add': is_add})
 483
 484     def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
 485         return self.api(self.papi.bd_ip_mac_add_del,
 486                         {'bd_id': bd_id,
 487                          'is_add': is_add,
 488                          'ip': ip,
 489                          'mac': mac})
 490
 491     def bd_ip_mac_dump(self, bd_id):
 492         return self.api(self.papi.bd_ip_mac_dump,
 493                         {'bd_id': bd_id})
 494
 495     def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
 496         return self.api(self.papi.want_ip4_arp_events,
 497                         {'enable_disable': enable_disable,
 498                          'ip': ip,
 499                          'pid': os.getpid(), })
 500
 501     def want_ip6_nd_events(self, enable_disable=1, ip="::"):
 502         return self.api(self.papi.want_ip6_nd_events,
 503                         {'enable_disable': enable_disable,
 504                          'ip': ip,
 505                          'pid': os.getpid(), })
 506
 507     def want_ip6_ra_events(self, enable_disable=1):
 508         return self.api(self.papi.want_ip6_ra_events,
 509                         {'enable_disable': enable_disable,
 510                          'pid': os.getpid(), })
 511
 512     def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
 513                                        mrc=0, mrd=0):
 514         return self.api(self.papi.ip6nd_send_router_solicitation,
 515                         {'irt': irt,
 516                          'mrt': mrt,
 517                          'mrc': mrc,
 518                          'mrd': mrd,
 519                          'sw_if_index': sw_if_index})
 520
 521     def ip6_nd_address_autoconfig(self, sw_if_index, enable,
 522                                   install_default_routes):
 523         return self.api(self.papi.ip6_nd_address_autoconfig,
 524                         {'sw_if_index': sw_if_index,
 525                          'enable': enable,
 526                          'install_default_routes': install_default_routes})
 527
 528     def want_interface_events(self, enable_disable=1):
 529         return self.api(self.papi.want_interface_events,
 530                         {'enable_disable': enable_disable,
 531                          'pid': os.getpid(), })
 532
 533     def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
 534                                max_macs_in_event=0, learn_limit=0):
 535         return self.api(self.papi.want_l2_macs_events,
 536                         {'enable_disable': enable_disable,
 537                          'scan_delay': scan_delay,
 538                          'max_macs_in_event': max_macs_in_event,
 539                          'learn_limit': learn_limit,
 540                          'pid': os.getpid(), })
 541
 542     def want_dhcp6_reply_events(self, enable_disable=1):
 543         return self.api(self.papi.want_dhcp6_reply_events,
 544                         {'enable_disable': enable_disable,
 545                          'pid': os.getpid()})
 546
 547     def want_dhcp6_pd_reply_events(self, enable_disable=1):
 548         return self.api(self.papi.want_dhcp6_pd_reply_events,
 549                         {'enable_disable': enable_disable,
 550                          'pid': os.getpid()})
 551
 552     def dhcp6_clients_enable_disable(self, enable=1):
 553         return self.api(self.papi.dhcp6_clients_enable_disable,
 554                         {'enable': enable})
 555
 556     def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
 557                                   addresses, server_index=0xFFFFFFFF,
 558                                   irt=0, mrt=0, mrc=1, mrd=0, stop=0,
 559                                   ):
 560         return self.api(self.papi.dhcp6_send_client_message,
 561                         {'sw_if_index': sw_if_index,
 562                          'server_index': server_index,
 563                          'irt': irt,
 564                          'mrt': mrt,
 565                          'mrc': mrc,
 566                          'mrd': mrd,
 567                          'stop': stop,
 568                          'msg_type': msg_type,
 569                          'T1': T1,
 570                          'T2': T2,
 571                          'n_addresses': len(addresses),
 572                          'addresses': addresses})
 573
 574     def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
 575                                      prefixes, server_index=0xFFFFFFFF,
 576                                      irt=0, mrt=0, mrc=1, mrd=0, stop=0,
 577                                      ):
 578         return self.api(self.papi.dhcp6_pd_send_client_message,
 579                         {'sw_if_index': sw_if_index,
 580                          'server_index': server_index,
 581                          'irt': irt,
 582                          'mrt': mrt,
 583                          'mrc': mrc,
 584                          'mrd': mrd,
 585                          'stop': stop,
 586                          'msg_type': msg_type,
 587                          'T1': T1,
 588                          'T2': T2,
 589                          'n_prefixes': len(prefixes),
 590                          'prefixes': prefixes})
 591
 592     def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
 593                                     enable=1):
 594         return self.api(self.papi.dhcp6_client_enable_disable,
 595                         {'sw_if_index': sw_if_index,
 596                          'enable': enable})
 597
 598     def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
 599                                        enable=1):
 600         return self.api(self.papi.dhcp6_pd_client_enable_disable,
 601                         {'sw_if_index': sw_if_index,
 602                          'prefix_group': prefix_group,
 603                          'enable': enable})
 604
 605     def ip6_add_del_address_using_prefix(self, sw_if_index, address,
 606                                          prefix_length, prefix_group,
 607                                          is_add=1):
 608         return self.api(self.papi.ip6_add_del_address_using_prefix,
 609                         {'sw_if_index': sw_if_index,
 610                          'prefix_group': prefix_group,
 611                          'address': address,
 612                          'prefix_length': prefix_length,
 613                          'is_add': is_add})
 614
 615     def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
 616                       filter_mac=0, bvi_mac=0):
 617         """Create/delete L2 FIB entry.
 618
 619         :param str mac: MAC address to create FIB entry for.
 620         :param int bd_id: Bridge domain index.
 621         :param int sw_if_index: Software interface index of the interface.
 622         :param int is_add: Add or delete flag. (Default value = 1)
 623         :param int static_mac: Set to 1 to create static MAC entry.
 624             (Default value = 0)
 625         :param int filter_mac: Set to 1 to drop packet that's source or
 626             destination MAC address contains defined MAC address.
 627             (Default value = 0)
 628         :param int bvi_mac: Set to 1 to create entry that points to BVI
 629             interface. (Default value = 0)
 630         """
 631         return self.api(self.papi.l2fib_add_del,
 632                         {'mac': mac,
 633                          'bd_id': bd_id,
 634                          'sw_if_index': sw_if_index,
 635                          'is_add': is_add,
 636                          'static_mac': static_mac,
 637                          'filter_mac': filter_mac,
 638                          'bvi_mac': bvi_mac})
 639
 640     def l2fib_flush_int(self, sw_if_index):
 641         """Flush L2 FIB entries for sw_if_index.
 642
 643         :param int sw_if_index: Software interface index of the interface.
 644         """
 645         return self.api(self.papi.l2fib_flush_int,
 646                         {'sw_if_index': sw_if_index})
 647
 648     def l2fib_flush_bd(self, bd_id):
 649         """Flush L2 FIB entries for bd_id.
 650
 651         :param int sw_if_index: Bridge Domain id.
 652         """
 653         return self.api(self.papi.l2fib_flush_bd,
 654                         {'bd_id': bd_id})
 655
 656     def l2fib_flush_all(self):
 657         """Flush all L2 FIB.
 658         """
 659         return self.api(self.papi.l2fib_flush_all, {})
 660
 661     def l2_fib_table_dump(self, bd_id):
 662         """ Dump the L2 FIB """
 663         return self.api(self.papi.l2_fib_table_dump,
 664                         {'bd_id': bd_id})
 665
 666     def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
 667                                    shg=0, port_type=L2_PORT_TYPE.NORMAL,
 668                                    enable=1):
 669         """Add/remove interface to/from bridge domain.
 670
 671         :param int sw_if_index: Software interface index of the interface.
 672         :param int bd_id: Bridge domain index.
 673         :param int shg: Split-horizon group index. (Default value = 0)
 674         :param int bvi: Set interface as a bridge group virtual interface.
 675             (Default value = 0)
 676         :param int enable: Add or remove interface. (Default value = 1)
 677         """
 678         return self.api(self.papi.sw_interface_set_l2_bridge,
 679                         {'rx_sw_if_index': sw_if_index,
 680                          'bd_id': bd_id,
 681                          'shg': shg,
 682                          'port_type': port_type,
 683                          'enable': enable})
 684
 685     def bridge_flags(self, bd_id, is_set, feature_bitmap):
 686         """Enable/disable required feature of the bridge domain with defined
 687         ID.
 688
 689         :param int bd_id: Bridge domain ID.
 690         :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
 691         :param int flags: Bitmap value of the feature to be set:
 692             - learn (1 << 0),
 693             - forward (1 << 1),
 694             - flood (1 << 2),
 695             - uu-flood (1 << 3) or
 696             - arp-term (1 << 4).
 697         """
 698         return self.api(self.papi.bridge_flags,
 699                         {'bd_id': bd_id,
 700                          'is_set': is_set,
 701                          'flags': feature_bitmap})
 702
 703     def bridge_domain_dump(self, bd_id=0):
 704         """
 705
 706         :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
 707             existing bridge domains returned)
 708         :return: Dictionary of bridge domain(s) data.
 709         """
 710         return self.api(self.papi.bridge_domain_dump,
 711                         {'bd_id': bd_id})
 712
 713     def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
 714                                      enable):
 715         """Create or delete unidirectional cross-connect from Tx interface to
 716         Rx interface.
 717
 718         :param int rx_sw_if_index: Software interface index of Rx interface.
 719         :param int tx_sw_if_index: Software interface index of Tx interface.
 720         :param int enable: Create cross-connect if equal to 1, delete
 721             cross-connect if equal to 0.
 722
 723         """
 724         return self.api(self.papi.sw_interface_set_l2_xconnect,
 725                         {'rx_sw_if_index': rx_sw_if_index,
 726                          'tx_sw_if_index': tx_sw_if_index,
 727                          'enable': enable})
 728
 729     def sw_interface_set_l2_tag_rewrite(
 730             self,
 731             sw_if_index,
 732             vtr_oper,
 733             push=0,
 734             tag1=0,
 735             tag2=0):
 736         """L2 interface vlan tag rewrite configure request
 737         :param client_index - opaque cookie to identify the sender
 738         :param context - sender context, to match reply w/ request
 739         :param sw_if_index - interface the operation is applied to
 740         :param vtr_op - Choose from l2_vtr_op_t enum values
 741         :param push_dot1q - first pushed flag dot1q id set, else dot1ad
 742         :param tag1 - Needed for any push or translate vtr op
 743         :param tag2 - Needed for any push 2 or translate x-2 vtr ops
 744
 745         """
 746         return self.api(self.papi.l2_interface_vlan_tag_rewrite,
 747                         {'sw_if_index': sw_if_index,
 748                          'vtr_op': vtr_oper,
 749                          'push_dot1q': push,
 750                          'tag1': tag1,
 751                          'tag2': tag2})
 752
 753     def sw_interface_set_l2_emulation(
 754             self,
 755             sw_if_index,
 756             enable=1):
 757         """L2 Emulation
 758         :param sw_if_index - interface the operation is applied to
 759
 760         """
 761         return self.api(self.papi.l2_emulation,
 762                         {'sw_if_index': sw_if_index,
 763                          'enable': enable})
 764
 765     def sw_interface_set_ip_directed_broadcast(
 766             self,
 767             sw_if_index,
 768             enable=1):
 769         """IP Directed broadcast
 770         :param sw_if_index - interface the operation is applied to
 771
 772         """
 773         return self.api(self.papi.sw_interface_set_ip_directed_broadcast,
 774                         {'sw_if_index': sw_if_index,
 775                          'enable': enable})
 776
 777     def sw_interface_set_flags(self, sw_if_index, admin_up_down):
 778         """
 779
 780         :param admin_up_down:
 781         :param sw_if_index:
 782
 783         """
 784         return self.api(self.papi.sw_interface_set_flags,
 785                         {'sw_if_index': sw_if_index,
 786                          'admin_up_down': admin_up_down})
 787
 788     def sw_interface_set_mtu(self, sw_if_index, mtu=[0, 0, 0, 0]):
 789         """
 790         :param sw_if_index:
 791         :param mtu:
 792
 793         """
 794         return self.api(self.papi.sw_interface_set_mtu,
 795                         {'sw_if_index': sw_if_index,
 796                          'mtu': mtu})
 797
 798     def sw_interface_set_promiscuous(self, sw_if_index, enable):
 799         """
 800         :param sw_if_index:
 801         :param enable:
 802
 803         """
 804         return self.api(self.papi.sw_interface_set_promiscuous,
 805                         {'sw_if_index': sw_if_index,
 806                          'enable': enable})
 807
 808     def sw_interface_set_mac_address(self, sw_if_index, mac):
 809         return self.api(self.papi.sw_interface_set_mac_address,
 810                         {'sw_if_index': sw_if_index,
 811                          'mac_address': mac})
 812
 813     def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
 814                      no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
 815                      default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
 816         """Create subinterface
 817         from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
 818
 819         :param sub_id: param inner_vlan:
 820         :param sw_if_index:
 821         :param outer_vlan:
 822         :param inner_vlan:
 823         :param no_tags:  (Default value = 0)
 824         :param one_tag:  (Default value = 0)
 825         :param two_tags:  (Default value = 0)
 826         :param dot1ad:  (Default value = 0)
 827         :param exact_match:  (Default value = 0)
 828         :param default_sub:  (Default value = 0)
 829         :param outer_vlan_id_any:  (Default value = 0)
 830         :param inner_vlan_id_any:  (Default value = 0)
 831
 832         """
 833         return self.api(
 834             self.papi.create_subif,
 835             {'sw_if_index': sw_if_index,
 836              'sub_id': sub_id,
 837              'no_tags': no_tags,
 838              'one_tag': one_tag,
 839              'two_tags': two_tags,
 840              'dot1ad': dot1ad,
 841              'exact_match': exact_match,
 842              'default_sub': default_sub,
 843              'outer_vlan_id_any': outer_vlan_id_any,
 844              'inner_vlan_id_any': inner_vlan_id_any,
 845              'outer_vlan_id': outer_vlan,
 846              'inner_vlan_id': inner_vlan})
 847
 848     def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
 849         """Create p2p ethernet subinterface
 850
 851         :param sw_if_index: main (parent) interface
 852         :param remote_mac: client (remote) mac address
 853
 854         """
 855         return self.api(
 856             self.papi.p2p_ethernet_add,
 857             {'parent_if_index': sw_if_index,
 858              'remote_mac': remote_mac,
 859              'subif_id': subif_id})
 860
 861     def delete_subif(self, sw_if_index):
 862         """Delete subinterface
 863
 864         :param sw_if_index:
 865         """
 866         return self.api(self.papi.delete_subif,
 867                         {'sw_if_index': sw_if_index})
 868
 869     def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
 870         """Delete p2p ethernet subinterface
 871
 872         :param sw_if_index: main (parent) interface
 873         :param remote_mac: client (remote) mac address
 874
 875         """
 876         return self.api(
 877             self.papi.p2p_ethernet_del,
 878             {'parent_if_index': sw_if_index,
 879              'remote_mac': remote_mac})
 880
 881     def create_vlan_subif(self, sw_if_index, vlan):
 882         """
 883
 884         :param vlan:
 885         :param sw_if_index:
 886
 887         """
 888         return self.api(self.papi.create_vlan_subif,
 889                         {'sw_if_index': sw_if_index,
 890                          'vlan_id': vlan})
 891
 892     def create_loopback(self, mac=''):
 893         """
 894
 895         :param mac: (Optional)
 896         """
 897         return self.api(self.papi.create_loopback,
 898                         {'mac_address': mac})
 899
 900     def delete_loopback(self, sw_if_index):
 901         return self.api(self.papi.delete_loopback,
 902                         {'sw_if_index': sw_if_index, })
 903
 904     def ip_table_add_del(self,
 905                          table_id,
 906                          is_add=1,
 907                          is_ipv6=0):
 908         """
 909
 910         :param table_id
 911         :param is_add:  (Default value = 1)
 912         :param is_ipv6:  (Default value = 0)
 913
 914         """
 915
 916         return self.api(
 917             self.papi.ip_table_add_del,
 918             {'table_id': table_id,
 919              'is_add': is_add,
 920              'is_ipv6': is_ipv6})
 921
 922     def ip_add_del_route(
 923             self,
 924             dst_address,
 925             dst_address_length,
 926             next_hop_address,
 927             next_hop_sw_if_index=0xFFFFFFFF,
 928             table_id=0,
 929             next_hop_table_id=0,
 930             next_hop_weight=1,
 931             next_hop_n_out_labels=0,
 932             next_hop_out_label_stack=[],
 933             next_hop_via_label=MPLS_LABEL_INVALID,
 934             next_hop_id=0xFFFFFFFF,
 935             is_resolve_host=0,
 936             is_resolve_attached=0,
 937             classify_table_index=0xFFFFFFFF,
 938             is_add=1,
 939             is_drop=0,
 940             is_unreach=0,
 941             is_prohibit=0,
 942             is_ipv6=0,
 943             is_local=0,
 944             is_classify=0,
 945             is_multipath=0,
 946             is_dvr=0,
 947             is_udp_encap=0,
 948             is_source_lookup=0):
 949         """
 950
 951         :param dst_address_length:
 952         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 953         :param dst_address:
 954         :param next_hop_address:
 955         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 956         :param vrf_id:  (Default value = 0)
 957         :param lookup_in_vrf:  (Default value = 0)
 958         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 959         :param is_add:  (Default value = 1)
 960         :param is_drop:  (Default value = 0)
 961         :param is_ipv6:  (Default value = 0)
 962         :param is_local:  (Default value = 0)
 963         :param is_classify:  (Default value = 0)
 964         :param is_multipath:  (Default value = 0)
 965         :param is_resolve_host:  (Default value = 0)
 966         :param is_resolve_attached:  (Default value = 0)
 967         :param is_dvr:  (Default value = 0)
 968         :param is_source_lookup:  (Default value = 0)
 969         :param next_hop_weight:  (Default value = 1)
 970
 971         """
 972
 973         return self.api(
 974             self.papi.ip_add_del_route,
 975             {'next_hop_sw_if_index': next_hop_sw_if_index,
 976              'table_id': table_id,
 977              'classify_table_index': classify_table_index,
 978              'next_hop_table_id': next_hop_table_id,
 979              'is_add': is_add,
 980              'is_drop': is_drop,
 981              'is_unreach': is_unreach,
 982              'is_prohibit': is_prohibit,
 983              'is_ipv6': is_ipv6,
 984              'is_local': is_local,
 985              'is_classify': is_classify,
 986              'is_multipath': is_multipath,
 987              'is_resolve_host': is_resolve_host,
 988              'is_resolve_attached': is_resolve_attached,
 989              'is_dvr': is_dvr,
 990              'is_source_lookup': is_source_lookup,
 991              'is_udp_encap': is_udp_encap,
 992              'next_hop_weight': next_hop_weight,
 993              'dst_address_length': dst_address_length,
 994              'dst_address': dst_address,
 995              'next_hop_id': next_hop_id,
 996              'next_hop_address': next_hop_address,
 997              'next_hop_n_out_labels': next_hop_n_out_labels,
 998              'next_hop_via_label': next_hop_via_label,
 999              'next_hop_out_label_stack': next_hop_out_label_stack})
1000
1001     def ip_fib_dump(self):
1002         return self.api(self.papi.ip_fib_dump, {})
1003
1004     def ip6_fib_dump(self):
1005         return self.api(self.papi.ip6_fib_dump, {})
1006
1007     def ip_neighbor_add_del(self,
1008                             sw_if_index,
1009                             mac_address,
1010                             ip_address,
1011                             is_add=1,
1012                             flags=0):
1013         """ Add neighbor MAC to IPv4 or IPv6 address.
1014
1015         :param sw_if_index:
1016         :param mac_address:
1017         :param dst_address:
1018         :param is_add:  (Default value = 1)
1019         :param flags:  (Default value = 0/NONE)
1020         """
1021         return self.api(
1022             self.papi.ip_neighbor_add_del,
1023             {
1024                 'is_add': is_add,
1025                 'neighbor': {
1026                     'sw_if_index': sw_if_index,
1027                     'flags': flags,
1028                     'mac_address': mac_address,
1029                     'ip_address': ip_address
1030                 }
1031             }
1032         )
1033
1034     def ip_neighbor_dump(self,
1035                          sw_if_index,
1036                          is_ipv6=0):
1037         """ Return IP neighbor dump.
1038
1039         :param sw_if_index:
1040         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1041         """
1042
1043         return self.api(
1044             self.papi.ip_neighbor_dump,
1045             {'is_ipv6': is_ipv6,
1046              'sw_if_index': sw_if_index
1047              }
1048         )
1049
1050     def proxy_arp_add_del(self,
1051                           low,
1052                           hi,
1053                           table_id=0,
1054                           is_add=1):
1055         """ Config Proxy Arp Range.
1056
1057         :param low_address: Start address in the rnage to Proxy for
1058         :param hi_address: End address in the rnage to Proxy for
1059         :param vrf_id: The VRF/table in which to proxy
1060         """
1061
1062         return self.api(
1063             self.papi.proxy_arp_add_del,
1064             {'proxy':
1065              {
1066                  'table_id': table_id,
1067                  'low': low,
1068                  'hi': hi,
1069              },
1070              'is_add': is_add})
1071
1072     def proxy_arp_intfc_enable_disable(self,
1073                                        sw_if_index,
1074                                        is_enable=1):
1075         """ Enable/Disable an interface for proxy ARP requests
1076
1077         :param sw_if_index: Interface
1078         :param enable_disable: Enable/Disable
1079         """
1080
1081         return self.api(
1082             self.papi.proxy_arp_intfc_enable_disable,
1083             {'sw_if_index': sw_if_index,
1084              'enable_disable': is_enable
1085              }
1086         )
1087
1088     def reset_vrf(self,
1089                   vrf_id,
1090                   is_ipv6=0,
1091                   ):
1092         """ Reset VRF (remove all routes etc.) request.
1093
1094         :param int vrf_id: ID of the FIB table / VRF to reset.
1095         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1096         """
1097
1098         return self.api(
1099             self.papi.reset_vrf,
1100             {'vrf_id': vrf_id,
1101              'is_ipv6': is_ipv6,
1102              }
1103         )
1104
1105     def reset_fib(self,
1106                   vrf_id,
1107                   is_ipv6=0,
1108                   ):
1109         """ Reset VRF (remove all routes etc.) request.
1110
1111         :param int vrf_id: ID of the FIB table / VRF to reset.
1112         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1113         """
1114
1115         return self.api(
1116             self.papi.reset_fib,
1117             {'vrf_id': vrf_id,
1118              'is_ipv6': is_ipv6,
1119              }
1120         )
1121
1122     def ip_dump(self,
1123                 is_ipv6=0,
1124                 ):
1125         """ Return IP dump.
1126
1127         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
1128         """
1129
1130         return self.api(
1131             self.papi.ip_dump,
1132             {'is_ipv6': is_ipv6,
1133              }
1134         )
1135
1136     def sw_interface_span_enable_disable(
1137             self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
1138         """
1139
1140         :param sw_if_index_from:
1141         :param sw_if_index_to:
1142         :param state:
1143         :param is_l2:
1144         """
1145         return self.api(self.papi.sw_interface_span_enable_disable,
1146                         {'sw_if_index_from': sw_if_index_from,
1147                          'sw_if_index_to': sw_if_index_to,
1148                          'state': state,
1149                          'is_l2': is_l2,
1150                          })
1151
1152     def gre_tunnel_add_del(self,
1153                            src_address,
1154                            dst_address,
1155                            outer_fib_id=0,
1156                            tunnel_type=0,
1157                            instance=0xFFFFFFFF,
1158                            session_id=0,
1159                            is_add=1,
1160                            is_ip6=0):
1161         """ Add a GRE tunnel
1162
1163         :param src_address:
1164         :param dst_address:
1165         :param outer_fib_id:  (Default value = 0)
1166         :param tunnel_type:  (Default value = 0)
1167         :param instance:  (Default value = 0xFFFFFFFF)
1168         :param session_id: (Defalt value = 0)
1169         :param is_add:  (Default value = 1)
1170         :param is_ipv6:  (Default value = 0)
1171         """
1172
1173         return self.api(
1174             self.papi.gre_add_del_tunnel,
1175             {'is_add': is_add,
1176              'is_ipv6': is_ip6,
1177              'tunnel_type': tunnel_type,
1178              'instance': instance,
1179              'src_address': src_address,
1180              'dst_address': dst_address,
1181              'outer_fib_id': outer_fib_id,
1182              'session_id': session_id}
1183         )
1184
1185     def udp_encap_add(self,
1186                       src_ip,
1187                       dst_ip,
1188                       src_port,
1189                       dst_port,
1190                       table_id=0):
1191         """ Add a GRE tunnel
1192         :param src_ip:
1193         :param dst_ip:
1194         :param src_port:
1195         :param dst_port:
1196         :param outer_fib_id:  (Default value = 0)
1197         """
1198
1199         return self.api(
1200             self.papi.udp_encap_add,
1201             {
1202                 'udp_encap': {
1203                     'src_ip': src_ip,
1204                     'dst_ip': dst_ip,
1205                     'src_port': src_port,
1206                     'dst_port': dst_port,
1207                     'table_id': table_id
1208                 }
1209             })
1210
1211     def udp_encap_del(self, id):
1212         return self.api(self.papi.udp_encap_del, {'id': id})
1213
1214     def udp_encap_dump(self):
1215         return self.api(self.papi.udp_encap_dump, {})
1216
1217     def want_udp_encap_stats(self, enable=1):
1218         return self.api(self.papi.want_udp_encap_stats,
1219                         {'enable': enable,
1220                          'pid': os.getpid()})
1221
1222     def mpls_fib_dump(self):
1223         return self.api(self.papi.mpls_fib_dump, {})
1224
1225     def mpls_table_add_del(
1226             self,
1227             table_id,
1228             is_add=1):
1229         """
1230
1231         :param table_id
1232         :param is_add:  (Default value = 1)
1233
1234         """
1235
1236         return self.api(
1237             self.papi.mpls_table_add_del,
1238             {'mt_table_id': table_id,
1239              'mt_is_add': is_add})
1240
1241     def mpls_route_add_del(
1242             self,
1243             label,
1244             eos,
1245             next_hop_proto,
1246             next_hop_address,
1247             next_hop_sw_if_index=0xFFFFFFFF,
1248             table_id=0,
1249             next_hop_table_id=0,
1250             next_hop_weight=1,
1251             next_hop_n_out_labels=0,
1252             next_hop_out_label_stack=[],
1253             next_hop_via_label=MPLS_LABEL_INVALID,
1254             is_resolve_host=0,
1255             is_resolve_attached=0,
1256             is_interface_rx=0,
1257             is_rpf_id=0,
1258             is_multicast=0,
1259             is_add=1,
1260             is_drop=0,
1261             is_multipath=0,
1262             classify_table_index=0xFFFFFFFF,
1263             is_classify=0):
1264         """
1265
1266         :param dst_address_length:
1267         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1268         :param dst_address:
1269         :param next_hop_address:
1270         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1271         :param vrf_id:  (Default value = 0)
1272         :param lookup_in_vrf:  (Default value = 0)
1273         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1274         :param is_add:  (Default value = 1)
1275         :param is_drop:  (Default value = 0)
1276         :param is_ipv6:  (Default value = 0)
1277         :param is_local:  (Default value = 0)
1278         :param is_classify:  (Default value = 0)
1279         :param is_multipath:  (Default value = 0)
1280         :param is_multicast:  (Default value = 0)
1281         :param is_resolve_host:  (Default value = 0)
1282         :param is_resolve_attached:  (Default value = 0)
1283         :param next_hop_weight:  (Default value = 1)
1284
1285         """
1286         return self.api(
1287             self.papi.mpls_route_add_del,
1288             {'mr_label': label,
1289              'mr_eos': eos,
1290              'mr_table_id': table_id,
1291              'mr_classify_table_index': classify_table_index,
1292              'mr_is_add': is_add,
1293              'mr_is_classify': is_classify,
1294              'mr_is_multipath': is_multipath,
1295              'mr_is_multicast': is_multicast,
1296              'mr_is_resolve_host': is_resolve_host,
1297              'mr_is_resolve_attached': is_resolve_attached,
1298              'mr_is_interface_rx': is_interface_rx,
1299              'mr_is_rpf_id': is_rpf_id,
1300              'mr_next_hop_proto': next_hop_proto,
1301              'mr_next_hop_weight': next_hop_weight,
1302              'mr_next_hop': next_hop_address,
1303              'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1304              'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1305              'mr_next_hop_table_id': next_hop_table_id,
1306              'mr_next_hop_via_label': next_hop_via_label,
1307              'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1308
1309     def mpls_ip_bind_unbind(
1310             self,
1311             label,
1312             dst_address,
1313             dst_address_length,
1314             table_id=0,
1315             ip_table_id=0,
1316             is_ip4=1,
1317             is_bind=1):
1318         """
1319         """
1320         return self.api(
1321             self.papi.mpls_ip_bind_unbind,
1322             {'mb_mpls_table_id': table_id,
1323              'mb_label': label,
1324              'mb_ip_table_id': ip_table_id,
1325              'mb_is_bind': is_bind,
1326              'mb_is_ip4': is_ip4,
1327              'mb_address_length': dst_address_length,
1328              'mb_address': dst_address})
1329
1330     def mpls_tunnel_add_del(
1331             self,
1332             tun_sw_if_index,
1333             next_hop_proto_is_ip4,
1334             next_hop_address,
1335             next_hop_sw_if_index=0xFFFFFFFF,
1336             next_hop_table_id=0,
1337             next_hop_weight=1,
1338             next_hop_n_out_labels=0,
1339             next_hop_out_label_stack=[],
1340             next_hop_via_label=MPLS_LABEL_INVALID,
1341             is_add=1,
1342             l2_only=0,
1343             is_multicast=0):
1344         """
1345
1346         :param dst_address_length:
1347         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1348         :param dst_address:
1349         :param next_hop_address:
1350         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
1351         :param vrf_id:  (Default value = 0)
1352         :param lookup_in_vrf:  (Default value = 0)
1353         :param classify_table_index:  (Default value = 0xFFFFFFFF)
1354         :param is_add:  (Default value = 1)
1355         :param is_drop:  (Default value = 0)
1356         :param is_ipv6:  (Default value = 0)
1357         :param is_local:  (Default value = 0)
1358         :param is_classify:  (Default value = 0)
1359         :param is_multipath:  (Default value = 0)
1360         :param is_resolve_host:  (Default value = 0)
1361         :param is_resolve_attached:  (Default value = 0)
1362         :param next_hop_weight:  (Default value = 1)
1363         :param is_multicast:  (Default value = 0)
1364
1365         """
1366         return self.api(
1367             self.papi.mpls_tunnel_add_del,
1368             {'mt_sw_if_index': tun_sw_if_index,
1369              'mt_is_add': is_add,
1370              'mt_l2_only': l2_only,
1371              'mt_is_multicast': is_multicast,
1372              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1373              'mt_next_hop_weight': next_hop_weight,
1374              'mt_next_hop': next_hop_address,
1375              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1376              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1377              'mt_next_hop_table_id': next_hop_table_id,
1378              'mt_next_hop_via_label': next_hop_via_label,
1379              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1380
1381     def mpls_tunnel_dump(self, sw_if_index=0xffffffff):
1382         return self.api(self.papi.mpls_tunnel_dump,
1383                         {'sw_if_index': sw_if_index})
1384
1385     def nat44_interface_add_del_feature(
1386             self,
1387             sw_if_index,
1388             is_inside=1,
1389             is_add=1):
1390         """Enable/disable NAT44 feature on the interface
1391
1392         :param sw_if_index: Software index of the interface
1393         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1394         :param is_add: 1 if add, 0 if delete (Default value = 1)
1395         """
1396         return self.api(
1397             self.papi.nat44_interface_add_del_feature,
1398             {'is_add': is_add,
1399              'is_inside': is_inside,
1400              'sw_if_index': sw_if_index})
1401
1402     def nat44_interface_add_del_output_feature(
1403             self,
1404             sw_if_index,
1405             is_inside=1,
1406             is_add=1):
1407         """Enable/disable NAT44 output feature on the interface
1408
1409         :param sw_if_index: Software index of the interface
1410         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1411         :param is_add: 1 if add, 0 if delete (Default value = 1)
1412         """
1413         return self.api(
1414             self.papi.nat44_interface_add_del_output_feature,
1415             {'is_add': is_add,
1416              'is_inside': is_inside,
1417              'sw_if_index': sw_if_index})
1418
1419     def nat44_add_del_static_mapping(
1420             self,
1421             local_ip,
1422             external_ip=0,
1423             external_sw_if_index=0xFFFFFFFF,
1424             local_port=0,
1425             external_port=0,
1426             addr_only=1,
1427             vrf_id=0,
1428             protocol=0,
1429             twice_nat=0,
1430             self_twice_nat=0,
1431             out2in_only=0,
1432             tag="",
1433             is_add=1):
1434         """Add/delete NAT44 static mapping
1435
1436         :param local_ip: Local IP address
1437         :param external_ip: External IP address
1438         :param external_sw_if_index: External interface instead of IP address
1439         :param local_port: Local port number (Default value = 0)
1440         :param external_port: External port number (Default value = 0)
1441         :param addr_only: 1 if address only mapping, 0 if address and port
1442         :param vrf_id: VRF ID
1443         :param protocol: IP protocol (Default value = 0)
1444         :param twice_nat: 1 if translate external host address and port
1445         :param self_twice_nat: 1 if translate external host address and port
1446                                whenever external host address equals
1447                                local address of internal host
1448         :param out2in_only: if 1 rule is matching only out2in direction
1449         :param tag: Opaque string tag
1450         :param is_add: 1 if add, 0 if delete (Default value = 1)
1451         """
1452         return self.api(
1453             self.papi.nat44_add_del_static_mapping,
1454             {'is_add': is_add,
1455              'addr_only': addr_only,
1456              'local_ip_address': local_ip,
1457              'external_ip_address': external_ip,
1458              'local_port': local_port,
1459              'external_port': external_port,
1460              'external_sw_if_index': external_sw_if_index,
1461              'vrf_id': vrf_id,
1462              'protocol': protocol,
1463              'twice_nat': twice_nat,
1464              'self_twice_nat': self_twice_nat,
1465              'out2in_only': out2in_only,
1466              'tag': tag})
1467
1468     def nat44_add_del_identity_mapping(
1469             self,
1470             ip='0',
1471             sw_if_index=0xFFFFFFFF,
1472             port=0,
1473             addr_only=1,
1474             vrf_id=0,
1475             protocol=0,
1476             tag='',
1477             is_add=1):
1478         """Add/delete NAT44 identity mapping
1479
1480         :param ip: IP address (Default value = 0)
1481         :param sw_if_index: Interface instead of IP address
1482         :param port: Port number (Default value = 0)
1483         :param addr_only: 1 if address only mapping, 0 if address and port
1484         :param vrf_id: VRF ID
1485         :param protocol: IP protocol (Default value = 0)
1486         :param tag: Opaque string tag
1487         :param is_add: 1 if add, 0 if delete (Default value = 1)
1488         """
1489         return self.api(
1490             self.papi.nat44_add_del_identity_mapping,
1491             {'is_add': is_add,
1492              'addr_only': addr_only,
1493              'ip_address': ip,
1494              'port': port,
1495              'sw_if_index': sw_if_index,
1496              'vrf_id': vrf_id,
1497              'tag': tag,
1498              'protocol': protocol})
1499
1500     def nat44_add_del_address_range(
1501             self,
1502             first_ip_address,
1503             last_ip_address,
1504             is_add=1,
1505             vrf_id=0xFFFFFFFF,
1506             twice_nat=0):
1507         """Add/del NAT44 address range
1508
1509         :param first_ip_address: First IP address
1510         :param last_ip_address: Last IP address
1511         :param vrf_id: VRF id for the address range
1512         :param twice_nat: twice NAT address for extenal hosts
1513         :param is_add: 1 if add, 0 if delete (Default value = 1)
1514         """
1515         return self.api(
1516             self.papi.nat44_add_del_address_range,
1517             {'first_ip_address': first_ip_address,
1518              'last_ip_address': last_ip_address,
1519              'vrf_id': vrf_id,
1520              'twice_nat': twice_nat,
1521              'is_add': is_add})
1522
1523     def nat44_address_dump(self):
1524         """Dump NAT44 addresses
1525         :return: Dictionary of NAT44 addresses
1526         """
1527         return self.api(self.papi.nat44_address_dump, {})
1528
1529     def nat44_interface_dump(self):
1530         """Dump interfaces with NAT44 feature
1531         :return: Dictionary of interfaces with NAT44 feature
1532         """
1533         return self.api(self.papi.nat44_interface_dump, {})
1534
1535     def nat44_interface_output_feature_dump(self):
1536         """Dump interfaces with NAT44 output feature
1537         :return: Dictionary of interfaces with NAT44 output feature
1538         """
1539         return self.api(self.papi.nat44_interface_output_feature_dump, {})
1540
1541     def nat44_static_mapping_dump(self):
1542         """Dump NAT44 static mappings
1543         :return: Dictionary of NAT44 static mappings
1544         """
1545         return self.api(self.papi.nat44_static_mapping_dump, {})
1546
1547     def nat44_identity_mapping_dump(self):
1548         """Dump NAT44 identity mappings
1549         :return: Dictionary of NAT44 identity mappings
1550         """
1551         return self.api(self.papi.nat44_identity_mapping_dump, {})
1552
1553     def nat_show_config(self):
1554         """Show NAT plugin config
1555         :return: NAT plugin config parameters
1556         """
1557         return self.api(self.papi.nat_show_config, {})
1558
1559     def nat44_add_interface_addr(
1560             self,
1561             sw_if_index,
1562             twice_nat=0,
1563             is_add=1):
1564         """Add/del NAT44 address from interface
1565
1566         :param sw_if_index: Software index of the interface
1567         :param twice_nat: twice NAT address for extenal hosts
1568         :param is_add: 1 if add, 0 if delete (Default value = 1)
1569         """
1570         return self.api(
1571             self.papi.nat44_add_del_interface_addr,
1572             {'is_add': is_add,
1573              'sw_if_index': sw_if_index,
1574              'twice_nat': twice_nat})
1575
1576     def nat44_interface_addr_dump(self):
1577         """Dump NAT44 addresses interfaces
1578         :return: Dictionary of NAT44 addresses interfaces
1579         """
1580         return self.api(self.papi.nat44_interface_addr_dump, {})
1581
1582     def nat_ipfix(
1583             self,
1584             domain_id=1,
1585             src_port=4739,
1586             enable=1):
1587         """Enable/disable NAT IPFIX logging
1588
1589         :param domain_id: Observation domain ID (Default value = 1)
1590         :param src_port: Source port number (Default value = 4739)
1591         :param enable: 1 if enable, 0 if disable (Default value = 1)
1592         """
1593         return self.api(
1594             self.papi.nat_ipfix_enable_disable,
1595             {'domain_id': domain_id,
1596              'src_port': src_port,
1597              'enable': enable})
1598
1599     def nat44_user_session_dump(
1600             self,
1601             ip_address,
1602             vrf_id):
1603         """Dump NAT44 user's sessions
1604
1605         :param ip_address: ip adress of the user to be dumped
1606         :param cpu_index: cpu_index on which the user is
1607         :param vrf_id: VRF ID
1608         :return: Dictionary of S-NAT sessions
1609         """
1610         return self.api(
1611             self.papi.nat44_user_session_dump,
1612             {'ip_address': ip_address,
1613              'vrf_id': vrf_id})
1614
1615     def nat44_user_dump(self):
1616         """Dump NAT44 users
1617
1618         :return: Dictionary of NAT44 users
1619         """
1620         return self.api(self.papi.nat44_user_dump, {})
1621
1622     def nat44_add_del_lb_static_mapping(
1623             self,
1624             external_addr,
1625             external_port,
1626             protocol,
1627             twice_nat=0,
1628             self_twice_nat=0,
1629             out2in_only=0,
1630             tag='',
1631             affinity=0,
1632             local_num=0,
1633             locals=[],
1634             is_add=1):
1635         """Add/delete NAT44 load balancing static mapping
1636
1637         :param twice_nat: 1 if translate external host address and port
1638         :param tag: Opaque string tag
1639         :param affinity: if 0 disabled, otherwise client IP affinity timeout
1640         :param is_add - 1 if add, 0 if delete
1641         """
1642         return self.api(
1643             self.papi.nat44_add_del_lb_static_mapping,
1644             {'is_add': is_add,
1645              'external_addr': external_addr,
1646              'external_port': external_port,
1647              'protocol': protocol,
1648              'twice_nat': twice_nat,
1649              'self_twice_nat': self_twice_nat,
1650              'out2in_only': out2in_only,
1651              'tag': tag,
1652              'affinity': affinity,
1653              'local_num': local_num,
1654              'locals': locals})
1655
1656     def nat44_lb_static_mapping_add_del_local(
1657            self,
1658            external_addr,
1659            external_port,
1660            local_addr,
1661            local_port,
1662            protocol,
1663            probability,
1664            vrf_id=0,
1665            is_add=1):
1666         """Add/delete NAT44 load-balancing static mapping rule backend
1667
1668         :param external_addr: external IPv4 address of the servic
1669         :param external_port: external L4 port number of the service
1670         :param local_addr: IPv4 address of the internal node
1671         :param local_port: L4 port number of the internal node
1672         :param protocol: IP protocol number
1673         :param probability: probability of the internal node
1674         :param vrf_id: VRF id of the internal node
1675         :param is_add: 1 if add, 0 if delete
1676         """
1677         return self.api(
1678             self.papi.nat44_lb_static_mapping_add_del_local,
1679             {'is_add': is_add,
1680              'external_addr': external_addr,
1681              'external_port': external_port,
1682              'local': {
1683                  'addr': local_addr,
1684                  'port': local_port,
1685                  'probability': probability,
1686                  'vrf_id': vrf_id},
1687              'protocol': protocol})
1688
1689     def nat44_lb_static_mapping_dump(self):
1690         """Dump NAT44 load balancing static mappings
1691
1692         :return: Dictionary of NAT44 load balancing static mapping
1693         """
1694         return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1695
1696     def nat44_del_session(
1697             self,
1698             addr,
1699             port,
1700             protocol,
1701             vrf_id=0,
1702             is_in=1,
1703             ext_host_address=None,
1704             ext_host_port=0):
1705         """Delete NAT44 session
1706
1707         :param addr: IPv4 address
1708         :param por: port number
1709         :param protocol: IP protocol number
1710         :param vrf_id: VRF ID
1711         :param is_in: 1 if inside network addres and port pari, 0 if outside
1712         :param ext_host_address: external host IPv4 address
1713         :param ext_host_port: external host port
1714         """
1715         if ext_host_address is None:
1716             return self.api(
1717                 self.papi.nat44_del_session,
1718                 {'address': addr,
1719                  'port': port,
1720                  'protocol': protocol,
1721                  'vrf_id': vrf_id,
1722                  'is_in': is_in})
1723         else:
1724             return self.api(
1725                 self.papi.nat44_del_session,
1726                 {'address': addr,
1727                  'port': port,
1728                  'protocol': protocol,
1729                  'vrf_id': vrf_id,
1730                  'is_in': is_in,
1731                  'ext_host_valid': 1,
1732                  'ext_host_address': ext_host_address,
1733                  'ext_host_port': ext_host_port})
1734
1735     def nat44_forwarding_enable_disable(
1736             self,
1737             enable):
1738         """Enable/disable forwarding for NAT44
1739
1740         :param enable: 1 for enable, 0 for disable
1741         """
1742         return self.api(
1743             self.papi.nat44_forwarding_enable_disable,
1744             {'enable': enable})
1745
1746     def nat_set_reass(
1747             self,
1748             timeout=2,
1749             max_reass=1024,
1750             max_frag=5,
1751             drop_frag=0,
1752             is_ip6=0):
1753         """Set NAT virtual fragmentation reassembly
1754
1755         :param timeout: reassembly timeout (Default 2sec)
1756         :param max_reass: maximum concurrent reassemblies (Default 1024)
1757         :param max_frag: maximum fragmets per reassembly (Default 5)
1758         :param drop_frag: if 0 translate fragments, otherwise drop fragments
1759         :param is_ip6: 1 if IPv6, 0 if IPv4
1760         """
1761         return self.api(
1762             self.papi.nat_set_reass,
1763             {'timeout': timeout,
1764              'max_reass': max_reass,
1765              'max_frag': max_frag,
1766              'drop_frag': drop_frag,
1767              'is_ip6': is_ip6})
1768
1769     def nat_get_reass(self):
1770         """Get NAT virtual fragmentation reassembly configuration
1771
1772         :return: NAT virtual fragmentation reassembly configuration
1773         """
1774         return self.api(self.papi.nat_get_reass, {})
1775
1776     def nat_reass_dump(self):
1777         """Dump NAT virtual fragmentation reassemblies
1778
1779         :return: Dictionary of NAT virtual fragmentation reassemblies
1780         """
1781         return self.api(self.papi.nat_reass_dump, {})
1782
1783     def nat_det_add_del_map(
1784             self,
1785             in_addr,
1786             in_plen,
1787             out_addr,
1788             out_plen,
1789             is_add=1):
1790         """Add/delete deterministic NAT mapping
1791
1792         :param is_add - 1 if add, 0 if delete
1793         :param in_addr - inside IP address
1794         :param in_plen - inside IP address prefix length
1795         :param out_addr - outside IP address
1796         :param out_plen - outside IP address prefix length
1797         """
1798         return self.api(
1799             self.papi.nat_det_add_del_map,
1800             {'is_add': is_add,
1801              'is_nat44': 1,
1802              'in_addr': in_addr,
1803              'in_plen': in_plen,
1804              'out_addr': out_addr,
1805              'out_plen': out_plen})
1806
1807     def nat_det_forward(
1808             self,
1809             in_addr):
1810         """Get outside address and port range from inside address
1811
1812         :param in_addr - inside IP address
1813         """
1814         return self.api(
1815             self.papi.nat_det_forward,
1816             {'in_addr': in_addr,
1817              'is_nat44': 1})
1818
1819     def nat_det_reverse(
1820             self,
1821             out_addr,
1822             out_port):
1823         """Get inside address from outside address and port
1824
1825         :param out_addr - outside IP address
1826         :param out_port - outside port
1827         """
1828         return self.api(
1829             self.papi.nat_det_reverse,
1830             {'out_addr': out_addr,
1831              'out_port': out_port})
1832
1833     def nat_det_map_dump(self):
1834         """Dump deterministic NAT mappings
1835
1836         :return: Dictionary of deterministic NAT mappings
1837         """
1838         return self.api(self.papi.nat_det_map_dump, {})
1839
1840     def nat_set_timeouts(
1841             self,
1842             udp=300,
1843             tcp_established=7440,
1844             tcp_transitory=240,
1845             icmp=60):
1846         """Set values of timeouts for NAT sessions (in seconds)
1847
1848         :param udp - UDP timeout (Default value = 300)
1849         :param tcp_established - TCP established timeout (Default value = 7440)
1850         :param tcp_transitory - TCP transitory timeout (Default value = 240)
1851         :param icmp - ICMP timeout (Default value = 60)
1852         """
1853         return self.api(
1854             self.papi.nat_set_timeouts,
1855             {'udp': udp,
1856              'tcp_established': tcp_established,
1857              'tcp_transitory': tcp_transitory,
1858              'icmp': icmp})
1859
1860     def nat_get_timeouts(self):
1861         """Get values of timeouts for NAT sessions
1862
1863         :return: Timeouts for NAT sessions (in seconds)
1864         """
1865         return self.api(self.papi.nat_get_timeouts, {})
1866
1867     def nat_set_addr_and_port_alloc_alg(
1868             self,
1869             alg=0,
1870             psid_offset=0,
1871             psid_length=0,
1872             psid=0,
1873             start_port=0,
1874             end_port=0):
1875         """Set address and port assignment algorithm
1876
1877         :param alg: algorithm: 0 - default, 1 - MAP-E, 2 - port range
1878         :param psid_offset: number of offset bits (valid only for MAP-E alg)
1879         :param psid_length: length of PSID (valid only for MAP-E alg)
1880         :param psid: Port Set Identifier value (valid only for MAP-E alg)
1881         :param start_port: beginning of the port range
1882         :param end_port: end of the port range
1883         """
1884         return self.api(
1885             self.papi.nat_set_addr_and_port_alloc_alg,
1886             {'alg': alg,
1887              'psid_offset': psid_offset,
1888              'psid_length': psid_length,
1889              'psid': psid,
1890              'start_port': start_port,
1891              'end_port': end_port})
1892
1893     def nat_get_addr_and_port_alloc_alg(self):
1894         """Get address and port assignment algorithm"""
1895         return self.api(self.papi.nat_get_addr_and_port_alloc_alg, {})
1896
1897     def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1898         """Set TCP MSS rewriting configuration
1899
1900         :param enable: disable(0)/enable(1) MSS rewriting feature
1901         :param mss_value: MSS value to be used for MSS rewriting
1902         """
1903         return self.api(
1904             self.papi.nat_set_mss_clamping,
1905             {'enable': enable, 'mss_value': mss_value})
1906
1907     def nat_get_mss_clamping(self):
1908         """Get TCP MSS rewriting configuration"""
1909         return self.api(self.papi.nat_get_mss_clamping, {})
1910
1911     def nat_det_close_session_out(
1912             self,
1913             out_addr,
1914             out_port,
1915             ext_addr,
1916             ext_port):
1917         """Close deterministic NAT session using outside address and port
1918
1919         :param out_addr - outside IP address
1920         :param out_port - outside port
1921         :param ext_addr - external host IP address
1922         :param ext_port - external host port
1923         """
1924         return self.api(
1925             self.papi.nat_det_close_session_out,
1926             {'out_addr': out_addr,
1927              'out_port': out_port,
1928              'ext_addr': ext_addr,
1929              'ext_port': ext_port})
1930
1931     def nat_det_close_session_in(
1932             self,
1933             in_addr,
1934             in_port,
1935             ext_addr,
1936             ext_port):
1937         """Close deterministic NAT session using inside address and port
1938
1939         :param in_addr - inside IP address
1940         :param in_port - inside port
1941         :param ext_addr - external host IP address
1942         :param ext_port - external host port
1943         """
1944         return self.api(
1945             self.papi.nat_det_close_session_in,
1946             {'in_addr': in_addr,
1947              'in_port': in_port,
1948              'ext_addr': ext_addr,
1949              'ext_port': ext_port,
1950              'is_nat44': 1})
1951
1952     def nat_det_session_dump(
1953             self,
1954             user_addr):
1955         """Dump deterministic NAT sessions belonging to a user
1956
1957         :param user_addr - inside IP address of the user
1958         :return: Dictionary of deterministic NAT sessions
1959         """
1960         return self.api(
1961             self.papi.nat_det_session_dump,
1962             {'is_nat44': 1,
1963              'user_addr': user_addr})
1964
1965     def nat64_add_del_pool_addr_range(
1966             self,
1967             start_addr,
1968             end_addr,
1969             vrf_id=0xFFFFFFFF,
1970             is_add=1):
1971         """Add/del address range to NAT64 pool
1972
1973         :param start_addr: First IP address
1974         :param end_addr: Last IP address
1975         :param vrf_id: VRF id for the address range
1976         :param is_add: 1 if add, 0 if delete (Default value = 1)
1977         """
1978         return self.api(
1979             self.papi.nat64_add_del_pool_addr_range,
1980             {'start_addr': start_addr,
1981              'end_addr': end_addr,
1982              'vrf_id': vrf_id,
1983              'is_add': is_add})
1984
1985     def nat64_pool_addr_dump(self):
1986         """Dump NAT64 pool addresses
1987         :return: Dictionary of NAT64 pool addresses
1988         """
1989         return self.api(self.papi.nat64_pool_addr_dump, {})
1990
1991     def nat64_add_del_interface(
1992             self,
1993             sw_if_index,
1994             is_inside=1,
1995             is_add=1):
1996         """Enable/disable NAT64 feature on the interface
1997            :param sw_if_index: Index of the interface
1998            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1999            :param is_add: 1 if add, 0 if delete (Default value = 1)
2000         """
2001         return self.api(
2002             self.papi.nat64_add_del_interface,
2003             {'sw_if_index': sw_if_index,
2004              'is_inside': is_inside,
2005              'is_add': is_add})
2006
2007     def nat64_interface_dump(self):
2008         """Dump interfaces with NAT64 feature
2009         :return: Dictionary of interfaces with NAT64 feature
2010         """
2011         return self.api(self.papi.nat64_interface_dump, {})
2012
2013     def nat64_add_del_static_bib(
2014             self,
2015             in_ip,
2016             out_ip,
2017             in_port,
2018             out_port,
2019             protocol,
2020             vrf_id=0,
2021             is_add=1):
2022         """Add/delete S-NAT static BIB entry
2023
2024         :param in_ip: Inside IPv6 address
2025         :param out_ip: Outside IPv4 address
2026         :param in_port: Inside port number
2027         :param out_port: Outside port number
2028         :param protocol: IP protocol
2029         :param vrf_id: VRF ID (Default value = 0)
2030         :param is_add: 1 if add, 0 if delete (Default value = 1)
2031         """
2032         return self.api(
2033             self.papi.nat64_add_del_static_bib,
2034             {'i_addr': in_ip,
2035              'o_addr': out_ip,
2036              'i_port': in_port,
2037              'o_port': out_port,
2038              'vrf_id': vrf_id,
2039              'proto': protocol,
2040              'is_add': is_add})
2041
2042     def nat64_bib_dump(self, protocol=255):
2043         """Dump NAT64 BIB
2044
2045         :param protocol: IP protocol (Default value = 255, all BIBs)
2046         :returns: Dictionary of NAT64 BIB entries
2047         """
2048         return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
2049
2050     def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
2051                            tcp_incoming_syn=6):
2052         """Set values of timeouts for NAT64 (in seconds)
2053
2054         :param udpi: UDP timeout (Default value = 300)
2055         :param icmp: ICMP timeout (Default value = 60)
2056         :param tcp_trans: TCP transitory timeout (Default value = 240)
2057         :param tcp_est: TCP established timeout (Default value = 7440)
2058         :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
2059         """
2060         return self.api(
2061             self.papi.nat64_set_timeouts,
2062             {'udp': udp,
2063              'icmp': icmp,
2064              'tcp_trans': tcp_trans,
2065              'tcp_est': tcp_est,
2066              'tcp_incoming_syn': tcp_incoming_syn})
2067
2068     def nat64_get_timeouts(self):
2069         """Get values of timeouts for NAT64
2070
2071         :return: Timeouts for NAT64 (in seconds)
2072         """
2073         return self.api(self.papi.nat64_get_timeouts, {})
2074
2075     def nat64_st_dump(self, protocol=255):
2076         """Dump NAT64 session table
2077
2078         :param protocol: IP protocol (Default value = 255, all STs)
2079         :returns: Dictionary of NAT64 sesstion table entries
2080         """
2081         return self.api(self.papi.nat64_st_dump, {'proto': protocol})
2082
2083     def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
2084         """Add/del NAT64 prefix
2085
2086         :param prefix: NAT64 prefix
2087         :param plen: NAT64 prefix length
2088         :param vrf_id: VRF id of tenant (Default 0)
2089         :param is_add: 1 if add, 0 if delete (Default value = 1)
2090         """
2091         return self.api(
2092             self.papi.nat64_add_del_prefix,
2093             {'prefix': prefix,
2094              'prefix_len': plen,
2095              'vrf_id': vrf_id,
2096              'is_add': is_add})
2097
2098     def nat64_prefix_dump(self):
2099         """Dump NAT64 prefix
2100
2101         :returns: Dictionary of NAT64 prefixes
2102         """
2103         return self.api(self.papi.nat64_prefix_dump, {})
2104
2105     def nat64_add_interface_addr(
2106             self,
2107             sw_if_index,
2108             is_add=1):
2109         """Add/del NAT64 address from interface
2110
2111         :param sw_if_index: Software index of the interface
2112         :param is_add: 1 if add, 0 if delete (Default value = 1)
2113         """
2114         return self.api(self.papi.nat64_add_del_interface_addr,
2115                         {'is_add': is_add, 'sw_if_index': sw_if_index})
2116
2117     def dslite_set_aftr_addr(self, ip6, ip4):
2118         """Set DS-Lite AFTR addresses
2119
2120         :param ip4: IPv4 address
2121         :param ip6: IPv6 address
2122         """
2123         return self.api(
2124             self.papi.dslite_set_aftr_addr,
2125             {'ip4_addr': ip4,
2126              'ip6_addr': ip6})
2127
2128     def dslite_set_b4_addr(self, ip6, ip4):
2129         """Set DS-Lite B4 IPv6 address
2130
2131         :param ip4: IPv4 address
2132         :param ip6: IPv6 address
2133         """
2134         return self.api(
2135             self.papi.dslite_set_b4_addr,
2136             {'ip4_addr': ip4,
2137              'ip6_addr': ip6})
2138
2139     def dslite_add_del_pool_addr_range(
2140             self,
2141             start_addr,
2142             end_addr,
2143             is_add=1):
2144         """Add/del address range to DS-Lite pool
2145
2146         :param start_addr: First IP address
2147         :param end_addr: Last IP address
2148         :param is_add: 1 if add, 0 if delete (Default value = 1)
2149         """
2150         return self.api(
2151             self.papi.dslite_add_del_pool_addr_range,
2152             {'start_addr': start_addr,
2153              'end_addr': end_addr,
2154              'is_add': is_add})
2155
2156     def nat66_add_del_interface(
2157             self,
2158             sw_if_index,
2159             is_inside=1,
2160             is_add=1):
2161         """Enable/disable NAT66 feature on the interface
2162            :param sw_if_index: Index of the interface
2163            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
2164            :param is_add: 1 if add, 0 if delete (Default value = 1)
2165         """
2166         return self.api(
2167             self.papi.nat66_add_del_interface,
2168             {'sw_if_index': sw_if_index,
2169              'is_inside': is_inside,
2170              'is_add': is_add})
2171
2172     def nat66_add_del_static_mapping(
2173             self,
2174             in_ip,
2175             out_ip,
2176             vrf_id=0,
2177             is_add=1):
2178         """Add/delete NAT66 static mapping
2179
2180         :param in_ip: Inside IPv6 address
2181         :param out_ip: Outside IPv6 address
2182         :param vrf_id: VRF ID (Default value = 0)
2183         :param is_add: 1 if add, 0 if delete (Default value = 1)
2184         """
2185         return self.api(
2186             self.papi.nat66_add_del_static_mapping,
2187             {'local_ip_address': in_ip,
2188              'external_ip_address': out_ip,
2189              'vrf_id': vrf_id,
2190              'is_add': is_add})
2191
2192     def nat66_interface_dump(self):
2193         """Dump interfaces with NAT66 feature
2194         :return: Dictionary of interfaces with NAT66 feature
2195         """
2196         return self.api(self.papi.nat66_interface_dump, {})
2197
2198     def nat66_static_mapping_dump(self):
2199         """Dump NAT66 static mappings
2200         :return: Dictionary of NAT66 static mappings
2201         """
2202         return self.api(self.papi.nat66_static_mapping_dump, {})
2203
2204     def nat_ha_set_listener(self, addr, port, path_mtu=512):
2205         """Set HA listener (local settings)
2206
2207         :param addr: local IP4 address
2208         :param port: local UDP port number
2209         :param path_mtu: path MTU (Default value = 512)
2210         """
2211         return self.api(self.papi.nat_ha_set_listener,
2212                         {'ip_address': addr,
2213                          'port': port,
2214                          'path_mtu': path_mtu})
2215
2216     def nat_ha_get_listener(self):
2217         """Get HA listener/local configuration"""
2218         return self.api(self.papi.nat_ha_get_listener, {})
2219
2220     def nat_ha_set_failover(self, addr, port, refresh=10):
2221         """Set HA failover (remote settings)
2222
2223         :param addr: failover IP4 address
2224         :param port: failvoer UDP port number
2225         :param refresh: number of seconds after which to send session refresh
2226         """
2227         return self.api(self.papi.nat_ha_set_failover,
2228                         {'ip_address': addr,
2229                          'port': port,
2230                          'session_refresh_interval': refresh})
2231
2232     def nat_ha_get_failover(self):
2233         """Get HA failover/remote settings reply"""
2234         return self.api(self.papi.nat_ha_get_failover, {})
2235
2236     def nat_ha_flush(self):
2237         """Flush the current HA data"""
2238         return self.api(self.papi.nat_ha_flush, {})
2239
2240     def nat_ha_resync(self, want_resync_event=1):
2241         """Resync HA (resend existing sessions to new failover)
2242         :param want_resync_event: if non-zero resync completed event sent
2243         """
2244         return self.api(self.papi.nat_ha_resync,
2245                         {'want_resync_event': want_resync_event,
2246                          'pid': os.getpid()})
2247
2248     def control_ping(self):
2249         self.api(self.papi.control_ping)
2250
2251     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
2252                     detect_mult, local_addr, peer_addr, is_ipv6=0,
2253                     bfd_key_id=None, conf_key_id=None):
2254         if bfd_key_id is None:
2255             return self.api(self.papi.bfd_udp_add,
2256                             {
2257                                 'sw_if_index': sw_if_index,
2258                                 'desired_min_tx': desired_min_tx,
2259                                 'required_min_rx': required_min_rx,
2260                                 'local_addr': local_addr,
2261                                 'peer_addr': peer_addr,
2262                                 'is_ipv6': is_ipv6,
2263                                 'detect_mult': detect_mult,
2264                             })
2265         else:
2266             return self.api(self.papi.bfd_udp_add,
2267                             {
2268                                 'sw_if_index': sw_if_index,
2269                                 'desired_min_tx': desired_min_tx,
2270                                 'required_min_rx': required_min_rx,
2271                                 'local_addr': local_addr,
2272                                 'peer_addr': peer_addr,
2273                                 'is_ipv6': is_ipv6,
2274                                 'detect_mult': detect_mult,
2275                                 'is_authenticated': 1,
2276                                 'bfd_key_id': bfd_key_id,
2277                                 'conf_key_id': conf_key_id,
2278                             })
2279
2280     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
2281                     detect_mult, local_addr, peer_addr, is_ipv6=0):
2282         return self.api(self.papi.bfd_udp_mod,
2283                         {
2284                             'sw_if_index': sw_if_index,
2285                             'desired_min_tx': desired_min_tx,
2286                             'required_min_rx': required_min_rx,
2287                             'local_addr': local_addr,
2288                             'peer_addr': peer_addr,
2289                             'is_ipv6': is_ipv6,
2290                             'detect_mult': detect_mult,
2291                         })
2292
2293     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
2294                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
2295                               is_delayed=False):
2296         return self.api(self.papi.bfd_udp_auth_activate,
2297                         {
2298                             'sw_if_index': sw_if_index,
2299                             'local_addr': local_addr,
2300                             'peer_addr': peer_addr,
2301                             'is_ipv6': is_ipv6,
2302                             'is_delayed': 1 if is_delayed else 0,
2303                             'bfd_key_id': bfd_key_id,
2304                             'conf_key_id': conf_key_id,
2305                         })
2306
2307     def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
2308                                 is_ipv6=0, is_delayed=False):
2309         return self.api(self.papi.bfd_udp_auth_deactivate,
2310                         {
2311                             'sw_if_index': sw_if_index,
2312                             'local_addr': local_addr,
2313                             'peer_addr': peer_addr,
2314                             'is_ipv6': is_ipv6,
2315                             'is_delayed': 1 if is_delayed else 0,
2316                         })
2317
2318     def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
2319         return self.api(self.papi.bfd_udp_del,
2320                         {
2321                             'sw_if_index': sw_if_index,
2322                             'local_addr': local_addr,
2323                             'peer_addr': peer_addr,
2324                             'is_ipv6': is_ipv6,
2325                         })
2326
2327     def bfd_udp_session_dump(self):
2328         return self.api(self.papi.bfd_udp_session_dump, {})
2329
2330     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
2331                                   peer_addr, is_ipv6=0):
2332         return self.api(self.papi.bfd_udp_session_set_flags, {
2333             'admin_up_down': admin_up_down,
2334             'sw_if_index': sw_if_index,
2335             'local_addr': local_addr,
2336             'peer_addr': peer_addr,
2337             'is_ipv6': is_ipv6,
2338         })
2339
2340     def want_bfd_events(self, enable_disable=1):
2341         return self.api(self.papi.want_bfd_events, {
2342             'enable_disable': enable_disable,
2343             'pid': os.getpid(),
2344         })
2345
2346     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
2347         return self.api(self.papi.bfd_auth_set_key, {
2348             'conf_key_id': conf_key_id,
2349             'auth_type': auth_type,
2350             'key': key,
2351             'key_len': len(key),
2352         })
2353
2354     def bfd_auth_del_key(self, conf_key_id):
2355         return self.api(self.papi.bfd_auth_del_key, {
2356             'conf_key_id': conf_key_id,
2357         })
2358
2359     def bfd_auth_keys_dump(self):
2360         return self.api(self.papi.bfd_auth_keys_dump, {})
2361
2362     def bfd_udp_set_echo_source(self, sw_if_index):
2363         return self.api(self.papi.bfd_udp_set_echo_source,
2364                         {'sw_if_index': sw_if_index})
2365
2366     def bfd_udp_del_echo_source(self):
2367         return self.api(self.papi.bfd_udp_del_echo_source, {})
2368
2369     def bfd_udp_get_echo_source(self):
2370         return self.api(self.papi.bfd_udp_get_echo_source, {})
2371
2372     def classify_add_del_table(
2373             self,
2374             is_add,
2375             mask,
2376             match_n_vectors=1,
2377             table_index=0xFFFFFFFF,
2378             nbuckets=2,
2379             memory_size=2097152,
2380             skip_n_vectors=0,
2381             next_table_index=0xFFFFFFFF,
2382             miss_next_index=0xFFFFFFFF,
2383             current_data_flag=0,
2384             current_data_offset=0):
2385         """
2386         :param is_add:
2387         :param mask:
2388         :param match_n_vectors: (Default value = 1)
2389         :param table_index: (Default value = 0xFFFFFFFF)
2390         :param nbuckets:  (Default value = 2)
2391         :param memory_size:  (Default value = 2097152)
2392         :param skip_n_vectors:  (Default value = 0)
2393         :param next_table_index:  (Default value = 0xFFFFFFFF)
2394         :param miss_next_index:  (Default value = 0xFFFFFFFF)
2395         :param current_data_flag:  (Default value = 0)
2396         :param current_data_offset:  (Default value = 0)
2397         """
2398
2399         mask_len = ((len(mask) - 1) / 16 + 1) * 16
2400         mask = mask + '\0' * (mask_len - len(mask))
2401         return self.api(
2402             self.papi.classify_add_del_table,
2403             {'is_add': is_add,
2404              'table_index': table_index,
2405              'nbuckets': nbuckets,
2406              'memory_size': memory_size,
2407              'skip_n_vectors': skip_n_vectors,
2408              'match_n_vectors': match_n_vectors,
2409              'next_table_index': next_table_index,
2410              'miss_next_index': miss_next_index,
2411              'current_data_flag': current_data_flag,
2412              'current_data_offset': current_data_offset,
2413              'mask_len': mask_len,
2414              'mask': mask})
2415
2416     def classify_add_del_session(
2417             self,
2418             is_add,
2419             table_index,
2420             match,
2421             opaque_index=0xFFFFFFFF,
2422             hit_next_index=0xFFFFFFFF,
2423             advance=0,
2424             action=0,
2425             metadata=0):
2426         """
2427         :param is_add:
2428         :param table_index:
2429         :param match:
2430         :param opaque_index:  (Default value = 0xFFFFFFFF)
2431         :param hit_next_index:  (Default value = 0xFFFFFFFF)
2432         :param advance:  (Default value = 0)
2433         :param action:  (Default value = 0)
2434         :param metadata:  (Default value = 0)
2435         """
2436
2437         match_len = ((len(match) - 1) / 16 + 1) * 16
2438         match = match + '\0' * (match_len - len(match))
2439         return self.api(
2440             self.papi.classify_add_del_session,
2441             {'is_add': is_add,
2442              'table_index': table_index,
2443              'hit_next_index': hit_next_index,
2444              'opaque_index': opaque_index,
2445              'advance': advance,
2446              'action': action,
2447              'metadata': metadata,
2448              'match_len': match_len,
2449              'match': match})
2450
2451     def input_acl_set_interface(
2452             self,
2453             is_add,
2454             sw_if_index,
2455             ip4_table_index=0xFFFFFFFF,
2456             ip6_table_index=0xFFFFFFFF,
2457             l2_table_index=0xFFFFFFFF):
2458         """
2459         :param is_add:
2460         :param sw_if_index:
2461         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
2462         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
2463         :param l2_table_index:  (Default value = 0xFFFFFFFF)
2464         """
2465
2466         return self.api(
2467             self.papi.input_acl_set_interface,
2468             {'sw_if_index': sw_if_index,
2469              'ip4_table_index': ip4_table_index,
2470              'ip6_table_index': ip6_table_index,
2471              'l2_table_index': l2_table_index,
2472              'is_add': is_add})
2473
2474     def output_acl_set_interface(
2475             self,
2476             is_add,
2477             sw_if_index,
2478             ip4_table_index=0xFFFFFFFF,
2479             ip6_table_index=0xFFFFFFFF,
2480             l2_table_index=0xFFFFFFFF):
2481         """
2482         :param is_add:
2483         :param sw_if_index:
2484         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
2485         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
2486         :param l2_table_index:  (Default value = 0xFFFFFFFF)
2487         """
2488
2489         return self.api(
2490             self.papi.output_acl_set_interface,
2491             {'sw_if_index': sw_if_index,
2492              'ip4_table_index': ip4_table_index,
2493              'ip6_table_index': ip6_table_index,
2494              'l2_table_index': l2_table_index,
2495              'is_add': is_add})
2496
2497     def set_ipfix_exporter(
2498             self,
2499             collector_address,
2500             src_address,
2501             path_mtu,
2502             template_interval,
2503             vrf_id=0,
2504             collector_port=4739,
2505             udp_checksum=0):
2506         return self.api(
2507             self.papi.set_ipfix_exporter,
2508             {
2509                 'collector_address': collector_address,
2510                 'collector_port': collector_port,
2511                 'src_address': src_address,
2512                 'vrf_id': vrf_id,
2513                 'path_mtu': path_mtu,
2514                 'template_interval': template_interval,
2515                 'udp_checksum': udp_checksum,
2516             })
2517
2518     def dhcp_proxy_config(self,
2519                           dhcp_server,
2520                           dhcp_src_address,
2521                           rx_table_id=0,
2522                           server_table_id=0,
2523                           is_add=1,
2524                           is_ipv6=0):
2525         return self.api(
2526             self.papi.dhcp_proxy_config,
2527             {
2528                 'rx_vrf_id': rx_table_id,
2529                 'server_vrf_id': server_table_id,
2530                 'is_ipv6': is_ipv6,
2531                 'is_add': is_add,
2532                 'dhcp_server': dhcp_server,
2533                 'dhcp_src_address': dhcp_src_address,
2534             })
2535
2536     def dhcp_proxy_set_vss(self,
2537                            table_id,
2538                            vss_type=255,
2539                            vpn_ascii_id="",
2540                            oui=0,
2541                            vpn_index=0,
2542                            is_add=1,
2543                            is_ip6=0):
2544         return self.api(
2545             self.papi.dhcp_proxy_set_vss,
2546             {
2547                 'tbl_id': table_id,
2548                 'vss_type': vss_type,
2549                 'vpn_ascii_id': vpn_ascii_id,
2550                 'oui': oui,
2551                 'vpn_index': vpn_index,
2552                 'is_add': is_add,
2553                 'is_ipv6': is_ip6,
2554             })
2555
2556     def dhcp_client_dump(self):
2557         return self.api(self.papi.dhcp_client_dump, {})
2558
2559     def dhcp_client(self,
2560                     sw_if_index,
2561                     hostname,
2562                     client_id='',
2563                     is_add=1,
2564                     set_broadcast_flag=1,
2565                     want_dhcp_events=0):
2566         return self.api(
2567             self.papi.dhcp_client_config,
2568             {
2569                 'is_add': is_add,
2570                 'client': {
2571                     'sw_if_index': sw_if_index,
2572                     'hostname': hostname,
2573                     'id': client_id,
2574                     'want_dhcp_event': want_dhcp_events,
2575                     'set_broadcast_flag': set_broadcast_flag,
2576                     'pid': os.getpid()}
2577             })
2578
2579     def ip_mroute_add_del(self,
2580                           src_address,
2581                           grp_address,
2582                           grp_address_length,
2583                           e_flags,
2584                           next_hop_afi,
2585                           next_hop_sw_if_index,
2586                           next_hop_address,
2587                           i_flags,
2588                           bier_imp=0,
2589                           rpf_id=0,
2590                           table_id=0,
2591                           is_add=1,
2592                           is_ipv6=0,
2593                           is_local=0):
2594         """
2595         IP Multicast Route add/del
2596         """
2597         return self.api(
2598             self.papi.ip_mroute_add_del,
2599             {'next_hop_sw_if_index': next_hop_sw_if_index,
2600              'entry_flags': e_flags,
2601              'itf_flags': i_flags,
2602              'table_id': table_id,
2603              'rpf_id': rpf_id,
2604              'is_add': is_add,
2605              'is_ipv6': is_ipv6,
2606              'is_local': is_local,
2607              'bier_imp': bier_imp,
2608              'next_hop_afi': next_hop_afi,
2609              'grp_address_length': grp_address_length,
2610              'grp_address': grp_address,
2611              'src_address': src_address,
2612              'nh_address': next_hop_address})
2613
2614     def mfib_signal_dump(self):
2615         return self.api(self.papi.mfib_signal_dump, {})
2616
2617     def ip_mfib_dump(self):
2618         return self.api(self.papi.ip_mfib_dump, {})
2619
2620     def ip6_mfib_dump(self):
2621         return self.api(self.papi.ip6_mfib_dump, {})
2622
2623     def lisp_enable_disable(self, is_enabled):
2624         return self.api(
2625             self.papi.lisp_enable_disable,
2626             {
2627                 'is_en': is_enabled,
2628             })
2629
2630     def lisp_locator_set(self,
2631                          ls_name,
2632                          is_add=1):
2633         return self.api(
2634             self.papi.lisp_add_del_locator_set,
2635             {
2636                 'is_add': is_add,
2637                 'locator_set_name': ls_name
2638             })
2639
2640     def lisp_locator_set_dump(self):
2641         return self.api(self.papi.lisp_locator_set_dump, {})
2642
2643     def lisp_locator(self,
2644                      ls_name,
2645                      sw_if_index,
2646                      priority=1,
2647                      weight=1,
2648                      is_add=1):
2649         return self.api(
2650             self.papi.lisp_add_del_locator,
2651             {
2652                 'is_add': is_add,
2653                 'locator_set_name': ls_name,
2654                 'sw_if_index': sw_if_index,
2655                 'priority': priority,
2656                 'weight': weight
2657             })
2658
2659     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2660         return self.api(
2661             self.papi.lisp_locator_dump,
2662             {
2663                 'is_index_set': is_index_set,
2664                 'ls_name': ls_name,
2665                 'ls_index': ls_index,
2666             })
2667
2668     def lisp_local_mapping(self,
2669                            ls_name,
2670                            eid_type,
2671                            eid,
2672                            prefix_len,
2673                            vni=0,
2674                            key_id=0,
2675                            key="",
2676                            is_add=1):
2677         return self.api(
2678             self.papi.lisp_add_del_local_eid,
2679             {
2680                 'locator_set_name': ls_name,
2681                 'is_add': is_add,
2682                 'eid_type': eid_type,
2683                 'eid': eid,
2684                 'prefix_len': prefix_len,
2685                 'vni': vni,
2686                 'key_id': key_id,
2687                 'key': key
2688             })
2689
2690     def lisp_eid_table_dump(self,
2691                             eid_set=0,
2692                             prefix_length=0,
2693                             vni=0,
2694                             eid_type=0,
2695                             eid=None,
2696                             filter_opt=0):
2697         return self.api(
2698             self.papi.lisp_eid_table_dump,
2699             {
2700                 'eid_set': eid_set,
2701                 'prefix_length': prefix_length,
2702                 'vni': vni,
2703                 'eid_type': eid_type,
2704                 'eid': eid,
2705                 'filter': filter_opt,
2706             })
2707
2708     def lisp_remote_mapping(self,
2709                             eid_type,
2710                             eid,
2711                             eid_prefix_len=0,
2712                             vni=0,
2713                             rlocs=[],
2714                             rlocs_num=0,
2715                             is_src_dst=0,
2716                             is_add=1):
2717         return self.api(
2718             self.papi.lisp_add_del_remote_mapping,
2719             {
2720                 'is_add': is_add,
2721                 'eid_type': eid_type,
2722                 'eid': eid,
2723                 'eid_len': eid_prefix_len,
2724                 'rloc_num': rlocs_num,
2725                 'rlocs': rlocs,
2726                 'vni': vni,
2727                 'is_src_dst': is_src_dst,
2728             })
2729
2730     def lisp_adjacency(self,
2731                        leid,
2732                        reid,
2733                        leid_len,
2734                        reid_len,
2735                        eid_type,
2736                        is_add=1,
2737                        vni=0):
2738         return self.api(
2739             self.papi.lisp_add_del_adjacency,
2740             {
2741                 'is_add': is_add,
2742                 'vni': vni,
2743                 'eid_type': eid_type,
2744                 'leid': leid,
2745                 'reid': reid,
2746                 'leid_len': leid_len,
2747                 'reid_len': reid_len,
2748             })
2749
2750     def lisp_adjacencies_get(self, vni=0):
2751         return self.api(
2752             self.papi.lisp_adjacencies_get,
2753             {
2754                 'vni': vni
2755             })
2756
2757     def map_add_domain(self,
2758                        ip6_prefix,
2759                        ip6_src,
2760                        ip4_prefix,
2761                        ea_bits_len=0,
2762                        psid_offset=0,
2763                        psid_length=0,
2764                        mtu=1280):
2765
2766         return self.api(
2767             self.papi.map_add_domain,
2768             {
2769                 'ip6_prefix': ip6_prefix,
2770                 'ip4_prefix': ip4_prefix,
2771                 'ip6_src': ip6_src,
2772                 'ea_bits_len': ea_bits_len,
2773                 'psid_offset': psid_offset,
2774                 'psid_length': psid_length,
2775                 'mtu': mtu
2776             })
2777
2778     def map_if_enable_disable(self, is_enable, sw_if_index, is_translation):
2779         return self.api(
2780             self.papi.map_if_enable_disable,
2781             {
2782                 'is_enable': is_enable,
2783                 'sw_if_index': sw_if_index,
2784                 'is_translation': is_translation,
2785             })
2786
2787     def map_param_set_tcp(self, tcp_mss):
2788         return self.api(
2789             self.papi.map_param_set_tcp,
2790             {
2791                 'tcp_mss': tcp_mss,
2792             })
2793
2794     def gtpu_add_del_tunnel(
2795             self,
2796             src_addr,
2797             dst_addr,
2798             is_add=1,
2799             is_ipv6=0,
2800             mcast_sw_if_index=0xFFFFFFFF,
2801             encap_vrf_id=0,
2802             decap_next_index=0xFFFFFFFF,
2803             teid=0):
2804         """
2805
2806         :param is_add:  (Default value = 1)
2807         :param is_ipv6:  (Default value = 0)
2808         :param src_addr:
2809         :param dst_addr:
2810         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2811         :param encap_vrf_id:  (Default value = 0)
2812         :param decap_next_index:  (Default value = 0xFFFFFFFF)
2813         :param teid:  (Default value = 0)
2814
2815         """
2816         return self.api(self.papi.gtpu_add_del_tunnel,
2817                         {'is_add': is_add,
2818                          'is_ipv6': is_ipv6,
2819                          'src_address': src_addr,
2820                          'dst_address': dst_addr,
2821                          'mcast_sw_if_index': mcast_sw_if_index,
2822                          'encap_vrf_id': encap_vrf_id,
2823                          'decap_next_index': decap_next_index,
2824                          'teid': teid})
2825
2826     def vxlan_gpe_add_del_tunnel(
2827             self,
2828             src_addr,
2829             dst_addr,
2830             mcast_sw_if_index=0xFFFFFFFF,
2831             is_add=1,
2832             is_ipv6=0,
2833             encap_vrf_id=0,
2834             decap_vrf_id=0,
2835             protocol=3,
2836             vni=0):
2837         """
2838
2839         :param local:
2840         :param remote:
2841         :param is_add:  (Default value = 1)
2842         :param is_ipv6:  (Default value = 0)
2843         :param encap_vrf_id:  (Default value = 0)
2844         :param decap_vrf_id:  (Default value = 0)
2845         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2846         :param protocol:  (Default value = 3)
2847         :param vni:  (Default value = 0)
2848
2849         """
2850         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2851                         {'is_add': is_add,
2852                          'is_ipv6': is_ipv6,
2853                          'local': src_addr,
2854                          'remote': dst_addr,
2855                          'mcast_sw_if_index': mcast_sw_if_index,
2856                          'encap_vrf_id': encap_vrf_id,
2857                          'decap_vrf_id': decap_vrf_id,
2858                          'protocol': protocol,
2859                          'vni': vni})
2860
2861     def vxlan_gbp_tunnel_add_del(
2862             self,
2863             src,
2864             dst,
2865             mcast_sw_if_index=0xFFFFFFFF,
2866             is_add=1,
2867             is_ipv6=0,
2868             encap_table_id=0,
2869             vni=0,
2870             instance=0xFFFFFFFF):
2871         """
2872
2873         :param dst_addr:
2874         :param src_addr:
2875         :param is_add:  (Default value = 1)
2876         :param is_ipv6:  (Default value = 0)
2877         :param encap_table_id:  (Default value = 0)
2878         :param decap_next_index:  (Default value = 0xFFFFFFFF)
2879         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
2880         :param vni:  (Default value = 0)
2881         :param instance:  (Default value = 0xFFFFFFFF)
2882
2883         """
2884         return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2885                         {'is_add': is_add,
2886                          'tunnel': {
2887                              'src': src,
2888                              'dst': dst,
2889                              'mcast_sw_if_index': mcast_sw_if_index,
2890                              'encap_table_id': encap_table_id,
2891                              'vni': vni,
2892                              'instance': instance}})
2893
2894     def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2895         return self.api(self.papi.vxlan_gbp_tunnel_dump,
2896                         {'sw_if_index': sw_if_index,
2897                          '_no_type_conversion': True})
2898
2899     def pppoe_add_del_session(
2900             self,
2901             client_ip,
2902             client_mac,
2903             session_id=0,
2904             is_add=1,
2905             is_ipv6=0,
2906             decap_vrf_id=0):
2907         """
2908
2909         :param is_add:  (Default value = 1)
2910         :param is_ipv6:  (Default value = 0)
2911         :param client_ip:
2912         :param session_id:  (Default value = 0)
2913         :param client_mac:
2914         :param decap_vrf_id:  (Default value = 0)
2915
2916         """
2917         return self.api(self.papi.pppoe_add_del_session,
2918                         {'is_add': is_add,
2919                          'is_ipv6': is_ipv6,
2920                          'session_id': session_id,
2921                          'client_ip': client_ip,
2922                          'decap_vrf_id': decap_vrf_id,
2923                          'client_mac': client_mac})
2924
2925     def sr_mpls_policy_add(self, bsid, weight, type, segments):
2926         return self.api(self.papi.sr_mpls_policy_add,
2927                         {'bsid': bsid,
2928                          'weight': weight,
2929                          'type': type,
2930                          'n_segments': len(segments),
2931                          'segments': segments})
2932
2933     def sr_mpls_policy_del(self, bsid):
2934         return self.api(self.papi.sr_mpls_policy_del,
2935                         {'bsid': bsid})
2936
2937     def sr_localsid_add_del(self,
2938                             localsid,
2939                             behavior,
2940                             nh_addr4,
2941                             nh_addr6,
2942                             is_del=0,
2943                             end_psp=0,
2944                             sw_if_index=0xFFFFFFFF,
2945                             vlan_index=0,
2946                             fib_table=0,
2947                             ):
2948         """ Add/del IPv6 SR local-SID.
2949
2950         :param localsid:
2951         :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2952         :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2953         :param nh_addr4:
2954         :param nh_addr6:
2955         :param is_del:  (Default value = 0)
2956         :param end_psp: (Default value = 0)
2957         :param sw_if_index: (Default value = 0xFFFFFFFF)
2958         :param vlan_index:  (Default value = 0)
2959         :param fib_table:   (Default value = 0)
2960         """
2961         return self.api(
2962             self.papi.sr_localsid_add_del,
2963             {'is_del': is_del,
2964              'localsid': localsid,
2965              'end_psp': end_psp,
2966              'behavior': behavior,
2967              'sw_if_index': sw_if_index,
2968              'vlan_index': vlan_index,
2969              'fib_table': fib_table,
2970              'nh_addr4': nh_addr4,
2971              'nh_addr6': nh_addr6
2972              }
2973         )
2974
2975     def sr_policy_add(
2976             self,
2977             bsid_addr,
2978             weight=1,
2979             is_encap=1,
2980             type=0,
2981             fib_table=0,
2982             n_segments=0,
2983             segments=[]):
2984         """
2985         :param bsid_addr: bindingSID of the SR Policy
2986         :param weight: weight of the sid list. optional. (default: 1)
2987         :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2988             (default: Encap)
2989         :param type: type/behavior of the SR policy. (default or spray) \
2990             (default: default)
2991         :param fib_table: VRF where to install the FIB entry for the BSID \
2992             (default: 0)
2993         :param n_segments: number of segments \
2994             (default: 0)
2995         :param segments: a vector of IPv6 address composing the segment list \
2996             (default: [])
2997         """
2998         return self.api(
2999             self.papi.sr_policy_add,
3000             {'bsid_addr': bsid_addr,
3001              'weight': weight,
3002              'is_encap': is_encap,
3003              'type': type,
3004              'fib_table': fib_table,
3005              'n_segments': n_segments,
3006              'segments': segments
3007              }
3008         )
3009
3010     def sr_policy_del(
3011             self,
3012             bsid_addr,
3013             sr_policy_index=0):
3014         """
3015         :param bsid: bindingSID of the SR Policy
3016         :param sr_policy_index: index of the sr policy (default: 0)
3017         """
3018         return self.api(
3019             self.papi.sr_policy_del,
3020             {'bsid_addr': bsid_addr,
3021              'sr_policy_index': sr_policy_index
3022              })
3023
3024     def sr_steering_add_del(
3025             self,
3026             is_del,
3027             bsid_addr,
3028             sr_policy_index,
3029             table_id,
3030             prefix_addr,
3031             mask_width,
3032             sw_if_index,
3033             traffic_type):
3034         """
3035         Steer traffic L2 and L3 traffic through a given SR policy
3036
3037         :param is_del: delete or add
3038         :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
3039         :param sr_policy: is the index of the SR Policy (alt to bsid)
3040         :param table_id: is the VRF where to install the FIB entry for the BSID
3041         :param prefix_addr: is the IPv4/v6 address for L3 traffic type
3042         :param mask_width: is the mask for L3 traffic type
3043         :param sw_if_index: is the incoming interface for L2 traffic
3044         :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
3045         """
3046         return self.api(
3047             self.papi.sr_steering_add_del,
3048             {'is_del': is_del,
3049              'bsid_addr': bsid_addr,
3050              'sr_policy_index': sr_policy_index,
3051              'table_id': table_id,
3052              'prefix_addr': prefix_addr,
3053              'mask_width': mask_width,
3054              'sw_if_index': sw_if_index,
3055              'traffic_type': traffic_type
3056              })
3057
3058     def acl_add_replace(self, acl_index, r, tag='',
3059                         expected_retval=0):
3060         """Add/replace an ACL
3061         :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
3062         :param acl_rule r: ACL rules array.
3063         :param str tag: symbolic tag (description) for this ACL.
3064         :param int count: number of rules.
3065         """
3066         return self.api(self.papi.acl_add_replace,
3067                         {'acl_index': acl_index,
3068                          'r': r,
3069                          'count': len(r),
3070                          'tag': tag},
3071                         expected_retval=expected_retval)
3072
3073     def acl_del(self, acl_index, expected_retval=0):
3074         """
3075
3076         :param acl_index:
3077         :return:
3078         """
3079         return self.api(self.papi.acl_del,
3080                         {'acl_index': acl_index},
3081                         expected_retval=expected_retval)
3082
3083     def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
3084                                    expected_retval=0):
3085         return self.api(self.papi.acl_interface_set_acl_list,
3086                         {'sw_if_index': sw_if_index,
3087                          'count': len(acls),
3088                          'n_input': n_input,
3089                          'acls': acls},
3090                         expected_retval=expected_retval)
3091
3092     def acl_interface_set_etype_whitelist(self, sw_if_index,
3093                                           n_input, whitelist,
3094                                           expected_retval=0):
3095         return self.api(self.papi.acl_interface_set_etype_whitelist,
3096                         {'sw_if_index': sw_if_index,
3097                          'count': len(whitelist),
3098                          'n_input': n_input,
3099                          'whitelist': whitelist},
3100                         expected_retval=expected_retval)
3101
3102     def acl_interface_add_del(self,
3103                               sw_if_index,
3104                               acl_index,
3105                               is_add=1):
3106         """ Add/Delete ACL to/from interface
3107
3108         :param sw_if_index:
3109         :param acl_index:
3110         :param is_add:  (Default value = 1)
3111         """
3112
3113         return self.api(self.papi.acl_interface_add_del,
3114                         {'is_add': is_add,
3115                          'is_input': 1,
3116                          'sw_if_index': sw_if_index,
3117                          'acl_index': acl_index})
3118
3119     def acl_dump(self, acl_index, expected_retval=0):
3120         return self.api(self.papi.acl_dump,
3121                         {'acl_index': acl_index},
3122                         expected_retval=expected_retval)
3123
3124     def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
3125                                 expected_retval=0):
3126         return self.api(self.papi.acl_interface_list_dump,
3127                         {'sw_if_index': sw_if_index},
3128                         expected_retval=expected_retval)
3129
3130     def macip_acl_add(self, rules, tag=""):
3131         """ Add MACIP acl
3132
3133         :param rules: list of rules for given acl
3134         :param tag: acl tag
3135         """
3136
3137         return self.api(self.papi.macip_acl_add,
3138                         {'r': rules,
3139                          'count': len(rules),
3140                          'tag': tag})
3141
3142     def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
3143         """ Add MACIP acl
3144
3145         :param rules: list of rules for given acl
3146         :param tag: acl tag
3147         """
3148
3149         return self.api(self.papi.macip_acl_add_replace,
3150                         {'acl_index': acl_index,
3151                          'r': rules,
3152                          'count': len(rules),
3153                          'tag': tag})
3154
3155     def macip_acl_del(self, acl_index):
3156         """
3157
3158         :param acl_index:
3159         :return:
3160         """
3161         return self.api(self.papi.macip_acl_del,
3162                         {'acl_index': acl_index})
3163
3164     def macip_acl_interface_add_del(self,
3165                                     sw_if_index,
3166                                     acl_index,
3167                                     is_add=1):
3168         """ Add MACIP acl to interface
3169
3170         :param sw_if_index:
3171         :param acl_index:
3172         :param is_add:  (Default value = 1)
3173         """
3174
3175         return self.api(self.papi.macip_acl_interface_add_del,
3176                         {'is_add': is_add,
3177                          'sw_if_index': sw_if_index,
3178                          'acl_index': acl_index})
3179
3180     def macip_acl_interface_get(self):
3181         """ Return interface acls dump
3182         """
3183         return self.api(
3184             self.papi.macip_acl_interface_get, {})
3185
3186     def macip_acl_dump(self, acl_index=4294967295):
3187         """ Return MACIP acl dump
3188         """
3189
3190         return self.api(
3191             self.papi.macip_acl_dump, {'acl_index': acl_index})
3192
3193     def policer_add_del(self,
3194                         name,
3195                         cir,
3196                         eir,
3197                         cb,
3198                         eb,
3199                         is_add=1,
3200                         rate_type=0,
3201                         round_type=0,
3202                         ptype=0,
3203                         color_aware=0,
3204                         conform_action_type=1,
3205                         conform_dscp=0,
3206                         exceed_action_type=0,
3207                         exceed_dscp=0,
3208                         violate_action_type=0,
3209                         violate_dscp=0):
3210         return self.api(self.papi.policer_add_del,
3211                         {'name': name,
3212                          'cir': cir,
3213                          'eir': eir,
3214                          'cb': cb,
3215                          'eb': eb,
3216                          'is_add': is_add,
3217                          'rate_type': rate_type,
3218                          'round_type': round_type,
3219                          'type': ptype,
3220                          'color_aware': color_aware,
3221                          'conform_action_type': conform_action_type,
3222                          'conform_dscp': conform_dscp,
3223                          'exceed_action_type': exceed_action_type,
3224                          'exceed_dscp': exceed_dscp,
3225                          'violate_action_type': violate_action_type,
3226                          'violate_dscp': violate_dscp})
3227
3228     def ip_punt_police(self,
3229                        policer_index,
3230                        is_ip6=0,
3231                        is_add=1):
3232         return self.api(self.papi.ip_punt_police,
3233                         {'policer_index': policer_index,
3234                          'is_add': is_add,
3235                          'is_ip6': is_ip6})
3236
3237     def ip_punt_redirect(self,
3238                          rx_sw_if_index,
3239                          tx_sw_if_index,
3240                          address,
3241                          is_add=1):
3242         return self.api(self.papi.ip_punt_redirect,
3243                         {'punt': {'rx_sw_if_index': rx_sw_if_index,
3244                                   'tx_sw_if_index': tx_sw_if_index,
3245                                   'nh': address},
3246                          'is_add': is_add})
3247
3248     def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
3249         return self.api(self.papi.ip_punt_redirect_dump,
3250                         {'sw_if_index': sw_if_index,
3251                          'is_ipv6': is_ipv6})
3252
3253     def bier_table_add_del(self,
3254                            bti,
3255                            mpls_label,
3256                            is_add=1):
3257         """ BIER Table add/del """
3258         return self.api(
3259             self.papi.bier_table_add_del,
3260             {'bt_tbl_id': {"bt_set": bti.set_id,
3261                            "bt_sub_domain": bti.sub_domain_id,
3262                            "bt_hdr_len_id": bti.hdr_len_id},
3263              'bt_label': mpls_label,
3264              'bt_is_add': is_add})
3265
3266     def bier_table_dump(self):
3267         return self.api(self.papi.bier_table_dump, {})
3268
3269     def bier_route_add_del(self,
3270                            bti,
3271                            bp,
3272                            paths,
3273                            is_add=1,
3274                            is_replace=0):
3275         """ BIER Route add/del """
3276         return self.api(
3277             self.papi.bier_route_add_del,
3278             {'br_tbl_id': {"bt_set": bti.set_id,
3279                            "bt_sub_domain": bti.sub_domain_id,
3280                            "bt_hdr_len_id": bti.hdr_len_id},
3281              'br_bp': bp,
3282              'br_n_paths': len(paths),
3283              'br_paths': paths,
3284              'br_is_add': is_add,
3285              'br_is_replace': is_replace})
3286
3287     def bier_route_dump(self, bti):
3288         return self.api(
3289             self.papi.bier_route_dump,
3290             {'br_tbl_id': {"bt_set": bti.set_id,
3291                            "bt_sub_domain": bti.sub_domain_id,
3292                            "bt_hdr_len_id": bti.hdr_len_id}})
3293
3294     def bier_imp_add(self,
3295                      bti,
3296                      src,
3297                      ibytes,
3298                      is_add=1):
3299         """ BIER Imposition Add """
3300         return self.api(
3301             self.papi.bier_imp_add,
3302             {'bi_tbl_id': {"bt_set": bti.set_id,
3303                            "bt_sub_domain": bti.sub_domain_id,
3304                            "bt_hdr_len_id": bti.hdr_len_id},
3305              'bi_src': src,
3306              'bi_n_bytes': len(ibytes),
3307              'bi_bytes': ibytes})
3308
3309     def bier_imp_del(self, bi_index):
3310         """ BIER Imposition del """
3311         return self.api(
3312             self.papi.bier_imp_del,
3313             {'bi_index': bi_index})
3314
3315     def bier_imp_dump(self):
3316         return self.api(self.papi.bier_imp_dump, {})
3317
3318     def bier_disp_table_add_del(self,
3319                                 bdti,
3320                                 is_add=1):
3321         """ BIER Disposition Table add/del """
3322         return self.api(
3323             self.papi.bier_disp_table_add_del,
3324             {'bdt_tbl_id': bdti,
3325              'bdt_is_add': is_add})
3326
3327     def bier_disp_table_dump(self):
3328         return self.api(self.papi.bier_disp_table_dump, {})
3329
3330     def bier_disp_entry_add_del(self,
3331                                 bdti,
3332                                 bp,
3333                                 payload_proto,
3334                                 next_hop_afi,
3335                                 next_hop,
3336                                 next_hop_tbl_id=0,
3337                                 next_hop_rpf_id=~0,
3338                                 next_hop_is_ip4=1,
3339                                 is_add=1):
3340         """ BIER Route add/del """
3341         lstack = []
3342         while (len(lstack) < 16):
3343             lstack.append({})
3344         return self.api(
3345             self.papi.bier_disp_entry_add_del,
3346             {'bde_tbl_id': bdti,
3347              'bde_bp': bp,
3348              'bde_payload_proto': payload_proto,
3349              'bde_n_paths': 1,
3350              'bde_paths': [{'next_hop': next_hop,
3351                             'table_id': next_hop_tbl_id,
3352                             'afi': next_hop_afi,
3353                             'rpf_id': next_hop_rpf_id,
3354                             'n_labels': 0,
3355                             'label_stack': lstack}],
3356              'bde_is_add': is_add})
3357
3358     def bier_disp_entry_dump(self, bdti):
3359         return self.api(
3360             self.papi.bier_disp_entry_dump,
3361             {'bde_tbl_id': bdti})
3362
3363     def add_node_next(self, node_name, next_name):
3364         """ Set the next node for a given node request
3365
3366         :param node_name:
3367         :param next_name:
3368         """
3369         return self.api(self.papi.add_node_next,
3370                         {'node_name': node_name,
3371                          'next_name': next_name})
3372
3373     def session_enable_disable(self, is_enabled):
3374         return self.api(
3375             self.papi.session_enable_disable,
3376             {'is_enable': is_enabled})
3377
3378     def ipsec_spd_add_del(self, spd_id, is_add=1):
3379         """ SPD add/del - Wrapper to add or del ipsec SPD
3380         Sample CLI : 'ipsec spd add 1'
3381
3382         :param spd_id - SPD ID to be created in the vpp . mandatory
3383         :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
3384               optional
3385         :returns: reply from the API
3386         """
3387         return self.api(
3388             self.papi.ipsec_spd_add_del, {
3389                 'spd_id': spd_id, 'is_add': is_add})
3390
3391     def ipsec_spds_dump(self):
3392         return self.api(self.papi.ipsec_spds_dump, {})
3393
3394     def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
3395         """ IPSEC interface SPD add/del - \
3396              Wrapper to associate/disassociate SPD to interface in VPP
3397         Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
3398
3399         :param spd_id - SPD ID to associate with the interface . mandatory
3400         :param sw_if_index - Interface Index which needs to ipsec \
3401             association mandatory
3402         :param is_add - add(1) or del(0) association with interface \
3403                 (Default 1 - add) . optional
3404         :returns: reply from the API
3405         """
3406         return self.api(
3407             self.papi.ipsec_interface_add_del_spd,
3408             {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
3409
3410     def ipsec_spd_interface_dump(self, spd_index=None):
3411         return self.api(self.papi.ipsec_spd_interface_dump,
3412                         {'spd_index': spd_index if spd_index else 0,
3413                          'spd_index_valid': 1 if spd_index else 0})
3414
3415     def ipsec_sad_entry_add_del(self,
3416                                 sad_id,
3417                                 spi,
3418                                 integrity_algorithm,
3419                                 integrity_key,
3420                                 crypto_algorithm,
3421                                 crypto_key,
3422                                 protocol,
3423                                 tunnel_src_address='',
3424                                 tunnel_dst_address='',
3425                                 flags=0,
3426                                 is_add=1):
3427         """ IPSEC SA add/del
3428         :param sad_id: security association ID
3429         :param spi: security param index of the SA in decimal
3430         :param integrity_algorithm:
3431         :param integrity_key:
3432         :param crypto_algorithm:
3433         :param crypto_key:
3434         :param protocol: AH(0) or ESP(1) protocol
3435         :param tunnel_src_address: tunnel mode outer src address
3436         :param tunnel_dst_address: tunnel mode outer dst address
3437         :param is_add:
3438         :param is_tunnel:
3439         :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
3440              crypto and ipsec algorithms
3441         """
3442         return self.api(
3443             self.papi.ipsec_sad_entry_add_del,
3444             {
3445                 'is_add': is_add,
3446                 'entry':
3447                 {
3448                     'sad_id': sad_id,
3449                     'spi': spi,
3450                     'tunnel_src': tunnel_src_address,
3451                     'tunnel_dst': tunnel_dst_address,
3452                     'protocol': protocol,
3453                     'integrity_algorithm': integrity_algorithm,
3454                     'integrity_key': {
3455                         'length': len(integrity_key),
3456                         'data': integrity_key,
3457                     },
3458                     'crypto_algorithm': crypto_algorithm,
3459                     'crypto_key': {
3460                         'length': len(crypto_key),
3461                         'data': crypto_key,
3462                     },
3463                     'flags': flags,
3464                 }
3465             })
3466
3467     def ipsec_sa_dump(self, sa_id=None):
3468         return self.api(self.papi.ipsec_sa_dump,
3469                         {'sa_id': sa_id if sa_id else 0xffffffff})
3470
3471     def ipsec_spd_entry_add_del(self,
3472                                 spd_id,
3473                                 sa_id,
3474                                 local_address_start,
3475                                 local_address_stop,
3476                                 remote_address_start,
3477                                 remote_address_stop,
3478                                 local_port_start=0,
3479                                 local_port_stop=65535,
3480                                 remote_port_start=0,
3481                                 remote_port_stop=65535,
3482                                 protocol=0,
3483                                 policy=0,
3484                                 priority=100,
3485                                 is_outbound=1,
3486                                 is_add=1,
3487                                 is_ipv6=0,
3488                                 is_ip_any=0):
3489         """ IPSEC policy SPD add/del   -
3490                     Wrapper to configure ipsec SPD policy entries in VPP
3491         :param spd_id: SPD ID for the policy
3492         :param local_address_start: local-ip-range start address
3493         :param local_address_stop : local-ip-range stop address
3494         :param remote_address_start: remote-ip-range start address
3495         :param remote_address_stop : remote-ip-range stop address
3496         :param local_port_start: (Default value = 0)
3497         :param local_port_stop: (Default value = 65535)
3498         :param remote_port_start: (Default value = 0)
3499         :param remote_port_stop: (Default value = 65535)
3500         :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
3501         :param sa_id: Security Association ID for mapping it to SPD
3502         :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
3503                (Default value = 0)
3504         :param priority: value for the spd action (Default value = 100)
3505         :param is_outbound: flag for inbound(0) or outbound(1)
3506                (Default value = 1)
3507         :param is_add: (Default value = 1)
3508         """
3509         return self.api(
3510             self.papi.ipsec_spd_entry_add_del,
3511             {
3512                 'is_add': is_add,
3513                 'entry':
3514                 {
3515                     'spd_id': spd_id,
3516                     'sa_id': sa_id,
3517                     'local_address_start': local_address_start,
3518                     'local_address_stop': local_address_stop,
3519                     'remote_address_start': remote_address_start,
3520                     'remote_address_stop': remote_address_stop,
3521                     'local_port_start': local_port_start,
3522                     'local_port_stop': local_port_stop,
3523                     'remote_port_start': remote_port_start,
3524                     'remote_port_stop': remote_port_stop,
3525                     'protocol': protocol,
3526                     'policy': policy,
3527                     'priority': priority,
3528                     'is_outbound': is_outbound,
3529                     'is_ip_any': is_ip_any
3530                 }
3531             })
3532
3533     def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
3534         return self.api(self.papi.ipsec_spd_dump,
3535                         {'spd_id': spd_id,
3536                          'sa_id': sa_id})
3537
3538     def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
3539                                 remote_spi, crypto_alg, local_crypto_key,
3540                                 remote_crypto_key, integ_alg, local_integ_key,
3541                                 remote_integ_key, is_add=1, esn=0,
3542                                 anti_replay=1, renumber=0, show_instance=0):
3543         return self.api(
3544             self.papi.ipsec_tunnel_if_add_del,
3545             {'local_ip': local_ip, 'remote_ip': remote_ip,
3546              'local_spi': local_spi, 'remote_spi': remote_spi,
3547              'crypto_alg': crypto_alg,
3548              'local_crypto_key_len': len(local_crypto_key),
3549              'local_crypto_key': local_crypto_key,
3550              'remote_crypto_key_len': len(remote_crypto_key),
3551              'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
3552              'local_integ_key_len': len(local_integ_key),
3553              'local_integ_key': local_integ_key,
3554              'remote_integ_key_len': len(remote_integ_key),
3555              'remote_integ_key': remote_integ_key, 'is_add': is_add,
3556              'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
3557              'show_instance': show_instance
3558              })
3559
3560     def ipsec_select_backend(self, protocol, index):
3561         return self.api(self.papi.ipsec_select_backend,
3562                         {'protocol': protocol, 'index': index})
3563
3564     def ipsec_backend_dump(self):
3565         return self.api(self.papi.ipsec_backend_dump, {})
3566
3567     def app_namespace_add(self,
3568                           namespace_id,
3569                           ip4_fib_id=0,
3570                           ip6_fib_id=0,
3571                           sw_if_index=0xFFFFFFFF,
3572                           secret=0):
3573         return self.api(
3574             self.papi.app_namespace_add_del,
3575             {'secret': secret,
3576              'sw_if_index': sw_if_index,
3577              'ip4_fib_id': ip4_fib_id,
3578              'ip6_fib_id': ip6_fib_id,
3579              'namespace_id': namespace_id,
3580              'namespace_id_len': len(namespace_id)})
3581
3582     def punt_socket_register(self, port, pathname, protocol=0x11,
3583                              header_version=1, is_ip4=1):
3584         """ Register punt socket """
3585         return self.api(self.papi.punt_socket_register,
3586                         {'header_version': header_version,
3587                          'punt': {'ipv': is_ip4,
3588                                   'l4_protocol': protocol,
3589                                   'l4_port': port},
3590                          'pathname': pathname})
3591
3592     def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
3593         """ Unregister punt socket """
3594         return self.api(self.papi.punt_socket_deregister,
3595                         {'punt': {'ipv': is_ip4,
3596                                   'l4_protocol': protocol,
3597                                   'l4_port': port}})
3598
3599     def punt_socket_dump(self, is_ip6=1):
3600         """ Dump punt socket"""
3601         return self.api(self.papi.punt_socket_dump,
3602                         {'is_ipv6': is_ip6})
3603
3604     def ip_reassembly_set(self, timeout_ms, max_reassemblies,
3605                           expire_walk_interval_ms, is_ip6=0):
3606         """ Set IP reassembly parameters """
3607         return self.api(self.papi.ip_reassembly_set,
3608                         {'is_ip6': is_ip6,
3609                          'timeout_ms': timeout_ms,
3610                          'expire_walk_interval_ms': expire_walk_interval_ms,
3611                          'max_reassemblies': max_reassemblies})
3612
3613     def ip_reassembly_get(self, is_ip6=0):
3614         """ Get IP reassembly parameters """
3615         return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
3616
3617     def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
3618                                      enable_ip6=False):
3619         """ Enable/disable IP reassembly """
3620         return self.api(self.papi.ip_reassembly_enable_disable,
3621                         {'sw_if_index': sw_if_index,
3622                          'enable_ip4': 1 if enable_ip4 else 0,
3623                          'enable_ip6': 1 if enable_ip6 else 0,
3624                          })
3625
3626     def gbp_endpoint_add(self, sw_if_index, ips, mac, epg, flags,
3627                          tun_src, tun_dst):
3628         """ GBP endpoint Add """
3629         return self.api(self.papi.gbp_endpoint_add,
3630                         {'endpoint': {
3631                             'sw_if_index': sw_if_index,
3632                             'ips': ips,
3633                             'n_ips': len(ips),
3634                             'mac': mac,
3635                             'epg_id': epg,
3636                             'flags': flags,
3637                             'tun': {
3638                                 'src': tun_src,
3639                                 'dst': tun_dst,
3640                             }}})
3641
3642     def gbp_endpoint_del(self, handle):
3643         """ GBP endpoint Del """
3644         return self.api(self.papi.gbp_endpoint_del,
3645                         {'handle': handle})
3646
3647     def gbp_endpoint_dump(self):
3648         """ GBP endpoint Dump """
3649         return self.api(self.papi.gbp_endpoint_dump,
3650                         {'_no_type_conversion': True})
3651
3652     def gbp_endpoint_group_add(self, epg, sclass, bd,
3653                                rd, uplink_sw_if_index):
3654         """ GBP endpoint group Add """
3655         return self.api(self.papi.gbp_endpoint_group_add,
3656                         {'epg':
3657                          {
3658                              'uplink_sw_if_index': uplink_sw_if_index,
3659                              'bd_id': bd,
3660                              'rd_id': rd,
3661                              'epg_id': epg,
3662                              'sclass': sclass
3663                          }})
3664
3665     def gbp_endpoint_group_del(self, epg):
3666         """ GBP endpoint group Del """
3667         return self.api(self.papi.gbp_endpoint_group_del,
3668                         {'epg_id': epg})
3669
3670     def gbp_endpoint_group_dump(self):
3671         """ GBP endpoint group Dump """
3672         return self.api(self.papi.gbp_endpoint_group_dump, {})
3673
3674     def gbp_bridge_domain_add(self, bd_id, flags,
3675                               bvi_sw_if_index,
3676                               uu_fwd_sw_if_index,
3677                               bm_flood_sw_if_index):
3678         """ GBP bridge-domain Add """
3679         return self.api(self.papi.gbp_bridge_domain_add,
3680                         {'bd':
3681                          {
3682                              'flags': flags,
3683                              'bvi_sw_if_index': bvi_sw_if_index,
3684                              'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
3685                              'bm_flood_sw_if_index': bm_flood_sw_if_index,
3686                              'bd_id': bd_id
3687                          }})
3688
3689     def gbp_bridge_domain_del(self, bd_id):
3690         """ GBP bridge-domain Del """
3691         return self.api(self.papi.gbp_bridge_domain_del,
3692                         {'bd_id': bd_id})
3693
3694     def gbp_bridge_domain_dump(self):
3695         """ GBP Bridge Domain Dump """
3696         return self.api(self.papi.gbp_bridge_domain_dump, {})
3697
3698     def gbp_route_domain_add(self, rd_id,
3699                              ip4_table_id,
3700                              ip6_table_id,
3701                              ip4_uu_sw_if_index,
3702                              ip6_uu_sw_if_index):
3703         """ GBP route-domain Add """
3704         return self.api(self.papi.gbp_route_domain_add,
3705                         {'rd':
3706                          {
3707                              'ip4_table_id': ip4_table_id,
3708                              'ip6_table_id': ip6_table_id,
3709                              'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
3710                              'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
3711                              'rd_id': rd_id
3712                          }})
3713
3714     def gbp_route_domain_del(self, rd_id):
3715         """ GBP route-domain Del """
3716         return self.api(self.papi.gbp_route_domain_del,
3717                         {'rd_id': rd_id})
3718
3719     def gbp_route_domain_dump(self):
3720         """ GBP Route Domain Dump """
3721         return self.api(self.papi.gbp_route_domain_dump, {})
3722
3723     def gbp_recirc_add_del(self, is_add, sw_if_index, epg, is_ext):
3724         """ GBP recirc Add/Del """
3725         return self.api(self.papi.gbp_recirc_add_del,
3726                         {'is_add': is_add,
3727                          'recirc': {
3728                              'is_ext': is_ext,
3729                              'sw_if_index': sw_if_index,
3730                              'epg_id': epg}})
3731
3732     def gbp_recirc_dump(self):
3733         """ GBP recirc Dump """
3734         return self.api(self.papi.gbp_recirc_dump, {})
3735
3736     def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
3737         """ GBP recirc Add/Del """
3738         return self.api(self.papi.gbp_ext_itf_add_del,
3739                         {'is_add': is_add,
3740                          'ext_itf': {
3741                              'sw_if_index': sw_if_index,
3742                              'bd_id': bd_id,
3743                              'rd_id': rd_id}})
3744
3745     def gbp_ext_itf_dump(self):
3746         """ GBP recirc Dump """
3747         return self.api(self.papi.gbp_ext_itf_dump, {})
3748
3749     def gbp_subnet_add_del(self, is_add, rd_id,
3750                            prefix, type,
3751                            sw_if_index=0xffffffff,
3752                            epg_id=0xffff):
3753         """ GBP Subnet Add/Del """
3754         return self.api(self.papi.gbp_subnet_add_del,
3755                         {'is_add': is_add,
3756                          'subnet': {
3757                              'type': type,
3758                              'sw_if_index': sw_if_index,
3759                              'epg_id': epg_id,
3760                              'prefix': prefix,
3761                              'rd_id': rd_id}})
3762
3763     def gbp_subnet_dump(self):
3764         """ GBP Subnet Dump """
3765         return self.api(self.papi.gbp_subnet_dump,
3766                         {'_no_type_conversion': True})
3767
3768     def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index,
3769                              rules, allowed_ethertypes):
3770         """ GBP contract Add/Del """
3771         return self.api(self.papi.gbp_contract_add_del,
3772                         {'is_add': is_add,
3773                          'contract': {
3774                              'acl_index': acl_index,
3775                              'src_epg': src_epg,
3776                              'dst_epg': dst_epg,
3777                              'n_rules': len(rules),
3778                              'rules': rules,
3779                              'n_ether_types': len(allowed_ethertypes),
3780                              'allowed_ethertypes': allowed_ethertypes}})
3781
3782     def gbp_contract_dump(self):
3783         """ GBP contract Dump """
3784         return self.api(self.papi.gbp_contract_dump, {})
3785
3786     def gbp_endpoint_learn_set_inactive_threshold(self, threshold):
3787         """ GBP set inactive threshold """
3788         return self.api(self.papi.gbp_endpoint_learn_set_inactive_threshold,
3789                         {'threshold': threshold})
3790
3791     def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode):
3792         """ GBP VXLAN tunnel add """
3793         return self.api(self.papi.gbp_vxlan_tunnel_add,
3794                         {
3795                             'tunnel': {
3796                                 'vni': vni,
3797                                 'mode': mode,
3798                                 'bd_rd_id': bd_rd_id
3799                             }
3800                         })
3801
3802     def gbp_vxlan_tunnel_del(self, vni):
3803         """ GBP VXLAN tunnel del """
3804         return self.api(self.papi.gbp_vxlan_tunnel_del,
3805                         {
3806                             'vni': vni,
3807                         })
3808
3809     def gbp_vxlan_tunnel_dump(self):
3810         """ GBP VXLAN tunnel add/del """
3811         return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
3812
3813     def ipip_6rd_add_tunnel(self, ip6_table_id, ip6_prefix, ip6_prefix_len,
3814                             ip4_table_id, ip4_prefix, ip4_prefix_len, ip4_src,
3815                             security_check):
3816         """ 6RD tunnel Add """
3817         return self.api(self.papi.ipip_6rd_add_tunnel,
3818                         {'ip4_table_id': ip4_table_id,
3819                          'ip6_table_id': ip6_table_id,
3820                          'ip6_prefix': ip6_prefix,
3821                          'ip6_prefix_len': ip6_prefix_len,
3822                          'ip4_prefix': ip4_prefix,
3823                          'ip4_prefix_len': ip4_prefix_len,
3824                          'ip4_src': ip4_src,
3825                          'security_check': security_check})
3826
3827     def ipip_6rd_del_tunnel(self, sw_if_index):
3828         """ 6RD tunnel Delete """
3829         return self.api(self.papi.ipip_6rd_del_tunnel,
3830                         {'sw_if_index': sw_if_index})
3831
3832     def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
3833                         instance=0xFFFFFFFF, table_id=0, tc_tos=0):
3834         """ IPIP tunnel Add/Del """
3835         return self.api(self.papi.ipip_add_tunnel,
3836                         {'is_ipv6': is_ipv6,
3837                          'instance': instance,
3838                          'src_address': src_address,
3839                          'dst_address': dst_address,
3840                          'table_id': table_id,
3841                          'tc_tos': tc_tos})
3842
3843     def ipip_del_tunnel(self, sw_if_index):
3844         """ IPIP tunnel Delete """
3845         return self.api(self.papi.ipip_del_tunnel,
3846                         {'sw_if_index': sw_if_index})
3847
3848     def qos_egress_map_update(self, id, outputs):
3849         """ QOS egress map update """
3850         return self.api(self.papi.qos_egress_map_update,
3851                         {'map_id': id,
3852                          'rows': outputs})
3853
3854     def qos_egress_map_delete(self, id):
3855         """ QOS egress map delete """
3856         return self.api(self.papi.qos_egress_map_delete,
3857                         {'map_id': id})
3858
3859     def qos_mark_enable_disable(self, sw_if_index,
3860                                 output_source,
3861                                 map_id,
3862                                 enable):
3863         """ QOS Mark Enable/Disable """
3864         return self.api(self.papi.qos_mark_enable_disable,
3865                         {'map_id': map_id,
3866                          'sw_if_index': sw_if_index,
3867                          'output_source': output_source,
3868                          'enable': enable})
3869
3870     def qos_record_enable_disable(self, sw_if_index, input_source, enable):
3871         """ IP QoS recording Enble/Disable """
3872         return self.api(self.papi.qos_record_enable_disable,
3873                         {'sw_if_index': sw_if_index,
3874                          'input_source': input_source,
3875                          'enable': enable})
3876
3877     def igmp_enable_disable(self, sw_if_index, enable, host):
3878         """ Enable/disable IGMP on a given interface """
3879         return self.api(self.papi.igmp_enable_disable,
3880                         {'enable': enable,
3881                          'mode': host,
3882                          'sw_if_index': sw_if_index})
3883
3884     def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
3885         """ Add/del IGMP proxy device """
3886         return self.api(self.papi.igmp_proxy_device_add_del,
3887                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3888                          'add': add})
3889
3890     def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
3891         """ Add/del interface to/from IGMP proxy device """
3892         return self.api(self.papi.igmp_proxy_device_add_del_interface,
3893                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3894                          'add': add})
3895
3896     def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3897         """ Listen for new (S,G) on specified interface
3898
3899         :param enable: add/del
3900         :param sw_if_index: interface sw index
3901         :param saddr: source ip4 addr
3902         :param gaddr: group ip4 addr
3903         """
3904         return self.api(self.papi.igmp_listen,
3905                         {
3906                             'group':
3907                             {
3908                                 'filter': filter,
3909                                 'sw_if_index': sw_if_index,
3910                                 'n_srcs': len(saddrs),
3911                                 'saddrs': saddrs,
3912                                 'gaddr':  gaddr
3913                             }
3914                         })
3915
3916     def igmp_dump(self, sw_if_index=None):
3917         """ Dump all (S,G) interface configurations """
3918         if sw_if_index is None:
3919             sw_if_index = 0xffffffff
3920         return self.api(self.papi.igmp_dump,
3921                         {'sw_if_index': sw_if_index})
3922
3923     def igmp_clear_interface(self, sw_if_index):
3924         """ Remove all (S,G)s from specified interface
3925             doesn't send IGMP report!
3926         """
3927         return self.api(
3928             self.papi.igmp_clear_interface, {
3929                 'sw_if_index': sw_if_index})
3930
3931     def want_igmp_events(self, enable=1):
3932         return self.api(self.papi.want_igmp_events, {'enable': enable,
3933                                                      'pid': os.getpid()})
3934
3935     def bond_create(
3936             self,
3937             mode,
3938             lb,
3939             use_custom_mac,
3940             mac_address='',
3941             interface_id=0xFFFFFFFF):
3942         """
3943         :param mode: mode
3944         :param lb: load balance
3945         :param use_custom_mac: use custom mac
3946         :param mac_address: mac address
3947         :param interface_id: custom interface ID
3948         """
3949         return self.api(
3950             self.papi.bond_create,
3951             {'mode': mode,
3952              'lb': lb,
3953              'use_custom_mac': use_custom_mac,
3954              'mac_address': mac_address,
3955              'id': interface_id
3956              })
3957
3958     def bond_delete(
3959             self,
3960             sw_if_index):
3961         """
3962         :param sw_if_index: interface the operation is applied to
3963         """
3964         return self.api(self.papi.bond_delete,
3965                         {'sw_if_index': sw_if_index})
3966
3967     def bond_enslave(
3968             self,
3969             sw_if_index,
3970             bond_sw_if_index,
3971             is_passive,
3972             is_long_timeout):
3973         """
3974         :param sw_if_index: slave sw_if_index
3975         :param bond_sw_if_index: bond sw_if_index
3976         :param is_passive: is passive lacp speaker
3977         :param is_long_time: 90 seconds timeout instead of 3 seconds timeout
3978         """
3979         return self.api(
3980             self.papi.bond_enslave,
3981             {'sw_if_index': sw_if_index,
3982              'bond_sw_if_index': bond_sw_if_index,
3983              'is_passive': is_passive,
3984              'is_long_timeout': is_long_timeout
3985              })
3986
3987     def bond_detach_slave(
3988             self,
3989             sw_if_index):
3990         """
3991         :param sw_if_index: slave interface the operation is applied to
3992         """
3993         return self.api(self.papi.bond_detach_slave,
3994                         {'sw_if_index': sw_if_index})
3995
3996     def sw_interface_slave_dump(
3997             self,
3998             sw_if_index):
3999         """
4000         :param sw_if_index: bond sw_if_index
4001         """
4002         return self.api(self.papi.sw_interface_slave_dump,
4003                         {'sw_if_index': sw_if_index})
4004
4005     def sw_interface_bond_dump(
4006             self):
4007         """
4008
4009         """
4010         return self.api(self.papi.sw_interface_bond_dump,
4011                         {})
4012
4013     def create_vhost_user_if(
4014             self,
4015             is_server,
4016             sock_filename,
4017             renumber,
4018             disable_mrg_rxbuf,
4019             disable_indirect_desc,
4020             custom_dev_instance,
4021             use_custom_mac,
4022             mac_address,
4023             tag=''):
4024         """
4025         :param is_server: is server
4026         :param sock_filename: socket name
4027         :param renumber: renumber
4028         :param disable_mrg_rxbuf: disable mergable rx buffers
4029         :param disable_indirect_desc: disable indirect descriptors
4030         :param custom_dev_instance: custom dev instance
4031         :param use_custom_mac: use custom mac
4032         :param mac_address: mac address
4033         :param tag: tag (default '')
4034         """
4035         return self.api(
4036             self.papi.create_vhost_user_if,
4037             {'is_server': is_server,
4038              'sock_filename': sock_filename,
4039              'renumber': renumber,
4040              'disable_mrg_rxbuf': disable_mrg_rxbuf,
4041              'disable_indirect_desc': disable_indirect_desc,
4042              'custom_dev_instance': custom_dev_instance,
4043              'use_custom_mac': use_custom_mac,
4044              'mac_address': mac_address,
4045              'tag': tag
4046              })
4047
4048     def delete_vhost_user_if(
4049             self,
4050             sw_if_index):
4051         """
4052         :param sw_if_index: interface the operation is applied to
4053         """
4054         return self.api(self.papi.delete_vhost_user_if,
4055                         {'sw_if_index': sw_if_index, })
4056
4057     def sw_interface_vhost_user_dump(
4058             self):
4059         """
4060
4061         """
4062         return self.api(self.papi.sw_interface_vhost_user_dump,
4063                         {})
4064
4065     def abf_policy_add_del(self, is_add, policy):
4066         return self.api(
4067             self.papi.abf_policy_add_del,
4068             {'is_add': is_add,
4069              'policy': policy})
4070
4071     def abf_itf_attach_add_del(self, is_add, attach):
4072         return self.api(
4073             self.papi.abf_itf_attach_add_del,
4074             {'is_add': is_add,
4075              'attach': attach})
4076
4077     def abf_policy_dump(self):
4078         return self.api(
4079             self.papi.abf_policy_dump, {})
4080
4081     def abf_itf_attach_dump(self):
4082         return self.api(
4083             self.papi.abf_itf_attach_dump, {})
4084
4085     def pipe_create(self, is_specified, user_instance):
4086         return self.api(self.papi.pipe_create,
4087                         {'is_specified': is_specified,
4088                          'user_instance': user_instance})
4089
4090     def pipe_delete(self, parent_sw_if_index):
4091         return self.api(self.papi.pipe_delete,
4092                         {'parent_sw_if_index': parent_sw_if_index})
4093
4094     def pipe_dump(self):
4095         return self.api(self.papi.pipe_dump, {})
4096
4097     def memif_create(
4098             self,
4099             role,
4100             mode,
4101             rx_queues=None,
4102             tx_queues=None,
4103             _id=None,
4104             socket_id=None,
4105             secret=None,
4106             ring_size=None,
4107             buffer_size=None,
4108             hw_addr=None):
4109         return self.api(self.papi.memif_create,
4110                         {'role': role,
4111                          'mode': mode,
4112                          'rx_queues': rx_queues,
4113                          'tx_queues': tx_queues,
4114                          'id': _id,
4115                          'socket_id': socket_id,
4116                          'secret': secret,
4117                          'ring_size': ring_size,
4118                          'buffer_size': buffer_size,
4119                          'hw_addr': hw_addr})
4120
4121     def memif_delete(self, sw_if_index):
4122         return self.api(self.papi.memif_delete, {'sw_if_index': sw_if_index})
4123
4124     def memif_dump(self):
4125         return self.api(self.papi.memif_dump, {})
4126
4127     def memif_socket_filename_add_del(
4128             self, is_add, socket_id, socket_filename):
4129         return self.api(
4130             self.papi.memif_socket_filename_add_del,
4131             {'is_add': is_add,
4132              'socket_id': socket_id,
4133              'socket_filename': socket_filename})
4134
4135     def memif_socket_filename_dump(self):
4136         return self.api(self.papi.memif_socket_filename_dump, {})
4137
4138     def svs_table_add_del(self, af, table_id, is_add=1):
4139         return self.api(self.papi.svs_table_add_del,
4140                         {
4141                             'table_id': table_id,
4142                             'is_add': is_add,
4143                             'af': af,
4144                         })
4145
4146     def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
4147         return self.api(self.papi.svs_route_add_del,
4148                         {
4149                             'table_id': table_id,
4150                             'source_table_id': src_table_id,
4151                             'prefix': prefix,
4152                             'is_add': is_add,
4153                         })
4154
4155     def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
4156         return self.api(self.papi.svs_enable_disable,
4157                         {
4158                             'af': af,
4159                             'table_id': table_id,
4160                             'sw_if_index': sw_if_index,
4161                             'is_enable': is_enable,
4162                         })
4163
4164     def svs_dump(self):
4165         return self.api(self.papi.svs_dump, {})
4166
4167     def syslog_set_sender(
4168             self,
4169             collector,
4170             src,
4171             collector_port=514,
4172             vrf_id=0,
4173             max_msg_size=480):
4174         """Set syslog sender configuration
4175
4176         :param collector: colector IP address
4177         :param src: source IP address
4178         :param collector_port: collector UDP port (Default value = 514)
4179         :param vrf_id: VRF id (Default value = 0)
4180         :param max_msg_size: maximum message length (Default value = 480)
4181         """
4182         return self.api(self.papi.syslog_set_sender,
4183                         {'collector_address': collector,
4184                          'src_address': src,
4185                          'collector_port': collector_port,
4186                          'vrf_id': vrf_id,
4187                          'max_msg_size': max_msg_size})
4188
4189     def syslog_get_sender(self):
4190         """Return syslog sender configuration"""
4191         return self.api(self.papi.syslog_get_sender, {})
4192
4193     def syslog_set_filter(self, severity):
4194         """Set syslog filter parameters
4195
4196         :param severity: severity filter (specified severity and greater match)
4197         """
4198         return self.api(self.papi.syslog_set_filter, {'severity': severity})
4199
4200     def syslog_get_filter(self):
4201         """Return syslog filter parameters"""
4202         return self.api(self.papi.syslog_get_filter, {})