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