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, 'pid': os.getpid(), },
 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 sw_interface_set_mac_address(self, sw_if_index, mac):
 378         return self.api(self.papi.sw_interface_set_mac_address,
 379                         {'sw_if_index': sw_if_index,
 380                          'mac_address': mac})
 381
 382     def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
 383         """Create p2p ethernet subinterface
 384
 385         :param sw_if_index: main (parent) interface
 386         :param remote_mac: client (remote) mac address
 387
 388         """
 389         return self.api(
 390             self.papi.p2p_ethernet_add,
 391             {'parent_if_index': sw_if_index,
 392              'remote_mac': remote_mac,
 393              'subif_id': subif_id})
 394
 395     def p2p_ethernet_del(self, sw_if_index, remote_mac):
 396         """Delete p2p ethernet subinterface
 397
 398         :param sw_if_index: main (parent) interface
 399         :param remote_mac: client (remote) mac address
 400
 401         """
 402         return self.api(
 403             self.papi.p2p_ethernet_del,
 404             {'parent_if_index': sw_if_index,
 405              'remote_mac': remote_mac})
 406
 407     def create_vlan_subif(self, sw_if_index, vlan):
 408         """
 409
 410         :param vlan:
 411         :param sw_if_index:
 412
 413         """
 414         return self.api(self.papi.create_vlan_subif,
 415                         {'sw_if_index': sw_if_index,
 416                          'vlan_id': vlan})
 417
 418     def create_loopback(self, mac=''):
 419         """
 420
 421         :param mac: (Optional)
 422         """
 423         return self.api(self.papi.create_loopback,
 424                         {'mac_address': mac})
 425
 426     def ip_route_dump(self, table_id, is_ip6=False):
 427         return self.api(self.papi.ip_route_dump,
 428                         {'table': {
 429                             'table_id': table_id,
 430                             'is_ip6': is_ip6
 431                         }})
 432
 433     def ip_neighbor_add_del(self,
 434                             sw_if_index,
 435                             mac_address,
 436                             ip_address,
 437                             is_add=1,
 438                             flags=0):
 439         """ Add neighbor MAC to IPv4 or IPv6 address.
 440
 441         :param sw_if_index:
 442         :param mac_address:
 443         :param dst_address:
 444         :param is_add:  (Default value = 1)
 445         :param flags:  (Default value = 0/NONE)
 446         """
 447         return self.api(
 448             self.papi.ip_neighbor_add_del,
 449             {
 450                 'is_add': is_add,
 451                 'neighbor': {
 452                     'sw_if_index': sw_if_index,
 453                     'flags': flags,
 454                     'mac_address': mac_address,
 455                     'ip_address': ip_address
 456                 }
 457             }
 458         )
 459
 460     def proxy_arp_add_del(self,
 461                           low,
 462                           hi,
 463                           table_id=0,
 464                           is_add=1):
 465         """ Config Proxy Arp Range.
 466
 467         :param low_address: Start address in the rnage to Proxy for
 468         :param hi_address: End address in the rnage to Proxy for
 469         :param vrf_id: The VRF/table in which to proxy
 470         """
 471
 472         return self.api(
 473             self.papi.proxy_arp_add_del,
 474             {'proxy':
 475                 {
 476                     'table_id': table_id,
 477                     'low': low,
 478                     'hi': hi,
 479                 },
 480                 'is_add': is_add})
 481
 482     def proxy_arp_intfc_enable_disable(self,
 483                                        sw_if_index,
 484                                        is_enable=1):
 485         """ Enable/Disable an interface for proxy ARP requests
 486
 487         :param sw_if_index: Interface
 488         :param enable_disable: Enable/Disable
 489         """
 490
 491         return self.api(
 492             self.papi.proxy_arp_intfc_enable_disable,
 493             {'sw_if_index': sw_if_index,
 494              'enable': is_enable
 495              }
 496         )
 497
 498     def udp_encap_add(self,
 499                       src_ip,
 500                       dst_ip,
 501                       src_port,
 502                       dst_port,
 503                       table_id=0):
 504         """ Add a GRE tunnel
 505         :param src_ip:
 506         :param dst_ip:
 507         :param src_port:
 508         :param dst_port:
 509         :param outer_fib_id:  (Default value = 0)
 510         """
 511
 512         return self.api(
 513             self.papi.udp_encap_add,
 514             {
 515                 'udp_encap': {
 516                     'src_ip': src_ip,
 517                     'dst_ip': dst_ip,
 518                     'src_port': src_port,
 519                     'dst_port': dst_port,
 520                     'table_id': table_id
 521                 }
 522             })
 523
 524     def udp_encap_del(self, id):
 525         return self.api(self.papi.udp_encap_del, {'id': id})
 526
 527     def udp_encap_dump(self):
 528         return self.api(self.papi.udp_encap_dump, {})
 529
 530     def want_udp_encap_stats(self, enable=1):
 531         return self.api(self.papi.want_udp_encap_stats,
 532                         {'enable': enable,
 533                          'pid': os.getpid()})
 534
 535     def mpls_route_dump(self, table_id):
 536         return self.api(self.papi.mpls_route_dump,
 537                         {'table': {
 538                             'mt_table_id': table_id
 539                         }})
 540
 541     def mpls_table_dump(self):
 542         return self.api(self.papi.mpls_table_dump, {})
 543
 544     def mpls_table_add_del(
 545             self,
 546             table_id,
 547             is_add=1):
 548         """
 549
 550         :param table_id
 551         :param is_add:  (Default value = 1)
 552
 553         """
 554
 555         return self.api(
 556             self.papi.mpls_table_add_del,
 557             {'mt_table':
 558              {
 559                  'mt_table_id': table_id,
 560              },
 561              'mt_is_add': is_add})
 562
 563     def mpls_route_add_del(self,
 564                            table_id,
 565                            label,
 566                            eos,
 567                            eos_proto,
 568                            is_multicast,
 569                            paths,
 570                            is_add,
 571                            is_multipath):
 572         """ MPLS Route add/del """
 573         return self.api(
 574             self.papi.mpls_route_add_del,
 575             {'mr_route':
 576              {
 577                  'mr_table_id': table_id,
 578                  'mr_label': label,
 579                  'mr_eos': eos,
 580                  'mr_eos_proto': eos_proto,
 581                  'mr_is_multicast': is_multicast,
 582                  'mr_n_paths': len(paths),
 583                  'mr_paths': paths,
 584              },
 585              'mr_is_add': is_add,
 586              'mr_is_multipath': is_multipath})
 587
 588     def mpls_ip_bind_unbind(
 589             self,
 590             label,
 591             prefix,
 592             table_id=0,
 593             ip_table_id=0,
 594             is_bind=1):
 595         """
 596         """
 597         return self.api(
 598             self.papi.mpls_ip_bind_unbind,
 599             {'mb_mpls_table_id': table_id,
 600              'mb_label': label,
 601              'mb_ip_table_id': ip_table_id,
 602              'mb_is_bind': is_bind,
 603              'mb_prefix': prefix})
 604
 605     def mpls_tunnel_add_del(
 606             self,
 607             tun_sw_if_index,
 608             paths,
 609             is_add=1,
 610             l2_only=0,
 611             is_multicast=0):
 612         """
 613         """
 614         return self.api(
 615             self.papi.mpls_tunnel_add_del,
 616             {'mt_is_add': is_add,
 617              'mt_tunnel':
 618              {
 619                  'mt_sw_if_index': tun_sw_if_index,
 620                  'mt_l2_only': l2_only,
 621                  'mt_is_multicast': is_multicast,
 622                  'mt_n_paths': len(paths),
 623                  'mt_paths': paths,
 624              }})
 625
 626     def input_acl_set_interface(
 627             self,
 628             is_add,
 629             sw_if_index,
 630             ip4_table_index=0xFFFFFFFF,
 631             ip6_table_index=0xFFFFFFFF,
 632             l2_table_index=0xFFFFFFFF):
 633         """
 634         :param is_add:
 635         :param sw_if_index:
 636         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
 637         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
 638         :param l2_table_index:  (Default value = 0xFFFFFFFF)
 639         """
 640
 641         return self.api(
 642             self.papi.input_acl_set_interface,
 643             {'sw_if_index': sw_if_index,
 644              'ip4_table_index': ip4_table_index,
 645              'ip6_table_index': ip6_table_index,
 646              'l2_table_index': l2_table_index,
 647              'is_add': is_add})
 648
 649     def output_acl_set_interface(
 650             self,
 651             is_add,
 652             sw_if_index,
 653             ip4_table_index=0xFFFFFFFF,
 654             ip6_table_index=0xFFFFFFFF,
 655             l2_table_index=0xFFFFFFFF):
 656         """
 657         :param is_add:
 658         :param sw_if_index:
 659         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
 660         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
 661         :param l2_table_index:  (Default value = 0xFFFFFFFF)
 662         """
 663
 664         return self.api(
 665             self.papi.output_acl_set_interface,
 666             {'sw_if_index': sw_if_index,
 667              'ip4_table_index': ip4_table_index,
 668              'ip6_table_index': ip6_table_index,
 669              'l2_table_index': l2_table_index,
 670              'is_add': is_add})
 671
 672     def set_ipfix_exporter(
 673             self,
 674             collector_address,
 675             src_address,
 676             path_mtu,
 677             template_interval,
 678             vrf_id=0,
 679             collector_port=4739,
 680             udp_checksum=0):
 681         return self.api(
 682             self.papi.set_ipfix_exporter,
 683             {
 684                 'collector_address': collector_address,
 685                 'collector_port': collector_port,
 686                 'src_address': src_address,
 687                 'vrf_id': vrf_id,
 688                 'path_mtu': path_mtu,
 689                 'template_interval': template_interval,
 690                 'udp_checksum': udp_checksum,
 691             })
 692
 693     def ip_mroute_add_del(self,
 694                           table_id,
 695                           prefix,
 696                           e_flags,
 697                           rpf_id,
 698                           paths,
 699                           is_add=1,
 700                           is_multipath=1):
 701         """
 702         IP Multicast Route add/del
 703         """
 704         return self.api(
 705             self.papi.ip_mroute_add_del,
 706             {
 707                 'is_add': is_add,
 708                 'is_multipath': is_multipath,
 709                 'route': {
 710                     'table_id': table_id,
 711                     'entry_flags': e_flags,
 712                     'rpf_id': rpf_id,
 713                     'prefix': prefix,
 714                     'n_paths': len(paths),
 715                     'paths': paths,
 716                 }
 717             })
 718
 719     def mfib_signal_dump(self):
 720         return self.api(self.papi.mfib_signal_dump, {})
 721
 722     def ip_mroute_dump(self, table_id, is_ip6=False):
 723         return self.api(self.papi.ip_mroute_dump,
 724                         {'table': {
 725                             'table_id': table_id,
 726                             'is_ip6': is_ip6
 727                         }})
 728
 729     def lisp_enable_disable(self, is_enabled):
 730         return self.api(
 731             self.papi.lisp_enable_disable,
 732             {
 733                 'is_en': is_enabled,
 734             })
 735
 736     def lisp_add_del_locator_set(self,
 737                                  ls_name,
 738                                  is_add=1):
 739         return self.api(
 740             self.papi.lisp_add_del_locator_set,
 741             {
 742                 'is_add': is_add,
 743                 'locator_set_name': ls_name
 744             })
 745
 746     def lisp_add_del_locator(self,
 747                              ls_name,
 748                              sw_if_index,
 749                              priority=1,
 750                              weight=1,
 751                              is_add=1):
 752         return self.api(
 753             self.papi.lisp_add_del_locator,
 754             {
 755                 'is_add': is_add,
 756                 'locator_set_name': ls_name,
 757                 'sw_if_index': sw_if_index,
 758                 'priority': priority,
 759                 'weight': weight
 760             })
 761
 762     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
 763         return self.api(
 764             self.papi.lisp_locator_dump,
 765             {
 766                 'is_index_set': is_index_set,
 767                 'ls_name': ls_name,
 768                 'ls_index': ls_index,
 769             })
 770
 771     def lisp_add_del_local_eid(self,
 772                                ls_name,
 773                                eid_type,
 774                                eid,
 775                                prefix_len,
 776                                vni=0,
 777                                key_id=0,
 778                                key="",
 779                                is_add=1):
 780         return self.api(
 781             self.papi.lisp_add_del_local_eid,
 782             {
 783                 'locator_set_name': ls_name,
 784                 'is_add': is_add,
 785                 'eid_type': eid_type,
 786                 'eid': eid,
 787                 'prefix_len': prefix_len,
 788                 'vni': vni,
 789                 'key_id': key_id,
 790                 'key': key
 791             })
 792
 793     def lisp_eid_table_dump(self,
 794                             eid_set=0,
 795                             prefix_length=0,
 796                             vni=0,
 797                             eid_type=0,
 798                             eid=None,
 799                             filter_opt=0):
 800         return self.api(
 801             self.papi.lisp_eid_table_dump,
 802             {
 803                 'eid_set': eid_set,
 804                 'prefix_length': prefix_length,
 805                 'vni': vni,
 806                 'eid_type': eid_type,
 807                 'eid': eid,
 808                 'filter': filter_opt,
 809             })
 810
 811     def lisp_add_del_remote_mapping(self,
 812                                     eid_type,
 813                                     eid,
 814                                     eid_prefix_len=0,
 815                                     vni=0,
 816                                     rlocs=[],
 817                                     rlocs_num=0,
 818                                     is_src_dst=0,
 819                                     is_add=1):
 820         return self.api(
 821             self.papi.lisp_add_del_remote_mapping,
 822             {
 823                 'is_add': is_add,
 824                 'eid_type': eid_type,
 825                 'eid': eid,
 826                 'eid_len': eid_prefix_len,
 827                 'rloc_num': rlocs_num,
 828                 'rlocs': rlocs,
 829                 'vni': vni,
 830                 'is_src_dst': is_src_dst,
 831             })
 832
 833     def lisp_add_del_adjacency(self,
 834                                leid,
 835                                reid,
 836                                leid_len,
 837                                reid_len,
 838                                eid_type,
 839                                is_add=1,
 840                                vni=0):
 841         return self.api(
 842             self.papi.lisp_add_del_adjacency,
 843             {
 844                 'is_add': is_add,
 845                 'vni': vni,
 846                 'eid_type': eid_type,
 847                 'leid': leid,
 848                 'reid': reid,
 849                 'leid_len': leid_len,
 850                 'reid_len': reid_len,
 851             })
 852
 853     def vxlan_gpe_add_del_tunnel(
 854             self,
 855             src_addr,
 856             dst_addr,
 857             mcast_sw_if_index=0xFFFFFFFF,
 858             is_add=1,
 859             is_ipv6=0,
 860             encap_vrf_id=0,
 861             decap_vrf_id=0,
 862             protocol=3,
 863             vni=0):
 864         """
 865
 866         :param local:
 867         :param remote:
 868         :param is_add:  (Default value = 1)
 869         :param is_ipv6:  (Default value = 0)
 870         :param encap_vrf_id:  (Default value = 0)
 871         :param decap_vrf_id:  (Default value = 0)
 872         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 873         :param protocol:  (Default value = 3)
 874         :param vni:  (Default value = 0)
 875
 876         """
 877         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
 878                         {'is_add': is_add,
 879                          'is_ipv6': is_ipv6,
 880                          'local': src_addr,
 881                          'remote': dst_addr,
 882                          'mcast_sw_if_index': mcast_sw_if_index,
 883                          'encap_vrf_id': encap_vrf_id,
 884                          'decap_vrf_id': decap_vrf_id,
 885                          'protocol': protocol,
 886                          'vni': vni})
 887
 888     def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
 889         return self.api(self.papi.vxlan_gbp_tunnel_dump,
 890                         {'sw_if_index': sw_if_index})
 891
 892     def pppoe_add_del_session(
 893             self,
 894             client_ip,
 895             client_mac,
 896             session_id=0,
 897             is_add=1,
 898             decap_vrf_id=0):
 899         """
 900
 901         :param is_add:  (Default value = 1)
 902         :param is_ipv6:  (Default value = 0)
 903         :param client_ip:
 904         :param session_id:  (Default value = 0)
 905         :param client_mac:
 906         :param decap_vrf_id:  (Default value = 0)
 907
 908         """
 909         return self.api(self.papi.pppoe_add_del_session,
 910                         {'is_add': is_add,
 911                          'session_id': session_id,
 912                          'client_ip': client_ip,
 913                          'decap_vrf_id': decap_vrf_id,
 914                          'client_mac': client_mac})
 915
 916     def sr_mpls_policy_add(self, bsid, weight, type, segments):
 917         return self.api(self.papi.sr_mpls_policy_add,
 918                         {'bsid': bsid,
 919                          'weight': weight,
 920                          'is_spray': type,
 921                          'n_segments': len(segments),
 922                          'segments': segments})
 923
 924     def sr_mpls_policy_del(self, bsid):
 925         return self.api(self.papi.sr_mpls_policy_del,
 926                         {'bsid': bsid})
 927
 928     def sr_localsid_add_del(self,
 929                             localsid,
 930                             behavior,
 931                             nh_addr4,
 932                             nh_addr6,
 933                             is_del=0,
 934                             end_psp=0,
 935                             sw_if_index=0xFFFFFFFF,
 936                             vlan_index=0,
 937                             fib_table=0,
 938                             ):
 939         """ Add/del IPv6 SR local-SID.
 940
 941         :param localsid:
 942         :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
 943         :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
 944         :param nh_addr4:
 945         :param nh_addr6:
 946         :param is_del:  (Default value = 0)
 947         :param end_psp: (Default value = 0)
 948         :param sw_if_index: (Default value = 0xFFFFFFFF)
 949         :param vlan_index:  (Default value = 0)
 950         :param fib_table:   (Default value = 0)
 951         """
 952         return self.api(
 953             self.papi.sr_localsid_add_del,
 954             {'is_del': is_del,
 955              'localsid': localsid,
 956              'end_psp': end_psp,
 957              'behavior': behavior,
 958              'sw_if_index': sw_if_index,
 959              'vlan_index': vlan_index,
 960              'fib_table': fib_table,
 961              'nh_addr4': nh_addr4,
 962              'nh_addr6': nh_addr6
 963              }
 964         )
 965
 966     def sr_policy_add(
 967             self,
 968             bsid_addr,
 969             weight=1,
 970             is_encap=1,
 971             type=0,
 972             fib_table=0,
 973             n_segments=0,
 974             segments=[]):
 975         """
 976         :param bsid_addr: bindingSID of the SR Policy
 977         :param weight: weight of the sid list. optional. (default: 1)
 978         :param is_encap: (bool) whether SR policy should Encap or SRH insert \
 979             (default: Encap)
 980         :param type: type/behavior of the SR policy. (default or spray) \
 981             (default: default)
 982         :param fib_table: VRF where to install the FIB entry for the BSID \
 983             (default: 0)
 984         :param n_segments: number of segments \
 985             (default: 0)
 986         :param segments: a vector of IPv6 address composing the segment list \
 987             (default: [])
 988         """
 989         return self.api(
 990             self.papi.sr_policy_add,
 991             {'bsid_addr': bsid_addr,
 992              'weight': weight,
 993              'is_encap': is_encap,
 994              'type': type,
 995              'fib_table': fib_table,
 996              'n_segments': n_segments,
 997              'segments': segments
 998              }
 999         )
