test/vpp_papi_provider.py

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