test/vpp_papi_provider.py

   1 import os
   2 import fnmatch
   3 import time
   4 from hook import Hook
   5 from collections import deque
   6
   7 # Sphinx creates auto-generated documentation by importing the python source
   8 # files and collecting the docstrings from them. The NO_VPP_PAPI flag allows
   9 # the vpp_papi_provider.py file to be importable without having to build
  10 # the whole vpp api if the user only wishes to generate the test documentation.
  11 do_import = True
  12 try:
  13     no_vpp_papi = os.getenv("NO_VPP_PAPI")
  14     if no_vpp_papi == "1":
  15         do_import = False
  16 except:
  17     pass
  18
  19 if do_import:
  20     from vpp_papi import VPP
  21
  22 # from vnet/vnet/mpls/mpls_types.h
  23 MPLS_IETF_MAX_LABEL = 0xfffff
  24 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
  25
  26
  27 class L2_VTR_OP:
  28     L2_POP_1 = 3
  29
  30
  31 class VppPapiProvider(object):
  32     """VPP-api provider using vpp-papi
  33
  34     @property hook: hook object providing before and after api/cli hooks
  35     """
  36
  37     _zero, _negative = range(2)
  38
  39     def __init__(self, name, shm_prefix, test_class):
  40         self.hook = Hook("vpp-papi-provider")
  41         self.name = name
  42         self.shm_prefix = shm_prefix
  43         self.test_class = test_class
  44         self._expect_api_retval = self._zero
  45         self._expect_stack = []
  46         jsonfiles = []
  47
  48         install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
  49         for root, dirnames, filenames in os.walk(install_dir):
  50             for filename in fnmatch.filter(filenames, '*.api.json'):
  51                 jsonfiles.append(os.path.join(root, filename))
  52
  53         self.papi = VPP(jsonfiles)
  54         self._events = deque()
  55
  56     def __enter__(self):
  57         return self
  58
  59     def expect_negative_api_retval(self):
  60         """ Expect API failure """
  61         self._expect_stack.append(self._expect_api_retval)
  62         self._expect_api_retval = self._negative
  63         return self
  64
  65     def expect_zero_api_retval(self):
  66         """ Expect API success """
  67         self._expect_stack.append(self._expect_api_retval)
  68         self._expect_api_retval = self._zero
  69         return self
  70
  71     def __exit__(self, exc_type, exc_value, traceback):
  72         self._expect_api_retval = self._expect_stack.pop()
  73
  74     def register_hook(self, hook):
  75         """Replace hook registration with new hook
  76
  77         :param hook:
  78
  79         """
  80         self.hook = hook
  81
  82     def collect_events(self):
  83         """ Collect all events from the internal queue and clear the queue. """
  84         e = self._events
  85         self._events = deque()
  86         return e
  87
  88     def wait_for_event(self, timeout, name=None):
  89         """ Wait for and return next event. """
  90         if self._events:
  91             self.test_class.logger.debug("Not waiting, event already queued")
  92         limit = time.time() + timeout
  93         while time.time() < limit:
  94             if self._events:
  95                 e = self._events.popleft()
  96                 if name and type(e).__name__ != name:
  97                     raise Exception(
  98                         "Unexpected event received: %s, expected: %s" %
  99                         (type(e).__name__, name))
 100                 self.test_class.logger.debug("Returning event %s:%s" %
 101                                              (name, e))
 102                 return e
 103             time.sleep(0)  # yield
 104         if name is not None:
 105             raise Exception("Event %s did not occur within timeout" % name)
 106         raise Exception("Event did not occur within timeout")
 107
 108     def __call__(self, name, event):
 109         """ Enqueue event in the internal event queue. """
 110         # FIXME use the name instead of relying on type(e).__name__ ?
 111         # FIXME #2 if this throws, it is eaten silently, Ole?
 112         self.test_class.logger.debug("New event: %s: %s" % (name, event))
 113         self._events.append(event)
 114
 115     def connect(self):
 116         """Connect the API to VPP"""
 117         self.papi.connect(self.name, self.shm_prefix)
 118         self.papi.register_event_callback(self)
 119
 120     def disconnect(self):
 121         """Disconnect the API from VPP"""
 122         self.papi.disconnect()
 123
 124     def api(self, api_fn, api_args, expected_retval=0):
 125         """ Call API function and check it's return value.
 126         Call the appropriate hooks before and after the API call
 127
 128         :param api_fn: API function to call
 129         :param api_args: tuple of API function arguments
 130         :param expected_retval: Expected return value (Default value = 0)
 131         :returns: reply from the API
 132
 133         """
 134         self.hook.before_api(api_fn.__name__, api_args)
 135         reply = api_fn(**api_args)
 136         if self._expect_api_retval == self._negative:
 137             if hasattr(reply, 'retval') and reply.retval >= 0:
 138                 msg = "API call passed unexpectedly: expected negative "\
 139                     "return value instead of %d in %s" % \
 140                     (reply.retval, repr(reply))
 141                 self.test_class.logger.info(msg)
 142                 raise Exception(msg)
 143         elif self._expect_api_retval == self._zero:
 144             if hasattr(reply, 'retval') and reply.retval != expected_retval:
 145                 msg = "API call failed, expected zero return value instead "\
 146                     "of %d in %s" % (expected_retval, repr(reply))
 147                 self.test_class.logger.info(msg)
 148                 raise Exception(msg)
 149         else:
 150             raise Exception("Internal error, unexpected value for "
 151                             "self._expect_api_retval %s" %
 152                             self._expect_api_retval)
 153         self.hook.after_api(api_fn.__name__, api_args)
 154         return reply
 155
 156     def cli(self, cli):
 157         """ Execute a CLI, calling the before/after hooks appropriately.
 158
 159         :param cli: CLI to execute
 160         :returns: CLI output
 161
 162         """
 163         self.hook.before_cli(cli)
 164         cli += '\n'
 165         r = self.papi.cli_inband(length=len(cli), cmd=cli)
 166         self.hook.after_cli(cli)
 167         if hasattr(r, 'reply'):
 168             return r.reply.decode().rstrip('\x00')
 169
 170     def ppcli(self, cli):
 171         """ Helper method to print CLI command in case of info logging level.
 172
 173         :param cli: CLI to execute
 174         :returns: CLI output
 175         """
 176         return cli + "\n" + str(self.cli(cli))
 177
 178     def _convert_mac(self, mac):
 179         return int(mac.replace(":", ""), 16) << 16
 180
 181     def show_version(self):
 182         """ """
 183         return self.papi.show_version()
 184
 185     def pg_create_interface(self, pg_index):
 186         """
 187
 188         :param pg_index:
 189
 190         """
 191         return self.api(self.papi.pg_create_interface,
 192                         {"interface_id": pg_index})
 193
 194     def sw_interface_dump(self, filter=None):
 195         """
 196
 197         :param filter:  (Default value = None)
 198
 199         """
 200         if filter is not None:
 201             args = {"name_filter_valid": 1, "name_filter": filter}
 202         else:
 203             args = {}
 204         return self.api(self.papi.sw_interface_dump, args)
 205
 206     def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
 207         """ Set the IPvX Table-id for the Interface
 208
 209         :param sw_if_index:
 210         :param is_ipv6:
 211         :param table_id:
 212
 213         """
 214         return self.api(self.papi.sw_interface_set_table,
 215                         {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
 216                          'vrf_id': table_id})
 217
 218     def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
 219                                      is_ipv6=0, is_add=1, del_all=0):
 220         """
 221
 222         :param addr: param is_ipv6:  (Default value = 0)
 223         :param sw_if_index:
 224         :param addr_len:
 225         :param is_ipv6:  (Default value = 0)
 226         :param is_add:  (Default value = 1)
 227         :param del_all:  (Default value = 0)
 228
 229         """
 230         return self.api(self.papi.sw_interface_add_del_address,
 231                         {'sw_if_index': sw_if_index,
 232                          'is_add': is_add,
 233                          'is_ipv6': is_ipv6,
 234                          'del_all': del_all,
 235                          'address_length': addr_len,
 236                          'address': addr})
 237
 238     def sw_interface_enable_disable_mpls(self, sw_if_index,
 239                                          is_enable=1):
 240         """
 241         Enable/Disable MPLS on the interface
 242         :param sw_if_index:
 243         :param is_enable:  (Default value = 1)
 244
 245         """
 246         return self.api(self.papi.sw_interface_set_mpls_enable,
 247                         {'sw_if_index': sw_if_index,
 248                          'enable': is_enable})
 249
 250     def sw_interface_ra_suppress(self, sw_if_index):
 251         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 252                         {'sw_if_index': sw_if_index})
 253
 254     def ip6_sw_interface_ra_config(self, sw_if_index,
 255                                    no,
 256                                    suppress,
 257                                    send_unicast):
 258         return self.api(self.papi.sw_interface_ip6nd_ra_config,
 259                         {'sw_if_index': sw_if_index,
 260                          'is_no': no,
 261                          'suppress': suppress,
 262                          'send_unicast': send_unicast})
 263
 264     def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
 265         """
 266         Enable/Disable An interface for IPv6
 267         """
 268         return self.api(self.papi.sw_interface_ip6_enable_disable,
 269                         {'sw_if_index': sw_if_index,
 270                          'enable': enable})
 271
 272     def vxlan_add_del_tunnel(
 273             self,
 274             src_addr,
 275             dst_addr,
 276             mcast_sw_if_index=0xFFFFFFFF,
 277             is_add=1,
 278             is_ipv6=0,
 279             encap_vrf_id=0,
 280             decap_next_index=0xFFFFFFFF,
 281             vni=0):
 282         """
 283
 284         :param dst_addr:
 285         :param src_addr:
 286         :param is_add:  (Default value = 1)
 287         :param is_ipv6:  (Default value = 0)
 288         :param encap_vrf_id:  (Default value = 0)
 289         :param decap_next_index:  (Default value = 0xFFFFFFFF)
 290         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 291         :param vni:  (Default value = 0)
 292
 293         """
 294         return self.api(self.papi.vxlan_add_del_tunnel,
 295                         {'is_add': is_add,
 296                          'is_ipv6': is_ipv6,
 297                          'src_address': src_addr,
 298                          'dst_address': dst_addr,
 299                          'mcast_sw_if_index': mcast_sw_if_index,
 300                          'encap_vrf_id': encap_vrf_id,
 301                          'decap_next_index': decap_next_index,
 302                          'vni': vni})
 303
 304     def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
 305                               learn=1, arp_term=0, is_add=1):
 306         """Create/delete bridge domain.
 307
 308         :param int bd_id: Bridge domain index.
 309         :param int flood: Enable/disable bcast/mcast flooding in the BD.
 310             (Default value = 1)
 311         :param int uu_flood: Enable/disable unknown unicast flood in the BD.
 312             (Default value = 1)
 313         :param int forward: Enable/disable forwarding on all interfaces in
 314             the BD. (Default value = 1)
 315         :param int learn: Enable/disable learning on all interfaces in the BD.
 316             (Default value = 1)
 317         :param int arp_term: Enable/disable arp termination in the BD.
 318             (Default value = 1)
 319         :param int is_add: Add or delete flag. (Default value = 1)
 320         """
 321         return self.api(self.papi.bridge_domain_add_del,
 322                         {'bd_id': bd_id,
 323                          'flood': flood,
 324                          'uu_flood': uu_flood,
 325                          'forward': forward,
 326                          'learn': learn,
 327                          'arp_term': arp_term,
 328                          'is_add': is_add})
 329
 330     def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
 331                       filter_mac=0, bvi_mac=0):
 332         """Create/delete L2 FIB entry.
 333
 334         :param str mac: MAC address to create FIB entry for.
 335         :param int bd_id: Bridge domain index.
 336         :param int sw_if_index: Software interface index of the interface.
 337         :param int is_add: Add or delete flag. (Default value = 1)
 338         :param int static_mac: Set to 1 to create static MAC entry.
 339             (Default value = 0)
 340         :param int filter_mac: Set to 1 to drop packet that's source or
 341             destination MAC address contains defined MAC address.
 342             (Default value = 0)
 343         :param int bvi_mac: Set to 1 to create entry that points to BVI
 344             interface. (Default value = 0)
 345         """
 346         return self.api(self.papi.l2fib_add_del,
 347                         {'mac': self._convert_mac(mac),
 348                          'bd_id': bd_id,
 349                          'sw_if_index': sw_if_index,
 350                          'is_add': is_add,
 351                          'static_mac': static_mac,
 352                          'filter_mac': filter_mac,
 353                          'bvi_mac': bvi_mac})
 354
 355     def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
 356                                    shg=0, bvi=0, enable=1):
 357         """Add/remove interface to/from bridge domain.
 358
 359         :param int sw_if_index: Software interface index of the interface.
 360         :param int bd_id: Bridge domain index.
 361         :param int shg: Split-horizon group index. (Default value = 0)
 362         :param int bvi: Set interface as a bridge group virtual interface.
 363             (Default value = 0)
 364         :param int enable: Add or remove interface. (Default value = 1)
 365         """
 366         return self.api(self.papi.sw_interface_set_l2_bridge,
 367                         {'rx_sw_if_index': sw_if_index,
 368                          'bd_id': bd_id,
 369                          'shg': shg,
 370                          'bvi': bvi,
 371                          'enable': enable})
 372
 373     def bridge_flags(self, bd_id, is_set, feature_bitmap):
 374         """Enable/disable required feature of the bridge domain with defined ID.
 375
 376         :param int bd_id: Bridge domain ID.
 377         :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
 378         :param int feature_bitmap: Bitmap value of the feature to be set:
 379             - learn (1 << 0),
 380             - forward (1 << 1),
 381             - flood (1 << 2),
 382             - uu-flood (1 << 3) or
 383             - arp-term (1 << 4).
 384         """
 385         return self.api(self.papi.bridge_flags,
 386                         {'bd_id': bd_id,
 387                          'is_set': is_set,
 388                          'feature_bitmap': feature_bitmap})
 389
 390     def bridge_domain_dump(self, bd_id=0):
 391         """
 392
 393         :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
 394             existing bridge domains returned)
 395         :return: Dictionary of bridge domain(s) data.
 396         """
 397         return self.api(self.papi.bridge_domain_dump,
 398                         {'bd_id': bd_id})
 399
 400     def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
 401                                      enable):
 402         """Create or delete unidirectional cross-connect from Tx interface to
 403         Rx interface.
 404
 405         :param int rx_sw_if_index: Software interface index of Rx interface.
 406         :param int tx_sw_if_index: Software interface index of Tx interface.
 407         :param int enable: Create cross-connect if equal to 1, delete
 408             cross-connect if equal to 0.
 409
 410         """
 411         return self.api(self.papi.sw_interface_set_l2_xconnect,
 412                         {'rx_sw_if_index': rx_sw_if_index,
 413                          'tx_sw_if_index': tx_sw_if_index,
 414                          'enable': enable})
 415
 416     def sw_interface_set_l2_tag_rewrite(
 417             self,
 418             sw_if_index,
 419             vtr_oper,
 420             push=0,
 421             tag1=0,
 422             tag2=0):
 423         """L2 interface vlan tag rewrite configure request
 424         :param client_index - opaque cookie to identify the sender
 425         :param context - sender context, to match reply w/ request
 426         :param sw_if_index - interface the operation is applied to
 427         :param vtr_op - Choose from l2_vtr_op_t enum values
 428         :param push_dot1q - first pushed flag dot1q id set, else dot1ad
 429         :param tag1 - Needed for any push or translate vtr op
 430         :param tag2 - Needed for any push 2 or translate x-2 vtr ops
 431
 432         """
 433         return self.api(self.papi.l2_interface_vlan_tag_rewrite,
 434                         {'sw_if_index': sw_if_index,
 435                          'vtr_op': vtr_oper,
 436                          'push_dot1q': push,
 437                          'tag1': tag1,
 438                          'tag2': tag2})
 439
 440     def sw_interface_set_flags(self, sw_if_index, admin_up_down,
 441                                link_up_down=0, deleted=0):
 442         """
 443
 444         :param admin_up_down:
 445         :param sw_if_index:
 446         :param link_up_down:  (Default value = 0)
 447         :param deleted:  (Default value = 0)
 448
 449         """
 450         return self.api(self.papi.sw_interface_set_flags,
 451                         {'sw_if_index': sw_if_index,
 452                          'admin_up_down': admin_up_down,
 453                          'link_up_down': link_up_down,
 454                          'deleted': deleted})
 455
 456     def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
 457                      no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
 458                      default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
 459         """Create subinterface
 460         from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
 461
 462         :param sub_id: param inner_vlan:
 463         :param sw_if_index:
 464         :param outer_vlan:
 465         :param inner_vlan:
 466         :param no_tags:  (Default value = 0)
 467         :param one_tag:  (Default value = 0)
 468         :param two_tags:  (Default value = 0)
 469         :param dot1ad:  (Default value = 0)
 470         :param exact_match:  (Default value = 0)
 471         :param default_sub:  (Default value = 0)
 472         :param outer_vlan_id_any:  (Default value = 0)
 473         :param inner_vlan_id_any:  (Default value = 0)
 474
 475         """
 476         return self.api(
 477             self.papi.create_subif,
 478             {'sw_if_index': sw_if_index,
 479              'sub_id': sub_id,
 480              'no_tags': no_tags,
 481              'one_tag': one_tag,
 482              'two_tags': two_tags,
 483              'dot1ad': dot1ad,
 484              'exact_match': exact_match,
 485              'default_sub': default_sub,
 486              'outer_vlan_id_any': outer_vlan_id_any,
 487              'inner_vlan_id_any': inner_vlan_id_any,
 488              'outer_vlan_id': outer_vlan,
 489              'inner_vlan_id': inner_vlan})
 490
 491     def delete_subif(self, sw_if_index):
 492         """Delete subinterface
 493
 494         :param sw_if_index:
 495         """
 496         return self.api(self.papi.delete_subif,
 497                         {'sw_if_index': sw_if_index})
 498
 499     def create_vlan_subif(self, sw_if_index, vlan):
 500         """
 501
 502         :param vlan:
 503         :param sw_if_index:
 504
 505         """
 506         return self.api(self.papi.create_vlan_subif,
 507                         {'sw_if_index': sw_if_index,
 508                          'vlan_id': vlan})
 509
 510     def create_loopback(self, mac=''):
 511         """
 512
 513         :param mac: (Optional)
 514         """
 515         return self.api(self.papi.create_loopback,
 516                         {'mac_address': mac})
 517
 518     def delete_loopback(self, sw_if_index):
 519         return self.api(self.papi.delete_loopback,
 520                         {'sw_if_index': sw_if_index, })
 521
 522     def ip_add_del_route(
 523             self,
 524             dst_address,
 525             dst_address_length,
 526             next_hop_address,
 527             next_hop_sw_if_index=0xFFFFFFFF,
 528             table_id=0,
 529             next_hop_table_id=0,
 530             next_hop_weight=1,
 531             next_hop_n_out_labels=0,
 532             next_hop_out_label_stack=[],
 533             next_hop_via_label=MPLS_LABEL_INVALID,
 534             create_vrf_if_needed=0,
 535             is_resolve_host=0,
 536             is_resolve_attached=0,
 537             classify_table_index=0xFFFFFFFF,
 538             is_add=1,
 539             is_drop=0,
 540             is_unreach=0,
 541             is_prohibit=0,
 542             is_ipv6=0,
 543             is_local=0,
 544             is_classify=0,
 545             is_multipath=0,
 546             not_last=0):
 547         """
 548
 549         :param dst_address_length:
 550         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 551         :param dst_address:
 552         :param next_hop_address:
 553         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 554         :param vrf_id:  (Default value = 0)
 555         :param lookup_in_vrf:  (Default value = 0)
 556         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 557         :param create_vrf_if_needed:  (Default value = 0)
 558         :param is_add:  (Default value = 1)
 559         :param is_drop:  (Default value = 0)
 560         :param is_ipv6:  (Default value = 0)
 561         :param is_local:  (Default value = 0)
 562         :param is_classify:  (Default value = 0)
 563         :param is_multipath:  (Default value = 0)
 564         :param is_resolve_host:  (Default value = 0)
 565         :param is_resolve_attached:  (Default value = 0)
 566         :param not_last:  (Default value = 0)
 567         :param next_hop_weight:  (Default value = 1)
 568
 569         """
 570
 571         return self.api(
 572             self.papi.ip_add_del_route,
 573             {'next_hop_sw_if_index': next_hop_sw_if_index,
 574              'table_id': table_id,
 575              'classify_table_index': classify_table_index,
 576              'next_hop_table_id': next_hop_table_id,
 577              'create_vrf_if_needed': create_vrf_if_needed,
 578              'is_add': is_add,
 579              'is_drop': is_drop,
 580              'is_unreach': is_unreach,
 581              'is_prohibit': is_prohibit,
 582              'is_ipv6': is_ipv6,
 583              'is_local': is_local,
 584              'is_classify': is_classify,
 585              'is_multipath': is_multipath,
 586              'is_resolve_host': is_resolve_host,
 587              'is_resolve_attached': is_resolve_attached,
 588              'not_last': not_last,
 589              'next_hop_weight': next_hop_weight,
 590              'dst_address_length': dst_address_length,
 591              'dst_address': dst_address,
 592              'next_hop_address': next_hop_address,
 593              'next_hop_n_out_labels': next_hop_n_out_labels,
 594              'next_hop_via_label': next_hop_via_label,
 595              'next_hop_out_label_stack': next_hop_out_label_stack})
 596
 597     def ip_fib_dump(self):
 598         return self.api(self.papi.ip_fib_dump, {})
 599
 600     def ip_neighbor_add_del(self,
 601                             sw_if_index,
 602                             mac_address,
 603                             dst_address,
 604                             vrf_id=0,
 605                             is_add=1,
 606                             is_ipv6=0,
 607                             is_static=0,
 608                             ):
 609         """ Add neighbor MAC to IPv4 or IPv6 address.
 610
 611         :param sw_if_index:
 612         :param mac_address:
 613         :param dst_address:
 614         :param vrf_id:  (Default value = 0)
 615         :param is_add:  (Default value = 1)
 616         :param is_ipv6:  (Default value = 0)
 617         :param is_static:  (Default value = 0)
 618         """
 619
 620         return self.api(
 621             self.papi.ip_neighbor_add_del,
 622             {'vrf_id': vrf_id,
 623              'sw_if_index': sw_if_index,
 624              'is_add': is_add,
 625              'is_ipv6': is_ipv6,
 626              'is_static': is_static,
 627              'mac_address': mac_address,
 628              'dst_address': dst_address
 629              }
 630         )
 631
 632     def reset_vrf(self,
 633                   vrf_id,
 634                   is_ipv6=0,
 635                   ):
 636         """ Reset VRF (remove all routes etc.) request.
 637
 638         :param int vrf_id: ID of the FIB table / VRF to reset.
 639         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 640         """
 641
 642         return self.api(
 643             self.papi.reset_vrf,
 644             {'vrf_id': vrf_id,
 645              'is_ipv6': is_ipv6,
 646              }
 647         )
 648
 649     def reset_fib(self,
 650                   vrf_id,
 651                   is_ipv6=0,
 652                   ):
 653         """ Reset VRF (remove all routes etc.) request.
 654
 655         :param int vrf_id: ID of the FIB table / VRF to reset.
 656         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 657         """
 658
 659         return self.api(
 660             self.papi.reset_fib,
 661             {'vrf_id': vrf_id,
 662              'is_ipv6': is_ipv6,
 663              }
 664         )
 665
 666     def ip_dump(self,
 667                 is_ipv6=0,
 668                 ):
 669         """ Return IP dump.
 670
 671         :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
 672         """
 673
 674         return self.api(
 675             self.papi.ip_dump,
 676             {'is_ipv6': is_ipv6,
 677              }
 678         )
 679
 680     def sw_interface_span_enable_disable(
 681             self, sw_if_index_from, sw_if_index_to, state=1):
 682         """
 683
 684         :param sw_if_index_from:
 685         :param sw_if_index_to:
 686         :param state:
 687         """
 688         return self.api(self.papi.sw_interface_span_enable_disable,
 689                         {'sw_if_index_from': sw_if_index_from,
 690                          'sw_if_index_to': sw_if_index_to,
 691                          'state': state})
 692
 693     def gre_tunnel_add_del(self,
 694                            src_address,
 695                            dst_address,
 696                            outer_fib_id=0,
 697                            is_teb=0,
 698                            is_add=1,
 699                            is_ip6=0):
 700         """ Add a GRE tunnel
 701
 702         :param src_address:
 703         :param dst_address:
 704         :param outer_fib_id:  (Default value = 0)
 705         :param is_add:  (Default value = 1)
 706         :param is_ipv6:  (Default value = 0)
 707         :param is_teb:  (Default value = 0)
 708         """
 709
 710         return self.api(
 711             self.papi.gre_add_del_tunnel,
 712             {'is_add': is_add,
 713              'is_ipv6': is_ip6,
 714              'teb': is_teb,
 715              'src_address': src_address,
 716              'dst_address': dst_address,
 717              'outer_fib_id': outer_fib_id}
 718         )
 719
 720     def mpls_route_add_del(
 721             self,
 722             label,
 723             eos,
 724             next_hop_proto_is_ip4,
 725             next_hop_address,
 726             next_hop_sw_if_index=0xFFFFFFFF,
 727             table_id=0,
 728             next_hop_table_id=0,
 729             next_hop_weight=1,
 730             next_hop_n_out_labels=0,
 731             next_hop_out_label_stack=[],
 732             next_hop_via_label=MPLS_LABEL_INVALID,
 733             create_vrf_if_needed=0,
 734             is_resolve_host=0,
 735             is_resolve_attached=0,
 736             is_add=1,
 737             is_drop=0,
 738             is_multipath=0,
 739             classify_table_index=0xFFFFFFFF,
 740             is_classify=0,
 741             not_last=0):
 742         """
 743
 744         :param dst_address_length:
 745         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 746         :param dst_address:
 747         :param next_hop_address:
 748         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 749         :param vrf_id:  (Default value = 0)
 750         :param lookup_in_vrf:  (Default value = 0)
 751         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 752         :param create_vrf_if_needed:  (Default value = 0)
 753         :param is_add:  (Default value = 1)
 754         :param is_drop:  (Default value = 0)
 755         :param is_ipv6:  (Default value = 0)
 756         :param is_local:  (Default value = 0)
 757         :param is_classify:  (Default value = 0)
 758         :param is_multipath:  (Default value = 0)
 759         :param is_resolve_host:  (Default value = 0)
 760         :param is_resolve_attached:  (Default value = 0)
 761         :param not_last:  (Default value = 0)
 762         :param next_hop_weight:  (Default value = 1)
 763
 764         """
 765
 766         return self.api(
 767             self.papi.mpls_route_add_del,
 768             {'mr_label': label,
 769              'mr_eos': eos,
 770              'mr_table_id': table_id,
 771              'mr_classify_table_index': classify_table_index,
 772              'mr_create_table_if_needed': create_vrf_if_needed,
 773              'mr_is_add': is_add,
 774              'mr_is_classify': is_classify,
 775              'mr_is_multipath': is_multipath,
 776              'mr_is_resolve_host': is_resolve_host,
 777              'mr_is_resolve_attached': is_resolve_attached,
 778              'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
 779              'mr_next_hop_weight': next_hop_weight,
 780              'mr_next_hop': next_hop_address,
 781              'mr_next_hop_n_out_labels': next_hop_n_out_labels,
 782              'mr_next_hop_sw_if_index': next_hop_sw_if_index,
 783              'mr_next_hop_table_id': next_hop_table_id,
 784              'mr_next_hop_via_label': next_hop_via_label,
 785              'mr_next_hop_out_label_stack': next_hop_out_label_stack})
 786
 787     def mpls_ip_bind_unbind(
 788             self,
 789             label,
 790             dst_address,
 791             dst_address_length,
 792             table_id=0,
 793             ip_table_id=0,
 794             is_ip4=1,
 795             create_vrf_if_needed=0,
 796             is_bind=1):
 797         """
 798         """
 799         return self.api(
 800             self.papi.mpls_ip_bind_unbind,
 801             {'mb_mpls_table_id': table_id,
 802              'mb_label': label,
 803              'mb_ip_table_id': ip_table_id,
 804              'mb_create_table_if_needed': create_vrf_if_needed,
 805              'mb_is_bind': is_bind,
 806              'mb_is_ip4': is_ip4,
 807              'mb_address_length': dst_address_length,
 808              'mb_address': dst_address})
 809
 810     def mpls_tunnel_add_del(
 811             self,
 812             tun_sw_if_index,
 813             next_hop_proto_is_ip4,
 814             next_hop_address,
 815             next_hop_sw_if_index=0xFFFFFFFF,
 816             next_hop_table_id=0,
 817             next_hop_weight=1,
 818             next_hop_n_out_labels=0,
 819             next_hop_out_label_stack=[],
 820             next_hop_via_label=MPLS_LABEL_INVALID,
 821             create_vrf_if_needed=0,
 822             is_add=1,
 823             l2_only=0):
 824         """
 825
 826         :param dst_address_length:
 827         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 828         :param dst_address:
 829         :param next_hop_address:
 830         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 831         :param vrf_id:  (Default value = 0)
 832         :param lookup_in_vrf:  (Default value = 0)
 833         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 834         :param create_vrf_if_needed:  (Default value = 0)
 835         :param is_add:  (Default value = 1)
 836         :param is_drop:  (Default value = 0)
 837         :param is_ipv6:  (Default value = 0)
 838         :param is_local:  (Default value = 0)
 839         :param is_classify:  (Default value = 0)
 840         :param is_multipath:  (Default value = 0)
 841         :param is_resolve_host:  (Default value = 0)
 842         :param is_resolve_attached:  (Default value = 0)
 843         :param not_last:  (Default value = 0)
 844         :param next_hop_weight:  (Default value = 1)
 845
 846         """
 847         return self.api(
 848             self.papi.mpls_tunnel_add_del,
 849             {'mt_sw_if_index': tun_sw_if_index,
 850              'mt_is_add': is_add,
 851              'mt_l2_only': l2_only,
 852              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
 853              'mt_next_hop_weight': next_hop_weight,
 854              'mt_next_hop': next_hop_address,
 855              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
 856              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
 857              'mt_next_hop_table_id': next_hop_table_id,
 858              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
 859
 860     def snat_interface_add_del_feature(
 861             self,
 862             sw_if_index,
 863             is_inside=1,
 864             is_add=1):
 865         """Enable/disable S-NAT feature on the interface
 866
 867         :param sw_if_index: Software index of the interface
 868         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
 869         :param is_add: 1 if add, 0 if delete (Default value = 1)
 870         """
 871         return self.api(
 872             self.papi.snat_interface_add_del_feature,
 873             {'is_add': is_add,
 874              'is_inside': is_inside,
 875              'sw_if_index': sw_if_index})
 876
 877     def snat_add_static_mapping(
 878             self,
 879             local_ip,
 880             external_ip=0,
 881             external_sw_if_index=0xFFFFFFFF,
 882             local_port=0,
 883             external_port=0,
 884             addr_only=1,
 885             vrf_id=0,
 886             protocol=0,
 887             is_add=1,
 888             is_ip4=1):
 889         """Add/delete S-NAT static mapping
 890
 891         :param local_ip: Local IP address
 892         :param external_ip: External IP address
 893         :param external_sw_if_index: External interface instead of IP address
 894         :param local_port: Local port number (Default value = 0)
 895         :param external_port: External port number (Default value = 0)
 896         :param addr_only: 1 if address only mapping, 0 if address and port
 897         :param vrf_id: VRF ID
 898         :param protocol: IP protocol (Default value = 0)
 899         :param is_add: 1 if add, 0 if delete (Default value = 1)
 900         :param is_ip4: 1 if address type is IPv4 (Default value = 1)
 901         """
 902         return self.api(
 903             self.papi.snat_add_static_mapping,
 904             {'is_add': is_add,
 905              'is_ip4': is_ip4,
 906              'addr_only': addr_only,
 907              'local_ip_address': local_ip,
 908              'external_ip_address': external_ip,
 909              'local_port': local_port,
 910              'external_port': external_port,
 911              'external_sw_if_index': external_sw_if_index,
 912              'vrf_id': vrf_id,
 913              'protocol': protocol})
 914
 915     def snat_add_address_range(
 916             self,
 917             first_ip_address,
 918             last_ip_address,
 919             is_add=1,
 920             is_ip4=1):
 921         """Add/del S-NAT address range
 922
 923         :param first_ip_address: First IP address
 924         :param last_ip_address: Last IP address
 925         :param is_add: 1 if add, 0 if delete (Default value = 1)
 926         :param is_ip4: 1 if address type is IPv4 (Default value = 1)
 927         """
 928         return self.api(
 929             self.papi.snat_add_address_range,
 930             {'is_ip4': is_ip4,
 931              'first_ip_address': first_ip_address,
 932              'last_ip_address': last_ip_address,
 933              'is_add': is_add})
 934
 935     def snat_address_dump(self):
 936         """Dump S-NAT addresses
 937         :return: Dictionary of S-NAT addresses
 938         """
 939         return self.api(self.papi.snat_address_dump, {})
 940
 941     def snat_interface_dump(self):
 942         """Dump interfaces with S-NAT feature
 943         :return: Dictionary of interfaces with S-NAT feature
 944         """
 945         return self.api(self.papi.snat_interface_dump, {})
 946
 947     def snat_static_mapping_dump(self):
 948         """Dump S-NAT static mappings
 949         :return: Dictionary of S-NAT static mappings
 950         """
 951         return self.api(self.papi.snat_static_mapping_dump, {})
 952
 953     def snat_show_config(self):
 954         """Show S-NAT config
 955         :return: S-NAT config parameters
 956         """
 957         return self.api(self.papi.snat_show_config, {})
 958
 959     def snat_add_interface_addr(
 960             self,
 961             sw_if_index,
 962             is_add=1):
 963         """Add/del S-NAT address from interface
 964
 965         :param sw_if_index: Software index of the interface
 966         :param is_add: 1 if add, 0 if delete (Default value = 1)
 967         """
 968         return self.api(self.papi.snat_add_del_interface_addr,
 969                         {'is_add': is_add, 'sw_if_index': sw_if_index})
 970
 971     def snat_interface_addr_dump(self):
 972         """Dump S-NAT addresses interfaces
 973         :return: Dictionary of S-NAT addresses interfaces
 974         """
 975         return self.api(self.papi.snat_interface_addr_dump, {})
 976
 977     def snat_ipfix(
 978             self,
 979             domain_id=1,
 980             src_port=4739,
 981             enable=1):
 982         """Enable/disable S-NAT IPFIX logging
 983
 984         :param domain_id: Observation domain ID (Default value = 1)
 985         :param src_port: Source port number (Default value = 4739)
 986         :param enable: 1 if enable, 0 if disable (Default value = 1)
 987         """
 988         return self.api(
 989             self.papi.snat_ipfix_enable_disable,
 990             {'domain_id': domain_id,
 991              'src_port': src_port,
 992              'enable': enable})
 993
 994     def control_ping(self):
 995         self.api(self.papi.control_ping)
 996
 997     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
 998                     detect_mult, local_addr, peer_addr, is_ipv6=0,
 999                     bfd_key_id=None, conf_key_id=None):
1000         if bfd_key_id is None:
1001             return self.api(self.papi.bfd_udp_add,
1002                             {
1003                                 'sw_if_index': sw_if_index,
1004                                 'desired_min_tx': desired_min_tx,
1005                                 'required_min_rx': required_min_rx,
1006                                 'local_addr': local_addr,
1007                                 'peer_addr': peer_addr,
1008                                 'is_ipv6': is_ipv6,
1009                                 'detect_mult': detect_mult,
1010                             })
1011         else:
1012             return self.api(self.papi.bfd_udp_add,
1013                             {
1014                                 'sw_if_index': sw_if_index,
1015                                 'desired_min_tx': desired_min_tx,
1016                                 'required_min_rx': required_min_rx,
1017                                 'local_addr': local_addr,
1018                                 'peer_addr': peer_addr,
1019                                 'is_ipv6': is_ipv6,
1020                                 'detect_mult': detect_mult,
1021                                 'is_authenticated': 1,
1022                                 'bfd_key_id': bfd_key_id,
1023                                 'conf_key_id': conf_key_id,
1024                             })
1025
1026     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1027                     detect_mult, local_addr, peer_addr, is_ipv6=0):
1028         return self.api(self.papi.bfd_udp_mod,
1029                         {
1030                             'sw_if_index': sw_if_index,
1031                             'desired_min_tx': desired_min_tx,
1032                             'required_min_rx': required_min_rx,
1033                             'local_addr': local_addr,
1034                             'peer_addr': peer_addr,
1035                             'is_ipv6': is_ipv6,
1036                             'detect_mult': detect_mult,
1037                         })
1038
1039     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1040                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1041                               is_delayed=False):
1042         return self.api(self.papi.bfd_udp_auth_activate,
1043                         {
1044                             'sw_if_index': sw_if_index,
1045                             'local_addr': local_addr,
1046                             'peer_addr': peer_addr,
1047                             'is_ipv6': is_ipv6,
1048                             'is_delayed': 1 if is_delayed else 0,
1049                             'bfd_key_id': bfd_key_id,
1050                             'conf_key_id': conf_key_id,
1051                         })
1052
1053     def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1054                                 is_ipv6=0, is_delayed=False):
1055         return self.api(self.papi.bfd_udp_auth_deactivate,
1056                         {
1057                             'sw_if_index': sw_if_index,
1058                             'local_addr': local_addr,
1059                             'peer_addr': peer_addr,
1060                             'is_ipv6': is_ipv6,
1061                             'is_delayed': 1 if is_delayed else 0,
1062                         })
1063
1064     def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1065         return self.api(self.papi.bfd_udp_del,
1066                         {
1067                             'sw_if_index': sw_if_index,
1068                             'local_addr': local_addr,
1069                             'peer_addr': peer_addr,
1070                             'is_ipv6': is_ipv6,
1071                         })
1072
1073     def bfd_udp_session_dump(self):
1074         return self.api(self.papi.bfd_udp_session_dump, {})
1075
1076     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1077                                   peer_addr, is_ipv6=0):
1078         return self.api(self.papi.bfd_udp_session_set_flags, {
1079             'admin_up_down': admin_up_down,
1080             'sw_if_index': sw_if_index,
1081             'local_addr': local_addr,
1082             'peer_addr': peer_addr,
1083             'is_ipv6': is_ipv6,
1084         })
1085
1086     def want_bfd_events(self, enable_disable=1):
1087         return self.api(self.papi.want_bfd_events, {
1088             'enable_disable': enable_disable,
1089             'pid': os.getpid(),
1090         })
1091
1092     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1093         return self.api(self.papi.bfd_auth_set_key, {
1094             'conf_key_id': conf_key_id,
1095             'auth_type': auth_type,
1096             'key': key,
1097             'key_len': len(key),
1098         })
1099
1100     def bfd_auth_del_key(self, conf_key_id):
1101         return self.api(self.papi.bfd_auth_del_key, {
1102             'conf_key_id': conf_key_id,
1103         })
1104
1105     def bfd_auth_keys_dump(self):
1106         return self.api(self.papi.bfd_auth_keys_dump, {})
1107
1108     def classify_add_del_table(
1109             self,
1110             is_add,
1111             mask,
1112             match_n_vectors=1,
1113             table_index=0xFFFFFFFF,
1114             nbuckets=2,
1115             memory_size=2097152,
1116             skip_n_vectors=0,
1117             next_table_index=0xFFFFFFFF,
1118             miss_next_index=0xFFFFFFFF,
1119             current_data_flag=0,
1120             current_data_offset=0):
1121         """
1122         :param is_add:
1123         :param mask:
1124         :param match_n_vectors: (Default value = 1)
1125         :param table_index: (Default value = 0xFFFFFFFF)
1126         :param nbuckets:  (Default value = 2)
1127         :param memory_size:  (Default value = 2097152)
1128         :param skip_n_vectors:  (Default value = 0)
1129         :param next_table_index:  (Default value = 0xFFFFFFFF)
1130         :param miss_next_index:  (Default value = 0xFFFFFFFF)
1131         :param current_data_flag:  (Default value = 0)
1132         :param current_data_offset:  (Default value = 0)
1133         """
1134
1135         return self.api(
1136             self.papi.classify_add_del_table,
1137             {'is_add': is_add,
1138              'table_index': table_index,
1139              'nbuckets': nbuckets,
1140              'memory_size': memory_size,
1141              'skip_n_vectors': skip_n_vectors,
1142              'match_n_vectors': match_n_vectors,
1143              'next_table_index': next_table_index,
1144              'miss_next_index': miss_next_index,
1145              'current_data_flag': current_data_flag,
1146              'current_data_offset': current_data_offset,
1147              'mask': mask})
1148
1149     def classify_add_del_session(
1150             self,
1151             is_add,
1152             table_index,
1153             match,
1154             opaque_index=0xFFFFFFFF,
1155             hit_next_index=0xFFFFFFFF,
1156             advance=0,
1157             action=0,
1158             metadata=0):
1159         """
1160         :param is_add:
1161         :param table_index:
1162         :param match:
1163         :param opaque_index:  (Default value = 0xFFFFFFFF)
1164         :param hit_next_index:  (Default value = 0xFFFFFFFF)
1165         :param advance:  (Default value = 0)
1166         :param action:  (Default value = 0)
1167         :param metadata:  (Default value = 0)
1168         """
1169
1170         return self.api(
1171             self.papi.classify_add_del_session,
1172             {'is_add': is_add,
1173              'table_index': table_index,
1174              'hit_next_index': hit_next_index,
1175              'opaque_index': opaque_index,
1176              'advance': advance,
1177              'action': action,
1178              'metadata': metadata,
1179              'match': match})
1180
1181     def input_acl_set_interface(
1182             self,
1183             is_add,
1184             sw_if_index,
1185             ip4_table_index=0xFFFFFFFF,
1186             ip6_table_index=0xFFFFFFFF,
1187             l2_table_index=0xFFFFFFFF):
1188         """
1189         :param is_add:
1190         :param sw_if_index:
1191         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
1192         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
1193         :param l2_table_index:  (Default value = 0xFFFFFFFF)
1194         """
1195
1196         return self.api(
1197             self.papi.input_acl_set_interface,
1198             {'sw_if_index': sw_if_index,
1199              'ip4_table_index': ip4_table_index,
1200              'ip6_table_index': ip6_table_index,
1201              'l2_table_index': l2_table_index,
1202              'is_add': is_add})
1203
1204     def set_ipfix_exporter(
1205             self,
1206             collector_address,
1207             src_address,
1208             path_mtu,
1209             template_interval,
1210             vrf_id=0,
1211             collector_port=4739,
1212             udp_checksum=0):
1213         return self.api(
1214             self.papi.set_ipfix_exporter,
1215             {
1216                 'collector_address': collector_address,
1217                 'collector_port': collector_port,
1218                 'src_address': src_address,
1219                 'vrf_id': vrf_id,
1220                 'path_mtu': path_mtu,
1221                 'template_interval': template_interval,
1222                 'udp_checksum': udp_checksum,
1223             })
1224
1225     def dhcp_proxy_config(self,
1226                           dhcp_server,
1227                           dhcp_src_address,
1228                           rx_table_id=0,
1229                           server_table_id=0,
1230                           is_add=1,
1231                           is_ipv6=0,
1232                           insert_circuit_id=0):
1233         return self.api(
1234             self.papi.dhcp_proxy_config_2,
1235             {
1236                 'rx_vrf_id': rx_table_id,
1237                 'server_vrf_id': server_table_id,
1238                 'is_ipv6': is_ipv6,
1239                 'is_add': is_add,
1240                 'insert_circuit_id': insert_circuit_id,
1241                 'dhcp_server': dhcp_server,
1242                 'dhcp_src_address': dhcp_src_address,
1243             })
1244
1245     def dhcp_proxy_set_vss(self,
1246                            table_id,
1247                            fib_id,
1248                            oui,
1249                            is_add=1,
1250                            is_ip6=0):
1251         return self.api(
1252             self.papi.dhcp_proxy_set_vss,
1253             {
1254                 'tbl_id': table_id,
1255                 'fib_id': fib_id,
1256                 'is_ipv6': is_ip6,
1257                 'is_add': is_add,
1258                 'oui': oui,
1259             })
1260
1261     def ip_mroute_add_del(self,
1262                           src_address,
1263                           grp_address,
1264                           grp_address_length,
1265                           e_flags,
1266                           next_hop_sw_if_index,
1267                           i_flags,
1268                           table_id=0,
1269                           create_vrf_if_needed=0,
1270                           is_add=1,
1271                           is_ipv6=0,
1272                           is_local=0):
1273         """
1274         """
1275         return self.api(
1276             self.papi.ip_mroute_add_del,
1277             {'next_hop_sw_if_index': next_hop_sw_if_index,
1278              'entry_flags': e_flags,
1279              'itf_flags': i_flags,
1280              'create_vrf_if_needed': create_vrf_if_needed,
1281              'is_add': is_add,
1282              'is_ipv6': is_ipv6,
1283              'is_local': is_local,
1284              'grp_address_length': grp_address_length,
1285              'grp_address': grp_address,
1286              'src_address': src_address})
1287
1288     def mfib_signal_dump(self):
1289         return self.api(self.papi.mfib_signal_dump, {})