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 VPPApiClient, mac_pton
15 from vpp_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID
19 # Dictionary keyed on message name to override default values for
24 'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
25 'bd_ip_mac_add_del': {'is_add': 1, },
26 'bfd_udp_add': {'is_authenticated': False, 'bfd_key_id': None,
28 'bfd_udp_auth_activate': {'bfd_key_id': None, 'conf_key_id': None,
30 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
32 'bier_disp_table_add_del': {'is_add': 1, },
33 'bier_imp_add': {'is_add': 1, },
34 'bier_route_add_del': {'is_add': 1, },
35 'bier_table_add_del': {'is_add': 1, },
36 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
37 'learn': 1, 'is_add': 1, },
39 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
40 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
41 'decap_next_index': 4294967295, },
42 'input_acl_set_interface': {'ip4_table_index': 4294967295,
43 'ip6_table_index': 4294967295,
44 'l2_table_index': 4294967295, },
45 'ip6_add_del_address_using_prefix': {'is_add': 1, },
46 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
47 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
48 'next_hop_weight': 1, 'next_hop_via_label': 1048576,
49 'classify_table_index': 4294967295, 'is_add': 1, },
50 'ip_mroute_add_del': {'is_add': 1, },
51 'ip_neighbor_add_del': {'is_add': 1, },
52 'ip_punt_police': {'is_add': 1, },
53 'ip_punt_redirect': {'is_add': 1, },
54 'ip_route_add_del': {'is_add': 1, },
55 'ipsec_interface_add_del_spd': {'is_add': 1, },
56 'ipsec_spd_add_del': {'is_add': 1, },
57 'ipsec_spd_dump': {'sa_id': 4294967295, },
58 'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
59 'remote_port_stop': 65535, 'priority': 100,
62 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
63 'l2_emulation': {'enable': 1, },
64 'l2fib_add_del': {'is_add': 1, },
65 'lisp_add_del_adjacency': {'is_add': 1, },
66 'lisp_add_del_local_eid': {'is_add': 1, },
67 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
68 'lisp_add_del_locator_set': {'is_add': 1, },
69 'lisp_add_del_remote_mapping': {'is_add': 1, },
70 'macip_acl_interface_add_del': {'is_add': 1, },
71 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
72 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
73 'mr_next_hop_weight': 1,
74 'mr_next_hop_via_label': 1048576,
76 'mr_classify_table_index': 4294967295, },
77 'mpls_table_add_del': {'is_add': 1, },
78 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
80 'next_hop_via_label': 1048576,
82 'output_acl_set_interface': {'ip4_table_index': 4294967295,
83 'ip6_table_index': 4294967295,
84 'l2_table_index': 4294967295, },
85 'pppoe_add_del_session': {'is_add': 1, },
86 'policer_add_del': {'is_add': 1, 'conform_action': {'type': 1}, },
87 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
89 'set_ipfix_exporter': {'collector_port': 4739, },
90 'sr_policy_add': {'weight': 1, 'is_encap': 1, },
91 'sw_interface_add_del_address': {'is_add': 1, },
92 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
93 'pref_lifetime': 4294967295, },
94 'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
95 'sw_interface_set_l2_bridge': {'enable': 1, },
96 'sw_interface_set_mpls_enable': {'enable': 1, },
97 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
98 'sw_interface_set_unnumbered': {'is_add': 1, },
99 'sw_interface_span_enable_disable': {'state': 1, },
100 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
101 'decap_next_index': 4294967295,
102 'instance': 4294967295, },
103 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
105 'want_bfd_events': {'enable_disable': 1, },
106 'want_igmp_events': {'enable': 1, },
107 'want_interface_events': {'enable_disable': 1, },
108 'want_l2_macs_events': {'enable_disable': 1, 'pid': os.getpid(), },
112 def as_fn_signature(d):
113 return ", ".join(f"{k}={v}" for k, v in d.items())
116 class CliFailedCommandError(Exception):
117 """ cli command failed."""
120 class CliSyntaxError(Exception):
121 """ cli command had a syntax error."""
124 class UnexpectedApiReturnValueError(Exception):
125 """ exception raised when the API return value is unexpected """
129 class VppPapiProvider(object):
130 """VPP-api provider using vpp-papi
132 @property hook: hook object providing before and after api/cli hooks
135 _zero, _negative = range(2)
137 def __init__(self, name, shm_prefix, test_class, read_timeout):
138 self.hook = Hook(test_class)
140 self.shm_prefix = shm_prefix
141 self.test_class = test_class
142 self._expect_api_retval = self._zero
143 self._expect_stack = []
145 # install_dir is a class attribute. We need to set it before
146 # calling the constructor.
147 VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
151 if os.environ['SOCKET'] == '1':
156 self.vpp = VPPApiClient(logger=test_class.logger,
157 read_timeout=read_timeout,
158 use_socket=use_socket,
159 server_address=test_class.api_sock)
160 self._events = deque()
165 def assert_negative_api_retval(self):
166 """ Expect API failure - used with with, e.g.:
167 with self.vapi.assert_negative_api_retval():
168 self.vapi.<api call expected to fail>
170 self._expect_stack.append(self._expect_api_retval)
171 self._expect_api_retval = self._negative
174 def assert_zero_api_retval(self):
175 """ Expect API success - used with with, e.g.:
176 with self.vapi.assert_negative_api_retval():
177 self.vapi.<api call expected to succeed>
179 note: this is useful only inside another with block
180 as success is the default expected value
182 self._expect_stack.append(self._expect_api_retval)
183 self._expect_api_retval = self._zero
186 def __exit__(self, exc_type, exc_value, traceback):
187 self._expect_api_retval = self._expect_stack.pop()
189 def register_hook(self, hook):
190 """Replace hook registration with new hook
197 def collect_events(self):
198 """ Collect all events from the internal queue and clear the queue. """
200 self._events = deque()
203 def wait_for_event(self, timeout, name=None):
204 """ Wait for and return next event. """
206 self.test_class.logger.debug("Expecting event '%s' within %ss",
209 self.test_class.logger.debug("Expecting event within %ss",
212 self.test_class.logger.debug("Not waiting, event already queued")
213 limit = time.time() + timeout
214 while time.time() < limit:
216 e = self._events.popleft()
217 if name and type(e).__name__ != name:
219 "Unexpected event received: %s, expected: %s" %
220 (type(e).__name__, name))
221 self.test_class.logger.debug("Returning event %s:%s" %
224 self.test_class.sleep(0) # yield
225 raise Exception("Event did not occur within timeout")
227 def __call__(self, name, event):
228 """ Enqueue event in the internal event queue. """
229 # FIXME use the name instead of relying on type(e).__name__ ?
230 # FIXME #2 if this throws, it is eaten silently, Ole?
231 self.test_class.logger.debug("New event: %s: %s" % (name, event))
232 self._events.append(event)
234 def factory(self, name, apifn):
236 fields = apifn._func.msg.fields
238 # add positional and kw arguments
240 for i, o in enumerate(fields[3:]):
243 except BaseException:
247 if name in defaultmapping:
248 for k, v in iteritems(defaultmapping[name]):
252 return self.api(apifn, d)
256 def __getattribute__(self, name):
258 method = super(VppPapiProvider, self).__getattribute__(name)
259 except AttributeError:
260 method = self.factory(name, getattr(self.papi, name))
261 # lazily load the method so we don't need to call factory
262 # again for this name.
263 setattr(self, name, method)
267 """Connect the API to VPP"""
268 self.vpp.connect(self.name, self.shm_prefix)
269 self.papi = self.vpp.api
270 self.vpp.register_event_callback(self)
272 def disconnect(self):
273 """Disconnect the API from VPP"""
274 self.vpp.disconnect()
276 def api(self, api_fn, api_args, expected_retval=0):
277 """ Call API function and check it's return value.
278 Call the appropriate hooks before and after the API call
280 :param api_fn: API function to call
281 :param api_args: tuple of API function arguments
282 :param expected_retval: Expected return value (Default value = 0)
283 :returns: reply from the API
286 self.hook.before_api(api_fn.__name__, api_args)
287 reply = api_fn(**api_args)
288 if self._expect_api_retval == self._negative:
289 if hasattr(reply, 'retval') and reply.retval >= 0:
290 msg = "%s(%s) passed unexpectedly: expected negative " \
291 "return value instead of %d in %s" % \
292 (api_fn.__name__, as_fn_signature(api_args),
294 moves.reprlib.repr(reply))
295 self.test_class.logger.info(msg)
296 raise UnexpectedApiReturnValueError(msg)
297 elif self._expect_api_retval == self._zero:
298 if hasattr(reply, 'retval') and reply.retval != expected_retval:
299 msg = "%s(%s) failed, expected %d return value instead " \
300 "of %d in %s" % (api_fn.__name__,
301 as_fn_signature(api_args),
302 expected_retval, reply.retval,
304 self.test_class.logger.info(msg)
305 raise UnexpectedApiReturnValueError(msg)
307 raise Exception("Internal error, unexpected value for "
308 "self._expect_api_retval %s" %
309 self._expect_api_retval)
310 self.hook.after_api(api_fn.__name__, api_args)
313 def cli_return_response(self, cli):
314 """ Execute a CLI, calling the before/after hooks appropriately.
315 Return the reply without examining it
317 :param cli: CLI to execute
318 :returns: response object
321 self.hook.before_cli(cli)
323 r = self.papi.cli_inband(cmd=cli)
324 self.hook.after_cli(cli)
328 """ Execute a CLI, calling the before/after hooks appropriately.
330 :param cli: CLI to execute
334 r = self.cli_return_response(cli)
336 raise CliSyntaxError(r.reply)
338 raise CliFailedCommandError(r.reply)
339 if hasattr(r, 'reply'):
342 def ppcli(self, cli):
343 """ Helper method to print CLI command in case of info logging level.
345 :param cli: CLI to execute
348 return cli + "\n" + self.cli(cli)
350 def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
352 return self.api(self.papi.ip6nd_send_router_solicitation,
357 'sw_if_index': sw_if_index})
359 def want_interface_events(self, enable_disable=1):
360 return self.api(self.papi.want_interface_events,
361 {'enable_disable': enable_disable,
362 'pid': os.getpid(), })
364 def sw_interface_set_mac_address(self, sw_if_index, mac):
365 return self.api(self.papi.sw_interface_set_mac_address,
366 {'sw_if_index': sw_if_index,
369 def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
370 """Create p2p ethernet subinterface
372 :param sw_if_index: main (parent) interface
373 :param remote_mac: client (remote) mac address
377 self.papi.p2p_ethernet_add,
378 {'parent_if_index': sw_if_index,
379 'remote_mac': remote_mac,
380 'subif_id': subif_id})
382 def p2p_ethernet_del(self, sw_if_index, remote_mac):
383 """Delete p2p ethernet subinterface
385 :param sw_if_index: main (parent) interface
386 :param remote_mac: client (remote) mac address
390 self.papi.p2p_ethernet_del,
391 {'parent_if_index': sw_if_index,
392 'remote_mac': remote_mac})
394 def create_vlan_subif(self, sw_if_index, vlan):
401 return self.api(self.papi.create_vlan_subif,
402 {'sw_if_index': sw_if_index,
405 def create_loopback(self, mac=''):
408 :param mac: (Optional)
410 return self.api(self.papi.create_loopback,
411 {'mac_address': mac})
413 def ip_route_dump(self, table_id, is_ip6=False):
414 return self.api(self.papi.ip_route_dump,
416 'table_id': table_id,
420 def ip_neighbor_add_del(self,
426 """ Add neighbor MAC to IPv4 or IPv6 address.
431 :param is_add: (Default value = 1)
432 :param flags: (Default value = 0/NONE)
435 self.papi.ip_neighbor_add_del,
439 'sw_if_index': sw_if_index,
441 'mac_address': mac_address,
442 'ip_address': ip_address
447 def udp_encap_add(self,
458 :param outer_fib_id: (Default value = 0)
462 self.papi.udp_encap_add,
467 'src_port': src_port,
468 'dst_port': dst_port,
473 def udp_encap_del(self, id):
474 return self.api(self.papi.udp_encap_del, {'id': id})
476 def udp_encap_dump(self):
477 return self.api(self.papi.udp_encap_dump, {})
479 def want_udp_encap_stats(self, enable=1):
480 return self.api(self.papi.want_udp_encap_stats,
484 def mpls_route_dump(self, table_id):
485 return self.api(self.papi.mpls_route_dump,
487 'mt_table_id': table_id
490 def mpls_table_dump(self):
491 return self.api(self.papi.mpls_table_dump, {})
493 def mpls_table_add_del(
500 :param is_add: (Default value = 1)
505 self.papi.mpls_table_add_del,
508 'mt_table_id': table_id,
510 'mt_is_add': is_add})
512 def mpls_route_add_del(self,
521 """ MPLS Route add/del """
523 self.papi.mpls_route_add_del,
526 'mr_table_id': table_id,
529 'mr_eos_proto': eos_proto,
530 'mr_is_multicast': is_multicast,
531 'mr_n_paths': len(paths),
535 'mr_is_multipath': is_multipath})
537 def mpls_ip_bind_unbind(
547 self.papi.mpls_ip_bind_unbind,
548 {'mb_mpls_table_id': table_id,
550 'mb_ip_table_id': ip_table_id,
551 'mb_is_bind': is_bind,
552 'mb_prefix': prefix})
554 def mpls_tunnel_add_del(
564 self.papi.mpls_tunnel_add_del,
565 {'mt_is_add': is_add,
568 'mt_sw_if_index': tun_sw_if_index,
569 'mt_l2_only': l2_only,
570 'mt_is_multicast': is_multicast,
571 'mt_n_paths': len(paths),
575 def input_acl_set_interface(
579 ip4_table_index=0xFFFFFFFF,
580 ip6_table_index=0xFFFFFFFF,
581 l2_table_index=0xFFFFFFFF):
585 :param ip4_table_index: (Default value = 0xFFFFFFFF)
586 :param ip6_table_index: (Default value = 0xFFFFFFFF)
587 :param l2_table_index: (Default value = 0xFFFFFFFF)
591 self.papi.input_acl_set_interface,
592 {'sw_if_index': sw_if_index,
593 'ip4_table_index': ip4_table_index,
594 'ip6_table_index': ip6_table_index,
595 'l2_table_index': l2_table_index,
598 def output_acl_set_interface(
602 ip4_table_index=0xFFFFFFFF,
603 ip6_table_index=0xFFFFFFFF,
604 l2_table_index=0xFFFFFFFF):
608 :param ip4_table_index: (Default value = 0xFFFFFFFF)
609 :param ip6_table_index: (Default value = 0xFFFFFFFF)
610 :param l2_table_index: (Default value = 0xFFFFFFFF)
614 self.papi.output_acl_set_interface,
615 {'sw_if_index': sw_if_index,
616 'ip4_table_index': ip4_table_index,
617 'ip6_table_index': ip6_table_index,
618 'l2_table_index': l2_table_index,
621 def set_ipfix_exporter(
631 self.papi.set_ipfix_exporter,
633 'collector_address': collector_address,
634 'collector_port': collector_port,
635 'src_address': src_address,
637 'path_mtu': path_mtu,
638 'template_interval': template_interval,
639 'udp_checksum': udp_checksum,
642 def mfib_signal_dump(self):
643 return self.api(self.papi.mfib_signal_dump, {})
645 def ip_mroute_dump(self, table_id, is_ip6=False):
646 return self.api(self.papi.ip_mroute_dump,
648 'table_id': table_id,
652 def vxlan_gpe_add_del_tunnel(
656 mcast_sw_if_index=0xFFFFFFFF,
667 :param is_add: (Default value = 1)
668 :param is_ipv6: (Default value = 0)
669 :param encap_vrf_id: (Default value = 0)
670 :param decap_vrf_id: (Default value = 0)
671 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
672 :param protocol: (Default value = 3)
673 :param vni: (Default value = 0)
676 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
681 'mcast_sw_if_index': mcast_sw_if_index,
682 'encap_vrf_id': encap_vrf_id,
683 'decap_vrf_id': decap_vrf_id,
684 'protocol': protocol,
687 def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
688 return self.api(self.papi.vxlan_gbp_tunnel_dump,
689 {'sw_if_index': sw_if_index})
691 def pppoe_add_del_session(
700 :param is_add: (Default value = 1)
701 :param is_ipv6: (Default value = 0)
703 :param session_id: (Default value = 0)
705 :param decap_vrf_id: (Default value = 0)
708 return self.api(self.papi.pppoe_add_del_session,
710 'session_id': session_id,
711 'client_ip': client_ip,
712 'decap_vrf_id': decap_vrf_id,
713 'client_mac': client_mac})
715 def sr_mpls_policy_add(self, bsid, weight, type, segments):
716 return self.api(self.papi.sr_mpls_policy_add,
720 'n_segments': len(segments),
721 'segments': segments})
723 def sr_mpls_policy_del(self, bsid):
724 return self.api(self.papi.sr_mpls_policy_del,
727 def ip_punt_police(self,
731 return self.api(self.papi.ip_punt_police,
732 {'policer_index': policer_index,
736 def ip_punt_redirect(self,
741 return self.api(self.papi.ip_punt_redirect,
742 {'punt': {'rx_sw_if_index': rx_sw_if_index,
743 'tx_sw_if_index': tx_sw_if_index,
747 def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0):
748 return self.api(self.papi.ip_punt_redirect_dump,
749 {'sw_if_index': sw_if_index,
752 def bier_table_add_del(self,
756 """ BIER Table add/del """
758 self.papi.bier_table_add_del,
759 {'bt_tbl_id': {"bt_set": bti.set_id,
760 "bt_sub_domain": bti.sub_domain_id,
761 "bt_hdr_len_id": bti.hdr_len_id},
762 'bt_label': mpls_label,
763 'bt_is_add': is_add})
765 def bier_table_dump(self):
766 return self.api(self.papi.bier_table_dump, {})
768 def bier_route_add_del(self,
774 """ BIER Route add/del """
776 self.papi.bier_route_add_del,
779 'br_tbl_id': {"bt_set": bti.set_id,
780 "bt_sub_domain": bti.sub_domain_id,
781 "bt_hdr_len_id": bti.hdr_len_id},
783 'br_n_paths': len(paths),
787 'br_is_replace': is_replace
790 def bier_route_dump(self, bti):
792 self.papi.bier_route_dump,
793 {'br_tbl_id': {"bt_set": bti.set_id,
794 "bt_sub_domain": bti.sub_domain_id,
795 "bt_hdr_len_id": bti.hdr_len_id}})
797 def bier_imp_add(self,
802 """ BIER Imposition Add """
804 self.papi.bier_imp_add,
805 {'bi_tbl_id': {"bt_set": bti.set_id,
806 "bt_sub_domain": bti.sub_domain_id,
807 "bt_hdr_len_id": bti.hdr_len_id},
809 'bi_n_bytes': len(ibytes),
812 def bier_imp_del(self, bi_index):
813 """ BIER Imposition del """
815 self.papi.bier_imp_del,
816 {'bi_index': bi_index})
818 def bier_imp_dump(self):
819 return self.api(self.papi.bier_imp_dump, {})
821 def bier_disp_table_add_del(self,
824 """ BIER Disposition Table add/del """
826 self.papi.bier_disp_table_add_del,
828 'bdt_is_add': is_add})
830 def bier_disp_table_dump(self):
831 return self.api(self.papi.bier_disp_table_dump, {})
833 def bier_disp_entry_add_del(self,
843 """ BIER Route add/del """
845 while (len(lstack) < 16):
848 self.papi.bier_disp_entry_add_del,
851 'bde_payload_proto': payload_proto,
853 'bde_paths': [{'table_id': next_hop_tbl_id,
854 'rpf_id': next_hop_rpf_id,
856 'label_stack': lstack}],
857 'bde_is_add': is_add})
859 def bier_disp_entry_dump(self, bdti):
861 self.papi.bier_disp_entry_dump,
862 {'bde_tbl_id': bdti})
864 def ipsec_spd_add_del(self, spd_id, is_add=1):
865 """ SPD add/del - Wrapper to add or del ipsec SPD
866 Sample CLI : 'ipsec spd add 1'
868 :param spd_id - SPD ID to be created in the vpp . mandatory
869 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
871 :returns: reply from the API
874 self.papi.ipsec_spd_add_del, {
875 'spd_id': spd_id, 'is_add': is_add})
877 def ipsec_spds_dump(self):
878 return self.api(self.papi.ipsec_spds_dump, {})
880 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
881 """ IPSEC interface SPD add/del - \
882 Wrapper to associate/disassociate SPD to interface in VPP
883 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
885 :param spd_id - SPD ID to associate with the interface . mandatory
886 :param sw_if_index - Interface Index which needs to ipsec \
887 association mandatory
888 :param is_add - add(1) or del(0) association with interface \
889 (Default 1 - add) . optional
890 :returns: reply from the API
893 self.papi.ipsec_interface_add_del_spd,
894 {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
896 def ipsec_spd_interface_dump(self, spd_index=None):
897 return self.api(self.papi.ipsec_spd_interface_dump,
898 {'spd_index': spd_index if spd_index else 0,
899 'spd_index_valid': 1 if spd_index else 0})
901 def ipsec_spd_entry_add_del(self,
906 remote_address_start,
909 local_port_stop=65535,
911 remote_port_stop=65535,
919 """ IPSEC policy SPD add/del -
920 Wrapper to configure ipsec SPD policy entries in VPP
921 :param spd_id: SPD ID for the policy
922 :param local_address_start: local-ip-range start address
923 :param local_address_stop : local-ip-range stop address
924 :param remote_address_start: remote-ip-range start address
925 :param remote_address_stop : remote-ip-range stop address
926 :param local_port_start: (Default value = 0)
927 :param local_port_stop: (Default value = 65535)
928 :param remote_port_start: (Default value = 0)
929 :param remote_port_stop: (Default value = 65535)
930 :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
931 :param sa_id: Security Association ID for mapping it to SPD
932 :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
934 :param priority: value for the spd action (Default value = 100)
935 :param is_outbound: flag for inbound(0) or outbound(1)
937 :param is_add: (Default value = 1)
940 self.papi.ipsec_spd_entry_add_del,
947 'local_address_start': local_address_start,
948 'local_address_stop': local_address_stop,
949 'remote_address_start': remote_address_start,
950 'remote_address_stop': remote_address_stop,
951 'local_port_start': local_port_start,
952 'local_port_stop': local_port_stop,
953 'remote_port_start': remote_port_start,
954 'remote_port_stop': remote_port_stop,
955 'protocol': protocol,
957 'priority': priority,
958 'is_outbound': is_outbound,
962 def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
963 return self.api(self.papi.ipsec_spd_dump,
967 def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
968 remote_spi, crypto_alg, local_crypto_key,
969 remote_crypto_key, integ_alg, local_integ_key,
970 remote_integ_key, is_add=1, esn=0, salt=0,
971 anti_replay=1, renumber=0,
972 udp_encap=0, show_instance=0xffffffff):
974 self.papi.ipsec_tunnel_if_add_del,
976 'local_ip': local_ip,
977 'remote_ip': remote_ip,
978 'local_spi': local_spi,
979 'remote_spi': remote_spi,
980 'crypto_alg': crypto_alg,
981 'local_crypto_key_len': len(local_crypto_key),
982 'local_crypto_key': local_crypto_key,
983 'remote_crypto_key_len': len(remote_crypto_key),
984 'remote_crypto_key': remote_crypto_key,
985 'integ_alg': integ_alg,
986 'local_integ_key_len': len(local_integ_key),
987 'local_integ_key': local_integ_key,
988 'remote_integ_key_len': len(remote_integ_key),
989 'remote_integ_key': remote_integ_key,
992 'anti_replay': anti_replay,
993 'renumber': renumber,
994 'show_instance': show_instance,
995 'udp_encap': udp_encap,
999 def ipsec_select_backend(self, protocol, index):
1000 return self.api(self.papi.ipsec_select_backend,
1001 {'protocol': protocol, 'index': index})
1003 def ipsec_backend_dump(self):
1004 return self.api(self.papi.ipsec_backend_dump, {})
1006 def punt_socket_register(self, reg, pathname,
1008 """ Register punt socket """
1009 return self.api(self.papi.punt_socket_register,
1010 {'header_version': header_version,
1012 'pathname': pathname})
1014 def punt_socket_deregister(self, reg):
1015 """ Unregister punt socket """
1016 return self.api(self.papi.punt_socket_deregister,
1019 def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
1021 """ GBP endpoint Add """
1022 return self.api(self.papi.gbp_endpoint_add,
1024 'sw_if_index': sw_if_index,
1035 def gbp_endpoint_del(self, handle):
1036 """ GBP endpoint Del """
1037 return self.api(self.papi.gbp_endpoint_del,
1040 def gbp_endpoint_dump(self):
1041 """ GBP endpoint Dump """
1042 return self.api(self.papi.gbp_endpoint_dump, {})
1044 def gbp_endpoint_group_add(self, vnid, sclass, bd,
1045 rd, uplink_sw_if_index,
1047 """ GBP endpoint group Add """
1048 return self.api(self.papi.gbp_endpoint_group_add,
1051 'uplink_sw_if_index': uplink_sw_if_index,
1056 'retention': retention
1059 def gbp_endpoint_group_del(self, sclass):
1060 """ GBP endpoint group Del """
1061 return self.api(self.papi.gbp_endpoint_group_del,
1064 def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1067 bm_flood_sw_if_index):
1068 """ GBP bridge-domain Add """
1069 return self.api(self.papi.gbp_bridge_domain_add,
1073 'bvi_sw_if_index': bvi_sw_if_index,
1074 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1075 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1080 def gbp_bridge_domain_del(self, bd_id):
1081 """ GBP bridge-domain Del """
1082 return self.api(self.papi.gbp_bridge_domain_del,
1085 def gbp_route_domain_add(self, rd_id,
1090 ip6_uu_sw_if_index):
1091 """ GBP route-domain Add """
1092 return self.api(self.papi.gbp_route_domain_add,
1096 'ip4_table_id': ip4_table_id,
1097 'ip6_table_id': ip6_table_id,
1098 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1099 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1103 def gbp_route_domain_del(self, rd_id):
1104 """ GBP route-domain Del """
1105 return self.api(self.papi.gbp_route_domain_del,
1108 def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1109 """ GBP recirc Add/Del """
1110 return self.api(self.papi.gbp_recirc_add_del,
1114 'sw_if_index': sw_if_index,
1117 def gbp_recirc_dump(self):
1118 """ GBP recirc Dump """
1119 return self.api(self.papi.gbp_recirc_dump, {})
1121 def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1122 """ GBP recirc Add/Del """
1123 return self.api(self.papi.gbp_ext_itf_add_del,
1126 'sw_if_index': sw_if_index,
1131 def gbp_ext_itf_dump(self):
1132 """ GBP recirc Dump """
1133 return self.api(self.papi.gbp_ext_itf_dump, {})
1135 def gbp_subnet_add_del(self, is_add, rd_id,
1137 sw_if_index=0xffffffff,
1139 """ GBP Subnet Add/Del """
1140 return self.api(self.papi.gbp_subnet_add_del,
1144 'sw_if_index': sw_if_index,
1149 def gbp_subnet_dump(self):
1150 """ GBP Subnet Dump """
1151 return self.api(self.papi.gbp_subnet_dump, {})
1153 def gbp_contract_dump(self):
1154 """ GBP contract Dump """
1155 return self.api(self.papi.gbp_contract_dump, {})
1157 def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1158 """ GBP VXLAN tunnel add """
1159 return self.api(self.papi.gbp_vxlan_tunnel_add,
1164 'bd_rd_id': bd_rd_id,
1169 def gbp_vxlan_tunnel_del(self, vni):
1170 """ GBP VXLAN tunnel del """
1171 return self.api(self.papi.gbp_vxlan_tunnel_del,
1176 def gbp_vxlan_tunnel_dump(self):
1177 """ GBP VXLAN tunnel add/del """
1178 return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1180 def igmp_enable_disable(self, sw_if_index, enable, host):
1181 """ Enable/disable IGMP on a given interface """
1182 return self.api(self.papi.igmp_enable_disable,
1185 'sw_if_index': sw_if_index})
1187 def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1188 """ Add/del IGMP proxy device """
1189 return self.api(self.papi.igmp_proxy_device_add_del,
1190 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1193 def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1194 """ Add/del interface to/from IGMP proxy device """
1195 return self.api(self.papi.igmp_proxy_device_add_del_interface,
1196 {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1199 def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1200 """ Listen for new (S,G) on specified interface
1202 :param enable: add/del
1203 :param sw_if_index: interface sw index
1204 :param saddr: source ip4 addr
1205 :param gaddr: group ip4 addr
1207 return self.api(self.papi.igmp_listen,
1212 'sw_if_index': sw_if_index,
1213 'n_srcs': len(saddrs),
1219 def igmp_clear_interface(self, sw_if_index):
1220 """ Remove all (S,G)s from specified interface
1221 doesn't send IGMP report!
1224 self.papi.igmp_clear_interface, {
1225 'sw_if_index': sw_if_index})
1227 def want_igmp_events(self, enable=1):
1228 return self.api(self.papi.want_igmp_events, {'enable': enable,
1229 'pid': os.getpid()})