test/vpp_papi_provider.py

   1 # NB NB NB NB NB NB NB NB NB NB NB
   2 #
   3 # NOTE: The API binary wrappers in this file are in the process of being
   4 # deprecated. DO NOT ADD NEW WRAPPERS HERE. Call the functions using
   5 # named arguments directly instead.
   6 #
   7
   8 import os
   9 import time
  10 from collections import deque
  11
  12 from six import moves, iteritems
  13 from vpp_papi import VPPApiClient, mac_pton
  14 from hook import Hook
  15 from vpp_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID
  16
  17
  18 #
  19 # Dictionary keyed on message name to override default values for
  20 # named parameters
  21 #
  22 defaultmapping = {
  23     'map_add_domain': {'mtu': 1280},
  24     'syslog_set_sender': {'collector_port': 514,
  25                           'max_msg_size': 480},
  26     'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
  27     'acl_interface_list_dump': {'sw_if_index': 4294967295, },
  28     'app_namespace_add_del': {'sw_if_index': 4294967295, },
  29     'bd_ip_mac_add_del': {'is_add': 1, },
  30     'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
  31                                 'is_add': 1, },
  32     'bier_disp_table_add_del': {'is_add': 1, },
  33     'bier_imp_add': {'is_add': 1, },
  34     'bier_route_add_del': {'is_add': 1, },
  35     'bier_table_add_del': {'is_add': 1, },
  36     'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
  37                               'learn': 1, 'is_add': 1, },
  38     'bvi_create': {'user_instance': 4294967295, },
  39     'bvi_delete': {},
  40     'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
  41                                'nbuckets': 2, 'memory_size': 2097152,
  42                                'next_table_index': 4294967295,
  43                                'miss_next_index': 4294967295, },
  44     'dhcp6_client_enable_disable': {'enable': 1, },
  45     'dhcp6_clients_enable_disable': {'enable': 1, },
  46     'dhcp6_pd_client_enable_disable': {'enable': 1, },
  47     'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
  48     'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
  49     'dhcp_proxy_config': {'is_add': 1, },
  50     'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
  51     'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
  52     'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
  53                               'decap_next_index': 4294967295, },
  54     'gre_tunnel_add_del': {'instance': 4294967295, 'is_add': 1, },
  55     'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
  56                             'decap_next_index': 4294967295, },
  57     'input_acl_set_interface': {'ip4_table_index': 4294967295,
  58                                 'ip6_table_index': 4294967295,
  59                                 'l2_table_index': 4294967295, },
  60     'ip6_add_del_address_using_prefix': {'is_add': 1, },
  61     'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
  62     'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
  63                          'next_hop_weight': 1, 'next_hop_via_label': 1048576,
  64                          'next_hop_id': 4294967295,
  65                          'classify_table_index': 4294967295, 'is_add': 1, },
  66     'ip_mroute_add_del': {'is_add': 1, },
  67     'ip_neighbor_add_del': {'is_add': 1, },
  68     'ip_punt_police': {'is_add': 1, },
  69     'ip_punt_redirect': {'is_add': 1, },
  70     'ip_table_add_del': {'is_add': 1, },
  71     'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
  72     'ipip_add_tunnel': {'is_ipv6': 1, 'instance': 4294967295, },
  73     'ipsec_interface_add_del_spd': {'is_add': 1, },
  74     'ipsec_sad_entry_add_del': {'is_add': 1, },
  75     'ipsec_spd_add_del': {'is_add': 1, },
  76     'ipsec_spd_dump': {'sa_id': 4294967295, },
  77     'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
  78                                 'remote_port_stop': 65535, 'priority': 100,
  79                                 'is_outbound': 1,
  80                                 'is_add': 1, },
  81     'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
  82     'l2_emulation': {'enable': 1, },
  83     'l2fib_add_del': {'is_add': 1, },
  84     'lb_conf': {'sticky_buckets_per_core': 4294967295,
  85                 'flow_timeout': 4294967295},
  86     'lisp_add_del_adjacency': {'is_add': 1, },
  87     'lisp_add_del_local_eid': {'is_add': 1, },
  88     'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
  89     'lisp_add_del_locator_set': {'is_add': 1, },
  90     'lisp_add_del_remote_mapping': {'is_add': 1, },
  91     'macip_acl_add_replace': {'acl_index': 4294967295, },
  92     'macip_acl_dump': {'acl_index': 4294967295, },
  93     'macip_acl_interface_add_del': {'is_add': 1, },
  94     'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
  95     'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
  96                            'mr_next_hop_weight': 1,
  97                            'mr_next_hop_via_label': 1048576,
  98                            'mr_is_add': 1,
  99                            'mr_classify_table_index': 4294967295, },
 100     'mpls_table_add_del': {'is_add': 1, },
 101     'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
 102                             'next_hop_weight': 1,
 103                             'next_hop_via_label': 1048576,
 104                             'is_add': 1, },
 105     'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
 106     'output_acl_set_interface': {'ip4_table_index': 4294967295,
 107                                  'ip6_table_index': 4294967295,
 108                                  'l2_table_index': 4294967295, },
 109     'pppoe_add_del_session': {'is_add': 1, },
 110     'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
 111     'proxy_arp_add_del': {'is_add': 1, },
 112     'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
 113     'punt_socket_register': {'protocol': 17, 'header_version': 1,
 114                              'is_ip4': 1, },
 115     'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, },
 116     'punt_socket_dump': {'is_ip6': 1, },
 117     'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
 118                          'proto': 1, },
 119     'set_ipfix_exporter': {'collector_port': 4739, },
 120     'sr_localsid_add_del': {'sw_if_index': 4294967295, },
 121     'sr_policy_add': {'weight': 1, 'is_encap': 1, },
 122     'svs_enable_disable': {'is_enable': 1, },
 123     'svs_route_add_del': {'is_add': 1, },
 124     'svs_table_add_del': {'is_add': 1, },
 125     'sw_interface_add_del_address': {'is_add': 1, },
 126     'sw_interface_dump': {'sw_if_index': 4294967295, },
 127     'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
 128                                      'pref_lifetime': 4294967295, },
 129     'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
 130     'sw_interface_set_l2_bridge': {'enable': 1, },
 131     'sw_interface_set_mpls_enable': {'enable': 1, },
 132     'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
 133     'sw_interface_set_unnumbered': {'is_add': 1, },
 134     'sw_interface_span_enable_disable': {'state': 1, },
 135     'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 136                              'decap_next_index': 4294967295,
 137                              'instance': 4294967295, },
 138     'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 139                                  'instance': 4294967295, },
 140     'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
 141     'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 142                                  'protocol': 3, },
 143     'want_bfd_events': {'enable_disable': 1, },
 144     'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
 145     'want_dhcp6_reply_events': {'enable_disable': 1, },
 146     'want_igmp_events': {'enable': 1, },
 147     'want_interface_events': {'enable_disable': 1, },
 148     'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
 149     'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
 150     'want_ip6_ra_events': {'enable_disable': 1, },
 151     'want_l2_macs_events': {'enable_disable': 1, },
 152 }
 153
 154
 155 class CliFailedCommandError(Exception):
 156     """ cli command failed."""
 157
 158
 159 class CliSyntaxError(Exception):
 160     """ cli command had a syntax error."""
 161
 162
 163 class UnexpectedApiReturnValueError(Exception):
 164     """ exception raised when the API return value is unexpected """
 165     pass
 166
 167
 168 class VppPapiProvider(object):
 169     """VPP-api provider using vpp-papi
 170
 171     @property hook: hook object providing before and after api/cli hooks
 172     """
 173
 174     _zero, _negative = range(2)
 175
 176     def __init__(self, name, shm_prefix, test_class, read_timeout):
 177         self.hook = Hook(test_class)
 178         self.name = name
 179         self.shm_prefix = shm_prefix
 180         self.test_class = test_class
 181         self._expect_api_retval = self._zero
 182         self._expect_stack = []
 183
 184         # install_dir is a class attribute. We need to set it before
 185         # calling the constructor.
 186         VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
 187
 188         use_socket = False
 189         try:
 190             if os.environ['SOCKET'] == '1':
 191                 use_socket = True
 192         except KeyError:
 193             pass
 194
 195         self.vpp = VPPApiClient(logger=test_class.logger,
 196                                 read_timeout=read_timeout,
 197                                 use_socket=use_socket,
 198                                 server_address=test_class.api_sock)
 199         self._events = deque()
 200
 201     def __enter__(self):
 202         return self
 203
 204     def assert_negative_api_retval(self):
 205         """ Expect API failure - used with with, e.g.:
 206             with self.vapi.assert_negative_api_retval():
 207                 self.vapi.<api call expected to fail>
 208         """
 209         self._expect_stack.append(self._expect_api_retval)
 210         self._expect_api_retval = self._negative
 211         return self
 212
 213     def assert_zero_api_retval(self):
 214         """ Expect API success - used with with, e.g.:
 215             with self.vapi.assert_negative_api_retval():
 216                 self.vapi.<api call expected to succeed>
 217
 218             note: this is useful only inside another with block
 219                   as success is the default expected value
 220         """
 221         self._expect_stack.append(self._expect_api_retval)
 222         self._expect_api_retval = self._zero
 223         return self
 224
 225     def __exit__(self, exc_type, exc_value, traceback):
 226         self._expect_api_retval = self._expect_stack.pop()
 227
 228     def register_hook(self, hook):
 229         """Replace hook registration with new hook
 230
 231         :param hook:
 232
 233         """
 234         self.hook = hook
 235
 236     def collect_events(self):
 237         """ Collect all events from the internal queue and clear the queue. """
 238         e = self._events
 239         self._events = deque()
 240         return e
 241
 242     def wait_for_event(self, timeout, name=None):
 243         """ Wait for and return next event. """
 244         if name:
 245             self.test_class.logger.debug("Expecting event '%s' within %ss",
 246                                          name, timeout)
 247         else:
 248             self.test_class.logger.debug("Expecting event within %ss",
 249                                          timeout)
 250         if self._events:
 251             self.test_class.logger.debug("Not waiting, event already queued")
 252         limit = time.time() + timeout
 253         while time.time() < limit:
 254             if self._events:
 255                 e = self._events.popleft()
 256                 if name and type(e).__name__ != name:
 257                     raise Exception(
 258                         "Unexpected event received: %s, expected: %s" %
 259                         (type(e).__name__, name))
 260                 self.test_class.logger.debug("Returning event %s:%s" %
 261                                              (name, e))
 262                 return e
 263             self.test_class.sleep(0)  # yield
 264         raise Exception("Event did not occur within timeout")
 265
 266     def __call__(self, name, event):
 267         """ Enqueue event in the internal event queue. """
 268         # FIXME use the name instead of relying on type(e).__name__ ?
 269         # FIXME #2 if this throws, it is eaten silently, Ole?
 270         self.test_class.logger.debug("New event: %s: %s" % (name, event))
 271         self._events.append(event)
 272
 273     def factory(self, name, apifn):
 274         def f(*a, **ka):
 275             fields = apifn._func.msg.fields
 276
 277             # add positional and kw arguments
 278             d = ka
 279             for i, o in enumerate(fields[3:]):
 280                 try:
 281                     d[o] = a[i]
 282                 except:
 283                     break
 284
 285             # Default override
 286             if name in defaultmapping:
 287                 for k, v in iteritems(defaultmapping[name]):
 288                     if k in d:
 289                         continue
 290                     d[k] = v
 291             return self.api(apifn, d)
 292
 293         return f
 294
 295     def __getattribute__(self, name):
 296         try:
 297             method = super(VppPapiProvider, self).__getattribute__(name)
 298         except AttributeError:
 299             method = self.factory(name, getattr(self.papi, name))
 300             # lazily load the method so we don't need to call factory
 301             # again for this name.
 302             setattr(self, name, method)
 303         return method
 304
 305     def connect(self):
 306         """Connect the API to VPP"""
 307         self.vpp.connect(self.name, self.shm_prefix)
 308         self.papi = self.vpp.api
 309         self.vpp.register_event_callback(self)
 310
 311     def disconnect(self):
 312         """Disconnect the API from VPP"""
 313         self.vpp.disconnect()
 314
 315     def api(self, api_fn, api_args, expected_retval=0):
 316         """ Call API function and check it's return value.
 317         Call the appropriate hooks before and after the API call
 318
 319         :param api_fn: API function to call
 320         :param api_args: tuple of API function arguments
 321         :param expected_retval: Expected return value (Default value = 0)
 322         :returns: reply from the API
 323
 324         """
 325         self.hook.before_api(api_fn.__name__, api_args)
 326         reply = api_fn(**api_args)
 327         if self._expect_api_retval == self._negative:
 328             if hasattr(reply, 'retval') and reply.retval >= 0:
 329                 msg = "API call passed unexpectedly: expected negative " \
 330                       "return value instead of %d in %s" % \
 331                       (reply.retval, moves.reprlib.repr(reply))
 332                 self.test_class.logger.info(msg)
 333                 raise UnexpectedApiReturnValueError(msg)
 334         elif self._expect_api_retval == self._zero:
 335             if hasattr(reply, 'retval') and reply.retval != expected_retval:
 336                 msg = "API call failed, expected %d return value instead " \
 337                       "of %d in %s" % (expected_retval, reply.retval,
 338                                        moves.reprlib.repr(reply))
 339                 self.test_class.logger.info(msg)
 340                 raise UnexpectedApiReturnValueError(msg)
 341         else:
 342             raise Exception("Internal error, unexpected value for "
 343                             "self._expect_api_retval %s" %
 344                             self._expect_api_retval)
 345         self.hook.after_api(api_fn.__name__, api_args)
 346         return reply
 347
 348     def cli(self, cli):
 349         """ Execute a CLI, calling the before/after hooks appropriately.
 350
 351         :param cli: CLI to execute
 352         :returns: CLI output
 353
 354         """
 355         self.hook.before_cli(cli)
 356         cli += '\n'
 357         r = self.papi.cli_inband(cmd=cli)
 358         self.hook.after_cli(cli)
 359         if r.retval == -156:
 360             raise CliSyntaxError(r.reply)
 361         if r.retval != 0:
 362             raise CliFailedCommandError(r.reply)
 363         if hasattr(r, 'reply'):
 364             return r.reply
 365
 366     def ppcli(self, cli):
 367         """ Helper method to print CLI command in case of info logging level.
 368
 369         :param cli: CLI to execute
 370         :returns: CLI output
 371         """
 372         return cli + "\n" + str(self.cli(cli))
 373
 374     def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
 375         return self.api(self.papi.want_ip4_arp_events,
 376                         {'enable_disable': enable_disable,
 377                          'ip': ip,
 378                          'pid': os.getpid(), })
 379
 380     def want_ip6_nd_events(self, enable_disable=1, ip="::"):
 381         return self.api(self.papi.want_ip6_nd_events,
 382                         {'enable_disable': enable_disable,
 383                          'ip': ip,
 384                          'pid': os.getpid(), })
 385
 386     def want_ip6_ra_events(self, enable_disable=1):
 387         return self.api(self.papi.want_ip6_ra_events,
 388                         {'enable_disable': enable_disable,
 389                          'pid': os.getpid(), })
 390
 391     def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
 392                                        mrc=0, mrd=0):
 393         return self.api(self.papi.ip6nd_send_router_solicitation,
 394                         {'irt': irt,
 395                          'mrt': mrt,
 396                          'mrc': mrc,
 397                          'mrd': mrd,
 398                          'sw_if_index': sw_if_index})
 399
 400     def want_interface_events(self, enable_disable=1):
 401         return self.api(self.papi.want_interface_events,
 402                         {'enable_disable': enable_disable,
 403                          'pid': os.getpid(), })
 404
 405     def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
 406                             max_macs_in_event=0, learn_limit=0):
 407         return self.api(self.papi.want_l2_macs_events,
 408                         {'enable_disable': enable_disable,
 409                          'scan_delay': scan_delay,
 410                          'max_macs_in_event': max_macs_in_event,
 411                          'learn_limit': learn_limit,
 412                          'pid': os.getpid(), })
 413
 414     def want_dhcp6_reply_events(self, enable_disable=1):
 415         return self.api(self.papi.want_dhcp6_reply_events,
 416                         {'enable_disable': enable_disable,
 417                          'pid': os.getpid()})
 418
 419     def want_dhcp6_pd_reply_events(self, enable_disable=1):
 420         return self.api(self.papi.want_dhcp6_pd_reply_events,
 421                         {'enable_disable': enable_disable,
 422                          'pid': os.getpid()})
 423
 424     def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
 425                                      prefixes, server_index=0xFFFFFFFF,
 426                                      irt=0, mrt=0, mrc=1, mrd=0, stop=0,
 427                                      ):
 428         return self.api(self.papi.dhcp6_pd_send_client_message,
 429                         {'sw_if_index': sw_if_index,
 430                          'server_index': server_index,
 431                          'irt': irt,
 432                          'mrt': mrt,
 433                          'mrc': mrc,
 434                          'mrd': mrd,
 435                          'stop': stop,
 436                          'msg_type': msg_type,
 437                          'T1': T1,
 438                          'T2': T2,
 439                          'n_prefixes': len(prefixes),
 440                          'prefixes': prefixes})
 441
 442     def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
 443                                     enable=1):
 444         return self.api(self.papi.dhcp6_client_enable_disable,
 445                         {'sw_if_index': sw_if_index,
 446                          'enable': enable})
 447
 448     def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
 449                                        enable=1):
 450         return self.api(self.papi.dhcp6_pd_client_enable_disable,
 451                         {'sw_if_index': sw_if_index,
 452                          'prefix_group': prefix_group,
 453                          'enable': enable})
 454
 455     def ip6_add_del_address_using_prefix(self, sw_if_index, address,
 456                                          prefix_length, prefix_group,
 457                                          is_add=1):
 458         return self.api(self.papi.ip6_add_del_address_using_prefix,
 459                         {'sw_if_index': sw_if_index,
 460                          'prefix_group': prefix_group,
 461                          'address': address,
 462                          'prefix_length': prefix_length,
 463                          'is_add': is_add})
 464
 465     def sw_interface_set_mac_address(self, sw_if_index, mac):
 466         return self.api(self.papi.sw_interface_set_mac_address,
 467                         {'sw_if_index': sw_if_index,
 468                          'mac_address': mac})
 469
 470     def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
 471         """Create p2p ethernet subinterface
 472
 473         :param sw_if_index: main (parent) interface
 474         :param remote_mac: client (remote) mac address
 475
 476         """
 477         return self.api(
 478             self.papi.p2p_ethernet_add,
 479             {'parent_if_index': sw_if_index,
 480              'remote_mac': remote_mac,
 481              'subif_id': subif_id})
 482
 483     def p2p_ethernet_del(self, sw_if_index, remote_mac):
 484         """Delete p2p ethernet subinterface
 485
 486         :param sw_if_index: main (parent) interface
 487         :param remote_mac: client (remote) mac address
 488
 489         """
 490         return self.api(
 491             self.papi.p2p_ethernet_del,
 492             {'parent_if_index': sw_if_index,
 493              'remote_mac': remote_mac})
 494
 495     def create_vlan_subif(self, sw_if_index, vlan):
 496         """
 497
 498         :param vlan:
 499         :param sw_if_index:
 500
 501         """
 502         return self.api(self.papi.create_vlan_subif,
 503                         {'sw_if_index': sw_if_index,
 504                          'vlan_id': vlan})
 505
 506     def create_loopback(self, mac=''):
 507         """
 508
 509         :param mac: (Optional)
 510         """
 511         return self.api(self.papi.create_loopback,
 512                         {'mac_address': mac})
 513
 514     def ip_neighbor_add_del(self,
 515                             sw_if_index,
 516                             mac_address,
 517                             ip_address,
 518                             is_add=1,
 519                             flags=0):
 520         """ Add neighbor MAC to IPv4 or IPv6 address.
 521
 522         :param sw_if_index:
 523         :param mac_address:
 524         :param dst_address:
 525         :param is_add:  (Default value = 1)
 526         :param flags:  (Default value = 0/NONE)
 527         """
 528         return self.api(
 529             self.papi.ip_neighbor_add_del,
 530             {
 531                 'is_add': is_add,
 532                 'neighbor': {
 533                     'sw_if_index': sw_if_index,
 534                     'flags': flags,
 535                     'mac_address': mac_address,
 536                     'ip_address': ip_address
 537                 }
 538             }
 539         )
 540
 541     def proxy_arp_add_del(self,
 542                           low,
 543                           hi,
 544                           table_id=0,
 545                           is_add=1):
 546         """ Config Proxy Arp Range.
 547
 548         :param low_address: Start address in the rnage to Proxy for
 549         :param hi_address: End address in the rnage to Proxy for
 550         :param vrf_id: The VRF/table in which to proxy
 551         """
 552
 553         return self.api(
 554             self.papi.proxy_arp_add_del,
 555             {'proxy':
 556                 {
 557                     'table_id': table_id,
 558                     'low': low,
 559                     'hi': hi,
 560                 },
 561                 'is_add': is_add})
 562
 563     def proxy_arp_intfc_enable_disable(self,
 564                                        sw_if_index,
 565                                        is_enable=1):
 566         """ Enable/Disable an interface for proxy ARP requests
 567
 568         :param sw_if_index: Interface
 569         :param enable_disable: Enable/Disable
 570         """
 571
 572         return self.api(
 573             self.papi.proxy_arp_intfc_enable_disable,
 574             {'sw_if_index': sw_if_index,
 575              'enable_disable': is_enable
 576              }
 577         )
 578
 579     def gre_tunnel_add_del(self,
 580                            src,
 581                            dst,
 582                            outer_fib_id=0,
 583                            tunnel_type=0,
 584                            instance=0xFFFFFFFF,
 585                            session_id=0,
 586                            is_add=1):
 587         """ Add a GRE tunnel
 588
 589         :param src_address:
 590         :param dst_address:
 591         :param outer_fib_id:  (Default value = 0)
 592         :param tunnel_type:  (Default value = 0)
 593         :param instance:  (Default value = 0xFFFFFFFF)
 594         :param session_id: (Default value = 0)
 595         :param is_add:  (Default value = 1)
 596         :param is_ipv6:  (Default value = 0)
 597         """
 598
 599         return self.api(
 600             self.papi.gre_tunnel_add_del,
 601             {'is_add': is_add,
 602              'tunnel':
 603              {
 604                  'type': tunnel_type,
 605                  'instance': instance,
 606                  'src': src,
 607                  'dst': dst,
 608                  'outer_fib_id': outer_fib_id,
 609                  'session_id': session_id}
 610              }
 611         )
 612
 613     def udp_encap_add(self,
 614                       src_ip,
 615                       dst_ip,
 616                       src_port,
 617                       dst_port,
 618                       table_id=0):
 619         """ Add a GRE tunnel
 620         :param src_ip:
 621         :param dst_ip:
 622         :param src_port:
 623         :param dst_port:
 624         :param outer_fib_id:  (Default value = 0)
 625         """
 626
 627         return self.api(
 628             self.papi.udp_encap_add,
 629             {
 630                 'udp_encap': {
 631                     'src_ip': src_ip,
 632                     'dst_ip': dst_ip,
 633                     'src_port': src_port,
 634                     'dst_port': dst_port,
 635                     'table_id': table_id
 636                 }
 637             })
 638
 639     def mpls_table_add_del(
 640             self,
 641             table_id,
 642             is_add=1):
 643         """
 644
 645         :param table_id
 646         :param is_add:  (Default value = 1)
 647
 648         """
 649
 650         return self.api(
 651             self.papi.mpls_table_add_del,
 652             {'mt_table_id': table_id,
 653              'mt_is_add': is_add})
 654
 655     def mpls_ip_bind_unbind(
 656             self,
 657             label,
 658             dst_address,
 659             dst_address_length,
 660             table_id=0,
 661             ip_table_id=0,
 662             is_ip4=1,
 663             is_bind=1):
 664         """
 665         """
 666         return self.api(
 667             self.papi.mpls_ip_bind_unbind,
 668             {'mb_mpls_table_id': table_id,
 669              'mb_label': label,
 670              'mb_ip_table_id': ip_table_id,
 671              'mb_is_bind': is_bind,
 672              'mb_is_ip4': is_ip4,
 673              'mb_address_length': dst_address_length,
 674              'mb_address': dst_address})
 675
 676     def mpls_tunnel_add_del(
 677             self,
 678             tun_sw_if_index,
 679             next_hop_proto_is_ip4,
 680             next_hop_address,
 681             next_hop_sw_if_index=0xFFFFFFFF,
 682             next_hop_table_id=0,
 683             next_hop_weight=1,
 684             next_hop_n_out_labels=0,
 685             next_hop_out_label_stack=[],
 686             next_hop_via_label=MPLS_LABEL_INVALID,
 687             is_add=1,
 688             l2_only=0,
 689             is_multicast=0):
 690         """
 691
 692         :param dst_address_length:
 693         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 694         :param dst_address:
 695         :param next_hop_address:
 696         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 697         :param vrf_id:  (Default value = 0)
 698         :param lookup_in_vrf:  (Default value = 0)
 699         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 700         :param is_add:  (Default value = 1)
 701         :param is_drop:  (Default value = 0)
 702         :param is_ipv6:  (Default value = 0)
 703         :param is_local:  (Default value = 0)
 704         :param is_classify:  (Default value = 0)
 705         :param is_multipath:  (Default value = 0)
 706         :param is_resolve_host:  (Default value = 0)
 707         :param is_resolve_attached:  (Default value = 0)
 708         :param next_hop_weight:  (Default value = 1)
 709         :param is_multicast:  (Default value = 0)
 710
 711         """
 712         return self.api(
 713             self.papi.mpls_tunnel_add_del,
 714             {'mt_sw_if_index': tun_sw_if_index,
 715              'mt_is_add': is_add,
 716              'mt_l2_only': l2_only,
 717              'mt_is_multicast': is_multicast,
 718              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
 719              'mt_next_hop_weight': next_hop_weight,
 720              'mt_next_hop': next_hop_address,
 721              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
 722              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
 723              'mt_next_hop_table_id': next_hop_table_id,
 724              'mt_next_hop_via_label': next_hop_via_label,
 725              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
 726
 727     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
 728                     detect_mult, local_addr, peer_addr, is_ipv6=0,
 729                     bfd_key_id=None, conf_key_id=None):
 730         if bfd_key_id is None:
 731             return self.api(self.papi.bfd_udp_add,
 732                             {
 733                                 'sw_if_index': sw_if_index,
 734                                 'desired_min_tx': desired_min_tx,
 735                                 'required_min_rx': required_min_rx,
 736                                 'local_addr': local_addr,
 737                                 'peer_addr': peer_addr,
 738                                 'is_ipv6': is_ipv6,
 739                                 'detect_mult': detect_mult,
 740                             })
 741         else:
 742             return self.api(self.papi.bfd_udp_add,
 743                             {
 744                                 'sw_if_index': sw_if_index,
 745                                 'desired_min_tx': desired_min_tx,
 746                                 'required_min_rx': required_min_rx,
 747                                 'local_addr': local_addr,
 748                                 'peer_addr': peer_addr,
 749                                 'is_ipv6': is_ipv6,
 750                                 'detect_mult': detect_mult,
 751                                 'is_authenticated': 1,
 752                                 'bfd_key_id': bfd_key_id,
 753                                 'conf_key_id': conf_key_id,
 754                             })
 755
 756     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
 757                     detect_mult, local_addr, peer_addr, is_ipv6=0):
 758         return self.api(self.papi.bfd_udp_mod,
 759                         {
 760                             'sw_if_index': sw_if_index,
 761                             'desired_min_tx': desired_min_tx,
 762                             'required_min_rx': required_min_rx,
 763                             'local_addr': local_addr,
 764                             'peer_addr': peer_addr,
 765                             'is_ipv6': is_ipv6,
 766                             'detect_mult': detect_mult,
 767                         })
 768
 769     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
 770                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
 771                               is_delayed=False):
 772         return self.api(self.papi.bfd_udp_auth_activate,
 773                         {
 774                             'sw_if_index': sw_if_index,
 775                             'local_addr': local_addr,
 776                             'peer_addr': peer_addr,
 777                             'is_ipv6': is_ipv6,
 778                             'is_delayed': 1 if is_delayed else 0,
 779                             'bfd_key_id': bfd_key_id,
 780                             'conf_key_id': conf_key_id,
 781                         })
 782
 783     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
 784                                   peer_addr, is_ipv6=0):
 785         return self.api(self.papi.bfd_udp_session_set_flags, {
 786             'admin_up_down': admin_up_down,
 787             'sw_if_index': sw_if_index,
 788             'local_addr': local_addr,
 789             'peer_addr': peer_addr,
 790             'is_ipv6': is_ipv6,
 791         })
 792
 793     def want_bfd_events(self, enable_disable=1):
 794         return self.api(self.papi.want_bfd_events, {
 795             'enable_disable': enable_disable,
 796             'pid': os.getpid(),
 797         })
 798
 799     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
 800         return self.api(self.papi.bfd_auth_set_key, {
 801             'conf_key_id': conf_key_id,
 802             'auth_type': auth_type,
 803             'key': key,
 804             'key_len': len(key),
 805         })
 806
 807     def classify_add_del_table(
 808             self,
 809             is_add,
 810             mask,
 811             match_n_vectors=1,
 812             table_index=0xFFFFFFFF,
 813             nbuckets=2,
 814             memory_size=2097152,
 815             skip_n_vectors=0,
 816             next_table_index=0xFFFFFFFF,
 817             miss_next_index=0xFFFFFFFF,
 818             current_data_flag=0,
 819             current_data_offset=0):
 820         """
 821         :param is_add:
 822         :param mask:
 823         :param match_n_vectors: (Default value = 1)
 824         :param table_index: (Default value = 0xFFFFFFFF)
 825         :param nbuckets:  (Default value = 2)
 826         :param memory_size:  (Default value = 2097152)
 827         :param skip_n_vectors:  (Default value = 0)
 828         :param next_table_index:  (Default value = 0xFFFFFFFF)
 829         :param miss_next_index:  (Default value = 0xFFFFFFFF)
 830         :param current_data_flag:  (Default value = 0)
 831         :param current_data_offset:  (Default value = 0)
 832         """
 833
 834         mask_len = ((len(mask) - 1) / 16 + 1) * 16
 835         mask = mask + '\0' * (mask_len - len(mask))
 836         return self.api(
 837             self.papi.classify_add_del_table,
 838             {'is_add': is_add,
 839              'table_index': table_index,
 840              'nbuckets': nbuckets,
 841              'memory_size': memory_size,
 842              'skip_n_vectors': skip_n_vectors,
 843              'match_n_vectors': match_n_vectors,
 844              'next_table_index': next_table_index,
 845              'miss_next_index': miss_next_index,
 846              'current_data_flag': current_data_flag,
 847              'current_data_offset': current_data_offset,
 848              'mask_len': mask_len,
 849              'mask': mask})
 850
 851     def classify_add_del_session(
 852             self,
 853             is_add,
 854             table_index,
 855             match,
 856             opaque_index=0xFFFFFFFF,
 857             hit_next_index=0xFFFFFFFF,
 858             advance=0,
 859             action=0,
 860             metadata=0):
 861         """
 862         :param is_add:
 863         :param table_index:
 864         :param match:
 865         :param opaque_index:  (Default value = 0xFFFFFFFF)
 866         :param hit_next_index:  (Default value = 0xFFFFFFFF)
 867         :param advance:  (Default value = 0)
 868         :param action:  (Default value = 0)
 869         :param metadata:  (Default value = 0)
 870         """
 871
 872         match_len = ((len(match) - 1) / 16 + 1) * 16
 873         match = match + '\0' * (match_len - len(match))
 874         return self.api(
 875             self.papi.classify_add_del_session,
 876             {'is_add': is_add,
 877              'table_index': table_index,
 878              'hit_next_index': hit_next_index,
 879              'opaque_index': opaque_index,
 880              'advance': advance,
 881              'action': action,
 882              'metadata': metadata,
 883              'match_len': match_len,
 884              'match': match})
 885
 886     def input_acl_set_interface(
 887             self,
 888             is_add,
 889             sw_if_index,
 890             ip4_table_index=0xFFFFFFFF,
 891             ip6_table_index=0xFFFFFFFF,
 892             l2_table_index=0xFFFFFFFF):
 893         """
 894         :param is_add:
 895         :param sw_if_index:
 896         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
 897         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
 898         :param l2_table_index:  (Default value = 0xFFFFFFFF)
 899         """
 900
 901         return self.api(
 902             self.papi.input_acl_set_interface,
 903             {'sw_if_index': sw_if_index,
 904              'ip4_table_index': ip4_table_index,
 905              'ip6_table_index': ip6_table_index,
 906              'l2_table_index': l2_table_index,
 907              'is_add': is_add})
 908
 909     def output_acl_set_interface(
 910             self,
 911             is_add,
 912             sw_if_index,
 913             ip4_table_index=0xFFFFFFFF,
 914             ip6_table_index=0xFFFFFFFF,
 915             l2_table_index=0xFFFFFFFF):
 916         """
 917         :param is_add:
 918         :param sw_if_index:
 919         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
 920         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
 921         :param l2_table_index:  (Default value = 0xFFFFFFFF)
 922         """
 923
 924         return self.api(
 925             self.papi.output_acl_set_interface,
 926             {'sw_if_index': sw_if_index,
 927              'ip4_table_index': ip4_table_index,
 928              'ip6_table_index': ip6_table_index,
 929              'l2_table_index': l2_table_index,
 930              'is_add': is_add})
 931
 932     def set_ipfix_exporter(
 933             self,
 934             collector_address,
 935             src_address,
 936             path_mtu,
 937             template_interval,
 938             vrf_id=0,
 939             collector_port=4739,
 940             udp_checksum=0):
 941         return self.api(
 942             self.papi.set_ipfix_exporter,
 943             {
 944                 'collector_address': collector_address,
 945                 'collector_port': collector_port,
 946                 'src_address': src_address,
 947                 'vrf_id': vrf_id,
 948                 'path_mtu': path_mtu,
 949                 'template_interval': template_interval,
 950                 'udp_checksum': udp_checksum,
 951             })
 952
 953     def dhcp_proxy_config(self,
 954                           dhcp_server,
 955                           dhcp_src_address,
 956                           rx_table_id=0,
 957                           server_table_id=0,
 958                           is_add=1,
 959                           is_ipv6=0):
 960         return self.api(
 961             self.papi.dhcp_proxy_config,
 962             {
 963                 'rx_vrf_id': rx_table_id,
 964                 'server_vrf_id': server_table_id,
 965                 'is_ipv6': is_ipv6,
 966                 'is_add': is_add,
 967                 'dhcp_server': dhcp_server,
 968                 'dhcp_src_address': dhcp_src_address,
 969             })
 970
 971     def dhcp_proxy_set_vss(self,
 972                            table_id,
 973                            vss_type=255,
 974                            vpn_ascii_id="",
 975                            oui=0,
 976                            vpn_index=0,
 977                            is_add=1,
 978                            is_ip6=0):
 979         return self.api(
 980             self.papi.dhcp_proxy_set_vss,
 981             {
 982                 'tbl_id': table_id,
 983                 'vss_type': vss_type,
 984                 'vpn_ascii_id': vpn_ascii_id,
 985                 'oui': oui,
 986                 'vpn_index': vpn_index,
 987                 'is_add': is_add,
 988                 'is_ipv6': is_ip6,
 989             })
 990
 991     def dhcp_client_config(self,
 992                            sw_if_index,
 993                            hostname,
 994                            client_id='',
 995                            is_add=1,
 996                            set_broadcast_flag=1,
 997                            want_dhcp_events=0):
 998         return self.api(
 999             self.papi.dhcp_client_config,
1000             {
1001                 'is_add': is_add,
1002                 'client': {
1003                     'sw_if_index': sw_if_index,
1004                     'hostname': hostname,
1005                     'id': client_id,
1006                     'want_dhcp_event': want_dhcp_events,
1007                     'set_broadcast_flag': set_broadcast_flag,
1008                     'pid': os.getpid()}
1009             })
1010
1011     def ip_mroute_add_del(self,
1012                           src_address,
1013                           grp_address,
1014                           grp_address_length,
1015                           e_flags,
1016                           next_hop_afi,
1017                           next_hop_sw_if_index,
1018                           next_hop_address,
1019                           i_flags,
1020                           bier_imp=0,
1021                           rpf_id=0,
1022                           table_id=0,
1023                           is_add=1,
1024                           is_ipv6=0,
1025                           is_local=0):
1026         """
1027         IP Multicast Route add/del
1028         """
1029         return self.api(
1030             self.papi.ip_mroute_add_del,
1031             {'next_hop_sw_if_index': next_hop_sw_if_index,
1032              'entry_flags': e_flags,
1033              'itf_flags': i_flags,
1034              'table_id': table_id,
1035              'rpf_id': rpf_id,
1036              'is_add': is_add,
1037              'is_ipv6': is_ipv6,
1038              'is_local': is_local,
1039              'bier_imp': bier_imp,
1040              'next_hop_afi': next_hop_afi,
1041              'grp_address_length': grp_address_length,
1042              'grp_address': grp_address,
1043              'src_address': src_address,
1044              'nh_address': next_hop_address})
1045
1046     def lisp_enable_disable(self, is_enabled):
1047         return self.api(
1048             self.papi.lisp_enable_disable,
1049             {
1050                 'is_en': is_enabled,
1051             })
1052
1053     def lisp_add_del_locator_set(self,
1054                                  ls_name,
1055                                  is_add=1):
1056         return self.api(
1057             self.papi.lisp_add_del_locator_set,
1058             {
1059                 'is_add': is_add,
1060                 'locator_set_name': ls_name
1061             })
1062
1063     def lisp_add_del_locator(self,
1064                              ls_name,
1065                              sw_if_index,
1066                              priority=1,
1067                              weight=1,
1068                              is_add=1):
1069         return self.api(
1070             self.papi.lisp_add_del_locator,
1071             {
1072                 'is_add': is_add,
1073                 'locator_set_name': ls_name,
1074                 'sw_if_index': sw_if_index,
1075                 'priority': priority,
1076                 'weight': weight
1077             })
1078
1079     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1080         return self.api(
1081             self.papi.lisp_locator_dump,
1082             {
1083                 'is_index_set': is_index_set,
1084                 'ls_name': ls_name,
1085                 'ls_index': ls_index,
1086             })
1087
1088     def lisp_add_del_local_eid(self,
1089                                ls_name,
1090                                eid_type,
1091                                eid,
1092                                prefix_len,
1093                                vni=0,
1094                                key_id=0,
1095                                key="",
1096                                is_add=1):
1097         return self.api(
1098             self.papi.lisp_add_del_local_eid,
1099             {
1100                 'locator_set_name': ls_name,
1101                 'is_add': is_add,
1102                 'eid_type': eid_type,
1103                 'eid': eid,
1104                 'prefix_len': prefix_len,
1105                 'vni': vni,
1106                 'key_id': key_id,
1107                 'key': key
1108             })
1109
1110     def lisp_eid_table_dump(self,
1111                             eid_set=0,
1112                             prefix_length=0,
1113                             vni=0,
1114                             eid_type=0,
1115                             eid=None,
1116                             filter_opt=0):
1117         return self.api(
1118             self.papi.lisp_eid_table_dump,
1119             {
1120                 'eid_set': eid_set,
1121                 'prefix_length': prefix_length,
1122                 'vni': vni,
1123                 'eid_type': eid_type,
1124                 'eid': eid,
1125                 'filter': filter_opt,
1126             })
1127
1128     def lisp_add_del_remote_mapping(self,
1129                                     eid_type,
1130                                     eid,
1131                                     eid_prefix_len=0,
1132                                     vni=0,
1133                                     rlocs=[],
1134                                     rlocs_num=0,
1135                                     is_src_dst=0,
1136                                     is_add=1):
1137         return self.api(
1138             self.papi.lisp_add_del_remote_mapping,
1139             {
1140                 'is_add': is_add,
1141                 'eid_type': eid_type,
1142                 'eid': eid,
1143                 'eid_len': eid_prefix_len,
1144                 'rloc_num': rlocs_num,
1145                 'rlocs': rlocs,
1146                 'vni': vni,
1147                 'is_src_dst': is_src_dst,
1148             })
1149
1150     def lisp_add_del_adjacency(self,
1151                                leid,
1152                                reid,
1153                                leid_len,
1154                                reid_len,
1155                                eid_type,
1156                                is_add=1,
1157                                vni=0):
1158         return self.api(
1159             self.papi.lisp_add_del_adjacency,
1160             {
1161                 'is_add': is_add,
1162                 'vni': vni,
1163                 'eid_type': eid_type,
1164                 'leid': leid,
1165                 'reid': reid,
1166                 'leid_len': leid_len,
1167                 'reid_len': reid_len,
1168             })
1169
1170     def gtpu_add_del_tunnel(
1171             self,
1172             src_addr,
1173             dst_addr,
1174             is_add=1,
1175             is_ipv6=0,
1176             mcast_sw_if_index=0xFFFFFFFF,
1177             encap_vrf_id=0,
1178             decap_next_index=0xFFFFFFFF,
1179             teid=0):
1180         """
1181
1182         :param is_add:  (Default value = 1)
1183         :param is_ipv6:  (Default value = 0)
1184         :param src_addr:
1185         :param dst_addr:
1186         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
1187         :param encap_vrf_id:  (Default value = 0)
1188         :param decap_next_index:  (Default value = 0xFFFFFFFF)
1189         :param teid:  (Default value = 0)
1190
1191         """
1192         return self.api(self.papi.gtpu_add_del_tunnel,
1193                         {'is_add': is_add,
1194                          'is_ipv6': is_ipv6,
1195                          'src_address': src_addr,
1196                          'dst_address': dst_addr,
1197                          'mcast_sw_if_index': mcast_sw_if_index,
1198                          'encap_vrf_id': encap_vrf_id,
1199                          'decap_next_index': decap_next_index,
1200                          'teid': teid})
1201
1202     def vxlan_gpe_add_del_tunnel(
1203             self,
1204             src_addr,
1205             dst_addr,
1206             mcast_sw_if_index=0xFFFFFFFF,
1207             is_add=1,
1208             is_ipv6=0,
1209             encap_vrf_id=0,
1210             decap_vrf_id=0,
1211             protocol=3,
1212             vni=0):
1213         """
1214
1215         :param local:
1216         :param remote:
1217         :param is_add:  (Default value = 1)
1218         :param is_ipv6:  (Default value = 0)
1219         :param encap_vrf_id:  (Default value = 0)
1220         :param decap_vrf_id:  (Default value = 0)
1221         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
1222         :param protocol:  (Default value = 3)
1223         :param vni:  (Default value = 0)
1224
1225         """
1226         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1227                         {'is_add': is_add,
1228                          'is_ipv6': is_ipv6,
1229                          'local': src_addr,
1230                          'remote': dst_addr,
1231                          'mcast_sw_if_index': mcast_sw_if_index,
1232                          'encap_vrf_id': encap_vrf_id,
1233                          'decap_vrf_id': decap_vrf_id,
1234                          'protocol': protocol,
1235                          'vni': vni})
1236
1237     def vxlan_gbp_tunnel_add_del(
1238             self,
1239             src,
1240             dst,
1241             mcast_sw_if_index=0xFFFFFFFF,
1242             is_add=1,
1243             is_ipv6=0,
1244             encap_table_id=0,
1245             vni=0,
1246             mode=1,
1247             instance=0xFFFFFFFF):
1248         """
1249
1250         :param dst_addr:
1251         :param src_addr:
1252         :param is_add:  (Default value = 1)
1253         :param is_ipv6:  (Default value = 0)
1254         :param encap_table_id:  (Default value = 0)
1255         :param decap_next_index:  (Default value = 0xFFFFFFFF)
1256         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
1257         :param vni:  (Default value = 0)
1258         :param instance:  (Default value = 0xFFFFFFFF)
1259
1260         """
1261         return self.api(self.papi.vxlan_gbp_tunnel_add_del,
1262                         {'is_add': is_add,
1263                          'tunnel': {
1264                              'src': src,
1265                              'dst': dst,
1266                              'mcast_sw_if_index': mcast_sw_if_index,
1267                              'encap_table_id': encap_table_id,
1268                              'vni': vni,
1269                              'instance': instance,
1270                              "mode": mode}})
1271
1272     def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1273         return self.api(self.papi.vxlan_gbp_tunnel_dump,
1274                         {'sw_if_index': sw_if_index,
1275                          '_no_type_conversion': True})
1276
1277     def pppoe_add_del_session(
1278             self,
1279             client_ip,
1280             client_mac,
1281             session_id=0,
1282             is_add=1,
1283             is_ipv6=0,
1284             decap_vrf_id=0):
1285         """
1286
1287         :param is_add:  (Default value = 1)
1288         :param is_ipv6:  (Default value = 0)
1289         :param client_ip:
1290         :param session_id:  (Default value = 0)
1291         :param client_mac:
1292         :param decap_vrf_id:  (Default value = 0)
1293
1294         """
1295         return self.api(self.papi.pppoe_add_del_session,
1296                         {'is_add': is_add,
1297                          'is_ipv6': is_ipv6,
1298                          'session_id': session_id,
1299                          'client_ip': client_ip,
1300                          'decap_vrf_id': decap_vrf_id,
1301                          'client_mac': client_mac})
1302
1303     def sr_mpls_policy_add(self, bsid, weight, type, segments):
1304         return self.api(self.papi.sr_mpls_policy_add,
1305                         {'bsid': bsid,
1306                          'weight': weight,
1307                          'type': type,
1308                          'n_segments': len(segments),
1309                          'segments': segments})
1310
1311     def sr_mpls_policy_del(self, bsid):
1312         return self.api(self.papi.sr_mpls_policy_del,
1313                         {'bsid': bsid})
1314
1315     def sr_localsid_add_del(self,
1316                             localsid,
1317                             behavior,
1318                             nh_addr4,
1319                             nh_addr6,
1320                             is_del=0,
1321                             end_psp=0,
1322                             sw_if_index=0xFFFFFFFF,
1323                             vlan_index=0,
1324                             fib_table=0,
1325                             ):
1326         """ Add/del IPv6 SR local-SID.
1327
1328         :param localsid:
1329         :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1330         :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1331         :param nh_addr4:
1332         :param nh_addr6:
1333         :param is_del:  (Default value = 0)
1334         :param end_psp: (Default value = 0)
1335         :param sw_if_index: (Default value = 0xFFFFFFFF)
1336         :param vlan_index:  (Default value = 0)
1337         :param fib_table:   (Default value = 0)
1338         """
1339         return self.api(
1340             self.papi.sr_localsid_add_del,
1341             {'is_del': is_del,
1342              'localsid': localsid,
1343              'end_psp': end_psp,
1344              'behavior': behavior,
1345              'sw_if_index': sw_if_index,
1346              'vlan_index': vlan_index,
1347              'fib_table': fib_table,
1348              'nh_addr4': nh_addr4,
1349              'nh_addr6': nh_addr6
1350              }
1351         )
1352
1353     def sr_policy_add(
1354             self,
1355             bsid_addr,
1356             weight=1,
1357             is_encap=1,
1358             type=0,
1359             fib_table=0,
1360             n_segments=0,
1361             segments=[]):
1362         """
1363         :param bsid_addr: bindingSID of the SR Policy
1364         :param weight: weight of the sid list. optional. (default: 1)
1365         :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1366             (default: Encap)
1367         :param type: type/behavior of the SR policy. (default or spray) \
1368             (default: default)
1369         :param fib_table: VRF where to install the FIB entry for the BSID \
1370             (default: 0)
1371         :param n_segments: number of segments \
1372             (default: 0)
1373         :param segments: a vector of IPv6 address composing the segment list \
1374             (default: [])
1375         """
1376         return self.api(
1377             self.papi.sr_policy_add,
1378             {'bsid_addr': bsid_addr,
1379              'weight': weight,
1380              'is_encap': is_encap,
1381              'type': type,
1382              'fib_table': fib_table,
1383              'n_segments': n_segments,
1384              'segments': segments
1385              }
1386         )
1387
1388     def sr_policy_del(
1389             self,
1390             bsid_addr,
1391             sr_policy_index=0):
1392         """
1393         :param bsid: bindingSID of the SR Policy
1394         :param sr_policy_index: index of the sr policy (default: 0)
1395         """
1396         return self.api(
1397             self.papi.sr_policy_del,
1398             {'bsid_addr': bsid_addr,
1399              'sr_policy_index': sr_policy_index
1400              })
1401
1402     def sr_steering_add_del(
1403             self,
1404             is_del,
1405             bsid_addr,
1406             sr_policy_index,
1407             table_id,
1408             prefix_addr,
1409             mask_width,
1410             sw_if_index,
1411             traffic_type):
1412         """
1413         Steer traffic L2 and L3 traffic through a given SR policy
1414
1415         :param is_del: delete or add
1416         :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1417         :param sr_policy: is the index of the SR Policy (alt to bsid)
1418         :param table_id: is the VRF where to install the FIB entry for the BSID
1419         :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1420         :param mask_width: is the mask for L3 traffic type
1421         :param sw_if_index: is the incoming interface for L2 traffic
1422         :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1423         """
1424         return self.api(
1425             self.papi.sr_steering_add_del,
1426             {'is_del': is_del,
1427              'bsid_addr': bsid_addr,
1428              'sr_policy_index': sr_policy_index,
1429              'table_id': table_id,
1430              'prefix_addr': prefix_addr,
1431              'mask_width': mask_width,
1432              'sw_if_index': sw_if_index,
1433              'traffic_type': traffic_type
1434              })
1435
1436     def acl_add_replace(self, acl_index, r, tag='',
1437                         expected_retval=0):
1438         """Add/replace an ACL
1439         :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1440         :param acl_rule r: ACL rules array.
1441         :param str tag: symbolic tag (description) for this ACL.
1442         :param int count: number of rules.
1443         """
1444         return self.api(self.papi.acl_add_replace,
1445                         {'acl_index': acl_index,
1446                          'r': r,
1447                          'count': len(r),
1448                          'tag': tag},
1449                         expected_retval=expected_retval)
1450
1451     def acl_del(self, acl_index, expected_retval=0):
1452         """
1453
1454         :param acl_index:
1455         :return:
1456         """
1457         return self.api(self.papi.acl_del,
1458                         {'acl_index': acl_index},
1459                         expected_retval=expected_retval)
1460
1461     def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1462                                    expected_retval=0):
1463         return self.api(self.papi.acl_interface_set_acl_list,
1464                         {'sw_if_index': sw_if_index,
1465                          'count': len(acls),
1466                          'n_input': n_input,
1467                          'acls': acls},
1468                         expected_retval=expected_retval)
1469
1470     def acl_interface_set_etype_whitelist(self, sw_if_index,
1471                                           n_input, whitelist,
1472                                           expected_retval=0):
1473         return self.api(self.papi.acl_interface_set_etype_whitelist,
1474                         {'sw_if_index': sw_if_index,
1475                          'count': len(whitelist),
1476                          'n_input': n_input,
1477                          'whitelist': whitelist},
1478                         expected_retval=expected_retval)
1479
1480     def acl_interface_add_del(self,
1481                               sw_if_index,
1482                               acl_index,
1483                               is_add=1):
1484         """ Add/Delete ACL to/from interface
1485
1486         :param sw_if_index:
1487         :param acl_index:
1488         :param is_add:  (Default value = 1)
1489         """
1490
1491         return self.api(self.papi.acl_interface_add_del,
1492                         {'is_add': is_add,
1493                          'is_input': 1,
1494                          'sw_if_index': sw_if_index,
1495                          'acl_index': acl_index})
1496
1497     def acl_dump(self, acl_index, expected_retval=0):
1498         return self.api(self.papi.acl_dump,
1499                         {'acl_index': acl_index},
1500                         expected_retval=expected_retval)
1501
1502     def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1503                                 expected_retval=0):
1504         return self.api(self.papi.acl_interface_list_dump,
1505                         {'sw_if_index': sw_if_index},
1506                         expected_retval=expected_retval)
1507
1508     def macip_acl_add(self, rules, tag=""):
1509         """ Add MACIP acl
1510
1511         :param rules: list of rules for given acl
1512         :param tag: acl tag
1513         """
1514
1515         return self.api(self.papi.macip_acl_add,
1516                         {'r': rules,
1517                          'count': len(rules),
1518                          'tag': tag})
1519
1520     def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1521         """ Add MACIP acl
1522
1523         :param rules: list of rules for given acl
1524         :param tag: acl tag
1525         """
1526
1527         return self.api(self.papi.macip_acl_add_replace,
1528                         {'acl_index': acl_index,
1529                          'r': rules,
1530                          'count': len(rules),
1531                          'tag': tag})
1532
1533     def macip_acl_interface_add_del(self,
1534                                     sw_if_index,
1535                                     acl_index,
1536                                     is_add=1):
1537         """ Add MACIP acl to interface
1538
1539         :param sw_if_index:
1540         :param acl_index:
1541         :param is_add:  (Default value = 1)
1542         """
1543
1544         return self.api(self.papi.macip_acl_interface_add_del,
1545                         {'is_add': is_add,
1546                          'sw_if_index': sw_if_index,
1547                          'acl_index': acl_index})
1548
1549     def macip_acl_dump(self, acl_index=4294967295):
1550         """ Return MACIP acl dump
1551         """
1552
1553         return self.api(
1554             self.papi.macip_acl_dump, {'acl_index': acl_index})
1555
1556     def policer_add_del(self,
1557                         name,
1558                         cir,
1559                         eir,
1560                         cb,
1561                         eb,
1562                         is_add=1,
1563                         rate_type=0,
1564                         round_type=0,
1565                         ptype=0,
1566                         color_aware=0,
1567                         conform_action_type=1,
1568                         conform_dscp=0,
1569                         exceed_action_type=0,
1570                         exceed_dscp=0,
1571                         violate_action_type=0,
1572                         violate_dscp=0):
1573         return self.api(self.papi.policer_add_del,
1574                         {'name': name,
1575                          'cir': cir,
1576                          'eir': eir,
1577                          'cb': cb,
1578                          'eb': eb,
1579                          'is_add': is_add,
1580                          'rate_type': rate_type,
1581                          'round_type': round_type,
1582                          'type': ptype,
1583                          'color_aware': color_aware,
1584                          'conform_action_type': conform_action_type,
1585                          'conform_dscp': conform_dscp,
1586                          'exceed_action_type': exceed_action_type,
1587                          'exceed_dscp': exceed_dscp,
1588                          'violate_action_type': violate_action_type,
1589                          'violate_dscp': violate_dscp})
1590
1591     def ip_punt_police(self,
1592                        policer_index,
1593                        is_ip6=0,
1594                        is_add=1):
1595         return self.api(self.papi.ip_punt_police,
1596                         {'policer_index': policer_index,
1597                          'is_add': is_add,
1598                          'is_ip6': is_ip6})
1599
1600     def ip_punt_redirect(self,
1601                          rx_sw_if_index,
1602                          tx_sw_if_index,
1603                          address,
1604                          is_add=1):
1605         return self.api(self.papi.ip_punt_redirect,
1606                         {'punt': {'rx_sw_if_index': rx_sw_if_index,
1607                                   'tx_sw_if_index': tx_sw_if_index,
1608                                   'nh': address},
1609                          'is_add': is_add})
1610
1611     def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1612         return self.api(self.papi.ip_punt_redirect_dump,
1613                         {'sw_if_index': sw_if_index,
1614                          'is_ipv6': is_ipv6})
1615
1616     def bier_table_add_del(self,
1617                            bti,
1618                            mpls_label,
1619                            is_add=1):
1620         """ BIER Table add/del """
1621         return self.api(
1622             self.papi.bier_table_add_del,
1623             {'bt_tbl_id': {"bt_set": bti.set_id,
1624                            "bt_sub_domain": bti.sub_domain_id,
1625                            "bt_hdr_len_id": bti.hdr_len_id},
1626              'bt_label': mpls_label,
1627              'bt_is_add': is_add})
1628
1629     def bier_table_dump(self):
1630         return self.api(self.papi.bier_table_dump, {})
1631
1632     def bier_route_add_del(self,
1633                            bti,
1634                            bp,
1635                            paths,
1636                            is_add=1,
1637                            is_replace=0):
1638         """ BIER Route add/del """
1639         return self.api(
1640             self.papi.bier_route_add_del,
1641             {'br_tbl_id': {"bt_set": bti.set_id,
1642                            "bt_sub_domain": bti.sub_domain_id,
1643                            "bt_hdr_len_id": bti.hdr_len_id},
1644              'br_bp': bp,
1645              'br_n_paths': len(paths),
1646              'br_paths': paths,
1647              'br_is_add': is_add,
1648              'br_is_replace': is_replace})
1649
1650     def bier_route_dump(self, bti):
1651         return self.api(
1652             self.papi.bier_route_dump,
1653             {'br_tbl_id': {"bt_set": bti.set_id,
1654                            "bt_sub_domain": bti.sub_domain_id,
1655                            "bt_hdr_len_id": bti.hdr_len_id}})
1656
1657     def bier_imp_add(self,
1658                      bti,
1659                      src,
1660                      ibytes,
1661                      is_add=1):
1662         """ BIER Imposition Add """
1663         return self.api(
1664             self.papi.bier_imp_add,
1665             {'bi_tbl_id': {"bt_set": bti.set_id,
1666                            "bt_sub_domain": bti.sub_domain_id,
1667                            "bt_hdr_len_id": bti.hdr_len_id},
1668              'bi_src': src,
1669              'bi_n_bytes': len(ibytes),
1670              'bi_bytes': ibytes})
1671
1672     def bier_imp_del(self, bi_index):
1673         """ BIER Imposition del """
1674         return self.api(
1675             self.papi.bier_imp_del,
1676             {'bi_index': bi_index})
1677
1678     def bier_imp_dump(self):
1679         return self.api(self.papi.bier_imp_dump, {})
1680
1681     def bier_disp_table_add_del(self,
1682                                 bdti,
1683                                 is_add=1):
1684         """ BIER Disposition Table add/del """
1685         return self.api(
1686             self.papi.bier_disp_table_add_del,
1687             {'bdt_tbl_id': bdti,
1688              'bdt_is_add': is_add})
1689
1690     def bier_disp_table_dump(self):
1691         return self.api(self.papi.bier_disp_table_dump, {})
1692
1693     def bier_disp_entry_add_del(self,
1694                                 bdti,
1695                                 bp,
1696                                 payload_proto,
1697                                 next_hop_afi,
1698                                 next_hop,
1699                                 next_hop_tbl_id=0,
1700                                 next_hop_rpf_id=~0,
1701                                 next_hop_is_ip4=1,
1702                                 is_add=1):
1703         """ BIER Route add/del """
1704         lstack = []
1705         while (len(lstack) < 16):
1706             lstack.append({})
1707         return self.api(
1708             self.papi.bier_disp_entry_add_del,
1709             {'bde_tbl_id': bdti,
1710              'bde_bp': bp,
1711              'bde_payload_proto': payload_proto,
1712              'bde_n_paths': 1,
1713              'bde_paths': [{'next_hop': next_hop,
1714                             'table_id': next_hop_tbl_id,
1715                             'afi': next_hop_afi,
1716                             'rpf_id': next_hop_rpf_id,
1717                             'n_labels': 0,
1718                             'label_stack': lstack}],
1719              'bde_is_add': is_add})
1720
1721     def bier_disp_entry_dump(self, bdti):
1722         return self.api(
1723             self.papi.bier_disp_entry_dump,
1724             {'bde_tbl_id': bdti})
1725
1726     def session_enable_disable(self, is_enabled):
1727         return self.api(
1728             self.papi.session_enable_disable,
1729             {'is_enable': is_enabled})
1730
1731     def ipsec_spd_add_del(self, spd_id, is_add=1):
1732         """ SPD add/del - Wrapper to add or del ipsec SPD
1733         Sample CLI : 'ipsec spd add 1'
1734
1735         :param spd_id - SPD ID to be created in the vpp . mandatory
1736         :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1737               optional
1738         :returns: reply from the API
1739         """
1740         return self.api(
1741             self.papi.ipsec_spd_add_del, {
1742                 'spd_id': spd_id, 'is_add': is_add})
1743
1744     def ipsec_spds_dump(self):
1745         return self.api(self.papi.ipsec_spds_dump, {})
1746
1747     def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1748         """ IPSEC interface SPD add/del - \
1749              Wrapper to associate/disassociate SPD to interface in VPP
1750         Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1751
1752         :param spd_id - SPD ID to associate with the interface . mandatory
1753         :param sw_if_index - Interface Index which needs to ipsec \
1754             association mandatory
1755         :param is_add - add(1) or del(0) association with interface \
1756                 (Default 1 - add) . optional
1757         :returns: reply from the API
1758         """
1759         return self.api(
1760             self.papi.ipsec_interface_add_del_spd,
1761             {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1762
1763     def ipsec_spd_interface_dump(self, spd_index=None):
1764         return self.api(self.papi.ipsec_spd_interface_dump,
1765                         {'spd_index': spd_index if spd_index else 0,
1766                          'spd_index_valid': 1 if spd_index else 0})
1767
1768     def ipsec_sad_entry_add_del(self,
1769                                 sad_id,
1770                                 spi,
1771                                 integrity_algorithm,
1772                                 integrity_key,
1773                                 crypto_algorithm,
1774                                 crypto_key,
1775                                 protocol,
1776                                 tunnel_src_address='',
1777                                 tunnel_dst_address='',
1778                                 flags=0,
1779                                 salt=0,
1780                                 is_add=1):
1781         """ IPSEC SA add/del
1782         :param sad_id: security association ID
1783         :param spi: security param index of the SA in decimal
1784         :param integrity_algorithm:
1785         :param integrity_key:
1786         :param crypto_algorithm:
1787         :param crypto_key:
1788         :param protocol: AH(0) or ESP(1) protocol
1789         :param tunnel_src_address: tunnel mode outer src address
1790         :param tunnel_dst_address: tunnel mode outer dst address
1791         :param is_add:
1792         :param is_tunnel:
1793         :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1794              crypto and ipsec algorithms
1795         """
1796         return self.api(
1797             self.papi.ipsec_sad_entry_add_del,
1798             {
1799                 'is_add': is_add,
1800                 'entry':
1801                     {
1802                         'sad_id': sad_id,
1803                         'spi': spi,
1804                         'tunnel_src': tunnel_src_address,
1805                         'tunnel_dst': tunnel_dst_address,
1806                         'protocol': protocol,
1807                         'integrity_algorithm': integrity_algorithm,
1808                         'integrity_key': {
1809                             'length': len(integrity_key),
1810                             'data': integrity_key,
1811                         },
1812                         'crypto_algorithm': crypto_algorithm,
1813                         'crypto_key': {
1814                             'length': len(crypto_key),
1815                             'data': crypto_key,
1816                         },
1817                         'flags': flags,
1818                         'salt': salt,
1819                     }
1820             })
1821
1822     def ipsec_sa_dump(self, sa_id=None):
1823         return self.api(self.papi.ipsec_sa_dump,
1824                         {'sa_id': sa_id if sa_id else 0xffffffff})
1825
1826     def ipsec_spd_entry_add_del(self,
1827                                 spd_id,
1828                                 sa_id,
1829                                 local_address_start,
1830                                 local_address_stop,
1831                                 remote_address_start,
1832                                 remote_address_stop,
1833                                 local_port_start=0,
1834                                 local_port_stop=65535,
1835                                 remote_port_start=0,
1836                                 remote_port_stop=65535,
1837                                 protocol=0,
1838                                 policy=0,
1839                                 priority=100,
1840                                 is_outbound=1,
1841                                 is_add=1,
1842                                 is_ipv6=0,
1843                                 is_ip_any=0):
1844         """ IPSEC policy SPD add/del   -
1845                     Wrapper to configure ipsec SPD policy entries in VPP
1846         :param spd_id: SPD ID for the policy
1847         :param local_address_start: local-ip-range start address
1848         :param local_address_stop : local-ip-range stop address
1849         :param remote_address_start: remote-ip-range start address
1850         :param remote_address_stop : remote-ip-range stop address
1851         :param local_port_start: (Default value = 0)
1852         :param local_port_stop: (Default value = 65535)
1853         :param remote_port_start: (Default value = 0)
1854         :param remote_port_stop: (Default value = 65535)
1855         :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1856         :param sa_id: Security Association ID for mapping it to SPD
1857         :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1858                (Default value = 0)
1859         :param priority: value for the spd action (Default value = 100)
1860         :param is_outbound: flag for inbound(0) or outbound(1)
1861                (Default value = 1)
1862         :param is_add: (Default value = 1)
1863         """
1864         return self.api(
1865             self.papi.ipsec_spd_entry_add_del,
1866             {
1867                 'is_add': is_add,
1868                 'entry':
1869                     {
1870                         'spd_id': spd_id,
1871                         'sa_id': sa_id,
1872                         'local_address_start': local_address_start,
1873                         'local_address_stop': local_address_stop,
1874                         'remote_address_start': remote_address_start,
1875                         'remote_address_stop': remote_address_stop,
1876                         'local_port_start': local_port_start,
1877                         'local_port_stop': local_port_stop,
1878                         'remote_port_start': remote_port_start,
1879                         'remote_port_stop': remote_port_stop,
1880                         'protocol': protocol,
1881                         'policy': policy,
1882                         'priority': priority,
1883                         'is_outbound': is_outbound,
1884                         'is_ip_any': is_ip_any
1885                     }
1886             })
1887
1888     def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1889         return self.api(self.papi.ipsec_spd_dump,
1890                         {'spd_id': spd_id,
1891                          'sa_id': sa_id})
1892
1893     def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1894                                 remote_spi, crypto_alg, local_crypto_key,
1895                                 remote_crypto_key, integ_alg, local_integ_key,
1896                                 remote_integ_key, is_add=1, esn=0, salt=0,
1897                                 anti_replay=1, renumber=0, show_instance=0):
1898         return self.api(
1899             self.papi.ipsec_tunnel_if_add_del,
1900             {
1901                 'local_ip': local_ip,
1902                 'remote_ip': remote_ip,
1903                 'local_spi': local_spi,
1904                 'remote_spi': remote_spi,
1905                 'crypto_alg': crypto_alg,
1906                 'local_crypto_key_len': len(local_crypto_key),
1907                 'local_crypto_key': local_crypto_key,
1908                 'remote_crypto_key_len': len(remote_crypto_key),
1909                 'remote_crypto_key': remote_crypto_key,
1910                 'integ_alg': integ_alg,
1911                 'local_integ_key_len': len(local_integ_key),
1912                 'local_integ_key': local_integ_key,
1913                 'remote_integ_key_len': len(remote_integ_key),
1914                 'remote_integ_key': remote_integ_key,
1915                 'is_add': is_add,
1916                 'esn': esn,
1917                 'anti_replay': anti_replay,
1918                 'renumber': renumber,
1919                 'show_instance': show_instance,
1920                 'salt': salt
1921             })
1922
1923     def ipsec_gre_tunnel_add_del(self, local_ip, remote_ip,
1924                                  sa_out, sa_in, is_add=1):
1925         return self.api(self.papi.ipsec_gre_tunnel_add_del,
1926                         {
1927                             'is_add': is_add,
1928                             'tunnel': {
1929                                 'src': local_ip,
1930                                 'dst': remote_ip,
1931                                 'local_sa_id': sa_out,
1932                                 'remote_sa_id': sa_in
1933                             }
1934                         })
1935
1936     def ipsec_select_backend(self, protocol, index):
1937         return self.api(self.papi.ipsec_select_backend,
1938                         {'protocol': protocol, 'index': index})
1939
1940     def ipsec_backend_dump(self):
1941         return self.api(self.papi.ipsec_backend_dump, {})
1942
1943     def app_namespace_add_del(self,
1944                               namespace_id,
1945                               ip4_fib_id=0,
1946                               ip6_fib_id=0,
1947                               sw_if_index=0xFFFFFFFF,
1948                               secret=0):
1949         return self.api(
1950             self.papi.app_namespace_add_del,
1951             {'secret': secret,
1952              'sw_if_index': sw_if_index,
1953              'ip4_fib_id': ip4_fib_id,
1954              'ip6_fib_id': ip6_fib_id,
1955              'namespace_id': namespace_id,
1956              'namespace_id_len': len(namespace_id)})
1957
1958     def punt_socket_register(self, port, pathname, protocol=0x11,
1959                              header_version=1, is_ip4=1):
1960         """ Register punt socket """
1961         return self.api(self.papi.punt_socket_register,
1962                         {'header_version': header_version,
1963                          'punt': {'ipv': is_ip4,
1964                                   'l4_protocol': protocol,
1965                                   'l4_port': port},
1966                          'pathname': pathname})
1967
1968     def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
1969         """ Unregister punt socket """
1970         return self.api(self.papi.punt_socket_deregister,
1971                         {'punt': {'ipv': is_ip4,
1972                                   'l4_protocol': protocol,
1973                                   'l4_port': port}})
1974
1975     def punt_socket_dump(self, is_ip6=1):
1976         """ Dump punt socket"""
1977         return self.api(self.papi.punt_socket_dump,
1978                         {'is_ipv6': is_ip6})
1979
1980     def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1981                          tun_src, tun_dst):
1982         """ GBP endpoint Add """
1983         return self.api(self.papi.gbp_endpoint_add,
1984                         {'endpoint': {
1985                             'sw_if_index': sw_if_index,
1986                             'ips': ips,
1987                             'n_ips': len(ips),
1988                             'mac': mac,
1989                             'sclass': sclass,
1990                             'flags': flags,
1991                             'tun': {
1992                                 'src': tun_src,
1993                                 'dst': tun_dst,
1994                             }}})
1995
1996     def gbp_endpoint_del(self, handle):
1997         """ GBP endpoint Del """
1998         return self.api(self.papi.gbp_endpoint_del,
1999                         {'handle': handle})
2000
2001     def gbp_endpoint_dump(self):
2002         """ GBP endpoint Dump """
2003         return self.api(self.papi.gbp_endpoint_dump,
2004                         {'_no_type_conversion': True})
2005
2006     def gbp_endpoint_group_add(self, vnid, sclass, bd,
2007                                rd, uplink_sw_if_index,
2008                                retention):
2009         """ GBP endpoint group Add """
2010         return self.api(self.papi.gbp_endpoint_group_add,
2011                         {'epg':
2012                             {
2013                                 'uplink_sw_if_index': uplink_sw_if_index,
2014                                 'bd_id': bd,
2015                                 'rd_id': rd,
2016                                 'vnid': vnid,
2017                                 'sclass': sclass,
2018                                 'retention': retention
2019                             }})
2020
2021     def gbp_endpoint_group_del(self, sclass):
2022         """ GBP endpoint group Del """
2023         return self.api(self.papi.gbp_endpoint_group_del,
2024                         {'sclass': sclass})
2025
2026     def gbp_bridge_domain_add(self, bd_id, flags,
2027                               bvi_sw_if_index,
2028                               uu_fwd_sw_if_index,
2029                               bm_flood_sw_if_index):
2030         """ GBP bridge-domain Add """
2031         return self.api(self.papi.gbp_bridge_domain_add,
2032                         {'bd':
2033                             {
2034                                 'flags': flags,
2035                                 'bvi_sw_if_index': bvi_sw_if_index,
2036                                 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2037                                 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2038                                 'bd_id': bd_id
2039                             }})
2040
2041     def gbp_bridge_domain_del(self, bd_id):
2042         """ GBP bridge-domain Del """
2043         return self.api(self.papi.gbp_bridge_domain_del,
2044                         {'bd_id': bd_id})
2045
2046     def gbp_route_domain_add(self, rd_id,
2047                              ip4_table_id,
2048                              ip6_table_id,
2049                              ip4_uu_sw_if_index,
2050                              ip6_uu_sw_if_index):
2051         """ GBP route-domain Add """
2052         return self.api(self.papi.gbp_route_domain_add,
2053                         {'rd':
2054                             {
2055                                 'ip4_table_id': ip4_table_id,
2056                                 'ip6_table_id': ip6_table_id,
2057                                 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2058                                 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2059                                 'rd_id': rd_id
2060                             }})
2061
2062     def gbp_route_domain_del(self, rd_id):
2063         """ GBP route-domain Del """
2064         return self.api(self.papi.gbp_route_domain_del,
2065                         {'rd_id': rd_id})
2066
2067     def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2068         """ GBP recirc Add/Del """
2069         return self.api(self.papi.gbp_recirc_add_del,
2070                         {'is_add': is_add,
2071                          'recirc': {
2072                              'is_ext': is_ext,
2073                              'sw_if_index': sw_if_index,
2074                              'sclass': sclass}})
2075
2076     def gbp_recirc_dump(self):
2077         """ GBP recirc Dump """
2078         return self.api(self.papi.gbp_recirc_dump, {})
2079
2080     def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2081         """ GBP recirc Add/Del """
2082         return self.api(self.papi.gbp_ext_itf_add_del,
2083                         {'is_add': is_add,
2084                          'ext_itf': {
2085                              'sw_if_index': sw_if_index,
2086                              'bd_id': bd_id,
2087                              'rd_id': rd_id}})
2088
2089     def gbp_ext_itf_dump(self):
2090         """ GBP recirc Dump """
2091         return self.api(self.papi.gbp_ext_itf_dump, {})
2092
2093     def gbp_subnet_add_del(self, is_add, rd_id,
2094                            prefix, type,
2095                            sw_if_index=0xffffffff,
2096                            sclass=0xffff):
2097         """ GBP Subnet Add/Del """
2098         return self.api(self.papi.gbp_subnet_add_del,
2099                         {'is_add': is_add,
2100                          'subnet': {
2101                              'type': type,
2102                              'sw_if_index': sw_if_index,
2103                              'sclass': sclass,
2104                              'prefix': prefix,
2105                              'rd_id': rd_id}})
2106
2107     def gbp_subnet_dump(self):
2108         """ GBP Subnet Dump """
2109         return self.api(self.papi.gbp_subnet_dump,
2110                         {'_no_type_conversion': True})
2111
2112     def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2113                              rules, allowed_ethertypes):
2114         """ GBP contract Add/Del """
2115         return self.api(self.papi.gbp_contract_add_del,
2116                         {'is_add': is_add,
2117                          'contract': {
2118                              'acl_index': acl_index,
2119                              'sclass': sclass,
2120                              'dclass': dclass,
2121                              'n_rules': len(rules),
2122                              'rules': rules,
2123                              'n_ether_types': len(allowed_ethertypes),
2124                              'allowed_ethertypes': allowed_ethertypes}})
2125
2126     def gbp_contract_dump(self):
2127         """ GBP contract Dump """
2128         return self.api(self.papi.gbp_contract_dump, {})
2129
2130     def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2131         """ GBP VXLAN tunnel add """
2132         return self.api(self.papi.gbp_vxlan_tunnel_add,
2133                         {
2134                             'tunnel': {
2135                                 'vni': vni,
2136                                 'mode': mode,
2137                                 'bd_rd_id': bd_rd_id,
2138                                 'src': src
2139                             }
2140                         })
2141
2142     def gbp_vxlan_tunnel_del(self, vni):
2143         """ GBP VXLAN tunnel del """
2144         return self.api(self.papi.gbp_vxlan_tunnel_del,
2145                         {
2146                             'vni': vni,
2147                         })
2148
2149     def gbp_vxlan_tunnel_dump(self):
2150         """ GBP VXLAN tunnel add/del """
2151         return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2152
2153     def qos_egress_map_update(self, id, outputs):
2154         """ QOS egress map update """
2155         return self.api(self.papi.qos_egress_map_update,
2156                         {'map_id': id,
2157                          'rows': outputs})
2158
2159     def qos_egress_map_delete(self, id):
2160         """ QOS egress map delete """
2161         return self.api(self.papi.qos_egress_map_delete,
2162                         {'map_id': id})
2163
2164     def qos_mark_enable_disable(self, sw_if_index,
2165                                 output_source,
2166                                 map_id,
2167                                 enable):
2168         """ QOS Mark Enable/Disable """
2169         return self.api(self.papi.qos_mark_enable_disable,
2170                         {'map_id': map_id,
2171                          'sw_if_index': sw_if_index,
2172                          'output_source': output_source,
2173                          'enable': enable})
2174
2175     def igmp_enable_disable(self, sw_if_index, enable, host):
2176         """ Enable/disable IGMP on a given interface """
2177         return self.api(self.papi.igmp_enable_disable,
2178                         {'enable': enable,
2179                          'mode': host,
2180                          'sw_if_index': sw_if_index})
2181
2182     def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2183         """ Add/del IGMP proxy device """
2184         return self.api(self.papi.igmp_proxy_device_add_del,
2185                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2186                          'add': add})
2187
2188     def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2189         """ Add/del interface to/from IGMP proxy device """
2190         return self.api(self.papi.igmp_proxy_device_add_del_interface,
2191                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2192                          'add': add})
2193
2194     def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2195         """ Listen for new (S,G) on specified interface
2196
2197         :param enable: add/del
2198         :param sw_if_index: interface sw index
2199         :param saddr: source ip4 addr
2200         :param gaddr: group ip4 addr
2201         """
2202         return self.api(self.papi.igmp_listen,
2203                         {
2204                             'group':
2205                                 {
2206                                     'filter': filter,
2207                                     'sw_if_index': sw_if_index,
2208                                     'n_srcs': len(saddrs),
2209                                     'saddrs': saddrs,
2210                                     'gaddr': gaddr
2211                                 }
2212                         })
2213
2214     def igmp_clear_interface(self, sw_if_index):
2215         """ Remove all (S,G)s from specified interface
2216             doesn't send IGMP report!
2217         """
2218         return self.api(
2219             self.papi.igmp_clear_interface, {
2220                 'sw_if_index': sw_if_index})
2221
2222     def want_igmp_events(self, enable=1):
2223         return self.api(self.papi.want_igmp_events, {'enable': enable,
2224                                                      'pid': os.getpid()})
2225
2226     def bond_create(
2227             self,
2228             mode,
2229             lb,
2230             use_custom_mac,
2231             mac_address='',
2232             interface_id=0xFFFFFFFF):
2233         """
2234         :param mode: mode
2235         :param lb: load balance
2236         :param use_custom_mac: use custom mac
2237         :param mac_address: mac address
2238         :param interface_id: custom interface ID
2239         """
2240         return self.api(
2241             self.papi.bond_create,
2242             {'mode': mode,
2243              'lb': lb,
2244              'use_custom_mac': use_custom_mac,
2245              'mac_address': mac_address,
2246              'id': interface_id
2247              })
2248
2249     def pipe_delete(self, parent_sw_if_index):
2250         return self.api(self.papi.pipe_delete,
2251                         {'parent_sw_if_index': parent_sw_if_index})
2252
2253     def memif_create(
2254             self,
2255             role,
2256             mode,
2257             rx_queues=None,
2258             tx_queues=None,
2259             _id=None,
2260             socket_id=None,
2261             secret=None,
2262             ring_size=None,
2263             buffer_size=None,
2264             hw_addr=None):
2265         return self.api(self.papi.memif_create,
2266                         {'role': role,
2267                          'mode': mode,
2268                          'rx_queues': rx_queues,
2269                          'tx_queues': tx_queues,
2270                          'id': _id,
2271                          'socket_id': socket_id,
2272                          'secret': secret,
2273                          'ring_size': ring_size,
2274                          'buffer_size': buffer_size,
2275                          'hw_addr': hw_addr})
2276
2277     def svs_table_add_del(self, af, table_id, is_add=1):
2278         return self.api(self.papi.svs_table_add_del,
2279                         {
2280                             'table_id': table_id,
2281                             'is_add': is_add,
2282                             'af': af,
2283                         })
2284
2285     def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2286         return self.api(self.papi.svs_route_add_del,
2287                         {
2288                             'table_id': table_id,
2289                             'source_table_id': src_table_id,
2290                             'prefix': prefix,
2291                             'is_add': is_add,
2292                         })
2293
2294     def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2295         return self.api(self.papi.svs_enable_disable,
2296                         {
2297                             'af': af,
2298                             'table_id': table_id,
2299                             'sw_if_index': sw_if_index,
2300                             'is_enable': is_enable,
2301                         })