test/vpp_papi_provider.py

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