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