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