1000
1001     def sr_policy_del(
1002             self,
1003             bsid_addr,
1004             sr_policy_index=0):
1005         """
1006         :param bsid: bindingSID of the SR Policy
1007         :param sr_policy_index: index of the sr policy (default: 0)
1008         """
1009         return self.api(
1010             self.papi.sr_policy_del,
1011             {'bsid_addr': bsid_addr,
1012              'sr_policy_index': sr_policy_index
1013              })
1014
1015     def sr_steering_add_del(
1016             self,
1017             is_del,
1018             bsid_addr,
1019             sr_policy_index,
1020             table_id,
1021             prefix_addr,
1022             mask_width,
1023             sw_if_index,
1024             traffic_type):
1025         """
1026         Steer traffic L2 and L3 traffic through a given SR policy
1027
1028         :param is_del: delete or add
1029         :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
1030         :param sr_policy: is the index of the SR Policy (alt to bsid)
1031         :param table_id: is the VRF where to install the FIB entry for the BSID
1032         :param prefix_addr: is the IPv4/v6 address for L3 traffic type
1033         :param mask_width: is the mask for L3 traffic type
1034         :param sw_if_index: is the incoming interface for L2 traffic
1035         :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
1036         """
1037         return self.api(
1038             self.papi.sr_steering_add_del,
1039             {'is_del': is_del,
1040              'bsid_addr': bsid_addr,
1041              'sr_policy_index': sr_policy_index,
1042              'table_id': table_id,
1043              'prefix_addr': prefix_addr,
1044              'mask_width': mask_width,
1045              'sw_if_index': sw_if_index,
1046              'traffic_type': traffic_type
1047              })
1048
1049     def acl_add_replace(self, acl_index, r, tag='',
1050                         expected_retval=0):
1051         """Add/replace an ACL
1052         :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
1053         :param acl_rule r: ACL rules array.
1054         :param str tag: symbolic tag (description) for this ACL.
1055         :param int count: number of rules.
1056         """
1057         return self.api(self.papi.acl_add_replace,
1058                         {'acl_index': acl_index,
1059                          'r': r,
1060                          'count': len(r),
1061                          'tag': tag},
1062                         expected_retval=expected_retval)
1063
1064     def acl_del(self, acl_index, expected_retval=0):
1065         """
1066
1067         :param acl_index:
1068         :return:
1069         """
1070         return self.api(self.papi.acl_del,
1071                         {'acl_index': acl_index},
1072                         expected_retval=expected_retval)
1073
1074     def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
1075                                    expected_retval=0):
1076         return self.api(self.papi.acl_interface_set_acl_list,
1077                         {'sw_if_index': sw_if_index,
1078                          'count': len(acls),
1079                          'n_input': n_input,
1080                          'acls': acls},
1081                         expected_retval=expected_retval)
1082
1083     def acl_interface_set_etype_whitelist(self, sw_if_index,
1084                                           n_input, whitelist,
1085                                           expected_retval=0):
1086         return self.api(self.papi.acl_interface_set_etype_whitelist,
1087                         {'sw_if_index': sw_if_index,
1088                          'count': len(whitelist),
1089                          'n_input': n_input,
1090                          'whitelist': whitelist},
1091                         expected_retval=expected_retval)
1092
1093     def acl_interface_add_del(self,
1094                               sw_if_index,
1095                               acl_index,
1096                               is_add=1):
1097         """ Add/Delete ACL to/from interface
1098
1099         :param sw_if_index:
1100         :param acl_index:
1101         :param is_add:  (Default value = 1)
1102         """
1103
1104         return self.api(self.papi.acl_interface_add_del,
1105                         {'is_add': is_add,
1106                          'is_input': 1,
1107                          'sw_if_index': sw_if_index,
1108                          'acl_index': acl_index})
1109
1110     def acl_dump(self, acl_index, expected_retval=0):
1111         return self.api(self.papi.acl_dump,
1112                         {'acl_index': acl_index},
1113                         expected_retval=expected_retval)
1114
1115     def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
1116                                 expected_retval=0):
1117         return self.api(self.papi.acl_interface_list_dump,
1118                         {'sw_if_index': sw_if_index},
1119                         expected_retval=expected_retval)
1120
1121     def macip_acl_add(self, rules, tag=""):
1122         """ Add MACIP acl
1123
1124         :param rules: list of rules for given acl
1125         :param tag: acl tag
1126         """
1127
1128         return self.api(self.papi.macip_acl_add,
1129                         {'r': rules,
1130                          'count': len(rules),
1131                          'tag': tag})
1132
1133     def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
1134         """ Add MACIP acl
1135
1136         :param rules: list of rules for given acl
1137         :param tag: acl tag
1138         """
1139
1140         return self.api(self.papi.macip_acl_add_replace,
1141                         {'acl_index': acl_index,
1142                          'r': rules,
1143                          'count': len(rules),
1144                          'tag': tag})
1145
1146     def macip_acl_interface_add_del(self,
1147                                     sw_if_index,
1148                                     acl_index,
1149                                     is_add=1):
1150         """ Add MACIP acl to interface
1151
1152         :param sw_if_index:
1153         :param acl_index:
1154         :param is_add:  (Default value = 1)
1155         """
1156
1157         return self.api(self.papi.macip_acl_interface_add_del,
1158                         {'is_add': is_add,
1159                          'sw_if_index': sw_if_index,
1160                          'acl_index': acl_index})
1161
1162     def macip_acl_dump(self, acl_index=4294967295):
1163         """ Return MACIP acl dump
1164         """
1165
1166         return self.api(
1167             self.papi.macip_acl_dump, {'acl_index': acl_index})
1168
1169     def policer_add_del(self,
1170                         name,
1171                         cir,
1172                         eir,
1173                         cb,
1174                         eb,
1175                         is_add=1,
1176                         rate_type=0,
1177                         round_type=0,
1178                         ptype=0,
1179                         color_aware=0,
1180                         conform_action_type=1,
1181                         conform_dscp=0,
1182                         exceed_action_type=0,
1183                         exceed_dscp=0,
1184                         violate_action_type=0,
1185                         violate_dscp=0):
1186         return self.api(self.papi.policer_add_del,
1187                         {'name': name,
1188                          'cir': cir,
1189                          'eir': eir,
1190                          'cb': cb,
1191                          'eb': eb,
1192                          'is_add': is_add,
1193                          'rate_type': rate_type,
1194                          'round_type': round_type,
1195                          'type': ptype,
1196                          'color_aware': color_aware,
1197                          'conform_action_type': conform_action_type,
1198                          'conform_dscp': conform_dscp,
1199                          'exceed_action_type': exceed_action_type,
1200                          'exceed_dscp': exceed_dscp,
1201                          'violate_action_type': violate_action_type,
1202                          'violate_dscp': violate_dscp})
1203
1204     def ip_punt_police(self,
1205                        policer_index,
1206                        is_ip6=0,
1207                        is_add=1):
1208         return self.api(self.papi.ip_punt_police,
1209                         {'policer_index': policer_index,
1210                          'is_add': is_add,
1211                          'is_ip6': is_ip6})
1212
1213     def ip_punt_redirect(self,
1214                          rx_sw_if_index,
1215                          tx_sw_if_index,
1216                          address,
1217                          is_add=1):
1218         return self.api(self.papi.ip_punt_redirect,
1219                         {'punt': {'rx_sw_if_index': rx_sw_if_index,
1220                                   'tx_sw_if_index': tx_sw_if_index,
1221                                   'nh': address},
1222                          'is_add': is_add})
1223
1224     def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
1225         return self.api(self.papi.ip_punt_redirect_dump,
1226                         {'sw_if_index': sw_if_index,
1227                          'is_ipv6': is_ipv6})
1228
1229     def bier_table_add_del(self,
1230                            bti,
1231                            mpls_label,
1232                            is_add=1):
1233         """ BIER Table add/del """
1234         return self.api(
1235             self.papi.bier_table_add_del,
1236             {'bt_tbl_id': {"bt_set": bti.set_id,
1237                            "bt_sub_domain": bti.sub_domain_id,
1238                            "bt_hdr_len_id": bti.hdr_len_id},
1239              'bt_label': mpls_label,
1240              'bt_is_add': is_add})
1241
1242     def bier_table_dump(self):
1243         return self.api(self.papi.bier_table_dump, {})
1244
1245     def bier_route_add_del(self,
1246                            bti,
1247                            bp,
1248                            paths,
1249                            is_add=1,
1250                            is_replace=0):
1251         """ BIER Route add/del """
1252         return self.api(
1253             self.papi.bier_route_add_del,
1254             {
1255                 'br_route': {
1256                     'br_tbl_id': {"bt_set": bti.set_id,
1257                                   "bt_sub_domain": bti.sub_domain_id,
1258                                   "bt_hdr_len_id": bti.hdr_len_id},
1259                     'br_bp': bp,
1260                     'br_n_paths': len(paths),
1261                     'br_paths': paths,
1262                 },
1263                 'br_is_add': is_add,
1264                 'br_is_replace': is_replace
1265             })
1266
1267     def bier_route_dump(self, bti):
1268         return self.api(
1269             self.papi.bier_route_dump,
1270             {'br_tbl_id': {"bt_set": bti.set_id,
1271                            "bt_sub_domain": bti.sub_domain_id,
1272                            "bt_hdr_len_id": bti.hdr_len_id}})
1273
1274     def bier_imp_add(self,
1275                      bti,
1276                      src,
1277                      ibytes,
1278                      is_add=1):
1279         """ BIER Imposition Add """
1280         return self.api(
1281             self.papi.bier_imp_add,
1282             {'bi_tbl_id': {"bt_set": bti.set_id,
1283                            "bt_sub_domain": bti.sub_domain_id,
1284                            "bt_hdr_len_id": bti.hdr_len_id},
1285              'bi_src': src,
1286              'bi_n_bytes': len(ibytes),
1287              'bi_bytes': ibytes})
1288
1289     def bier_imp_del(self, bi_index):
1290         """ BIER Imposition del """
1291         return self.api(
1292             self.papi.bier_imp_del,
1293             {'bi_index': bi_index})
1294
1295     def bier_imp_dump(self):
1296         return self.api(self.papi.bier_imp_dump, {})
1297
1298     def bier_disp_table_add_del(self,
1299                                 bdti,
1300                                 is_add=1):
1301         """ BIER Disposition Table add/del """
1302         return self.api(
1303             self.papi.bier_disp_table_add_del,
1304             {'bdt_tbl_id': bdti,
1305              'bdt_is_add': is_add})
1306
1307     def bier_disp_table_dump(self):
1308         return self.api(self.papi.bier_disp_table_dump, {})
1309
1310     def bier_disp_entry_add_del(self,
1311                                 bdti,
1312                                 bp,
1313                                 payload_proto,
1314                                 next_hop_afi,
1315                                 next_hop,
1316                                 next_hop_tbl_id=0,
1317                                 next_hop_rpf_id=~0,
1318                                 next_hop_is_ip4=1,
1319                                 is_add=1):
1320         """ BIER Route add/del """
1321         lstack = []
1322         while (len(lstack) < 16):
1323             lstack.append({})
1324         return self.api(
1325             self.papi.bier_disp_entry_add_del,
1326             {'bde_tbl_id': bdti,
1327              'bde_bp': bp,
1328              'bde_payload_proto': payload_proto,
1329              'bde_n_paths': 1,
1330              'bde_paths': [{'table_id': next_hop_tbl_id,
1331                             'rpf_id': next_hop_rpf_id,
1332                             'n_labels': 0,
1333                             'label_stack': lstack}],
1334              'bde_is_add': is_add})
1335
1336     def bier_disp_entry_dump(self, bdti):
1337         return self.api(
1338             self.papi.bier_disp_entry_dump,
1339             {'bde_tbl_id': bdti})
1340
1341     def session_enable_disable(self, is_enabled):
1342         return self.api(
1343             self.papi.session_enable_disable,
1344             {'is_enable': is_enabled})
1345
1346     def ipsec_spd_add_del(self, spd_id, is_add=1):
1347         """ SPD add/del - Wrapper to add or del ipsec SPD
1348         Sample CLI : 'ipsec spd add 1'
1349
1350         :param spd_id - SPD ID to be created in the vpp . mandatory
1351         :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
1352               optional
1353         :returns: reply from the API
1354         """
1355         return self.api(
1356             self.papi.ipsec_spd_add_del, {
1357                 'spd_id': spd_id, 'is_add': is_add})
1358
1359     def ipsec_spds_dump(self):
1360         return self.api(self.papi.ipsec_spds_dump, {})
1361
1362     def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
1363         """ IPSEC interface SPD add/del - \
1364              Wrapper to associate/disassociate SPD to interface in VPP
1365         Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
1366
1367         :param spd_id - SPD ID to associate with the interface . mandatory
1368         :param sw_if_index - Interface Index which needs to ipsec \
1369             association mandatory
1370         :param is_add - add(1) or del(0) association with interface \
1371                 (Default 1 - add) . optional
1372         :returns: reply from the API
1373         """
1374         return self.api(
1375             self.papi.ipsec_interface_add_del_spd,
1376             {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
1377
1378     def ipsec_spd_interface_dump(self, spd_index=None):
1379         return self.api(self.papi.ipsec_spd_interface_dump,
1380                         {'spd_index': spd_index if spd_index else 0,
1381                          'spd_index_valid': 1 if spd_index else 0})
1382
1383     def ipsec_sad_entry_add_del(self,
1384                                 sad_id,
1385                                 spi,
1386                                 integrity_algorithm,
1387                                 integrity_key,
1388                                 crypto_algorithm,
1389                                 crypto_key,
1390                                 protocol,
1391                                 tunnel_src_address='',
1392                                 tunnel_dst_address='',
1393                                 flags=0,
1394                                 salt=0,
1395                                 is_add=1):
1396         """ IPSEC SA add/del
1397         :param sad_id: security association ID
1398         :param spi: security param index of the SA in decimal
1399         :param integrity_algorithm:
1400         :param integrity_key:
1401         :param crypto_algorithm:
1402         :param crypto_key:
1403         :param protocol: AH(0) or ESP(1) protocol
1404         :param tunnel_src_address: tunnel mode outer src address
1405         :param tunnel_dst_address: tunnel mode outer dst address
1406         :param is_add:
1407         :param is_tunnel:
1408         :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
1409              crypto and ipsec algorithms
1410         """
1411         return self.api(
1412             self.papi.ipsec_sad_entry_add_del,
1413             {
1414                 'is_add': is_add,
1415                 'entry':
1416                     {
1417                         'sad_id': sad_id,
1418                         'spi': spi,
1419                         'tunnel_src': tunnel_src_address,
1420                         'tunnel_dst': tunnel_dst_address,
1421                         'protocol': protocol,
1422                         'integrity_algorithm': integrity_algorithm,
1423                         'integrity_key': {
1424                             'length': len(integrity_key),
1425                             'data': integrity_key,
1426                         },
1427                         'crypto_algorithm': crypto_algorithm,
1428                         'crypto_key': {
1429                             'length': len(crypto_key),
1430                             'data': crypto_key,
1431                         },
1432                         'flags': flags,
1433                         'salt': salt,
1434                     }
1435             })
1436
1437     def ipsec_sa_dump(self, sa_id=None):
1438         return self.api(self.papi.ipsec_sa_dump,
1439                         {'sa_id': sa_id if sa_id else 0xffffffff})
1440
1441     def ipsec_spd_entry_add_del(self,
1442                                 spd_id,
1443                                 sa_id,
1444                                 local_address_start,
1445                                 local_address_stop,
1446                                 remote_address_start,
1447                                 remote_address_stop,
1448                                 local_port_start=0,
1449                                 local_port_stop=65535,
1450                                 remote_port_start=0,
1451                                 remote_port_stop=65535,
1452                                 protocol=0,
1453                                 policy=0,
1454                                 priority=100,
1455                                 is_outbound=1,
1456                                 is_add=1,
1457                                 is_ipv6=0,
1458                                 is_ip_any=0):
1459         """ IPSEC policy SPD add/del   -
1460                     Wrapper to configure ipsec SPD policy entries in VPP
1461         :param spd_id: SPD ID for the policy
1462         :param local_address_start: local-ip-range start address
1463         :param local_address_stop : local-ip-range stop address
1464         :param remote_address_start: remote-ip-range start address
1465         :param remote_address_stop : remote-ip-range stop address
1466         :param local_port_start: (Default value = 0)
1467         :param local_port_stop: (Default value = 65535)
1468         :param remote_port_start: (Default value = 0)
1469         :param remote_port_stop: (Default value = 65535)
1470         :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
1471         :param sa_id: Security Association ID for mapping it to SPD
1472         :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
1473                (Default value = 0)
1474         :param priority: value for the spd action (Default value = 100)
1475         :param is_outbound: flag for inbound(0) or outbound(1)
1476                (Default value = 1)
1477         :param is_add: (Default value = 1)
1478         """
1479         return self.api(
1480             self.papi.ipsec_spd_entry_add_del,
1481             {
1482                 'is_add': is_add,
1483                 'entry':
1484                     {
1485                         'spd_id': spd_id,
1486                         'sa_id': sa_id,
1487                         'local_address_start': local_address_start,
1488                         'local_address_stop': local_address_stop,
1489                         'remote_address_start': remote_address_start,
1490                         'remote_address_stop': remote_address_stop,
1491                         'local_port_start': local_port_start,
1492                         'local_port_stop': local_port_stop,
1493                         'remote_port_start': remote_port_start,
1494                         'remote_port_stop': remote_port_stop,
1495                         'protocol': protocol,
1496                         'policy': policy,
1497                         'priority': priority,
1498                         'is_outbound': is_outbound,
1499                     }
1500             })
1501
1502     def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
1503         return self.api(self.papi.ipsec_spd_dump,
1504                         {'spd_id': spd_id,
1505                          'sa_id': sa_id})
1506
1507     def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
1508                                 remote_spi, crypto_alg, local_crypto_key,
1509                                 remote_crypto_key, integ_alg, local_integ_key,
1510                                 remote_integ_key, is_add=1, esn=0, salt=0,
1511                                 anti_replay=1, renumber=0,
1512                                 udp_encap=0, show_instance=0xffffffff):
1513         return self.api(
1514             self.papi.ipsec_tunnel_if_add_del,
1515             {
1516                 'local_ip': local_ip,
1517                 'remote_ip': remote_ip,
1518                 'local_spi': local_spi,
1519                 'remote_spi': remote_spi,
1520                 'crypto_alg': crypto_alg,
1521                 'local_crypto_key_len': len(local_crypto_key),
1522                 'local_crypto_key': local_crypto_key,
1523                 'remote_crypto_key_len': len(remote_crypto_key),
1524                 'remote_crypto_key': remote_crypto_key,
1525                 'integ_alg': integ_alg,
1526                 'local_integ_key_len': len(local_integ_key),
1527                 'local_integ_key': local_integ_key,
1528                 'remote_integ_key_len': len(remote_integ_key),
1529                 'remote_integ_key': remote_integ_key,
1530                 'is_add': is_add,
1531                 'esn': esn,
1532                 'anti_replay': anti_replay,
1533                 'renumber': renumber,
1534                 'show_instance': show_instance,
1535                 'udp_encap': udp_encap,
1536                 'salt': salt
1537             })
1538
1539     def ipsec_select_backend(self, protocol, index):
1540         return self.api(self.papi.ipsec_select_backend,
1541                         {'protocol': protocol, 'index': index})
1542
1543     def ipsec_backend_dump(self):
1544         return self.api(self.papi.ipsec_backend_dump, {})
1545
1546     def app_namespace_add_del(self,
1547                               namespace_id,
1548                               ip4_fib_id=0,
1549                               ip6_fib_id=0,
1550                               sw_if_index=0xFFFFFFFF,
1551                               secret=0):
1552         return self.api(
1553             self.papi.app_namespace_add_del,
1554             {'secret': secret,
1555              'sw_if_index': sw_if_index,
1556              'ip4_fib_id': ip4_fib_id,
1557              'ip6_fib_id': ip6_fib_id,
1558              'namespace_id': namespace_id})
1559
1560     def punt_socket_register(self, reg, pathname,
1561                              header_version=1):
1562         """ Register punt socket """
1563         return self.api(self.papi.punt_socket_register,
1564                         {'header_version': header_version,
1565                          'punt': reg,
1566                          'pathname': pathname})
1567
1568     def punt_socket_deregister(self, reg):
1569         """ Unregister punt socket """
1570         return self.api(self.papi.punt_socket_deregister,
1571                         {'punt': reg})
1572
1573     def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1574                          tun_src, tun_dst):
1575         """ GBP endpoint Add """
1576         return self.api(self.papi.gbp_endpoint_add,
1577                         {'endpoint': {
1578                             'sw_if_index': sw_if_index,
1579                             'ips': ips,
1580                             'n_ips': len(ips),
1581                             'mac': mac,
1582                             'sclass': sclass,
1583                             'flags': flags,
1584                             'tun': {
1585                                 'src': tun_src,
1586                                 'dst': tun_dst,
1587                             }}})
1588
1589     def gbp_endpoint_del(self, handle):
1590         """ GBP endpoint Del """
1591         return self.api(self.papi.gbp_endpoint_del,
1592                         {'handle': handle})
1593
1594     def gbp_endpoint_dump(self):
1595         """ GBP endpoint Dump """
1596         return self.api(self.papi.gbp_endpoint_dump, {})
1597
1598     def gbp_endpoint_group_add(self, vnid, sclass, bd,
1599                                rd, uplink_sw_if_index,
1600                                retention):
1601         """ GBP endpoint group Add """
1602         return self.api(self.papi.gbp_endpoint_group_add,
1603                         {'epg':
1604                             {
1605                                 'uplink_sw_if_index': uplink_sw_if_index,
1606                                 'bd_id': bd,
1607                                 'rd_id': rd,
1608                                 'vnid': vnid,
1609                                 'sclass': sclass,
1610                                 'retention': retention
1611                             }})
1612
1613     def gbp_endpoint_group_del(self, sclass):
1614         """ GBP endpoint group Del """
1615         return self.api(self.papi.gbp_endpoint_group_del,
1616                         {'sclass': sclass})
1617
1618     def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1619                               bvi_sw_if_index,
1620                               uu_fwd_sw_if_index,
1621                               bm_flood_sw_if_index):
1622         """ GBP bridge-domain Add """
1623         return self.api(self.papi.gbp_bridge_domain_add,
1624                         {'bd':
1625                             {
1626                                 'flags': flags,
1627                                 'bvi_sw_if_index': bvi_sw_if_index,
1628                                 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1629                                 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1630                                 'bd_id': bd_id,
1631                                 'rd_id': rd_id
1632                             }})
1633
1634     def gbp_bridge_domain_del(self, bd_id):
1635         """ GBP bridge-domain Del """
1636         return self.api(self.papi.gbp_bridge_domain_del,
1637                         {'bd_id': bd_id})
1638
1639     def gbp_route_domain_add(self, rd_id,
1640                              scope,
1641                              ip4_table_id,
1642                              ip6_table_id,
1643                              ip4_uu_sw_if_index,
1644                              ip6_uu_sw_if_index):
1645         """ GBP route-domain Add """
1646         return self.api(self.papi.gbp_route_domain_add,
1647                         {'rd':
1648                             {
1649                                 'scope': scope,
1650                                 'ip4_table_id': ip4_table_id,
1651                                 'ip6_table_id': ip6_table_id,
1652                                 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1653                                 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1654                                 'rd_id': rd_id
1655                             }})
1656
1657     def gbp_route_domain_del(self, rd_id):
1658         """ GBP route-domain Del """
1659         return self.api(self.papi.gbp_route_domain_del,
1660                         {'rd_id': rd_id})
1661
1662     def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1663         """ GBP recirc Add/Del """
1664         return self.api(self.papi.gbp_recirc_add_del,
1665                         {'is_add': is_add,
1666                          'recirc': {
1667                              'is_ext': is_ext,
1668                              'sw_if_index': sw_if_index,
1669                              'sclass': sclass}})
1670
1671     def gbp_recirc_dump(self):
1672         """ GBP recirc Dump """
1673         return self.api(self.papi.gbp_recirc_dump, {})
1674
1675     def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1676         """ GBP recirc Add/Del """
1677         return self.api(self.papi.gbp_ext_itf_add_del,
1678                         {'is_add': is_add,
1679                          'ext_itf': {
1680                              'sw_if_index': sw_if_index,
1681                              'bd_id': bd_id,
1682                              'rd_id': rd_id,
1683                              'flags': flags}})
1684
1685     def gbp_ext_itf_dump(self):
1686         """ GBP recirc Dump """
1687         return self.api(self.papi.gbp_ext_itf_dump, {})
1688
1689     def gbp_subnet_add_del(self, is_add, rd_id,
1690                            prefix, type,
1691                            sw_if_index=0xffffffff,
1692                            sclass=0xffff):
1693         """ GBP Subnet Add/Del """
1694         return self.api(self.papi.gbp_subnet_add_del,
1695                         {'is_add': is_add,
1696                          'subnet': {
1697                              'type': type,
1698                              'sw_if_index': sw_if_index,
1699                              'sclass': sclass,
1700                              'prefix': prefix,
1701                              'rd_id': rd_id}})
1702
1703     def gbp_subnet_dump(self):
1704         """ GBP Subnet Dump """
1705         return self.api(self.papi.gbp_subnet_dump, {})
1706
1707     def gbp_contract_dump(self):
1708         """ GBP contract Dump """
1709         return self.api(self.papi.gbp_contract_dump, {})
1710
1711     def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1712         """ GBP VXLAN tunnel add """
1713         return self.api(self.papi.gbp_vxlan_tunnel_add,
1714                         {
1715                             'tunnel': {
1716                                 'vni': vni,
1717                                 'mode': mode,
1718                                 'bd_rd_id': bd_rd_id,
1719                                 'src': src
1720                             }
1721                         })
1722
1723     def gbp_vxlan_tunnel_del(self, vni):
1724         """ GBP VXLAN tunnel del """
1725         return self.api(self.papi.gbp_vxlan_tunnel_del,
1726                         {
1727                             'vni': vni,
1728                         })
1729
1730     def gbp_vxlan_tunnel_dump(self):
1731         """ GBP VXLAN tunnel add/del """
1732         return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1733
1734     def igmp_enable_disable(self, sw_if_index, enable, host):
1735         """ Enable/disable IGMP on a given interface """
1736         return self.api(self.papi.igmp_enable_disable,
1737                         {'enable': enable,
1738                          'mode': host,
1739                          'sw_if_index': sw_if_index})
1740
1741     def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1742         """ Add/del IGMP proxy device """
1743         return self.api(self.papi.igmp_proxy_device_add_del,
1744                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1745                          'add': add})
1746
1747     def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1748         """ Add/del interface to/from IGMP proxy device """
1749         return self.api(self.papi.igmp_proxy_device_add_del_interface,
1750                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1751                          'add': add})
1752
1753     def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1754         """ Listen for new (S,G) on specified interface
1755
1756         :param enable: add/del
1757         :param sw_if_index: interface sw index
1758         :param saddr: source ip4 addr
1759         :param gaddr: group ip4 addr
1760         """
1761         return self.api(self.papi.igmp_listen,
1762                         {
1763                             'group':
1764                                 {
1765                                     'filter': filter,
1766                                     'sw_if_index': sw_if_index,
1767                                     'n_srcs': len(saddrs),
1768                                     'saddrs': saddrs,
1769                                     'gaddr': gaddr
1770                                 }
1771                         })
1772
1773     def igmp_clear_interface(self, sw_if_index):
1774         """ Remove all (S,G)s from specified interface
1775             doesn't send IGMP report!
1776         """
1777         return self.api(
1778             self.papi.igmp_clear_interface, {
1779                 'sw_if_index': sw_if_index})
1780
1781     def want_igmp_events(self, enable=1):
1782         return self.api(self.papi.want_igmp_events, {'enable': enable,
1783                                                      'pid': os.getpid()})
1784
1785     def bond_create(
1786             self,
1787             mode,
1788             lb,
1789             numa_only,
1790             use_custom_mac,
1791             mac_address='',
1792             interface_id=0xFFFFFFFF):
1793         """
1794         :param mode: mode
1795         :param lb: load balance
1796         :param numa_only: tx on local numa node for lacp mode
1797         :param use_custom_mac: use custom mac
1798         :param mac_address: mac address
1799         :param interface_id: custom interface ID
1800         """
1801         return self.api(
1802             self.papi.bond_create,
1803             {'mode': mode,
1804              'lb': lb,
1805              'numa_only': numa_only,
1806              'use_custom_mac': use_custom_mac,
1807              'mac_address': mac_address,
1808              'id': interface_id
1809              })
1810
1811     def pipe_delete(self, parent_sw_if_index):
1812         return self.api(self.papi.pipe_delete,
1813                         {'parent_sw_if_index': parent_sw_if_index})
1814
1815     def svs_table_add_del(self, af, table_id, is_add=1):
1816         return self.api(self.papi.svs_table_add_del,
1817                         {
1818                             'table_id': table_id,
1819                             'is_add': is_add,
1820                             'af': af,
1821                         })
1822
1823     def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
1824         return self.api(self.papi.svs_route_add_del,
1825                         {
1826                             'table_id': table_id,
1827                             'source_table_id': src_table_id,
1828                             'prefix': prefix,
1829                             'is_add': is_add,
1830                         })
1831
1832     def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
1833         return self.api(self.papi.svs_enable_disable,
1834                         {
1835                             'af': af,
1836                             'table_id': table_id,
1837                             'sw_if_index': sw_if_index,
1838                             'is_enable': is_enable,
1839                         })
1840
1841     def feature_gso_enable_disable(self, sw_if_index, enable_disable=1):
1842         return self.api(self.papi.feature_gso_enable_disable,
1843                         {
1844                             'sw_if_index': sw_if_index,
1845                             'enable_disable': enable_disable,
1846                         })