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