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