test/vpp_papi_provider.py

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