1 # NB NB NB NB NB NB NB NB NB NB NB
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.
10 from collections import deque
12 from six import moves, iteritems
13 from vpp_papi import VPP, mac_pton
15 from vpp_l2 import L2_PORT_TYPE
17 # from vnet/vnet/mpls/mpls_types.h
18 MPLS_IETF_MAX_LABEL = 0xfffff
19 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
41 class SYSLOG_SEVERITY:
53 # Dictionary keyed on message name to override default values for
57 'map_add_domain': {'mtu': 1280},
58 'syslog_set_sender': {'collector_port': 514,
60 'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
61 'acl_interface_list_dump': {'sw_if_index': 4294967295, },
62 'app_namespace_add_del': {'sw_if_index': 4294967295, },
63 'bd_ip_mac_add_del': {'is_add': 1, },
64 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
66 'bier_disp_table_add_del': {'is_add': 1, },
67 'bier_imp_add': {'is_add': 1, },
68 'bier_route_add_del': {'is_add': 1, },
69 'bier_table_add_del': {'is_add': 1, },
70 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
71 'learn': 1, 'is_add': 1, },
72 'classify_add_del_table': {'match_n_vectors': 1, 'table_index': 4294967295,
73 'nbuckets': 2, 'memory_size': 2097152,
74 'next_table_index': 4294967295,
75 'miss_next_index': 4294967295, },
76 'dhcp6_client_enable_disable': {'enable': 1, },
77 'dhcp6_clients_enable_disable': {'enable': 1, },
78 'dhcp6_pd_client_enable_disable': {'enable': 1, },
79 'dhcp6_send_client_message': {'server_index': 4294967295, 'mrc': 1, },
80 'dhcp_client_config': {'is_add': 1, 'set_broadcast_flag': 1, },
81 'dhcp_proxy_config': {'is_add': 1, },
82 'dhcp_proxy_set_vss': {'vss_type': 255, 'is_add': 1, },
83 'dslite_add_del_pool_addr_range': {'is_add': 1, },
84 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
85 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
86 'decap_next_index': 4294967295, },
87 'gre_add_del_tunnel': {'instance': 4294967295, 'is_add': 1, },
88 'gtpu_add_del_tunnel': {'is_add': 1, 'mcast_sw_if_index': 4294967295,
89 'decap_next_index': 4294967295, },
90 'input_acl_set_interface': {'ip4_table_index': 4294967295,
91 'ip6_table_index': 4294967295,
92 'l2_table_index': 4294967295, },
93 'ip6_add_del_address_using_prefix': {'is_add': 1, },
94 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
95 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
96 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
97 'next_hop_id': 4294967295,
98 'classify_table_index': 4294967295, 'is_add': 1, },
99 'ip_mroute_add_del': {'is_add': 1, },
100 'ip_neighbor_add_del': {'is_add': 1, },
101 'ip_punt_police': {'is_add': 1, },
102 'ip_punt_redirect': {'is_add': 1, },
103 'ip_table_add_del': {'is_add': 1, },
104 'ip_unnumbered_dump': {'sw_if_index': 4294967295, },
105 'ipip_add_tunnel': {'is_ipv6': 1, 'instance': 4294967295, },
106 'ipsec_interface_add_del_spd': {'is_add': 1, },
107 'ipsec_sad_entry_add_del': {'is_add': 1, },
108 'ipsec_spd_add_del': {'is_add': 1, },
109 'ipsec_spd_dump': {'sa_id': 4294967295, },
110 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
111 'remote_port_stop': 65535, 'priority': 100,
114 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
115 'l2_emulation': {'enable': 1, },
116 'l2fib_add_del': {'is_add': 1, },
117 'lisp_add_del_adjacency': {'is_add': 1, },
118 'lisp_add_del_local_eid': {'is_add': 1, },
119 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
120 'lisp_add_del_locator_set': {'is_add': 1, },
121 'lisp_add_del_remote_mapping': {'is_add': 1, },
122 'macip_acl_add_replace': {'acl_index': 4294967295, },
123 'macip_acl_dump': {'acl_index': 4294967295, },
124 'macip_acl_interface_add_del': {'is_add': 1, },
125 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
126 'mpls_route_add_del': {'next_hop_sw_if_index': 4294967295,
127 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
128 'is_add': 1, 'classify_table_index': 4294967295, },
129 'mpls_table_add_del': {'is_add': 1, },
130 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
131 'next_hop_weight': 1,
132 'next_hop_via_label': 1048576,
134 'mpls_tunnel_dump': {'sw_if_index': 4294967295, },
135 'nat44_add_del_address_range': {'is_add': 1, 'vrf_id': 4294967295, },
136 'nat44_add_del_identity_mapping': {'ip': '0', 'sw_if_index': 4294967295,
137 'addr_only': 1, 'is_add': 1, },
138 'nat44_add_del_interface_addr': {'is_add': 1, },
139 'nat44_add_del_lb_static_mapping': {'is_add': 1, },
140 'nat44_add_del_static_mapping': {'external_sw_if_index': 4294967295,
141 'addr_only': 1, 'is_add': 1, },
142 'nat44_del_session': {'is_in': 1, },
143 'nat44_interface_add_del_feature': {'is_inside': 1, 'is_add': 1, },
144 'nat44_interface_add_del_output_feature': {'is_inside': 1, 'is_add': 1, },
145 'nat44_lb_static_mapping_add_del_local': {'is_add': 1, },
146 'nat64_add_del_interface': {'is_inside': 1, 'is_add': 1, },
147 'nat64_add_del_interface_addr': {'is_add': 1, },
148 'nat64_add_del_pool_addr_range': {'vrf_id': 4294967295, 'is_add': 1, },
149 'nat64_add_del_prefix': {'is_add': 1, },
150 'nat64_add_del_static_bib': {'is_add': 1, },
151 'nat64_bib_dump': {'protocol': 255, },
152 'nat64_st_dump': {'protocol': 255, },
153 'nat66_add_del_interface': {'is_inside': 1, 'is_add': 1, },
154 'nat66_add_del_static_mapping': {'is_add': 1, },
155 'nat_det_add_del_map': {'is_add': 1, },
156 'nat_ha_resync': {'want_resync_event': 1, },
157 'nat_ha_set_failover': {'refresh': 10, },
158 'nat_ha_set_listener': {'path_mtu': 512, },
159 'nat_ipfix_enable_disable': {'domain_id': 1, 'src_port': 4739,
161 'nat_set_mss_clamping': {'mss_value': 1500, },
162 'nat_set_reass': {'timeout': 2, 'max_reass': 1024, 'max_frag': 5, },
163 'nat_set_timeouts': {'udp': 300, 'tcp_established': 7440,
164 'tcp_transitory': 240, 'icmp': 60, },
165 'output_acl_set_interface': {'ip4_table_index': 4294967295,
166 'ip6_table_index': 4294967295,
167 'l2_table_index': 4294967295, },
168 'pppoe_add_del_session': {'is_add': 1, },
169 'policer_add_del': {'is_add': 1, 'conform_action_type': 1, },
170 'proxy_arp_add_del': {'is_add': 1, },
171 'proxy_arp_intfc_enable_disable': {'is_enable': 1, },
172 'punt_socket_register': {'protocol': 17, 'header_version': 1,
174 'punt_socket_deregister': {'protocol': 17, 'is_ip4': 1, },
175 'punt_socket_dump': {'is_ip6': 1, },
176 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
178 'set_ipfix_exporter': {'collector_port': 4739, },
179 'sr_localsid_add_del': {'sw_if_index': 4294967295, },
180 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
181 'svs_enable_disable': {'is_enable': 1, },
182 'svs_route_add_del': {'is_add': 1, },
183 'svs_table_add_del': {'is_add': 1, },
184 'sw_interface_add_del_address': {'is_add': 1, },
185 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
186 'pref_lifetime': 4294967295, },
187 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
188 'sw_interface_set_l2_bridge': {'enable': 1, },
189 'sw_interface_set_mpls_enable': {'enable': 1, },
190 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
191 'sw_interface_set_unnumbered': {'is_add': 1, },
192 'sw_interface_span_enable_disable': {'state': 1, },
193 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
194 'decap_next_index': 4294967295,
195 'instance': 4294967295, },
196 'vxlan_gbp_tunnel_add_del': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
197 'instance': 4294967295, },
198 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, },
199 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
201 'want_bfd_events': {'enable_disable': 1, },
202 'want_dhcp6_pd_reply_events': {'enable_disable': 1, },
203 'want_dhcp6_reply_events': {'enable_disable': 1, },
204 'want_igmp_events': {'enable': 1, },
205 'want_interface_events': {'enable_disable': 1, },
206 'want_ip4_arp_events': {'enable_disable': 1, 'ip': '0.0.0.0', },
207 'want_ip6_nd_events': {'enable_disable': 1, 'ip': '::', },
208 'want_ip6_ra_events': {'enable_disable': 1, },
209 'want_l2_macs_events': {'enable_disable': 1, },
213 class UnexpectedApiReturnValueError(Exception):
214 """ exception raised when the API return value is unexpected """
218 class VppPapiProvider(object):
219 """VPP-api provider using vpp-papi
221 @property hook: hook object providing before and after api/cli hooks
224 _zero, _negative = range(2)
226 def __init__(self, name, shm_prefix, test_class, read_timeout):
227 self.hook = Hook(test_class)
229 self.shm_prefix = shm_prefix
230 self.test_class = test_class
231 self._expect_api_retval = self._zero
232 self._expect_stack = []
234 install_dir = os.getenv('VPP_INSTALL_PATH')
236 # Vapi requires 'VPP_API_DIR', not set when run from Makefile.
237 if 'VPP_API_DIR' not in os.environ:
238 os.environ['VPP_API_DIR'] = os.getenv('VPP_INSTALL_PATH')
240 self.vpp = VPP(logger=test_class.logger,
241 read_timeout=read_timeout)
242 self._events = deque()
247 def assert_negative_api_retval(self):
248 """ Expect API failure - used with with, e.g.:
249 with self.vapi.assert_negative_api_retval():
250 self.vapi.<api call expected to fail>
252 self._expect_stack.append(self._expect_api_retval)
253 self._expect_api_retval = self._negative
256 def assert_zero_api_retval(self):
257 """ Expect API success - used with with, e.g.:
258 with self.vapi.assert_negative_api_retval():
259 self.vapi.<api call expected to succeed>
261 note: this is useful only inside another with block
262 as success is the default expected value
264 self._expect_stack.append(self._expect_api_retval)
265 self._expect_api_retval = self._zero
268 def __exit__(self, exc_type, exc_value, traceback):
269 self._expect_api_retval = self._expect_stack.pop()
271 def register_hook(self, hook):
272 """Replace hook registration with new hook
279 def collect_events(self):
280 """ Collect all events from the internal queue and clear the queue. """
282 self._events = deque()
285 def wait_for_event(self, timeout, name=None):
286 """ Wait for and return next event. """
288 self.test_class.logger.debug("Expecting event '%s' within %ss",
291 self.test_class.logger.debug("Expecting event within %ss",
294 self.test_class.logger.debug("Not waiting, event already queued")
295 limit = time.time() + timeout
296 while time.time() < limit:
298 e = self._events.popleft()
299 if name and type(e).__name__ != name:
301 "Unexpected event received: %s, expected: %s" %
302 (type(e).__name__, name))
303 self.test_class.logger.debug("Returning event %s:%s" %
306 time.sleep(0) # yield
307 raise Exception("Event did not occur within timeout")
309 def __call__(self, name, event):
310 """ Enqueue event in the internal event queue. """
311 # FIXME use the name instead of relying on type(e).__name__ ?
312 # FIXME #2 if this throws, it is eaten silently, Ole?
313 self.test_class.logger.debug("New event: %s: %s" % (name, event))
314 self._events.append(event)
316 def factory(self, name, apifn):
318 fields = apifn._func.msg.fields
320 # add positional and kw arguments
322 for i, o in enumerate(fields[3:]):
329 if name in defaultmapping:
330 for k, v in iteritems(defaultmapping[name]):
334 return self.api(apifn, d)
338 def __getattribute__(self, name):
340 method = super(VppPapiProvider, self).__getattribute__(name)
341 except AttributeError:
342 method = self.factory(name, getattr(self.papi, name))
343 # lazily load the method so we don't need to call factory
344 # again for this name.
345 setattr(self, name, method)
349 """Connect the API to VPP"""
350 self.vpp.connect(self.name, self.shm_prefix)
351 self.papi = self.vpp.api
352 self.vpp.register_event_callback(self)
354 def disconnect(self):
355 """Disconnect the API from VPP"""
356 self.vpp.disconnect()
358 def api(self, api_fn, api_args, expected_retval=0):
359 """ Call API function and check it's return value.
360 Call the appropriate hooks before and after the API call
362 :param api_fn: API function to call
363 :param api_args: tuple of API function arguments
364 :param expected_retval: Expected return value (Default value = 0)
365 :returns: reply from the API
368 self.hook.before_api(api_fn.__name__, api_args)
369 reply = api_fn(**api_args)
370 if self._expect_api_retval == self._negative:
371 if hasattr(reply, 'retval') and reply.retval >= 0:
372 msg = "API call passed unexpectedly: expected negative " \
373 "return value instead of %d in %s" % \
374 (reply.retval, moves.reprlib.repr(reply))
375 self.test_class.logger.info(msg)
376 raise UnexpectedApiReturnValueError(msg)
377 elif self._expect_api_retval == self._zero:
378 if hasattr(reply, 'retval') and reply.retval != expected_retval:
379 msg = "API call failed, expected %d return value instead " \
380 "of %d in %s" % (expected_retval, reply.retval,
381 moves.reprlib.repr(reply))
382 self.test_class.logger.info(msg)
383 raise UnexpectedApiReturnValueError(msg)
385 raise Exception("Internal error, unexpected value for "
386 "self._expect_api_retval %s" %
387 self._expect_api_retval)
388 self.hook.after_api(api_fn.__name__, api_args)
392 """ Execute a CLI, calling the before/after hooks appropriately.
394 :param cli: CLI to execute
398 self.hook.before_cli(cli)
400 r = self.papi.cli_inband(cmd=cli)
401 self.hook.after_cli(cli)
402 if hasattr(r, 'reply'):
405 def ppcli(self, cli):
406 """ Helper method to print CLI command in case of info logging level.
408 :param cli: CLI to execute
411 return cli + "\n" + str(self.cli(cli))
413 def set_ip_flow_hash(self,
422 return self.api(self.papi.set_ip_flow_hash,
432 def sw_interface_ip6nd_ra_prefix(self,
442 val_lifetime=0xffffffff,
443 pref_lifetime=0xffffffff):
444 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
445 {'sw_if_index': sw_if_index,
448 'address_length': address_length,
450 'use_default': use_default,
451 'no_advertise': no_advertise,
452 'off_link': off_link,
453 'no_autoconfig': no_autoconfig,
454 'no_onlink': no_onlink,
456 'val_lifetime': val_lifetime,
457 'pref_lifetime': pref_lifetime})
459 def vxlan_add_del_tunnel(
463 mcast_sw_if_index=0xFFFFFFFF,
467 decap_next_index=0xFFFFFFFF,
469 instance=0xFFFFFFFF):
474 :param is_add: (Default value = 1)
475 :param is_ipv6: (Default value = 0)
476 :param encap_vrf_id: (Default value = 0)
477 :param decap_next_index: (Default value = 0xFFFFFFFF)
478 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
479 :param vni: (Default value = 0)
480 :param instance: (Default value = 0xFFFFFFFF)
483 return self.api(self.papi.vxlan_add_del_tunnel,
486 'src_address': src_addr,
487 'dst_address': dst_addr,
488 'mcast_sw_if_index': mcast_sw_if_index,
489 'encap_vrf_id': encap_vrf_id,
490 'decap_next_index': decap_next_index,
492 'instance': instance})
494 def geneve_add_del_tunnel(
498 mcast_sw_if_index=0xFFFFFFFF,
502 decap_next_index=0xFFFFFFFF,
508 :param is_add: (Default value = 1)
509 :param is_ipv6: (Default value = 0)
510 :param encap_vrf_id: (Default value = 0)
511 :param decap_next_index: (Default value = 0xFFFFFFFF)
512 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
513 :param vni: (Default value = 0)
516 return self.api(self.papi.geneve_add_del_tunnel,
519 'local_address': local_addr,
520 'remote_address': remote_addr,
521 'mcast_sw_if_index': mcast_sw_if_index,
522 'encap_vrf_id': encap_vrf_id,
523 'decap_next_index': decap_next_index,
526 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
527 learn=1, arp_term=0, is_add=1):
528 """Create/delete bridge domain.
530 :param int bd_id: Bridge domain index.
531 :param int flood: Enable/disable bcast/mcast flooding in the BD.
533 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
535 :param int forward: Enable/disable forwarding on all interfaces in
536 the BD. (Default value = 1)
537 :param int learn: Enable/disable learning on all interfaces in the BD.
539 :param int arp_term: Enable/disable arp termination in the BD.
541 :param int is_add: Add or delete flag. (Default value = 1)
543 return self.api(self.papi.bridge_domain_add_del,
546 'uu_flood': uu_flood,
549 'arp_term': arp_term,
552 def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
553 return self.api(self.papi.want_ip4_arp_events,
554 {'enable_disable': enable_disable,
556 'pid': os.getpid(), })
558 def want_ip6_nd_events(self, enable_disable=1, ip="::"):
559 return self.api(self.papi.want_ip6_nd_events,
560 {'enable_disable': enable_disable,
562 'pid': os.getpid(), })
564 def want_ip6_ra_events(self, enable_disable=1):
565 return self.api(self.papi.want_ip6_ra_events,
566 {'enable_disable': enable_disable,
567 'pid': os.getpid(), })
569 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
571 return self.api(self.papi.ip6nd_send_router_solicitation,
576 'sw_if_index': sw_if_index})
578 def want_interface_events(self, enable_disable=1):
579 return self.api(self.papi.want_interface_events,
580 {'enable_disable': enable_disable,
581 'pid': os.getpid(), })
583 def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
584 max_macs_in_event=0, learn_limit=0):
585 return self.api(self.papi.want_l2_macs_events,
586 {'enable_disable': enable_disable,
587 'scan_delay': scan_delay,
588 'max_macs_in_event': max_macs_in_event,
589 'learn_limit': learn_limit,
590 'pid': os.getpid(), })
592 def want_dhcp6_reply_events(self, enable_disable=1):
593 return self.api(self.papi.want_dhcp6_reply_events,
594 {'enable_disable': enable_disable,
597 def want_dhcp6_pd_reply_events(self, enable_disable=1):
598 return self.api(self.papi.want_dhcp6_pd_reply_events,
599 {'enable_disable': enable_disable,
602 def dhcp6_send_client_message(self, msg_type, sw_if_index, T1, T2,
603 addresses, server_index=0xFFFFFFFF,
604 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
606 return self.api(self.papi.dhcp6_send_client_message,
607 {'sw_if_index': sw_if_index,
608 'server_index': server_index,
614 'msg_type': msg_type,
617 'n_addresses': len(addresses),
618 'addresses': addresses})
620 def dhcp6_pd_send_client_message(self, msg_type, sw_if_index, T1, T2,
621 prefixes, server_index=0xFFFFFFFF,
622 irt=0, mrt=0, mrc=1, mrd=0, stop=0,
624 return self.api(self.papi.dhcp6_pd_send_client_message,
625 {'sw_if_index': sw_if_index,
626 'server_index': server_index,
632 'msg_type': msg_type,
635 'n_prefixes': len(prefixes),
636 'prefixes': prefixes})
638 def dhcp6_client_enable_disable(self, sw_if_index, prefix_group='',
640 return self.api(self.papi.dhcp6_client_enable_disable,
641 {'sw_if_index': sw_if_index,
644 def dhcp6_pd_client_enable_disable(self, sw_if_index, prefix_group='',
646 return self.api(self.papi.dhcp6_pd_client_enable_disable,
647 {'sw_if_index': sw_if_index,
648 'prefix_group': prefix_group,
651 def ip6_add_del_address_using_prefix(self, sw_if_index, address,
652 prefix_length, prefix_group,
654 return self.api(self.papi.ip6_add_del_address_using_prefix,
655 {'sw_if_index': sw_if_index,
656 'prefix_group': prefix_group,
658 'prefix_length': prefix_length,
661 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
662 shg=0, port_type=L2_PORT_TYPE.NORMAL,
664 """Add/remove interface to/from bridge domain.
666 :param int sw_if_index: Software interface index of the interface.
667 :param int bd_id: Bridge domain index.
668 :param int shg: Split-horizon group index. (Default value = 0)
669 :param int bvi: Set interface as a bridge group virtual interface.
671 :param int enable: Add or remove interface. (Default value = 1)
673 return self.api(self.papi.sw_interface_set_l2_bridge,
674 {'rx_sw_if_index': sw_if_index,
677 'port_type': port_type,
680 def bridge_flags(self, bd_id, is_set, feature_bitmap):
681 """Enable/disable required feature of the bridge domain with defined
684 :param int bd_id: Bridge domain ID.
685 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
686 :param int flags: Bitmap value of the feature to be set:
690 - uu-flood (1 << 3) or
693 return self.api(self.papi.bridge_flags,
696 'flags': feature_bitmap})
698 def l2_interface_vlan_tag_rewrite(
705 """L2 interface vlan tag rewrite configure request
706 :param client_index - opaque cookie to identify the sender
707 :param context - sender context, to match reply w/ request
708 :param sw_if_index - interface the operation is applied to
709 :param vtr_op - Choose from l2_vtr_op_t enum values
710 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
711 :param tag1 - Needed for any push or translate vtr op
712 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
715 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
716 {'sw_if_index': sw_if_index,
722 def sw_interface_set_mac_address(self, sw_if_index, mac):
723 return self.api(self.papi.sw_interface_set_mac_address,
724 {'sw_if_index': sw_if_index,
727 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
728 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
729 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
730 """Create subinterface
731 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
733 :param sub_id: param inner_vlan:
737 :param no_tags: (Default value = 0)
738 :param one_tag: (Default value = 0)
739 :param two_tags: (Default value = 0)
740 :param dot1ad: (Default value = 0)
741 :param exact_match: (Default value = 0)
742 :param default_sub: (Default value = 0)
743 :param outer_vlan_id_any: (Default value = 0)
744 :param inner_vlan_id_any: (Default value = 0)
748 self.papi.create_subif,
749 {'sw_if_index': sw_if_index,
753 'two_tags': two_tags,
755 'exact_match': exact_match,
756 'default_sub': default_sub,
757 'outer_vlan_id_any': outer_vlan_id_any,
758 'inner_vlan_id_any': inner_vlan_id_any,
759 'outer_vlan_id': outer_vlan,
760 'inner_vlan_id': inner_vlan})
762 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
763 """Create p2p ethernet subinterface
765 :param sw_if_index: main (parent) interface
766 :param remote_mac: client (remote) mac address
770 self.papi.p2p_ethernet_add,
771 {'parent_if_index': sw_if_index,
772 'remote_mac': remote_mac,
773 'subif_id': subif_id})
775 def p2p_ethernet_del(self, sw_if_index, remote_mac):
776 """Delete p2p ethernet subinterface
778 :param sw_if_index: main (parent) interface
779 :param remote_mac: client (remote) mac address
783 self.papi.p2p_ethernet_del,
784 {'parent_if_index': sw_if_index,
785 'remote_mac': remote_mac})
787 def create_vlan_subif(self, sw_if_index, vlan):
794 return self.api(self.papi.create_vlan_subif,
795 {'sw_if_index': sw_if_index,
798 def create_loopback(self, mac=''):
801 :param mac: (Optional)
803 return self.api(self.papi.create_loopback,
804 {'mac_address': mac})
806 def ip_add_del_route(
811 next_hop_sw_if_index=0xFFFFFFFF,
815 next_hop_n_out_labels=0,
816 next_hop_out_label_stack=[],
817 next_hop_via_label=MPLS_LABEL_INVALID,
818 next_hop_id=0xFFFFFFFF,
820 is_resolve_attached=0,
821 classify_table_index=0xFFFFFFFF,
835 :param dst_address_length:
836 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
838 :param next_hop_address:
839 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
840 :param vrf_id: (Default value = 0)
841 :param lookup_in_vrf: (Default value = 0)
842 :param classify_table_index: (Default value = 0xFFFFFFFF)
843 :param is_add: (Default value = 1)
844 :param is_drop: (Default value = 0)
845 :param is_ipv6: (Default value = 0)
846 :param is_local: (Default value = 0)
847 :param is_classify: (Default value = 0)
848 :param is_multipath: (Default value = 0)
849 :param is_resolve_host: (Default value = 0)
850 :param is_resolve_attached: (Default value = 0)
851 :param is_dvr: (Default value = 0)
852 :param is_source_lookup: (Default value = 0)
853 :param next_hop_weight: (Default value = 1)
858 self.papi.ip_add_del_route,
859 {'next_hop_sw_if_index': next_hop_sw_if_index,
860 'table_id': table_id,
861 'classify_table_index': classify_table_index,
862 'next_hop_table_id': next_hop_table_id,
865 'is_unreach': is_unreach,
866 'is_prohibit': is_prohibit,
868 'is_local': is_local,
869 'is_classify': is_classify,
870 'is_multipath': is_multipath,
871 'is_resolve_host': is_resolve_host,
872 'is_resolve_attached': is_resolve_attached,
874 'is_source_lookup': is_source_lookup,
875 'is_udp_encap': is_udp_encap,
876 'next_hop_weight': next_hop_weight,
877 'dst_address_length': dst_address_length,
878 'dst_address': dst_address,
879 'next_hop_id': next_hop_id,
880 'next_hop_address': next_hop_address,
881 'next_hop_n_out_labels': next_hop_n_out_labels,
882 'next_hop_via_label': next_hop_via_label,
883 'next_hop_out_label_stack': next_hop_out_label_stack})
885 def ip_neighbor_add_del(self,
891 """ Add neighbor MAC to IPv4 or IPv6 address.
896 :param is_add: (Default value = 1)
897 :param flags: (Default value = 0/NONE)
900 self.papi.ip_neighbor_add_del,
904 'sw_if_index': sw_if_index,
906 'mac_address': mac_address,
907 'ip_address': ip_address
912 def proxy_arp_add_del(self,
917 """ Config Proxy Arp Range.
919 :param low_address: Start address in the rnage to Proxy for
920 :param hi_address: End address in the rnage to Proxy for
921 :param vrf_id: The VRF/table in which to proxy
925 self.papi.proxy_arp_add_del,
928 'table_id': table_id,
934 def proxy_arp_intfc_enable_disable(self,
937 """ Enable/Disable an interface for proxy ARP requests
939 :param sw_if_index: Interface
940 :param enable_disable: Enable/Disable
944 self.papi.proxy_arp_intfc_enable_disable,
945 {'sw_if_index': sw_if_index,
946 'enable_disable': is_enable
950 def gre_add_del_tunnel(self,
963 :param outer_fib_id: (Default value = 0)
964 :param tunnel_type: (Default value = 0)
965 :param instance: (Default value = 0xFFFFFFFF)
966 :param session_id: (Defalt value = 0)
967 :param is_add: (Default value = 1)
968 :param is_ipv6: (Default value = 0)
972 self.papi.gre_add_del_tunnel,
975 'tunnel_type': tunnel_type,
976 'instance': instance,
977 'src_address': src_address,
978 'dst_address': dst_address,
979 'outer_fib_id': outer_fib_id,
980 'session_id': session_id}
983 def udp_encap_add(self,
994 :param outer_fib_id: (Default value = 0)
998 self.papi.udp_encap_add,
1003 'src_port': src_port,
1004 'dst_port': dst_port,
1005 'table_id': table_id
1009 def mpls_table_add_del(
1016 :param is_add: (Default value = 1)
1021 self.papi.mpls_table_add_del,
1022 {'mt_table_id': table_id,
1023 'mt_is_add': is_add})
1025 def mpls_route_add_del(
1031 next_hop_sw_if_index=0xFFFFFFFF,
1033 next_hop_table_id=0,
1035 next_hop_n_out_labels=0,
1036 next_hop_out_label_stack=[],
1037 next_hop_via_label=MPLS_LABEL_INVALID,
1039 is_resolve_attached=0,
1046 classify_table_index=0xFFFFFFFF,
1050 :param dst_address_length:
1051 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1053 :param next_hop_address:
1054 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1055 :param vrf_id: (Default value = 0)
1056 :param lookup_in_vrf: (Default value = 0)
1057 :param classify_table_index: (Default value = 0xFFFFFFFF)
1058 :param is_add: (Default value = 1)
1059 :param is_drop: (Default value = 0)
1060 :param is_ipv6: (Default value = 0)
1061 :param is_local: (Default value = 0)
1062 :param is_classify: (Default value = 0)
1063 :param is_multipath: (Default value = 0)
1064 :param is_multicast: (Default value = 0)
1065 :param is_resolve_host: (Default value = 0)
1066 :param is_resolve_attached: (Default value = 0)
1067 :param next_hop_weight: (Default value = 1)
1071 self.papi.mpls_route_add_del,
1074 'mr_table_id': table_id,
1075 'mr_classify_table_index': classify_table_index,
1076 'mr_is_add': is_add,
1077 'mr_is_classify': is_classify,
1078 'mr_is_multipath': is_multipath,
1079 'mr_is_multicast': is_multicast,
1080 'mr_is_resolve_host': is_resolve_host,
1081 'mr_is_resolve_attached': is_resolve_attached,
1082 'mr_is_interface_rx': is_interface_rx,
1083 'mr_is_rpf_id': is_rpf_id,
1084 'mr_next_hop_proto': next_hop_proto,
1085 'mr_next_hop_weight': next_hop_weight,
1086 'mr_next_hop': next_hop_address,
1087 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1088 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1089 'mr_next_hop_table_id': next_hop_table_id,
1090 'mr_next_hop_via_label': next_hop_via_label,
1091 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1093 def mpls_ip_bind_unbind(
1105 self.papi.mpls_ip_bind_unbind,
1106 {'mb_mpls_table_id': table_id,
1108 'mb_ip_table_id': ip_table_id,
1109 'mb_is_bind': is_bind,
1110 'mb_is_ip4': is_ip4,
1111 'mb_address_length': dst_address_length,
1112 'mb_address': dst_address})
1114 def mpls_tunnel_add_del(
1117 next_hop_proto_is_ip4,
1119 next_hop_sw_if_index=0xFFFFFFFF,
1120 next_hop_table_id=0,
1122 next_hop_n_out_labels=0,
1123 next_hop_out_label_stack=[],
1124 next_hop_via_label=MPLS_LABEL_INVALID,
1130 :param dst_address_length:
1131 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1133 :param next_hop_address:
1134 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1135 :param vrf_id: (Default value = 0)
1136 :param lookup_in_vrf: (Default value = 0)
1137 :param classify_table_index: (Default value = 0xFFFFFFFF)
1138 :param is_add: (Default value = 1)
1139 :param is_drop: (Default value = 0)
1140 :param is_ipv6: (Default value = 0)
1141 :param is_local: (Default value = 0)
1142 :param is_classify: (Default value = 0)
1143 :param is_multipath: (Default value = 0)
1144 :param is_resolve_host: (Default value = 0)
1145 :param is_resolve_attached: (Default value = 0)
1146 :param next_hop_weight: (Default value = 1)
1147 :param is_multicast: (Default value = 0)
1151 self.papi.mpls_tunnel_add_del,
1152 {'mt_sw_if_index': tun_sw_if_index,
1153 'mt_is_add': is_add,
1154 'mt_l2_only': l2_only,
1155 'mt_is_multicast': is_multicast,
1156 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1157 'mt_next_hop_weight': next_hop_weight,
1158 'mt_next_hop': next_hop_address,
1159 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1160 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1161 'mt_next_hop_table_id': next_hop_table_id,
1162 'mt_next_hop_via_label': next_hop_via_label,
1163 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1165 def nat44_interface_add_del_feature(
1170 """Enable/disable NAT44 feature on the interface
1172 :param sw_if_index: Software index of the interface
1173 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1174 :param is_add: 1 if add, 0 if delete (Default value = 1)
1177 self.papi.nat44_interface_add_del_feature,
1179 'is_inside': is_inside,
1180 'sw_if_index': sw_if_index})
1182 def nat44_interface_add_del_output_feature(
1187 """Enable/disable NAT44 output feature on the interface
1189 :param sw_if_index: Software index of the interface
1190 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1191 :param is_add: 1 if add, 0 if delete (Default value = 1)
1194 self.papi.nat44_interface_add_del_output_feature,
1196 'is_inside': is_inside,
1197 'sw_if_index': sw_if_index})
1199 def nat44_add_del_static_mapping(
1203 external_sw_if_index=0xFFFFFFFF,
1214 """Add/delete NAT44 static mapping
1216 :param local_ip: Local IP address
1217 :param external_ip: External IP address
1218 :param external_sw_if_index: External interface instead of IP address
1219 :param local_port: Local port number (Default value = 0)
1220 :param external_port: External port number (Default value = 0)
1221 :param addr_only: 1 if address only mapping, 0 if address and port
1222 :param vrf_id: VRF ID
1223 :param protocol: IP protocol (Default value = 0)
1224 :param twice_nat: 1 if translate external host address and port
1225 :param self_twice_nat: 1 if translate external host address and port
1226 whenever external host address equals
1227 local address of internal host
1228 :param out2in_only: if 1 rule is matching only out2in direction
1229 :param tag: Opaque string tag
1230 :param is_add: 1 if add, 0 if delete (Default value = 1)
1233 self.papi.nat44_add_del_static_mapping,
1235 'addr_only': addr_only,
1236 'local_ip_address': local_ip,
1237 'external_ip_address': external_ip,
1238 'local_port': local_port,
1239 'external_port': external_port,
1240 'external_sw_if_index': external_sw_if_index,
1242 'protocol': protocol,
1243 'twice_nat': twice_nat,
1244 'self_twice_nat': self_twice_nat,
1245 'out2in_only': out2in_only,
1248 def nat44_add_del_identity_mapping(
1251 sw_if_index=0xFFFFFFFF,
1258 """Add/delete NAT44 identity mapping
1260 :param ip: IP address (Default value = 0)
1261 :param sw_if_index: Interface instead of IP address
1262 :param port: Port number (Default value = 0)
1263 :param addr_only: 1 if address only mapping, 0 if address and port
1264 :param vrf_id: VRF ID
1265 :param protocol: IP protocol (Default value = 0)
1266 :param tag: Opaque string tag
1267 :param is_add: 1 if add, 0 if delete (Default value = 1)
1270 self.papi.nat44_add_del_identity_mapping,
1272 'addr_only': addr_only,
1275 'sw_if_index': sw_if_index,
1278 'protocol': protocol})
1280 def nat44_add_del_address_range(
1287 """Add/del NAT44 address range
1289 :param first_ip_address: First IP address
1290 :param last_ip_address: Last IP address
1291 :param vrf_id: VRF id for the address range
1292 :param twice_nat: twice NAT address for extenal hosts
1293 :param is_add: 1 if add, 0 if delete (Default value = 1)
1296 self.papi.nat44_add_del_address_range,
1297 {'first_ip_address': first_ip_address,
1298 'last_ip_address': last_ip_address,
1300 'twice_nat': twice_nat,
1303 def nat44_add_del_interface_addr(
1308 """Add/del NAT44 address from interface
1310 :param sw_if_index: Software index of the interface
1311 :param twice_nat: twice NAT address for extenal hosts
1312 :param is_add: 1 if add, 0 if delete (Default value = 1)
1315 self.papi.nat44_add_del_interface_addr,
1317 'sw_if_index': sw_if_index,
1318 'twice_nat': twice_nat})
1320 def nat44_add_del_lb_static_mapping(
1333 """Add/delete NAT44 load balancing static mapping
1335 :param twice_nat: 1 if translate external host address and port
1336 :param tag: Opaque string tag
1337 :param affinity: if 0 disabled, otherwise client IP affinity timeout
1338 :param is_add - 1 if add, 0 if delete
1341 self.papi.nat44_add_del_lb_static_mapping,
1343 'external_addr': external_addr,
1344 'external_port': external_port,
1345 'protocol': protocol,
1346 'twice_nat': twice_nat,
1347 'self_twice_nat': self_twice_nat,
1348 'out2in_only': out2in_only,
1350 'affinity': affinity,
1351 'local_num': local_num,
1354 def nat44_lb_static_mapping_add_del_local(
1364 """Add/delete NAT44 load-balancing static mapping rule backend
1366 :param external_addr: external IPv4 address of the servic
1367 :param external_port: external L4 port number of the service
1368 :param local_addr: IPv4 address of the internal node
1369 :param local_port: L4 port number of the internal node
1370 :param protocol: IP protocol number
1371 :param probability: probability of the internal node
1372 :param vrf_id: VRF id of the internal node
1373 :param is_add: 1 if add, 0 if delete
1376 self.papi.nat44_lb_static_mapping_add_del_local,
1378 'external_addr': external_addr,
1379 'external_port': external_port,
1383 'probability': probability,
1385 'protocol': protocol})
1387 def nat44_del_session(
1394 ext_host_address=None,
1396 """Delete NAT44 session
1398 :param addr: IPv4 address
1399 :param por: port number
1400 :param protocol: IP protocol number
1401 :param vrf_id: VRF ID
1402 :param is_in: 1 if inside network addres and port pari, 0 if outside
1403 :param ext_host_address: external host IPv4 address
1404 :param ext_host_port: external host port
1406 if ext_host_address is None:
1408 self.papi.nat44_del_session,
1411 'protocol': protocol,
1416 self.papi.nat44_del_session,
1419 'protocol': protocol,
1422 'ext_host_valid': 1,
1423 'ext_host_address': ext_host_address,
1424 'ext_host_port': ext_host_port})
1426 def nat44_forwarding_enable_disable(
1429 """Enable/disable forwarding for NAT44
1431 :param enable: 1 for enable, 0 for disable
1434 self.papi.nat44_forwarding_enable_disable,
1437 def nat_det_add_del_map(
1444 """Add/delete deterministic NAT mapping
1446 :param is_add - 1 if add, 0 if delete
1447 :param in_addr - inside IP address
1448 :param in_plen - inside IP address prefix length
1449 :param out_addr - outside IP address
1450 :param out_plen - outside IP address prefix length
1453 self.papi.nat_det_add_del_map,
1458 'out_addr': out_addr,
1459 'out_plen': out_plen})
1461 def nat_det_forward(
1464 """Get outside address and port range from inside address
1466 :param in_addr - inside IP address
1469 self.papi.nat_det_forward,
1470 {'in_addr': in_addr,
1473 def nat_det_reverse(
1477 """Get inside address from outside address and port
1479 :param out_addr - outside IP address
1480 :param out_port - outside port
1483 self.papi.nat_det_reverse,
1484 {'out_addr': out_addr,
1485 'out_port': out_port})
1487 def nat_det_map_dump(self):
1488 """Dump deterministic NAT mappings
1490 :return: Dictionary of deterministic NAT mappings
1492 return self.api(self.papi.nat_det_map_dump, {})
1494 def nat_set_mss_clamping(self, enable=0, mss_value=1500):
1495 """Set TCP MSS rewriting configuration
1497 :param enable: disable(0)/enable(1) MSS rewriting feature
1498 :param mss_value: MSS value to be used for MSS rewriting
1501 self.papi.nat_set_mss_clamping,
1502 {'enable': enable, 'mss_value': mss_value})
1504 def nat_det_close_session_in(
1510 """Close deterministic NAT session using inside address and port
1512 :param in_addr - inside IP address
1513 :param in_port - inside port
1514 :param ext_addr - external host IP address
1515 :param ext_port - external host port
1518 self.papi.nat_det_close_session_in,
1519 {'in_addr': in_addr,
1521 'ext_addr': ext_addr,
1522 'ext_port': ext_port,
1525 def nat_det_session_dump(
1528 """Dump deterministic NAT sessions belonging to a user
1530 :param user_addr - inside IP address of the user
1531 :return: Dictionary of deterministic NAT sessions
1534 self.papi.nat_det_session_dump,
1536 'user_addr': user_addr})
1538 def nat64_add_del_interface(
1543 """Enable/disable NAT64 feature on the interface
1544 :param sw_if_index: Index of the interface
1545 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1546 :param is_add: 1 if add, 0 if delete (Default value = 1)
1549 self.papi.nat64_add_del_interface,
1550 {'sw_if_index': sw_if_index,
1551 'is_inside': is_inside,
1554 def nat64_add_del_static_bib(
1563 """Add/delete S-NAT static BIB entry
1565 :param in_ip: Inside IPv6 address
1566 :param out_ip: Outside IPv4 address
1567 :param in_port: Inside port number
1568 :param out_port: Outside port number
1569 :param protocol: IP protocol
1570 :param vrf_id: VRF ID (Default value = 0)
1571 :param is_add: 1 if add, 0 if delete (Default value = 1)
1574 self.papi.nat64_add_del_static_bib,
1583 def nat64_bib_dump(self, protocol=255):
1586 :param protocol: IP protocol (Default value = 255, all BIBs)
1587 :returns: Dictionary of NAT64 BIB entries
1589 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1591 def nat64_st_dump(self, protocol=255):
1592 """Dump NAT64 session table
1594 :param protocol: IP protocol (Default value = 255, all STs)
1595 :returns: Dictionary of NAT64 sesstion table entries
1597 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1599 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1600 """Add/del NAT64 prefix
1602 :param prefix: NAT64 prefix
1603 :param plen: NAT64 prefix length
1604 :param vrf_id: VRF id of tenant (Default 0)
1605 :param is_add: 1 if add, 0 if delete (Default value = 1)
1608 self.papi.nat64_add_del_prefix,
1614 def nat64_add_del_interface_addr(
1618 """Add/del NAT64 address from interface
1620 :param sw_if_index: Software index of the interface
1621 :param is_add: 1 if add, 0 if delete (Default value = 1)
1623 return self.api(self.papi.nat64_add_del_interface_addr,
1624 {'is_add': is_add, 'sw_if_index': sw_if_index})
1626 def dslite_set_aftr_addr(self, ip6, ip4):
1627 """Set DS-Lite AFTR addresses
1629 :param ip4: IPv4 address
1630 :param ip6: IPv6 address
1633 self.papi.dslite_set_aftr_addr,
1637 def dslite_set_b4_addr(self, ip6, ip4):
1638 """Set DS-Lite B4 IPv6 address
1640 :param ip4: IPv4 address
1641 :param ip6: IPv6 address
1644 self.papi.dslite_set_b4_addr,
1648 def nat66_add_del_interface(
1653 """Enable/disable NAT66 feature on the interface
1654 :param sw_if_index: Index of the interface
1655 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1656 :param is_add: 1 if add, 0 if delete (Default value = 1)
1659 self.papi.nat66_add_del_interface,
1660 {'sw_if_index': sw_if_index,
1661 'is_inside': is_inside,
1664 def nat66_add_del_static_mapping(
1670 """Add/delete NAT66 static mapping
1672 :param in_ip: Inside IPv6 address
1673 :param out_ip: Outside IPv6 address
1674 :param vrf_id: VRF ID (Default value = 0)
1675 :param is_add: 1 if add, 0 if delete (Default value = 1)
1678 self.papi.nat66_add_del_static_mapping,
1679 {'local_ip_address': in_ip,
1680 'external_ip_address': out_ip,
1684 def nat_ha_set_listener(self, addr, port, path_mtu=512):
1685 """Set HA listener (local settings)
1687 :param addr: local IP4 address
1688 :param port: local UDP port number
1689 :param path_mtu: path MTU (Default value = 512)
1691 return self.api(self.papi.nat_ha_set_listener,
1692 {'ip_address': addr,
1694 'path_mtu': path_mtu})
1696 def nat_ha_get_listener(self):
1697 """Get HA listener/local configuration"""
1698 return self.api(self.papi.nat_ha_get_listener, {})
1700 def nat_ha_set_failover(self, addr, port, refresh=10):
1701 """Set HA failover (remote settings)
1703 :param addr: failover IP4 address
1704 :param port: failvoer UDP port number
1705 :param refresh: number of seconds after which to send session refresh
1707 return self.api(self.papi.nat_ha_set_failover,
1708 {'ip_address': addr,
1710 'session_refresh_interval': refresh})
1712 def nat_ha_resync(self, want_resync_event=1):
1713 """Resync HA (resend existing sessions to new failover)
1714 :param want_resync_event: if non-zero resync completed event sent
1716 return self.api(self.papi.nat_ha_resync,
1717 {'want_resync_event': want_resync_event,
1718 'pid': os.getpid()})
1720 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1721 detect_mult, local_addr, peer_addr, is_ipv6=0,
1722 bfd_key_id=None, conf_key_id=None):
1723 if bfd_key_id is None:
1724 return self.api(self.papi.bfd_udp_add,
1726 'sw_if_index': sw_if_index,
1727 'desired_min_tx': desired_min_tx,
1728 'required_min_rx': required_min_rx,
1729 'local_addr': local_addr,
1730 'peer_addr': peer_addr,
1732 'detect_mult': detect_mult,
1735 return self.api(self.papi.bfd_udp_add,
1737 'sw_if_index': sw_if_index,
1738 'desired_min_tx': desired_min_tx,
1739 'required_min_rx': required_min_rx,
1740 'local_addr': local_addr,
1741 'peer_addr': peer_addr,
1743 'detect_mult': detect_mult,
1744 'is_authenticated': 1,
1745 'bfd_key_id': bfd_key_id,
1746 'conf_key_id': conf_key_id,
1749 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1750 detect_mult, local_addr, peer_addr, is_ipv6=0):
1751 return self.api(self.papi.bfd_udp_mod,
1753 'sw_if_index': sw_if_index,
1754 'desired_min_tx': desired_min_tx,
1755 'required_min_rx': required_min_rx,
1756 'local_addr': local_addr,
1757 'peer_addr': peer_addr,
1759 'detect_mult': detect_mult,
1762 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1763 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1765 return self.api(self.papi.bfd_udp_auth_activate,
1767 'sw_if_index': sw_if_index,
1768 'local_addr': local_addr,
1769 'peer_addr': peer_addr,
1771 'is_delayed': 1 if is_delayed else 0,
1772 'bfd_key_id': bfd_key_id,
1773 'conf_key_id': conf_key_id,
1776 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1777 peer_addr, is_ipv6=0):
1778 return self.api(self.papi.bfd_udp_session_set_flags, {
1779 'admin_up_down': admin_up_down,
1780 'sw_if_index': sw_if_index,
1781 'local_addr': local_addr,
1782 'peer_addr': peer_addr,
1786 def want_bfd_events(self, enable_disable=1):
1787 return self.api(self.papi.want_bfd_events, {
1788 'enable_disable': enable_disable,
1792 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1793 return self.api(self.papi.bfd_auth_set_key, {
1794 'conf_key_id': conf_key_id,
1795 'auth_type': auth_type,
1797 'key_len': len(key),
1800 def classify_add_del_table(
1805 table_index=0xFFFFFFFF,
1807 memory_size=2097152,
1809 next_table_index=0xFFFFFFFF,
1810 miss_next_index=0xFFFFFFFF,
1811 current_data_flag=0,
1812 current_data_offset=0):
1816 :param match_n_vectors: (Default value = 1)
1817 :param table_index: (Default value = 0xFFFFFFFF)
1818 :param nbuckets: (Default value = 2)
1819 :param memory_size: (Default value = 2097152)
1820 :param skip_n_vectors: (Default value = 0)
1821 :param next_table_index: (Default value = 0xFFFFFFFF)
1822 :param miss_next_index: (Default value = 0xFFFFFFFF)
1823 :param current_data_flag: (Default value = 0)
1824 :param current_data_offset: (Default value = 0)
1827 mask_len = ((len(mask) - 1) / 16 + 1) * 16
1828 mask = mask + '\0' * (mask_len - len(mask))
1830 self.papi.classify_add_del_table,
1832 'table_index': table_index,
1833 'nbuckets': nbuckets,
1834 'memory_size': memory_size,
1835 'skip_n_vectors': skip_n_vectors,
1836 'match_n_vectors': match_n_vectors,
1837 'next_table_index': next_table_index,
1838 'miss_next_index': miss_next_index,
1839 'current_data_flag': current_data_flag,
1840 'current_data_offset': current_data_offset,
1841 'mask_len': mask_len,
1844 def classify_add_del_session(
1849 opaque_index=0xFFFFFFFF,
1850 hit_next_index=0xFFFFFFFF,
1858 :param opaque_index: (Default value = 0xFFFFFFFF)
1859 :param hit_next_index: (Default value = 0xFFFFFFFF)
1860 :param advance: (Default value = 0)
1861 :param action: (Default value = 0)
1862 :param metadata: (Default value = 0)
1865 match_len = ((len(match) - 1) / 16 + 1) * 16
1866 match = match + '\0' * (match_len - len(match))
1868 self.papi.classify_add_del_session,
1870 'table_index': table_index,
1871 'hit_next_index': hit_next_index,
1872 'opaque_index': opaque_index,
1875 'metadata': metadata,
1876 'match_len': match_len,
1879 def input_acl_set_interface(
1883 ip4_table_index=0xFFFFFFFF,
1884 ip6_table_index=0xFFFFFFFF,
1885 l2_table_index=0xFFFFFFFF):
1889 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1890 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1891 :param l2_table_index: (Default value = 0xFFFFFFFF)
1895 self.papi.input_acl_set_interface,
1896 {'sw_if_index': sw_if_index,
1897 'ip4_table_index': ip4_table_index,
1898 'ip6_table_index': ip6_table_index,
1899 'l2_table_index': l2_table_index,
1902 def output_acl_set_interface(
1906 ip4_table_index=0xFFFFFFFF,
1907 ip6_table_index=0xFFFFFFFF,
1908 l2_table_index=0xFFFFFFFF):
1912 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1913 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1914 :param l2_table_index: (Default value = 0xFFFFFFFF)
1918 self.papi.output_acl_set_interface,
1919 {'sw_if_index': sw_if_index,
1920 'ip4_table_index': ip4_table_index,
1921 'ip6_table_index': ip6_table_index,
1922 'l2_table_index': l2_table_index,
1925 def set_ipfix_exporter(
1932 collector_port=4739,
1935 self.papi.set_ipfix_exporter,
1937 'collector_address': collector_address,
1938 'collector_port': collector_port,
1939 'src_address': src_address,
1941 'path_mtu': path_mtu,
1942 'template_interval': template_interval,
1943 'udp_checksum': udp_checksum,
1946 def dhcp_proxy_config(self,
1954 self.papi.dhcp_proxy_config,
1956 'rx_vrf_id': rx_table_id,
1957 'server_vrf_id': server_table_id,
1960 'dhcp_server': dhcp_server,
1961 'dhcp_src_address': dhcp_src_address,
1964 def dhcp_proxy_set_vss(self,
1973 self.papi.dhcp_proxy_set_vss,
1976 'vss_type': vss_type,
1977 'vpn_ascii_id': vpn_ascii_id,
1979 'vpn_index': vpn_index,
1984 def dhcp_client_config(self,
1989 set_broadcast_flag=1,
1990 want_dhcp_events=0):
1992 self.papi.dhcp_client_config,
1996 'sw_if_index': sw_if_index,
1997 'hostname': hostname,
1999 'want_dhcp_event': want_dhcp_events,
2000 'set_broadcast_flag': set_broadcast_flag,
2004 def ip_mroute_add_del(self,
2010 next_hop_sw_if_index,
2020 IP Multicast Route add/del
2023 self.papi.ip_mroute_add_del,
2024 {'next_hop_sw_if_index': next_hop_sw_if_index,
2025 'entry_flags': e_flags,
2026 'itf_flags': i_flags,
2027 'table_id': table_id,
2031 'is_local': is_local,
2032 'bier_imp': bier_imp,
2033 'next_hop_afi': next_hop_afi,
2034 'grp_address_length': grp_address_length,
2035 'grp_address': grp_address,
2036 'src_address': src_address,
2037 'nh_address': next_hop_address})
2039 def lisp_enable_disable(self, is_enabled):
2041 self.papi.lisp_enable_disable,
2043 'is_en': is_enabled,
2046 def lisp_add_del_locator_set(self,
2050 self.papi.lisp_add_del_locator_set,
2053 'locator_set_name': ls_name
2056 def lisp_add_del_locator(self,
2063 self.papi.lisp_add_del_locator,
2066 'locator_set_name': ls_name,
2067 'sw_if_index': sw_if_index,
2068 'priority': priority,
2072 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2074 self.papi.lisp_locator_dump,
2076 'is_index_set': is_index_set,
2078 'ls_index': ls_index,
2081 def lisp_add_del_local_eid(self,
2091 self.papi.lisp_add_del_local_eid,
2093 'locator_set_name': ls_name,
2095 'eid_type': eid_type,
2097 'prefix_len': prefix_len,
2103 def lisp_eid_table_dump(self,
2111 self.papi.lisp_eid_table_dump,
2114 'prefix_length': prefix_length,
2116 'eid_type': eid_type,
2118 'filter': filter_opt,
2121 def lisp_add_del_remote_mapping(self,
2131 self.papi.lisp_add_del_remote_mapping,
2134 'eid_type': eid_type,
2136 'eid_len': eid_prefix_len,
2137 'rloc_num': rlocs_num,
2140 'is_src_dst': is_src_dst,
2143 def lisp_add_del_adjacency(self,
2152 self.papi.lisp_add_del_adjacency,
2156 'eid_type': eid_type,
2159 'leid_len': leid_len,
2160 'reid_len': reid_len,
2163 def gtpu_add_del_tunnel(
2169 mcast_sw_if_index=0xFFFFFFFF,
2171 decap_next_index=0xFFFFFFFF,
2175 :param is_add: (Default value = 1)
2176 :param is_ipv6: (Default value = 0)
2179 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2180 :param encap_vrf_id: (Default value = 0)
2181 :param decap_next_index: (Default value = 0xFFFFFFFF)
2182 :param teid: (Default value = 0)
2185 return self.api(self.papi.gtpu_add_del_tunnel,
2188 'src_address': src_addr,
2189 'dst_address': dst_addr,
2190 'mcast_sw_if_index': mcast_sw_if_index,
2191 'encap_vrf_id': encap_vrf_id,
2192 'decap_next_index': decap_next_index,
2195 def vxlan_gpe_add_del_tunnel(
2199 mcast_sw_if_index=0xFFFFFFFF,
2210 :param is_add: (Default value = 1)
2211 :param is_ipv6: (Default value = 0)
2212 :param encap_vrf_id: (Default value = 0)
2213 :param decap_vrf_id: (Default value = 0)
2214 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2215 :param protocol: (Default value = 3)
2216 :param vni: (Default value = 0)
2219 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2224 'mcast_sw_if_index': mcast_sw_if_index,
2225 'encap_vrf_id': encap_vrf_id,
2226 'decap_vrf_id': decap_vrf_id,
2227 'protocol': protocol,
2230 def vxlan_gbp_tunnel_add_del(
2234 mcast_sw_if_index=0xFFFFFFFF,
2239 instance=0xFFFFFFFF):
2244 :param is_add: (Default value = 1)
2245 :param is_ipv6: (Default value = 0)
2246 :param encap_table_id: (Default value = 0)
2247 :param decap_next_index: (Default value = 0xFFFFFFFF)
2248 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2249 :param vni: (Default value = 0)
2250 :param instance: (Default value = 0xFFFFFFFF)
2253 return self.api(self.papi.vxlan_gbp_tunnel_add_del,
2258 'mcast_sw_if_index': mcast_sw_if_index,
2259 'encap_table_id': encap_table_id,
2261 'instance': instance}})
2263 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
2264 return self.api(self.papi.vxlan_gbp_tunnel_dump,
2265 {'sw_if_index': sw_if_index,
2266 '_no_type_conversion': True})
2268 def pppoe_add_del_session(
2278 :param is_add: (Default value = 1)
2279 :param is_ipv6: (Default value = 0)
2281 :param session_id: (Default value = 0)
2283 :param decap_vrf_id: (Default value = 0)
2286 return self.api(self.papi.pppoe_add_del_session,
2289 'session_id': session_id,
2290 'client_ip': client_ip,
2291 'decap_vrf_id': decap_vrf_id,
2292 'client_mac': client_mac})
2294 def sr_mpls_policy_add(self, bsid, weight, type, segments):
2295 return self.api(self.papi.sr_mpls_policy_add,
2299 'n_segments': len(segments),
2300 'segments': segments})
2302 def sr_mpls_policy_del(self, bsid):
2303 return self.api(self.papi.sr_mpls_policy_del,
2306 def sr_localsid_add_del(self,
2313 sw_if_index=0xFFFFFFFF,
2317 """ Add/del IPv6 SR local-SID.
2320 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2321 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2324 :param is_del: (Default value = 0)
2325 :param end_psp: (Default value = 0)
2326 :param sw_if_index: (Default value = 0xFFFFFFFF)
2327 :param vlan_index: (Default value = 0)
2328 :param fib_table: (Default value = 0)
2331 self.papi.sr_localsid_add_del,
2333 'localsid': localsid,
2335 'behavior': behavior,
2336 'sw_if_index': sw_if_index,
2337 'vlan_index': vlan_index,
2338 'fib_table': fib_table,
2339 'nh_addr4': nh_addr4,
2340 'nh_addr6': nh_addr6
2354 :param bsid_addr: bindingSID of the SR Policy
2355 :param weight: weight of the sid list. optional. (default: 1)
2356 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2358 :param type: type/behavior of the SR policy. (default or spray) \
2360 :param fib_table: VRF where to install the FIB entry for the BSID \
2362 :param n_segments: number of segments \
2364 :param segments: a vector of IPv6 address composing the segment list \
2368 self.papi.sr_policy_add,
2369 {'bsid_addr': bsid_addr,
2371 'is_encap': is_encap,
2373 'fib_table': fib_table,
2374 'n_segments': n_segments,
2375 'segments': segments
2384 :param bsid: bindingSID of the SR Policy
2385 :param sr_policy_index: index of the sr policy (default: 0)
2388 self.papi.sr_policy_del,
2389 {'bsid_addr': bsid_addr,
2390 'sr_policy_index': sr_policy_index
2393 def sr_steering_add_del(
2404 Steer traffic L2 and L3 traffic through a given SR policy
2406 :param is_del: delete or add
2407 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2408 :param sr_policy: is the index of the SR Policy (alt to bsid)
2409 :param table_id: is the VRF where to install the FIB entry for the BSID
2410 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2411 :param mask_width: is the mask for L3 traffic type
2412 :param sw_if_index: is the incoming interface for L2 traffic
2413 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2416 self.papi.sr_steering_add_del,
2418 'bsid_addr': bsid_addr,
2419 'sr_policy_index': sr_policy_index,
2420 'table_id': table_id,
2421 'prefix_addr': prefix_addr,
2422 'mask_width': mask_width,
2423 'sw_if_index': sw_if_index,
2424 'traffic_type': traffic_type
2427 def acl_add_replace(self, acl_index, r, tag='',
2429 """Add/replace an ACL
2430 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2431 :param acl_rule r: ACL rules array.
2432 :param str tag: symbolic tag (description) for this ACL.
2433 :param int count: number of rules.
2435 return self.api(self.papi.acl_add_replace,
2436 {'acl_index': acl_index,
2440 expected_retval=expected_retval)
2442 def acl_del(self, acl_index, expected_retval=0):
2448 return self.api(self.papi.acl_del,
2449 {'acl_index': acl_index},
2450 expected_retval=expected_retval)
2452 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2454 return self.api(self.papi.acl_interface_set_acl_list,
2455 {'sw_if_index': sw_if_index,
2459 expected_retval=expected_retval)
2461 def acl_interface_set_etype_whitelist(self, sw_if_index,
2464 return self.api(self.papi.acl_interface_set_etype_whitelist,
2465 {'sw_if_index': sw_if_index,
2466 'count': len(whitelist),
2468 'whitelist': whitelist},
2469 expected_retval=expected_retval)
2471 def acl_interface_add_del(self,
2475 """ Add/Delete ACL to/from interface
2479 :param is_add: (Default value = 1)
2482 return self.api(self.papi.acl_interface_add_del,
2485 'sw_if_index': sw_if_index,
2486 'acl_index': acl_index})
2488 def acl_dump(self, acl_index, expected_retval=0):
2489 return self.api(self.papi.acl_dump,
2490 {'acl_index': acl_index},
2491 expected_retval=expected_retval)
2493 def acl_interface_list_dump(self, sw_if_index=0xFFFFFFFF,
2495 return self.api(self.papi.acl_interface_list_dump,
2496 {'sw_if_index': sw_if_index},
2497 expected_retval=expected_retval)
2499 def macip_acl_add(self, rules, tag=""):
2502 :param rules: list of rules for given acl
2506 return self.api(self.papi.macip_acl_add,
2508 'count': len(rules),
2511 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2514 :param rules: list of rules for given acl
2518 return self.api(self.papi.macip_acl_add_replace,
2519 {'acl_index': acl_index,
2521 'count': len(rules),
2524 def macip_acl_interface_add_del(self,
2528 """ Add MACIP acl to interface
2532 :param is_add: (Default value = 1)
2535 return self.api(self.papi.macip_acl_interface_add_del,
2537 'sw_if_index': sw_if_index,
2538 'acl_index': acl_index})
2540 def macip_acl_dump(self, acl_index=4294967295):
2541 """ Return MACIP acl dump
2545 self.papi.macip_acl_dump, {'acl_index': acl_index})
2547 def policer_add_del(self,
2558 conform_action_type=1,
2560 exceed_action_type=0,
2562 violate_action_type=0,
2564 return self.api(self.papi.policer_add_del,
2571 'rate_type': rate_type,
2572 'round_type': round_type,
2574 'color_aware': color_aware,
2575 'conform_action_type': conform_action_type,
2576 'conform_dscp': conform_dscp,
2577 'exceed_action_type': exceed_action_type,
2578 'exceed_dscp': exceed_dscp,
2579 'violate_action_type': violate_action_type,
2580 'violate_dscp': violate_dscp})
2582 def ip_punt_police(self,
2586 return self.api(self.papi.ip_punt_police,
2587 {'policer_index': policer_index,
2591 def ip_punt_redirect(self,
2596 return self.api(self.papi.ip_punt_redirect,
2597 {'punt': {'rx_sw_if_index': rx_sw_if_index,
2598 'tx_sw_if_index': tx_sw_if_index,
2602 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
2603 return self.api(self.papi.ip_punt_redirect_dump,
2604 {'sw_if_index': sw_if_index,
2605 'is_ipv6': is_ipv6})
2607 def bier_table_add_del(self,
2611 """ BIER Table add/del """
2613 self.papi.bier_table_add_del,
2614 {'bt_tbl_id': {"bt_set": bti.set_id,
2615 "bt_sub_domain": bti.sub_domain_id,
2616 "bt_hdr_len_id": bti.hdr_len_id},
2617 'bt_label': mpls_label,
2618 'bt_is_add': is_add})
2620 def bier_table_dump(self):
2621 return self.api(self.papi.bier_table_dump, {})
2623 def bier_route_add_del(self,
2629 """ BIER Route add/del """
2631 self.papi.bier_route_add_del,
2632 {'br_tbl_id': {"bt_set": bti.set_id,
2633 "bt_sub_domain": bti.sub_domain_id,
2634 "bt_hdr_len_id": bti.hdr_len_id},
2636 'br_n_paths': len(paths),
2638 'br_is_add': is_add,
2639 'br_is_replace': is_replace})
2641 def bier_route_dump(self, bti):
2643 self.papi.bier_route_dump,
2644 {'br_tbl_id': {"bt_set": bti.set_id,
2645 "bt_sub_domain": bti.sub_domain_id,
2646 "bt_hdr_len_id": bti.hdr_len_id}})
2648 def bier_imp_add(self,
2653 """ BIER Imposition Add """
2655 self.papi.bier_imp_add,
2656 {'bi_tbl_id': {"bt_set": bti.set_id,
2657 "bt_sub_domain": bti.sub_domain_id,
2658 "bt_hdr_len_id": bti.hdr_len_id},
2660 'bi_n_bytes': len(ibytes),
2661 'bi_bytes': ibytes})
2663 def bier_imp_del(self, bi_index):
2664 """ BIER Imposition del """
2666 self.papi.bier_imp_del,
2667 {'bi_index': bi_index})
2669 def bier_imp_dump(self):
2670 return self.api(self.papi.bier_imp_dump, {})
2672 def bier_disp_table_add_del(self,
2675 """ BIER Disposition Table add/del """
2677 self.papi.bier_disp_table_add_del,
2678 {'bdt_tbl_id': bdti,
2679 'bdt_is_add': is_add})
2681 def bier_disp_table_dump(self):
2682 return self.api(self.papi.bier_disp_table_dump, {})
2684 def bier_disp_entry_add_del(self,
2694 """ BIER Route add/del """
2696 while (len(lstack) < 16):
2699 self.papi.bier_disp_entry_add_del,
2700 {'bde_tbl_id': bdti,
2702 'bde_payload_proto': payload_proto,
2704 'bde_paths': [{'next_hop': next_hop,
2705 'table_id': next_hop_tbl_id,
2706 'afi': next_hop_afi,
2707 'rpf_id': next_hop_rpf_id,
2709 'label_stack': lstack}],
2710 'bde_is_add': is_add})
2712 def bier_disp_entry_dump(self, bdti):
2714 self.papi.bier_disp_entry_dump,
2715 {'bde_tbl_id': bdti})
2717 def session_enable_disable(self, is_enabled):
2719 self.papi.session_enable_disable,
2720 {'is_enable': is_enabled})
2722 def ipsec_spd_add_del(self, spd_id, is_add=1):
2723 """ SPD add/del - Wrapper to add or del ipsec SPD
2724 Sample CLI : 'ipsec spd add 1'
2726 :param spd_id - SPD ID to be created in the vpp . mandatory
2727 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2729 :returns: reply from the API
2732 self.papi.ipsec_spd_add_del, {
2733 'spd_id': spd_id, 'is_add': is_add})
2735 def ipsec_spds_dump(self):
2736 return self.api(self.papi.ipsec_spds_dump, {})
2738 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2739 """ IPSEC interface SPD add/del - \
2740 Wrapper to associate/disassociate SPD to interface in VPP
2741 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2743 :param spd_id - SPD ID to associate with the interface . mandatory
2744 :param sw_if_index - Interface Index which needs to ipsec \
2745 association mandatory
2746 :param is_add - add(1) or del(0) association with interface \
2747 (Default 1 - add) . optional
2748 :returns: reply from the API
2751 self.papi.ipsec_interface_add_del_spd,
2752 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
2754 def ipsec_spd_interface_dump(self, spd_index=None):
2755 return self.api(self.papi.ipsec_spd_interface_dump,
2756 {'spd_index': spd_index if spd_index else 0,
2757 'spd_index_valid': 1 if spd_index else 0})
2759 def ipsec_sad_entry_add_del(self,
2762 integrity_algorithm,
2767 tunnel_src_address='',
2768 tunnel_dst_address='',
2771 """ IPSEC SA add/del
2772 :param sad_id: security association ID
2773 :param spi: security param index of the SA in decimal
2774 :param integrity_algorithm:
2775 :param integrity_key:
2776 :param crypto_algorithm:
2778 :param protocol: AH(0) or ESP(1) protocol
2779 :param tunnel_src_address: tunnel mode outer src address
2780 :param tunnel_dst_address: tunnel mode outer dst address
2783 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
2784 crypto and ipsec algorithms
2787 self.papi.ipsec_sad_entry_add_del,
2794 'tunnel_src': tunnel_src_address,
2795 'tunnel_dst': tunnel_dst_address,
2796 'protocol': protocol,
2797 'integrity_algorithm': integrity_algorithm,
2799 'length': len(integrity_key),
2800 'data': integrity_key,
2802 'crypto_algorithm': crypto_algorithm,
2804 'length': len(crypto_key),
2811 def ipsec_sa_dump(self, sa_id=None):
2812 return self.api(self.papi.ipsec_sa_dump,
2813 {'sa_id': sa_id if sa_id else 0xffffffff})
2815 def ipsec_spd_entry_add_del(self,
2818 local_address_start,
2820 remote_address_start,
2821 remote_address_stop,
2823 local_port_stop=65535,
2824 remote_port_start=0,
2825 remote_port_stop=65535,
2833 """ IPSEC policy SPD add/del -
2834 Wrapper to configure ipsec SPD policy entries in VPP
2835 :param spd_id: SPD ID for the policy
2836 :param local_address_start: local-ip-range start address
2837 :param local_address_stop : local-ip-range stop address
2838 :param remote_address_start: remote-ip-range start address
2839 :param remote_address_stop : remote-ip-range stop address
2840 :param local_port_start: (Default value = 0)
2841 :param local_port_stop: (Default value = 65535)
2842 :param remote_port_start: (Default value = 0)
2843 :param remote_port_stop: (Default value = 65535)
2844 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
2845 :param sa_id: Security Association ID for mapping it to SPD
2846 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
2848 :param priority: value for the spd action (Default value = 100)
2849 :param is_outbound: flag for inbound(0) or outbound(1)
2851 :param is_add: (Default value = 1)
2854 self.papi.ipsec_spd_entry_add_del,
2861 'local_address_start': local_address_start,
2862 'local_address_stop': local_address_stop,
2863 'remote_address_start': remote_address_start,
2864 'remote_address_stop': remote_address_stop,
2865 'local_port_start': local_port_start,
2866 'local_port_stop': local_port_stop,
2867 'remote_port_start': remote_port_start,
2868 'remote_port_stop': remote_port_stop,
2869 'protocol': protocol,
2871 'priority': priority,
2872 'is_outbound': is_outbound,
2873 'is_ip_any': is_ip_any
2877 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
2878 return self.api(self.papi.ipsec_spd_dump,
2882 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
2883 remote_spi, crypto_alg, local_crypto_key,
2884 remote_crypto_key, integ_alg, local_integ_key,
2885 remote_integ_key, is_add=1, esn=0,
2886 anti_replay=1, renumber=0, show_instance=0):
2888 self.papi.ipsec_tunnel_if_add_del,
2889 {'local_ip': local_ip, 'remote_ip': remote_ip,
2890 'local_spi': local_spi, 'remote_spi': remote_spi,
2891 'crypto_alg': crypto_alg,
2892 'local_crypto_key_len': len(local_crypto_key),
2893 'local_crypto_key': local_crypto_key,
2894 'remote_crypto_key_len': len(remote_crypto_key),
2895 'remote_crypto_key': remote_crypto_key, 'integ_alg': integ_alg,
2896 'local_integ_key_len': len(local_integ_key),
2897 'local_integ_key': local_integ_key,
2898 'remote_integ_key_len': len(remote_integ_key),
2899 'remote_integ_key': remote_integ_key, 'is_add': is_add,
2900 'esn': esn, 'anti_replay': anti_replay, 'renumber': renumber,
2901 'show_instance': show_instance
2904 def ipsec_select_backend(self, protocol, index):
2905 return self.api(self.papi.ipsec_select_backend,
2906 {'protocol': protocol, 'index': index})
2908 def ipsec_backend_dump(self):
2909 return self.api(self.papi.ipsec_backend_dump, {})
2911 def app_namespace_add_del(self,
2915 sw_if_index=0xFFFFFFFF,
2918 self.papi.app_namespace_add_del,
2920 'sw_if_index': sw_if_index,
2921 'ip4_fib_id': ip4_fib_id,
2922 'ip6_fib_id': ip6_fib_id,
2923 'namespace_id': namespace_id,
2924 'namespace_id_len': len(namespace_id)})
2926 def punt_socket_register(self, port, pathname, protocol=0x11,
2927 header_version=1, is_ip4=1):
2928 """ Register punt socket """
2929 return self.api(self.papi.punt_socket_register,
2930 {'header_version': header_version,
2931 'punt': {'ipv': is_ip4,
2932 'l4_protocol': protocol,
2934 'pathname': pathname})
2936 def punt_socket_deregister(self, port, protocol=0x11, is_ip4=1):
2937 """ Unregister punt socket """
2938 return self.api(self.papi.punt_socket_deregister,
2939 {'punt': {'ipv': is_ip4,
2940 'l4_protocol': protocol,
2943 def punt_socket_dump(self, is_ip6=1):
2944 """ Dump punt socket"""
2945 return self.api(self.papi.punt_socket_dump,
2946 {'is_ipv6': is_ip6})
2948 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
2950 """ GBP endpoint Add """
2951 return self.api(self.papi.gbp_endpoint_add,
2953 'sw_if_index': sw_if_index,
2964 def gbp_endpoint_del(self, handle):
2965 """ GBP endpoint Del """
2966 return self.api(self.papi.gbp_endpoint_del,
2969 def gbp_endpoint_dump(self):
2970 """ GBP endpoint Dump """
2971 return self.api(self.papi.gbp_endpoint_dump,
2972 {'_no_type_conversion': True})
2974 def gbp_endpoint_group_add(self, vnid, sclass, bd,
2975 rd, uplink_sw_if_index,
2977 """ GBP endpoint group Add """
2978 return self.api(self.papi.gbp_endpoint_group_add,
2981 'uplink_sw_if_index': uplink_sw_if_index,
2986 'retention': retention
2989 def gbp_endpoint_group_del(self, sclass):
2990 """ GBP endpoint group Del """
2991 return self.api(self.papi.gbp_endpoint_group_del,
2994 def gbp_bridge_domain_add(self, bd_id, flags,
2997 bm_flood_sw_if_index):
2998 """ GBP bridge-domain Add """
2999 return self.api(self.papi.gbp_bridge_domain_add,
3003 'bvi_sw_if_index': bvi_sw_if_index,
3004 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
3005 'bm_flood_sw_if_index': bm_flood_sw_if_index,
3009 def gbp_bridge_domain_del(self, bd_id):
3010 """ GBP bridge-domain Del """
3011 return self.api(self.papi.gbp_bridge_domain_del,
3014 def gbp_route_domain_add(self, rd_id,
3018 ip6_uu_sw_if_index):
3019 """ GBP route-domain Add """
3020 return self.api(self.papi.gbp_route_domain_add,
3023 'ip4_table_id': ip4_table_id,
3024 'ip6_table_id': ip6_table_id,
3025 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
3026 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
3030 def gbp_route_domain_del(self, rd_id):
3031 """ GBP route-domain Del """
3032 return self.api(self.papi.gbp_route_domain_del,
3035 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
3036 """ GBP recirc Add/Del """
3037 return self.api(self.papi.gbp_recirc_add_del,
3041 'sw_if_index': sw_if_index,
3044 def gbp_recirc_dump(self):
3045 """ GBP recirc Dump """
3046 return self.api(self.papi.gbp_recirc_dump, {})
3048 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id):
3049 """ GBP recirc Add/Del """
3050 return self.api(self.papi.gbp_ext_itf_add_del,
3053 'sw_if_index': sw_if_index,
3057 def gbp_ext_itf_dump(self):
3058 """ GBP recirc Dump """
3059 return self.api(self.papi.gbp_ext_itf_dump, {})
3061 def gbp_subnet_add_del(self, is_add, rd_id,
3063 sw_if_index=0xffffffff,
3065 """ GBP Subnet Add/Del """
3066 return self.api(self.papi.gbp_subnet_add_del,
3070 'sw_if_index': sw_if_index,
3075 def gbp_subnet_dump(self):
3076 """ GBP Subnet Dump """
3077 return self.api(self.papi.gbp_subnet_dump,
3078 {'_no_type_conversion': True})
3080 def gbp_contract_add_del(self, is_add, sclass, dclass, acl_index,
3081 rules, allowed_ethertypes):
3082 """ GBP contract Add/Del """
3083 return self.api(self.papi.gbp_contract_add_del,
3086 'acl_index': acl_index,
3089 'n_rules': len(rules),
3091 'n_ether_types': len(allowed_ethertypes),
3092 'allowed_ethertypes': allowed_ethertypes}})
3094 def gbp_contract_dump(self):
3095 """ GBP contract Dump """
3096 return self.api(self.papi.gbp_contract_dump, {})
3098 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
3099 """ GBP VXLAN tunnel add """
3100 return self.api(self.papi.gbp_vxlan_tunnel_add,
3105 'bd_rd_id': bd_rd_id,
3110 def gbp_vxlan_tunnel_del(self, vni):
3111 """ GBP VXLAN tunnel del """
3112 return self.api(self.papi.gbp_vxlan_tunnel_del,
3117 def gbp_vxlan_tunnel_dump(self):
3118 """ GBP VXLAN tunnel add/del """
3119 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
3121 def qos_egress_map_update(self, id, outputs):
3122 """ QOS egress map update """
3123 return self.api(self.papi.qos_egress_map_update,
3127 def qos_egress_map_delete(self, id):
3128 """ QOS egress map delete """
3129 return self.api(self.papi.qos_egress_map_delete,
3132 def qos_mark_enable_disable(self, sw_if_index,
3136 """ QOS Mark Enable/Disable """
3137 return self.api(self.papi.qos_mark_enable_disable,
3139 'sw_if_index': sw_if_index,
3140 'output_source': output_source,
3143 def igmp_enable_disable(self, sw_if_index, enable, host):
3144 """ Enable/disable IGMP on a given interface """
3145 return self.api(self.papi.igmp_enable_disable,
3148 'sw_if_index': sw_if_index})
3150 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
3151 """ Add/del IGMP proxy device """
3152 return self.api(self.papi.igmp_proxy_device_add_del,
3153 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3156 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
3157 """ Add/del interface to/from IGMP proxy device """
3158 return self.api(self.papi.igmp_proxy_device_add_del_interface,
3159 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
3162 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
3163 """ Listen for new (S,G) on specified interface
3165 :param enable: add/del
3166 :param sw_if_index: interface sw index
3167 :param saddr: source ip4 addr
3168 :param gaddr: group ip4 addr
3170 return self.api(self.papi.igmp_listen,
3175 'sw_if_index': sw_if_index,
3176 'n_srcs': len(saddrs),
3182 def igmp_clear_interface(self, sw_if_index):
3183 """ Remove all (S,G)s from specified interface
3184 doesn't send IGMP report!
3187 self.papi.igmp_clear_interface, {
3188 'sw_if_index': sw_if_index})
3190 def want_igmp_events(self, enable=1):
3191 return self.api(self.papi.want_igmp_events, {'enable': enable,
3192 'pid': os.getpid()})
3200 interface_id=0xFFFFFFFF):
3203 :param lb: load balance
3204 :param use_custom_mac: use custom mac
3205 :param mac_address: mac address
3206 :param interface_id: custom interface ID
3209 self.papi.bond_create,
3212 'use_custom_mac': use_custom_mac,
3213 'mac_address': mac_address,
3217 def pipe_delete(self, parent_sw_if_index):
3218 return self.api(self.papi.pipe_delete,
3219 {'parent_sw_if_index': parent_sw_if_index})
3233 return self.api(self.papi.memif_create,
3236 'rx_queues': rx_queues,
3237 'tx_queues': tx_queues,
3239 'socket_id': socket_id,
3241 'ring_size': ring_size,
3242 'buffer_size': buffer_size,
3243 'hw_addr': hw_addr})
3245 def svs_table_add_del(self, af, table_id, is_add=1):
3246 return self.api(self.papi.svs_table_add_del,
3248 'table_id': table_id,
3253 def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1):
3254 return self.api(self.papi.svs_route_add_del,
3256 'table_id': table_id,
3257 'source_table_id': src_table_id,
3262 def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1):
3263 return self.api(self.papi.svs_enable_disable,
3266 'table_id': table_id,
3267 'sw_if_index': sw_if_index,
3268 'is_enable': is_enable,