test/vpp_papi_provider.py

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