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 VPP, mac_pton
  14 from hook import Hook
  15 from vpp_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID
  16
  17
  18 class QOS_SOURCE:
  19     EXT = 0
  20     VLAN = 1
  21     MPLS = 2
  22     IP = 3
  23
  24
  25 class SYSLOG_SEVERITY:
  26     EMERG = 0
  27     ALERT = 1
  28     CRIT = 2
  29     ERR = 3
  30     WARN = 4
  31     NOTICE = 5
  32     INFO = 6
  33     DBG = 7
  34
  35
  36 #
  37 # Dictionary keyed on message name to override default values for
  38 # named parameters
  39 #
  40 defaultmapping = {
  41     'map_add_domain': {'mtu': 1280},
  42     'syslog_set_sender': {'collector_port': 514,
  43                           'max_msg_size': 480},
  44     'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
  45     'acl_interface_list_dump': {'sw_if_index': 4294967295, },
  46     'app_namespace_add_del': {'sw_if_index': 4294967295, },
  47     'bd_ip_mac_add_del': {'is_add': 1, },
  48     'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
  49                                 'is_add': 1, },
  50     'bier_disp_table_add_del': {'is_add': 1, },
  51     'bier_imp_add': {'is_add': 1, },
  52     'bier_route_add_del': {'is_add': 1, },
  53     'bier_table_add_del': {'is_add': 1, },
  54     'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
  55                               'learn': 1, 'is_add': 1, },
  56     'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
  57                                'nbuckets': 2, 'memory_size': 2097152,
  58                                'next_table_index': 4294967295,
  59                                'miss_next_index': 4294967295, },
  60     'dhcp6_client_enable_disable': {'enable': 1, },
  61     'dhcp6_clients_enable_disable': {'enable': 1, },
  62     'dhcp6_pd_client_enable_disable': {'enable': 1, },
  63     'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
  64     'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
  65     'dhcp_proxy_config': {'is_add': 1, },
  66     'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
  67     'dslite_add_del_pool_addr_range': {'is_add': 1, },
  68     'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
  69     'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
  70                               'decap_next_index': 4294967295, },
  71     'gre_tunnel_add_del': {'instance': 4294967295, 'is_add': 1, },
  72     'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
  73                             'decap_next_index': 4294967295, },
  74     'input_acl_set_interface': {'ip4_table_index': 4294967295,
  75                                 'ip6_table_index': 4294967295,
  76                                 'l2_table_index': 4294967295, },
  77     'ip6_add_del_address_using_prefix': {'is_add': 1, },
  78     'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
  79     'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
  80                          'next_hop_weight': 1, 'next_hop_via_label': 1048576,
  81                          'next_hop_id': 4294967295,
  82                          'classify_table_index': 4294967295, 'is_add': 1, },
  83     'ip_mroute_add_del': {'is_add': 1, },
  84     'ip_neighbor_add_del': {'is_add': 1, },
  85     'ip_punt_police': {'is_add': 1, },
  86     'ip_punt_redirect': {'is_add': 1, },
  87     'ip_table_add_del': {'is_add': 1, },
  88     'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
  89     'ipip_add_tunnel': {'is_ipv6': 1, 'instance': 4294967295, },
  90     'ipsec_interface_add_del_spd': {'is_add': 1, },
  91     'ipsec_sad_entry_add_del': {'is_add': 1, },
  92     'ipsec_spd_add_del': {'is_add': 1, },
  93     'ipsec_spd_dump': {'sa_id': 4294967295, },
  94     'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
  95                                 'remote_port_stop': 65535, 'priority': 100,
  96                                 'is_outbound': 1,
  97                                 'is_add': 1, },
  98     'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
  99     'l2_emulation': {'enable': 1, },
 100     'l2fib_add_del': {'is_add': 1, },
 101     'lb_conf': {'sticky_buckets_per_core': 4294967295,
 102                 'flow_timeout': 4294967295},
 103     'lisp_add_del_adjacency': {'is_add': 1, },
 104     'lisp_add_del_local_eid': {'is_add': 1, },
 105     'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
 106     'lisp_add_del_locator_set': {'is_add': 1, },
 107     'lisp_add_del_remote_mapping': {'is_add': 1, },
 108     'macip_acl_add_replace': {'acl_index': 4294967295, },
 109     'macip_acl_dump': {'acl_index': 4294967295, },
 110     'macip_acl_interface_add_del': {'is_add': 1, },
 111     'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
 112     'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
 113                            'mr_next_hop_weight': 1,
 114                            'mr_next_hop_via_label': 1048576,
 115                            'mr_is_add': 1,
 116                            'mr_classify_table_index': 4294967295, },
 117     'mpls_table_add_del': {'is_add': 1, },
 118     'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
 119                             'next_hop_weight': 1,
 120                             'next_hop_via_label': 1048576,
 121                             'is_add': 1, },
 122     'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
 123     'nat44_add_del_address_range': {'is_add': 1, 'vrf_id': 4294967295, },
 124     'nat44_add_del_identity_mapping': {'ip': b'0', 'sw_if_index': 4294967295,
 125                                        'is_add': 1, },
 126     'nat44_add_del_interface_addr': {'is_add': 1, },
 127     'nat44_add_del_lb_static_mapping': {'is_add': 1, },
 128     'nat44_add_del_static_mapping': {'external_sw_if_index': 4294967295,
 129                                      'is_add': 1, },
 130     'nat44_interface_add_del_feature': {'is_add': 1, },
 131     'nat44_interface_add_del_output_feature': {'is_add': 1, },
 132     'nat44_lb_static_mapping_add_del_local': {'is_add': 1, },
 133     'nat64_add_del_interface': {'is_add': 1, },
 134     'nat64_add_del_interface_addr': {'is_add': 1, },
 135     'nat64_add_del_pool_addr_range': {'vrf_id': 4294967295, 'is_add': 1, },
 136     'nat64_add_del_prefix': {'is_add': 1, },
 137     'nat64_add_del_static_bib': {'is_add': 1, },
 138     'nat64_bib_dump': {'protocol': 255, },
 139     'nat64_st_dump': {'protocol': 255, },
 140     'nat66_add_del_interface': {'is_add': 1, },
 141     'nat66_add_del_static_mapping': {'is_add': 1, },
 142     'nat_det_add_del_map': {'is_add': 1, },
 143     'nat_ha_resync': {'want_resync_event': 1, },
 144     'nat_ha_set_failover': {'refresh': 10, },
 145     'nat_ha_set_listener': {'path_mtu': 512, },
 146     'nat_ipfix_enable_disable': {'domain_id': 1, 'src_port': 4739,
 147                                  'enable': 1, },
 148     'nat_set_mss_clamping': {'mss_value': 1500, },
 149     'nat_set_reass': {'timeout': 2, 'max_reass': 1024, 'max_frag': 5, },
 150     'nat_set_timeouts': {'udp': 300, 'tcp_established': 7440,
 151                          'tcp_transitory': 240, 'icmp': 60, },
 152     'output_acl_set_interface': {'ip4_table_index': 4294967295,
 153                                  'ip6_table_index': 4294967295,
 154                                  'l2_table_index': 4294967295, },
 155     'pppoe_add_del_session': {'is_add': 1, },
 156     'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
 157     'proxy_arp_add_del': {'is_add': 1, },
 158     'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
 159     'punt_socket_register': {'protocol': 17, 'header_version': 1,
 160                              'is_ip4': 1, },
 161     'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, },
 162     'punt_socket_dump': {'is_ip6': 1, },
 163     'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
 164                          'proto': 1, },
 165     'set_ipfix_exporter': {'collector_port': 4739, },
 166     'sr_localsid_add_del': {'sw_if_index': 4294967295, },
 167     'sr_policy_add': {'weight': 1, 'is_encap': 1, },
 168     'svs_enable_disable': {'is_enable': 1, },
 169     'svs_route_add_del': {'is_add': 1, },
 170     'svs_table_add_del': {'is_add': 1, },
 171     'sw_interface_add_del_address': {'is_add': 1, },
 172     'sw_interface_dump': {'sw_if_index': 4294967295, },
 173     'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
 174                                      'pref_lifetime': 4294967295, },
 175     'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
 176     'sw_interface_set_l2_bridge': {'enable': 1, },
 177     'sw_interface_set_mpls_enable': {'enable': 1, },
 178     'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
 179     'sw_interface_set_unnumbered': {'is_add': 1, },
 180     'sw_interface_span_enable_disable': {'state': 1, },
 181     'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 182                              'decap_next_index': 4294967295,
 183                              'instance': 4294967295, },
 184     'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 185                                  'instance': 4294967295, },
 186     'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
 187     'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 188                                  'protocol': 3, },
 189     'want_bfd_events': {'enable_disable': 1, },
 190     'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
 191     'want_dhcp6_reply_events': {'enable_disable': 1, },
 192     'want_igmp_events': {'enable': 1, },
 193     'want_interface_events': {'enable_disable': 1, },
 194     'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
 195     'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
 196     'want_ip6_ra_events': {'enable_disable': 1, },
 197     'want_l2_macs_events': {'enable_disable': 1, },
 198 }
 199
 200
 201 class UnexpectedApiReturnValueError(Exception):
 202     """ exception raised when the API return value is unexpected """
 203     pass
 204
 205
 206 class VppPapiProvider(object):
 207     """VPP-api provider using vpp-papi
 208
 209     @property hook: hook object providing before and after api/cli hooks
 210     """
 211
 212     _zero, _negative = range(2)
 213
 214     def __init__(self, name, shm_prefix, test_class, read_timeout):
 215         self.hook = Hook(test_class)
 216         self.name = name
 217         self.shm_prefix = shm_prefix
 218         self.test_class = test_class
 219         self._expect_api_retval = self._zero
 220         self._expect_stack = []
 221
 222         install_dir = os.getenv('VPP_INSTALL_PATH')
 223
 224         # Vapi requires 'VPP_API_DIR', not set when run from Makefile.
 225         if 'VPP_API_DIR' not in os.environ:
 226             os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH')
 227
 228         self.vpp = VPP(logger=test_class.logger,
 229                        read_timeout=read_timeout)
 230         self._events = deque()
 231
 232     def __enter__(self):
 233         return self
 234
 235     def assert_negative_api_retval(self):
 236         """ Expect API failure - used with with, e.g.:
 237             with self.vapi.assert_negative_api_retval():
 238                 self.vapi.<api call expected to fail>
 239         """
 240         self._expect_stack.append(self._expect_api_retval)
 241         self._expect_api_retval = self._negative
 242         return self
 243
 244     def assert_zero_api_retval(self):
 245         """ Expect API success - used with with, e.g.:
 246             with self.vapi.assert_negative_api_retval():
 247                 self.vapi.<api call expected to succeed>
 248
 249             note: this is useful only inside another with block
 250                   as success is the default expected value
 251         """
 252         self._expect_stack.append(self._expect_api_retval)
 253         self._expect_api_retval = self._zero
 254         return self
 255
 256     def __exit__(self, exc_type, exc_value, traceback):
 257         self._expect_api_retval = self._expect_stack.pop()
 258
 259     def register_hook(self, hook):
 260         """Replace hook registration with new hook
 261
 262         :param hook:
 263
 264         """
 265         self.hook = hook
 266
 267     def collect_events(self):
 268         """ Collect all events from the internal queue and clear the queue. """
 269         e = self._events
 270         self._events = deque()
 271         return e
 272
 273     def wait_for_event(self, timeout, name=None):
 274         """ Wait for and return next event. """
 275         if name:
 276             self.test_class.logger.debug("Expecting event '%s' within %ss",
 277                                          name, timeout)
 278         else:
 279             self.test_class.logger.debug("Expecting event within %ss",
 280                                          timeout)
 281         if self._events:
 282             self.test_class.logger.debug("Not waiting, event already queued")
 283         limit = time.time() + timeout
 284         while time.time() < limit:
 285             if self._events:
 286                 e = self._events.popleft()
 287                 if name and type(e).__name__ != name:
 288                     raise Exception(
 289                         "Unexpected event received: %s, expected: %s" %
 290                         (type(e).__name__, name))
 291                 self.test_class.logger.debug("Returning event %s:%s" %
 292                                              (name, e))
 293                 return e
 294             self.test_class.sleep(0)  # yield
 295         raise Exception("Event did not occur within timeout")
 296
 297     def __call__(self, name, event):
 298         """ Enqueue event in the internal event queue. """
 299         # FIXME use the name instead of relying on type(e).__name__ ?
 300         # FIXME #2 if this throws, it is eaten silently, Ole?
 301         self.test_class.logger.debug("New event: %s: %s" % (name, event))
 302         self._events.append(event)
 303
 304     def factory(self, name, apifn):
 305         def f(*a, **ka):
 306             fields = apifn._func.msg.fields
 307
 308             # add positional and kw arguments
 309             d = ka
 310             for i, o in enumerate(fields[3:]):
 311                 try:
 312                     d[o] = a[i]
 313                 except:
 314                     break
 315
 316             # Default override
 317             if name in defaultmapping:
 318                 for k, v in iteritems(defaultmapping[name]):
 319                     if k in d:
 320                         continue
 321                     d[k] = v
 322             return self.api(apifn, d)
 323
 324         return f
 325
 326     def __getattribute__(self, name):
 327         try:
 328             method = super(VppPapiProvider, self).__getattribute__(name)
 329         except AttributeError:
 330             method = self.factory(name, getattr(self.papi, name))
 331             # lazily load the method so we don't need to call factory
 332             # again for this name.
 333             setattr(self, name, method)
 334         return method
 335
 336     def connect(self):
 337         """Connect the API to VPP"""
 338         self.vpp.connect(self.name, self.shm_prefix)
 339         self.papi = self.vpp.api
 340         self.vpp.register_event_callback(self)
 341
 342     def disconnect(self):
 343         """Disconnect the API from VPP"""
 344         self.vpp.disconnect()
 345
 346     def api(self, api_fn, api_args, expected_retval=0):
 347         """ Call API function and check it's return value.
 348         Call the appropriate hooks before and after the API call
 349
 350         :param api_fn: API function to call
 351         :param api_args: tuple of API function arguments
 352         :param expected_retval: Expected return value (Default value = 0)
 353         :returns: reply from the API
 354
 355         """
 356         self.hook.before_api(api_fn.__name__, api_args)
 357         reply = api_fn(**api_args)
 358         if self._expect_api_retval == self._negative:
 359             if hasattr(reply, 'retval') and reply.retval >= 0:
 360                 msg = "API call passed unexpectedly: expected negative " \
 361                       "return value instead of %d in %s" % \
 362                       (reply.retval, moves.reprlib.repr(reply))
 363                 self.test_class.logger.info(msg)
 364                 raise UnexpectedApiReturnValueError(msg)
 365         elif self._expect_api_retval == self._zero:
 366             if hasattr(reply, 'retval') and reply.retval != expected_retval:
 367                 msg = "API call failed, expected %d return value instead " \
 368                       "of %d in %s" % (expected_retval, reply.retval,
 369                                        moves.reprlib.repr(reply))
 370                 self.test_class.logger.info(msg)
 371                 raise UnexpectedApiReturnValueError(msg)
 372         else:
 373             raise Exception("Internal error, unexpected value for "
 374                             "self._expect_api_retval %s" %
 375                             self._expect_api_retval)
 376         self.hook.after_api(api_fn.__name__, api_args)
 377         return reply
 378
 379     def cli(self, cli):
 380         """ Execute a CLI, calling the before/after hooks appropriately.
 381
 382         :param cli: CLI to execute
 383         :returns: CLI output
 384
 385         """
 386         self.hook.before_cli(cli)
 387         cli += '\n'
 388         r = self.papi.cli_inband(cmd=cli)
 389         self.hook.after_cli(cli)
 390         if hasattr(r, 'reply'):
 391             return r.reply
 392
 393     def ppcli(self, cli):
 394         """ Helper method to print CLI command in case of info logging level.
 395
 396         :param cli: CLI to execute
 397         :returns: CLI output
 398         """
 399         return cli + "\n" + str(self.cli(cli))
 400
 401     def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
 402         return self.api(self.papi.want_ip4_arp_events,
 403                         {'enable_disable': enable_disable,
 404                          'ip': ip,
 405                          'pid': os.getpid(), })
 406
 407     def want_ip6_nd_events(self, enable_disable=1, ip="::"):
 408         return self.api(self.papi.want_ip6_nd_events,
 409                         {'enable_disable': enable_disable,
 410                          'ip': ip,
 411                          'pid': os.getpid(), })
 412
 413     def want_ip6_ra_events(self, enable_disable=1):
 414         return self.api(self.papi.want_ip6_ra_events,
 415                         {'enable_disable': enable_disable,
 416                          'pid': os.getpid(), })
 417
 418     def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
 419                                        mrc=0, mrd=0):
 420         return self.api(self.papi.ip6nd_send_router_solicitation,
 421                         {'irt': irt,
 422                          'mrt': mrt,
 423                          'mrc': mrc,
 424                          'mrd': mrd,
 425                          'sw_if_index': sw_if_index})
 426
 427     def want_interface_events(self, enable_disable=1):
 428         return self.api(self.papi.want_interface_events,
 429                         {'enable_disable': enable_disable,
 430                          'pid': os.getpid(), })
 431
 432     def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
 433                             max_macs_in_event=0, learn_limit=0):
 434         return self.api(self.papi.want_l2_macs_events,
 435                         {'enable_disable': enable_disable,
 436                          'scan_delay': scan_delay,
 437                          'max_macs_in_event': max_macs_in_event,
 438                          'learn_limit': learn_limit,
 439                          'pid': os.getpid(), })
 440
 441     def want_dhcp6_reply_events(self, enable_disable=1):
 442         return self.api(self.papi.want_dhcp6_reply_events,
 443                         {'enable_disable': enable_disable,
 444                          'pid': os.getpid()})
 445
 446     def want_dhcp6_pd_reply_events(self, enable_disable=1):
 447         return self.api(self.papi.want_dhcp6_pd_reply_events,
 448                         {'enable_disable': enable_disable,
 449                          'pid': os.getpid()})
 450
 451     def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
 452                                      prefixes, server_index=0xFFFFFFFF,
 453                                      irt=0, mrt=0, mrc=1, mrd=0, stop=0,
 454                                      ):
 455         return self.api(self.papi.dhcp6_pd_send_client_message,
 456                         {'sw_if_index': sw_if_index,
 457                          'server_index': server_index,
 458                          'irt': irt,
 459                          'mrt': mrt,
 460                          'mrc': mrc,
 461                          'mrd': mrd,
 462                          'stop': stop,
 463                          'msg_type': msg_type,
 464                          'T1': T1,
 465                          'T2': T2,
 466                          'n_prefixes': len(prefixes),
 467                          'prefixes': prefixes})
 468
 469     def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
 470                                     enable=1):
 471         return self.api(self.papi.dhcp6_client_enable_disable,
 472                         {'sw_if_index': sw_if_index,
 473                          'enable': enable})
 474
 475     def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
 476                                        enable=1):
 477         return self.api(self.papi.dhcp6_pd_client_enable_disable,
 478                         {'sw_if_index': sw_if_index,
 479                          'prefix_group': prefix_group,
 480                          'enable': enable})
 481
 482     def ip6_add_del_address_using_prefix(self, sw_if_index, address,
 483                                          prefix_length, prefix_group,
 484                                          is_add=1):
 485         return self.api(self.papi.ip6_add_del_address_using_prefix,
 486                         {'sw_if_index': sw_if_index,
 487                          'prefix_group': prefix_group,
 488                          'address': address,
 489                          'prefix_length': prefix_length,
 490                          'is_add': is_add})
 491
 492     def sw_interface_set_mac_address(self, sw_if_index, mac):
 493         return self.api(self.papi.sw_interface_set_mac_address,
 494                         {'sw_if_index': sw_if_index,
 495                          'mac_address': mac})
 496
 497     def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
 498         """Create p2p ethernet subinterface
 499
 500         :param sw_if_index: main (parent) interface
 501         :param remote_mac: client (remote) mac address
 502
 503         """
 504         return self.api(
 505             self.papi.p2p_ethernet_add,
 506             {'parent_if_index': sw_if_index,
 507              'remote_mac': remote_mac,
 508              'subif_id': subif_id})
 509
 510     def p2p_ethernet_del(self, sw_if_index, remote_mac):
 511         """Delete p2p ethernet subinterface
 512
 513         :param sw_if_index: main (parent) interface
 514         :param remote_mac: client (remote) mac address
 515
 516         """
 517         return self.api(
 518             self.papi.p2p_ethernet_del,
 519             {'parent_if_index': sw_if_index,
 520              'remote_mac': remote_mac})
 521
 522     def create_vlan_subif(self, sw_if_index, vlan):
 523         """
 524
 525         :param vlan:
 526         :param sw_if_index:
 527
 528         """
 529         return self.api(self.papi.create_vlan_subif,
 530                         {'sw_if_index': sw_if_index,
 531                          'vlan_id': vlan})
 532
 533     def create_loopback(self, mac=''):
 534         """
 535
 536         :param mac: (Optional)
 537         """
 538         return self.api(self.papi.create_loopback,
 539                         {'mac_address': mac})
 540
 541     def ip_neighbor_add_del(self,
 542                             sw_if_index,
 543                             mac_address,
 544                             ip_address,
 545                             is_add=1,
 546                             flags=0):
 547         """ Add neighbor MAC to IPv4 or IPv6 address.
 548
 549         :param sw_if_index:
 550         :param mac_address:
 551         :param dst_address:
 552         :param is_add:  (Default value = 1)
 553         :param flags:  (Default value = 0/NONE)
 554         """
 555         return self.api(
 556             self.papi.ip_neighbor_add_del,
 557             {
 558                 'is_add': is_add,
 559                 'neighbor': {
 560                     'sw_if_index': sw_if_index,
 561                     'flags': flags,
 562                     'mac_address': mac_address,
 563                     'ip_address': ip_address
 564                 }
 565             }
 566         )
 567
 568     def proxy_arp_add_del(self,
 569                           low,
 570                           hi,
 571                           table_id=0,
 572                           is_add=1):
 573         """ Config Proxy Arp Range.
 574
 575         :param low_address: Start address in the rnage to Proxy for
 576         :param hi_address: End address in the rnage to Proxy for
 577         :param vrf_id: The VRF/table in which to proxy
 578         """
 579
 580         return self.api(
 581             self.papi.proxy_arp_add_del,
 582             {'proxy':
 583                 {
 584                     'table_id': table_id,
 585                     'low': low,
 586                     'hi': hi,
 587                 },
 588                 'is_add': is_add})
 589
 590     def proxy_arp_intfc_enable_disable(self,
 591                                        sw_if_index,
 592                                        is_enable=1):
 593         """ Enable/Disable an interface for proxy ARP requests
 594
 595         :param sw_if_index: Interface
 596         :param enable_disable: Enable/Disable
 597         """
 598
 599         return self.api(
 600             self.papi.proxy_arp_intfc_enable_disable,
 601             {'sw_if_index': sw_if_index,
 602              'enable_disable': is_enable
 603              }
 604         )
 605
 606     def gre_tunnel_add_del(self,
 607                            src,
 608                            dst,
 609                            outer_fib_id=0,
 610                            tunnel_type=0,
 611                            instance=0xFFFFFFFF,
 612                            session_id=0,
 613                            is_add=1):
 614         """ Add a GRE tunnel
 615
 616         :param src_address:
 617         :param dst_address:
 618         :param outer_fib_id:  (Default value = 0)
 619         :param tunnel_type:  (Default value = 0)
 620         :param instance:  (Default value = 0xFFFFFFFF)
 621         :param session_id: (Default value = 0)
 622         :param is_add:  (Default value = 1)
 623         :param is_ipv6:  (Default value = 0)
 624         """
 625
 626         return self.api(
 627             self.papi.gre_tunnel_add_del,
 628             {'is_add': is_add,
 629              'tunnel':
 630              {
 631                  'type': tunnel_type,
 632                  'instance': instance,
 633                  'src': src,
 634                  'dst': dst,
 635                  'outer_fib_id': outer_fib_id,
 636                  'session_id': session_id}
 637              }
 638         )
 639
 640     def udp_encap_add(self,
 641                       src_ip,
 642                       dst_ip,
 643                       src_port,
 644                       dst_port,
 645                       table_id=0):
 646         """ Add a GRE tunnel
 647         :param src_ip:
 648         :param dst_ip:
 649         :param src_port:
 650         :param dst_port:
 651         :param outer_fib_id:  (Default value = 0)
 652         """
 653
 654         return self.api(
 655             self.papi.udp_encap_add,
 656             {
 657                 'udp_encap': {
 658                     'src_ip': src_ip,
 659                     'dst_ip': dst_ip,
 660                     'src_port': src_port,
 661                     'dst_port': dst_port,
 662                     'table_id': table_id
 663                 }
 664             })
 665
 666     def mpls_table_add_del(
 667             self,
 668             table_id,
 669             is_add=1):
 670         """
 671
 672         :param table_id
 673         :param is_add:  (Default value = 1)
 674
 675         """
 676
 677         return self.api(
 678             self.papi.mpls_table_add_del,
 679             {'mt_table_id': table_id,
 680              'mt_is_add': is_add})
 681
 682     def mpls_ip_bind_unbind(
 683             self,
 684             label,
 685             dst_address,
 686             dst_address_length,
 687             table_id=0,
 688             ip_table_id=0,
 689             is_ip4=1,
 690             is_bind=1):
 691         """
 692         """
 693         return self.api(
 694             self.papi.mpls_ip_bind_unbind,
 695             {'mb_mpls_table_id': table_id,
 696              'mb_label': label,
 697              'mb_ip_table_id': ip_table_id,
 698              'mb_is_bind': is_bind,
 699              'mb_is_ip4': is_ip4,
 700              'mb_address_length': dst_address_length,
 701              'mb_address': dst_address})
 702
 703     def mpls_tunnel_add_del(
 704             self,
 705             tun_sw_if_index,
 706             next_hop_proto_is_ip4,
 707             next_hop_address,
 708             next_hop_sw_if_index=0xFFFFFFFF,
 709             next_hop_table_id=0,
 710             next_hop_weight=1,
 711             next_hop_n_out_labels=0,
 712             next_hop_out_label_stack=[],
 713             next_hop_via_label=MPLS_LABEL_INVALID,
 714             is_add=1,
 715             l2_only=0,
 716             is_multicast=0):
 717         """
 718
 719         :param dst_address_length:
 720         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 721         :param dst_address:
 722         :param next_hop_address:
 723         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 724         :param vrf_id:  (Default value = 0)
 725         :param lookup_in_vrf:  (Default value = 0)
 726         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 727         :param is_add:  (Default value = 1)
 728         :param is_drop:  (Default value = 0)
 729         :param is_ipv6:  (Default value = 0)
 730         :param is_local:  (Default value = 0)
 731         :param is_classify:  (Default value = 0)
 732         :param is_multipath:  (Default value = 0)
 733         :param is_resolve_host:  (Default value = 0)
 734         :param is_resolve_attached:  (Default value = 0)
 735         :param next_hop_weight:  (Default value = 1)
 736         :param is_multicast:  (Default value = 0)
 737
 738         """
 739         return self.api(
 740             self.papi.mpls_tunnel_add_del,
 741             {'mt_sw_if_index': tun_sw_if_index,
 742              'mt_is_add': is_add,
 743              'mt_l2_only': l2_only,
 744              'mt_is_multicast': is_multicast,
 745              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
 746              'mt_next_hop_weight': next_hop_weight,
 747              'mt_next_hop': next_hop_address,
 748              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
 749              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
 750              'mt_next_hop_table_id': next_hop_table_id,
 751              'mt_next_hop_via_label': next_hop_via_label,
 752              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
 753
 754     def nat44_interface_add_del_feature(
 755             self,
 756             sw_if_index,
 757             is_add=1,
 758             flags=0):
 759         """Enable/disable NAT44 feature on the interface
 760
 761         :param sw_if_index: Software index of the interface
 762         :param is_add: 1 if add, 0 if delete (Default value = 1)
 763         :param flags: NAT_IS_INSIDE if inside else outside
 764         """
 765         return self.api(
 766             self.papi.nat44_interface_add_del_feature,
 767             {'is_add': is_add,
 768              'flags': flags,
 769              'sw_if_index': sw_if_index})
 770
 771     def nat44_interface_add_del_output_feature(
 772             self,
 773             sw_if_index,
 774             is_add=1,
 775             flags=0):
 776         """Enable/disable NAT44 output feature on the interface
 777
 778         :param sw_if_index: Software index of the interface
 779         :param is_add: 1 if add, 0 if delete (Default value = 1)
 780         :param flags: NAT_IS_INSIDE if inside else outside
 781         """
 782         return self.api(
 783             self.papi.nat44_interface_add_del_output_feature,
 784             {'is_add': is_add,
 785              'flags': flags,
 786              'sw_if_index': sw_if_index})
 787
 788     def nat44_add_del_static_mapping(
 789             self,
 790             local_ip,
 791             external_ip=0,
 792             external_sw_if_index=0xFFFFFFFF,
 793             local_port=0,
 794             external_port=0,
 795             vrf_id=0,
 796             protocol=0,
 797             is_add=1,
 798             flags=0,
 799             tag=""):
 800         """Add/delete NAT44 static mapping
 801
 802         :param local_ip: Local IP address
 803         :param external_ip: External IP address
 804         :param external_sw_if_index: External interface instead of IP address
 805         :param local_port: Local port number (Default value = 0)
 806         :param external_port: External port number (Default value = 0)
 807         :param vrf_id: VRF ID
 808         :param protocol: IP protocol (Default value = 0)
 809         :param flags: NAT configuration flags
 810         :param is_add: 1 if add, 0 if delete (Default value = 1)
 811         :param tag: Opaque string tag
 812         """
 813         return self.api(
 814             self.papi.nat44_add_del_static_mapping,
 815             {'is_add': is_add,
 816              'flags': flags,
 817              'local_ip_address': local_ip,
 818              'external_ip_address': external_ip,
 819              'protocol': protocol,
 820              'local_port': local_port,
 821              'external_port': external_port,
 822              'external_sw_if_index': external_sw_if_index,
 823              'vrf_id': vrf_id,
 824              'tag': tag})
 825
 826     def nat44_add_del_identity_mapping(
 827             self,
 828             ip=b'0',
 829             sw_if_index=0xFFFFFFFF,
 830             port=0,
 831             flags=0,
 832             vrf_id=0,
 833             protocol=0,
 834             tag='',
 835             is_add=1):
 836         """Add/delete NAT44 identity mapping
 837
 838         :param ip: IP address (Default value = 0)
 839         :param sw_if_index: Interface instead of IP address
 840         :param port: Port number (Default value = 0)
 841         :param flags: NAT configuration flags (NAT_IS_ADDR_ONLY)
 842         :param vrf_id: VRF ID
 843         :param protocol: IP protocol (Default value = 0)
 844         :param tag: Opaque string tag
 845         :param is_add: 1 if add, 0 if delete (Default value = 1)
 846         """
 847         return self.api(
 848             self.papi.nat44_add_del_identity_mapping,
 849             {'is_add': is_add,
 850              'flags': flags,
 851              'ip_address': ip,
 852              'protocol': protocol,
 853              'port': port,
 854              'sw_if_index': sw_if_index,
 855              'vrf_id': vrf_id,
 856              'tag': tag})
 857
 858     def nat44_add_del_address_range(
 859             self,
 860             first_ip_address,
 861             last_ip_address,
 862             is_add=1,
 863             vrf_id=0xFFFFFFFF,
 864             flags=0):
 865         """Add/del NAT44 address range
 866
 867         :param first_ip_address: First IP address
 868         :param last_ip_address: Last IP address
 869         :param vrf_id: VRF id for the address range
 870         :param is_add: 1 if add, 0 if delete (Default value = 1)
 871         :param flags: NAT configuration flags (NAT_IS_TWICE_NAT)
 872         """
 873         return self.api(
 874             self.papi.nat44_add_del_address_range,
 875             {'first_ip_address': first_ip_address,
 876              'last_ip_address': last_ip_address,
 877              'vrf_id': vrf_id,
 878              'is_add': is_add,
 879              'flags': flags})
 880
 881     def nat44_add_del_interface_addr(
 882             self,
 883             sw_if_index,
 884             flags=0,
 885             is_add=1):
 886         """Add/del NAT44 address from interface
 887
 888         :param sw_if_index: Software index of the interface
 889         :param flags: NAT configuration flags (NAT_IS_TWICE_NAT)
 890         :param is_add: 1 if add, 0 if delete (Default value = 1)
 891         """
 892         return self.api(
 893             self.papi.nat44_add_del_interface_addr,
 894             {'is_add': is_add,
 895              'sw_if_index': sw_if_index,
 896              'flags': flags})
 897
 898     def nat44_add_del_lb_static_mapping(
 899             self,
 900             external_addr,
 901             external_port,
 902             protocol,
 903             tag='',
 904             affinity=0,
 905             local_num=0,
 906             locals=[],
 907             flags=0,
 908             is_add=1):
 909         """Add/delete NAT44 load balancing static mapping
 910
 911         :param tag: Opaque string tag
 912         :param affinity: if 0 disabled, otherwise client IP affinity timeout
 913         :param flags: NAT configuration flags (NAT_IS_TWICE_NAT)
 914         :param is_add - 1 if add, 0 if delete
 915         """
 916         return self.api(
 917             self.papi.nat44_add_del_lb_static_mapping,
 918             {'is_add': is_add,
 919              'flags': flags,
 920              'external_addr': external_addr,
 921              'external_port': external_port,
 922              'protocol': protocol,
 923              'affinity': affinity,
 924              'local_num': local_num,
 925              'locals': locals,
 926              'tag': tag})
 927
 928     def nat44_lb_static_mapping_add_del_local(
 929             self,
 930             external_addr,
 931             external_port,
 932             local_addr,
 933             local_port,
 934             protocol,
 935             probability,
 936             vrf_id=0,
 937             is_add=1):
 938         """Add/delete NAT44 load-balancing static mapping rule backend
 939
 940         :param external_addr: external IPv4 address of the service
 941         :param external_port: external L4 port number of the service
 942         :param local_addr: IPv4 address of the internal node
 943         :param local_port: L4 port number of the internal node
 944         :param protocol: IP protocol number
 945         :param probability: probability of the internal node
 946         :param vrf_id: VRF id of the internal node
 947         :param is_add: 1 if add, 0 if delete
 948         """
 949         return self.api(
 950             self.papi.nat44_lb_static_mapping_add_del_local,
 951             {'is_add': is_add,
 952              'external_addr': external_addr,
 953              'external_port': external_port,
 954              'local': {
 955                  'addr': local_addr,
 956                  'port': local_port,
 957                  'probability': probability,
 958                  'vrf_id': vrf_id},
 959              'protocol': protocol})
 960
 961     def nat44_del_session(
 962             self,
 963             addr,
 964             port,
 965             protocol,
 966             vrf_id=0,
 967             flags=0,
 968             ext_host_address=None,
 969             ext_host_port=0):
 970         """Delete NAT44 session
 971
 972         :param addr: IPv4 address
 973         :param por: port number
 974         :param protocol: IP protocol number
 975         :param vrf_id: VRF ID
 976         :param flags: NAT configuration flags (NAT_IS_INSIDE)
 977         :param ext_host_address: external host IPv4 address
 978         :param ext_host_port: external host port
 979         """
 980         return self.api(
 981             self.papi.nat44_del_session,
 982             {'address': addr,
 983              'protocol': protocol,
 984              'port': port,
 985              'vrf_id': vrf_id,
 986              'flags': flags,
 987              'ext_host_address': ext_host_address,
 988              'ext_host_port': ext_host_port})
 989
 990     def nat44_forwarding_enable_disable(
 991             self,
 992             enable):
 993         """Enable/disable forwarding for NAT44
 994
 995         :param enable: 1 for enable, 0 for disable
 996         """
 997         return self.api(
 998             self.papi.nat44_forwarding_enable_disable,
 999             {'enable': enable})
1000
1001     def nat_det_map_dump(self):
1002         """Dump deterministic NAT mappings
1003
1004         :return: Dictionary of deterministic NAT mappings
1005         """
1006         return self.api(self.papi.nat_det_map_dump, {})
1007
1008     def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1009         """Set TCP MSS rewriting configuration
1010
1011         :param enable: disable(0)/enable(1) MSS rewriting feature
1012         :param mss_value: MSS value to be used for MSS rewriting
1013         """
1014         return self.api(
1015             self.papi.nat_set_mss_clamping,
1016             {'enable': enable, 'mss_value': mss_value})
1017
1018     def nat64_add_del_static_bib(
1019             self,
1020             in_ip,
1021             out_ip,
1022             in_port,
1023             out_port,
1024             protocol,
1025             vrf_id=0,
1026             is_add=1):
1027         """Add/delete S-NAT static BIB entry
1028
1029         :param in_ip: Inside IPv6 address
1030         :param out_ip: Outside IPv4 address
1031         :param in_port: Inside port number
1032         :param out_port: Outside port number
1033         :param protocol: IP protocol
1034         :param vrf_id: VRF ID (Default value = 0)
1035         :param is_add: 1 if add, 0 if delete (Default value = 1)
1036         """
1037         return self.api(
1038             self.papi.nat64_add_del_static_bib,
1039             {'i_addr': in_ip,
1040              'o_addr': out_ip,
1041              'i_port': in_port,
1042              'o_port': out_port,
1043              'vrf_id': vrf_id,
1044              'proto': protocol,
1045              'is_add': is_add})
1046
1047     def nat64_bib_dump(self, protocol=255):
1048         """Dump NAT64 BIB
1049
1050         :param protocol: IP protocol (Default value = 255, all BIBs)
1051         :returns: Dictionary of NAT64 BIB entries
1052         """
1053         return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1054
1055     def nat64_st_dump(self, protocol=255):
1056         """Dump NAT64 session table
1057
1058         :param protocol: IP protocol (Default value = 255, all STs)
1059         :returns: Dictionary of NAT64 session table entries
1060         """
1061         return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1062
1063     def nat64_add_del_prefix(self, prefix, vrf_id=0, is_add=1):
1064         """Add/del NAT64 prefix
1065
1066         :param prefix: NAT64 prefix
1067         :param vrf_id: VRF id of tenant (Default 0)
1068         :param is_add: 1 if add, 0 if delete (Default value = 1)
1069         """
1070         return self.api(
1071             self.papi.nat64_add_del_prefix,
1072             {'prefix': prefix,
1073              'vrf_id': vrf_id,
1074              'is_add': is_add})
1075
1076     def nat64_add_del_interface_addr(
1077             self,
1078             sw_if_index,
1079             is_add=1):
1080         """Add/del NAT64 address from interface
1081
1082         :param sw_if_index: Software index of the interface
1083         :param is_add: 1 if add, 0 if delete (Default value = 1)
1084         """
1085         return self.api(self.papi.nat64_add_del_interface_addr,
1086                         {'is_add': is_add, 'sw_if_index': sw_if_index})
1087
1088     def dslite_set_aftr_addr(self, ip6, ip4):
1089         """Set DS-Lite AFTR addresses
1090
1091         :param ip4: IPv4 address
1092         :param ip6: IPv6 address
1093         """
1094         return self.api(
1095             self.papi.dslite_set_aftr_addr,
1096             {'ip4_addr': ip4,
1097              'ip6_addr': ip6})
1098
1099     def dslite_set_b4_addr(self, ip6, ip4):
1100         """Set DS-Lite B4 IPv6 address
1101
1102         :param ip4: IPv4 address
1103         :param ip6: IPv6 address
1104         """
1105         return self.api(
1106             self.papi.dslite_set_b4_addr,
1107             {'ip4_addr': ip4,
1108              'ip6_addr': ip6})
1109
1110     def nat66_add_del_interface(
1111             self,
1112             sw_if_index,
1113             flags=0,
1114             is_add=1):
1115         """Enable/disable NAT66 feature on the interface
1116
1117            :param sw_if_index: Index of the interface
1118            :param flags: NAT configuration flags (NAT_IS_INSIDE)
1119            :param is_add: 1 if add, 0 if delete (Default value = 1)
1120         """
1121         return self.api(
1122             self.papi.nat66_add_del_interface,
1123             {'is_add': is_add,
1124              'flags': flags,
1125              'sw_if_index': sw_if_index})
1126
1127     def nat66_add_del_static_mapping(
1128             self,
1129             in_ip,
1130             out_ip,
1131             vrf_id=0,
1132             is_add=1):
1133         """Add/delete NAT66 static mapping
1134
1135         :param in_ip: Inside IPv6 address
1136         :param out_ip: Outside IPv6 address
1137         :param vrf_id: VRF ID (Default value = 0)
1138         :param is_add: 1 if add, 0 if delete (Default value = 1)
1139         """
1140         return self.api(
1141             self.papi.nat66_add_del_static_mapping,
1142             {'local_ip_address': in_ip,
1143              'external_ip_address': out_ip,
1144              'vrf_id': vrf_id,
1145              'is_add': is_add})
1146
1147     def nat_ha_set_listener(self, addr, port, path_mtu=512):
1148         """Set HA listener (local settings)
1149
1150         :param addr: local IP4 address
1151         :param port: local UDP port number
1152         :param path_mtu: path MTU (Default value = 512)
1153         """
1154         return self.api(self.papi.nat_ha_set_listener,
1155                         {'ip_address': addr,
1156                          'port': port,
1157                          'path_mtu': path_mtu})
1158
1159     def nat_ha_get_listener(self):
1160         """Get HA listener/local configuration"""
1161         return self.api(self.papi.nat_ha_get_listener, {})
1162
1163     def nat_ha_set_failover(self, addr, port, refresh=10):
1164         """Set HA failover (remote settings)
1165
1166         :param addr: failover IP4 address
1167         :param port: failover UDP port number
1168         :param refresh: number of seconds after which to send session refresh
1169         """
1170         return self.api(self.papi.nat_ha_set_failover,
1171                         {'ip_address': addr,
1172                          'port': port,
1173                          'session_refresh_interval': refresh})
1174
1175     def nat_ha_resync(self, want_resync_event=1):
1176         """Resync HA (resend existing sessions to new failover)
1177         :param want_resync_event: if non-zero resync completed event sent
1178         """
1179         return self.api(self.papi.nat_ha_resync,
1180                         {'want_resync_event': want_resync_event,
1181                          'pid': os.getpid()})
1182
1183     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1184                     detect_mult, local_addr, peer_addr, is_ipv6=0,
1185                     bfd_key_id=None, conf_key_id=None):
1186         if bfd_key_id is None:
1187             return self.api(self.papi.bfd_udp_add,
1188                             {
1189                                 'sw_if_index': sw_if_index,
1190                                 'desired_min_tx': desired_min_tx,
1191                                 'required_min_rx': required_min_rx,
1192                                 'local_addr': local_addr,
1193                                 'peer_addr': peer_addr,
1194                                 'is_ipv6': is_ipv6,
1195                                 'detect_mult': detect_mult,
1196                             })
1197         else:
1198             return self.api(self.papi.bfd_udp_add,
1199                             {
1200                                 'sw_if_index': sw_if_index,
1201                                 'desired_min_tx': desired_min_tx,
1202                                 'required_min_rx': required_min_rx,
1203                                 'local_addr': local_addr,
1204                                 'peer_addr': peer_addr,
1205                                 'is_ipv6': is_ipv6,
1206                                 'detect_mult': detect_mult,
1207                                 'is_authenticated': 1,
1208                                 'bfd_key_id': bfd_key_id,
1209                                 'conf_key_id': conf_key_id,
1210                             })
1211
1212     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1213                     detect_mult, local_addr, peer_addr, is_ipv6=0):
1214         return self.api(self.papi.bfd_udp_mod,
1215                         {
1216                             'sw_if_index': sw_if_index,
1217                             'desired_min_tx': desired_min_tx,
1218                             'required_min_rx': required_min_rx,
1219                             'local_addr': local_addr,
1220                             'peer_addr': peer_addr,
1221                             'is_ipv6': is_ipv6,
1222                             'detect_mult': detect_mult,
1223                         })
1224
1225     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1226                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1227                               is_delayed=False):
1228         return self.api(self.papi.bfd_udp_auth_activate,
1229                         {
1230                             'sw_if_index': sw_if_index,
1231                             'local_addr': local_addr,
1232                             'peer_addr': peer_addr,
1233                             'is_ipv6': is_ipv6,
1234                             'is_delayed': 1 if is_delayed else 0,
1235                             'bfd_key_id': bfd_key_id,
1236                             'conf_key_id': conf_key_id,
1237                         })
1238
1239     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1240                                   peer_addr, is_ipv6=0):
1241         return self.api(self.papi.bfd_udp_session_set_flags, {
1242             'admin_up_down': admin_up_down,
1243             'sw_if_index': sw_if_index,
1244             'local_addr': local_addr,
1245             'peer_addr': peer_addr,
1246             'is_ipv6': is_ipv6,
1247         })
1248
1249     def want_bfd_events(self, enable_disable=1):
1250         return self.api(self.papi.want_bfd_events, {
1251             'enable_disable': enable_disable,
1252             'pid': os.getpid(),
1253         })
1254
1255     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1256         return self.api(self.papi.bfd_auth_set_key, {
1257             'conf_key_id': conf_key_id,
1258             'auth_type': auth_type,
1259             'key': key,
1260             'key_len': len(key),
1261         })
1262
1263     def classify_add_del_table(
1264             self,
1265             is_add,
1266             mask,
1267             match_n_vectors=1,
1268             table_index=0xFFFFFFFF,
1269             nbuckets=2,
1270             memory_size=2097152,
1271             skip_n_vectors=0,
1272             next_table_index=0xFFFFFFFF,
1273             miss_next_index=0xFFFFFFFF,
1274             current_data_flag=0,
1275             current_data_offset=0):
1276         """
1277         :param is_add:
1278         :param mask:
1279         :param match_n_vectors: (Default value = 1)
1280         :param table_index: (Default value = 0xFFFFFFFF)
1281         :param nbuckets:  (Default value = 2)
1282         :param memory_size:  (Default value = 2097152)
1283         :param skip_n_vectors:  (Default value = 0)
1284         :param next_table_index:  (Default value = 0xFFFFFFFF)
1285         :param miss_next_index:  (Default value = 0xFFFFFFFF)
1286         :param current_data_flag:  (Default value = 0)
1287         :param current_data_offset:  (Default value = 0)
1288         """
1289
1290         mask_len = ((len(mask) - 1) / 16 + 1) * 16
1291         mask = mask + '\0' * (mask_len - len(mask))
1292         return self.api(
1293             self.papi.classify_add_del_table,
1294             {'is_add': is_add,
1295              'table_index': table_index,
1296              'nbuckets': nbuckets,
1297              'memory_size': memory_size,
1298              'skip_n_vectors': skip_n_vectors,
1299              'match_n_vectors': match_n_vectors,
1300              'next_table_index': next_table_index,
1301              'miss_next_index': miss_next_index,
1302              'current_data_flag': current_data_flag,
1303              'current_data_offset': current_data_offset,
1304              'mask_len': mask_len,
1305              'mask': mask})
1306
1307     def classify_add_del_session(
1308             self,
1309             is_add,
1310             table_index,
1311             match,
1312             opaque_index=0xFFFFFFFF,
1313             hit_next_index=0xFFFFFFFF,
1314             advance=0,
1315             action=0,
1316             metadata=0):
1317         """
1318         :param is_add:
1319         :param table_index:
1320         :param match:
1321         :param opaque_index:  (Default value = 0xFFFFFFFF)
1322         :param hit_next_index:  (Default value = 0xFFFFFFFF)
1323         :param advance:  (Default value = 0)
1324         :param action:  (Default value = 0)
1325         :param metadata:  (Default value = 0)
1326         """
1327
1328         match_len = ((len(match) - 1) / 16 + 1) * 16
1329         match = match + '\0' * (match_len - len(match))
1330         return self.api(
1331             self.papi.classify_add_del_session,
1332             {'is_add': is_add,
1333              'table_index': table_index,
1334              'hit_next_index': hit_next_index,
1335              'opaque_index': opaque_index,
1336              'advance': advance,
1337              'action': action,
1338              'metadata': metadata,
1339              'match_len': match_len,
1340              'match': match})
1341
1342     def input_acl_set_interface(
1343             self,
1344             is_add,
1345             sw_if_index,
1346             ip4_table_index=0xFFFFFFFF,
1347             ip6_table_index=0xFFFFFFFF,
1348             l2_table_index=0xFFFFFFFF):
1349         """
1350         :param is_add:
1351         :param sw_if_index:
1352         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
1353         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
1354         :param l2_table_index:  (Default value = 0xFFFFFFFF)
1355         """
1356
1357         return self.api(
1358             self.papi.input_acl_set_interface,
1359             {'sw_if_index': sw_if_index,
1360              'ip4_table_index': ip4_table_index,
1361              'ip6_table_index': ip6_table_index,
1362              'l2_table_index': l2_table_index,
1363              'is_add': is_add})
1364
1365     def output_acl_set_interface(
1366             self,
1367             is_add,
1368             sw_if_index,
1369             ip4_table_index=0xFFFFFFFF,
1370             ip6_table_index=0xFFFFFFFF,
1371             l2_table_index=0xFFFFFFFF):
1372         """
1373         :param is_add:
1374         :param sw_if_index:
1375         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
1376         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
1377         :param l2_table_index:  (Default value = 0xFFFFFFFF)
1378         """
1379
1380         return self.api(
1381             self.papi.output_acl_set_interface,
1382             {'sw_if_index': sw_if_index,
1383              'ip4_table_index': ip4_table_index,
1384              'ip6_table_index': ip6_table_index,
1385              'l2_table_index': l2_table_index,
1386              'is_add': is_add})
1387
1388     def set_ipfix_exporter(
1389             self,
1390             collector_address,
1391             src_address,
1392             path_mtu,
1393             template_interval,
1394             vrf_id=0,
1395             collector_port=4739,
1396             udp_checksum=0):
1397         return self.api(
1398             self.papi.set_ipfix_exporter,
1399             {
1400                 'collector_address': collector_address,
1401                 'collector_port': collector_port,
1402                 'src_address': src_address,
1403                 'vrf_id': vrf_id,
1404                 'path_mtu': path_mtu,
1405                 'template_interval': template_interval,
1406                 'udp_checksum': udp_checksum,
1407             })
1408
1409     def dhcp_proxy_config(self,
1410                           dhcp_server,
1411                           dhcp_src_address,
1412                           rx_table_id=0,
1413                           server_table_id=0,
1414                           is_add=1,
1415                           is_ipv6=0):
1416         return self.api(
1417             self.papi.dhcp_proxy_config,
1418             {
1419                 'rx_vrf_id': rx_table_id,
1420                 'server_vrf_id': server_table_id,
1421                 'is_ipv6': is_ipv6,
1422                 'is_add': is_add,
1423                 'dhcp_server': dhcp_server,
1424                 'dhcp_src_address': dhcp_src_address,
1425             })
1426
1427     def dhcp_proxy_set_vss(self,
1428                            table_id,
1429                            vss_type=255,
1430                            vpn_ascii_id="",
1431                            oui=0,
1432                            vpn_index=0,
1433                            is_add=1,
1434                            is_ip6=0):
1435         return self.api(
1436             self.papi.dhcp_proxy_set_vss,
1437             {
1438                 'tbl_id': table_id,
1439                 'vss_type': vss_type,
1440                 'vpn_ascii_id': vpn_ascii_id,
1441                 'oui': oui,
1442                 'vpn_index': vpn_index,
1443                 'is_add': is_add,
1444                 'is_ipv6': is_ip6,
1445             })
1446
1447     def dhcp_client_config(self,
1448                            sw_if_index,
1449                            hostname,
1450                            client_id='',
1451                            is_add=1,
1452                            set_broadcast_flag=1,
1453                            want_dhcp_events=0):
1454         return self.api(
1455             self.papi.dhcp_client_config,
1456             {
1457                 'is_add': is_add,
1458                 'client': {
1459                     'sw_if_index': sw_if_index,
1460                     'hostname': hostname,
1461                     'id': client_id,
1462                     'want_dhcp_event': want_dhcp_events,
1463                     'set_broadcast_flag': set_broadcast_flag,
1464                     'pid': os.getpid()}
1465             })
1466
1467     def ip_mroute_add_del(self,
1468                           src_address,
1469                           grp_address,
1470                           grp_address_length,
1471                           e_flags,
1472                           next_hop_afi,
1473                           next_hop_sw_if_index,
1474                           next_hop_address,
1475                           i_flags,
1476                           bier_imp=0,
1477                           rpf_id=0,
1478                           table_id=0,
1479                           is_add=1,
1480                           is_ipv6=0,
1481                           is_local=0):
1482         """
1483         IP Multicast Route add/del
1484         """
1485         return self.api(
1486             self.papi.ip_mroute_add_del,
1487             {'next_hop_sw_if_index': next_hop_sw_if_index,
1488              'entry_flags': e_flags,
1489              'itf_flags': i_flags,
1490              'table_id': table_id,
1491              'rpf_id': rpf_id,
1492              'is_add': is_add,
1493              'is_ipv6': is_ipv6,
1494              'is_local': is_local,
1495              'bier_imp': bier_imp,
1496              'next_hop_afi': next_hop_afi,
1497              'grp_address_length': grp_address_length,
1498              'grp_address': grp_address,
1499              'src_address': src_address,
1500              'nh_address': next_hop_address})
1501
1502     def lisp_enable_disable(self, is_enabled):
1503         return self.api(
1504             self.papi.lisp_enable_disable,
1505             {
1506                 'is_en': is_enabled,
1507             })
1508
1509     def lisp_add_del_locator_set(self,
1510                                  ls_name,
1511                                  is_add=1):
1512         return self.api(
1513             self.papi.lisp_add_del_locator_set,
1514             {
1515                 'is_add': is_add,
1516                 'locator_set_name': ls_name
1517             })
1518
1519     def lisp_add_del_locator(self,
1520                              ls_name,
1521                              sw_if_index,
1522                              priority=1,
1523                              weight=1,
1524                              is_add=1):
1525         return self.api(
1526             self.papi.lisp_add_del_locator,
1527             {
1528                 'is_add': is_add,
1529                 'locator_set_name': ls_name,
1530                 'sw_if_index': sw_if_index,
1531                 'priority': priority,
1532                 'weight': weight
1533             })
1534
1535     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1536         return self.api(
1537             self.papi.lisp_locator_dump,
1538             {
1539                 'is_index_set': is_index_set,
1540                 'ls_name': ls_name,
1541                 'ls_index': ls_index,
1542             })
1543
1544     def lisp_add_del_local_eid(self,
1545                                ls_name,
1546                                eid_type,
1547                                eid,
1548                                prefix_len,
1549                                vni=0,
1550                                key_id=0,
1551                                key="",
1552                                is_add=1):
1553         return self.api(
1554             self.papi.lisp_add_del_local_eid,
1555             {
1556                 'locator_set_name': ls_name,
1557                 'is_add': is_add,
1558                 'eid_type': eid_type,
1559                 'eid': eid,
1560                 'prefix_len': prefix_len,
1561                 'vni': vni,
1562                 'key_id': key_id,
1563                 'key': key
1564             })
1565
1566     def lisp_eid_table_dump(self,
1567                             eid_set=0,
1568                             prefix_length=0,
1569                             vni=0,
1570                             eid_type=0,
1571                             eid=None,
1572                             filter_opt=0):
1573         return self.api(
1574             self.papi.lisp_eid_table_dump,
1575             {
1576                 'eid_set': eid_set,
1577                 'prefix_length': prefix_length,
1578                 'vni': vni,
1579                 'eid_type': eid_type,
1580                 'eid': eid,
1581                 'filter': filter_opt,
1582             })
1583
1584     def lisp_add_del_remote_mapping(self,
1585                                     eid_type,
1586                                     eid,
1587                                     eid_prefix_len=0,
1588                                     vni=0,
1589                                     rlocs=[],
1590                                     rlocs_num=0,
1591                                     is_src_dst=0,
1592                                     is_add=1):
1593         return self.api(
1594             self.papi.lisp_add_del_remote_mapping,
1595             {
1596                 'is_add': is_add,
1597                 'eid_type': eid_type,
1598                 'eid': eid,
1599                 'eid_len': eid_prefix_len,
1600                 'rloc_num': rlocs_num,
1601                 'rlocs': rlocs,
1602                 'vni': vni,
1603                 'is_src_dst': is_src_dst,
1604             })
1605
1606     def lisp_add_del_adjacency(self,
1607                                leid,
1608                                reid,
1609                                leid_len,
1610                                reid_len,
1611                                eid_type,
1612                                is_add=1,
1613                                vni=0):
1614         return self.api(
1615             self.papi.lisp_add_del_adjacency,
1616             {
1617                 'is_add': is_add,
1618                 'vni': vni,
1619                 'eid_type': eid_type,
1620                 'leid': leid,
1621                 'reid': reid,
1622                 'leid_len': leid_len,
1623                 'reid_len': reid_len,
1624             })
1625
1626     def gtpu_add_del_tunnel(
1627             self,
1628             src_addr,
1629             dst_addr,
1630             is_add=1,
1631             is_ipv6=0,
1632             mcast_sw_if_index=0xFFFFFFFF,
1633             encap_vrf_id=0,
1634             decap_next_index=0xFFFFFFFF,
1635             teid=0):
1636         """
1637
1638         :param is_add:  (Default value = 1)
1639         :param is_ipv6:  (Default value = 0)
1640         :param src_addr:
1641         :param dst_addr:
1642         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
1643         :param encap_vrf_id:  (Default value = 0)
1644         :param decap_next_index:  (Default value = 0xFFFFFFFF)
1645         :param teid:  (Default value = 0)
1646
1647         """
1648         return self.api(self.papi.gtpu_add_del_tunnel,
1649                         {'is_add': is_add,
1650                          'is_ipv6': is_ipv6,
1651                          'src_address': src_addr,
1652                          'dst_address': dst_addr,
1653                          'mcast_sw_if_index': mcast_sw_if_index,
1654                          'encap_vrf_id': encap_vrf_id,
1655                          'decap_next_index': decap_next_index,
1656                          'teid': teid})
1657
1658     def vxlan_gpe_add_del_tunnel(
1659             self,
1660             src_addr,
1661             dst_addr,
1662             mcast_sw_if_index=0xFFFFFFFF,
1663             is_add=1,
1664             is_ipv6=0,
1665             encap_vrf_id=0,
1666             decap_vrf_id=0,
1667             protocol=3,
1668             vni=0):
1669         """
1670
1671         :param local:
1672         :param remote:
1673         :param is_add:  (Default value = 1)
1674         :param is_ipv6:  (Default value = 0)
1675         :param encap_vrf_id:  (Default value = 0)
1676         :param decap_vrf_id:  (Default value = 0)
1677         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
1678         :param protocol:  (Default value = 3)
1679         :param vni:  (Default value = 0)
1680
1681         """
1682         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1683                         {'is_add': is_add,
1684                          'is_ipv6': is_ipv6,
1685                          'local': src_addr,
1686                          'remote': dst_addr,
1687                          'mcast_sw_if_index': mcast_sw_if_index,
1688                          'encap_vrf_id': encap_vrf_id,
1689                          'decap_vrf_id': decap_vrf_id,
1690                          'protocol': protocol,
1691                          'vni': vni})
1692
1693     def vxlan_gbp_tunnel_add_del(
1694             self,
1695             src,
1696             dst,
1697             mcast_sw_if_index=0xFFFFFFFF,
1698             is_add=1,
1699             is_ipv6=0,
1700             encap_table_id=0,
1701             vni=0,
1702             mode=1,
1703             instance=0xFFFFFFFF):
1704         """
1705
1706         :param dst_addr:
1707         :param src_addr:
1708         :param is_add:  (Default value = 1)
1709         :param is_ipv6:  (Default value = 0)
1710         :param encap_table_id:  (Default value = 0)
1711         :param decap_next_index:  (Default value = 0xFFFFFFFF)
1712         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
1713         :param vni:  (Default value = 0)
1714         :param instance:  (Default value = 0xFFFFFFFF)
1715
1716         """
1717         return self.api(self.papi.vxlan_gbp_tunnel_add_del,
1718                         {'is_add': is_add,
1719                          'tunnel': {
1720                              'src': src,
1721                              'dst': dst,
1722                              'mcast_sw_if_index': mcast_sw_if_index,
1723                              'encap_table_id': encap_table_id,
1724                              'vni': vni,
1725                              'instance': instance,
1726                              "mode": mode}})
1727
1728     def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1729         return self.api(self.papi.vxlan_gbp_tunnel_dump,
1730                         {'sw_if_index': sw_if_index,
1731                          '_no_type_conversion': True})
1732
1733     def pppoe_add_del_session(
1734             self,
1735             client_ip,
1736             client_mac,
1737             session_id=0,
1738             is_add=1,
1739             is_ipv6=0,
1740             decap_vrf_id=0):
1741         """
1742
1743         :param is_add:  (Default value = 1)
1744         :param is_ipv6:  (Default value = 0)
1745         :param client_ip:
1746         :param session_id:  (Default value = 0)
1747         :param client_mac:
1748         :param decap_vrf_id:  (Default value = 0)
1749
1750         """
1751         return self.api(self.papi.pppoe_add_del_session,
1752                         {'is_add': is_add,
1753                          'is_ipv6': is_ipv6,
1754                          'session_id': session_id,
1755                          'client_ip': client_ip,
1756                          'decap_vrf_id': decap_vrf_id,
1757                          'client_mac': client_mac})
1758
1759     def sr_mpls_policy_add(self, bsid, weight, type, segments):
1760         return self.api(self.papi.sr_mpls_policy_add,
1761                         {'bsid': bsid,
1762                          'weight': weight,
1763                          'type': type,
1764                          'n_segments': len(segments),
1765                          'segments': segments})
1766
1767     def sr_mpls_policy_del(self, bsid):
1768         return self.api(self.papi.sr_mpls_policy_del,
1769                         {'bsid': bsid})
1770
1771     def sr_localsid_add_del(self,
1772                             localsid,
1773                             behavior,
1774                             nh_addr4,
1775                             nh_addr6,
1776                             is_del=0,
1777                             end_psp=0,
1778                             sw_if_index=0xFFFFFFFF,
1779                             vlan_index=0,
1780                             fib_table=0,
1781                             ):
1782         """ Add/del IPv6 SR local-SID.
1783
1784         :param localsid:
1785         :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1786         :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1787         :param nh_addr4:
1788         :param nh_addr6:
1789         :param is_del:  (Default value = 0)
1790         :param end_psp: (Default value = 0)
1791         :param sw_if_index: (Default value = 0xFFFFFFFF)
1792         :param vlan_index:  (Default value = 0)
1793         :param fib_table:   (Default value = 0)
1794         """
1795         return self.api(
1796             self.papi.sr_localsid_add_del,
1797             {'is_del': is_del,
1798              'localsid': localsid,
1799              'end_psp': end_psp,
1800              'behavior': behavior,
1801              'sw_if_index': sw_if_index,
1802              'vlan_index': vlan_index,
1803              'fib_table': fib_table,
1804              'nh_addr4': nh_addr4,
1805              'nh_addr6': nh_addr6
1806              }
1807         )
1808
1809     def sr_policy_add(
1810             self,
1811             bsid_addr,
1812             weight=1,
1813             is_encap=1,
1814             type=0,
1815             fib_table=0,
1816             n_segments=0,
1817             segments=[]):
1818         """
1819         :param bsid_addr: bindingSID of the SR Policy
1820         :param weight: weight of the sid list. optional. (default: 1)
1821         :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1822             (default: Encap)
1823         :param type: type/behavior of the SR policy. (default or spray) \
1824             (default: default)
1825         :param fib_table: VRF where to install the FIB entry for the BSID \
1826             (default: 0)
1827         :param n_segments: number of segments \
1828             (default: 0)
1829         :param segments: a vector of IPv6 address composing the segment list \
1830             (default: [])
1831         """
1832         return self.api(
1833             self.papi.sr_policy_add,
1834             {'bsid_addr': bsid_addr,
1835              'weight': weight,
1836              'is_encap': is_encap,
1837              'type': type,
1838              'fib_table': fib_table,
1839              'n_segments': n_segments,
1840              'segments': segments
1841              }
1842         )
1843
1844     def sr_policy_del(
1845             self,
1846             bsid_addr,
1847             sr_policy_index=0):
1848         """
1849         :param bsid: bindingSID of the SR Policy
1850         :param sr_policy_index: index of the sr policy (default: 0)
1851         """
1852         return self.api(
1853             self.papi.sr_policy_del,
1854             {'bsid_addr': bsid_addr,
1855              'sr_policy_index': sr_policy_index
1856              })
1857
1858     def sr_steering_add_del(
1859             self,
1860             is_del,
1861             bsid_addr,
1862             sr_policy_index,
1863             table_id,
1864             prefix_addr,
1865             mask_width,
1866             sw_if_index,
1867             traffic_type):
1868         """
1869         Steer traffic L2 and L3 traffic through a given SR policy
1870
1871         :param is_del: delete or add
1872         :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1873         :param sr_policy: is the index of the SR Policy (alt to bsid)
1874         :param table_id: is the VRF where to install the FIB entry for the BSID
1875         :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1876         :param mask_width: is the mask for L3 traffic type
1877         :param sw_if_index: is the incoming interface for L2 traffic
1878         :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1879         """
1880         return self.api(
1881             self.papi.sr_steering_add_del,
1882             {'is_del': is_del,
1883              'bsid_addr': bsid_addr,
1884              'sr_policy_index': sr_policy_index,
1885              'table_id': table_id,
1886              'prefix_addr': prefix_addr,
1887              'mask_width': mask_width,
1888              'sw_if_index': sw_if_index,
1889              'traffic_type': traffic_type
1890              })
1891
1892     def acl_add_replace(self, acl_index, r, tag='',
1893                         expected_retval=0):
1894         """Add/replace an ACL
1895         :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1896         :param acl_rule r: ACL rules array.
1897         :param str tag: symbolic tag (description) for this ACL.
1898         :param int count: number of rules.
1899         """
1900         return self.api(self.papi.acl_add_replace,
1901                         {'acl_index': acl_index,
1902                          'r': r,
1903                          'count': len(r),
1904                          'tag': tag},
1905                         expected_retval=expected_retval)
1906
1907     def acl_del(self, acl_index, expected_retval=0):
1908         """
1909
1910         :param acl_index:
1911         :return:
1912         """
1913         return self.api(self.papi.acl_del,
1914                         {'acl_index': acl_index},
1915                         expected_retval=expected_retval)
1916
1917     def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1918                                    expected_retval=0):
1919         return self.api(self.papi.acl_interface_set_acl_list,
1920                         {'sw_if_index': sw_if_index,
1921                          'count': len(acls),
1922                          'n_input': n_input,
1923                          'acls': acls},
1924                         expected_retval=expected_retval)
1925
1926     def acl_interface_set_etype_whitelist(self, sw_if_index,
1927                                           n_input, whitelist,
1928                                           expected_retval=0):
1929         return self.api(self.papi.acl_interface_set_etype_whitelist,
1930                         {'sw_if_index': sw_if_index,
1931                          'count': len(whitelist),
1932                          'n_input': n_input,
1933                          'whitelist': whitelist},
1934                         expected_retval=expected_retval)
1935
1936     def acl_interface_add_del(self,
1937                               sw_if_index,
1938                               acl_index,
1939                               is_add=1):
1940         """ Add/Delete ACL to/from interface
1941
1942         :param sw_if_index:
1943         :param acl_index:
1944         :param is_add:  (Default value = 1)
1945         """
1946
1947         return self.api(self.papi.acl_interface_add_del,
1948                         {'is_add': is_add,
1949                          'is_input': 1,
1950                          'sw_if_index': sw_if_index,
1951                          'acl_index': acl_index})
1952
1953     def acl_dump(self, acl_index, expected_retval=0):
1954         return self.api(self.papi.acl_dump,
1955                         {'acl_index': acl_index},
1956                         expected_retval=expected_retval)
1957
1958     def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1959                                 expected_retval=0):
1960         return self.api(self.papi.acl_interface_list_dump,
1961                         {'sw_if_index': sw_if_index},
1962                         expected_retval=expected_retval)
1963
1964     def macip_acl_add(self, rules, tag=""):
1965         """ Add MACIP acl
1966
1967         :param rules: list of rules for given acl
1968         :param tag: acl tag
1969         """
1970
1971         return self.api(self.papi.macip_acl_add,
1972                         {'r': rules,
1973                          'count': len(rules),
1974                          'tag': tag})
1975
1976     def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1977         """ Add MACIP acl
1978
1979         :param rules: list of rules for given acl
1980         :param tag: acl tag
1981         """
1982
1983         return self.api(self.papi.macip_acl_add_replace,
1984                         {'acl_index': acl_index,
1985                          'r': rules,
1986                          'count': len(rules),
1987                          'tag': tag})
1988
1989     def macip_acl_interface_add_del(self,
1990                                     sw_if_index,
1991                                     acl_index,
1992                                     is_add=1):
1993         """ Add MACIP acl to interface
1994
1995         :param sw_if_index:
1996         :param acl_index:
1997         :param is_add:  (Default value = 1)
1998         """
1999
2000         return self.api(self.papi.macip_acl_interface_add_del,
2001                         {'is_add': is_add,
2002                          'sw_if_index': sw_if_index,
2003                          'acl_index': acl_index})
2004
2005     def macip_acl_dump(self, acl_index=4294967295):
2006         """ Return MACIP acl dump
2007         """
2008
2009         return self.api(
2010             self.papi.macip_acl_dump, {'acl_index': acl_index})
2011
2012     def policer_add_del(self,
2013                         name,
2014                         cir,
2015                         eir,
2016                         cb,
2017                         eb,
2018                         is_add=1,
2019                         rate_type=0,
2020                         round_type=0,
2021                         ptype=0,
2022                         color_aware=0,
2023                         conform_action_type=1,
2024                         conform_dscp=0,
2025                         exceed_action_type=0,
2026                         exceed_dscp=0,
2027                         violate_action_type=0,
2028                         violate_dscp=0):
2029         return self.api(self.papi.policer_add_del,
2030                         {'name': name,
2031                          'cir': cir,
2032                          'eir': eir,
2033                          'cb': cb,
2034                          'eb': eb,
2035                          'is_add': is_add,
2036                          'rate_type': rate_type,
2037                          'round_type': round_type,
2038                          'type': ptype,
2039                          'color_aware': color_aware,
2040                          'conform_action_type': conform_action_type,
2041                          'conform_dscp': conform_dscp,
2042                          'exceed_action_type': exceed_action_type,
2043                          'exceed_dscp': exceed_dscp,
2044                          'violate_action_type': violate_action_type,
2045                          'violate_dscp': violate_dscp})
2046
2047     def ip_punt_police(self,
2048                        policer_index,
2049                        is_ip6=0,
2050                        is_add=1):
2051         return self.api(self.papi.ip_punt_police,
2052                         {'policer_index': policer_index,
2053                          'is_add': is_add,
2054                          'is_ip6': is_ip6})
2055
2056     def ip_punt_redirect(self,
2057                          rx_sw_if_index,
2058                          tx_sw_if_index,
2059                          address,
2060                          is_add=1):
2061         return self.api(self.papi.ip_punt_redirect,
2062                         {'punt': {'rx_sw_if_index': rx_sw_if_index,
2063                                   'tx_sw_if_index': tx_sw_if_index,
2064                                   'nh': address},
2065                          'is_add': is_add})
2066
2067     def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
2068         return self.api(self.papi.ip_punt_redirect_dump,
2069                         {'sw_if_index': sw_if_index,
2070                          'is_ipv6': is_ipv6})
2071
2072     def bier_table_add_del(self,
2073                            bti,
2074                            mpls_label,
2075                            is_add=1):
2076         """ BIER Table add/del """
2077         return self.api(
2078             self.papi.bier_table_add_del,
2079             {'bt_tbl_id': {"bt_set": bti.set_id,
2080                            "bt_sub_domain": bti.sub_domain_id,
2081                            "bt_hdr_len_id": bti.hdr_len_id},
2082              'bt_label': mpls_label,
2083              'bt_is_add': is_add})
2084
2085     def bier_table_dump(self):
2086         return self.api(self.papi.bier_table_dump, {})
2087
2088     def bier_route_add_del(self,
2089                            bti,
2090                            bp,
2091                            paths,
2092                            is_add=1,
2093                            is_replace=0):
2094         """ BIER Route add/del """
2095         return self.api(
2096             self.papi.bier_route_add_del,
2097             {'br_tbl_id': {"bt_set": bti.set_id,
2098                            "bt_sub_domain": bti.sub_domain_id,
2099                            "bt_hdr_len_id": bti.hdr_len_id},
2100              'br_bp': bp,
2101              'br_n_paths': len(paths),
2102              'br_paths': paths,
2103              'br_is_add': is_add,
2104              'br_is_replace': is_replace})
2105
2106     def bier_route_dump(self, bti):
2107         return self.api(
2108             self.papi.bier_route_dump,
2109             {'br_tbl_id': {"bt_set": bti.set_id,
2110                            "bt_sub_domain": bti.sub_domain_id,
2111                            "bt_hdr_len_id": bti.hdr_len_id}})
2112
2113     def bier_imp_add(self,
2114                      bti,
2115                      src,
2116                      ibytes,
2117                      is_add=1):
2118         """ BIER Imposition Add """
2119         return self.api(
2120             self.papi.bier_imp_add,
2121             {'bi_tbl_id': {"bt_set": bti.set_id,
2122                            "bt_sub_domain": bti.sub_domain_id,
2123                            "bt_hdr_len_id": bti.hdr_len_id},
2124              'bi_src': src,
2125              'bi_n_bytes': len(ibytes),
2126              'bi_bytes': ibytes})
2127
2128     def bier_imp_del(self, bi_index):
2129         """ BIER Imposition del """
2130         return self.api(
2131             self.papi.bier_imp_del,
2132             {'bi_index': bi_index})
2133
2134     def bier_imp_dump(self):
2135         return self.api(self.papi.bier_imp_dump, {})
2136
2137     def bier_disp_table_add_del(self,
2138                                 bdti,
2139                                 is_add=1):
2140         """ BIER Disposition Table add/del """
2141         return self.api(
2142             self.papi.bier_disp_table_add_del,
2143             {'bdt_tbl_id': bdti,
2144              'bdt_is_add': is_add})
2145
2146     def bier_disp_table_dump(self):
2147         return self.api(self.papi.bier_disp_table_dump, {})
2148
2149     def bier_disp_entry_add_del(self,
2150                                 bdti,
2151                                 bp,
2152                                 payload_proto,
2153                                 next_hop_afi,
2154                                 next_hop,
2155                                 next_hop_tbl_id=0,
2156                                 next_hop_rpf_id=~0,
2157                                 next_hop_is_ip4=1,
2158                                 is_add=1):
2159         """ BIER Route add/del """
2160         lstack = []
2161         while (len(lstack) < 16):
2162             lstack.append({})
2163         return self.api(
2164             self.papi.bier_disp_entry_add_del,
2165             {'bde_tbl_id': bdti,
2166              'bde_bp': bp,
2167              'bde_payload_proto': payload_proto,
2168              'bde_n_paths': 1,
2169              'bde_paths': [{'next_hop': next_hop,
2170                             'table_id': next_hop_tbl_id,
2171                             'afi': next_hop_afi,
2172                             'rpf_id': next_hop_rpf_id,
2173                             'n_labels': 0,
2174                             'label_stack': lstack}],
2175              'bde_is_add': is_add})
2176
2177     def bier_disp_entry_dump(self, bdti):
2178         return self.api(
2179             self.papi.bier_disp_entry_dump,
2180             {'bde_tbl_id': bdti})
2181
2182     def session_enable_disable(self, is_enabled):
2183         return self.api(
2184             self.papi.session_enable_disable,
2185             {'is_enable': is_enabled})
2186
2187     def ipsec_spd_add_del(self, spd_id, is_add=1):
2188         """ SPD add/del - Wrapper to add or del ipsec SPD
2189         Sample CLI : 'ipsec spd add 1'
2190
2191         :param spd_id - SPD ID to be created in the vpp . mandatory
2192         :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2193               optional
2194         :returns: reply from the API
2195         """
2196         return self.api(
2197             self.papi.ipsec_spd_add_del, {
2198                 'spd_id': spd_id, 'is_add': is_add})
2199
2200     def ipsec_spds_dump(self):
2201         return self.api(self.papi.ipsec_spds_dump, {})
2202
2203     def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2204         """ IPSEC interface SPD add/del - \
2205              Wrapper to associate/disassociate SPD to interface in VPP
2206         Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2207
2208         :param spd_id - SPD ID to associate with the interface . mandatory
2209         :param sw_if_index - Interface Index which needs to ipsec \
2210             association mandatory
2211         :param is_add - add(1) or del(0) association with interface \
2212                 (Default 1 - add) . optional
2213         :returns: reply from the API
2214         """
2215         return self.api(
2216             self.papi.ipsec_interface_add_del_spd,
2217             {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
2218
2219     def ipsec_spd_interface_dump(self, spd_index=None):
2220         return self.api(self.papi.ipsec_spd_interface_dump,
2221                         {'spd_index': spd_index if spd_index else 0,
2222                          'spd_index_valid': 1 if spd_index else 0})
2223
2224     def ipsec_sad_entry_add_del(self,
2225                                 sad_id,
2226                                 spi,
2227                                 integrity_algorithm,
2228                                 integrity_key,
2229                                 crypto_algorithm,
2230                                 crypto_key,
2231                                 protocol,
2232                                 tunnel_src_address='',
2233                                 tunnel_dst_address='',
2234                                 flags=0,
2235                                 salt=0,
2236                                 is_add=1):
2237         """ IPSEC SA add/del
2238         :param sad_id: security association ID
2239         :param spi: security param index of the SA in decimal
2240         :param integrity_algorithm:
2241         :param integrity_key:
2242         :param crypto_algorithm:
2243         :param crypto_key:
2244         :param protocol: AH(0) or ESP(1) protocol
2245         :param tunnel_src_address: tunnel mode outer src address
2246         :param tunnel_dst_address: tunnel mode outer dst address
2247         :param is_add:
2248         :param is_tunnel:
2249         :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
2250              crypto and ipsec algorithms
2251         """
2252         return self.api(
2253             self.papi.ipsec_sad_entry_add_del,
2254             {
2255                 'is_add': is_add,
2256                 'entry':
2257                     {
2258                         'sad_id': sad_id,
2259                         'spi': spi,
2260                         'tunnel_src': tunnel_src_address,
2261                         'tunnel_dst': tunnel_dst_address,
2262                         'protocol': protocol,
2263                         'integrity_algorithm': integrity_algorithm,
2264                         'integrity_key': {
2265                             'length': len(integrity_key),
2266                             'data': integrity_key,
2267                         },
2268                         'crypto_algorithm': crypto_algorithm,
2269                         'crypto_key': {
2270                             'length': len(crypto_key),
2271                             'data': crypto_key,
2272                         },
2273                         'flags': flags,
2274                         'salt': salt,
2275                     }
2276             })
2277
2278     def ipsec_sa_dump(self, sa_id=None):
2279         return self.api(self.papi.ipsec_sa_dump,
2280                         {'sa_id': sa_id if sa_id else 0xffffffff})
2281
2282     def ipsec_spd_entry_add_del(self,
2283                                 spd_id,
2284                                 sa_id,
2285                                 local_address_start,
2286                                 local_address_stop,
2287                                 remote_address_start,
2288                                 remote_address_stop,
2289                                 local_port_start=0,
2290                                 local_port_stop=65535,
2291                                 remote_port_start=0,
2292                                 remote_port_stop=65535,
2293                                 protocol=0,
2294                                 policy=0,
2295                                 priority=100,
2296                                 is_outbound=1,
2297                                 is_add=1,
2298                                 is_ipv6=0,
2299                                 is_ip_any=0):
2300         """ IPSEC policy SPD add/del   -
2301                     Wrapper to configure ipsec SPD policy entries in VPP
2302         :param spd_id: SPD ID for the policy
2303         :param local_address_start: local-ip-range start address
2304         :param local_address_stop : local-ip-range stop address
2305         :param remote_address_start: remote-ip-range start address
2306         :param remote_address_stop : remote-ip-range stop address
2307         :param local_port_start: (Default value = 0)
2308         :param local_port_stop: (Default value = 65535)
2309         :param remote_port_start: (Default value = 0)
2310         :param remote_port_stop: (Default value = 65535)
2311         :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
2312         :param sa_id: Security Association ID for mapping it to SPD
2313         :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
2314                (Default value = 0)
2315         :param priority: value for the spd action (Default value = 100)
2316         :param is_outbound: flag for inbound(0) or outbound(1)
2317                (Default value = 1)
2318         :param is_add: (Default value = 1)
2319         """
2320         return self.api(
2321             self.papi.ipsec_spd_entry_add_del,
2322             {
2323                 'is_add': is_add,
2324                 'entry':
2325                     {
2326                         'spd_id': spd_id,
2327                         'sa_id': sa_id,
2328                         'local_address_start': local_address_start,
2329                         'local_address_stop': local_address_stop,
2330                         'remote_address_start': remote_address_start,
2331                         'remote_address_stop': remote_address_stop,
2332                         'local_port_start': local_port_start,
2333                         'local_port_stop': local_port_stop,
2334                         'remote_port_start': remote_port_start,
2335                         'remote_port_stop': remote_port_stop,
2336                         'protocol': protocol,
2337                         'policy': policy,
2338                         'priority': priority,
2339                         'is_outbound': is_outbound,
2340                         'is_ip_any': is_ip_any
2341                     }
2342             })
2343
2344     def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
2345         return self.api(self.papi.ipsec_spd_dump,
2346                         {'spd_id': spd_id,
2347                          'sa_id': sa_id})
2348
2349     def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
2350                                 remote_spi, crypto_alg, local_crypto_key,
2351                                 remote_crypto_key, integ_alg, local_integ_key,
2352                                 remote_integ_key, is_add=1, esn=0, salt=0,
2353                                 anti_replay=1, renumber=0, show_instance=0):
2354         return self.api(
2355             self.papi.ipsec_tunnel_if_add_del,
2356             {
2357                 'local_ip': local_ip,
2358                 'remote_ip': remote_ip,
2359                 'local_spi': local_spi,
2360                 'remote_spi': remote_spi,
2361                 'crypto_alg': crypto_alg,
2362                 'local_crypto_key_len': len(local_crypto_key),
2363                 'local_crypto_key': local_crypto_key,
2364                 'remote_crypto_key_len': len(remote_crypto_key),
2365                 'remote_crypto_key': remote_crypto_key,
2366                 'integ_alg': integ_alg,
2367                 'local_integ_key_len': len(local_integ_key),
2368                 'local_integ_key': local_integ_key,
2369                 'remote_integ_key_len': len(remote_integ_key),
2370                 'remote_integ_key': remote_integ_key,
2371                 'is_add': is_add,
2372                 'esn': esn,
2373                 'anti_replay': anti_replay,
2374                 'renumber': renumber,
2375                 'show_instance': show_instance,
2376                 'salt': salt
2377             })
2378
2379     def ipsec_gre_tunnel_add_del(self, local_ip, remote_ip,
2380                                  sa_out, sa_in, is_add=1):
2381         return self.api(self.papi.ipsec_gre_tunnel_add_del,
2382                         {
2383                             'is_add': is_add,
2384                             'tunnel': {
2385                                 'src': local_ip,
2386                                 'dst': remote_ip,
2387                                 'local_sa_id': sa_out,
2388                                 'remote_sa_id': sa_in
2389                             }
2390                         })
2391
2392     def ipsec_select_backend(self, protocol, index):
2393         return self.api(self.papi.ipsec_select_backend,
2394                         {'protocol': protocol, 'index': index})
2395
2396     def ipsec_backend_dump(self):
2397         return self.api(self.papi.ipsec_backend_dump, {})
2398
2399     def app_namespace_add_del(self,
2400                               namespace_id,
2401                               ip4_fib_id=0,
2402                               ip6_fib_id=0,
2403                               sw_if_index=0xFFFFFFFF,
2404                               secret=0):
2405         return self.api(
2406             self.papi.app_namespace_add_del,
2407             {'secret': secret,
2408              'sw_if_index': sw_if_index,
2409              'ip4_fib_id': ip4_fib_id,
2410              'ip6_fib_id': ip6_fib_id,
2411              'namespace_id': namespace_id,
2412              'namespace_id_len': len(namespace_id)})
2413
2414     def punt_socket_register(self, port, pathname, protocol=0x11,
2415                              header_version=1, is_ip4=1):
2416         """ Register punt socket """
2417         return self.api(self.papi.punt_socket_register,
2418                         {'header_version': header_version,
2419                          'punt': {'ipv': is_ip4,
2420                                   'l4_protocol': protocol,
2421                                   'l4_port': port},
2422                          'pathname': pathname})
2423
2424     def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
2425         """ Unregister punt socket """
2426         return self.api(self.papi.punt_socket_deregister,
2427                         {'punt': {'ipv': is_ip4,
2428                                   'l4_protocol': protocol,
2429                                   'l4_port': port}})
2430
2431     def punt_socket_dump(self, is_ip6=1):
2432         """ Dump punt socket"""
2433         return self.api(self.papi.punt_socket_dump,
2434                         {'is_ipv6': is_ip6})
2435
2436     def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
2437                          tun_src, tun_dst):
2438         """ GBP endpoint Add """
2439         return self.api(self.papi.gbp_endpoint_add,
2440                         {'endpoint': {
2441                             'sw_if_index': sw_if_index,
2442                             'ips': ips,
2443                             'n_ips': len(ips),
2444                             'mac': mac,
2445                             'sclass': sclass,
2446                             'flags': flags,
2447                             'tun': {
2448                                 'src': tun_src,
2449                                 'dst': tun_dst,
2450                             }}})
2451
2452     def gbp_endpoint_del(self, handle):
2453         """ GBP endpoint Del """
2454         return self.api(self.papi.gbp_endpoint_del,
2455                         {'handle': handle})
2456
2457     def gbp_endpoint_dump(self):
2458         """ GBP endpoint Dump """
2459         return self.api(self.papi.gbp_endpoint_dump,
2460                         {'_no_type_conversion': True})
2461
2462     def gbp_endpoint_group_add(self, vnid, sclass, bd,
2463                                rd, uplink_sw_if_index,
2464                                retention):
2465         """ GBP endpoint group Add """
2466         return self.api(self.papi.gbp_endpoint_group_add,
2467                         {'epg':
2468                             {
2469                                 'uplink_sw_if_index': uplink_sw_if_index,
2470                                 'bd_id': bd,
2471                                 'rd_id': rd,
2472                                 'vnid': vnid,
2473                                 'sclass': sclass,
2474                                 'retention': retention
2475                             }})
2476
2477     def gbp_endpoint_group_del(self, sclass):
2478         """ GBP endpoint group Del """
2479         return self.api(self.papi.gbp_endpoint_group_del,
2480                         {'sclass': sclass})
2481
2482     def gbp_bridge_domain_add(self, bd_id, flags,
2483                               bvi_sw_if_index,
2484                               uu_fwd_sw_if_index,
2485                               bm_flood_sw_if_index):
2486         """ GBP bridge-domain Add """
2487         return self.api(self.papi.gbp_bridge_domain_add,
2488                         {'bd':
2489                             {
2490                                 'flags': flags,
2491                                 'bvi_sw_if_index': bvi_sw_if_index,
2492                                 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2493                                 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2494                                 'bd_id': bd_id
2495                             }})
2496
2497     def gbp_bridge_domain_del(self, bd_id):
2498         """ GBP bridge-domain Del """
2499         return self.api(self.papi.gbp_bridge_domain_del,
2500                         {'bd_id': bd_id})
2501
2502     def gbp_route_domain_add(self, rd_id,
2503                              ip4_table_id,
2504                              ip6_table_id,
2505                              ip4_uu_sw_if_index,
2506                              ip6_uu_sw_if_index):
2507         """ GBP route-domain Add """
2508         return self.api(self.papi.gbp_route_domain_add,
2509                         {'rd':
2510                             {
2511                                 'ip4_table_id': ip4_table_id,
2512                                 'ip6_table_id': ip6_table_id,
2513                                 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2514                                 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2515                                 'rd_id': rd_id
2516                             }})
2517
2518     def gbp_route_domain_del(self, rd_id):
2519         """ GBP route-domain Del """
2520         return self.api(self.papi.gbp_route_domain_del,
2521                         {'rd_id': rd_id})
2522
2523     def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2524         """ GBP recirc Add/Del """
2525         return self.api(self.papi.gbp_recirc_add_del,
2526                         {'is_add': is_add,
2527                          'recirc': {
2528                              'is_ext': is_ext,
2529                              'sw_if_index': sw_if_index,
2530                              'sclass': sclass}})
2531
2532     def gbp_recirc_dump(self):
2533         """ GBP recirc Dump """
2534         return self.api(self.papi.gbp_recirc_dump, {})
2535
2536     def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2537         """ GBP recirc Add/Del """
2538         return self.api(self.papi.gbp_ext_itf_add_del,
2539                         {'is_add': is_add,
2540                          'ext_itf': {
2541                              'sw_if_index': sw_if_index,
2542                              'bd_id': bd_id,
2543                              'rd_id': rd_id}})
2544
2545     def gbp_ext_itf_dump(self):
2546         """ GBP recirc Dump """
2547         return self.api(self.papi.gbp_ext_itf_dump, {})
2548
2549     def gbp_subnet_add_del(self, is_add, rd_id,
2550                            prefix, type,
2551                            sw_if_index=0xffffffff,
2552                            sclass=0xffff):
2553         """ GBP Subnet Add/Del """
2554         return self.api(self.papi.gbp_subnet_add_del,
2555                         {'is_add': is_add,
2556                          'subnet': {
2557                              'type': type,
2558                              'sw_if_index': sw_if_index,
2559                              'sclass': sclass,
2560                              'prefix': prefix,
2561                              'rd_id': rd_id}})
2562
2563     def gbp_subnet_dump(self):
2564         """ GBP Subnet Dump """
2565         return self.api(self.papi.gbp_subnet_dump,
2566                         {'_no_type_conversion': True})
2567
2568     def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2569                              rules, allowed_ethertypes):
2570         """ GBP contract Add/Del """
2571         return self.api(self.papi.gbp_contract_add_del,
2572                         {'is_add': is_add,
2573                          'contract': {
2574                              'acl_index': acl_index,
2575                              'sclass': sclass,
2576                              'dclass': dclass,
2577                              'n_rules': len(rules),
2578                              'rules': rules,
2579                              'n_ether_types': len(allowed_ethertypes),
2580                              'allowed_ethertypes': allowed_ethertypes}})
2581
2582     def gbp_contract_dump(self):
2583         """ GBP contract Dump """
2584         return self.api(self.papi.gbp_contract_dump, {})
2585
2586     def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2587         """ GBP VXLAN tunnel add """
2588         return self.api(self.papi.gbp_vxlan_tunnel_add,
2589                         {
2590                             'tunnel': {
2591                                 'vni': vni,
2592                                 'mode': mode,
2593                                 'bd_rd_id': bd_rd_id,
2594                                 'src': src
2595                             }
2596                         })
2597
2598     def gbp_vxlan_tunnel_del(self, vni):
2599         """ GBP VXLAN tunnel del """
2600         return self.api(self.papi.gbp_vxlan_tunnel_del,
2601                         {
2602                             'vni': vni,
2603                         })
2604
2605     def gbp_vxlan_tunnel_dump(self):
2606         """ GBP VXLAN tunnel add/del """
2607         return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2608
2609     def qos_egress_map_update(self, id, outputs):
2610         """ QOS egress map update """
2611         return self.api(self.papi.qos_egress_map_update,
2612                         {'map_id': id,
2613                          'rows': outputs})
2614
2615     def qos_egress_map_delete(self, id):
2616         """ QOS egress map delete """
2617         return self.api(self.papi.qos_egress_map_delete,
2618                         {'map_id': id})
2619
2620     def qos_mark_enable_disable(self, sw_if_index,
2621                                 output_source,
2622                                 map_id,
2623                                 enable):
2624         """ QOS Mark Enable/Disable """
2625         return self.api(self.papi.qos_mark_enable_disable,
2626                         {'map_id': map_id,
2627                          'sw_if_index': sw_if_index,
2628                          'output_source': output_source,
2629                          'enable': enable})
2630
2631     def igmp_enable_disable(self, sw_if_index, enable, host):
2632         """ Enable/disable IGMP on a given interface """
2633         return self.api(self.papi.igmp_enable_disable,
2634                         {'enable': enable,
2635                          'mode': host,
2636                          'sw_if_index': sw_if_index})
2637
2638     def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2639         """ Add/del IGMP proxy device """
2640         return self.api(self.papi.igmp_proxy_device_add_del,
2641                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2642                          'add': add})
2643
2644     def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2645         """ Add/del interface to/from IGMP proxy device """
2646         return self.api(self.papi.igmp_proxy_device_add_del_interface,
2647                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2648                          'add': add})
2649
2650     def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2651         """ Listen for new (S,G) on specified interface
2652
2653         :param enable: add/del
2654         :param sw_if_index: interface sw index
2655         :param saddr: source ip4 addr
2656         :param gaddr: group ip4 addr
2657         """
2658         return self.api(self.papi.igmp_listen,
2659                         {
2660                             'group':
2661                                 {
2662                                     'filter': filter,
2663                                     'sw_if_index': sw_if_index,
2664                                     'n_srcs': len(saddrs),
2665                                     'saddrs': saddrs,
2666                                     'gaddr': gaddr
2667                                 }
2668                         })
2669
2670     def igmp_clear_interface(self, sw_if_index):
2671         """ Remove all (S,G)s from specified interface
2672             doesn't send IGMP report!
2673         """
2674         return self.api(
2675             self.papi.igmp_clear_interface, {
2676                 'sw_if_index': sw_if_index})
2677
2678     def want_igmp_events(self, enable=1):
2679         return self.api(self.papi.want_igmp_events, {'enable': enable,
2680                                                      'pid': os.getpid()})
2681
2682     def bond_create(
2683             self,
2684             mode,
2685             lb,
2686             use_custom_mac,
2687             mac_address='',
2688             interface_id=0xFFFFFFFF):
2689         """
2690         :param mode: mode
2691         :param lb: load balance
2692         :param use_custom_mac: use custom mac
2693         :param mac_address: mac address
2694         :param interface_id: custom interface ID
2695         """
2696         return self.api(
2697             self.papi.bond_create,
2698             {'mode': mode,
2699              'lb': lb,
2700              'use_custom_mac': use_custom_mac,
2701              'mac_address': mac_address,
2702              'id': interface_id
2703              })
2704
2705     def pipe_delete(self, parent_sw_if_index):
2706         return self.api(self.papi.pipe_delete,
2707                         {'parent_sw_if_index': parent_sw_if_index})
2708
2709     def memif_create(
2710             self,
2711             role,
2712             mode,
2713             rx_queues=None,
2714             tx_queues=None,
2715             _id=None,
2716             socket_id=None,
2717             secret=None,
2718             ring_size=None,
2719             buffer_size=None,
2720             hw_addr=None):
2721         return self.api(self.papi.memif_create,
2722                         {'role': role,
2723                          'mode': mode,
2724                          'rx_queues': rx_queues,
2725                          'tx_queues': tx_queues,
2726                          'id': _id,
2727                          'socket_id': socket_id,
2728                          'secret': secret,
2729                          'ring_size': ring_size,
2730                          'buffer_size': buffer_size,
2731                          'hw_addr': hw_addr})
2732
2733     def svs_table_add_del(self, af, table_id, is_add=1):
2734         return self.api(self.papi.svs_table_add_del,
2735                         {
2736                             'table_id': table_id,
2737                             'is_add': is_add,
2738                             'af': af,
2739                         })
2740
2741     def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2742         return self.api(self.papi.svs_route_add_del,
2743                         {
2744                             'table_id': table_id,
2745                             'source_table_id': src_table_id,
2746                             'prefix': prefix,
2747                             'is_add': is_add,
2748                         })
2749
2750     def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2751         return self.api(self.papi.svs_enable_disable,
2752                         {
2753                             'af': af,
2754                             'table_id': table_id,
2755                             'sw_if_index': sw_if_index,
2756                             'is_enable': is_enable,
2757                         })