test/vpp_papi_provider.py

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