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