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