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
  24     'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
  25     'bd_ip_mac_add_del': {'is_add': 1, },
  26     'bfd_udp_add': {'is_authenticated': False, 'bfd_key_id': None,
  27                     'conf_key_id': None},
  28     'bfd_udp_auth_activate': {'bfd_key_id': None, 'conf_key_id': None,
  29                               'is_delayed': False},
  30     'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
  31                                 'is_add': 1, },
  32     'bier_disp_table_add_del': {'is_add': 1, },
  33     'bier_imp_add': {'is_add': 1, },
  34     'bier_route_add_del': {'is_add': 1, },
  35     'bier_table_add_del': {'is_add': 1, },
  36     'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
  37                               'learn': 1, 'is_add': 1, },
  38     'bvi_delete': {},
  39     'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
  40     'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
  41                               'decap_next_index': 4294967295, },
  42     'input_acl_set_interface': {'ip4_table_index': 4294967295,
  43                                 'ip6_table_index': 4294967295,
  44                                 'l2_table_index': 4294967295, },
  45     'ip6_add_del_address_using_prefix': {'is_add': 1, },
  46     'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
  47     'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
  48                          'next_hop_weight': 1, 'next_hop_via_label': 1048576,
  49                          'classify_table_index': 4294967295, 'is_add': 1, },
  50     'ip_mroute_add_del': {'is_add': 1, },
  51     'ip_neighbor_add_del': {'is_add': 1, },
  52     'ip_punt_police': {'is_add': 1, },
  53     'ip_punt_redirect': {'is_add': 1, },
  54     'ip_route_add_del': {'is_add': 1, },
  55     'ipsec_interface_add_del_spd': {'is_add': 1, },
  56     'ipsec_sad_entry_add_del': {'is_add': 1, },
  57     'ipsec_spd_add_del': {'is_add': 1, },
  58     'ipsec_spd_dump': {'sa_id': 4294967295, },
  59     'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
  60                                 'remote_port_stop': 65535, 'priority': 100,
  61                                 'is_outbound': 1,
  62                                 'is_add': 1, },
  63     'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
  64     'l2_emulation': {'enable': 1, },
  65     'l2fib_add_del': {'is_add': 1, },
  66     'lisp_add_del_adjacency': {'is_add': 1, },
  67     'lisp_add_del_local_eid': {'is_add': 1, },
  68     'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
  69     'lisp_add_del_locator_set': {'is_add': 1, },
  70     'lisp_add_del_remote_mapping': {'is_add': 1, },
  71     'macip_acl_interface_add_del': {'is_add': 1, },
  72     'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
  73     'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
  74                            'mr_next_hop_weight': 1,
  75                            'mr_next_hop_via_label': 1048576,
  76                            'mr_is_add': 1,
  77                            'mr_classify_table_index': 4294967295, },
  78     'mpls_table_add_del': {'is_add': 1, },
  79     'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
  80                             'next_hop_weight': 1,
  81                             'next_hop_via_label': 1048576,
  82                             'is_add': 1, },
  83     'output_acl_set_interface': {'ip4_table_index': 4294967295,
  84                                  'ip6_table_index': 4294967295,
  85                                  'l2_table_index': 4294967295, },
  86     'pppoe_add_del_session': {'is_add': 1, },
  87     'policer_add_del': {'is_add': 1, 'conform_action': {'type': 1}, },
  88     'proxy_arp_add_del': {'is_add': 1, },
  89     'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
  90     'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
  91                          'proto': 1, },
  92     'set_ipfix_exporter': {'collector_port': 4739, },
  93     'sr_policy_add': {'weight': 1, 'is_encap': 1, },
  94     'svs_enable_disable': {'is_enable': 1, },
  95     'svs_route_add_del': {'is_add': 1, },
  96     'svs_table_add_del': {'is_add': 1, },
  97     'sw_interface_add_del_address': {'is_add': 1, },
  98     'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
  99                                      'pref_lifetime': 4294967295, },
 100     'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
 101     'sw_interface_set_l2_bridge': {'enable': 1, },
 102     'sw_interface_set_mpls_enable': {'enable': 1, },
 103     'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
 104     'sw_interface_set_unnumbered': {'is_add': 1, },
 105     'sw_interface_span_enable_disable': {'state': 1, },
 106     'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 107                              'decap_next_index': 4294967295,
 108                              'instance': 4294967295, },
 109     'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 110                                  'protocol': 3, },
 111     'want_bfd_events': {'enable_disable': 1, },
 112     'want_igmp_events': {'enable': 1, },
 113     'want_interface_events': {'enable_disable': 1, },
 114     'want_l2_macs_events': {'enable_disable': 1, 'pid': os.getpid(), },
 115 }
 116
 117
 118 class CliFailedCommandError(Exception):
 119     """ cli command failed."""
 120
 121
 122 class CliSyntaxError(Exception):
 123     """ cli command had a syntax error."""
 124
 125
 126 class UnexpectedApiReturnValueError(Exception):
 127     """ exception raised when the API return value is unexpected """
 128     pass
 129
 130
 131 class VppPapiProvider(object):
 132     """VPP-api provider using vpp-papi
 133
 134     @property hook: hook object providing before and after api/cli hooks
 135     """
 136
 137     _zero, _negative = range(2)
 138
 139     def __init__(self, name, shm_prefix, test_class, read_timeout):
 140         self.hook = Hook(test_class)
 141         self.name = name
 142         self.shm_prefix = shm_prefix
 143         self.test_class = test_class
 144         self._expect_api_retval = self._zero
 145         self._expect_stack = []
 146
 147         # install_dir is a class attribute. We need to set it before
 148         # calling the constructor.
 149         VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
 150
 151         use_socket = False
 152         try:
 153             if os.environ['SOCKET'] == '1':
 154                 use_socket = True
 155         except KeyError:
 156             pass
 157
 158         self.vpp = VPPApiClient(logger=test_class.logger,
 159                                 read_timeout=read_timeout,
 160                                 use_socket=use_socket,
 161                                 server_address=test_class.api_sock)
 162         self._events = deque()
 163
 164     def __enter__(self):
 165         return self
 166
 167     def assert_negative_api_retval(self):
 168         """ Expect API failure - used with with, e.g.:
 169             with self.vapi.assert_negative_api_retval():
 170                 self.vapi.<api call expected to fail>
 171         """
 172         self._expect_stack.append(self._expect_api_retval)
 173         self._expect_api_retval = self._negative
 174         return self
 175
 176     def assert_zero_api_retval(self):
 177         """ Expect API success - used with with, e.g.:
 178             with self.vapi.assert_negative_api_retval():
 179                 self.vapi.<api call expected to succeed>
 180
 181             note: this is useful only inside another with block
 182                   as success is the default expected value
 183         """
 184         self._expect_stack.append(self._expect_api_retval)
 185         self._expect_api_retval = self._zero
 186         return self
 187
 188     def __exit__(self, exc_type, exc_value, traceback):
 189         self._expect_api_retval = self._expect_stack.pop()
 190
 191     def register_hook(self, hook):
 192         """Replace hook registration with new hook
 193
 194         :param hook:
 195
 196         """
 197         self.hook = hook
 198
 199     def collect_events(self):
 200         """ Collect all events from the internal queue and clear the queue. """
 201         e = self._events
 202         self._events = deque()
 203         return e
 204
 205     def wait_for_event(self, timeout, name=None):
 206         """ Wait for and return next event. """
 207         if name:
 208             self.test_class.logger.debug("Expecting event '%s' within %ss",
 209                                          name, timeout)
 210         else:
 211             self.test_class.logger.debug("Expecting event within %ss",
 212                                          timeout)
 213         if self._events:
 214             self.test_class.logger.debug("Not waiting, event already queued")
 215         limit = time.time() + timeout
 216         while time.time() < limit:
 217             if self._events:
 218                 e = self._events.popleft()
 219                 if name and type(e).__name__ != name:
 220                     raise Exception(
 221                         "Unexpected event received: %s, expected: %s" %
 222                         (type(e).__name__, name))
 223                 self.test_class.logger.debug("Returning event %s:%s" %
 224                                              (name, e))
 225                 return e
 226             self.test_class.sleep(0)  # yield
 227         raise Exception("Event did not occur within timeout")
 228
 229     def __call__(self, name, event):
 230         """ Enqueue event in the internal event queue. """
 231         # FIXME use the name instead of relying on type(e).__name__ ?
 232         # FIXME #2 if this throws, it is eaten silently, Ole?
 233         self.test_class.logger.debug("New event: %s: %s" % (name, event))
 234         self._events.append(event)
 235
 236     def factory(self, name, apifn):
 237         def f(*a, **ka):
 238             fields = apifn._func.msg.fields
 239
 240             # add positional and kw arguments
 241             d = ka
 242             for i, o in enumerate(fields[3:]):
 243                 try:
 244                     d[o] = a[i]
 245                 except BaseException:
 246                     break
 247
 248             # Default override
 249             if name in defaultmapping:
 250                 for k, v in iteritems(defaultmapping[name]):
 251                     if k in d:
 252                         continue
 253                     d[k] = v
 254             return self.api(apifn, d)
 255
 256         return f
 257
 258     def __getattribute__(self, name):
 259         try:
 260             method = super(VppPapiProvider, self).__getattribute__(name)
 261         except AttributeError:
 262             method = self.factory(name, getattr(self.papi, name))
 263             # lazily load the method so we don't need to call factory
 264             # again for this name.
 265             setattr(self, name, method)
 266         return method
 267
 268     def connect(self):
 269         """Connect the API to VPP"""
 270         self.vpp.connect(self.name, self.shm_prefix)
 271         self.papi = self.vpp.api
 272         self.vpp.register_event_callback(self)
 273
 274     def disconnect(self):
 275         """Disconnect the API from VPP"""
 276         self.vpp.disconnect()
 277
 278     def api(self, api_fn, api_args, expected_retval=0):
 279         """ Call API function and check it's return value.
 280         Call the appropriate hooks before and after the API call
 281
 282         :param api_fn: API function to call
 283         :param api_args: tuple of API function arguments
 284         :param expected_retval: Expected return value (Default value = 0)
 285         :returns: reply from the API
 286
 287         """
 288         self.hook.before_api(api_fn.__name__, api_args)
 289         reply = api_fn(**api_args)
 290         if self._expect_api_retval == self._negative:
 291             if hasattr(reply, 'retval') and reply.retval >= 0:
 292                 msg = "API call passed unexpectedly: expected negative " \
 293                       "return value instead of %d in %s" % \
 294                       (reply.retval, moves.reprlib.repr(reply))
 295                 self.test_class.logger.info(msg)
 296                 raise UnexpectedApiReturnValueError(msg)
 297         elif self._expect_api_retval == self._zero:
 298             if hasattr(reply, 'retval') and reply.retval != expected_retval:
 299                 msg = "API call failed, expected %d return value instead " \
 300                       "of %d in %s" % (expected_retval, reply.retval,
 301                                        repr(reply))
 302                 self.test_class.logger.info(msg)
 303                 raise UnexpectedApiReturnValueError(msg)
 304         else:
 305             raise Exception("Internal error, unexpected value for "
 306                             "self._expect_api_retval %s" %
 307                             self._expect_api_retval)
 308         self.hook.after_api(api_fn.__name__, api_args)
 309         return reply
 310
 311     def cli_return_response(self, cli):
 312         """ Execute a CLI, calling the before/after hooks appropriately.
 313         Return the reply without examining it
 314
 315         :param cli: CLI to execute
 316         :returns: response object
 317
 318         """
 319         self.hook.before_cli(cli)
 320         cli += '\n'
 321         r = self.papi.cli_inband(cmd=cli)
 322         self.hook.after_cli(cli)
 323         return r
 324
 325     def cli(self, cli):
 326         """ Execute a CLI, calling the before/after hooks appropriately.
 327
 328         :param cli: CLI to execute
 329         :returns: CLI output
 330
 331         """
 332         r = self.cli_return_response(cli)
 333         if r.retval == -156:
 334             raise CliSyntaxError(r.reply)
 335         if r.retval != 0:
 336             raise CliFailedCommandError(r.reply)
 337         if hasattr(r, 'reply'):
 338             return r.reply
 339
 340     def ppcli(self, cli):
 341         """ Helper method to print CLI command in case of info logging level.
 342
 343         :param cli: CLI to execute
 344         :returns: CLI output
 345         """
 346         return cli + "\n" + self.cli(cli)
 347
 348     def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
 349                                        mrc=0, mrd=0):
 350         return self.api(self.papi.ip6nd_send_router_solicitation,
 351                         {'irt': irt,
 352                          'mrt': mrt,
 353                          'mrc': mrc,
 354                          'mrd': mrd,
 355                          'sw_if_index': sw_if_index})
 356
 357     def want_interface_events(self, enable_disable=1):
 358         return self.api(self.papi.want_interface_events,
 359                         {'enable_disable': enable_disable,
 360                          'pid': os.getpid(), })
 361
 362     def sw_interface_set_mac_address(self, sw_if_index, mac):
 363         return self.api(self.papi.sw_interface_set_mac_address,
 364                         {'sw_if_index': sw_if_index,
 365                          'mac_address': mac})
 366
 367     def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
 368         """Create p2p ethernet subinterface
 369
 370         :param sw_if_index: main (parent) interface
 371         :param remote_mac: client (remote) mac address
 372
 373         """
 374         return self.api(
 375             self.papi.p2p_ethernet_add,
 376             {'parent_if_index': sw_if_index,
 377              'remote_mac': remote_mac,
 378              'subif_id': subif_id})
 379
 380     def p2p_ethernet_del(self, sw_if_index, remote_mac):
 381         """Delete p2p ethernet subinterface
 382
 383         :param sw_if_index: main (parent) interface
 384         :param remote_mac: client (remote) mac address
 385
 386         """
 387         return self.api(
 388             self.papi.p2p_ethernet_del,
 389             {'parent_if_index': sw_if_index,
 390              'remote_mac': remote_mac})
 391
 392     def create_vlan_subif(self, sw_if_index, vlan):
 393         """
 394
 395         :param vlan:
 396         :param sw_if_index:
 397
 398         """
 399         return self.api(self.papi.create_vlan_subif,
 400                         {'sw_if_index': sw_if_index,
 401                          'vlan_id': vlan})
 402
 403     def create_loopback(self, mac=''):
 404         """
 405
 406         :param mac: (Optional)
 407         """
 408         return self.api(self.papi.create_loopback,
 409                         {'mac_address': mac})
 410
 411     def ip_route_dump(self, table_id, is_ip6=False):
 412         return self.api(self.papi.ip_route_dump,
 413                         {'table': {
 414                             'table_id': table_id,
 415                             'is_ip6': is_ip6
 416                         }})
 417
 418     def ip_neighbor_add_del(self,
 419                             sw_if_index,
 420                             mac_address,
 421                             ip_address,
 422                             is_add=1,
 423                             flags=0):
 424         """ Add neighbor MAC to IPv4 or IPv6 address.
 425
 426         :param sw_if_index:
 427         :param mac_address:
 428         :param dst_address:
 429         :param is_add:  (Default value = 1)
 430         :param flags:  (Default value = 0/NONE)
 431         """
 432         return self.api(
 433             self.papi.ip_neighbor_add_del,
 434             {
 435                 'is_add': is_add,
 436                 'neighbor': {
 437                     'sw_if_index': sw_if_index,
 438                     'flags': flags,
 439                     'mac_address': mac_address,
 440                     'ip_address': ip_address
 441                 }
 442             }
 443         )
 444
 445     def proxy_arp_add_del(self,
 446                           low,
 447                           hi,
 448                           table_id=0,
 449                           is_add=1):
 450         """ Config Proxy Arp Range.
 451
 452         :param low_address: Start address in the rnage to Proxy for
 453         :param hi_address: End address in the rnage to Proxy for
 454         :param vrf_id: The VRF/table in which to proxy
 455         """
 456
 457         return self.api(
 458             self.papi.proxy_arp_add_del,
 459             {'proxy':
 460                 {
 461                     'table_id': table_id,
 462                     'low': low,
 463                     'hi': hi,
 464                 },
 465                 'is_add': is_add})
 466
 467     def proxy_arp_intfc_enable_disable(self,
 468                                        sw_if_index,
 469                                        is_enable=1):
 470         """ Enable/Disable an interface for proxy ARP requests
 471
 472         :param sw_if_index: Interface
 473         :param enable_disable: Enable/Disable
 474         """
 475
 476         return self.api(
 477             self.papi.proxy_arp_intfc_enable_disable,
 478             {'sw_if_index': sw_if_index,
 479              'enable': is_enable
 480              }
 481         )
 482
 483     def udp_encap_add(self,
 484                       src_ip,
 485                       dst_ip,
 486                       src_port,
 487                       dst_port,
 488                       table_id=0):
 489         """ Add a GRE tunnel
 490         :param src_ip:
 491         :param dst_ip:
 492         :param src_port:
 493         :param dst_port:
 494         :param outer_fib_id:  (Default value = 0)
 495         """
 496
 497         return self.api(
 498             self.papi.udp_encap_add,
 499             {
 500                 'udp_encap': {
 501                     'src_ip': src_ip,
 502                     'dst_ip': dst_ip,
 503                     'src_port': src_port,
 504                     'dst_port': dst_port,
 505                     'table_id': table_id
 506                 }
 507             })
 508
 509     def udp_encap_del(self, id):
 510         return self.api(self.papi.udp_encap_del, {'id': id})
 511
 512     def udp_encap_dump(self):
 513         return self.api(self.papi.udp_encap_dump, {})
 514
 515     def want_udp_encap_stats(self, enable=1):
 516         return self.api(self.papi.want_udp_encap_stats,
 517                         {'enable': enable,
 518                          'pid': os.getpid()})
 519
 520     def mpls_route_dump(self, table_id):
 521         return self.api(self.papi.mpls_route_dump,
 522                         {'table': {
 523                             'mt_table_id': table_id
 524                         }})
 525
 526     def mpls_table_dump(self):
 527         return self.api(self.papi.mpls_table_dump, {})
 528
 529     def mpls_table_add_del(
 530             self,
 531             table_id,
 532             is_add=1):
 533         """
 534
 535         :param table_id
 536         :param is_add:  (Default value = 1)
 537
 538         """
 539
 540         return self.api(
 541             self.papi.mpls_table_add_del,
 542             {'mt_table':
 543              {
 544                  'mt_table_id': table_id,
 545              },
 546              'mt_is_add': is_add})
 547
 548     def mpls_route_add_del(self,
 549                            table_id,
 550                            label,
 551                            eos,
 552                            eos_proto,
 553                            is_multicast,
 554                            paths,
 555                            is_add,
 556                            is_multipath):
 557         """ MPLS Route add/del """
 558         return self.api(
 559             self.papi.mpls_route_add_del,
 560             {'mr_route':
 561              {
 562                  'mr_table_id': table_id,
 563                  'mr_label': label,
 564                  'mr_eos': eos,
 565                  'mr_eos_proto': eos_proto,
 566                  'mr_is_multicast': is_multicast,
 567                  'mr_n_paths': len(paths),
 568                  'mr_paths': paths,
 569              },
 570              'mr_is_add': is_add,
 571              'mr_is_multipath': is_multipath})
 572
 573     def mpls_ip_bind_unbind(
 574             self,
 575             label,
 576             prefix,
 577             table_id=0,
 578             ip_table_id=0,
 579             is_bind=1):
 580         """
 581         """
 582         return self.api(
 583             self.papi.mpls_ip_bind_unbind,
 584             {'mb_mpls_table_id': table_id,
 585              'mb_label': label,
 586              'mb_ip_table_id': ip_table_id,
 587              'mb_is_bind': is_bind,
 588              'mb_prefix': prefix})
 589
 590     def mpls_tunnel_add_del(
 591             self,
 592             tun_sw_if_index,
 593             paths,
 594             is_add=1,
 595             l2_only=0,
 596             is_multicast=0):
 597         """
 598         """
 599         return self.api(
 600             self.papi.mpls_tunnel_add_del,
 601             {'mt_is_add': is_add,
 602              'mt_tunnel':
 603              {
 604                  'mt_sw_if_index': tun_sw_if_index,
 605                  'mt_l2_only': l2_only,
 606                  'mt_is_multicast': is_multicast,
 607                  'mt_n_paths': len(paths),
 608                  'mt_paths': paths,
 609              }})
 610
 611     def input_acl_set_interface(
 612             self,
 613             is_add,
 614             sw_if_index,
 615             ip4_table_index=0xFFFFFFFF,
 616             ip6_table_index=0xFFFFFFFF,
 617             l2_table_index=0xFFFFFFFF):
 618         """
 619         :param is_add:
 620         :param sw_if_index:
 621         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
 622         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
 623         :param l2_table_index:  (Default value = 0xFFFFFFFF)
 624         """
 625
 626         return self.api(
 627             self.papi.input_acl_set_interface,
 628             {'sw_if_index': sw_if_index,
 629              'ip4_table_index': ip4_table_index,
 630              'ip6_table_index': ip6_table_index,
 631              'l2_table_index': l2_table_index,
 632              'is_add': is_add})
 633
 634     def output_acl_set_interface(
 635             self,
 636             is_add,
 637             sw_if_index,
 638             ip4_table_index=0xFFFFFFFF,
 639             ip6_table_index=0xFFFFFFFF,
 640             l2_table_index=0xFFFFFFFF):
 641         """
 642         :param is_add:
 643         :param sw_if_index:
 644         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
 645         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
 646         :param l2_table_index:  (Default value = 0xFFFFFFFF)
 647         """
 648
 649         return self.api(
 650             self.papi.output_acl_set_interface,
 651             {'sw_if_index': sw_if_index,
 652              'ip4_table_index': ip4_table_index,
 653              'ip6_table_index': ip6_table_index,
 654              'l2_table_index': l2_table_index,
 655              'is_add': is_add})
 656
 657     def set_ipfix_exporter(
 658             self,
 659             collector_address,
 660             src_address,
 661             path_mtu,
 662             template_interval,
 663             vrf_id=0,
 664             collector_port=4739,
 665             udp_checksum=0):
 666         return self.api(
 667             self.papi.set_ipfix_exporter,
 668             {
 669                 'collector_address': collector_address,
 670                 'collector_port': collector_port,
 671                 'src_address': src_address,
 672                 'vrf_id': vrf_id,
 673                 'path_mtu': path_mtu,
 674                 'template_interval': template_interval,
 675                 'udp_checksum': udp_checksum,
 676             })
 677
 678     def ip_mroute_add_del(self,
 679                           table_id,
 680                           prefix,
 681                           e_flags,
 682                           rpf_id,
 683                           paths,
 684                           is_add=1,
 685                           is_multipath=1):
 686         """
 687         IP Multicast Route add/del
 688         """
 689         return self.api(
 690             self.papi.ip_mroute_add_del,
 691             {
 692                 'is_add': is_add,
 693                 'is_multipath': is_multipath,
 694                 'route': {
 695                     'table_id': table_id,
 696                     'entry_flags': e_flags,
 697                     'rpf_id': rpf_id,
 698                     'prefix': prefix,
 699                     'n_paths': len(paths),
 700                     'paths': paths,
 701                 }
 702             })
 703
 704     def mfib_signal_dump(self):
 705         return self.api(self.papi.mfib_signal_dump, {})
 706
 707     def ip_mroute_dump(self, table_id, is_ip6=False):
 708         return self.api(self.papi.ip_mroute_dump,
 709                         {'table': {
 710                             'table_id': table_id,
 711                             'is_ip6': is_ip6
 712                         }})
 713
 714     def lisp_enable_disable(self, is_enabled):
 715         return self.api(
 716             self.papi.lisp_enable_disable,
 717             {
 718                 'is_en': is_enabled,
 719             })
 720
 721     def lisp_add_del_locator_set(self,
 722                                  ls_name,
 723                                  is_add=1):
 724         return self.api(
 725             self.papi.lisp_add_del_locator_set,
 726             {
 727                 'is_add': is_add,
 728                 'locator_set_name': ls_name
 729             })
 730
 731     def lisp_add_del_locator(self,
 732                              ls_name,
 733                              sw_if_index,
 734                              priority=1,
 735                              weight=1,
 736                              is_add=1):
 737         return self.api(
 738             self.papi.lisp_add_del_locator,
 739             {
 740                 'is_add': is_add,
 741                 'locator_set_name': ls_name,
 742                 'sw_if_index': sw_if_index,
 743                 'priority': priority,
 744                 'weight': weight
 745             })
 746
 747     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
 748         return self.api(
 749             self.papi.lisp_locator_dump,
 750             {
 751                 'is_index_set': is_index_set,
 752                 'ls_name': ls_name,
 753                 'ls_index': ls_index,
 754             })
 755
 756     def lisp_add_del_local_eid(self,
 757                                ls_name,
 758                                eid_type,
 759                                eid,
 760                                prefix_len,
 761                                vni=0,
 762                                key_id=0,
 763                                key="",
 764                                is_add=1):
 765         return self.api(
 766             self.papi.lisp_add_del_local_eid,
 767             {
 768                 'locator_set_name': ls_name,
 769                 'is_add': is_add,
 770                 'eid_type': eid_type,
 771                 'eid': eid,
 772                 'prefix_len': prefix_len,
 773                 'vni': vni,
 774                 'key_id': key_id,
 775                 'key': key
 776             })
 777
 778     def lisp_eid_table_dump(self,
 779                             eid_set=0,
 780                             prefix_length=0,
 781                             vni=0,
 782                             eid_type=0,
 783                             eid=None,
 784                             filter_opt=0):
 785         return self.api(
 786             self.papi.lisp_eid_table_dump,
 787             {
 788                 'eid_set': eid_set,
 789                 'prefix_length': prefix_length,
 790                 'vni': vni,
 791                 'eid_type': eid_type,
 792                 'eid': eid,
 793                 'filter': filter_opt,
 794             })
 795
 796     def lisp_add_del_remote_mapping(self,
 797                                     eid_type,
 798                                     eid,
 799                                     eid_prefix_len=0,
 800                                     vni=0,
 801                                     rlocs=[],
 802                                     rlocs_num=0,
 803                                     is_src_dst=0,
 804                                     is_add=1):
 805         return self.api(
 806             self.papi.lisp_add_del_remote_mapping,
 807             {
 808                 'is_add': is_add,
 809                 'eid_type': eid_type,
 810                 'eid': eid,
 811                 'eid_len': eid_prefix_len,
 812                 'rloc_num': rlocs_num,
 813                 'rlocs': rlocs,
 814                 'vni': vni,
 815                 'is_src_dst': is_src_dst,
 816             })
 817
 818     def lisp_add_del_adjacency(self,
 819                                leid,
 820                                reid,
 821                                leid_len,
 822                                reid_len,
 823                                eid_type,
 824                                is_add=1,
 825                                vni=0):
 826         return self.api(
 827             self.papi.lisp_add_del_adjacency,
 828             {
 829                 'is_add': is_add,
 830                 'vni': vni,
 831                 'eid_type': eid_type,
 832                 'leid': leid,
 833                 'reid': reid,
 834                 'leid_len': leid_len,
 835                 'reid_len': reid_len,
 836             })
 837
 838     def vxlan_gpe_add_del_tunnel(
 839             self,
 840             src_addr,
 841             dst_addr,
 842             mcast_sw_if_index=0xFFFFFFFF,
 843             is_add=1,
 844             is_ipv6=0,
 845             encap_vrf_id=0,
 846             decap_vrf_id=0,
 847             protocol=3,
 848             vni=0):
 849         """
 850
 851         :param local:
 852         :param remote:
 853         :param is_add:  (Default value = 1)
 854         :param is_ipv6:  (Default value = 0)
 855         :param encap_vrf_id:  (Default value = 0)
 856         :param decap_vrf_id:  (Default value = 0)
 857         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 858         :param protocol:  (Default value = 3)
 859         :param vni:  (Default value = 0)
 860
 861         """
 862         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
 863                         {'is_add': is_add,
 864                          'is_ipv6': is_ipv6,
 865                          'local': src_addr,
 866                          'remote': dst_addr,
 867                          'mcast_sw_if_index': mcast_sw_if_index,
 868                          'encap_vrf_id': encap_vrf_id,
 869                          'decap_vrf_id': decap_vrf_id,
 870                          'protocol': protocol,
 871                          'vni': vni})
 872
 873     def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
 874         return self.api(self.papi.vxlan_gbp_tunnel_dump,
 875                         {'sw_if_index': sw_if_index})
 876
 877     def pppoe_add_del_session(
 878             self,
 879             client_ip,
 880             client_mac,
 881             session_id=0,
 882             is_add=1,
 883             decap_vrf_id=0):
 884         """
 885
 886         :param is_add:  (Default value = 1)
 887         :param is_ipv6:  (Default value = 0)
 888         :param client_ip:
 889         :param session_id:  (Default value = 0)
 890         :param client_mac:
 891         :param decap_vrf_id:  (Default value = 0)
 892
 893         """
 894         return self.api(self.papi.pppoe_add_del_session,
 895                         {'is_add': is_add,
 896                          'session_id': session_id,
 897                          'client_ip': client_ip,
 898                          'decap_vrf_id': decap_vrf_id,
 899                          'client_mac': client_mac})
 900
 901     def sr_mpls_policy_add(self, bsid, weight, type, segments):
 902         return self.api(self.papi.sr_mpls_policy_add,
 903                         {'bsid': bsid,
 904                          'weight': weight,
 905                          'is_spray': type,
 906                          'n_segments': len(segments),
 907                          'segments': segments})
 908
 909     def sr_mpls_policy_del(self, bsid):
 910         return self.api(self.papi.sr_mpls_policy_del,
 911                         {'bsid': bsid})
 912
 913     def ip_punt_police(self,
 914                        policer_index,
 915                        is_ip6=0,
 916                        is_add=1):
 917         return self.api(self.papi.ip_punt_police,
 918                         {'policer_index': policer_index,
 919                          'is_add': is_add,
 920                          'is_ip6': is_ip6})
 921
 922     def ip_punt_redirect(self,
 923                          rx_sw_if_index,
 924                          tx_sw_if_index,
 925                          address,
 926                          is_add=1):
 927         return self.api(self.papi.ip_punt_redirect,
 928                         {'punt': {'rx_sw_if_index': rx_sw_if_index,
 929                                   'tx_sw_if_index': tx_sw_if_index,
 930                                   'nh': address},
 931                          'is_add': is_add})
 932
 933     def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
 934         return self.api(self.papi.ip_punt_redirect_dump,
 935                         {'sw_if_index': sw_if_index,
 936                          'is_ipv6': is_ipv6})
 937
 938     def bier_table_add_del(self,
 939                            bti,
 940                            mpls_label,
 941                            is_add=1):
 942         """ BIER Table add/del """
 943         return self.api(
 944             self.papi.bier_table_add_del,
 945             {'bt_tbl_id': {"bt_set": bti.set_id,
 946                            "bt_sub_domain": bti.sub_domain_id,
 947                            "bt_hdr_len_id": bti.hdr_len_id},
 948              'bt_label': mpls_label,
 949              'bt_is_add': is_add})
 950
 951     def bier_table_dump(self):
 952         return self.api(self.papi.bier_table_dump, {})
 953
 954     def bier_route_add_del(self,
 955                            bti,
 956                            bp,
 957                            paths,
 958                            is_add=1,
 959                            is_replace=0):
 960         """ BIER Route add/del """
 961         return self.api(
 962             self.papi.bier_route_add_del,
 963             {
 964                 'br_route': {
 965                     'br_tbl_id': {"bt_set": bti.set_id,
 966                                   "bt_sub_domain": bti.sub_domain_id,
 967                                   "bt_hdr_len_id": bti.hdr_len_id},
 968                     'br_bp': bp,
 969                     'br_n_paths': len(paths),
 970                     'br_paths': paths,
 971                 },
 972                 'br_is_add': is_add,
 973                 'br_is_replace': is_replace
 974             })
 975
 976     def bier_route_dump(self, bti):
 977         return self.api(
 978             self.papi.bier_route_dump,
 979             {'br_tbl_id': {"bt_set": bti.set_id,
 980                            "bt_sub_domain": bti.sub_domain_id,
 981                            "bt_hdr_len_id": bti.hdr_len_id}})
 982
 983     def bier_imp_add(self,
 984                      bti,
 985                      src,
 986                      ibytes,
 987                      is_add=1):
 988         """ BIER Imposition Add """
 989         return self.api(
 990             self.papi.bier_imp_add,
 991             {'bi_tbl_id': {"bt_set": bti.set_id,
 992                            "bt_sub_domain": bti.sub_domain_id,
 993                            "bt_hdr_len_id": bti.hdr_len_id},
 994              'bi_src': src,
 995              'bi_n_bytes': len(ibytes),
 996              'bi_bytes': ibytes})
 997
 998     def bier_imp_del(self, bi_index):
 999         """ BIER Imposition del """
