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