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 import deprecation
  13 from six import moves, iteritems
  14 from vpp_papi import VPP, mac_pton
  15
  16 from hook import Hook
  17 from vpp_l2 import L2_PORT_TYPE
  18
  19 # from vnet/vnet/mpls/mpls_types.h
  20 MPLS_IETF_MAX_LABEL = 0xfffff
  21 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
  22
  23
  24 class L2_VTR_OP:
  25     L2_DISABLED = 0
  26     L2_PUSH_1 = 1
  27     L2_PUSH_2 = 2
  28     L2_POP_1 = 3
  29     L2_POP_2 = 4
  30     L2_TRANSLATE_1_1 = 5
  31     L2_TRANSLATE_1_2 = 6
  32     L2_TRANSLATE_2_1 = 7
  33     L2_TRANSLATE_2_2 = 8
  34
  35
  36 class QOS_SOURCE:
  37     EXT = 0
  38     VLAN = 1
  39     MPLS = 2
  40     IP = 3
  41
  42
  43 class SYSLOG_SEVERITY:
  44     EMERG = 0
  45     ALERT = 1
  46     CRIT = 2
  47     ERR = 3
  48     WARN = 4
  49     NOTICE = 5
  50     INFO = 6
  51     DBG = 7
  52
  53
  54 #
  55 # Dictionary keyed on message name to override default values for
  56 # named parameters
  57 #
  58 defaultmapping = {
  59     'map_add_domain': {'mtu': 1280},
  60     'syslog_set_sender': {'collector_port': 514,
  61                           'max_msg_size': 480},
  62     'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
  63     'acl_interface_list_dump': {'sw_if_index': 4294967295, },
  64     'app_namespace_add_del': {'sw_if_index': 4294967295, },
  65     'bd_ip_mac_add_del': {'is_add': 1, },
  66     'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
  67                                 'is_add': 1, },
  68     'bier_disp_table_add_del': {'is_add': 1, },
  69     'bier_imp_add': {'is_add': 1, },
  70     'bier_route_add_del': {'is_add': 1, },
  71     'bier_table_add_del': {'is_add': 1, },
  72     'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
  73                               'learn': 1, 'is_add': 1, },
  74     'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
  75                                'nbuckets': 2, 'memory_size': 2097152,
  76                                'next_table_index': 4294967295,
  77                                'miss_next_index': 4294967295, },
  78     'dhcp6_client_enable_disable': {'enable': 1, },
  79     'dhcp6_clients_enable_disable': {'enable': 1, },
  80     'dhcp6_pd_client_enable_disable': {'enable': 1, },
  81     'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
  82     'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
  83     'dhcp_proxy_config': {'is_add': 1, },
  84     'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
  85     'dslite_add_del_pool_addr_range': {'is_add': 1, },
  86     'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
  87     'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
  88                               'decap_next_index': 4294967295, },
  89     'gre_add_del_tunnel': {'instance': 4294967295, 'is_add': 1, },
  90     'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
  91                             'decap_next_index': 4294967295, },
  92     'input_acl_set_interface': {'ip4_table_index': 4294967295,
  93                                 'ip6_table_index': 4294967295,
  94                                 'l2_table_index': 4294967295, },
  95     'ip6_add_del_address_using_prefix': {'is_add': 1, },
  96     'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
  97     'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
  98                          'next_hop_weight': 1, 'next_hop_via_label': 1048576,
  99                          'next_hop_id': 4294967295,
 100                          'classify_table_index': 4294967295, 'is_add': 1, },
 101     'ip_mroute_add_del': {'is_add': 1, },
 102     'ip_neighbor_add_del': {'is_add': 1, },
 103     'ip_punt_police': {'is_add': 1, },
 104     'ip_punt_redirect': {'is_add': 1, },
 105     'ip_table_add_del': {'is_add': 1, },
 106     'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
 107     'ipip_add_tunnel': {'is_ipv6': 1, 'instance': 4294967295, },
 108     'ipsec_interface_add_del_spd': {'is_add': 1, },
 109     'ipsec_sad_entry_add_del': {'is_add': 1, },
 110     'ipsec_spd_add_del': {'is_add': 1, },
 111     'ipsec_spd_dump': {'sa_id': 4294967295, },
 112     'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
 113                                 'remote_port_stop': 65535, 'priority': 100,
 114                                 'is_outbound': 1,
 115                                 'is_add': 1, },
 116     'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
 117     'l2_emulation': {'enable': 1, },
 118     'l2fib_add_del': {'is_add': 1, },
 119     'lisp_add_del_adjacency': {'is_add': 1, },
 120     'lisp_add_del_local_eid': {'is_add': 1, },
 121     'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
 122     'lisp_add_del_locator_set': {'is_add': 1, },
 123     'lisp_add_del_remote_mapping': {'is_add': 1, },
 124     'macip_acl_add_replace': {'acl_index': 4294967295, },
 125     'macip_acl_dump': {'acl_index': 4294967295, },
 126     'macip_acl_interface_add_del': {'is_add': 1, },
 127     'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
 128     'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
 129                            'mr_next_hop_weight': 1,
 130                            'mr_next_hop_via_label': 1048576,
 131                            'mr_is_add': 1,
 132                            'mr_classify_table_index': 4294967295, },
 133     'mpls_table_add_del': {'is_add': 1, },
 134     'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
 135                             'next_hop_weight': 1,
 136                             'next_hop_via_label': 1048576,
 137                             'is_add': 1, },
 138     'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
 139     'nat44_add_del_address_range': {'is_add': 1, 'vrf_id': 4294967295, },
 140     'nat44_add_del_identity_mapping': {'ip': b'0', 'sw_if_index': 4294967295,
 141                                        'addr_only': 1, 'is_add': 1, },
 142     'nat44_add_del_interface_addr': {'is_add': 1, },
 143     'nat44_add_del_lb_static_mapping': {'is_add': 1, },
 144     'nat44_add_del_static_mapping': {'external_sw_if_index': 4294967295,
 145                                      'addr_only': 1, 'is_add': 1, },
 146     'nat44_del_session': {'is_in': 1, },
 147     'nat44_interface_add_del_feature': {'is_inside': 1, 'is_add': 1, },
 148     'nat44_interface_add_del_output_feature': {'is_inside': 1, 'is_add': 1, },
 149     'nat44_lb_static_mapping_add_del_local': {'is_add': 1, },
 150     'nat64_add_del_interface': {'is_inside': 1, 'is_add': 1, },
 151     'nat64_add_del_interface_addr': {'is_add': 1, },
 152     'nat64_add_del_pool_addr_range': {'vrf_id': 4294967295, 'is_add': 1, },
 153     'nat64_add_del_prefix': {'is_add': 1, },
 154     'nat64_add_del_static_bib': {'is_add': 1, },
 155     'nat64_bib_dump': {'protocol': 255, },
 156     'nat64_st_dump': {'protocol': 255, },
 157     'nat66_add_del_interface': {'is_inside': 1, 'is_add': 1, },
 158     'nat66_add_del_static_mapping': {'is_add': 1, },
 159     'nat_det_add_del_map': {'is_add': 1, },
 160     'nat_ha_resync': {'want_resync_event': 1, },
 161     'nat_ha_set_failover': {'refresh': 10, },
 162     'nat_ha_set_listener': {'path_mtu': 512, },
 163     'nat_ipfix_enable_disable': {'domain_id': 1, 'src_port': 4739,
 164                                  'enable': 1, },
 165     'nat_set_mss_clamping': {'mss_value': 1500, },
 166     'nat_set_reass': {'timeout': 2, 'max_reass': 1024, 'max_frag': 5, },
 167     'nat_set_timeouts': {'udp': 300, 'tcp_established': 7440,
 168                          'tcp_transitory': 240, 'icmp': 60, },
 169     'output_acl_set_interface': {'ip4_table_index': 4294967295,
 170                                  'ip6_table_index': 4294967295,
 171                                  'l2_table_index': 4294967295, },
 172     'pppoe_add_del_session': {'is_add': 1, },
 173     'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
 174     'proxy_arp_add_del': {'is_add': 1, },
 175     'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
 176     'punt_socket_register': {'protocol': 17, 'header_version': 1,
 177                              'is_ip4': 1, },
 178     'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, },
 179     'punt_socket_dump': {'is_ip6': 1, },
 180     'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
 181                          'proto': 1, },
 182     'set_ipfix_exporter': {'collector_port': 4739, },
 183     'sr_localsid_add_del': {'sw_if_index': 4294967295, },
 184     'sr_policy_add': {'weight': 1, 'is_encap': 1, },
 185     'svs_enable_disable': {'is_enable': 1, },
 186     'svs_route_add_del': {'is_add': 1, },
 187     'svs_table_add_del': {'is_add': 1, },
 188     'sw_interface_add_del_address': {'is_add': 1, },
 189     'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
 190                                      'pref_lifetime': 4294967295, },
 191     'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
 192     'sw_interface_set_l2_bridge': {'enable': 1, },
 193     'sw_interface_set_mpls_enable': {'enable': 1, },
 194     'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
 195     'sw_interface_set_unnumbered': {'is_add': 1, },
 196     'sw_interface_span_enable_disable': {'state': 1, },
 197     'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 198                              'decap_next_index': 4294967295,
 199                              'instance': 4294967295, },
 200     'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 201                                  'instance': 4294967295, },
 202     'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
 203     'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 204                                  'protocol': 3, },
 205     'want_bfd_events': {'enable_disable': 1, },
 206     'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
 207     'want_dhcp6_reply_events': {'enable_disable': 1, },
 208     'want_igmp_events': {'enable': 1, },
 209     'want_interface_events': {'enable_disable': 1, },
 210     'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
 211     'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
 212     'want_ip6_ra_events': {'enable_disable': 1, },
 213     'want_l2_macs_events': {'enable_disable': 1, },
 214 }
 215
 216
 217 class UnexpectedApiReturnValueError(Exception):
 218     """ exception raised when the API return value is unexpected """
 219     pass
 220
 221
 222 class VppPapiProvider(object):
 223     """VPP-api provider using vpp-papi
 224
 225     @property hook: hook object providing before and after api/cli hooks
 226     """
 227
 228     _zero, _negative = range(2)
 229
 230     def __init__(self, name, shm_prefix, test_class, read_timeout):
 231         self.hook = Hook(test_class)
 232         self.name = name
 233         self.shm_prefix = shm_prefix
 234         self.test_class = test_class
 235         self._expect_api_retval = self._zero
 236         self._expect_stack = []
 237
 238         install_dir = os.getenv('VPP_INSTALL_PATH')
 239
 240         # Vapi requires 'VPP_API_DIR', not set when run from Makefile.
 241         if 'VPP_API_DIR' not in os.environ:
 242             os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH')
 243
 244         self.vpp = VPP(logger=test_class.logger,
 245                        read_timeout=read_timeout)
 246         self._events = deque()
 247
 248     def __enter__(self):
 249         return self
 250
 251     def assert_negative_api_retval(self):
 252         """ Expect API failure - used with with, e.g.:
 253             with self.vapi.assert_negative_api_retval():
 254                 self.vapi.<api call expected to fail>
 255         """
 256         self._expect_stack.append(self._expect_api_retval)
 257         self._expect_api_retval = self._negative
 258         return self
 259
 260     def assert_zero_api_retval(self):
 261         """ Expect API success - used with with, e.g.:
 262             with self.vapi.assert_negative_api_retval():
 263                 self.vapi.<api call expected to succeed>
 264
 265             note: this is useful only inside another with block
 266                   as success is the default expected value
 267         """
 268         self._expect_stack.append(self._expect_api_retval)
 269         self._expect_api_retval = self._zero
 270         return self
 271
 272     def __exit__(self, exc_type, exc_value, traceback):
 273         self._expect_api_retval = self._expect_stack.pop()
 274
 275     def register_hook(self, hook):
 276         """Replace hook registration with new hook
 277
 278         :param hook:
 279
 280         """
 281         self.hook = hook
 282
 283     def collect_events(self):
 284         """ Collect all events from the internal queue and clear the queue. """
 285         e = self._events
 286         self._events = deque()
 287         return e
 288
 289     def wait_for_event(self, timeout, name=None):
 290         """ Wait for and return next event. """
 291         if name:
 292             self.test_class.logger.debug("Expecting event '%s' within %ss",
 293                                          name, timeout)
 294         else:
 295             self.test_class.logger.debug("Expecting event within %ss",
 296                                          timeout)
 297         if self._events:
 298             self.test_class.logger.debug("Not waiting, event already queued")
 299         limit = time.time() + timeout
 300         while time.time() < limit:
 301             if self._events:
 302                 e = self._events.popleft()
 303                 if name and type(e).__name__ != name:
 304                     raise Exception(
 305                         "Unexpected event received: %s, expected: %s" %
 306                         (type(e).__name__, name))
 307                 self.test_class.logger.debug("Returning event %s:%s" %
 308                                              (name, e))
 309                 return e
 310             self.test_class.sleep(0)  # yield
 311         raise Exception("Event did not occur within timeout")
 312
 313     def __call__(self, name, event):
 314         """ Enqueue event in the internal event queue. """
 315         # FIXME use the name instead of relying on type(e).__name__ ?
 316         # FIXME #2 if this throws, it is eaten silently, Ole?
 317         self.test_class.logger.debug("New event: %s: %s" % (name, event))
 318         self._events.append(event)
 319
 320     def factory(self, name, apifn):
 321         def f(*a, **ka):
 322             fields = apifn._func.msg.fields
 323
 324             # add positional and kw arguments
 325             d = ka
 326             for i, o in enumerate(fields[3:]):
 327                 try:
 328                     d[o] = a[i]
 329                 except:
 330                     break
 331
 332             # Default override
 333             if name in defaultmapping:
 334                 for k, v in iteritems(defaultmapping[name]):
 335                     if k in d:
 336                         continue
 337                     d[k] = v
 338             return self.api(apifn, d)
 339
 340         return f
 341
 342     def __getattribute__(self, name):
 343         try:
 344             method = super(VppPapiProvider, self).__getattribute__(name)
 345         except AttributeError:
 346             method = self.factory(name, getattr(self.papi, name))
 347             # lazily load the method so we don't need to call factory
 348             # again for this name.
 349             setattr(self, name, method)
 350         return method
 351
 352     def connect(self):
 353         """Connect the API to VPP"""
 354         self.vpp.connect(self.name, self.shm_prefix)
 355         self.papi = self.vpp.api
 356         self.vpp.register_event_callback(self)
 357
 358     def disconnect(self):
 359         """Disconnect the API from VPP"""
 360         self.vpp.disconnect()
 361
 362     def api(self, api_fn, api_args, expected_retval=0):
 363         """ Call API function and check it's return value.
 364         Call the appropriate hooks before and after the API call
 365
 366         :param api_fn: API function to call
 367         :param api_args: tuple of API function arguments
 368         :param expected_retval: Expected return value (Default value = 0)
 369         :returns: reply from the API
 370
 371         """
 372         self.hook.before_api(api_fn.__name__, api_args)
 373         reply = api_fn(**api_args)
 374         if self._expect_api_retval == self._negative:
 375             if hasattr(reply, 'retval') and reply.retval >= 0:
 376                 msg = "API call passed unexpectedly: expected negative " \
 377                       "return value instead of %d in %s" % \
 378                       (reply.retval, moves.reprlib.repr(reply))
 379                 self.test_class.logger.info(msg)
 380                 raise UnexpectedApiReturnValueError(msg)
 381         elif self._expect_api_retval == self._zero:
 382             if hasattr(reply, 'retval') and reply.retval != expected_retval:
 383                 msg = "API call failed, expected %d return value instead " \
 384                       "of %d in %s" % (expected_retval, reply.retval,
 385                                        moves.reprlib.repr(reply))
 386                 self.test_class.logger.info(msg)
 387                 raise UnexpectedApiReturnValueError(msg)
 388         else:
 389             raise Exception("Internal error, unexpected value for "
 390                             "self._expect_api_retval %s" %
 391                             self._expect_api_retval)
 392         self.hook.after_api(api_fn.__name__, api_args)
 393         return reply
 394
 395     @deprecation.deprecated(
 396         deprecated_in="19.04", removed_in="19.07",
 397         details="Use the Corresponding API function instead.")
 398     def cli(self, cli):
 399         """ Execute a CLI, calling the before/after hooks appropriately.
 400
 401         :param cli: CLI to execute
 402         :returns: CLI output
 403
 404         """
 405         self.hook.before_cli(cli)
 406         cli += '\n'
 407         r = self.papi.cli_inband(cmd=cli)
 408         self.hook.after_cli(cli)
 409         if hasattr(r, 'reply'):
 410             return r.reply
 411
 412     def ppcli(self, cli):
 413         """ Helper method to print CLI command in case of info logging level.
 414
 415         :param cli: CLI to execute
 416         :returns: CLI output
 417         """
 418         return cli + "\n" + str(self.cli(cli))
 419
 420     def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
 421         return self.api(self.papi.want_ip4_arp_events,
 422                         {'enable_disable': enable_disable,
 423                          'ip': ip,
 424                          'pid': os.getpid(), })
 425
 426     def want_ip6_nd_events(self, enable_disable=1, ip="::"):
 427         return self.api(self.papi.want_ip6_nd_events,
 428                         {'enable_disable': enable_disable,
 429                          'ip': ip,
 430                          'pid': os.getpid(), })
 431
 432     def want_ip6_ra_events(self, enable_disable=1):
 433         return self.api(self.papi.want_ip6_ra_events,
 434                         {'enable_disable': enable_disable,
 435                          'pid': os.getpid(), })
 436
 437     def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
 438                                        mrc=0, mrd=0):
 439         return self.api(self.papi.ip6nd_send_router_solicitation,
 440                         {'irt': irt,
 441                          'mrt': mrt,
 442                          'mrc': mrc,
 443                          'mrd': mrd,
 444                          'sw_if_index': sw_if_index})
 445
 446     def want_interface_events(self, enable_disable=1):
 447         return self.api(self.papi.want_interface_events,
 448                         {'enable_disable': enable_disable,
 449                          'pid': os.getpid(), })
 450
 451     def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
 452                             max_macs_in_event=0, learn_limit=0):
 453         return self.api(self.papi.want_l2_macs_events,
 454                         {'enable_disable': enable_disable,
 455                          'scan_delay': scan_delay,
 456                          'max_macs_in_event': max_macs_in_event,
 457                          'learn_limit': learn_limit,
 458                          'pid': os.getpid(), })
 459
 460     def want_dhcp6_reply_events(self, enable_disable=1):
 461         return self.api(self.papi.want_dhcp6_reply_events,
 462                         {'enable_disable': enable_disable,
 463                          'pid': os.getpid()})
 464
 465     def want_dhcp6_pd_reply_events(self, enable_disable=1):
 466         return self.api(self.papi.want_dhcp6_pd_reply_events,
 467                         {'enable_disable': enable_disable,
 468                          'pid': os.getpid()})
 469
 470     def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
 471                                      prefixes, server_index=0xFFFFFFFF,
 472                                      irt=0, mrt=0, mrc=1, mrd=0, stop=0,
 473                                      ):
 474         return self.api(self.papi.dhcp6_pd_send_client_message,
 475                         {'sw_if_index': sw_if_index,
 476                          'server_index': server_index,
 477                          'irt': irt,
 478                          'mrt': mrt,
 479                          'mrc': mrc,
 480                          'mrd': mrd,
 481                          'stop': stop,
 482                          'msg_type': msg_type,
 483                          'T1': T1,
 484                          'T2': T2,
 485                          'n_prefixes': len(prefixes),
 486                          'prefixes': prefixes})
 487
 488     def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
 489                                     enable=1):
 490         return self.api(self.papi.dhcp6_client_enable_disable,
 491                         {'sw_if_index': sw_if_index,
 492                          'enable': enable})
 493
 494     def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
 495                                        enable=1):
 496         return self.api(self.papi.dhcp6_pd_client_enable_disable,
 497                         {'sw_if_index': sw_if_index,
 498                          'prefix_group': prefix_group,
 499                          'enable': enable})
 500
 501     def ip6_add_del_address_using_prefix(self, sw_if_index, address,
 502                                          prefix_length, prefix_group,
 503                                          is_add=1):
 504         return self.api(self.papi.ip6_add_del_address_using_prefix,
 505                         {'sw_if_index': sw_if_index,
 506                          'prefix_group': prefix_group,
 507                          'address': address,
 508                          'prefix_length': prefix_length,
 509                          'is_add': is_add})
 510
 511     def sw_interface_set_mac_address(self, sw_if_index, mac):
 512         return self.api(self.papi.sw_interface_set_mac_address,
 513                         {'sw_if_index': sw_if_index,
 514                          'mac_address': mac})
 515
 516     def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
 517         """Create p2p ethernet subinterface
 518
 519         :param sw_if_index: main (parent) interface
 520         :param remote_mac: client (remote) mac address
 521
 522         """
 523         return self.api(
 524             self.papi.p2p_ethernet_add,
 525             {'parent_if_index': sw_if_index,
 526              'remote_mac': remote_mac,
 527              'subif_id': subif_id})
 528
 529     def p2p_ethernet_del(self, sw_if_index, remote_mac):
 530         """Delete p2p ethernet subinterface
 531
 532         :param sw_if_index: main (parent) interface
 533         :param remote_mac: client (remote) mac address
 534
 535         """
 536         return self.api(
 537             self.papi.p2p_ethernet_del,
 538             {'parent_if_index': sw_if_index,
 539              'remote_mac': remote_mac})
 540
 541     def create_vlan_subif(self, sw_if_index, vlan):
 542         """
 543
 544         :param vlan:
 545         :param sw_if_index:
 546
 547         """
 548         return self.api(self.papi.create_vlan_subif,
 549                         {'sw_if_index': sw_if_index,
 550                          'vlan_id': vlan})
 551
 552     def create_loopback(self, mac=''):
 553         """
 554
 555         :param mac: (Optional)
 556         """
 557         return self.api(self.papi.create_loopback,
 558                         {'mac_address': mac})
 559
 560     def ip_neighbor_add_del(self,
 561                             sw_if_index,
 562                             mac_address,
 563                             ip_address,
 564                             is_add=1,
 565                             flags=0):
 566         """ Add neighbor MAC to IPv4 or IPv6 address.
 567
 568         :param sw_if_index:
 569         :param mac_address:
 570         :param dst_address:
 571         :param is_add:  (Default value = 1)
 572         :param flags:  (Default value = 0/NONE)
 573         """
 574         return self.api(
 575             self.papi.ip_neighbor_add_del,
 576             {
 577                 'is_add': is_add,
 578                 'neighbor': {
 579                     'sw_if_index': sw_if_index,
 580                     'flags': flags,
 581                     'mac_address': mac_address,
 582                     'ip_address': ip_address
 583                 }
 584             }
 585         )
 586
 587     def proxy_arp_add_del(self,
 588                           low,
 589                           hi,
 590                           table_id=0,
 591                           is_add=1):
 592         """ Config Proxy Arp Range.
 593
 594         :param low_address: Start address in the rnage to Proxy for
 595         :param hi_address: End address in the rnage to Proxy for
 596         :param vrf_id: The VRF/table in which to proxy
 597         """
 598
 599         return self.api(
 600             self.papi.proxy_arp_add_del,
 601             {'proxy':
 602                 {
 603                     'table_id': table_id,
 604                     'low': low,
 605                     'hi': hi,
 606                 },
 607                 'is_add': is_add})
 608
 609     def proxy_arp_intfc_enable_disable(self,
 610                                        sw_if_index,
 611                                        is_enable=1):
 612         """ Enable/Disable an interface for proxy ARP requests
 613
 614         :param sw_if_index: Interface
 615         :param enable_disable: Enable/Disable
 616         """
 617
 618         return self.api(
 619             self.papi.proxy_arp_intfc_enable_disable,
 620             {'sw_if_index': sw_if_index,
 621              'enable_disable': is_enable
 622              }
 623         )
 624
 625     def gre_add_del_tunnel(self,
 626                            src_address,
 627                            dst_address,
 628                            outer_fib_id=0,
 629                            tunnel_type=0,
 630                            instance=0xFFFFFFFF,
 631                            session_id=0,
 632                            is_add=1,
 633                            is_ip6=0):
 634         """ Add a GRE tunnel
 635
 636         :param src_address:
 637         :param dst_address:
 638         :param outer_fib_id:  (Default value = 0)
 639         :param tunnel_type:  (Default value = 0)
 640         :param instance:  (Default value = 0xFFFFFFFF)
 641         :param session_id: (Defalt value = 0)
 642         :param is_add:  (Default value = 1)
 643         :param is_ipv6:  (Default value = 0)
 644         """
 645
 646         return self.api(
 647             self.papi.gre_add_del_tunnel,
 648             {'is_add': is_add,
 649              'is_ipv6': is_ip6,
 650              'tunnel_type': tunnel_type,
 651              'instance': instance,
 652              'src_address': src_address,
 653              'dst_address': dst_address,
 654              'outer_fib_id': outer_fib_id,
 655              'session_id': session_id}
 656         )
 657
 658     def udp_encap_add(self,
 659                       src_ip,
 660                       dst_ip,
 661                       src_port,
 662                       dst_port,
 663                       table_id=0):
 664         """ Add a GRE tunnel
 665         :param src_ip:
 666         :param dst_ip:
 667         :param src_port:
 668         :param dst_port:
 669         :param outer_fib_id:  (Default value = 0)
 670         """
 671
 672         return self.api(
 673             self.papi.udp_encap_add,
 674             {
 675                 'udp_encap': {
 676                     'src_ip': src_ip,
 677                     'dst_ip': dst_ip,
 678                     'src_port': src_port,
 679                     'dst_port': dst_port,
 680                     'table_id': table_id
 681                 }
 682             })
 683
 684     def mpls_table_add_del(
 685             self,
 686             table_id,
 687             is_add=1):
 688         """
 689
 690         :param table_id
 691         :param is_add:  (Default value = 1)
 692
 693         """
 694
 695         return self.api(
 696             self.papi.mpls_table_add_del,
 697             {'mt_table_id': table_id,
 698              'mt_is_add': is_add})
 699
 700     def mpls_ip_bind_unbind(
 701             self,
 702             label,
 703             dst_address,
 704             dst_address_length,
 705             table_id=0,
 706             ip_table_id=0,
 707             is_ip4=1,
 708             is_bind=1):
 709         """
 710         """
 711         return self.api(
 712             self.papi.mpls_ip_bind_unbind,
 713             {'mb_mpls_table_id': table_id,
 714              'mb_label': label,
 715              'mb_ip_table_id': ip_table_id,
 716              'mb_is_bind': is_bind,
 717              'mb_is_ip4': is_ip4,
 718              'mb_address_length': dst_address_length,
 719              'mb_address': dst_address})
 720
 721     def mpls_tunnel_add_del(
 722             self,
 723             tun_sw_if_index,
 724             next_hop_proto_is_ip4,
 725             next_hop_address,
 726             next_hop_sw_if_index=0xFFFFFFFF,
 727             next_hop_table_id=0,
 728             next_hop_weight=1,
 729             next_hop_n_out_labels=0,
 730             next_hop_out_label_stack=[],
 731             next_hop_via_label=MPLS_LABEL_INVALID,
 732             is_add=1,
 733             l2_only=0,
 734             is_multicast=0):
 735         """
 736
 737         :param dst_address_length:
 738         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 739         :param dst_address:
 740         :param next_hop_address:
 741         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 742         :param vrf_id:  (Default value = 0)
 743         :param lookup_in_vrf:  (Default value = 0)
 744         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 745         :param is_add:  (Default value = 1)
 746         :param is_drop:  (Default value = 0)
 747         :param is_ipv6:  (Default value = 0)
 748         :param is_local:  (Default value = 0)
 749         :param is_classify:  (Default value = 0)
 750         :param is_multipath:  (Default value = 0)
 751         :param is_resolve_host:  (Default value = 0)
 752         :param is_resolve_attached:  (Default value = 0)
 753         :param next_hop_weight:  (Default value = 1)
 754         :param is_multicast:  (Default value = 0)
 755
 756         """
 757         return self.api(
 758             self.papi.mpls_tunnel_add_del,
 759             {'mt_sw_if_index': tun_sw_if_index,
 760              'mt_is_add': is_add,
 761              'mt_l2_only': l2_only,
 762              'mt_is_multicast': is_multicast,
 763              'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
 764              'mt_next_hop_weight': next_hop_weight,
 765              'mt_next_hop': next_hop_address,
 766              'mt_next_hop_n_out_labels': next_hop_n_out_labels,
 767              'mt_next_hop_sw_if_index': next_hop_sw_if_index,
 768              'mt_next_hop_table_id': next_hop_table_id,
 769              'mt_next_hop_via_label': next_hop_via_label,
 770              'mt_next_hop_out_label_stack': next_hop_out_label_stack})
 771
 772     def nat44_interface_add_del_feature(
 773             self,
 774             sw_if_index,
 775             is_inside=1,
 776             is_add=1):
 777         """Enable/disable NAT44 feature on the interface
 778
 779         :param sw_if_index: Software index of the interface
 780         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
 781         :param is_add: 1 if add, 0 if delete (Default value = 1)
 782         """
 783         return self.api(
 784             self.papi.nat44_interface_add_del_feature,
 785             {'is_add': is_add,
 786              'is_inside': is_inside,
 787              'sw_if_index': sw_if_index})
 788
 789     def nat44_interface_add_del_output_feature(
 790             self,
 791             sw_if_index,
 792             is_inside=1,
 793             is_add=1):
 794         """Enable/disable NAT44 output feature on the interface
 795
 796         :param sw_if_index: Software index of the interface
 797         :param is_inside: 1 if inside, 0 if outside (Default value = 1)
 798         :param is_add: 1 if add, 0 if delete (Default value = 1)
 799         """
 800         return self.api(
 801             self.papi.nat44_interface_add_del_output_feature,
 802             {'is_add': is_add,
 803              'is_inside': is_inside,
 804              'sw_if_index': sw_if_index})
 805
 806     def nat44_add_del_static_mapping(
 807             self,
 808             local_ip,
 809             external_ip=0,
 810             external_sw_if_index=0xFFFFFFFF,
 811             local_port=0,
 812             external_port=0,
 813             addr_only=1,
 814             vrf_id=0,
 815             protocol=0,
 816             twice_nat=0,
 817             self_twice_nat=0,
 818             out2in_only=0,
 819             tag="",
 820             is_add=1):
 821         """Add/delete NAT44 static mapping
 822
 823         :param local_ip: Local IP address
 824         :param external_ip: External IP address
 825         :param external_sw_if_index: External interface instead of IP address
 826         :param local_port: Local port number (Default value = 0)
 827         :param external_port: External port number (Default value = 0)
 828         :param addr_only: 1 if address only mapping, 0 if address and port
 829         :param vrf_id: VRF ID
 830         :param protocol: IP protocol (Default value = 0)
 831         :param twice_nat: 1 if translate external host address and port
 832         :param self_twice_nat: 1 if translate external host address and port
 833                                whenever external host address equals
 834                                local address of internal host
 835         :param out2in_only: if 1 rule is matching only out2in direction
 836         :param tag: Opaque string tag
 837         :param is_add: 1 if add, 0 if delete (Default value = 1)
 838         """
 839         return self.api(
 840             self.papi.nat44_add_del_static_mapping,
 841             {'is_add': is_add,
 842              'addr_only': addr_only,
 843              'local_ip_address': local_ip,
 844              'external_ip_address': external_ip,
 845              'local_port': local_port,
 846              'external_port': external_port,
 847              'external_sw_if_index': external_sw_if_index,
 848              'vrf_id': vrf_id,
 849              'protocol': protocol,
 850              'twice_nat': twice_nat,
 851              'self_twice_nat': self_twice_nat,
 852              'out2in_only': out2in_only,
 853              'tag': tag})
 854
 855     def nat44_add_del_identity_mapping(
 856             self,
 857             ip=b'0',
 858             sw_if_index=0xFFFFFFFF,
 859             port=0,
 860             addr_only=1,
 861             vrf_id=0,
 862             protocol=0,
 863             tag='',
 864             is_add=1):
 865         """Add/delete NAT44 identity mapping
 866
 867         :param ip: IP address (Default value = 0)
 868         :param sw_if_index: Interface instead of IP address
 869         :param port: Port number (Default value = 0)
 870         :param addr_only: 1 if address only mapping, 0 if address and port
 871         :param vrf_id: VRF ID
 872         :param protocol: IP protocol (Default value = 0)
 873         :param tag: Opaque string tag
 874         :param is_add: 1 if add, 0 if delete (Default value = 1)
 875         """
 876         return self.api(
 877             self.papi.nat44_add_del_identity_mapping,
 878             {'is_add': is_add,
 879              'addr_only': addr_only,
 880              'ip_address': ip,
 881              'port': port,
 882              'sw_if_index': sw_if_index,
 883              'vrf_id': vrf_id,
 884              'tag': tag,
 885              'protocol': protocol})
 886
 887     def nat44_add_del_address_range(
 888             self,
 889             first_ip_address,
 890             last_ip_address,
 891             is_add=1,
 892             vrf_id=0xFFFFFFFF,
 893             twice_nat=0):
 894         """Add/del NAT44 address range
 895
 896         :param first_ip_address: First IP address
 897         :param last_ip_address: Last IP address
 898         :param vrf_id: VRF id for the address range
 899         :param twice_nat: twice NAT address for extenal hosts
 900         :param is_add: 1 if add, 0 if delete (Default value = 1)
 901         """
 902         return self.api(
 903             self.papi.nat44_add_del_address_range,
 904             {'first_ip_address': first_ip_address,
 905              'last_ip_address': last_ip_address,
 906              'vrf_id': vrf_id,
 907              'twice_nat': twice_nat,
 908              'is_add': is_add})
 909
 910     def nat44_add_del_interface_addr(
 911             self,
 912             sw_if_index,
 913             twice_nat=0,
 914             is_add=1):
 915         """Add/del NAT44 address from interface
 916
 917         :param sw_if_index: Software index of the interface
 918         :param twice_nat: twice NAT address for extenal hosts
 919         :param is_add: 1 if add, 0 if delete (Default value = 1)
 920         """
 921         return self.api(
 922             self.papi.nat44_add_del_interface_addr,
 923             {'is_add': is_add,
 924              'sw_if_index': sw_if_index,
 925              'twice_nat': twice_nat})
 926
 927     def nat44_add_del_lb_static_mapping(
 928             self,
 929             external_addr,
 930             external_port,
 931             protocol,
 932             twice_nat=0,
 933             self_twice_nat=0,
 934             out2in_only=0,
 935             tag='',
 936             affinity=0,
 937             local_num=0,
 938             locals=[],
 939             is_add=1):
 940         """Add/delete NAT44 load balancing static mapping
 941
 942         :param twice_nat: 1 if translate external host address and port
 943         :param tag: Opaque string tag
 944         :param affinity: if 0 disabled, otherwise client IP affinity timeout
 945         :param is_add - 1 if add, 0 if delete
 946         """
 947         return self.api(
 948             self.papi.nat44_add_del_lb_static_mapping,
 949             {'is_add': is_add,
 950              'external_addr': external_addr,
 951              'external_port': external_port,
 952              'protocol': protocol,
 953              'twice_nat': twice_nat,
 954              'self_twice_nat': self_twice_nat,
 955              'out2in_only': out2in_only,
 956              'tag': tag,
 957              'affinity': affinity,
 958              'local_num': local_num,
 959              'locals': locals})
 960
 961     def nat44_lb_static_mapping_add_del_local(
 962             self,
 963             external_addr,
 964             external_port,
 965             local_addr,
 966             local_port,
 967             protocol,
 968             probability,
 969             vrf_id=0,
 970             is_add=1):
 971         """Add/delete NAT44 load-balancing static mapping rule backend
 972
 973         :param external_addr: external IPv4 address of the servic
 974         :param external_port: external L4 port number of the service
 975         :param local_addr: IPv4 address of the internal node
 976         :param local_port: L4 port number of the internal node
 977         :param protocol: IP protocol number
 978         :param probability: probability of the internal node
 979         :param vrf_id: VRF id of the internal node
 980         :param is_add: 1 if add, 0 if delete
 981         """
 982         return self.api(
 983             self.papi.nat44_lb_static_mapping_add_del_local,
 984             {'is_add': is_add,
 985              'external_addr': external_addr,
 986              'external_port': external_port,
 987              'local': {
 988                  'addr': local_addr,
 989                  'port': local_port,
 990                  'probability': probability,
 991                  'vrf_id': vrf_id},
 992              'protocol': protocol})
 993
 994     def nat44_del_session(
 995             self,
 996             addr,
 997             port,
 998             protocol,
 999             vrf_id=0,
1000             is_in=1,
1001             ext_host_address=None,
1002             ext_host_port=0):
1003         """Delete NAT44 session
1004
1005         :param addr: IPv4 address
1006         :param por: port number
1007         :param protocol: IP protocol number
1008         :param vrf_id: VRF ID
1009         :param is_in: 1 if inside network addres and port pari, 0 if outside
1010         :param ext_host_address: external host IPv4 address
1011         :param ext_host_port: external host port
1012         """
1013         if ext_host_address is None:
1014             return self.api(
1015                 self.papi.nat44_del_session,
1016                 {'address': addr,
1017                  'port': port,
1018                  'protocol': protocol,
1019                  'vrf_id': vrf_id,
1020                  'is_in': is_in})
1021         else:
1022             return self.api(
1023                 self.papi.nat44_del_session,
1024                 {'address': addr,
1025                  'port': port,
1026                  'protocol': protocol,
1027                  'vrf_id': vrf_id,
1028                  'is_in': is_in,
1029                  'ext_host_valid': 1,
1030                  'ext_host_address': ext_host_address,
1031                  'ext_host_port': ext_host_port})
1032
1033     def nat44_forwarding_enable_disable(
1034             self,
1035             enable):
1036         """Enable/disable forwarding for NAT44
1037
1038         :param enable: 1 for enable, 0 for disable
1039         """
1040         return self.api(
1041             self.papi.nat44_forwarding_enable_disable,
1042             {'enable': enable})
1043
1044     def nat_det_add_del_map(
1045             self,
1046             in_addr,
1047             in_plen,
1048             out_addr,
1049             out_plen,
1050             is_add=1):
1051         """Add/delete deterministic NAT mapping
1052
1053         :param is_add - 1 if add, 0 if delete
1054         :param in_addr - inside IP address
1055         :param in_plen - inside IP address prefix length
1056         :param out_addr - outside IP address
1057         :param out_plen - outside IP address prefix length
1058         """
1059         return self.api(
1060             self.papi.nat_det_add_del_map,
1061             {'is_add': is_add,
1062              'is_nat44': 1,
1063              'in_addr': in_addr,
1064              'in_plen': in_plen,
1065              'out_addr': out_addr,
1066              'out_plen': out_plen})
1067
1068     def nat_det_forward(
1069             self,
1070             in_addr):
1071         """Get outside address and port range from inside address
1072
1073         :param in_addr - inside IP address
1074         """
1075         return self.api(
1076             self.papi.nat_det_forward,
1077             {'in_addr': in_addr,
1078              'is_nat44': 1})
1079
1080     def nat_det_reverse(
1081             self,
1082             out_addr,
1083             out_port):
1084         """Get inside address from outside address and port
1085
1086         :param out_addr - outside IP address
1087         :param out_port - outside port
1088         """
1089         return self.api(
1090             self.papi.nat_det_reverse,
1091             {'out_addr': out_addr,
1092              'out_port': out_port})
1093
1094     def nat_det_map_dump(self):
1095         """Dump deterministic NAT mappings
1096
1097         :return: Dictionary of deterministic NAT mappings
1098         """
1099         return self.api(self.papi.nat_det_map_dump, {})
1100
1101     def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1102         """Set TCP MSS rewriting configuration
1103
1104         :param enable: disable(0)/enable(1) MSS rewriting feature
1105         :param mss_value: MSS value to be used for MSS rewriting
1106         """
1107         return self.api(
1108             self.papi.nat_set_mss_clamping,
1109             {'enable': enable, 'mss_value': mss_value})
1110
1111     def nat_det_close_session_in(
1112             self,
1113             in_addr,
1114             in_port,
1115             ext_addr,
1116             ext_port):
1117         """Close deterministic NAT session using inside address and port
1118
1119         :param in_addr - inside IP address
1120         :param in_port - inside port
1121         :param ext_addr - external host IP address
1122         :param ext_port - external host port
1123         """
1124         return self.api(
1125             self.papi.nat_det_close_session_in,
1126             {'in_addr': in_addr,
1127              'in_port': in_port,
1128              'ext_addr': ext_addr,
1129              'ext_port': ext_port,
1130              'is_nat44': 1})
1131
1132     def nat_det_session_dump(
1133             self,
1134             user_addr):
1135         """Dump deterministic NAT sessions belonging to a user
1136
1137         :param user_addr - inside IP address of the user
1138         :return: Dictionary of deterministic NAT sessions
1139         """
1140         return self.api(
1141             self.papi.nat_det_session_dump,
1142             {'is_nat44': 1,
1143              'user_addr': user_addr})
1144
1145     def nat64_add_del_interface(
1146             self,
1147             sw_if_index,
1148             is_inside=1,
1149             is_add=1):
1150         """Enable/disable NAT64 feature on the interface
1151            :param sw_if_index: Index of the interface
1152            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1153            :param is_add: 1 if add, 0 if delete (Default value = 1)
1154         """
1155         return self.api(
1156             self.papi.nat64_add_del_interface,
1157             {'sw_if_index': sw_if_index,
1158              'is_inside': is_inside,
1159              'is_add': is_add})
1160
1161     def nat64_add_del_static_bib(
1162             self,
1163             in_ip,
1164             out_ip,
1165             in_port,
1166             out_port,
1167             protocol,
1168             vrf_id=0,
1169             is_add=1):
1170         """Add/delete S-NAT static BIB entry
1171
1172         :param in_ip: Inside IPv6 address
1173         :param out_ip: Outside IPv4 address
1174         :param in_port: Inside port number
1175         :param out_port: Outside port number
1176         :param protocol: IP protocol
1177         :param vrf_id: VRF ID (Default value = 0)
1178         :param is_add: 1 if add, 0 if delete (Default value = 1)
1179         """
1180         return self.api(
1181             self.papi.nat64_add_del_static_bib,
1182             {'i_addr': in_ip,
1183              'o_addr': out_ip,
1184              'i_port': in_port,
1185              'o_port': out_port,
1186              'vrf_id': vrf_id,
1187              'proto': protocol,
1188              'is_add': is_add})
1189
1190     def nat64_bib_dump(self, protocol=255):
1191         """Dump NAT64 BIB
1192
1193         :param protocol: IP protocol (Default value = 255, all BIBs)
1194         :returns: Dictionary of NAT64 BIB entries
1195         """
1196         return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1197
1198     def nat64_st_dump(self, protocol=255):
1199         """Dump NAT64 session table
1200
1201         :param protocol: IP protocol (Default value = 255, all STs)
1202         :returns: Dictionary of NAT64 sesstion table entries
1203         """
1204         return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1205
1206     def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1207         """Add/del NAT64 prefix
1208
1209         :param prefix: NAT64 prefix
1210         :param plen: NAT64 prefix length
1211         :param vrf_id: VRF id of tenant (Default 0)
1212         :param is_add: 1 if add, 0 if delete (Default value = 1)
1213         """
1214         return self.api(
1215             self.papi.nat64_add_del_prefix,
1216             {'prefix': prefix,
1217              'prefix_len': plen,
1218              'vrf_id': vrf_id,
1219              'is_add': is_add})
1220
1221     def nat64_add_del_interface_addr(
1222             self,
1223             sw_if_index,
1224             is_add=1):
1225         """Add/del NAT64 address from interface
1226
1227         :param sw_if_index: Software index of the interface
1228         :param is_add: 1 if add, 0 if delete (Default value = 1)
1229         """
1230         return self.api(self.papi.nat64_add_del_interface_addr,
1231                         {'is_add': is_add, 'sw_if_index': sw_if_index})
1232
1233     def dslite_set_aftr_addr(self, ip6, ip4):
1234         """Set DS-Lite AFTR addresses
1235
1236         :param ip4: IPv4 address
1237         :param ip6: IPv6 address
1238         """
1239         return self.api(
1240             self.papi.dslite_set_aftr_addr,
1241             {'ip4_addr': ip4,
1242              'ip6_addr': ip6})
1243
1244     def dslite_set_b4_addr(self, ip6, ip4):
1245         """Set DS-Lite B4 IPv6 address
1246
1247         :param ip4: IPv4 address
1248         :param ip6: IPv6 address
1249         """
1250         return self.api(
1251             self.papi.dslite_set_b4_addr,
1252             {'ip4_addr': ip4,
1253              'ip6_addr': ip6})
1254
1255     def nat66_add_del_interface(
1256             self,
1257             sw_if_index,
1258             is_inside=1,
1259             is_add=1):
1260         """Enable/disable NAT66 feature on the interface
1261            :param sw_if_index: Index of the interface
1262            :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1263            :param is_add: 1 if add, 0 if delete (Default value = 1)
1264         """
1265         return self.api(
1266             self.papi.nat66_add_del_interface,
1267             {'sw_if_index': sw_if_index,
1268              'is_inside': is_inside,
1269              'is_add': is_add})
1270
1271     def nat66_add_del_static_mapping(
1272             self,
1273             in_ip,
1274             out_ip,
1275             vrf_id=0,
1276             is_add=1):
1277         """Add/delete NAT66 static mapping
1278
1279         :param in_ip: Inside IPv6 address
1280         :param out_ip: Outside IPv6 address
1281         :param vrf_id: VRF ID (Default value = 0)
1282         :param is_add: 1 if add, 0 if delete (Default value = 1)
1283         """
1284         return self.api(
1285             self.papi.nat66_add_del_static_mapping,
1286             {'local_ip_address': in_ip,
1287              'external_ip_address': out_ip,
1288              'vrf_id': vrf_id,
1289              'is_add': is_add})
1290
1291     def nat_ha_set_listener(self, addr, port, path_mtu=512):
1292         """Set HA listener (local settings)
1293
1294         :param addr: local IP4 address
1295         :param port: local UDP port number
1296         :param path_mtu: path MTU (Default value = 512)
1297         """
1298         return self.api(self.papi.nat_ha_set_listener,
1299                         {'ip_address': addr,
1300                          'port': port,
1301                          'path_mtu': path_mtu})
1302
1303     def nat_ha_get_listener(self):
1304         """Get HA listener/local configuration"""
1305         return self.api(self.papi.nat_ha_get_listener, {})
1306
1307     def nat_ha_set_failover(self, addr, port, refresh=10):
1308         """Set HA failover (remote settings)
1309
1310         :param addr: failover IP4 address
1311         :param port: failvoer UDP port number
1312         :param refresh: number of seconds after which to send session refresh
1313         """
1314         return self.api(self.papi.nat_ha_set_failover,
1315                         {'ip_address': addr,
1316                          'port': port,
1317                          'session_refresh_interval': refresh})
1318
1319     def nat_ha_resync(self, want_resync_event=1):
1320         """Resync HA (resend existing sessions to new failover)
1321         :param want_resync_event: if non-zero resync completed event sent
1322         """
1323         return self.api(self.papi.nat_ha_resync,
1324                         {'want_resync_event': want_resync_event,
1325                          'pid': os.getpid()})
1326
1327     def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1328                     detect_mult, local_addr, peer_addr, is_ipv6=0,
1329                     bfd_key_id=None, conf_key_id=None):
1330         if bfd_key_id is None:
1331             return self.api(self.papi.bfd_udp_add,
1332                             {
1333                                 'sw_if_index': sw_if_index,
1334                                 'desired_min_tx': desired_min_tx,
1335                                 'required_min_rx': required_min_rx,
1336                                 'local_addr': local_addr,
1337                                 'peer_addr': peer_addr,
1338                                 'is_ipv6': is_ipv6,
1339                                 'detect_mult': detect_mult,
1340                             })
1341         else:
1342             return self.api(self.papi.bfd_udp_add,
1343                             {
1344                                 'sw_if_index': sw_if_index,
1345                                 'desired_min_tx': desired_min_tx,
1346                                 'required_min_rx': required_min_rx,
1347                                 'local_addr': local_addr,
1348                                 'peer_addr': peer_addr,
1349                                 'is_ipv6': is_ipv6,
1350                                 'detect_mult': detect_mult,
1351                                 'is_authenticated': 1,
1352                                 'bfd_key_id': bfd_key_id,
1353                                 'conf_key_id': conf_key_id,
1354                             })
1355
1356     def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1357                     detect_mult, local_addr, peer_addr, is_ipv6=0):
1358         return self.api(self.papi.bfd_udp_mod,
1359                         {
1360                             'sw_if_index': sw_if_index,
1361                             'desired_min_tx': desired_min_tx,
1362                             'required_min_rx': required_min_rx,
1363                             'local_addr': local_addr,
1364                             'peer_addr': peer_addr,
1365                             'is_ipv6': is_ipv6,
1366                             'detect_mult': detect_mult,
1367                         })
1368
1369     def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1370                               is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1371                               is_delayed=False):
1372         return self.api(self.papi.bfd_udp_auth_activate,
1373                         {
1374                             'sw_if_index': sw_if_index,
1375                             'local_addr': local_addr,
1376                             'peer_addr': peer_addr,
1377                             'is_ipv6': is_ipv6,
1378                             'is_delayed': 1 if is_delayed else 0,
1379                             'bfd_key_id': bfd_key_id,
1380                             'conf_key_id': conf_key_id,
1381                         })
1382
1383     def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1384                                   peer_addr, is_ipv6=0):
1385         return self.api(self.papi.bfd_udp_session_set_flags, {
1386             'admin_up_down': admin_up_down,
1387             'sw_if_index': sw_if_index,
1388             'local_addr': local_addr,
1389             'peer_addr': peer_addr,
1390             'is_ipv6': is_ipv6,
1391         })
1392
1393     def want_bfd_events(self, enable_disable=1):
1394         return self.api(self.papi.want_bfd_events, {
1395             'enable_disable': enable_disable,
1396             'pid': os.getpid(),
1397         })
1398
1399     def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1400         return self.api(self.papi.bfd_auth_set_key, {
1401             'conf_key_id': conf_key_id,
1402             'auth_type': auth_type,
1403             'key': key,
1404             'key_len': len(key),
1405         })
1406
1407     def classify_add_del_table(
1408             self,
1409             is_add,
1410             mask,
1411             match_n_vectors=1,
1412             table_index=0xFFFFFFFF,
1413             nbuckets=2,
1414             memory_size=2097152,
1415             skip_n_vectors=0,
1416             next_table_index=0xFFFFFFFF,
1417             miss_next_index=0xFFFFFFFF,
1418             current_data_flag=0,
1419             current_data_offset=0):
1420         """
1421         :param is_add:
1422         :param mask:
1423         :param match_n_vectors: (Default value = 1)
1424         :param table_index: (Default value = 0xFFFFFFFF)
1425         :param nbuckets:  (Default value = 2)
1426         :param memory_size:  (Default value = 2097152)
1427         :param skip_n_vectors:  (Default value = 0)
1428         :param next_table_index:  (Default value = 0xFFFFFFFF)
1429         :param miss_next_index:  (Default value = 0xFFFFFFFF)
1430         :param current_data_flag:  (Default value = 0)
1431         :param current_data_offset:  (Default value = 0)
1432         """
1433
1434         mask_len = ((len(mask) - 1) / 16 + 1) * 16
1435         mask = mask + '\0' * (mask_len - len(mask))
1436         return self.api(
1437             self.papi.classify_add_del_table,
1438             {'is_add': is_add,
1439              'table_index': table_index,
1440              'nbuckets': nbuckets,
1441              'memory_size': memory_size,
1442              'skip_n_vectors': skip_n_vectors,
1443              'match_n_vectors': match_n_vectors,
1444              'next_table_index': next_table_index,
1445              'miss_next_index': miss_next_index,
1446              'current_data_flag': current_data_flag,
1447              'current_data_offset': current_data_offset,
1448              'mask_len': mask_len,
1449              'mask': mask})
1450
1451     def classify_add_del_session(
1452             self,
1453             is_add,
1454             table_index,
1455             match,
1456             opaque_index=0xFFFFFFFF,
1457             hit_next_index=0xFFFFFFFF,
1458             advance=0,
1459             action=0,
1460             metadata=0):
1461         """
1462         :param is_add:
1463         :param table_index:
1464         :param match:
1465         :param opaque_index:  (Default value = 0xFFFFFFFF)
1466         :param hit_next_index:  (Default value = 0xFFFFFFFF)
1467         :param advance:  (Default value = 0)
1468         :param action:  (Default value = 0)
1469         :param metadata:  (Default value = 0)
1470         """
1471
1472         match_len = ((len(match) - 1) / 16 + 1) * 16
1473         match = match + '\0' * (match_len - len(match))
1474         return self.api(
1475             self.papi.classify_add_del_session,
1476             {'is_add': is_add,
1477              'table_index': table_index,
1478              'hit_next_index': hit_next_index,
1479              'opaque_index': opaque_index,
1480              'advance': advance,
1481              'action': action,
1482              'metadata': metadata,
1483              'match_len': match_len,
1484              'match': match})
1485
1486     def input_acl_set_interface(
1487             self,
1488             is_add,
1489             sw_if_index,
1490             ip4_table_index=0xFFFFFFFF,
1491             ip6_table_index=0xFFFFFFFF,
1492             l2_table_index=0xFFFFFFFF):
1493         """
1494         :param is_add:
1495         :param sw_if_index:
1496         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
1497         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
1498         :param l2_table_index:  (Default value = 0xFFFFFFFF)
1499         """
1500
1501         return self.api(
1502             self.papi.input_acl_set_interface,
1503             {'sw_if_index': sw_if_index,
1504              'ip4_table_index': ip4_table_index,
1505              'ip6_table_index': ip6_table_index,
1506              'l2_table_index': l2_table_index,
1507              'is_add': is_add})
1508
1509     def output_acl_set_interface(
1510             self,
1511             is_add,
1512             sw_if_index,
1513             ip4_table_index=0xFFFFFFFF,
1514             ip6_table_index=0xFFFFFFFF,
1515             l2_table_index=0xFFFFFFFF):
1516         """
1517         :param is_add:
1518         :param sw_if_index:
1519         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
1520         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
1521         :param l2_table_index:  (Default value = 0xFFFFFFFF)
1522         """
1523
1524         return self.api(
1525             self.papi.output_acl_set_interface,
1526             {'sw_if_index': sw_if_index,
1527              'ip4_table_index': ip4_table_index,
1528              'ip6_table_index': ip6_table_index,
1529              'l2_table_index': l2_table_index,
1530              'is_add': is_add})
1531
1532     def set_ipfix_exporter(
1533             self,
1534             collector_address,
1535             src_address,
1536             path_mtu,
1537             template_interval,
1538             vrf_id=0,
1539             collector_port=4739,
1540             udp_checksum=0):
1541         return self.api(
1542             self.papi.set_ipfix_exporter,
1543             {
1544                 'collector_address': collector_address,
1545                 'collector_port': collector_port,
1546                 'src_address': src_address,
1547                 'vrf_id': vrf_id,
1548                 'path_mtu': path_mtu,
1549                 'template_interval': template_interval,
1550                 'udp_checksum': udp_checksum,
1551             })
1552
1553     def dhcp_proxy_config(self,
1554                           dhcp_server,
1555                           dhcp_src_address,
1556                           rx_table_id=0,
1557                           server_table_id=0,
1558                           is_add=1,
1559                           is_ipv6=0):
1560         return self.api(
1561             self.papi.dhcp_proxy_config,
1562             {
1563                 'rx_vrf_id': rx_table_id,
1564                 'server_vrf_id': server_table_id,
1565                 'is_ipv6': is_ipv6,
1566                 'is_add': is_add,
1567                 'dhcp_server': dhcp_server,
1568                 'dhcp_src_address': dhcp_src_address,
1569             })
1570
1571     def dhcp_proxy_set_vss(self,
1572                            table_id,
1573                            vss_type=255,
1574                            vpn_ascii_id="",
1575                            oui=0,
1576                            vpn_index=0,
1577                            is_add=1,
1578                            is_ip6=0):
1579         return self.api(
1580             self.papi.dhcp_proxy_set_vss,
1581             {
1582                 'tbl_id': table_id,
1583                 'vss_type': vss_type,
1584                 'vpn_ascii_id': vpn_ascii_id,
1585                 'oui': oui,
1586                 'vpn_index': vpn_index,
1587                 'is_add': is_add,
1588                 'is_ipv6': is_ip6,
1589             })
1590
1591     def dhcp_client_config(self,
1592                            sw_if_index,
1593                            hostname,
1594                            client_id='',
1595                            is_add=1,
1596                            set_broadcast_flag=1,
1597                            want_dhcp_events=0):
1598         return self.api(
1599             self.papi.dhcp_client_config,
1600             {
1601                 'is_add': is_add,
1602                 'client': {
1603                     'sw_if_index': sw_if_index,
1604                     'hostname': hostname,
1605                     'id': client_id,
1606                     'want_dhcp_event': want_dhcp_events,
1607                     'set_broadcast_flag': set_broadcast_flag,
1608                     'pid': os.getpid()}
1609             })
1610
1611     def ip_mroute_add_del(self,
1612                           src_address,
1613                           grp_address,
1614                           grp_address_length,
1615                           e_flags,
1616                           next_hop_afi,
1617                           next_hop_sw_if_index,
1618                           next_hop_address,
1619                           i_flags,
1620                           bier_imp=0,
1621                           rpf_id=0,
1622                           table_id=0,
1623                           is_add=1,
1624                           is_ipv6=0,
1625                           is_local=0):
1626         """
1627         IP Multicast Route add/del
1628         """
1629         return self.api(
1630             self.papi.ip_mroute_add_del,
1631             {'next_hop_sw_if_index': next_hop_sw_if_index,
1632              'entry_flags': e_flags,
1633              'itf_flags': i_flags,
1634              'table_id': table_id,
1635              'rpf_id': rpf_id,
1636              'is_add': is_add,
1637              'is_ipv6': is_ipv6,
1638              'is_local': is_local,
1639              'bier_imp': bier_imp,
1640              'next_hop_afi': next_hop_afi,
1641              'grp_address_length': grp_address_length,
1642              'grp_address': grp_address,
1643              'src_address': src_address,
1644              'nh_address': next_hop_address})
1645
1646     def lisp_enable_disable(self, is_enabled):
1647         return self.api(
1648             self.papi.lisp_enable_disable,
1649             {
1650                 'is_en': is_enabled,
1651             })
1652
1653     def lisp_add_del_locator_set(self,
1654                                  ls_name,
1655                                  is_add=1):
1656         return self.api(
1657             self.papi.lisp_add_del_locator_set,
1658             {
1659                 'is_add': is_add,
1660                 'locator_set_name': ls_name
1661             })
1662
1663     def lisp_add_del_locator(self,
1664                              ls_name,
1665                              sw_if_index,
1666                              priority=1,
1667                              weight=1,
1668                              is_add=1):
1669         return self.api(
1670             self.papi.lisp_add_del_locator,
1671             {
1672                 'is_add': is_add,
1673                 'locator_set_name': ls_name,
1674                 'sw_if_index': sw_if_index,
1675                 'priority': priority,
1676                 'weight': weight
1677             })
1678
1679     def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1680         return self.api(
1681             self.papi.lisp_locator_dump,
1682             {
1683                 'is_index_set': is_index_set,
1684                 'ls_name': ls_name,
1685                 'ls_index': ls_index,
1686             })
1687
1688     def lisp_add_del_local_eid(self,
1689                                ls_name,
1690                                eid_type,
1691                                eid,
1692                                prefix_len,
1693                                vni=0,
1694                                key_id=0,
1695                                key="",
1696                                is_add=1):
1697         return self.api(
1698             self.papi.lisp_add_del_local_eid,
1699             {
1700                 'locator_set_name': ls_name,
1701                 'is_add': is_add,
1702                 'eid_type': eid_type,
1703                 'eid': eid,
1704                 'prefix_len': prefix_len,
1705                 'vni': vni,
1706                 'key_id': key_id,
1707                 'key': key
1708             })
1709
1710     def lisp_eid_table_dump(self,
1711                             eid_set=0,
1712                             prefix_length=0,
1713                             vni=0,
1714                             eid_type=0,
1715                             eid=None,
1716                             filter_opt=0):
1717         return self.api(
1718             self.papi.lisp_eid_table_dump,
1719             {
1720                 'eid_set': eid_set,
1721                 'prefix_length': prefix_length,
1722                 'vni': vni,
1723                 'eid_type': eid_type,
1724                 'eid': eid,
1725                 'filter': filter_opt,
1726             })
1727
1728     def lisp_add_del_remote_mapping(self,
1729                                     eid_type,
1730                                     eid,
1731                                     eid_prefix_len=0,
1732                                     vni=0,
1733                                     rlocs=[],
1734                                     rlocs_num=0,
1735                                     is_src_dst=0,
1736                                     is_add=1):
1737         return self.api(
1738             self.papi.lisp_add_del_remote_mapping,
1739             {
1740                 'is_add': is_add,
1741                 'eid_type': eid_type,
1742                 'eid': eid,
1743                 'eid_len': eid_prefix_len,
1744                 'rloc_num': rlocs_num,
1745                 'rlocs': rlocs,
1746                 'vni': vni,
1747                 'is_src_dst': is_src_dst,
1748             })
1749
1750     def lisp_add_del_adjacency(self,
1751                                leid,
1752                                reid,
1753                                leid_len,
1754                                reid_len,
1755                                eid_type,
1756                                is_add=1,
1757                                vni=0):
1758         return self.api(
1759             self.papi.lisp_add_del_adjacency,
1760             {
1761                 'is_add': is_add,
1762                 'vni': vni,
1763                 'eid_type': eid_type,
1764                 'leid': leid,
1765                 'reid': reid,
1766                 'leid_len': leid_len,
1767                 'reid_len': reid_len,
1768             })
1769
1770     def gtpu_add_del_tunnel(
1771             self,
1772             src_addr,
1773             dst_addr,
1774             is_add=1,
1775             is_ipv6=0,
1776             mcast_sw_if_index=0xFFFFFFFF,
1777             encap_vrf_id=0,
1778             decap_next_index=0xFFFFFFFF,
1779             teid=0):
1780         """
1781
1782         :param is_add:  (Default value = 1)
1783         :param is_ipv6:  (Default value = 0)
1784         :param src_addr:
1785         :param dst_addr:
1786         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
1787         :param encap_vrf_id:  (Default value = 0)
1788         :param decap_next_index:  (Default value = 0xFFFFFFFF)
1789         :param teid:  (Default value = 0)
1790
1791         """
1792         return self.api(self.papi.gtpu_add_del_tunnel,
1793                         {'is_add': is_add,
1794                          'is_ipv6': is_ipv6,
1795                          'src_address': src_addr,
1796                          'dst_address': dst_addr,
1797                          'mcast_sw_if_index': mcast_sw_if_index,
1798                          'encap_vrf_id': encap_vrf_id,
1799                          'decap_next_index': decap_next_index,
1800                          'teid': teid})
1801
1802     def vxlan_gpe_add_del_tunnel(
1803             self,
1804             src_addr,
1805             dst_addr,
1806             mcast_sw_if_index=0xFFFFFFFF,
1807             is_add=1,
1808             is_ipv6=0,
1809             encap_vrf_id=0,
1810             decap_vrf_id=0,
1811             protocol=3,
1812             vni=0):
1813         """
1814
1815         :param local:
1816         :param remote:
1817         :param is_add:  (Default value = 1)
1818         :param is_ipv6:  (Default value = 0)
1819         :param encap_vrf_id:  (Default value = 0)
1820         :param decap_vrf_id:  (Default value = 0)
1821         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
1822         :param protocol:  (Default value = 3)
1823         :param vni:  (Default value = 0)
1824
1825         """
1826         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
1827                         {'is_add': is_add,
1828                          'is_ipv6': is_ipv6,
1829                          'local': src_addr,
1830                          'remote': dst_addr,
1831                          'mcast_sw_if_index': mcast_sw_if_index,
1832                          'encap_vrf_id': encap_vrf_id,
1833                          'decap_vrf_id': decap_vrf_id,
1834                          'protocol': protocol,
1835                          'vni': vni})
1836
1837     def vxlan_gbp_tunnel_add_del(
1838             self,
1839             src,
1840             dst,
1841             mcast_sw_if_index=0xFFFFFFFF,
1842             is_add=1,
1843             is_ipv6=0,
1844             encap_table_id=0,
1845             vni=0,
1846             instance=0xFFFFFFFF):
1847         """
1848
1849         :param dst_addr:
1850         :param src_addr:
1851         :param is_add:  (Default value = 1)
1852         :param is_ipv6:  (Default value = 0)
1853         :param encap_table_id:  (Default value = 0)
1854         :param decap_next_index:  (Default value = 0xFFFFFFFF)
1855         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
1856         :param vni:  (Default value = 0)
1857         :param instance:  (Default value = 0xFFFFFFFF)
1858
1859         """
1860         return self.api(self.papi.vxlan_gbp_tunnel_add_del,
1861                         {'is_add': is_add,
1862                          'tunnel': {
1863                              'src': src,
1864                              'dst': dst,
1865                              'mcast_sw_if_index': mcast_sw_if_index,
1866                              'encap_table_id': encap_table_id,
1867                              'vni': vni,
1868                              'instance': instance}})
1869
1870     def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
1871         return self.api(self.papi.vxlan_gbp_tunnel_dump,
1872                         {'sw_if_index': sw_if_index,
1873                          '_no_type_conversion': True})
1874
1875     def pppoe_add_del_session(
1876             self,
1877             client_ip,
1878             client_mac,
1879             session_id=0,
1880             is_add=1,
1881             is_ipv6=0,
1882             decap_vrf_id=0):
1883         """
1884
1885         :param is_add:  (Default value = 1)
1886         :param is_ipv6:  (Default value = 0)
1887         :param client_ip:
1888         :param session_id:  (Default value = 0)
1889         :param client_mac:
1890         :param decap_vrf_id:  (Default value = 0)
1891
1892         """
1893         return self.api(self.papi.pppoe_add_del_session,
1894                         {'is_add': is_add,
1895                          'is_ipv6': is_ipv6,
1896                          'session_id': session_id,
1897                          'client_ip': client_ip,
1898                          'decap_vrf_id': decap_vrf_id,
1899                          'client_mac': client_mac})
1900
1901     def sr_mpls_policy_add(self, bsid, weight, type, segments):
1902         return self.api(self.papi.sr_mpls_policy_add,
1903                         {'bsid': bsid,
1904                          'weight': weight,
1905                          'type': type,
1906                          'n_segments': len(segments),
1907                          'segments': segments})
1908
1909     def sr_mpls_policy_del(self, bsid):
1910         return self.api(self.papi.sr_mpls_policy_del,
1911                         {'bsid': bsid})
1912
1913     def sr_localsid_add_del(self,
1914                             localsid,
1915                             behavior,
1916                             nh_addr4,
1917                             nh_addr6,
1918                             is_del=0,
1919                             end_psp=0,
1920                             sw_if_index=0xFFFFFFFF,
1921                             vlan_index=0,
1922                             fib_table=0,
1923                             ):
1924         """ Add/del IPv6 SR local-SID.
1925
1926         :param localsid:
1927         :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
1928         :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
1929         :param nh_addr4:
1930         :param nh_addr6:
1931         :param is_del:  (Default value = 0)
1932         :param end_psp: (Default value = 0)
1933         :param sw_if_index: (Default value = 0xFFFFFFFF)
1934         :param vlan_index:  (Default value = 0)
1935         :param fib_table:   (Default value = 0)
1936         """
1937         return self.api(
1938             self.papi.sr_localsid_add_del,
1939             {'is_del': is_del,
1940              'localsid': localsid,
1941              'end_psp': end_psp,
1942              'behavior': behavior,
1943              'sw_if_index': sw_if_index,
1944              'vlan_index': vlan_index,
1945              'fib_table': fib_table,
1946              'nh_addr4': nh_addr4,
1947              'nh_addr6': nh_addr6
1948              }
1949         )
1950
1951     def sr_policy_add(
1952             self,
1953             bsid_addr,
1954             weight=1,
1955             is_encap=1,
1956             type=0,
1957             fib_table=0,
1958             n_segments=0,
1959             segments=[]):
1960         """
1961         :param bsid_addr: bindingSID of the SR Policy
1962         :param weight: weight of the sid list. optional. (default: 1)
1963         :param is_encap: (bool) whether SR policy should Encap or SRH insert \
1964             (default: Encap)
1965         :param type: type/behavior of the SR policy. (default or spray) \
1966             (default: default)
1967         :param fib_table: VRF where to install the FIB entry for the BSID \
1968             (default: 0)
1969         :param n_segments: number of segments \
1970             (default: 0)
1971         :param segments: a vector of IPv6 address composing the segment list \
1972             (default: [])
1973         """
1974         return self.api(
1975             self.papi.sr_policy_add,
1976             {'bsid_addr': bsid_addr,
1977              'weight': weight,
1978              'is_encap': is_encap,
1979              'type': type,
1980              'fib_table': fib_table,
1981              'n_segments': n_segments,
1982              'segments': segments
1983              }
1984         )
1985
1986     def sr_policy_del(
1987             self,
1988             bsid_addr,
1989             sr_policy_index=0):
1990         """
1991         :param bsid: bindingSID of the SR Policy
1992         :param sr_policy_index: index of the sr policy (default: 0)
1993         """
1994         return self.api(
1995             self.papi.sr_policy_del,
1996             {'bsid_addr': bsid_addr,
1997              'sr_policy_index': sr_policy_index
1998              })
1999
2000     def sr_steering_add_del(
2001             self,
2002             is_del,
2003             bsid_addr,
2004             sr_policy_index,
2005             table_id,
2006             prefix_addr,
2007             mask_width,
2008             sw_if_index,
2009             traffic_type):
2010         """
2011         Steer traffic L2 and L3 traffic through a given SR policy
2012
2013         :param is_del: delete or add
2014         :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2015         :param sr_policy: is the index of the SR Policy (alt to bsid)
2016         :param table_id: is the VRF where to install the FIB entry for the BSID
2017         :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2018         :param mask_width: is the mask for L3 traffic type
2019         :param sw_if_index: is the incoming interface for L2 traffic
2020         :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2021         """
2022         return self.api(
2023             self.papi.sr_steering_add_del,
2024             {'is_del': is_del,
2025              'bsid_addr': bsid_addr,
2026              'sr_policy_index': sr_policy_index,
2027              'table_id': table_id,
2028              'prefix_addr': prefix_addr,
2029              'mask_width': mask_width,
2030              'sw_if_index': sw_if_index,
2031              'traffic_type': traffic_type
2032              })
2033
2034     def acl_add_replace(self, acl_index, r, tag='',
2035                         expected_retval=0):
2036         """Add/replace an ACL
2037         :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2038         :param acl_rule r: ACL rules array.
2039         :param str tag: symbolic tag (description) for this ACL.
2040         :param int count: number of rules.
2041         """
2042         return self.api(self.papi.acl_add_replace,
2043                         {'acl_index': acl_index,
2044                          'r': r,
2045                          'count': len(r),
2046                          'tag': tag},
2047                         expected_retval=expected_retval)
2048
2049     def acl_del(self, acl_index, expected_retval=0):
2050         """
2051
2052         :param acl_index:
2053         :return:
2054         """
2055         return self.api(self.papi.acl_del,
2056                         {'acl_index': acl_index},
2057                         expected_retval=expected_retval)
2058
2059     def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2060                                    expected_retval=0):
2061         return self.api(self.papi.acl_interface_set_acl_list,
2062                         {'sw_if_index': sw_if_index,
2063                          'count': len(acls),
2064                          'n_input': n_input,
2065                          'acls': acls},
2066                         expected_retval=expected_retval)
2067
2068     def acl_interface_set_etype_whitelist(self, sw_if_index,
2069                                           n_input, whitelist,
2070                                           expected_retval=0):
2071         return self.api(self.papi.acl_interface_set_etype_whitelist,
2072                         {'sw_if_index': sw_if_index,
2073                          'count': len(whitelist),
2074                          'n_input': n_input,
2075                          'whitelist': whitelist},
2076                         expected_retval=expected_retval)
2077
2078     def acl_interface_add_del(self,
2079                               sw_if_index,
2080                               acl_index,
2081                               is_add=1):
2082         """ Add/Delete ACL to/from interface
2083
2084         :param sw_if_index:
2085         :param acl_index:
2086         :param is_add:  (Default value = 1)
2087         """
2088
2089         return self.api(self.papi.acl_interface_add_del,
2090                         {'is_add': is_add,
2091                          'is_input': 1,
2092                          'sw_if_index': sw_if_index,
2093                          'acl_index': acl_index})
2094
2095     def acl_dump(self, acl_index, expected_retval=0):
2096         return self.api(self.papi.acl_dump,
2097                         {'acl_index': acl_index},
2098                         expected_retval=expected_retval)
2099
2100     def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2101                                 expected_retval=0):
2102         return self.api(self.papi.acl_interface_list_dump,
2103                         {'sw_if_index': sw_if_index},
2104                         expected_retval=expected_retval)
2105
2106     def macip_acl_add(self, rules, tag=""):
2107         """ Add MACIP acl
2108
2109         :param rules: list of rules for given acl
2110         :param tag: acl tag
2111         """
2112
2113         return self.api(self.papi.macip_acl_add,
2114                         {'r': rules,
2115                          'count': len(rules),
2116                          'tag': tag})
2117
2118     def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2119         """ Add MACIP acl
2120
2121         :param rules: list of rules for given acl
2122         :param tag: acl tag
2123         """
2124
2125         return self.api(self.papi.macip_acl_add_replace,
2126                         {'acl_index': acl_index,
2127                          'r': rules,
2128                          'count': len(rules),
2129                          'tag': tag})
2130
2131     def macip_acl_interface_add_del(self,
2132                                     sw_if_index,
2133                                     acl_index,
2134                                     is_add=1):
2135         """ Add MACIP acl to interface
2136
2137         :param sw_if_index:
2138         :param acl_index:
2139         :param is_add:  (Default value = 1)
2140         """
2141
2142         return self.api(self.papi.macip_acl_interface_add_del,
2143                         {'is_add': is_add,
2144                          'sw_if_index': sw_if_index,
2145                          'acl_index': acl_index})
2146
2147     def macip_acl_dump(self, acl_index=4294967295):
2148         """ Return MACIP acl dump
2149         """
2150
2151         return self.api(
2152             self.papi.macip_acl_dump, {'acl_index': acl_index})
2153
2154     def policer_add_del(self,
2155                         name,
2156                         cir,
2157                         eir,
2158                         cb,
2159                         eb,
2160                         is_add=1,
2161                         rate_type=0,
2162                         round_type=0,
2163                         ptype=0,
2164                         color_aware=0,
2165                         conform_action_type=1,
2166                         conform_dscp=0,
2167                         exceed_action_type=0,
2168                         exceed_dscp=0,
2169                         violate_action_type=0,
2170                         violate_dscp=0):
2171         return self.api(self.papi.policer_add_del,
2172                         {'name': name,
2173                          'cir': cir,
2174                          'eir': eir,
2175                          'cb': cb,
2176                          'eb': eb,
2177                          'is_add': is_add,
2178                          'rate_type': rate_type,
2179                          'round_type': round_type,
2180                          'type': ptype,
2181                          'color_aware': color_aware,
2182                          'conform_action_type': conform_action_type,
2183                          'conform_dscp': conform_dscp,
2184                          'exceed_action_type': exceed_action_type,
2185                          'exceed_dscp': exceed_dscp,
2186                          'violate_action_type': violate_action_type,
2187                          'violate_dscp': violate_dscp})
2188
2189     def ip_punt_police(self,
2190                        policer_index,
2191                        is_ip6=0,
2192                        is_add=1):
2193         return self.api(self.papi.ip_punt_police,
2194                         {'policer_index': policer_index,
2195                          'is_add': is_add,
2196                          'is_ip6': is_ip6})
2197
2198     def ip_punt_redirect(self,
2199                          rx_sw_if_index,
2200                          tx_sw_if_index,
2201                          address,
2202                          is_add=1):
2203         return self.api(self.papi.ip_punt_redirect,
2204                         {'punt': {'rx_sw_if_index': rx_sw_if_index,
2205                                   'tx_sw_if_index': tx_sw_if_index,
2206                                   'nh': address},
2207                          'is_add': is_add})
2208
2209     def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
2210         return self.api(self.papi.ip_punt_redirect_dump,
2211                         {'sw_if_index': sw_if_index,
2212                          'is_ipv6': is_ipv6})
2213
2214     def bier_table_add_del(self,
2215                            bti,
2216                            mpls_label,
2217                            is_add=1):
2218         """ BIER Table add/del """
2219         return self.api(
2220             self.papi.bier_table_add_del,
2221             {'bt_tbl_id': {"bt_set": bti.set_id,
2222                            "bt_sub_domain": bti.sub_domain_id,
2223                            "bt_hdr_len_id": bti.hdr_len_id},
2224              'bt_label': mpls_label,
2225              'bt_is_add': is_add})
2226
2227     def bier_table_dump(self):
2228         return self.api(self.papi.bier_table_dump, {})
2229
2230     def bier_route_add_del(self,
2231                            bti,
2232                            bp,
2233                            paths,
2234                            is_add=1,
2235                            is_replace=0):
2236         """ BIER Route add/del """
2237         return self.api(
2238             self.papi.bier_route_add_del,
2239             {'br_tbl_id': {"bt_set": bti.set_id,
2240                            "bt_sub_domain": bti.sub_domain_id,
2241                            "bt_hdr_len_id": bti.hdr_len_id},
2242              'br_bp': bp,
2243              'br_n_paths': len(paths),
2244              'br_paths': paths,
2245              'br_is_add': is_add,
2246              'br_is_replace': is_replace})
2247
2248     def bier_route_dump(self, bti):
2249         return self.api(
2250             self.papi.bier_route_dump,
2251             {'br_tbl_id': {"bt_set": bti.set_id,
2252                            "bt_sub_domain": bti.sub_domain_id,
2253                            "bt_hdr_len_id": bti.hdr_len_id}})
2254
2255     def bier_imp_add(self,
2256                      bti,
2257                      src,
2258                      ibytes,
2259                      is_add=1):
2260         """ BIER Imposition Add """
2261         return self.api(
2262             self.papi.bier_imp_add,
2263             {'bi_tbl_id': {"bt_set": bti.set_id,
2264                            "bt_sub_domain": bti.sub_domain_id,
2265                            "bt_hdr_len_id": bti.hdr_len_id},
2266              'bi_src': src,
2267              'bi_n_bytes': len(ibytes),
2268              'bi_bytes': ibytes})
2269
2270     def bier_imp_del(self, bi_index):
2271         """ BIER Imposition del """
2272         return self.api(
2273             self.papi.bier_imp_del,
2274             {'bi_index': bi_index})
2275
2276     def bier_imp_dump(self):
2277         return self.api(self.papi.bier_imp_dump, {})
2278
2279     def bier_disp_table_add_del(self,
2280                                 bdti,
2281                                 is_add=1):
2282         """ BIER Disposition Table add/del """
2283         return self.api(
2284             self.papi.bier_disp_table_add_del,
2285             {'bdt_tbl_id': bdti,
2286              'bdt_is_add': is_add})
2287
2288     def bier_disp_table_dump(self):
2289         return self.api(self.papi.bier_disp_table_dump, {})
2290
2291     def bier_disp_entry_add_del(self,
2292                                 bdti,
2293                                 bp,
2294                                 payload_proto,
2295                                 next_hop_afi,
2296                                 next_hop,
2297                                 next_hop_tbl_id=0,
2298                                 next_hop_rpf_id=~0,
2299                                 next_hop_is_ip4=1,
2300                                 is_add=1):
2301         """ BIER Route add/del """
2302         lstack = []
2303         while (len(lstack) < 16):
2304             lstack.append({})
2305         return self.api(
2306             self.papi.bier_disp_entry_add_del,
2307             {'bde_tbl_id': bdti,
2308              'bde_bp': bp,
2309              'bde_payload_proto': payload_proto,
2310              'bde_n_paths': 1,
2311              'bde_paths': [{'next_hop': next_hop,
2312                             'table_id': next_hop_tbl_id,
2313                             'afi': next_hop_afi,
2314                             'rpf_id': next_hop_rpf_id,
2315                             'n_labels': 0,
2316                             'label_stack': lstack}],
2317              'bde_is_add': is_add})
2318
2319     def bier_disp_entry_dump(self, bdti):
2320         return self.api(
2321             self.papi.bier_disp_entry_dump,
2322             {'bde_tbl_id': bdti})
2323
2324     def session_enable_disable(self, is_enabled):
2325         return self.api(
2326             self.papi.session_enable_disable,
2327             {'is_enable': is_enabled})
2328
2329     def ipsec_spd_add_del(self, spd_id, is_add=1):
2330         """ SPD add/del - Wrapper to add or del ipsec SPD
2331         Sample CLI : 'ipsec spd add 1'
2332
2333         :param spd_id - SPD ID to be created in the vpp . mandatory
2334         :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2335               optional
2336         :returns: reply from the API
2337         """
2338         return self.api(
2339             self.papi.ipsec_spd_add_del, {
2340                 'spd_id': spd_id, 'is_add': is_add})
2341
2342     def ipsec_spds_dump(self):
2343         return self.api(self.papi.ipsec_spds_dump, {})
2344
2345     def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2346         """ IPSEC interface SPD add/del - \
2347              Wrapper to associate/disassociate SPD to interface in VPP
2348         Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2349
2350         :param spd_id - SPD ID to associate with the interface . mandatory
2351         :param sw_if_index - Interface Index which needs to ipsec \
2352             association mandatory
2353         :param is_add - add(1) or del(0) association with interface \
2354                 (Default 1 - add) . optional
2355         :returns: reply from the API
2356         """
2357         return self.api(
2358             self.papi.ipsec_interface_add_del_spd,
2359             {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
2360
2361     def ipsec_spd_interface_dump(self, spd_index=None):
2362         return self.api(self.papi.ipsec_spd_interface_dump,
2363                         {'spd_index': spd_index if spd_index else 0,
2364                          'spd_index_valid': 1 if spd_index else 0})
2365
2366     def ipsec_sad_entry_add_del(self,
2367                                 sad_id,
2368                                 spi,
2369                                 integrity_algorithm,
2370                                 integrity_key,
2371                                 crypto_algorithm,
2372                                 crypto_key,
2373                                 protocol,
2374                                 tunnel_src_address='',
2375                                 tunnel_dst_address='',
2376                                 flags=0,
2377                                 is_add=1):
2378         """ IPSEC SA add/del
2379         :param sad_id: security association ID
2380         :param spi: security param index of the SA in decimal
2381         :param integrity_algorithm:
2382         :param integrity_key:
2383         :param crypto_algorithm:
2384         :param crypto_key:
2385         :param protocol: AH(0) or ESP(1) protocol
2386         :param tunnel_src_address: tunnel mode outer src address
2387         :param tunnel_dst_address: tunnel mode outer dst address
2388         :param is_add:
2389         :param is_tunnel:
2390         :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
2391              crypto and ipsec algorithms
2392         """
2393         return self.api(
2394             self.papi.ipsec_sad_entry_add_del,
2395             {
2396                 'is_add': is_add,
2397                 'entry':
2398                     {
2399                         'sad_id': sad_id,
2400                         'spi': spi,
2401                         'tunnel_src': tunnel_src_address,
2402                         'tunnel_dst': tunnel_dst_address,
2403                         'protocol': protocol,
2404                         'integrity_algorithm': integrity_algorithm,
2405                         'integrity_key': {
2406                             'length': len(integrity_key),
2407                             'data': integrity_key,
2408                         },
2409                         'crypto_algorithm': crypto_algorithm,
2410                         'crypto_key': {
2411                             'length': len(crypto_key),
2412                             'data': crypto_key,
2413                         },
2414                         'flags': flags,
2415                     }
2416             })
2417
2418     def ipsec_sa_dump(self, sa_id=None):
2419         return self.api(self.papi.ipsec_sa_dump,
2420                         {'sa_id': sa_id if sa_id else 0xffffffff})
2421
2422     def ipsec_spd_entry_add_del(self,
2423                                 spd_id,
2424                                 sa_id,
2425                                 local_address_start,
2426                                 local_address_stop,
2427                                 remote_address_start,
2428                                 remote_address_stop,
2429                                 local_port_start=0,
2430                                 local_port_stop=65535,
2431                                 remote_port_start=0,
2432                                 remote_port_stop=65535,
2433                                 protocol=0,
2434                                 policy=0,
2435                                 priority=100,
2436                                 is_outbound=1,
2437                                 is_add=1,
2438                                 is_ipv6=0,
2439                                 is_ip_any=0):
2440         """ IPSEC policy SPD add/del   -
2441                     Wrapper to configure ipsec SPD policy entries in VPP
2442         :param spd_id: SPD ID for the policy
2443         :param local_address_start: local-ip-range start address
2444         :param local_address_stop : local-ip-range stop address
2445         :param remote_address_start: remote-ip-range start address
2446         :param remote_address_stop : remote-ip-range stop address
2447         :param local_port_start: (Default value = 0)
2448         :param local_port_stop: (Default value = 65535)
2449         :param remote_port_start: (Default value = 0)
2450         :param remote_port_stop: (Default value = 65535)
2451         :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
2452         :param sa_id: Security Association ID for mapping it to SPD
2453         :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
2454                (Default value = 0)
2455         :param priority: value for the spd action (Default value = 100)
2456         :param is_outbound: flag for inbound(0) or outbound(1)
2457                (Default value = 1)
2458         :param is_add: (Default value = 1)
2459         """
2460         return self.api(
2461             self.papi.ipsec_spd_entry_add_del,
2462             {
2463                 'is_add': is_add,
2464                 'entry':
2465                     {
2466                         'spd_id': spd_id,
2467                         'sa_id': sa_id,
2468                         'local_address_start': local_address_start,
2469                         'local_address_stop': local_address_stop,
2470                         'remote_address_start': remote_address_start,
2471                         'remote_address_stop': remote_address_stop,
2472                         'local_port_start': local_port_start,
2473                         'local_port_stop': local_port_stop,
2474                         'remote_port_start': remote_port_start,
2475                         'remote_port_stop': remote_port_stop,
2476                         'protocol': protocol,
2477                         'policy': policy,
2478                         'priority': priority,
2479                         'is_outbound': is_outbound,
2480                         'is_ip_any': is_ip_any
2481                     }
2482             })
2483
2484     def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
2485         return self.api(self.papi.ipsec_spd_dump,
2486                         {'spd_id': spd_id,
2487                          'sa_id': sa_id})
2488
2489     def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
2490                                 remote_spi, crypto_alg, local_crypto_key,
2491                                 remote_crypto_key, integ_alg, local_integ_key,
2492                                 remote_integ_key, is_add=1, esn=0,
2493                                 anti_replay=1, renumber=0, show_instance=0):
2494         return self.api(
2495             self.papi.ipsec_tunnel_if_add_del,
2496             {'local_ip': local_ip, 'remote_ip': remote_ip,
2497              'local_spi': local_spi, 'remote_spi': remote_spi,
2498              'crypto_alg': crypto_alg,
2499              'local_crypto_key_len': len(local_crypto_key),
2500              'local_crypto_key': local_crypto_key,
2501              'remote_crypto_key_len': len(remote_crypto_key),
2502              'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
2503              'local_integ_key_len': len(local_integ_key),
2504              'local_integ_key': local_integ_key,
2505              'remote_integ_key_len': len(remote_integ_key),
2506              'remote_integ_key': remote_integ_key, 'is_add': is_add,
2507              'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
2508              'show_instance': show_instance
2509              })
2510
2511     def ipsec_select_backend(self, protocol, index):
2512         return self.api(self.papi.ipsec_select_backend,
2513                         {'protocol': protocol, 'index': index})
2514
2515     def ipsec_backend_dump(self):
2516         return self.api(self.papi.ipsec_backend_dump, {})
2517
2518     def app_namespace_add_del(self,
2519                               namespace_id,
2520                               ip4_fib_id=0,
2521                               ip6_fib_id=0,
2522                               sw_if_index=0xFFFFFFFF,
2523                               secret=0):
2524         return self.api(
2525             self.papi.app_namespace_add_del,
2526             {'secret': secret,
2527              'sw_if_index': sw_if_index,
2528              'ip4_fib_id': ip4_fib_id,
2529              'ip6_fib_id': ip6_fib_id,
2530              'namespace_id': namespace_id,
2531              'namespace_id_len': len(namespace_id)})
2532
2533     def punt_socket_register(self, port, pathname, protocol=0x11,
2534                              header_version=1, is_ip4=1):
2535         """ Register punt socket """
2536         return self.api(self.papi.punt_socket_register,
2537                         {'header_version': header_version,
2538                          'punt': {'ipv': is_ip4,
2539                                   'l4_protocol': protocol,
2540                                   'l4_port': port},
2541                          'pathname': pathname})
2542
2543     def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
2544         """ Unregister punt socket """
2545         return self.api(self.papi.punt_socket_deregister,
2546                         {'punt': {'ipv': is_ip4,
2547                                   'l4_protocol': protocol,
2548                                   'l4_port': port}})
2549
2550     def punt_socket_dump(self, is_ip6=1):
2551         """ Dump punt socket"""
2552         return self.api(self.papi.punt_socket_dump,
2553                         {'is_ipv6': is_ip6})
2554
2555     def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
2556                          tun_src, tun_dst):
2557         """ GBP endpoint Add """
2558         return self.api(self.papi.gbp_endpoint_add,
2559                         {'endpoint': {
2560                             'sw_if_index': sw_if_index,
2561                             'ips': ips,
2562                             'n_ips': len(ips),
2563                             'mac': mac,
2564                             'sclass': sclass,
2565                             'flags': flags,
2566                             'tun': {
2567                                 'src': tun_src,
2568                                 'dst': tun_dst,
2569                             }}})
2570
2571     def gbp_endpoint_del(self, handle):
2572         """ GBP endpoint Del """
2573         return self.api(self.papi.gbp_endpoint_del,
2574                         {'handle': handle})
2575
2576     def gbp_endpoint_dump(self):
2577         """ GBP endpoint Dump """
2578         return self.api(self.papi.gbp_endpoint_dump,
2579                         {'_no_type_conversion': True})
2580
2581     def gbp_endpoint_group_add(self, vnid, sclass, bd,
2582                                rd, uplink_sw_if_index,
2583                                retention):
2584         """ GBP endpoint group Add """
2585         return self.api(self.papi.gbp_endpoint_group_add,
2586                         {'epg':
2587                             {
2588                                 'uplink_sw_if_index': uplink_sw_if_index,
2589                                 'bd_id': bd,
2590                                 'rd_id': rd,
2591                                 'vnid': vnid,
2592                                 'sclass': sclass,
2593                                 'retention': retention
2594                             }})
2595
2596     def gbp_endpoint_group_del(self, sclass):
2597         """ GBP endpoint group Del """
2598         return self.api(self.papi.gbp_endpoint_group_del,
2599                         {'sclass': sclass})
2600
2601     def gbp_bridge_domain_add(self, bd_id, flags,
2602                               bvi_sw_if_index,
2603                               uu_fwd_sw_if_index,
2604                               bm_flood_sw_if_index):
2605         """ GBP bridge-domain Add """
2606         return self.api(self.papi.gbp_bridge_domain_add,
2607                         {'bd':
2608                             {
2609                                 'flags': flags,
2610                                 'bvi_sw_if_index': bvi_sw_if_index,
2611                                 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
2612                                 'bm_flood_sw_if_index': bm_flood_sw_if_index,
2613                                 'bd_id': bd_id
2614                             }})
2615
2616     def gbp_bridge_domain_del(self, bd_id):
2617         """ GBP bridge-domain Del """
2618         return self.api(self.papi.gbp_bridge_domain_del,
2619                         {'bd_id': bd_id})
2620
2621     def gbp_route_domain_add(self, rd_id,
2622                              ip4_table_id,
2623                              ip6_table_id,
2624                              ip4_uu_sw_if_index,
2625                              ip6_uu_sw_if_index):
2626         """ GBP route-domain Add """
2627         return self.api(self.papi.gbp_route_domain_add,
2628                         {'rd':
2629                             {
2630                                 'ip4_table_id': ip4_table_id,
2631                                 'ip6_table_id': ip6_table_id,
2632                                 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
2633                                 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
2634                                 'rd_id': rd_id
2635                             }})
2636
2637     def gbp_route_domain_del(self, rd_id):
2638         """ GBP route-domain Del """
2639         return self.api(self.papi.gbp_route_domain_del,
2640                         {'rd_id': rd_id})
2641
2642     def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
2643         """ GBP recirc Add/Del """
2644         return self.api(self.papi.gbp_recirc_add_del,
2645                         {'is_add': is_add,
2646                          'recirc': {
2647                              'is_ext': is_ext,
2648                              'sw_if_index': sw_if_index,
2649                              'sclass': sclass}})
2650
2651     def gbp_recirc_dump(self):
2652         """ GBP recirc Dump """
2653         return self.api(self.papi.gbp_recirc_dump, {})
2654
2655     def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
2656         """ GBP recirc Add/Del """
2657         return self.api(self.papi.gbp_ext_itf_add_del,
2658                         {'is_add': is_add,
2659                          'ext_itf': {
2660                              'sw_if_index': sw_if_index,
2661                              'bd_id': bd_id,
2662                              'rd_id': rd_id}})
2663
2664     def gbp_ext_itf_dump(self):
2665         """ GBP recirc Dump """
2666         return self.api(self.papi.gbp_ext_itf_dump, {})
2667
2668     def gbp_subnet_add_del(self, is_add, rd_id,
2669                            prefix, type,
2670                            sw_if_index=0xffffffff,
2671                            sclass=0xffff):
2672         """ GBP Subnet Add/Del """
2673         return self.api(self.papi.gbp_subnet_add_del,
2674                         {'is_add': is_add,
2675                          'subnet': {
2676                              'type': type,
2677                              'sw_if_index': sw_if_index,
2678                              'sclass': sclass,
2679                              'prefix': prefix,
2680                              'rd_id': rd_id}})
2681
2682     def gbp_subnet_dump(self):
2683         """ GBP Subnet Dump """
2684         return self.api(self.papi.gbp_subnet_dump,
2685                         {'_no_type_conversion': True})
2686
2687     def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
2688                              rules, allowed_ethertypes):
2689         """ GBP contract Add/Del """
2690         return self.api(self.papi.gbp_contract_add_del,
2691                         {'is_add': is_add,
2692                          'contract': {
2693                              'acl_index': acl_index,
2694                              'sclass': sclass,
2695                              'dclass': dclass,
2696                              'n_rules': len(rules),
2697                              'rules': rules,
2698                              'n_ether_types': len(allowed_ethertypes),
2699                              'allowed_ethertypes': allowed_ethertypes}})
2700
2701     def gbp_contract_dump(self):
2702         """ GBP contract Dump """
2703         return self.api(self.papi.gbp_contract_dump, {})
2704
2705     def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
2706         """ GBP VXLAN tunnel add """
2707         return self.api(self.papi.gbp_vxlan_tunnel_add,
2708                         {
2709                             'tunnel': {
2710                                 'vni': vni,
2711                                 'mode': mode,
2712                                 'bd_rd_id': bd_rd_id,
2713                                 'src': src
2714                             }
2715                         })
2716
2717     def gbp_vxlan_tunnel_del(self, vni):
2718         """ GBP VXLAN tunnel del """
2719         return self.api(self.papi.gbp_vxlan_tunnel_del,
2720                         {
2721                             'vni': vni,
2722                         })
2723
2724     def gbp_vxlan_tunnel_dump(self):
2725         """ GBP VXLAN tunnel add/del """
2726         return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
2727
2728     def qos_egress_map_update(self, id, outputs):
2729         """ QOS egress map update """
2730         return self.api(self.papi.qos_egress_map_update,
2731                         {'map_id': id,
2732                          'rows': outputs})
2733
2734     def qos_egress_map_delete(self, id):
2735         """ QOS egress map delete """
2736         return self.api(self.papi.qos_egress_map_delete,
2737                         {'map_id': id})
2738
2739     def qos_mark_enable_disable(self, sw_if_index,
2740                                 output_source,
2741                                 map_id,
2742                                 enable):
2743         """ QOS Mark Enable/Disable """
2744         return self.api(self.papi.qos_mark_enable_disable,
2745                         {'map_id': map_id,
2746                          'sw_if_index': sw_if_index,
2747                          'output_source': output_source,
2748                          'enable': enable})
2749
2750     def igmp_enable_disable(self, sw_if_index, enable, host):
2751         """ Enable/disable IGMP on a given interface """
2752         return self.api(self.papi.igmp_enable_disable,
2753                         {'enable': enable,
2754                          'mode': host,
2755                          'sw_if_index': sw_if_index})
2756
2757     def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
2758         """ Add/del IGMP proxy device """
2759         return self.api(self.papi.igmp_proxy_device_add_del,
2760                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2761                          'add': add})
2762
2763     def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
2764         """ Add/del interface to/from IGMP proxy device """
2765         return self.api(self.papi.igmp_proxy_device_add_del_interface,
2766                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
2767                          'add': add})
2768
2769     def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
2770         """ Listen for new (S,G) on specified interface
2771
2772         :param enable: add/del
2773         :param sw_if_index: interface sw index
2774         :param saddr: source ip4 addr
2775         :param gaddr: group ip4 addr
2776         """
2777         return self.api(self.papi.igmp_listen,
2778                         {
2779                             'group':
2780                                 {
2781                                     'filter': filter,
2782                                     'sw_if_index': sw_if_index,
2783                                     'n_srcs': len(saddrs),
2784                                     'saddrs': saddrs,
2785                                     'gaddr': gaddr
2786                                 }
2787                         })
2788
2789     def igmp_clear_interface(self, sw_if_index):
2790         """ Remove all (S,G)s from specified interface
2791             doesn't send IGMP report!
2792         """
2793         return self.api(
2794             self.papi.igmp_clear_interface, {
2795                 'sw_if_index': sw_if_index})
2796
2797     def want_igmp_events(self, enable=1):
2798         return self.api(self.papi.want_igmp_events, {'enable': enable,
2799                                                      'pid': os.getpid()})
2800
2801     def bond_create(
2802             self,
2803             mode,
2804             lb,
2805             use_custom_mac,
2806             mac_address='',
2807             interface_id=0xFFFFFFFF):
2808         """
2809         :param mode: mode
2810         :param lb: load balance
2811         :param use_custom_mac: use custom mac
2812         :param mac_address: mac address
2813         :param interface_id: custom interface ID
2814         """
2815         return self.api(
2816             self.papi.bond_create,
2817             {'mode': mode,
2818              'lb': lb,
2819              'use_custom_mac': use_custom_mac,
2820              'mac_address': mac_address,
2821              'id': interface_id
2822              })
2823
2824     def pipe_delete(self, parent_sw_if_index):
2825         return self.api(self.papi.pipe_delete,
2826                         {'parent_sw_if_index': parent_sw_if_index})
2827
2828     def memif_create(
2829             self,
2830             role,
2831             mode,
2832             rx_queues=None,
2833             tx_queues=None,
2834             _id=None,
2835             socket_id=None,
2836             secret=None,
2837             ring_size=None,
2838             buffer_size=None,
2839             hw_addr=None):
2840         return self.api(self.papi.memif_create,
2841                         {'role': role,
2842                          'mode': mode,
2843                          'rx_queues': rx_queues,
2844                          'tx_queues': tx_queues,
2845                          'id': _id,
2846                          'socket_id': socket_id,
2847                          'secret': secret,
2848                          'ring_size': ring_size,
2849                          'buffer_size': buffer_size,
2850                          'hw_addr': hw_addr})
2851
2852     def svs_table_add_del(self, af, table_id, is_add=1):
2853         return self.api(self.papi.svs_table_add_del,
2854                         {
2855                             'table_id': table_id,
2856                             'is_add': is_add,
2857                             'af': af,
2858                         })
2859
2860     def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
2861         return self.api(self.papi.svs_route_add_del,
2862                         {
2863                             'table_id': table_id,
2864                             'source_table_id': src_table_id,
2865                             'prefix': prefix,
2866                             'is_add': is_add,
2867                         })
2868
2869     def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
2870         return self.api(self.papi.svs_enable_disable,
2871                         {
2872                             'af': af,
2873                             'table_id': table_id,
2874                             'sw_if_index': sw_if_index,
2875                             'is_enable': is_enable,
2876                         })