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