test/vpp_papi_provider.py

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