1000         return self.api(
1001             self.papi.bier_imp_del,
1002             {'bi_index': bi_index})
1003
1004     def bier_imp_dump(self):
1005         return self.api(self.papi.bier_imp_dump, {})
1006
1007     def bier_disp_table_add_del(self,
1008                                 bdti,
1009                                 is_add=1):
1010         """ BIER Disposition Table add/del """
1011         return self.api(
1012             self.papi.bier_disp_table_add_del,
1013             {'bdt_tbl_id': bdti,
1014              'bdt_is_add': is_add})
1015
1016     def bier_disp_table_dump(self):
1017         return self.api(self.papi.bier_disp_table_dump, {})
1018
1019     def bier_disp_entry_add_del(self,
1020                                 bdti,
1021                                 bp,
1022                                 payload_proto,
1023                                 next_hop_afi,
1024                                 next_hop,
1025                                 next_hop_tbl_id=0,
1026                                 next_hop_rpf_id=~0,
1027                                 next_hop_is_ip4=1,
1028                                 is_add=1):
1029         """ BIER Route add/del """
1030         lstack = []
1031         while (len(lstack) < 16):
1032             lstack.append({})
1033         return self.api(
1034             self.papi.bier_disp_entry_add_del,
1035             {'bde_tbl_id': bdti,
1036              'bde_bp': bp,
1037              'bde_payload_proto': payload_proto,
1038              'bde_n_paths': 1,
1039              'bde_paths': [{'table_id': next_hop_tbl_id,
1040                             'rpf_id': next_hop_rpf_id,
1041                             'n_labels': 0,
1042                             'label_stack': lstack}],
1043              'bde_is_add': is_add})
1044
1045     def bier_disp_entry_dump(self, bdti):
1046         return self.api(
1047             self.papi.bier_disp_entry_dump,
1048             {'bde_tbl_id': bdti})
1049
1050     def session_enable_disable(self, is_enabled):
1051         return self.api(
1052             self.papi.session_enable_disable,
1053             {'is_enable': is_enabled})
1054
1055     def ipsec_spd_add_del(self, spd_id, is_add=1):
1056         """ SPD add/del - Wrapper to add or del ipsec SPD
1057         Sample CLI : 'ipsec spd add 1'
1058
1059         :param spd_id - SPD ID to be created in the vpp . mandatory
1060         :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1061               optional
1062         :returns: reply from the API
1063         """
1064         return self.api(
1065             self.papi.ipsec_spd_add_del, {
1066                 'spd_id': spd_id, 'is_add': is_add})
1067
1068     def ipsec_spds_dump(self):
1069         return self.api(self.papi.ipsec_spds_dump, {})
1070
1071     def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1072         """ IPSEC interface SPD add/del - \
1073              Wrapper to associate/disassociate SPD to interface in VPP
1074         Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1075
1076         :param spd_id - SPD ID to associate with the interface . mandatory
1077         :param sw_if_index - Interface Index which needs to ipsec \
1078             association mandatory
1079         :param is_add - add(1) or del(0) association with interface \
1080                 (Default 1 - add) . optional
1081         :returns: reply from the API
1082         """
1083         return self.api(
1084             self.papi.ipsec_interface_add_del_spd,
1085             {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1086
1087     def ipsec_spd_interface_dump(self, spd_index=None):
1088         return self.api(self.papi.ipsec_spd_interface_dump,
1089                         {'spd_index': spd_index if spd_index else 0,
1090                          'spd_index_valid': 1 if spd_index else 0})
1091
1092     def ipsec_sad_entry_add_del(self,
1093                                 sad_id,
1094                                 spi,
1095                                 integrity_algorithm,
1096                                 integrity_key,
1097                                 crypto_algorithm,
1098                                 crypto_key,
1099                                 protocol,
1100                                 tunnel_src_address='',
1101                                 tunnel_dst_address='',
1102                                 flags=0,
1103                                 salt=0,
1104                                 is_add=1):
1105         """ IPSEC SA add/del
1106         :param sad_id: security association ID
1107         :param spi: security param index of the SA in decimal
1108         :param integrity_algorithm:
1109         :param integrity_key:
1110         :param crypto_algorithm:
1111         :param crypto_key:
1112         :param protocol: AH(0) or ESP(1) protocol
1113         :param tunnel_src_address: tunnel mode outer src address
1114         :param tunnel_dst_address: tunnel mode outer dst address
1115         :param is_add:
1116         :param is_tunnel:
1117         :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1118              crypto and ipsec algorithms
1119         """
1120         return self.api(
1121             self.papi.ipsec_sad_entry_add_del,
1122             {
1123                 'is_add': is_add,
1124                 'entry':
1125                     {
1126                         'sad_id': sad_id,
1127                         'spi': spi,
1128                         'tunnel_src': tunnel_src_address,
1129                         'tunnel_dst': tunnel_dst_address,
1130                         'protocol': protocol,
1131                         'integrity_algorithm': integrity_algorithm,
1132                         'integrity_key': {
1133                             'length': len(integrity_key),
1134                             'data': integrity_key,
1135                         },
1136                         'crypto_algorithm': crypto_algorithm,
1137                         'crypto_key': {
1138                             'length': len(crypto_key),
1139                             'data': crypto_key,
1140                         },
1141                         'flags': flags,
1142                         'salt': salt,
1143                     }
1144             })
1145
1146     def ipsec_sa_dump(self, sa_id=None):
1147         return self.api(self.papi.ipsec_sa_dump,
1148                         {'sa_id': sa_id if sa_id else 0xffffffff})
1149
1150     def ipsec_spd_entry_add_del(self,
1151                                 spd_id,
1152                                 sa_id,
1153                                 local_address_start,
1154                                 local_address_stop,
1155                                 remote_address_start,
1156                                 remote_address_stop,
1157                                 local_port_start=0,
1158                                 local_port_stop=65535,
1159                                 remote_port_start=0,
1160                                 remote_port_stop=65535,
1161                                 protocol=0,
1162                                 policy=0,
1163                                 priority=100,
1164                                 is_outbound=1,
1165                                 is_add=1,
1166                                 is_ipv6=0,
1167                                 is_ip_any=0):
1168         """ IPSEC policy SPD add/del   -
1169                     Wrapper to configure ipsec SPD policy entries in VPP
1170         :param spd_id: SPD ID for the policy
1171         :param local_address_start: local-ip-range start address
1172         :param local_address_stop : local-ip-range stop address
1173         :param remote_address_start: remote-ip-range start address
1174         :param remote_address_stop : remote-ip-range stop address
1175         :param local_port_start: (Default value = 0)
1176         :param local_port_stop: (Default value = 65535)
1177         :param remote_port_start: (Default value = 0)
1178         :param remote_port_stop: (Default value = 65535)
1179         :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1180         :param sa_id: Security Association ID for mapping it to SPD
1181         :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1182                (Default value = 0)
1183         :param priority: value for the spd action (Default value = 100)
1184         :param is_outbound: flag for inbound(0) or outbound(1)
1185                (Default value = 1)
1186         :param is_add: (Default value = 1)
1187         """
1188         return self.api(
1189             self.papi.ipsec_spd_entry_add_del,
1190             {
1191                 'is_add': is_add,
1192                 'entry':
1193                     {
1194                         'spd_id': spd_id,
1195                         'sa_id': sa_id,
1196                         'local_address_start': local_address_start,
1197                         'local_address_stop': local_address_stop,
1198                         'remote_address_start': remote_address_start,
1199                         'remote_address_stop': remote_address_stop,
1200                         'local_port_start': local_port_start,
1201                         'local_port_stop': local_port_stop,
1202                         'remote_port_start': remote_port_start,
1203                         'remote_port_stop': remote_port_stop,
1204                         'protocol': protocol,
1205                         'policy': policy,
1206                         'priority': priority,
1207                         'is_outbound': is_outbound,
1208                     }
1209             })
1210
1211     def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1212         return self.api(self.papi.ipsec_spd_dump,
1213                         {'spd_id': spd_id,
1214                          'sa_id': sa_id})
1215
1216     def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1217                                 remote_spi, crypto_alg, local_crypto_key,
1218                                 remote_crypto_key, integ_alg, local_integ_key,
1219                                 remote_integ_key, is_add=1, esn=0, salt=0,
1220                                 anti_replay=1, renumber=0,
1221                                 udp_encap=0, show_instance=0xffffffff):
1222         return self.api(
1223             self.papi.ipsec_tunnel_if_add_del,
1224             {
1225                 'local_ip': local_ip,
1226                 'remote_ip': remote_ip,
1227                 'local_spi': local_spi,
1228                 'remote_spi': remote_spi,
1229                 'crypto_alg': crypto_alg,
1230                 'local_crypto_key_len': len(local_crypto_key),
1231                 'local_crypto_key': local_crypto_key,
1232                 'remote_crypto_key_len': len(remote_crypto_key),
1233                 'remote_crypto_key': remote_crypto_key,
1234                 'integ_alg': integ_alg,
1235                 'local_integ_key_len': len(local_integ_key),
1236                 'local_integ_key': local_integ_key,
1237                 'remote_integ_key_len': len(remote_integ_key),
1238                 'remote_integ_key': remote_integ_key,
1239                 'is_add': is_add,
1240                 'esn': esn,
1241                 'anti_replay': anti_replay,
1242                 'renumber': renumber,
1243                 'show_instance': show_instance,
1244                 'udp_encap': udp_encap,
1245                 'salt': salt
1246             })
1247
1248     def ipsec_select_backend(self, protocol, index):
1249         return self.api(self.papi.ipsec_select_backend,
1250                         {'protocol': protocol, 'index': index})
1251
1252     def ipsec_backend_dump(self):
1253         return self.api(self.papi.ipsec_backend_dump, {})
1254
1255     def app_namespace_add_del(self,
1256                               namespace_id,
1257                               ip4_fib_id=0,
1258                               ip6_fib_id=0,
1259                               sw_if_index=0xFFFFFFFF,
1260                               secret=0):
1261         return self.api(
1262             self.papi.app_namespace_add_del,
1263             {'secret': secret,
1264              'sw_if_index': sw_if_index,
1265              'ip4_fib_id': ip4_fib_id,
1266              'ip6_fib_id': ip6_fib_id,
1267              'namespace_id': namespace_id})
1268
1269     def punt_socket_register(self, reg, pathname,
1270                              header_version=1):
1271         """ Register punt socket """
1272         return self.api(self.papi.punt_socket_register,
1273                         {'header_version': header_version,
1274                          'punt': reg,
1275                          'pathname': pathname})
1276
1277     def punt_socket_deregister(self, reg):
1278         """ Unregister punt socket """
1279         return self.api(self.papi.punt_socket_deregister,
1280                         {'punt': reg})
1281
1282     def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1283                          tun_src, tun_dst):
1284         """ GBP endpoint Add """
1285         return self.api(self.papi.gbp_endpoint_add,
1286                         {'endpoint': {
1287                             'sw_if_index': sw_if_index,
1288                             'ips': ips,
1289                             'n_ips': len(ips),
1290                             'mac': mac,
1291                             'sclass': sclass,
1292                             'flags': flags,
1293                             'tun': {
1294                                 'src': tun_src,
1295                                 'dst': tun_dst,
1296                             }}})
1297
1298     def gbp_endpoint_del(self, handle):
1299         """ GBP endpoint Del """
1300         return self.api(self.papi.gbp_endpoint_del,
1301                         {'handle': handle})
1302
1303     def gbp_endpoint_dump(self):
1304         """ GBP endpoint Dump """
1305         return self.api(self.papi.gbp_endpoint_dump, {})
1306
1307     def gbp_endpoint_group_add(self, vnid, sclass, bd,
1308                                rd, uplink_sw_if_index,
1309                                retention):
1310         """ GBP endpoint group Add """
1311         return self.api(self.papi.gbp_endpoint_group_add,
1312                         {'epg':
1313                             {
1314                                 'uplink_sw_if_index': uplink_sw_if_index,
1315                                 'bd_id': bd,
1316                                 'rd_id': rd,
1317                                 'vnid': vnid,
1318                                 'sclass': sclass,
1319                                 'retention': retention
1320                             }})
1321
1322     def gbp_endpoint_group_del(self, sclass):
1323         """ GBP endpoint group Del """
1324         return self.api(self.papi.gbp_endpoint_group_del,
1325                         {'sclass': sclass})
1326
1327     def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1328                               bvi_sw_if_index,
1329                               uu_fwd_sw_if_index,
1330                               bm_flood_sw_if_index):
1331         """ GBP bridge-domain Add """
1332         return self.api(self.papi.gbp_bridge_domain_add,
1333                         {'bd':
1334                             {
1335                                 'flags': flags,
1336                                 'bvi_sw_if_index': bvi_sw_if_index,
1337                                 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1338                                 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1339                                 'bd_id': bd_id,
1340                                 'rd_id': rd_id
1341                             }})
1342
1343     def gbp_bridge_domain_del(self, bd_id):
1344         """ GBP bridge-domain Del """
1345         return self.api(self.papi.gbp_bridge_domain_del,
1346                         {'bd_id': bd_id})
1347
1348     def gbp_route_domain_add(self, rd_id,
1349                              scope,
1350                              ip4_table_id,
1351                              ip6_table_id,
1352                              ip4_uu_sw_if_index,
1353                              ip6_uu_sw_if_index):
1354         """ GBP route-domain Add """
1355         return self.api(self.papi.gbp_route_domain_add,
1356                         {'rd':
1357                             {
1358                                 'scope': scope,
1359                                 'ip4_table_id': ip4_table_id,
1360                                 'ip6_table_id': ip6_table_id,
1361                                 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1362                                 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1363                                 'rd_id': rd_id
1364                             }})
1365
1366     def gbp_route_domain_del(self, rd_id):
1367         """ GBP route-domain Del """
1368         return self.api(self.papi.gbp_route_domain_del,
1369                         {'rd_id': rd_id})
1370
1371     def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1372         """ GBP recirc Add/Del """
1373         return self.api(self.papi.gbp_recirc_add_del,
1374                         {'is_add': is_add,
1375                          'recirc': {
1376                              'is_ext': is_ext,
1377                              'sw_if_index': sw_if_index,
1378                              'sclass': sclass}})
1379
1380     def gbp_recirc_dump(self):
1381         """ GBP recirc Dump """
1382         return self.api(self.papi.gbp_recirc_dump, {})
1383
1384     def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1385         """ GBP recirc Add/Del """
1386         return self.api(self.papi.gbp_ext_itf_add_del,
1387                         {'is_add': is_add,
1388                          'ext_itf': {
1389                              'sw_if_index': sw_if_index,
1390                              'bd_id': bd_id,
1391                              'rd_id': rd_id,
1392                              'flags': flags}})
1393
1394     def gbp_ext_itf_dump(self):
1395         """ GBP recirc Dump """
1396         return self.api(self.papi.gbp_ext_itf_dump, {})
1397
1398     def gbp_subnet_add_del(self, is_add, rd_id,
1399                            prefix, type,
1400                            sw_if_index=0xffffffff,
1401                            sclass=0xffff):
1402         """ GBP Subnet Add/Del """
1403         return self.api(self.papi.gbp_subnet_add_del,
1404                         {'is_add': is_add,
1405                          'subnet': {
1406                              'type': type,
1407                              'sw_if_index': sw_if_index,
1408                              'sclass': sclass,
1409                              'prefix': prefix,
1410                              'rd_id': rd_id}})
1411
1412     def gbp_subnet_dump(self):
1413         """ GBP Subnet Dump """
1414         return self.api(self.papi.gbp_subnet_dump, {})
1415
1416     def gbp_contract_dump(self):
1417         """ GBP contract Dump """
1418         return self.api(self.papi.gbp_contract_dump, {})
1419
1420     def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1421         """ GBP VXLAN tunnel add """
1422         return self.api(self.papi.gbp_vxlan_tunnel_add,
1423                         {
1424                             'tunnel': {
1425                                 'vni': vni,
1426                                 'mode': mode,
1427                                 'bd_rd_id': bd_rd_id,
1428                                 'src': src
1429                             }
1430                         })
1431
1432     def gbp_vxlan_tunnel_del(self, vni):
1433         """ GBP VXLAN tunnel del """
1434         return self.api(self.papi.gbp_vxlan_tunnel_del,
1435                         {
1436                             'vni': vni,
1437                         })
1438
1439     def gbp_vxlan_tunnel_dump(self):
1440         """ GBP VXLAN tunnel add/del """
1441         return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1442
1443     def igmp_enable_disable(self, sw_if_index, enable, host):
1444         """ Enable/disable IGMP on a given interface """
1445         return self.api(self.papi.igmp_enable_disable,
1446                         {'enable': enable,
1447                          'mode': host,
1448                          'sw_if_index': sw_if_index})
1449
1450     def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1451         """ Add/del IGMP proxy device """
1452         return self.api(self.papi.igmp_proxy_device_add_del,
1453                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1454                          'add': add})
1455
1456     def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1457         """ Add/del interface to/from IGMP proxy device """
1458         return self.api(self.papi.igmp_proxy_device_add_del_interface,
1459                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1460                          'add': add})
1461
1462     def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1463         """ Listen for new (S,G) on specified interface
1464
1465         :param enable: add/del
1466         :param sw_if_index: interface sw index
1467         :param saddr: source ip4 addr
1468         :param gaddr: group ip4 addr
1469         """
1470         return self.api(self.papi.igmp_listen,
1471                         {
1472                             'group':
1473                                 {
1474                                     'filter': filter,
1475                                     'sw_if_index': sw_if_index,
1476                                     'n_srcs': len(saddrs),
1477                                     'saddrs': saddrs,
1478                                     'gaddr': gaddr
1479                                 }
1480                         })
1481
1482     def igmp_clear_interface(self, sw_if_index):
1483         """ Remove all (S,G)s from specified interface
1484             doesn't send IGMP report!
1485         """
1486         return self.api(
1487             self.papi.igmp_clear_interface, {
1488                 'sw_if_index': sw_if_index})
1489
1490     def want_igmp_events(self, enable=1):
1491         return self.api(self.papi.want_igmp_events, {'enable': enable,
1492                                                      'pid': os.getpid()})
1493
1494     def bond_create(
1495             self,
1496             mode,
1497             lb,
1498             numa_only,
1499             use_custom_mac,
1500             mac_address='',
1501             interface_id=0xFFFFFFFF):
1502         """
1503         :param mode: mode
1504         :param lb: load balance
1505         :param numa_only: tx on local numa node for lacp mode
1506         :param use_custom_mac: use custom mac
1507         :param mac_address: mac address
1508         :param interface_id: custom interface ID
1509         """
1510         return self.api(
1511             self.papi.bond_create,
1512             {'mode': mode,
1513              'lb': lb,
1514              'numa_only': numa_only,
1515              'use_custom_mac': use_custom_mac,
1516              'mac_address': mac_address,
1517              'id': interface_id
1518              })
1519
1520     def pipe_delete(self, parent_sw_if_index):
1521         return self.api(self.papi.pipe_delete,
1522                         {'parent_sw_if_index': parent_sw_if_index})
1523
1524     def svs_table_add_del(self, af, table_id, is_add=1):
1525         return self.api(self.papi.svs_table_add_del,
1526                         {
1527                             'table_id': table_id,
1528                             'is_add': is_add,
1529                             'af': af,
1530                         })
1531
1532     def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
1533         return self.api(self.papi.svs_route_add_del,
1534                         {
1535                             'table_id': table_id,
1536                             'source_table_id': src_table_id,
1537                             'prefix': prefix,
1538                             'is_add': is_add,
1539                         })
1540
1541     def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
1542         return self.api(self.papi.svs_enable_disable,
1543                         {
1544                             'af': af,
1545                             'table_id': table_id,
1546                             'sw_if_index': sw_if_index,
1547                             'is_enable': is_enable,
1548                         })
1549
1550     def feature_gso_enable_disable(self, sw_if_index, enable_disable=1):
1551         return self.api(self.papi.feature_gso_enable_disable,
1552                         {
1553                             'sw_if_index': sw_if_index,
1554                             'enable_disable': enable_disable,
1555                         })